Files
developer.sailpoint.com/static/api-specs/idn/beta/paths/sod-exceptions.yaml
2022-11-17 13:53:47 +00:00

97 lines
2.6 KiB
YAML

post:
operationId: createSodException
tags:
- SOD Exception
summary: Create SOD Exception
# security:
# - oauth2: [API]
description: >-
This API creates a SOD exception.
A token with API authority is required to call this API.
requestBody:
required: true
content:
application/json:
schema:
$ref: "../schemas/sod/models/Exception.yaml"
examples:
Exception created:
$ref: "../schemas/sod/examples/exception-body.yaml"
responses:
"201":
$ref: "../schemas/sod/responses/201.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"
get:
operationId: listSodExceptions
tags:
- SOD Exception
summary: List SOD Exceptions
# security:
# - oauth2: [API]
description: >-
This API returns a list of all SOD exceptions.
A token with API authority is required to call this API.
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:
**id**: *eq, in* **sodPolicy.id**: *eq, in* **identity.id**: *eq, in*
example: identity.id eq "bc693f07e7b645539626c25954c58554"
required: false
- 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:
**sodPolicy.id, identity.id, start, end**
example: identity.id,-start
required: false
responses:
"200":
$ref: "../schemas/sod/responses/200-list.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"