Skip to main content

User

This model represents user.

PropertyTypeDescriptionInformation
idintIdentifierUnique for single user.
first_namestringFirst name of a userMaximal length is 50 characters.
last_namestringLast name of a userMaximal length is 50 characters.
emailstringEmail addressShould be valid email address.
phonestringPhone numberShould be valid phone number.
is_activeboolUser activity statetrue for active user, false for inactive user. Inactive user is forbidden to sign in.
addressstringPhone numberAddress of User, max 255.
birth_datedateBirth date of User--
notestringNote of User--
two_factor_auth_enabledboolTwo factor authenticationtrue for enabled, false for disabled. Inactive that user has enabled two factor auth
user_group_idint or nullIdentifier of User group--
minimal_monthly_report_minutesintShould be a numberMinimal time each user should work in a month
vacation_daysintShould be a numberMax amount of vacation days for user
github_emailstring or nullShould be a stringGithub e-mail should by filled by those, who have different e-mail used on Github.
google_calendar_idstringGoogle Calendar IdNullable. Specifies user's calendar.

created_at | DateTime | User creation date and time | Read-only.

Example:

{
"id": 1,
"first_name": "Ketr",
"last_name": "Pnotek",
"email": "ketr.pnotek@mikihoklubik.cz",
"is_active": true,
"phone": null,
"address": null,
"birth_date": null,
"note": null,
"two_factor_auth_enabled": true,
"user_group_id": 1,
"created_at": "2022-11-29T16:11:54+0100",
"_links": [
{
"href": "/api/v0/users/1",
"rel": "self",
"type": "GET"
}
]
}