Automated commit by github action: 4960500838

static/api-specs/idn/beta/paths/dkim-attributes.yaml

@@ -1,37 +0,0 @@
-get:
-  operationId: getDkimAttributes
-  tags:
-    - Notifications
-  summary: Get DKIM Attributes
-  description: >-
-    Retrieve DKIM (DomainKeys Identified Mail) attributes from a list of identities. Limit retrieval of 100 identities per call
-  parameters:
-    - in: query
-      name: identities
-      required: true
-      schema:
-        type: string
-        format: comma-separated
-      description: >-
-        Returns the DKIM attributes for each of the given identities
-      example:
-        bobsmith@sailpoint.com,alex.jordan@sailpoint.com
-  responses:
-    '200':
-      description: List of DKIM Attributes
-      content:
-        application/json:
-          schema:
-            type: array
-            items:
-              $ref: '../schemas/DkimAttributesDto.yaml'
-    '400':
-      $ref: '../../v3/responses/400.yaml'
-    '401':
-      $ref: '../../v3/responses/401.yaml'
-    '403':
-      $ref: '../../v3/responses/403.yaml'
-    '429':
-      $ref: '../../v3/responses/429.yaml'
-    '500':
-      $ref: '../../v3/responses/500.yaml'

static/api-specs/idn/beta/paths/mail-from-attribute.yaml

@@ -0,0 +1,36 @@
+get:
+  security:
+  - oauth2: [ sp:notification-mail-from-attributes:read ]
+  operationId: getMailFromAttributes
+  tags:
+  - Notifications
+  summary: Get MAIL FROM Attributes
+  description: >-
+    Retrieve MAIL FROM attributes for a given AWS SES identity.
+  parameters:
+  - in: query
+    name: id
+    required: true
+    schema:
+      type: string
+    description: >-
+      Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
+    example:
+      bobsmith@sailpoint.com
+  responses:
+    '200':
+      description: MAIL FROM Attributes object
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/MailFromAttributes.yaml'
+    '400':
+      $ref: '../../v3/responses/400.yaml'
+    '401':
+      $ref: '../../v3/responses/401.yaml'
+    '403':
+      $ref: '../../v3/responses/403.yaml'
+    '429':
+      $ref: '../../v3/responses/429.yaml'
+    '500':
+      $ref: '../../v3/responses/500.yaml'

static/api-specs/idn/beta/paths/mail-from-attributes.yaml

@@ -0,0 +1,35 @@
+put:
+  security:
+  - oauth2: [ sp:notification-mail-from-attributes:write ]
+  operationId: putMailFromAttributes
+  tags:
+  - Notifications
+  summary: Change MAIL FROM domain
+  description: >-
+    Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../schemas/MailFromAttributesDto.yaml'
+        example:
+          identity: "BobSmith@sailpoint.com"
+          mailFromDomain: "example.sailpoint.com"
+  responses:
+    '200':
+      description: MAIL FROM Attributes required to verify the change
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/MailFromAttributes.yaml'
+    '400':
+      $ref: '../../v3/responses/400.yaml'
+    '401':
+      $ref: '../../v3/responses/401.yaml'
+    '403':
+      $ref: '../../v3/responses/403.yaml'
+    '429':
+      $ref: '../../v3/responses/429.yaml'
+    '500':
+      $ref: '../../v3/responses/500.yaml'

static/api-specs/idn/beta/paths/verified-domains.yaml

@@ -0,0 +1,63 @@
+get:
+  security:
+  - oauth2: [ sp:notification-dkim-attributes:read ]
+  operationId: getDkimAttributes
+  tags:
+    - Notifications
+  summary: Get DKIM Attributes
+  description: >-
+    Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call.
+  responses:
+    '200':
+      description: List of DKIM Attributes
+      content:
+        application/json:
+          schema:
+            type: array
+            items:
+              $ref: '../schemas/DkimAttributes.yaml'
+    '400':
+      $ref: '../../v3/responses/400.yaml'
+    '401':
+      $ref: '../../v3/responses/401.yaml'
+    '403':
+      $ref: '../../v3/responses/403.yaml'
+    '429':
+      $ref: '../../v3/responses/429.yaml'
+    '500':
+      $ref: '../../v3/responses/500.yaml'
+
+post:
+  security:
+  - oauth2: [ sp:notification-verify-domain-dkim:write ]
+  operationId: createDomainDkim
+  tags:
+  - Notifications
+  summary: Verify domain address via DKIM
+  description: >-
+    Create a domain to be verified via DKIM (DomainKeys Identified Mail)
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../schemas/DomainAddress.yaml'
+  responses:
+    '200':
+      description: List of DKIM tokens required for the verification process.
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/DomainStatusDto.yaml'
+    '400':
+      $ref: '../../v3/responses/400.yaml'
+    '401':
+      $ref: '../../v3/responses/401.yaml'
+    '403':
+      $ref: '../../v3/responses/403.yaml'
+    '405':
+      $ref: '../../v3/responses/405.yaml'
+    '429':
+      $ref: '../../v3/responses/429.yaml'
+    '500':
+      $ref: '../../v3/responses/500.yaml'

static/api-specs/idn/beta/paths/verify-domain-dkim.yaml

