Skip to main content

UserSafeRead

A platform user (without credentials).

idIdrequired

Unique numeric identifier of the record.

usernameUsernamerequired

The user's login name.

email object

Email used to match this local user during Yandex ID OAuth login, if configured.

anyOf
string
roleUserRolerequired

The user's role — user, manager, or admin.

Possible values: [user, manager, admin]

is_activeIs Active

Whether this user is allowed to authenticate and use the platform.

Default value: true
created_atdate-timerequired

Creation time (UTC, ISO 8601).

company_idsinteger[]

Company memberships granted to this user. Admin users can access all companies.

UserSafeRead
{
"id": 0,
"username": "string",
"email": "string",
"role": "user",
"is_active": true,
"created_at": "2024-07-29T15:51:28.071Z",
"company_ids": [
0
]
}