Create a screen.

POST

/api/admin/screens

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/screens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "screen_key": "example", "display_name": "example", "description": "example", "screen_kind": "registration", "fields": [ { "field": "example", "label": "example", "required": true, "block_type": "identity_field", "block_id": "example", "value_type": "text", "auth_method": "example", "text": "example", "help_text": "example", "placeholder": "example", "human_verification_timing": "initial", "display_condition": { "mode": "always", "feature": "passkey" }, "layout_columns": 1, "layout_column": 1, "order": 1 } ], "localizations": { "additionalProperty": "example" }, "settings": { "canvas_layout": "narrow" }, "is_active": true }'

Creates a custom reusable screen for Flow screen nodes.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

screen_key

string

display_name

required

string

description

string | null

screen_kind

required

string

Allowed values: registration profile_completion login consent code_input custom

fields

required

Array<object>

>= 1 items

object

field

required

string

label

required

string

required

boolean

block_type

string

Allowed values: identity_field auth_widget code_input_widget consent_widget heading text security_verification divider layout_row

block_id

string

value_type

string | null

Allowed values: text boolean

auth_method

string | null

text

string | null

help_text

string | null

placeholder

string | null

human_verification_timing

string | null

Allowed values: initial submit

display_condition

object

mode

required

string

Allowed values: always feature_enabled hidden

feature

string | null

Allowed values: passkey mail_otp mail_otp_totp totp external_idp directory_password

key

additional properties

layout_columns

integer | null

>= 1 <= 4

layout_column

integer | null

>= 1 <= 4

order

integer

localizations

object

key

additional properties

settings

object

canvas_layout

string

Allowed values: narrow wide

key

additional properties

is_active

boolean

Responses

201

Created screen.

Media type application/json

object

screen

object

key

additional properties

Example ^generated

{
  "screen": {
    "additionalProperty": "example"
  }
}

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

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