Skip to main content

UserCreate

Payload used to create User. Required fields are name, email.

nameName (string)required
emailstring<email>required
alias object
anyOf
string
categoryCategory (string)
Default value: user
type object
anyOf
string
groupsstring[]
tagsstring[]
providerProvider (string)

Possible values: [local, oidc]

Default value: local
external_id object
anyOf
string
password object

Password (for local auth)

anyOf
string
is_activeIs Active (boolean)
Default value: true
avatar_config object

Avatar configuration as a JSON object containing only primitive values, limited to 4 KB.

anyOf
object
UserCreate
{
"name": "string",
"email": "user@example.com",
"alias": "string",
"category": "user",
"type": "string",
"groups": [
"string"
],
"tags": [
"string"
],
"provider": "local",
"external_id": "string",
"password": "string",
"is_active": true,
"avatar_config": {}
}