Access Grants

Early Access Preview. The Access Grants API is currently in Alpha. We're actively developing it and seeking early feedback at [email protected]. Expect breaking changes as we refine the design.

The access_grant Object

Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity while creating the new Access Grant.

An Access Grant resource.

{
  "access_grant_id": "ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b",
  "access_method_ids": [
    "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d",
    "5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f",
    "c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f"
  ],
  "created_at": "2025-06-16T16:54:17.946606Z",
  "display_name": "My Access Grant",
  "ends_at": "2025-06-18T16:54:17.946606Z",
  "instant_key_url": "https://ik.seam.co/ABCXYZ",
  "requested_access_methods": [
    {
      "display_name": "PIN Code Credential",
      "mode": "code",
      "created_at": "2025-06-16T16:54:17.946606Z",
      "created_access_method_ids": ["a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d"]
    },
    {
      "display_name": "Card Credential",
      "mode": "card",
      "created_at": "2025-06-16T16:54:19.946606Z",
      "created_access_method_ids": ["5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f"]
    },
    {
      "display_name": "Mobile Key Credential",
      "mode": "mobile_key",
      "created_at": "2025-06-16T16:54:21.946606Z",
      "created_access_method_ids": ["c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f"]
    }
  ],
  "space_ids": [
    "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a"
  ],
  "starts_at": "2025-06-16T16:54:17.946606Z",
  "user_identity_id": "e3d736c1-540d-4d10-83e5-9a4e135453b4",
  "workspace_id": "750fc0bc-4450-4356-8d9f-18c6a3a6b2c7"
}

Properties

access_grant_id UUID

ID of the Access Grant.

access_grant_key String

Unique key for the access grant within the workspace.

access_method_ids List of UUIDs

IDs of the access methods created for the Access Grant.

client_session_token String

Client Session Token. Only returned if the Access Grant has a mobile_key access method.

created_at Datetime

Date and time at which the Access Grant was created.

display_name String

Display name of the Access Grant.

ends_at Datetime

Date and time at which the Access Grant ends.

instant_key_url String

Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.

location_ids List of UUIDs

Deprecated. Use space_ids.

name String

Name of the Access Grant. If not provided, the display name will be computed.

requested_access_methods List of Objects

Access methods that the user requested for the Access Grant.

Child Object Properties

created_access_method_ids List of UUIDs

IDs of the access methods created for the requested access method.

created_at Datetime

Date and time at which the requested access method was added to the 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 the Access Grant gives access.

starts_at Datetime

Date and time at which the Access Grant starts.

user_identity_id UUID

ID of user identity to which the Access Grant gives access.

workspace_id UUID

ID of 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/get_related

Gets all related resources for one or more Access Grants.

/access_grants/list

Gets an Access Grant.

/access_grants/update

Updates an existing Access Grant's time window.

PreviousList Compatible Credential Manager ACS Systems NextCreate an Access Grant

Last updated 2 days ago

Was this helpful?