core

User Viewset

post/core/users/

Request

  • Base URL: https://api.goauthentik.io/api/v3
  • URL: https://api.goauthentik.io/api/v3/core/users/
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer+agent

Request body

usernamestring required
namestring required

User's display name.

is_activeboolean

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

last_loginstring date-time nullable
groupsstring[]
rolesstring[]
emailstring email
attributesobject
pathstring
type'internal' | 'external' | 'service_account' | 'internal_service_account'

Response

pkinteger required
usernamestring required
namestring required

User's display name.

is_activeboolean

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

last_loginstring date-time nullable
date_joinedstring date-time required
is_superuserboolean required
groupsstring[]
rolesstring[]
emailstring email
avatarstring required

User's avatar, either a http/https URL or a data URI

attributesobject
uidstring required
pathstring
type'internal' | 'external' | 'service_account' | 'internal_service_account'
uuidstring uuid required
password_change_datestring date-time required
last_updatedstring date-time required

Changes

No recorded changes to this operation across all 22 revisions of this API.