Access rights

Access rights simplify the management of access permissions for large sets of users with similar access profiles. An access right can contain multiple access points. Access rights determine who can enter where, and when. This service is responsible for managing access right resources as well as their association with access points.

See also the specific access rights guide for more information on how to use access rights in the Nebula API: Access rights and user access rights in Salto Nebula.

name string

Resource name of the access right. It must have the format of installations/*/access-rights/*. For example: installations/surelock-homes-hq/access-rights/baskerville.

display_name string

Display name of the access right.

schedules array of Schedule objects

Schedules in which this access right is applied.

name string

Resource name of the access right's access point association. It must have the format of installations/*/access-rights/*/access-points/*. For example: installations/surelock-homes-hq/access-rights/baskerville/access-points/baker-street-entrance.

access_point string

The access point resource name to bind as an association to the parent access right. For example: installations/surelock-homes-hq/access-points/baker-street-entrance.

display_name string

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

name string

Resource name of the access right's access point group association. It must have the format of installations/*/access-rights/*/access-point-groups/*. For example: installations/surelock-homes-hq/access-rights/baskerville/access-point-groups/common-accesses.

access_point_group string

The access point group resource name to bind as an association to the parent access right. For example: installations/surelock-homes-hq/access-point-groups/common-accesses.

display_name string

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

name string

Resource name of the access right's destination association. It must have the format of installations/*/access-rights/*/destinations/*. For example: installations/surelock-homes-hq/access-rights/baskerville/destinations/elevator-floor-5.

destination string

The destination resource name to bind as an association to the parent access right. For example: installations/surelock-homes-hq/destinations/elevator-floor-5.

display_name string

Display name of the associated entity. In this case a destination.

days array of Day objects

Days when it's valid.

start_time TimeOfDay

Start time of day when schedule starts being valid.

end_time TimeOfDay

End time of day when schedule ends being valid.

day_type enum DayType

Day type

Possible enum values

DAY_TYPE_UNSPECIFIED

Value 0. Unspecified

NORMAL

Value 1. Normal day

HOLIDAY

Value 2. Holidays

SPECIAL_1

Value 3. Special day type 1

SPECIAL_2

Value 4. Special day type 2

day_of_week enum DayOfWeek

In case day_type is NORMAL, the specific day of the week.

Possible enum values

DAY_OF_WEEK_UNSPECIFIED

Value 0. Unspecified

MONDAY

Value 1. Monday

TUESDAY

Value 2. Tuesday

WEDNESDAY

Value 3. Wednesday

THURSDAY

Value 4. Thursday

FRIDAY

Value 5. Friday

SATURDAY

Value 6. Saturday

SUNDAY

Value 7. Sunday

hours integer

Hours of day in 24 hour format. Should be from 0 to 23.

minutes integer

Minutes of hour of day. Must be from 0 to 59.

seconds integer

Seconds of minutes of the time. Must be from 0 to 59.

nanos integer

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

The access right object

name string

Resource name of the access right. It must have the format of installations/*/access-rights/*. For example: installations/surelock-homes-hq/access-rights/baskerville.

display_name string

Display name of the access right.

schedules array of Schedule objects

Schedules in which this access right is applied.

The access right's access point association

name string

access_point string

The access point resource name to bind as an association to the parent access right. For example: installations/surelock-homes-hq/access-points/baker-street-entrance.

display_name string

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

The access right's access point group association

name string

access_point_group string

The access point group resource name to bind as an association to the parent access right. For example: installations/surelock-homes-hq/access-point-groups/common-accesses.

display_name string

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

The access right's destination association

name string

destination string

The destination resource name to bind as an association to the parent access right. For example: installations/surelock-homes-hq/destinations/elevator-floor-5.

display_name string

Display name of the associated entity. In this case a destination.

Create an access right

Creates a new access right.

Input

parent string

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

access_right AccessRight

The access right resource to be created. Client must not set the AccessRight.name field.

access_right_id string

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

Output

name string

Resource name of the access right. It must have the format of installations/*/access-rights/*.

display_name string

Display name of the access right.

schedules array of Schedule objects

Schedules in which this access right is applied.

Get an access right

Retrieves an existing access right.

Input

name string

The name of the requested access right resource.

Output

name string

Resource name of the access right. It must have the format of installations/*/access-rights/*.

display_name string

Display name of the access right.

schedules array of Schedule objects

Schedules in which this access right is applied.

List access rights

Returns a list of access rights that have been previously created.

Input

parent string

The parent resource name.

page_size integer

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 access rights to return.

order_by string

How the results should be sorted.

Output

access_rights array of AccessRight objects

The field name should match the noun access_rights 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 access right

Updates an existing access right.

Input

access_right AccessRight

The access right 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 access right. It must have the format of installations/*/access-rights/*.

display_name string

Display name of the access right.

schedules array of Schedule objects

Schedules in which this access right is applied.

Delete an access right

Permanently deletes an access right. This cannot be undone.

Input

name string

The resource name of the access point to be deleted.

Output

No return value.

Create an access point

Creates an access right's access point association.

Input

parent string

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

access_right_access_point AccessRightAccessPoint

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

Output

name string

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

access_point string

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

display_name string

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

Create a batch of access rights access points

Creates a batch of access rights access points associations. This method allows the creation of multiple access rights access points in a single operation.

Input

parent string

Resource name of the parent resource where the access right's access points associations are to be created.

requests array of CreateAccessRightAccessPointRequest objects

The request message specifying the resources to create. A maximum of 100 access right access points can be created in a batch.

Output

access_right_access_points array of AccessRightAccessPoint objects

Access right access points created.

Get an access point

Retrieves an existing access right's access point association.

Input

name string

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

Output

name string

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

access_point string

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

display_name string

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

List access points

Lists an existing access right's access point associations.

Input

parent string

The parent resource name.

page_size integer

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 access right's access point associations to return.

order_by string

How the results should be sorted.

Output

access_right_access_points array of AccessRightAccessPoint objects

The field name should match the noun access_right_access_points 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 access point

Updates an existing access right's access point association.

Input

access_right_access_point AccessRightAccessPoint

The access right's access point 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 access right's access point association. It must have the format of installations/*/access-rights/*/access-points/*.

access_point string

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

display_name string

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

Delete an access point

Deletes an access right's access point association.

Input

name string

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

Output

No return value.

Delete a batch of access points

Permanently deletes a batch of access right's access point associations. This cannot be undone.

Input

parent string

Resource name of the access point's access right relation to be deleted.

requests array of DeleteAccessRightAccessPointRequest objects

The request message specifying the resources to delete. A maximum of 100 access point's access rights associations can be deleted in a batch.

Output

Create an access point group

Creates an access right's access point group association.

Input

parent string

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

access_right_access_point_group AccessRightAccessPointGroup

The access right's access point group association resource to be created. Client must not set the AccessRightAccessPointGroup.name field.

Output

name string

Resource name of the access right's access point group association. It must have the format of installations/*/access-rights/*/access-point-groups/*.

access_point_group string

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

display_name string

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

Create a batch of access right's access point groups

Creates a batch of access right's access point groups associations. This method allows the creation of multiple access right's access point groups in a single operation.

Input

parent string

Resource name of the parent resource where the access right's access point groups associations are to be created.

requests array of CreateAccessRightAccessPointGroupRequest objects

The request message specifying the resources to create. A maximum of 100 access right's access point groups can be created in a batch.

Output

access_right_access_point_groups array of AccessRightAccessPointGroup objects

Access right's access point groups created.

Get an access point group

Retrieves an existing access right's access point group association.

Input

name string

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

Output

name string

Resource name of the access right's access point group association. It must have the format of installations/*/access-rights/*/access-point-groups/*.

access_point_group string

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

display_name string

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

List access point groups

Lists an existing access right's access point group associations.

Input

parent string

The parent resource name.

page_size integer

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 access right's access point group associations to return.

order_by string

How the results should be sorted.

Output

access_right_access_point_groups array of AccessRightAccessPointGroup objects

The field name should match the noun access_right_access_point_groups 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 access point group

Updates an existing access right's access point group association.

Input

access_right_access_point_group AccessRightAccessPointGroup

The access right's access point group 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 access right's access point group association. It must have the format of installations/*/access-rights/*/access-point-groups/*.

access_point_group string

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

display_name string

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

Delete an access point group

Deletes an access right's access point group association.

Input

name string

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

Output

No return value.

Delete a batch of access point groups

Permanently deletes a batch access right's access point group associations. This cannot be undone.

Input

parent string

Resource name of the access right's access point group associations to be deleted.

requests array of DeleteAccessRightAccessPointGroupRequest objects

The request message specifying the resources to delete. A maximum of 100 access right's access point group associations can be deleted in a batch.

Output

Create an access right destination

Creates an access right's destination association.

Input

parent string

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

access_right_destination AccessRightDestination

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

Output

name string

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

destination string

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

display_name string

Display name of the associated entity. In this case a destination.

Get an access right destination

Retrieves an existing access right's destination association.

Input

name string

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

Output

name string

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

destination string

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

display_name string

Display name of the associated entity. In this case a destination.

List access right destinations

Lists an existing access right's destination associations.

Input

parent string

The parent resource name.

page_size integer

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 access right's destination associations to return.

order_by string

How the results should be sorted.

Output

access_right_destinations array of AccessRightDestination objects

The field name should match the noun access_right_destinations 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 access right destination

Updates an existing access right's destination association.

Input

access_right_destination AccessRightDestination

The access right's destination 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 access right's destination association. It must have the format of installations/*/access-rights/*/destinations/*.

destination string

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

display_name string

Display name of the associated entity. In this case a destination.

Delete an access right destination

Deletes an access right's destination association.

Input

name string

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

Output

No return value.