stages_authenticator_totp_update
PUT/api/v3//stages/authenticator/totp/:stage_uuid/
AuthenticatorTOTPStage Viewset
Request
Path Parameters
stage_uuid uuidrequired
A UUID string identifying this TOTP Authenticator Setup Stage.
- application/json
Body
required
name stringrequired
Possible values: non-empty
flow_set
object[]
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
digits DigitsEnum (string)required
Possible values: [6
, 8
]
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
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[]
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
digits DigitsEnum (string)required
Possible values: [6
, 8
]
{
"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",
"background": "string",
"policy_engine_mode": "all",
"compatibility_mode": true,
"export_url": "string",
"layout": "stacked"
}
],
"configure_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"friendly_name": "string",
"digits": "6"
}
- application/json
- Schema
- Example (from schema)
Schema
non_field_errors string[]
code string
property name* any
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
detail stringrequired
code string
{
"detail": "string",
"code": "string"
}
Authorization: http
name: authentiktype: httpscheme: bearer
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "/api/v3/stages/authenticator/totp/:stage_uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var content = new StringContent("{\n \"name\": \"string\",\n \"flow_set\": [\n {\n \"name\": \"string\",\n \"slug\": \"string\",\n \"title\": \"string\",\n \"designation\": \"authentication\",\n \"policy_engine_mode\": \"all\",\n \"compatibility_mode\": true,\n \"layout\": \"stacked\",\n \"denied_action\": \"message_continue\"\n }\n ],\n \"configure_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"friendly_name\": \"string\",\n \"digits\": \"6\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());