Access point groups
An access point group is a specified collection of access points that are grouped together to make them easier to manage.
For example, an access point group could be all the doors on the first floor of an installation, or all the lockers in the gym area, or all the doors in the financial services department.
Resource name of the access point group. It must have the format of installations/*/access-point-groups/*. For example: installations/surelock-homes-hq/access-point-groups/common-accesses.
Display name of the access point group.
Resource name of the access point groups's access point association. It must have the format of installations/*/access-point-groups/*/access-points/*. For example: installations/surelock-homes-hq/access-point-groups/common-accesses/access-points/baker-street-entrance.
The access point resource name to bind as an association to the parent access point group. For example: installations/surelock-homes-hq/access-points/baker-street-entrance.
Display name of the associated entity. In this case an access point.
The access point group object
Resource name of the access point group. It must have the format of installations/*/access-point-groups/*. For example: installations/surelock-homes-hq/access-point-groups/common-accesses.
Display name of the access point group.
The access point group's access point association
Resource name of the access point groups's access point association. It must have the format of installations/*/access-point-groups/*/access-points/*. For example: installations/surelock-homes-hq/access-point-groups/common-accesses/access-points/baker-street-entrance.
The access point resource name to bind as an association to the parent access point group. For example: installations/surelock-homes-hq/access-points/baker-street-entrance.
Display name of the associated entity. In this case an access point.
Create an access point group
Creates an access point group.
Input
Resource name of the parent resource where to create the access point group.
The access point group resource to be created. Client must not set the AccessPointGroup.name field.
The access point group ID to use for this access point group. In case it's empty the server will autogenerate a unique identifier.
Output
Resource name of the access point group. It must have the format of installations/*/access-point-groups/*.
Display name of the access point group.
Get an access point group
Gets an existing access point group.
Input
The name of the requested access point group resource.
Output
Resource name of the access point group. It must have the format of installations/*/access-point-groups/*.
Display name of the access point group.
List access point groups
Returns a list of access point groups that have been previously created.
Input
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 access point groups to return.
How the results should be sorted.
Show deleted access point groups.
Output
The field name should match the noun 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.
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 point group.
Input
The access point group resource which replaces the resource on the server.
The update mask applied to the resource.
Output
Resource name of the access point group. It must have the format of installations/*/access-point-groups/*.
Display name of the access point group.
Delete an access point group
Soft deletes an access point group.
Input
The resource name of the access point group to be soft deleted.
Output
Resource name of the access point group. It must have the format of installations/*/access-point-groups/*.
Display name of the access point group.
Create an access point
Creates an access point group's access point association.
Input
Resource name of the parent resource where the access point group's access point association is to be created.
The access point group's access point association resource to be created. Client must not set the AccessPointGroupAccessPoint.name field.
Output
Resource name of the access point groups's access point association. It must have the format of installations/*/access-point-groups/*/access-points/*.
The access point resource name to bind as an association to the parent access point group.
Display name of the associated entity. In this case an access point.
Create a batch of access point group access points
Creates a batch of access point group's access points association. This method allows the creation of multiple access point group's access points in a single operation.
Input
Resource name of the parent resource where the access point group's access point associations are to be created.
The request message specifying the resources to create. A maximum of 100 access point group access points can be created in a batch.
Output
Access point group access points created.
Get an access point
Retrieves an existing access point group's access point association.
Input
The name of the requested access point group's access point association resource.
Output
Resource name of the access point groups's access point association. It must have the format of installations/*/access-point-groups/*/access-points/*.
The access point resource name to bind as an association to the parent access point group.
Display name of the associated entity. In this case an access point.
List access points
Lists an existing access point group's access point associations.
Input
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 access point group's access point associations to return.
How the results should be sorted.
Output
The field name should match the noun access_point_group_access_points 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.
Update an access point
Updates an existing access point group's access point association.
Input
The access point group's access point resource which replaces the resource on the server.
The update mask applied to the resource.
Output
Resource name of the access point groups's access point association. It must have the format of installations/*/access-point-groups/*/access-points/*.
The access point resource name to bind as an association to the parent access point group.
Display name of the associated entity. In this case an access point.
Delete an access point
Deletes an access point group's access point association.
Input
The resource name of the access point group's access point association to be deleted.
Output
No return value.
Delete a batch of access point group access point associations
Deletes a batch of access point group access point associations. This method allows the deletion of multiple access point group access points in a single operation. This cannot be undone.
Input
The resource name of the access point group's access point associations to be deleted.
The request message specifying the resources to delete. A maximum of 100 access point group access points can be deleted in a batch.
Output
Back
Access rights