List directory migration user states

GET

/api/admin/tenants/{tenantId}/directory-auth/migration/user-states

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/tenants/example/directory-auth/migration/user-states \
  --header 'Authorization: Bearer <token>'

Lists per-user migration states for explicit migration campaigns.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

tenantId

required

string

Query Parameters

state

string

campaign_id

string

user_id

string

limit

integer

>= 1 <= 100

Responses

200

Directory migration user states.

Media type application/json

object

tenantId

required

string

items

required

Array<object>

object

id

required

string

tenant_id

required

string

campaign_id

required

string

user_id

string

nullable

connector_id

string

nullable

directory_subject

string

nullable

cohort_key

string

nullable

state

required

string

Allowed values: not_applicable eligible prompted deferred passkey_required enrolled blocked recovered

first_directory_login_at

integer

nullable

prompted_at

integer

nullable

deferred_until

integer

nullable

passkey_required_at

integer

nullable

enrolled_at

integer

nullable

blocked_reason

string

nullable

recovery_reason

string

nullable

reset_count

integer

last_reset_at

integer

nullable

last_reset_by

string

nullable

last_reset_reason

string

nullable

created_at

required

integer

updated_at

required

integer

Example

{
  "items": [
    {
      "state": "not_applicable"
    }
  ]
}

400

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

401

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

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