List Flow assignments.

GET

/api/admin/flow-assignments

Code sample: Shell / cURL

curl --request GET \
  --url 'https://auth.example.com/api/admin/flow-assignments?target_type=tenant' \
  --header 'Authorization: Bearer <token>'

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Query Parameters

flow_id

string

target_type

string

Allowed values: tenant oidc_client saml_sp

target_id

string

Responses

200

Flow assignment list response.

Media type application/json

object

assignments

required

Array<object>

object

id

required

string

tenant_id

required

string

target_type

required

string

Allowed values: tenant oidc_client saml_sp

target_id

required

string | null

flow_kind

required

Built-in Flow kind or a custom kind prefixed with custom:.

string

/^(login|registration|approve|account|custom:[a-z0-9][a-z0-9_-]{0,63})$/

flow_id

required

string

enabled

required

boolean

created_at

required

integer format: int64

updated_at

required

integer format: int64

key

additional properties

key

additional properties

Example

{
  "assignments": [
    {
      "target_type": "tenant",
      "flow_kind": "login"
    }
  ]
}

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

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