Access Grants

Early Access Preview. The access grants API is currently in Alpha. We're actively developing it and seeking early feedback at [e-mail]. Expect breaking changes as we refine the design.

The access_grant Object

• Properties

• Errors

• Warnings

• Events

• Endpoints

---

Properties

access_grant_id UUID

ID of the access grant.

---

access_method_ids List of UUIDs

IDs of the access methods that were created for this access grant.

---

created_at Datetime

Date and time at which the access grant was created.

---

display_name String

Display name of the access grant.

---

location_ids List of UUIDs

Deprecated. Use space_ids.

---

requested_access_methods List of Objects

Access methods that the user requested for this access grant.

Child Object Properties

created_access_method_ids List of UUIDs

IDs of the access methods that were created for this requested access method.

created_at Datetime

Date and time at which the requested access method was added to this access grant.

display_name String

Display name of the access method.

mode Enum

Access method mode. Supported values: `code`, `card`, `mobile_key`.

---

space_ids List of UUIDs

IDs of the spaces to which access is being given.

---

user_identity_id UUID

ID of user identity to which access is being granted.

---

workspace_id UUID

Unique identifier for the Seam workspace associated with the access grant.

---

Events

access_grant.created

An access grant was created.

Properties

access_grant_id UUID

ID of the affected access grant.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: access_grant.created

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

---

access_grant.deleted

An access grant was deleted.

Properties

access_grant_id UUID

ID of the affected access grant.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: access_grant.deleted

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

---

access_grant.access_granted_to_all_doors

All access requested for an access grant was successfully granted.

Properties

access_grant_id UUID

ID of the affected access grant.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: access_grant.access_granted_to_all_doors

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

---

access_grant.access_granted_to_door

Access requested as part of an access grant to a particular door was successfully granted.

Properties

access_grant_id UUID

ID of the affected access grant.

acs_entrance_id UUID

ID of the affected entrance.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: access_grant.access_granted_to_door

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

---

access_grant.access_to_door_lost

Access to a particular door that was requested as part of an access grant was lost.

Properties

access_grant_id UUID

ID of the affected access grant.

acs_entrance_id UUID

ID of the affected entrance.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: access_grant.access_to_door_lost

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

---

Endpoints

/access_grants/create

Creates a new access grant.

/access_grants/delete

Delete an access grant.

/access_grants/get

Get an access grant.

/access_grants/list

Get an access grant.