Units

A unit is a sub-grouping within an installation. A common use case for a unit might be an individual apartment which is located within an apartment block. A unit can also often be considered a "rentable space". For example, it could be an office space located within a larger office building that contains multiple office spaces rented by different companies. Other use cases include hotel rooms (units) inside a hotel (installation).

name string

Resource name of the unit. It must have the format installations/*/units/*, for example: installations/surelock-homes-hq/units/101.

display_name string

Display name.

move_in_time timestamp

Time the unit was moved in.

move_out_time timestamp

Time the unit was moved out.

privacy_settings PrivacySettings

The privacy settings of the unit. Can either be enabled or disabled. If enabled, owners and installation managers can see neither events nor users that belong to the unit.

default_access_rights array of string objects

The resource names of the default access rights to be associated within this unit. For example: installations/surelock-homes-hq/access-rights/baskerville. A maximum of 5 access rights can be specified.

manager string

The resource name of the manager resource that currently controls this unit. A manager resource is any resource (such as a booking) that creates and governs the lifecycle of this unit. Example: "installations/surelock-homes-hq/bookings/watson-family-booking" If set, this unit is considered "managed" and cannot be modified directly. It behaves as a side-effect of the manager resource. For example, a unit may become managed when a booking is checked in, and unmanaged when the booking is checked out.

name string required

Output only. Resource name of the policy. It must have the format of installations/*/units/*/iam-policies, for example: installations/surelock-homes-hq/units/101/iam-policies/standard.

member string

Specifies the identity requesting access to this resource.

roles array of string objects

The names of the roles this policy grants.

enabled boolean

The privacy status of the unit.

given_name string

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.

access_rights array of string objects

The access rights resource names to bind as an association to the occupant. For example: installations/surelock-homes-hq/units/101/access-rights/baskerville.

iam_roles array of string objects

The IAM roles to bind as an association to the occupant. For example: iam-roles/unit.admin.

family_name string

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 string

The email address of the occupant. It must be unique within the unit.

Representation of an IAM policy inside the API

name string required

Output only. Resource name of the policy. It must have the format of installations/*/units/*/iam-policies, for example: installations/surelock-homes-hq/units/101/iam-policies/standard.

member string

Specifies the identity requesting access to this resource.

roles array of string objects

The names of the roles this policy grants.

Representation of a unit resource inside the API

name string

Resource name of the unit. It must have the format installations/*/units/*, for example: installations/surelock-homes-hq/units/101.

display_name string

Display name.

move_in_time timestamp

Time the unit was moved in.

move_out_time timestamp

Time the unit was moved out.

privacy_settings PrivacySettings

The privacy settings of the unit. Can either be enabled or disabled. If enabled, owners and installation managers can see neither events nor users that belong to the unit.

default_access_rights array of string objects

manager string

Create a unit

Creates a new unit.

Input

parent string required

Resource name of the parent resource under which the unit is created.

unit Unit required

The unit resource to be created. Client must not set the Unit.name field.

unit_id string

The unit id to use for this unit. If it's empty the server will autogenerate a unique identifier.

Output

name string

Resource name of the unit. It must have the format installations/*/units/*,

display_name string

Display name.

move_in_time timestamp

Time the unit was moved in.

move_out_time timestamp

Time the unit was moved out.

privacy_settings PrivacySettings

The privacy settings of the unit. Can either be enabled or disabled. If enabled, owners and installation managers can see neither events nor users that belong to the unit.

default_access_rights array of string objects

manager string

Get an existing unit

Retrieves an existing unit.

Input

name string required

The name of the requested unit resource.

Output

name string

Resource name of the unit. It must have the format installations/*/units/*,

display_name string

Display name.

move_in_time timestamp

Time the unit was moved in.

move_out_time timestamp

Time the unit was moved out.

privacy_settings PrivacySettings

The privacy settings of the unit. Can either be enabled or disabled. If enabled, owners and installation managers can see neither events nor users that belong to the unit.

default_access_rights array of string objects

manager string

List units

Returns a list of units that have been previously created.

Input

parent string required

The parent resource name,

page_size integer required

The maximum number of items to return.

page_token string

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

filter string

A filter that chooses which units to return.

order_by string

How the results should be sorted.

Output

units array of Unit objects

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

next_page_token string

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

Update an existing unit

Updates an existing unit.

Input

unit Unit

The unit resource which replaces the resource on the server.

update_mask fieldmask

The update mask applied to the resource.

Output

name string

Resource name of the unit. It must have the format installations/*/units/*,

display_name string

Display name.

move_in_time timestamp

Time the unit was moved in.

move_out_time timestamp

Time the unit was moved out.

privacy_settings PrivacySettings

The privacy settings of the unit. Can either be enabled or disabled. If enabled, owners and installation managers can see neither events nor users that belong to the unit.

default_access_rights array of string objects

manager string

Delete a unit

Permanently deletes a unit. This cannot be undone.

Input

name string required

The resource name of the unit to be deleted,

Output

No return value.

Clean out a unit

Deprecated: Use MoveOutUnit

Input

name string

The resource name of the unit to be cleaned out.

Output

Move in a unit

Moves in a unit by creating new occupants and associating them with the unit.

Input

name string

Resource name of the parent resource where to move in the unit.

occupants array of Occupant objects

The occupants to be created inside the unit.

Output

Move out a unit

Moves out a unit by deleting all the occupants belonging to it. This process implicitly entails the blocking of the keys that were active within the unit. Moving out a unit will not delete the access rights and the associated access points that belong to the unit.

Input

name string

The resource name of the unit to be moved out.

Output

Create a policy

Creates a new policy.

Input

parent string required

Resource name of the parent resource where to create the policy.

policy_id string

The policy ID to use for policy. In case it's empty the server will autogenerate a unique identifier.

policy Policy required

The policy resource to be created. Client must not set the Policy.name field.

Output

name string required

Output only. Resource name of the policy. It must have the format of installations/*/units/*/iam-policies,

member string

Specifies the identity requesting access to this resource.

roles array of string objects

The names of the roles this policy grants.

Get an existing policy

Retrieves an existing policy.

Input

name string required

The name of the requested policy resource.

Output

name string required

Output only. Resource name of the policy. It must have the format of installations/*/units/*/iam-policies,

member string

Specifies the identity requesting access to this resource.

roles array of string objects

The names of the roles this policy grants.

List policies

Returns a list of policies that have been previously created.

Input

parent string required

The parent resource name,

page_size integer required

The maximum number of items to return.

page_token string

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

filter string

A filter that chooses which policies to return.

order_by string

How the results should be sorted.

Output

policies array of Policy objects

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

next_page_token string

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

Update an existing policy

Updates an existing policy.

Input

policy Policy

The policy resource which replaces the resource on the server.

update_mask fieldmask

The update mask applied to the resource.

Output

name string required

Output only. Resource name of the policy. It must have the format of installations/*/units/*/iam-policies,

member string

Specifies the identity requesting access to this resource.

roles array of string objects

The names of the roles this policy grants.

Delete a policy

Permanently deletes a policy. This cannot be undone.

Input

name string required

The resource name of the policy to be deleted,

Output

No return value.

Test a permission

Returns permissions that a caller has on the installation. If the installation does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Input

unit string required

The resource name for which the policy detail is being requested,

permissions array of string objects

The set of permissions to check for the resource_name. Permissions with wildcards (such as '' or 'nebula.access-point.') are not allowed.

Output

permissions array of string objects

A subset of TestPermissionsRequest.permissions that the caller is allowed.