List account legal holds.

GET

/api/admin/users/{id}/legal-holds

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/users/example/legal-holds \
  --header 'Authorization: Bearer <token>'

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Header Parameters

X-Tenant-Id

string

Tenant selector for multi-tenant admin requests.

Responses

200

Account legal-hold history, newest first.

Media type application/json

object

items

required

Array<object>

<= 100 items

object

id

required

string

/^legal-hold:[a-f0-9]{64}$/

subject_type

required

string

Allowed values: account

account_id

required

string

state

required

string

Allowed values: active released expired

reason_code

required

string

>= 1 characters <= 64 characters /^[a-z0-9][a-z0-9._-]{0,63}$/

case_reference

required

string | null

<= 256 characters

expires_at

required

Unix epoch milliseconds; null means no automatic expiry.

integer | null

version

required

integer

>= 1

created_by

required

string

created_at

required

integer

released_by

required

string | null

released_at

required

integer | null

release_reason

required

string | null

updated_at

required

integer

key

additional properties

key

additional properties

Example

{
  "items": [
    {
      "subject_type": "account",
      "state": "active"
    }
  ]
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}