core_users_retrieve
GET/core/users/:id/
User Viewset
Request
Path Parameters
id integerrequired
A unique integer value identifying this User.
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
pk ID (integer)required
username stringrequired
Possible values: <= 150 characters
name stringrequired
User's display name.
is_active Active (boolean)
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_login date-timenullable
is_superuser booleanrequired
groups uuid[]
groups_obj
object[]
nullable
required
pk uuidrequired
num_pk integerrequired
Get a numerical, int32 ID for the group
name stringrequired
is_superuser boolean
Users added to this group will be superusers.
parent uuidnullable
parent_name stringnullablerequired
attributes
object
property name* any
email email
Possible values: <= 254 characters
avatar stringrequired
User's avatar, either a http/https URL or a data URI
attributes
object
property name* any
uid stringrequired
path string
type UserTypeEnum (string)
Possible values: [internal
, external
, service_account
, internal_service_account
]
uuid uuidrequired
{
"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"
}
- 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"
}
Loading...