The access_method Object
Represents an access method for an access grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.
A card access method resource.
Copy {
"access_method_id" : "27d8ad77-55c2-4e20-b5b3-43555926f0e8" ,
"created_at" : "2025-06-14T16:54:17.946612Z" ,
"display_name" : "My Card" ,
"is_card_encoding_required" : true ,
"issued_at" : "2025-06-14T16:54:17.946612Z" ,
"mode" : "card" ,
"workspace_id" : "661025d3-c1d2-403c-83a8-af153aaedfbc"
} A mobile key access method resource.
Copy {
"access_method_id" : "27d8ad77-55c2-4e20-b5b3-43555926f0e8" ,
"created_at" : "2025-06-14T16:54:17.946612Z" ,
"display_name" : "My Mobile Key" ,
"instant_key_url" : "https://se.am/1234" ,
"is_card_encoding_required" : false ,
"mode" : "mobile_key" ,
"workspace_id" : "661025d3-c1d2-403c-83a8-af153aaedfbc"
} A PIN code access method resource.
Copy {
"access_method_id": "27d8ad77-55c2-4e20-b5b3-43555926f0e8",
"created_at": "2025-06-14T16:54:17.946612Z",
"display_name": "My PIN Code",
"is_card_encoding_required": false,
"mode": "code",
"workspace_id": "661025d3-c1d2-403c-83a8-af153aaedfbc"
} 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 the Instant Key for mobile key access methods.
is_card_encoding_required Boolean
Indicates 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.
workspace_id UUID
ID of the Seam workspace associated with the access method.
Events
access_method.issued
An access method was issued.
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.
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.
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.
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.
access_method.reissued
An access method was reissued due to an access grant update.
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.reissued
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.
