stages_authenticator_sms_update
PUT/stages/authenticator/sms/:stage_uuid/
AuthenticatorSMSStage Viewset
Request
Path Parameters
A UUID string identifying this SMS Authenticator Setup Stage.
- application/json
Body
required
Array [
]
Possible values: non-empty
flow_set
object[]
Possible values: non-empty
Possible values: non-empty
and <= 50 characters
, Value must match regular expression ^[-a-zA-Z0-9_]+$
Visible in the URL.
Possible values: non-empty
Shown as the Title in Flow pages.
Possible values: [authentication
, authorization
, invalidation
, enrollment
, unenrollment
, recovery
, stage_configuration
]
Possible values: [all
, any
]
Enable compatibility mode, increases compatibility with password managers on mobile devices.
Possible values: [stacked
, content_left
, content_right
, sidebar_left
, sidebar_right
]
Possible values: [message_continue
, message
, continue
]
Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage.
Possible values: non-empty
Possible values: [twilio
, generic
]
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
Possible values: [basic
, bearer
]
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.
Optionally modify the payload being sent to custom providers.
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Get object type so that we know how to edit the object
Return object's verbose_name
Return object's plural verbose_name
Return internal model name
flow_set
object[]
Possible values: <= 50 characters
, Value must match regular expression ^[-a-zA-Z0-9_]+$
Visible in the URL.
Shown as the Title in Flow pages.
Possible values: [authentication
, authorization
, invalidation
, enrollment
, unenrollment
, recovery
, stage_configuration
]
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Possible values: [all
, any
]
Enable compatibility mode, increases compatibility with password managers on mobile devices.
Get export URL for flow
Possible values: [stacked
, content_left
, content_right
, sidebar_left
, sidebar_right
]
Possible values: [message_continue
, message
, continue
]
Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage.
Possible values: [twilio
, generic
]
Possible values: [basic
, bearer
]
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.
Optionally modify the payload being sent to custom providers.
{
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"component": "string",
"verbose_name": "string",
"verbose_name_plural": "string",
"meta_model_name": "string",
"flow_set": [
{
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"policybindingmodel_ptr_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"slug": "string",
"title": "string",
"designation": "authentication",
"background": "string",
"policy_engine_mode": "all",
"compatibility_mode": true,
"export_url": "string",
"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"
}
- application/json
- Schema
- Example (from schema)
Schema
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "string",
"code": "string"
}