Skip to main content

UserResponse

User API response. Excludes password_hash by design.

id object
anyOf
string
nameName (string)required
emailstring<email>required

Email address

alias object
anyOf
string
categoryCategory (string)
Default value: user
type object
anyOf
string
groupsstring[]

Group ID list

tagsstring[]
created_at object
anyOf
integer
updated_at object
anyOf
integer
providerProvider (string)

Auth provider (local or oidc)

Possible values: [local, oidc]

Default value: local
external_id object

OIDC external user ID

anyOf
string
synced_at object
anyOf
integer
is_activeIs Active (boolean)

Whether the account is active

Default value: true
display_name object

User-override display name

anyOf
string
avatar_config object

Stored avatar configuration as a JSON object, or null when no configuration is set.

anyOf
object
avatar_url object

Signed proxy URL for the uploaded avatar image, or null when no avatar image has been uploaded.

anyOf
string
itemItem (string)requireddeprecated
UserResponse
{
"id": "string",
"name": "string",
"email": "user@example.com",
"alias": "string",
"category": "user",
"type": "string",
"groups": [
"string"
],
"tags": [
"string"
],
"created_at": 0,
"updated_at": 0,
"provider": "local",
"external_id": "string",
"synced_at": 0,
"is_active": true,
"display_name": "string",
"avatar_config": {},
"avatar_url": "string"
}