Access Methods

Early Access Preview. The access methods 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_method Object

• Properties

• Errors

• Warnings

• Events

• Endpoints

---

Properties

access_method_id UUID

ID of the access method.

---

created_at Datetime

Date and time at which the access method was created.

---

display_name String

Display name of the access method.

---

instant_key_url String

URL of instant key for mobile key access methods.

---

is_card_encoding_required Boolean

Whether card encoding is required for plastic card access methods.

---

issued_at Datetime

Date and time at which the access method was issued.

---

mode Enum

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

Enum values

• code

• card

• mobile_key

---

workspace_id UUID

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

---

Events

access_method.issued

An access method was issued.

Properties

access_method_id UUID

ID of the affected access method.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: access_method.issued

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

---

access_method.revoked

An access method was revoked.

Properties

access_method_id UUID

ID of the affected access method.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: access_method.revoked

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

---

access_method.card_encoding_required

An access method representing a physical card requires encoding.

Properties

access_method_id UUID

ID of the affected access method.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: access_method.card_encoding_required

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

---

access_method.deleted

An access method was deleted.

Properties

access_method_id UUID

ID of the affected access method.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: access_method.deleted

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

---

Endpoints

/access_methods/delete

Delete an access method.

/access_methods/get

Get an access method.

/access_methods/list

List all access methods, usually filtered by access grant.