Access Trait
API Service: AccessApi
AccessApi describes the capability to manage access to a resource. This could be a access card reader next to a door, or a barrier at a car park.
| Method | Request Type | Response Type | Description |
|---|---|---|---|
| GetLastAccessAttempt | GetLastAccessAttemptRequest | AccessAttempt | |
| PullAccessAttempts | PullAccessAttemptsRequest | PullAccessAttemptsResponse stream |
AccessAttempt
| Field Name | Type | Description |
|---|---|---|
| grant | AccessAttempt.Grant | Was the access attempt granted or denied. |
| reason | string | A reason for either granting or denying the access attempt. For example "Operator override" or "Unrecognised card". |
| actor | smartcore.bos.Actor | Actor describes the entity attempting to gain access. Optional. |
| access_attempt_time | google.protobuf.Timestamp | The time the access attempt was made |
AccessAttempt.Grant
| Name | Number | Description |
|---|---|---|
| GRANT_UNKNOWN | 0 | The status of the access attempt is unknown. |
| GRANTED | 1 | The access attempt was granted. |
| DENIED | 2 | The access attempt was denied. |
| PENDING | 3 | Access is pending a decision. |
| ABORTED | 4 | Access was aborted before being granted or denied. Typically only used following PENDING. |
| FORCED | 5 | Access was not granted, happened anyway. For example if someone forced the door open. |
| FAILED | 6 | Access was granted, but failed for other reasons. For example if the door is stuck |
| TAILGATE | 7 | Access was granted, but to the actor before this one. Happens when someone follows another person through a door. |
GetLastAccessAttemptRequest
| Field Name | Type | Description |
|---|---|---|
| name | string | The name of the device to get the last access attempt for. |
| read_mask | google.protobuf.FieldMask |
PullAccessAttemptsRequest
| Field Name | Type | Description |
|---|---|---|
| name | string | The name of the device to pull access attempts for. |
| read_mask | google.protobuf.FieldMask | |
| updates_only | bool |
PullAccessAttemptsResponse
| Field Name | Type | Description |
|---|---|---|
| changes | repeated PullAccessAttemptsResponse.Change |
PullAccessAttemptsResponse.Change
| Field Name | Type | Description |
|---|---|---|
| name | string | |
| change_time | google.protobuf.Timestamp | |
| access_attempt | AccessAttempt |