Users

Resource name of the parent resource where the user is to be created.

The user resource to be created. Client must not set the User.name field.

The user id to use for this user. In case it's empty the server will autogenerate a unique identifier.

Resource name of the user. It must have the format of installations/*/users/*.

The personal name, forename or given name ("first name"). It could also contain a middle name. First name is not used because the given name is not placed first in some cultures.

The display name of the user, formed by concatenating the first and last name values.

Activation time independent of any time zone or calendar.

Expiration time independent of any time zone or calendar.

The URI to view the user photo.

The card key resource that belongs to the user.

The electronic key resource that belongs to the user.

The app key resource that belongs to the user.

The wallet key resource that belongs to the user.

The passcode resource that belongs to the user.

Indicates whether this user is blocked or not. A blocked user cannot perform any admin actions, that is, if they have a management role this will no longer be valid. If the user has a key then it will no longer unlock access points.

The name of the parent user of this user. Only users who have had keys shared with them will have this field set.

The surname or family name ("last name"). It could also contain more than one surname so that both matrilineal and patrilineal surnames can be included in one place. Last name is not used because the family name is not placed last in some cultures.

Email address.

The file resource name for the user photo. It must have the format of installations/surelock-homes-hq/files/01DSYSJ1PR36VVC3MRFRV4DC7G.

The resource name of the manager resource that owns this user. A manager resource is any resource (such as a booking) that creates and governs the lifecycle of this user. Example: "installations/surelock-homes-hq/bookings/watson-family-booking" If set, this user is considered "managed" and cannot be modified directly. It behaves as a side-effect of the manager resource.

The name of the requested user resource.

Resource name of the user. It must have the format of installations/*/users/*.

The personal name, forename or given name ("first name"). It could also contain a middle name. First name is not used because the given name is not placed first in some cultures.

The display name of the user, formed by concatenating the first and last name values.

Activation time independent of any time zone or calendar.

Expiration time independent of any time zone or calendar.

The URI to view the user photo.

The card key resource that belongs to the user.

The electronic key resource that belongs to the user.

The app key resource that belongs to the user.

The wallet key resource that belongs to the user.

The passcode resource that belongs to the user.

Indicates whether this user is blocked or not. A blocked user cannot perform any admin actions, that is, if they have a management role this will no longer be valid. If the user has a key then it will no longer unlock access points.

The name of the parent user of this user. Only users who have had keys shared with them will have this field set.

The surname or family name ("last name"). It could also contain more than one surname so that both matrilineal and patrilineal surnames can be included in one place. Last name is not used because the family name is not placed last in some cultures.

Email address.

The file resource name for the user photo. It must have the format of installations/surelock-homes-hq/files/01DSYSJ1PR36VVC3MRFRV4DC7G.

The resource name of the manager resource that owns this user. A manager resource is any resource (such as a booking) that creates and governs the lifecycle of this user. Example: "installations/surelock-homes-hq/bookings/watson-family-booking" If set, this user is considered "managed" and cannot be modified directly. It behaves as a side-effect of the manager resource.

Resource name of the parent of the users to be retreived.

The names of the users requested.

Users requested.

The parent resource name.

The maximum number of items to return.

The next_page_token value returned from a previous List request, if any.

A filter that chooses which users to return.

How the results should be sorted.

The field name should match the noun users in the method name. There will be a maximum number of items returned based on the page_size field in the request.

Token to retrieve the next page of results, or empty if there are no more results in the list.

The total number of users in all pages, irrespective of any pagination. This is an estimated number based on the requested filter, and it may change in subsequent pages.

The user resource which replaces the resource on the server.

The update mask applied to the resource.

Resource name of the user. It must have the format of installations/*/users/*.

The personal name, forename or given name ("first name"). It could also contain a middle name. First name is not used because the given name is not placed first in some cultures.

The display name of the user, formed by concatenating the first and last name values.

Activation time independent of any time zone or calendar.

Expiration time independent of any time zone or calendar.

The URI to view the user photo.

The card key resource that belongs to the user.

The electronic key resource that belongs to the user.

The app key resource that belongs to the user.

The wallet key resource that belongs to the user.

The passcode resource that belongs to the user.

Indicates whether this user is blocked or not. A blocked user cannot perform any admin actions, that is, if they have a management role this will no longer be valid. If the user has a key then it will no longer unlock access points.

The name of the parent user of this user. Only users who have had keys shared with them will have this field set.

The surname or family name ("last name"). It could also contain more than one surname so that both matrilineal and patrilineal surnames can be included in one place. Last name is not used because the family name is not placed last in some cultures.

Email address.

The file resource name for the user photo. It must have the format of installations/surelock-homes-hq/files/01DSYSJ1PR36VVC3MRFRV4DC7G.

The resource name of the manager resource that owns this user. A manager resource is any resource (such as a booking) that creates and governs the lifecycle of this user. Example: "installations/surelock-homes-hq/bookings/watson-family-booking" If set, this user is considered "managed" and cannot be modified directly. It behaves as a side-effect of the manager resource.

The resource name of the user to be deleted.

The resource name of the user to be blocked.

The resource name of the user to be unblocked.

Resource name of the parent resource where the users's access right association is to be created.

The user's access right association resource to be created. Client must not set the UserAccessRight.name field.

Resource name of the user's access right association. It must have the format of installations/*/users/*/access-rights/*.

The access right resource name to bind as an association to the parent access point.

Display name of the associated entity. In this case an access right.

The schedules for the user's access right. If set, this can only be more restrictive than the schedules defined in the associated access right.

The computed effective schedules for the user's access right based on the given parent resource.

Activation time independent of any time zone or calendar. User access right's association activation time rules: 1. Activation time must be specified in multiples of 10 minutes. Valid examples: 07:40, 12:30, 18:10. Invalid examples: 12:32, 10:15. 2. If no activation time is provided, the current time is used, truncated to the nearest earlier multiple of 10 minutes. For example, if the current time is 14:46, the system will use 14:40.

Expiration time independent of any time zone or calendar. User access right's association expiration time rules: 1. Expiration time must be specified in multiples of 10 minutes. Valid examples: 07:40, 12:30, 18:10. Invalid examples: 12:32, 10:15. 2. When specifying expiration time, it must: - Be at least 10 minutes after activation time. - Always be a multiple of 10 minutes. The system does not round or adjust expiration time for you. For example, if you attempt to set 10:15, the system will reject it.

The resource name of the manager resource that owns this user access right. A manager resource is any resource (such as a booking) that creates and governs the lifecycle of this user access right. Example: "installations/surelock-homes-hq/bookings/watson-family-booking" If set, this user access right is considered "managed" and cannot be modified directly. It behaves as a side-effect of the manager resource.

The name of the requested user's access right association resource.

Resource name of the user's access right association. It must have the format of installations/*/users/*/access-rights/*.

The access right resource name to bind as an association to the parent access point.

Display name of the associated entity. In this case an access right.

The schedules for the user's access right. If set, this can only be more restrictive than the schedules defined in the associated access right.

The computed effective schedules for the user's access right based on the given parent resource.

Activation time independent of any time zone or calendar. User access right's association activation time rules: 1. Activation time must be specified in multiples of 10 minutes. Valid examples: 07:40, 12:30, 18:10. Invalid examples: 12:32, 10:15. 2. If no activation time is provided, the current time is used, truncated to the nearest earlier multiple of 10 minutes. For example, if the current time is 14:46, the system will use 14:40.

Expiration time independent of any time zone or calendar. User access right's association expiration time rules: 1. Expiration time must be specified in multiples of 10 minutes. Valid examples: 07:40, 12:30, 18:10. Invalid examples: 12:32, 10:15. 2. When specifying expiration time, it must: - Be at least 10 minutes after activation time. - Always be a multiple of 10 minutes. The system does not round or adjust expiration time for you. For example, if you attempt to set 10:15, the system will reject it.

The resource name of the manager resource that owns this user access right. A manager resource is any resource (such as a booking) that creates and governs the lifecycle of this user access right. Example: "installations/surelock-homes-hq/bookings/watson-family-booking" If set, this user access right is considered "managed" and cannot be modified directly. It behaves as a side-effect of the manager resource.

The parent resource name.

The maximum number of items to return.

The next_page_token value returned from a previous List request, if any.

A filter that chooses which user's access right associations to return.

How the results should be sorted.

The field name should match the noun user_access_rights in the method name. There will be a maximum number of items returned based on the page_size field in the request.

Token to retrieve the next page of results, or empty if there are no more results in the list.

The user's access right resource which replaces the resource on the server.

The update mask applied to the resource.

Resource name of the user's access right association. It must have the format of installations/*/users/*/access-rights/*.

The access right resource name to bind as an association to the parent access point.

Display name of the associated entity. In this case an access right.

The schedules for the user's access right. If set, this can only be more restrictive than the schedules defined in the associated access right.

The computed effective schedules for the user's access right based on the given parent resource.

Activation time independent of any time zone or calendar. User access right's association activation time rules: 1. Activation time must be specified in multiples of 10 minutes. Valid examples: 07:40, 12:30, 18:10. Invalid examples: 12:32, 10:15. 2. If no activation time is provided, the current time is used, truncated to the nearest earlier multiple of 10 minutes. For example, if the current time is 14:46, the system will use 14:40.

Expiration time independent of any time zone or calendar. User access right's association expiration time rules: 1. Expiration time must be specified in multiples of 10 minutes. Valid examples: 07:40, 12:30, 18:10. Invalid examples: 12:32, 10:15. 2. When specifying expiration time, it must: - Be at least 10 minutes after activation time. - Always be a multiple of 10 minutes. The system does not round or adjust expiration time for you. For example, if you attempt to set 10:15, the system will reject it.

The resource name of the manager resource that owns this user access right. A manager resource is any resource (such as a booking) that creates and governs the lifecycle of this user access right. Example: "installations/surelock-homes-hq/bookings/watson-family-booking" If set, this user access right is considered "managed" and cannot be modified directly. It behaves as a side-effect of the manager resource.

The resource name of the user's access right association to be deleted.

The name of the requested user's card key to be assigned.

Unique identifier of the physical card. Length dependent of technology. Max length for ISO14443-3 is 10 bytes.

Output only. Resource name of the user's card key. It must have the format of installations/*/users/*/card-key.

Unique identifier of the physical card. Length dependent of technology. Max length for ISO14443-3 is 10 bytes.

Indicates whether this card key has been assigned, not assigned or is active and ready for use. This field cannot be modified using a standard UpdateCardKey operation. To change the value of this field, you must call EncodeCardKey. If the value is NOT_ASSIGNED it also applies to cases where the assignation process has been initiated, but not completed.

Indicates whether this card key has pending updates or not. This field cannot be modified using a standard UpdateCardKey operation. To change the value of this field, you must call OutdateCardKey.

The name of the requested user's card key to be canceled.

Output only. Resource name of the user's card key. It must have the format of installations/*/users/*/card-key.

Unique identifier of the physical card. Length dependent of technology. Max length for ISO14443-3 is 10 bytes.

Indicates whether this card key has been assigned, not assigned or is active and ready for use. This field cannot be modified using a standard UpdateCardKey operation. To change the value of this field, you must call EncodeCardKey. If the value is NOT_ASSIGNED it also applies to cases where the assignation process has been initiated, but not completed.

Indicates whether this card key has pending updates or not. This field cannot be modified using a standard UpdateCardKey operation. To change the value of this field, you must call OutdateCardKey.

The name of the requested user's card key to be encoded.

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

The name of the requested user's app key to be assigned.

Resource name of the user's app key. It must have the format of installations/*/users/*/app-key.

Indicates whether this app key has been assigned or not. This field cannot be modified using a standard UpdateAppKey operation. To change the value of this field, you must call AssignAppKey.

Indicates whether this app key has pending updates or not. This field cannot be modified using a standard UpdateAppKey operation. To change the value of this field, you must call OutdateAppKey.

The name of the requested user's app key to be canceled.

Resource name of the user's app key. It must have the format of installations/*/users/*/app-key.

Indicates whether this app key has been assigned or not. This field cannot be modified using a standard UpdateAppKey operation. To change the value of this field, you must call AssignAppKey.

Indicates whether this app key has pending updates or not. This field cannot be modified using a standard UpdateAppKey operation. To change the value of this field, you must call OutdateAppKey.

The name of the requested user's app key.

Computed data of the requested app key.

The name of the requested user's wallet key to be assigned.

The newly-assigned wallet key.

The access URL which contains the data to allow end users to sign in to SALTO Identity seamlessly and which is also used in the add-to-wallet process.

The name of the requested user's wallet key to be canceled.

The canceled wallet key.

The name of the requested user's passcode to be assigned.

The assigned passcode.

The passcode value.

The name of the requested user's passcode to be canceled.

The canceled passcode.

The name of the requested user's electronic key to be assigned.

Globally unique identifier that is used across all devices manufactured by SALTO.

The assigned electronic key.

The name of the requested user's electronic key to be canceled.

The canceled electronic key.

The name of the requested user's electronic key to be encoded.

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.