Emergency keys

Emergency keys are a special type of card key that can only be created by installation owners. These keys override any standard access restrictions and are intended to comply with safety regulations. For example, fire safety regulations in some countries require providing unconditional access to emergency responders.

These keys are intended for specific emergency situations and not as a workaround for the security restrictions of standard keys.

This service is responsible for managing emergency key resources.

name string

Resource name of the emergency key. It must have the format installations/*/emergency-keys/*. For example: installations/surelock-homes-hq/emergency-keys/firefighters.

display_name string

Display name of the emergency key.

uid string

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

The emergency key object

name string

Resource name of the emergency key. It must have the format installations/*/emergency-keys/*. For example: installations/surelock-homes-hq/emergency-keys/firefighters.

display_name string

Display name of the emergency key.

uid string

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

Create an emergency key

Creates a new emergency key.

Input

parent string required

Resource name of the parent resource where the access right is to be created. For example: ìnstallations/surelock-homes-hq`.

emergency_key EmergencyKey required

The emergency key resource to be created. Client must not set the EmergencyKey.name field.

Output

name string

Resource name of the emergency key. It must have the format installations/*/emergency-keys/*.

display_name string

Display name of the emergency key.

uid string

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

Get an emergency key

Retrieves an existing emergency key.

Input

name string required

The name of the requested emergency key resource.

Output

name string

Resource name of the emergency key. It must have the format installations/*/emergency-keys/*.

display_name string

Display name of the emergency key.

uid string

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

List emergency keys

Returns a list of emergency keys 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 emergency keys to return.

order_by string

How the results should be sorted.

Output

emergency_keys array of EmergencyKey objects

The field name should match the noun emergency_keys 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

The token to retrieve the next page of emergency keys.

Update an emergency key

Updates an existing emergency key.

Input

emergency_key EmergencyKey

The emergency key 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 emergency key. It must have the format installations/*/emergency-keys/*.

display_name string

Display name of the emergency key.

uid string

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

Delete an emergency key

Deletes an existing emergency key.

Input

name string required

The resource name of the emergency key to delete.

Output

No return value.