mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 12:27:48 +00:00
9269e86172
* added new oauth2 flow and description * renamed authentication to make more sense' by github action: 5967546682
56 lines
1.6 KiB
YAML
56 lines
1.6 KiB
YAML
post:
|
|
operationId: setLifecycleState
|
|
tags:
|
|
- Lifecycle States
|
|
summary: Set Lifecycle State
|
|
description: >-
|
|
This endpoint will set/update an identity's lifecycle state to the one provided and updates the corresponding Identity Profile.
|
|
|
|
A token with ORG_ADMIN or API authority is required to call this API.
|
|
security:
|
|
- UserContextAuth: [idn:identity-lifecycle-state:update]
|
|
parameters:
|
|
- in: path
|
|
name: identity-id
|
|
description: >-
|
|
The ID of the identity to update
|
|
required: true
|
|
example: 2c9180857893f1290178944561990364
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
lifecycleStateId:
|
|
type: string
|
|
description: The ID of the lifecycle state to set
|
|
example: 2c9180877a86e408017a8c19fefe046c
|
|
responses:
|
|
'200':
|
|
description: The request was successfully accepted into the system.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
accountActivityId:
|
|
type: string
|
|
example: 2c9180837ab5b716017ab7c6c9ef1e20
|
|
description: The ID of the IdentityRequest object that was generated when the workflow launches
|
|
'400':
|
|
$ref: '../responses/400.yaml'
|
|
'401':
|
|
$ref: '../responses/401.yaml'
|
|
'403':
|
|
$ref: '../responses/403.yaml'
|
|
'404':
|
|
$ref: '../responses/404.yaml'
|
|
'429':
|
|
$ref: '../responses/429.yaml'
|
|
'500':
|
|
$ref: '../responses/500.yaml'
|