mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 20:37:50 +00:00
87 lines
2.4 KiB
YAML
87 lines
2.4 KiB
YAML
get:
|
|
operationId: listFromAddresses
|
|
tags:
|
|
- Notifications
|
|
summary: List From Addresses
|
|
description: >-
|
|
Retrieve a list of sender email addresses and their verification statuses
|
|
parameters:
|
|
- $ref: '../../v3/parameters/limit.yaml'
|
|
- $ref: '../../v3/parameters/offset.yaml'
|
|
- $ref: '../../v3/parameters/count.yaml'
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: >-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
|
|
**email**: *eq, ge, le, sw*
|
|
example: email eq "john.doe@company.com"
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: >-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
|
|
Sorting is supported for the following fields: **email**
|
|
example: email
|
|
responses:
|
|
'200':
|
|
description: List of Email Status
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/EmailStatusDto.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:
|
|
operationId: createVerifiedFromAddress
|
|
tags:
|
|
- Notifications
|
|
summary: Create Verified From Address
|
|
description: >-
|
|
Create a new sender email address and initiate verification process.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/EmailStatusDto.yaml'
|
|
example:
|
|
email: "sender@example.com"
|
|
|
|
responses:
|
|
'201':
|
|
description: New Verified Email Status
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/EmailStatusDto.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'
|