Access Method Events

`access_method.issued`

An access method was issued.

{
  "access_grant_ids": [],
  "access_grant_keys": [],
  "access_method_id": "00000000-0000-0000-0000-000000000000",
  "code": "1234",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "An access method was issued.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_method.issued",
  "is_backup_code": true,
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_grant_ids

Array

IDs of the access grants associated with this access method.

access_grant_keys

Array

Keys of the access grants associated with this access method (if present).

access_method_id

String (UUID)

ID of the affected access method.

code

String

The actual PIN code for code access methods (only present when mode is ‘code’).

created_at

String (ISO 8601)

Date and time at which the event was created.

event_description

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: access_method.issued

is_backup_code

Boolean

Indicates whether the code is a backup code (only present when mode is ‘code’ and a backup code was used).

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_method.revoked`

An access method was revoked.

{
  "access_grant_ids": [],
  "access_grant_keys": [],
  "access_method_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "An access method was revoked.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_method.revoked",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_grant_ids

Array

IDs of the access grants associated with this access method.

access_grant_keys

Array

Keys of the access grants associated with this access method (if present).

access_method_id

String (UUID)

ID of the affected access method.

created_at

String (ISO 8601)

Date and time at which the event was created.

event_description

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: access_method.revoked

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_method.card_encoding_required`

An access method representing a physical card requires encoding.

{
  "access_grant_ids": [],
  "access_grant_keys": [],
  "access_method_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "An access method representing a physical card requires encoding.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_method.card_encoding_required",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_grant_ids

Array

IDs of the access grants associated with this access method.

access_grant_keys

Array

Keys of the access grants associated with this access method (if present).

access_method_id

String (UUID)

ID of the affected access method.

created_at

String (ISO 8601)

Date and time at which the event was created.

event_description

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: access_method.card_encoding_required

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_method.deleted`

An access method was deleted.

{
  "access_grant_ids": [],
  "access_grant_keys": [],
  "access_method_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "An access method was deleted.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_method.deleted",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_grant_ids

Array

IDs of the access grants associated with this access method.

access_grant_keys

Array

Keys of the access grants associated with this access method (if present).

access_method_id

String (UUID)

ID of the affected access method.

created_at

String (ISO 8601)

Date and time at which the event was created.

event_description

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: access_method.deleted

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_method.reissued`

An access method was reissued.

{
  "access_grant_ids": [],
  "access_grant_keys": [],
  "access_method_id": "00000000-0000-0000-0000-000000000000",
  "code": "1234",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "An access method was reissued.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_method.reissued",
  "is_backup_code": true,
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_grant_ids

Array

IDs of the access grants associated with this access method.

access_grant_keys

Array

Keys of the access grants associated with this access method (if present).

access_method_id

String (UUID)

ID of the affected access method.

code

String

The actual PIN code for code access methods (only present when mode is ‘code’).

created_at

String (ISO 8601)

Date and time at which the event was created.

event_description

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: access_method.reissued

is_backup_code

Boolean

Indicates whether the code is a backup code (only present when mode is ‘code’ and a backup code was used).

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_method.created`

An access method was created.

{
  "access_grant_ids": [],
  "access_grant_keys": [],
  "access_method_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "An access method was created.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_method.created",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_grant_ids

Array

IDs of the access grants associated with this access method.

access_grant_keys

Array

Keys of the access grants associated with this access method (if present).

access_method_id

String (UUID)

ID of the affected access method.

created_at

String (ISO 8601)

Date and time at which the event was created.

event_description

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: access_method.created

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

Access Method Events

`access_method.issued`

`access_method.revoked`

`access_method.card_encoding_required`

`access_method.deleted`

`access_method.reissued`

`access_method.created`

​access_method.issued

​access_method.revoked

​access_method.card_encoding_required

​access_method.deleted

​access_method.reissued

​access_method.created

`access_method.issued`

`access_method.revoked`

`access_method.card_encoding_required`

`access_method.deleted`

`access_method.reissued`

`access_method.created`