List Identity Controls

Identity Controls provide fine-grained control over identity activity and lifecycle states. Get the current control settings for an identity.

Pass the next_page_cursor value into the page_cursor field of a new request to retrieve the next page of results.

GET /v2/identity/controls

Try it

200

{
  "items": [
    {
      "id": "<string>",
      "type": "CLOSED",
      "set_by": "PAXOS",
      "is_overridable": true,
      "reason_code": "OTHER",
      "reason": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_page_cursor": "<string>"
}

OAuth Scope

identity:read_identity_control

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

identity_id · string · required

The Identity ID

include_deleted · boolean

Include deleted controls in the response.

limit · integer<int32>

Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000.

order · enum<string>

Return items in ascending (ASC) or descending (DESC) order. Defaults to DESC.

Available options: DESC, ASC

order_by · enum<string>

The specific method by which the returned results will be ordered. Defaults to CREATED_AT.

Available options: CREATED_AT

page_cursor · string

Optional: Cursor for getting the next page of results.

Response

200

application/json

A successful response.

items · object[]

The list of identity controls.

Show child attributes

items. id · string

Unique identifier for this control

items. type · enum<string>

The type of control applied to an identity.

• CLOSED: Identity is closed and cannot perform any actions
• FROZEN: Identity is frozen due to compliance reasons
• DORMANT: Identity is dormant due to inactivity

Available options: CLOSED, FROZEN, DORMANT

items. set_by · enum<string>

Indicates who set the control.

• PAXOS: Control was set by Paxos (e.g., for compliance or risk reasons)
• CLIENT: Control was set by the client application

Available options: PAXOS, CLIENT

items. is_overridable · boolean

Whether this control can be deleted by the client application

items. reason_code · enum<string>

Reason code for why a control was applied.

• OTHER: Miscellaneous reason
• END_USER_REQUEST: Control applied at the end user's request
• COMPLIANCE: Control applied for compliance or regulatory reasons
• INACTIVITY: Identity is has been inactive for an extended period of time

Available options: OTHER, END_USER_REQUEST, COMPLIANCE, INACTIVITY

items. reason · string

Freetext reason why this identity control was set

items. created_at · string<date-time>

Time this identity control was created

items. deleted_at · string<date-time>

Time this identity control was deleted

next_page_cursor · string

Cursor token for fetching the next page. Empty if there are no more pages.