Skip to main content

stages_authenticator_sms_create

POST 
/api/v3//stages/authenticator/sms/

AuthenticatorSMSStage Viewset

Request​

Body

required

    name stringrequired

    Possible values: non-empty

    flow_set

    object[]

  • Array [

    • name stringrequired

    Possible values: non-empty

    slug stringrequired

    Visible in the URL.

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    title stringrequired

    Shown as the Title in Flow pages.

    Possible values: non-empty

    designation FlowDesignationEnum (string)required

    Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.

    Possible values: [authentication, authorization, invalidation, enrollment, unenrollment, recovery, stage_configuration]

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    compatibility_mode boolean

    Enable compatibility mode, increases compatibility with password managers on mobile devices.

    layout FlowLayoutEnum (string)

    Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]

    denied_action DeniedActionEnum (string)

    Configure what should happen when a flow denies access to a user.

    Possible values: [message_continue, message, continue]

  • ]

    • configure_flow uuidnullable

    Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage.

    friendly_name stringnullable

    Possible values: non-empty

    provider ProviderEnum (string)required

    Possible values: [twilio, generic]

    from_number stringrequired

    Possible values: non-empty

    account_sid stringrequired

    Possible values: non-empty

    auth stringrequired

    Possible values: non-empty

    auth_password string
    auth_type AuthTypeEnum (string)

    Possible values: [basic, bearer]

    verify_only boolean

    When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future.

    mapping uuidnullable

    Optionally modify the payload being sent to custom providers.

Responses​

Schema

    pk uuidrequired
    name stringrequired
    component stringrequired

    Get object type so that we know how to edit the object

    verbose_name stringrequired

    Return object's verbose_name

    verbose_name_plural stringrequired

    Return object's plural verbose_name

    meta_model_name stringrequired

    Return internal model name

    flow_set

    object[]

  • Array [

    • pk uuidrequired
    policybindingmodel_ptr_id uuidrequired
    name stringrequired
    slug stringrequired

    Visible in the URL.

    Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    title stringrequired

    Shown as the Title in Flow pages.

    designation FlowDesignationEnum (string)required

    Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.

    Possible values: [authentication, authorization, invalidation, enrollment, unenrollment, recovery, stage_configuration]

    background stringrequired

    Get the URL to the background image. If the name is /static or starts with http it is returned as-is

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    compatibility_mode boolean

    Enable compatibility mode, increases compatibility with password managers on mobile devices.

    export_url stringrequired

    Get export URL for flow

    layout FlowLayoutEnum (string)

    Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]

    denied_action DeniedActionEnum (string)

    Configure what should happen when a flow denies access to a user.

    Possible values: [message_continue, message, continue]

  • ]

    • configure_flow uuidnullable

    Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage.

    friendly_name stringnullable
    provider ProviderEnum (string)required

    Possible values: [twilio, generic]

    from_number stringrequired
    account_sid stringrequired
    auth stringrequired
    auth_password string
    auth_type AuthTypeEnum (string)

    Possible values: [basic, bearer]

    verify_only boolean

    When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future.

    mapping uuidnullable

    Optionally modify the payload being sent to custom providers.

Authorization: http

name: authentiktype: httpscheme: bearer

Request Collapse all
Base URL
/api/v3
Auth
Body required
{
  "name": "string",
  "flow_set": [
    {
      "name": "string",
      "slug": "string",
      "title": "string",
      "designation": "authentication",
      "policy_engine_mode": "all",
      "compatibility_mode": true,
      "layout": "stacked",
      "denied_action": "message_continue"
    }
  ],
  "configure_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "friendly_name": "string",
  "provider": "twilio",
  "from_number": "string",
  "account_sid": "string",
  "auth": "string",
  "auth_password": "string",
  "auth_type": "basic",
  "verify_only": true,
  "mapping": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}