Add domain allowlist endpoints (#2072)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-10-29 20:46:33.498190",
-            "spec_repo_commit": "c0b9551e"
+            "regenerated": "2024-10-30 18:58:10.241853",
+            "spec_repo_commit": "755120dd"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-10-29 20:46:33.516450",
-            "spec_repo_commit": "c0b9551e"
+            "regenerated": "2024-10-30 18:58:10.260831",
+            "spec_repo_commit": "755120dd"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -7115,6 +7115,81 @@ components:
           description: The type of the resource. The value should always be device.
           type: string
       type: object
+    DomainAllowlist:
+      description: The email domain allowlist for an org.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/DomainAllowlistAttributes'
+        id:
+          description: The unique identifier of the org.
+          nullable: true
+          type: string
+        type:
+          $ref: '#/components/schemas/DomainAllowlistType'
+      required:
+      - type
+      type: object
+    DomainAllowlistAttributes:
+      description: The details of the email domain allowlist.
+      properties:
+        domains:
+          description: The list of domains in the email domain allowlist.
+          items:
+            type: string
+          type: array
+        enabled:
+          description: Whether the email domain allowlist is enabled for the org.
+          type: boolean
+      type: object
+    DomainAllowlistRequest:
+      description: Request containing the desired email domain allowlist configuration.
+      properties:
+        data:
+          $ref: '#/components/schemas/DomainAllowlist'
+      required:
+      - data
+      type: object
+    DomainAllowlistResponse:
+      description: Response containing information about the email domain allowlist.
+      properties:
+        data:
+          $ref: '#/components/schemas/DomainAllowlistResponseData'
+      type: object
+    DomainAllowlistResponseData:
+      description: The email domain allowlist response for an org.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/DomainAllowlistResponseDataAttributes'
+        id:
+          description: The unique identifier of the org.
+          nullable: true
+          type: string
+        type:
+          $ref: '#/components/schemas/DomainAllowlistType'
+      required:
+      - type
+      type: object
+    DomainAllowlistResponseDataAttributes:
+      description: The details of the email domain allowlist.
+      properties:
+        domains:
+          description: The list of domains in the email domain allowlist.
+          items:
+            type: string
+          type: array
+        enabled:
+          description: Whether the email domain allowlist is enabled for the org.
+          type: boolean
+      type: object
+    DomainAllowlistType:
+      default: domain_allowlist
+      description: Email domain allowlist allowlist type.
+      enum:
+      - domain_allowlist
+      example: domain_allowlist
+      type: string
+      x-enum-varnames:
+      - DOMAIN_ALLOWLIST
     DowntimeCreateRequest:
       description: Request for creating a downtime.
       properties:
@@ -29433,6 +29508,61 @@ paths:
       tags:
       - Dashboard Lists
       x-codegen-request-body-name: body
+  /api/v2/domain_allowlist:
+    get:
+      description: Get the domain allowlist for an organization.
+      operationId: GetDomainAllowlist
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DomainAllowlistResponse'
+          description: OK
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - org_management
+      summary: Get Domain Allowlist
+      tags:
+      - Domain Allowlist
+      x-permission:
+        operator: OR
+        permissions:
+        - org_management
+    patch:
+      description: Update the domain allowlist for an organization.
+      operationId: PatchDomainAllowlist
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DomainAllowlistRequest'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DomainAllowlistResponse'
+          description: OK
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - org_management
+      summary: Sets Domain Allowlist
+      tags:
+      - Domain Allowlist
+      x-permission:
+        operator: OR
+        permissions:
+        - org_management
   /api/v2/dora/deployment:
     post:
       description: 'Use this API endpoint to provide data about deployments for DORA
@@ -41786,6 +41916,14 @@ tags:
 
     organization.'
   name: Dashboard Lists
+- description: 'Configure your Datadog Email Domain Allowlist directly through the
+    Datadog API.
+
+    The Email Domain Allowlist controls the domains that certain datadog emails can
+    be sent to.
+
+    For more information, see the [Domain Allowlist docs page](https://docs.datadoghq.com/account_management/org_settings/domain_allowlist)'
+  name: Domain Allowlist
 - description: '**Note**: Downtime V2 is currently in private beta. To request access,
     contact [Datadog support](https://docs.datadoghq.com/help/).
 

cassettes/features/v2/domain_allowlist/Get-Domain-Allowlist-returns-OK-response.frozen

@@ -0,0 +1 @@
+2024-10-23T18:16:16.668Z

cassettes/features/v2/domain_allowlist/Get-Domain-Allowlist-returns-OK-response.yml

@@ -0,0 +1 @@
+2024-10-23T18:16:16.928Z

cassettes/features/v2/domain_allowlist/Sets-Domain-Allowlist-returns-OK-response.frozen

@@ -0,0 +1,5 @@
+# Get Domain Allowlist returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::DomainAllowlistAPI.new
+p api_instance.get_domain_allowlist()

cassettes/features/v2/domain_allowlist/Sets-Domain-Allowlist-returns-OK-response.yml

@@ -0,0 +1,17 @@
+# Sets Domain Allowlist returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::DomainAllowlistAPI.new
+
+body = DatadogAPIClient::V2::DomainAllowlistRequest.new({
+  data: DatadogAPIClient::V2::DomainAllowlist.new({
+    attributes: DatadogAPIClient::V2::DomainAllowlistAttributes.new({
+      domains: [
+        "@static-test-domain.test",
+      ],
+      enabled: false,
+    }),
+    type: DatadogAPIClient::V2::DomainAllowlistType::DOMAIN_ALLOWLIST,
+  }),
+})
+p api_instance.patch_domain_allowlist(body)

examples/v2/domain-allowlist/GetDomainAllowlist.rb

@@ -1185,6 +1185,9 @@
             "dashboard_list_id" => "Integer",
             "body" => "DashboardListUpdateItemsRequest",
     },
+    "v2.PatchDomainAllowlist" => {
+            "body" => "DomainAllowlistRequest",
+    },
     "v2.CreateDORADeployment" => {
             "body" => "DORADeploymentRequest",
     },

examples/v2/domain-allowlist/PatchDomainAllowlist.rb

@@ -0,0 +1,32 @@
+@endpoint(domain-allowlist) @endpoint(domain-allowlist-v2)
+Feature: Domain Allowlist
+  Configure your Datadog Email Domain Allowlist directly through the Datadog
+  API. The Email Domain Allowlist controls the domains that certain datadog
+  emails can be sent to. For more information, see the [Domain Allowlist
+  docs page](https://docs.datadoghq.com/account_management/org_settings/doma
+  in_allowlist)
+
+  Background:
+    Given a valid "apiKeyAuth" key in the system
+    And a valid "appKeyAuth" key in the system
+    And an instance of "DomainAllowlist" API
+
+  @team:Datadog/team-aaa-dogmail
+  Scenario: Get Domain Allowlist returns "OK" response
+    Given new "GetDomainAllowlist" request
+    When the request is sent
+    Then the response status is 200 OK
+    And the response "data.type" is equal to "domain_allowlist"
+    And the response "data.attributes.domains" array contains value "@static-test-domain.test"
+    And the response "data.attributes.enabled" is equal to false
+
+  @team:Datadog/team-aaa-dogmail
+  Scenario: Sets Domain Allowlist returns "OK" response
+    Given new "PatchDomainAllowlist" request
+    And body with value {"data": {"attributes": {"domains": ["@static-test-domain.test"], "enabled": false}, "type": "domain_allowlist"}}
+    When the request is sent
+    Then the response status is 200 OK
+    And the response "data.type" is equal to "domain_allowlist"
+    And the response "data.attributes.domains" has length 1
+    And the response "data.attributes.domains" array contains value "@static-test-domain.test"
+    And the response "data.attributes.enabled" is equal to false