Access points
An access point represents either one electronic lock or a collection of devices capable of granting or denying access to a secured area, such as a room, office or apartment.
Although an access point frequently represents just one physical electronic lock it could also be made up of more than one device. For example, an access point could be composed of an electronic lock and a contact sensor or a controller and a keypad.
This service is responsible for managing access point resources.
Resource name of the access point. It must have the format installations/*/access-points/*. For example: installations/surelock-homes-hq/access-points/baker-street-entrance.
Display name of the access point.
Indicates whether the access point was left open.
Remote operations (for example: lock, unlock) that end users can perform on this access point via an app key.
APP_KEY_REMOTE_OPERATION_UNSPECIFIED0. Unspecified. This value is not allowed and will be rejected by the API.APP_KEY_REMOTE_OPERATION_LOCK1. Remotely locks the access point.APP_KEY_REMOTE_OPERATION_UNLOCK2. Remotely unlocks the access point.Calendar reference assigned to this access point. If not set, a calendar where all days are NORMAL will be used. That's to say a regular calendar that doesn't have any HOLIDAY or OTHER days added to it.
Enables or disables card key updates. This parameter doesn't have any effect on access points where its associated device is offline. This field is optional to maintain backward compatibility. The server checks for its presence to determine if clients are not updated and assigns a default value if it's missing.
The duration the access point remains unlocked. This field is optional for the server to check for its presence and assign a default value if it's missing. Allowed values are between 1 s and 30 m when set.
Time zone where the access point is located. It must follow the IANA Time Zone Database format. For example, "America/New_York." If not set, it falls back to the installation's time zone. This field is only usable on allowlisted installations.
Opening mode. This could be a fixed mode or a scheduled mode. The schedule takes the form of a relative resource name of an opening mode schedule.
The opening mode to be used permanently.
OPENING_MODE_UNSPECIFIED0. UnspecifiedOFFICE1. Office.TOGGLE2. Toggle.AUTOLOCK3. Autolock.Reference to an opening mode schedule
Specifies the underlying source from which this access point derives its operational capabilities and specific instance definition. For example: - installations/surelock-homes-hq/electronic-locks/dancing-men. - installations/surelock-homes-hq/controllers/conan-doyle. - installations/surelock-homes-hq/intercom-adaptors/elementary.
Source name, when source is an electronic lock.
Source name, when source is a controller.
Source name, when source is an intercom adaptor.
The access point object
Resource name of the access point. It must have the format installations/*/access-points/*. For example: installations/surelock-homes-hq/access-points/baker-street-entrance.
Display name of the access point.
Indicates whether the access point was left open.
Remote operations (for example: lock, unlock) that end users can perform on this access point via an app key.
APP_KEY_REMOTE_OPERATION_UNSPECIFIED0. Unspecified. This value is not allowed and will be rejected by the API.APP_KEY_REMOTE_OPERATION_LOCK1. Remotely locks the access point.APP_KEY_REMOTE_OPERATION_UNLOCK2. Remotely unlocks the access point.Calendar reference assigned to this access point. If not set, a calendar where all days are NORMAL will be used. That's to say a regular calendar that doesn't have any HOLIDAY or OTHER days added to it.
Enables or disables card key updates. This parameter doesn't have any effect on access points where its associated device is offline. This field is optional to maintain backward compatibility. The server checks for its presence to determine if clients are not updated and assigns a default value if it's missing.
The duration the access point remains unlocked. This field is optional for the server to check for its presence and assign a default value if it's missing. Allowed values are between 1 s and 30 m when set.
Time zone where the access point is located. It must follow the IANA Time Zone Database format. For example, "America/New_York." If not set, it falls back to the installation's time zone. This field is only usable on allowlisted installations.
Opening mode. This could be a fixed mode or a scheduled mode. The schedule takes the form of a relative resource name of an opening mode schedule.
The opening mode to be used permanently.
OPENING_MODE_UNSPECIFIED0. UnspecifiedOFFICE1. Office.TOGGLE2. Toggle.AUTOLOCK3. Autolock.Reference to an opening mode schedule
Specifies the underlying source from which this access point derives its operational capabilities and specific instance definition. For example: - installations/surelock-homes-hq/electronic-locks/dancing-men. - installations/surelock-homes-hq/controllers/conan-doyle. - installations/surelock-homes-hq/intercom-adaptors/elementary.
Source name, when source is an electronic lock.
Source name, when source is a controller.
Source name, when source is an intercom adaptor.
Create an access point
Creates a new access point.
Input
Resource name of the parent resource under which the access point is created.
The access point resource to be created. Client must not set the AccessPoint.name field.
The access point id to use for this access point. If it's empty the server will autogenerate a unique identifier.
Output
Resource name of the access point. It must have the format installations/*/access-points/*.
Display name of the access point.
Indicates whether the access point was left open.
Remote operations (for example: lock, unlock) that end users can perform on this access point via an app key.
APP_KEY_REMOTE_OPERATION_UNSPECIFIED0. Unspecified. This value is not allowed and will be rejected by the API.APP_KEY_REMOTE_OPERATION_LOCK1. Remotely locks the access point.APP_KEY_REMOTE_OPERATION_UNLOCK2. Remotely unlocks the access point.Calendar reference assigned to this access point. If not set, a calendar where all days are NORMAL will be used. That's to say a regular calendar that doesn't have any HOLIDAY or OTHER days added to it.
Enables or disables card key updates. This parameter doesn't have any effect on access points where its associated device is offline. This field is optional to maintain backward compatibility. The server checks for its presence to determine if clients are not updated and assigns a default value if it's missing.
The duration the access point remains unlocked. This field is optional for the server to check for its presence and assign a default value if it's missing. Allowed values are between 1 s and 30 m when set.
Time zone where the access point is located. It must follow the IANA Time Zone Database format. For example, "America/New_York." If not set, it falls back to the installation's time zone. This field is only usable on allowlisted installations.
Opening mode. This could be a fixed mode or a scheduled mode. The schedule takes the form of a relative resource name of an opening mode schedule.
The opening mode to be used permanently.
OPENING_MODE_UNSPECIFIED0. UnspecifiedOFFICE1. Office.TOGGLE2. Toggle.AUTOLOCK3. Autolock.Reference to an opening mode schedule
Specifies the underlying source from which this access point derives its operational capabilities and specific instance definition. For example: - installations/surelock-homes-hq/electronic-locks/dancing-men. - installations/surelock-homes-hq/controllers/conan-doyle. - installations/surelock-homes-hq/intercom-adaptors/elementary.
Source name, when source is an electronic lock.
Source name, when source is a controller.
Source name, when source is an intercom adaptor.
Get an access point
Retrieves an existing access point.
Input
The name of the requested access point resource.
Output
Resource name of the access point. It must have the format installations/*/access-points/*.
Display name of the access point.
Indicates whether the access point was left open.
Remote operations (for example: lock, unlock) that end users can perform on this access point via an app key.
APP_KEY_REMOTE_OPERATION_UNSPECIFIED0. Unspecified. This value is not allowed and will be rejected by the API.APP_KEY_REMOTE_OPERATION_LOCK1. Remotely locks the access point.APP_KEY_REMOTE_OPERATION_UNLOCK2. Remotely unlocks the access point.Calendar reference assigned to this access point. If not set, a calendar where all days are NORMAL will be used. That's to say a regular calendar that doesn't have any HOLIDAY or OTHER days added to it.
Enables or disables card key updates. This parameter doesn't have any effect on access points where its associated device is offline. This field is optional to maintain backward compatibility. The server checks for its presence to determine if clients are not updated and assigns a default value if it's missing.
The duration the access point remains unlocked. This field is optional for the server to check for its presence and assign a default value if it's missing. Allowed values are between 1 s and 30 m when set.
Time zone where the access point is located. It must follow the IANA Time Zone Database format. For example, "America/New_York." If not set, it falls back to the installation's time zone. This field is only usable on allowlisted installations.
Opening mode. This could be a fixed mode or a scheduled mode. The schedule takes the form of a relative resource name of an opening mode schedule.
The opening mode to be used permanently.
OPENING_MODE_UNSPECIFIED0. UnspecifiedOFFICE1. Office.TOGGLE2. Toggle.AUTOLOCK3. Autolock.Reference to an opening mode schedule
Specifies the underlying source from which this access point derives its operational capabilities and specific instance definition. For example: - installations/surelock-homes-hq/electronic-locks/dancing-men. - installations/surelock-homes-hq/controllers/conan-doyle. - installations/surelock-homes-hq/intercom-adaptors/elementary.
Source name, when source is an electronic lock.
Source name, when source is a controller.
Source name, when source is an intercom adaptor.
List access points
Returns a list of access points 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 points to return.
How the results should be sorted.
Output
The field name should match the noun 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.
The total number of access points in all pages, irrespective of any pagination. This is an estimated number based on the requested filter, and it may change in subsequent pages.
Update an access point
Updates an existing access point.
Input
The access point resource which replaces the resource on the server.
The update mask applied to the resource.
Output
Resource name of the access point. It must have the format installations/*/access-points/*.
Display name of the access point.
Indicates whether the access point was left open.
Remote operations (for example: lock, unlock) that end users can perform on this access point via an app key.
APP_KEY_REMOTE_OPERATION_UNSPECIFIED0. Unspecified. This value is not allowed and will be rejected by the API.APP_KEY_REMOTE_OPERATION_LOCK1. Remotely locks the access point.APP_KEY_REMOTE_OPERATION_UNLOCK2. Remotely unlocks the access point.Calendar reference assigned to this access point. If not set, a calendar where all days are NORMAL will be used. That's to say a regular calendar that doesn't have any HOLIDAY or OTHER days added to it.
Enables or disables card key updates. This parameter doesn't have any effect on access points where its associated device is offline. This field is optional to maintain backward compatibility. The server checks for its presence to determine if clients are not updated and assigns a default value if it's missing.
The duration the access point remains unlocked. This field is optional for the server to check for its presence and assign a default value if it's missing. Allowed values are between 1 s and 30 m when set.
Time zone where the access point is located. It must follow the IANA Time Zone Database format. For example, "America/New_York." If not set, it falls back to the installation's time zone. This field is only usable on allowlisted installations.
Opening mode. This could be a fixed mode or a scheduled mode. The schedule takes the form of a relative resource name of an opening mode schedule.
The opening mode to be used permanently.
OPENING_MODE_UNSPECIFIED0. UnspecifiedOFFICE1. Office.TOGGLE2. Toggle.AUTOLOCK3. Autolock.Reference to an opening mode schedule
Specifies the underlying source from which this access point derives its operational capabilities and specific instance definition. For example: - installations/surelock-homes-hq/electronic-locks/dancing-men. - installations/surelock-homes-hq/controllers/conan-doyle. - installations/surelock-homes-hq/intercom-adaptors/elementary.
Source name, when source is an electronic lock.
Source name, when source is a controller.
Source name, when source is an intercom adaptor.
Delete an access point
Permanently deletes an access point. This cannot be undone.
Input
The resource name of the access point to be deleted.
Output
No return value.
Unlock an access point
Remotely unlocks an access point. This can be run against those access points where their associated devices are online and connected.
Input
The resource name of the access point to be unlocked.
Output
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 operation result, which can be either an error or a valid response. If done == false, neither error nor response is set. If done == true, exactly one of error or response is set.
The error result of the operation in case of failure or cancellation.
The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example: if the original method name is AssignMobileKey(), the inferred response type is AssignMobileKeyResponse.
Lock an access point
Remotely locks an access point. This can be run against those access points where their associated devices are online and connected. The lock device type can only be a motorized lock. Attempting to call this method on non-motorized locks will result in an INVALID_ARGUMENT error.
Input
The resource name of the access point to be locked.
Output
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 operation result, which can be either an error or a valid response. If done == false, neither error nor response is set. If done == true, exactly one of error or response is set.
The error result of the operation in case of failure or cancellation.
The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example: if the original method name is AssignMobileKey(), the inferred response type is AssignMobileKeyResponse.
Back
Event types