Members

Create Member

post/members

Request body

Response

OK

idinteger required

The ID of the member

resource_type'Member' required

The resource type of the member

namestring required

The name of the member

imagestring nullable required

The URL to the profile picture of the member.

password_flow_enabledboolean required

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

access_enabledboolean required

Whether the member 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.

scim_access_enabledboolean required

Whether the member 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 member is not managed by SCIM.

last_accessed_atstring date-time nullable required

When the user last accessed a door.

created_atstring date-time required

When the member was created

updated_atstring date-time required

When the member was updated

role_idstring required

The role ID of the member.

notesstring nullable required

The notes for the member.

metadataobject required

The metadata for the member.

  • Nested values are not accepted.
  • Keys have a limit of 50 characters.
  • Values have a limit of 500 characters.
  • Keys number is limited to 50.
organization_idinteger nullable required

The organization ID of the member

user_idinteger required

The user ID of the member

{"stackTrail":"paths:/members:post:responses:200:content:application/json:schema:properties:place_id","oasType":"schema","type":"unknown"}
shares_countinteger required
confirmedboolean required

Changes

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