@@ -1,35 +0,0 @@
-post:
-  operationId: verifyDomainDkim
-  tags:
-    - Notifications
-  summary: Verify domain address via DKIM
-  description: >-
-    Create a domain to be verified via DKIM (DomainKeys Identified Mail)
-  requestBody:
-    required: true
-    content:
-      application/json:
-        schema:
-          $ref: '../schemas/DomainAddressDto.yaml'
-  responses:
-    '200':
-      description: List of DKIM tokens
-      content:
-        application/json:
-          schema:
-            type: array
-            items:
-              type: string
-          example: ["uq1m3jjk25ckd3whl4n7y46c56r5l6aq","u7pm38jky9ckdawhlsn7y4dcj6f5lpgq","uhpm3jjkjjckdkwhlqn7yw6cjer5tpay"]
-    '400':
-      $ref: '../../v3/responses/400.yaml'
-    '401':
-      $ref: '../../v3/responses/401.yaml'
-    '403':
-      $ref: '../../v3/responses/403.yaml'
-    '405':
-      $ref: '../../v3/responses/405.yaml'
-    '429':
-      $ref: '../../v3/responses/429.yaml'
-    '500':
-      $ref: '../../v3/responses/500.yaml'

static/api-specs/idn/beta/schemas/DkimAttributes.yaml

@@ -1,11 +1,16 @@
 type: object
 properties:
+  id:
+    type: string
+    example: 123b45b0-aaaa-bbbb-a7db-123456a56abc
+    description: UUID associated with domain to be verified
   address:
     type: string
     example: BobSmith@sailpoint.com
     description: The identity or domain address
   dkimEnabled:
     type: boolean
+    default: false
     example: true
     description: Whether or not DKIM has been enabled for this domain / identity
   dkimTokens:
@@ -18,4 +23,4 @@ properties:
     type: string
     example: Success
     description: The current status if the domain /identity has been verified. Ie Success, Failed, Pending
-description: DKIM attributes for a domain / identity
+description: DKIM attributes for a domain or identity

static/api-specs/idn/beta/schemas/DomainStatusDto.yaml

@@ -0,0 +1,23 @@
+type: object
+properties:
+  id:
+    type: string
+    example: 123b45b0-aaaa-bbbb-a7db-123456a56abc
+    description: New UUID associated with domain to be verified
+  domain:
+    type: string
+    example: sailpoint.com
+    description: A domain address
+  dkimEnabled:
+    default: false
+    example: true
+    description: DKIM is enabled for this domain
+  dkimTokens:
+    type: array
+    example: ["token1", "token2", "token3"]
+    description: DKIM tokens required for authentication
+  dkimVerificationStatus:
+    type: string
+    example: PENDING
+    description: Status of DKIM authentication
+description: Domain status DTO containing everything required to verify via DKIM

static/api-specs/idn/beta/schemas/MailFromAttributes.yaml

@@ -0,0 +1,23 @@
+type: object
+properties:
+  id:
+    type: string
+    example: BobSmith@sailpoint.com
+    description: The identity or domain address
+  mxRecord:
+    type: string
+    example: 10 feedback-smtp.us-east-1.amazonses.com
+    description: MX record that is required in customer's DNS to allow the domain to receive bounce and complaint notifications that email providers send you
+  txtRecord:
+    type: string
+    example: v=spf1 include:amazonses.com ~all
+    description: TXT record that is required in customer's DNS in order to prove that Amazon SES is authorized to send email from your domain
+  mailFromDomainStatus:
+    type: string
+    enum:
+    - PENDING
+    - SUCCESS
+    - FAILED
+    example: PENDING
+    description: The current status of the MAIL FROM verification
+description: MAIL FROM attributes for a domain / identity

static/api-specs/idn/beta/schemas/MailFromAttributesDto.yaml

@@ -0,0 +1,11 @@
+type: object
+properties:
+  identity:
+    type: string
+    example: BobSmith@sailpoint.com
+    description: The identity or domain address
+  mailFromDomain:
+    type: string
+    example: example.sailpoint.com
+    description: The new MAIL FROM domain of the identity. Must be a subdomain of the identity.
+description: MAIL FROM attributes for a domain / identity

static/api-specs/idn/sailpoint-api.beta.yaml

@@ -1314,6 +1314,10 @@ paths:
     $ref: './beta/paths/managed-cluster-log-config.yaml'
   /managed-clusters:
     $ref: './beta/paths/managed-clusters.yaml'
+  /mail-from-attributes:
+    $ref: './beta/paths/mail-from-attributes.yaml'
+  /mail-from-attribute/{id}:
+    $ref: './beta/paths/mail-from-attribute.yaml'
   /mfa/{method}/config:
     $ref: './beta/paths/mfa-config.yaml'
   /mfa/{method}/test:
@@ -1538,10 +1542,8 @@ paths:
     $ref: './beta/paths/verified-from-addresses.yaml'
   /verified-from-addresses/{id}:
     $ref: './beta/paths/verified-from-address.yaml'
-  /dkim-attributes/{identities}:
+  /verified-domains:
-    $ref: './beta/paths/dkim-attributes.yaml'
+    $ref: './beta/paths/verified-domains.yaml'
-  /verify-domain-dkim:
-    $ref: './beta/paths/verify-domain-dkim.yaml'
   /sod-policies:
     $ref: './beta/paths/sod-policies.yaml'
   /sod-policies/{id}: