mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-10 04:19:19 +00:00
128 lines
3.4 KiB
YAML
128 lines
3.4 KiB
YAML
get:
|
|
operationId: listLifecycleStates
|
|
tags:
|
|
- Lifecycle States
|
|
summary: Lifecycle State
|
|
description: |
|
|
This endpoint returns a 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
|
|
- in: path
|
|
name: lifecycle-state-id
|
|
description: >-
|
|
Lifecycle State ID
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
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'
|
|
|
|
patch:
|
|
operationId: updateLifecycleStates
|
|
tags:
|
|
- Lifecycle States
|
|
summary: Update Lifecycle State
|
|
description: |
|
|
This API updates individual lifecycle state fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
|
|
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
|
|
- in: path
|
|
name: lifecycle-state-id
|
|
description: >-
|
|
Lifecycle State ID
|
|
required: true
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
required: true
|
|
description: |
|
|
A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
|
|
The following fields can be updated:
|
|
* enabled
|
|
* description
|
|
* accountActions
|
|
* accessProfileIds
|
|
* emailNotificationOption
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/JsonPatchOperation.yaml'
|
|
example:
|
|
- op: "replace"
|
|
path: "/description"
|
|
value: "Updated description!"
|
|
- op: "replace"
|
|
path: "/accessProfileIds"
|
|
value:
|
|
- "2c918087742bab150174407a80f3125e"
|
|
- "2c918087742bab150174407a80f3124f"
|
|
- op: "replace"
|
|
path: "/accountActions"
|
|
value:
|
|
- "action": "ENABLE"
|
|
"sourceIds":
|
|
- "2c9180846a2f82fb016a481c1b1560c5"
|
|
- "2c9180846a2f82fb016a481c1b1560cc"
|
|
- "action": "DISABLE"
|
|
"sourceIds":
|
|
- "2c91808869a0c9980169a207258513fb"
|
|
- op: "replace"
|
|
path: "/emailNotificationOption"
|
|
value:
|
|
"notifyManagers": true
|
|
"notifyAllAdmins": false
|
|
"notifySpecificUsers": false
|
|
"emailAddressList": []
|
|
responses:
|
|
'200':
|
|
description: >-
|
|
Updated 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'
|