Sign in
Users

Create user

post/users

Request body

Response

OK

idinteger required

The ID of the user

resource_type'User' required

The resource type of the user

namestring required

The name of the user

emailstring email required

The email of the user.

created_atstring date-time required

When the user was created

updated_atstring date-time required

When the user was updated

metadataobject required

The metadata for the user.

  • Only basic types are allowed: string, null, integer, float, boolean.
  • Keys have a limit of 50 characters.
  • Values have a limit of 500 characters.
  • Keys number is limited to 50.
imagestring uri nullable required

The url to the image of the user.

otp_required_for_loginboolean required

Whether OTP/2FA is required for login.

password_flow_enabledboolean required

Whether the user can login with password flow. Only relevant for organizations.

access_enabledboolean required

Whether the user is allowed to access locks and elevators.

If the user is managed by SCIM, user access will be disabled unless both the access_enabled field and scim_access_enabled fields are set to true.

last_accessed_atstring date-time nullable required

When the user last accessed a door.

scim_access_enabledboolean required

Whether the user is allowed to access locks and elevators.

This field is read-only and can only be managed using SCIM. (See access_enabled)

It will always be set to true if the user is not managed by SCIM.

notesstring nullable required

The notes for the user.

organization_idinteger required

The organization ID of the user

confirmedboolean required
groups_countinteger required

Changes

No recorded changes to this endpoint across all 1 revision of this API.