Update Lifecycle State

PATCH 
/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id

Use this endpoint to update 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 stringrequired
Identity Profile ID.
Example: 2b838de9-db9b-abcf-e646-d4f274ad4238
lifecycle-state-id stringrequired
Lifecycle State ID.
Example: ef38f94347e94562b5bb8424a56397d8

application/json-patch+json

Body

array

required

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 [

op stringrequired

Possible values: [add, remove, replace, move, copy, test]

The operation to be performed

path stringrequired

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

oneOf

string

string

boolean

boolean

integer

integer

object

object

array

Array [

anyOf

MOD1

string

MOD2

integer

MOD3

object

]

• ]

Responses

200

Updated lifecycle state.

application/json

Schema

Schema

id string

Lifecycle state ID.

name string

Lifecycle state name.

technicalName string

Lifecycle state technical name. This is for internal use.

description string

Lifecycle state description.

created date-time

Lifecycle state created date.

modified date-time

Lifecycle state modified date.

enabled boolean

Indicates whether the lifecycle state is enabled or disabled.

identityCount int32

Number of identities that have the lifecycle state.

emailNotificationOption

object

notifyManagers boolean

If true, then the manager is notified of the lifecycle state change.

notifyAllAdmins boolean

If true, then all the admins are notified of the lifecycle state change.

notifySpecificUsers boolean

If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.

emailAddressList string[]

List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.

accountActions

object[]

Array [

action string

Possible values: [ENABLE, DISABLE]

Describes if action will be enabled or disabled

sourceIds string[]

List of source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features.

]

accessProfileIds string[]

List of access-profile IDs that are associated with the lifecycle state.

Example (from schema)

{
  "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"
  ]
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

403

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."
    }
  ]
}

429

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

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

500

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."
    }
  ]
}

Loading...