authenticators_totp_partial_update

PATCH 
/api/v3//authenticators/totp/:id/

Viewset for totp authenticator devices

Request

Path Parameters

id integerrequired

A unique integer value identifying this TOTP Device.

application/json

Body

namestring

The human-readable name of this device.

Possible values: non-empty and <= 64 characters

Responses

200

application/json

Schema

Schema

namestringrequired
The human-readable name of this device.
Possible values: <= 64 characters
pkID (integer)required
user object
Stripped down user serializer to show relevant users for groups
pkID (integer)required
usernamestringrequired
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
Possible values: <= 150 characters, Value must match regular expression ^[\w.@+-]+$
namestringrequired
User's display name.
is_activeActive (boolean)
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_logindate-timenullable
emailemail
Possible values: <= 254 characters
attributes object
property name*any
uidstringrequired

Example (auto)

{
  "name": "string",
  "pk": 0,
  "user": {
    "pk": 0,
    "username": "string",
    "name": "string",
    "is_active": true,
    "last_login": "2024-07-29T15:51:28.071Z",
    "email": "user@example.com",
    "attributes": {},
    "uid": "string"
  }
}

400

application/json

Schema

Schema

non_field_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

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

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

id — pathrequired

Body

{
  "name": "string"
}