Automated commit by github action: 3282169801

This commit is contained in:
GitHub Action Bot
2022-10-19 13:56:40 +00:00
parent dbf602ac9e
commit 8043256e68
6 changed files with 119 additions and 0 deletions

View File

@@ -0,0 +1,37 @@
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'

View File

@@ -0,0 +1,35 @@
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'

View File

@@ -0,0 +1,21 @@
type: object
properties:
address:
type: string
example: BobSmith@sailpoint.com
description: The identity or domain address
dkimEnabled:
type: boolean
example: true
description: Whether or not DKIM has been enabled for this domain / identity
dkimTokens:
type: array
items:
type: string
example: [ "uq1m3jjk25ckd3whl4n7y46c56r5l6aq","u7pm38jky9ckdawhlsn7y4dcj6f5lpgq","uhpm3jjkjjckdkwhlqn7yw6cjer5tpay" ]
description: The tokens to be added to a DNS for verification
dkimVerificationStatus:
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

View File

@@ -0,0 +1,6 @@
type: object
properties:
domain:
type: string
example: sailpoint.com
description: A domain address

View File

@@ -1446,6 +1446,10 @@ paths:
$ref: './beta/paths/verified-from-addresses.yaml'
/verified-from-addresses/{id}:
$ref: './beta/paths/verified-from-address.yaml'
/dkim-attributes/{identities}:
$ref: './beta/paths/dkim-attributes.yaml'
/verify-domain-dkim:
$ref: './beta/paths/verify-domain-dkim.yaml'
/sod-policies:
$ref: './beta/paths/sod-policies.yaml'
/sod-policies/{id}:

View File

@@ -0,0 +1,16 @@
description: Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method.
content:
application/json:
schema:
type: object
properties:
errorName:
description: A message describing the error
example: "NotSupportedException"
errorMessage:
description: Description of the error
example: Cannot consume content type
trackingId:
type: string
description: Unique tracking id for the error.
example: e7eab60924f64aa284175b9fa3309599