Create an Access Grant

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.

• Request Parameters

• Response

• Examples

Creates a new access grant.

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

requested_access_methods Array of Objects (Required)

---

acs_entrance_ids Array of UUIDs

Set of IDs of the entrances to which access is being granted.

---

device_ids Array of UUIDs

Set of IDs of the devices to which access is being granted.

---

ends_at String

Date and time at which the validity of the new grant ends, in ISO 8601 format. Must be a time in the future and after starts_at.

---

location Object

When used, creates a new location with the given entrances and devices, and gives the user access to this location.

acs_entrance_ids List

Deprecated. Use acs_entrance_ids at the top level.

---

device_ids List

Deprecated. Use device_ids at the top level.

---

name String

Name of the location.

---

location_ids Array of UUIDs

---

space_ids Array of UUIDs

Set of IDs of existing spaces to which access is being granted.

---

starts_at String

Date and time at which the validity of the new grant starts, in ISO 8601 format.

---

user_identity Object

When used, creates a new user identity with the given details, and grants them access.

email_address String

Unique email address for the user identity.

---

full_name String

---

phone_number String

Unique phone number for the user identity in E.164 format (for example, [phone]).

---

user_identity_id String

ID of user identity for whom access is being granted.

---

Response

access_grant