Files
api-specs/idn/beta/paths/lifecycle-states.yaml
2022-09-28 19:55:18 +00:00

90 lines
2.4 KiB
YAML

get:
operationId: listLifecycleStates
tags:
- Lifecycle States
summary: Lifecycle States List
description: |
This endpoint returns a list of lifecycle states associated with an Identity Profile.
A token with ORG_ADMIN or API authority is required to call this API.
parameters:
- in: path
name: identity-profile-id
description: >-
Identity Profile ID
required: true
schema:
type: string
- $ref: '../../v3/parameters/limit.yaml'
- $ref: '../../v3/parameters/offset.yaml'
- $ref: '../../v3/parameters/count.yaml'
- 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: **created, modified**
responses:
'200':
description: List of lifecycle-states
content:
application/json:
schema:
type: array
items:
$ref: '../schemas/LifecycleState.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: createLifecycleState
tags:
- Lifecycle States
summary: Lifecycle State Create
description: |
This endpoint creates a new lifecycle state.
A token with ORG_ADMIN or API authority is required to call this API.
parameters:
- in: path
name: identity-profile-id
description: >-
Identity Profile ID
required: true
schema:
type: string
requestBody:
description: Lifecycle State
required: true
content:
application/json:
schema:
$ref: '../schemas/LifecycleState.yaml'
responses:
'201':
description: lifecycle-state
content:
application/json:
schema:
$ref: '../schemas/LifecycleState.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'