Update Lifecycle State
PATCH/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id
This API updates individual lifecycle state fields using the JSON Patch standard.
A token with ORG_ADMIN or API authority is required to call this API.
Request
Path Parameters
Identity Profile ID
Lifecycle State ID
- application/json-patch+json
Body
arrayrequired
A list of lifecycle state update operations according to the JSON Patch standard.
The following fields can be updated:
- enabled
- description
- accountActions
- accessProfileIds
- emailNotificationOption
- Array [
- string
- boolean
- integer
- array
- Array [
- MOD1
- MOD2
- ]
- ]
Possible values: [add
, remove
, replace
, move
, copy
, test
]
The operation to be performed
A string JSON Pointer representing the target path to an element to be affected by the operation
value object
The value to be used for the operation, required for "add" and "replace" operations
string
boolean
integer
string
integer
Responses
- 200
- 400
- 401
- 403
- 429
- 500
Updated lifecycle-state.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
lifecycle stat id.
Lifecycle-state name.
The technical name for lifecycle state. This is for internal use.
Lifecycle state description.
Lifecycle state created date.
Lifecycle state modified date.
Whether the lifecycle state is enabled or disabled.
Number of identities that have the lifecycle state.
emailNotificationOption object
If true, then the manager is notified of the lifecycle state change.
If true, then all the admins are notified of the lifecycle state change.
If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.
List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.
accountActions object[]
Possible values: [ENABLE
, DISABLE
]
Describes if action will be enabled or disabled
List of source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features.
List of access-profile IDs that are associated with the lifecycle state.
{
"id": "2c9180835d2e5168015d32f890ca1581",
"name": "Lifecycle Name",
"technicalName": "lifecycleTechnicalName",
"description": "LifecycleDescription",
"created": "2015-05-28T14:07:17Z",
"modified": "2015-05-28T14:07:17Z",
"enabled": true,
"identityCount": 12,
"emailNotificationOption": {
"notifyManagers": true,
"notifyAllAdmins": true,
"notifySpecificUsers": true,
"emailAddressList": [
"[email protected]",
"[email protected]"
]
},
"accountActions": [
{
"action": "ENABLE",
"sourceIds": [
"2c918084660f45d6016617daa9210584",
"2c918084660f45d6016617daa9210500"
]
}
],
"accessProfileIds": [
"2c918084660f45d6016617daa9210584",
"2c918084660f45d6016617daa9210500"
]
}
Client Error - Returned if the request body is invalid.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "JWT validation failed: JWT is expired"
}
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
- application/json
- Schema
- Example (from schema)
- 403
Schema
- Array [
- ]
- Array [
- ]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 403 response object
{
"detailCode": "403 Forbidden",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The server understood the request but refuses to authorize it."
}
]
}
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"message": " Rate Limit Exceeded "
}
Internal Server Error - Returned if there is an unexpected error.
- application/json
- Schema
- Example (from schema)
- 500
Schema
- Array [
- ]
- Array [
- ]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 500 response object
{
"detailCode": "500.0 Internal Fault",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "An internal fault occurred."
}
]
}