core_tokens_partial_update

PATCH 
/api/v3//core/tokens/:identifier/

Token Viewset

Request

Path Parameters

identifier stringrequired

application/json

Body

managedManaged by authentik (string)nullable
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Possible values: non-empty
identifierstring
Possible values: non-empty and <= 255 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$
intentIntentEnum (string)
Possible values: [verification, api, recovery, app_password]
userinteger
descriptionstring
expiresdate-timenullable
expiringboolean

Responses

200

application/json

Schema

Schema

pkuuidrequired
managedManaged by authentik (string)nullable
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
identifierstringrequired
Possible values: <= 255 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$
intentIntentEnum (string)
Possible values: [verification, api, recovery, app_password]
userinteger
user_obj object
User Serializer
pkID (integer)required
usernamestringrequired
Possible values: <= 150 characters
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
is_superuserbooleanrequired
groupsuuid[]
groups_obj object[]nullablerequired
Array [
pkuuidrequired
num_pkintegerrequired
Get a numerical, int32 ID for the group
namestringrequired
is_superuserboolean
Users added to this group will be superusers.
parentuuidnullable
parent_namestringnullablerequired
attributes object
property name*any
]
emailemail
Possible values: <= 254 characters
avatarstringrequired
User's avatar, either a http/https URL or a data URI
attributes object
property name*any
uidstringrequired
pathstring
typeUserTypeEnum (string)
Possible values: [internal, external, service_account, internal_service_account]
uuiduuidrequired
password_change_datedate-timerequired
descriptionstring
expiresdate-timenullable
expiringboolean

Example (auto)

{
  "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "managed": "string",
  "identifier": "string",
  "intent": "verification",
  "user": 0,
  "user_obj": {
    "pk": 0,
    "username": "string",
    "name": "string",
    "is_active": true,
    "last_login": "2024-07-29T15:51:28.071Z",
    "is_superuser": true,
    "groups": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "groups_obj": [
      {
        "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "num_pk": 0,
        "name": "string",
        "is_superuser": true,
        "parent": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "parent_name": "string",
        "attributes": {}
      }
    ],
    "email": "user@example.com",
    "avatar": "string",
    "attributes": {},
    "uid": "string",
    "path": "string",
    "type": "internal",
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "password_change_date": "2024-07-29T15:51:28.071Z"
  },
  "description": "string",
  "expires": "2024-07-29T15:51:28.071Z",
  "expiring": true
}

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

identifier — pathrequired

Body

{
  "managed": "string",
  "identifier": "string",
  "intent": "verification",
  "user": 0,
  "description": "string",
  "expires": "2024-07-29T15:51:28.071Z",
  "expiring": true
}