Upsert a Flow assignment.

PUT

/api/admin/flow-assignments

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/flow-assignments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "target_type": "oidc_client", "target_id": "client_123", "flow_kind": "login", "flow_id": "flow_01HR0X", "enabled": true }'

Assigns a published Flow to a tenant default, OIDC client, or SAML SP for the selected Flow kind. A target can have at most one Flow assignment per Flow kind; saving a new assignment replaces any previous assignment for the same target and kind.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

target_type

required

string

Allowed values: tenant oidc_client saml_sp

target_id

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

boolean

key

additional properties

Example

{
  "target_type": "oidc_client",
  "target_id": "client_123",
  "flow_kind": "login",
  "flow_id": "flow_01HR0X",
  "enabled": true
}

Responses

200

Flow assignment mutation response.

Media type application/json

object

success

required

boolean

key

additional properties

Example

{
  "success": true
}

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

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