Skip to content
33 changes: 33 additions & 0 deletions docs/api/access_codes/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,39 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest
[access\_code](./)


{% tabs %}
{% tab title="JSON" %}



```json
{
"access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
"code": "1234",
"common_code_key": null,
"created_at": "2025-06-14T16:54:17.946242Z",
"device_id": "c9cd621d-ef0c-45c8-b608-026ebdb74615",
"ends_at": "2025-07-04T16:54:17.946049Z",
"errors": [],
"is_backup": false,
"is_backup_access_code_available": false,
"is_external_modification_allowed": false,
"is_managed": true,
"is_offline_access_code": true,
"is_one_time_use": true,
"is_scheduled_on_device": true,
"is_waiting_for_code_assignment": false,
"name": "My Access Code",
"pulled_backup_access_code_id": null,
"starts_at": "2025-07-02T16:54:17.946049Z",
"status": "set",
"type": "time_bound",
"warnings": []
}
```
{% endtab %}
{% endtabs %}

---

## Examples
Expand Down
33 changes: 33 additions & 0 deletions docs/api/access_codes/create_multiple.md
Original file line number Diff line number Diff line change
Expand Up @@ -437,3 +437,36 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest

Array of [access\_codes](./)


{% tabs %}
{% tab title="JSON" %}



```json
{
"access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
"code": "1234",
"common_code_key": null,
"created_at": "2025-06-14T16:54:17.946242Z",
"device_id": "c9cd621d-ef0c-45c8-b608-026ebdb74615",
"ends_at": "2025-07-04T16:54:17.946049Z",
"errors": [],
"is_backup": false,
"is_backup_access_code_available": false,
"is_external_modification_allowed": false,
"is_managed": true,
"is_offline_access_code": true,
"is_one_time_use": true,
"is_scheduled_on_device": true,
"is_waiting_for_code_assignment": false,
"name": "My Access Code",
"pulled_backup_access_code_id": null,
"starts_at": "2025-07-02T16:54:17.946049Z",
"status": "set",
"type": "time_bound",
"warnings": []
}
```
{% endtab %}
{% endtabs %}
33 changes: 33 additions & 0 deletions docs/api/access_codes/generate_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,3 +154,36 @@ ID of the device for which you want to generate a code.

[access\_code](./)


{% tabs %}
{% tab title="JSON" %}



```json
{
"access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
"code": "1234",
"common_code_key": null,
"created_at": "2025-06-14T16:54:17.946242Z",
"device_id": "c9cd621d-ef0c-45c8-b608-026ebdb74615",
"ends_at": "2025-07-04T16:54:17.946049Z",
"errors": [],
"is_backup": false,
"is_backup_access_code_available": false,
"is_external_modification_allowed": false,
"is_managed": true,
"is_offline_access_code": true,
"is_one_time_use": true,
"is_scheduled_on_device": true,
"is_waiting_for_code_assignment": false,
"name": "My Access Code",
"pulled_backup_access_code_id": null,
"starts_at": "2025-07-02T16:54:17.946049Z",
"status": "set",
"type": "time_bound",
"warnings": []
}
```
{% endtab %}
{% endtabs %}
33 changes: 33 additions & 0 deletions docs/api/access_codes/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,3 +295,36 @@ ID of the device containing the access code that you want to get. You must speci

[access\_code](./)


{% tabs %}
{% tab title="JSON" %}



```json
{
"access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
"code": "1234",
"common_code_key": null,
"created_at": "2025-06-14T16:54:17.946242Z",
"device_id": "c9cd621d-ef0c-45c8-b608-026ebdb74615",
"ends_at": "2025-07-04T16:54:17.946049Z",
"errors": [],
"is_backup": false,
"is_backup_access_code_available": false,
"is_external_modification_allowed": false,
"is_managed": true,
"is_offline_access_code": true,
"is_one_time_use": true,
"is_scheduled_on_device": true,
"is_waiting_for_code_assignment": false,
"name": "My Access Code",
"pulled_backup_access_code_id": null,
"starts_at": "2025-07-02T16:54:17.946049Z",
"status": "set",
"type": "time_bound",
"warnings": []
}
```
{% endtab %}
{% endtabs %}
33 changes: 33 additions & 0 deletions docs/api/access_codes/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -328,3 +328,36 @@ Your user ID for the user by which to filter access codes.

Array of [access\_codes](./)


{% tabs %}
{% tab title="JSON" %}



```json
{
"access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
"code": "1234",
"common_code_key": null,
"created_at": "2025-06-14T16:54:17.946242Z",
"device_id": "c9cd621d-ef0c-45c8-b608-026ebdb74615",
"ends_at": "2025-07-04T16:54:17.946049Z",
"errors": [],
"is_backup": false,
"is_backup_access_code_available": false,
"is_external_modification_allowed": false,
"is_managed": true,
"is_offline_access_code": true,
"is_one_time_use": true,
"is_scheduled_on_device": true,
"is_waiting_for_code_assignment": false,
"name": "My Access Code",
"pulled_backup_access_code_id": null,
"starts_at": "2025-07-02T16:54:17.946049Z",
"status": "set",
"type": "time_bound",
"warnings": []
}
```
{% endtab %}
{% endtabs %}
33 changes: 33 additions & 0 deletions docs/api/access_codes/pull_backup_access_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,3 +293,36 @@ ID of the access code for which you want to pull a backup access code.

[access\_code](./)


{% tabs %}
{% tab title="JSON" %}



```json
{
"access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
"code": "1234",
"common_code_key": null,
"created_at": "2025-06-14T16:54:17.946242Z",
"device_id": "c9cd621d-ef0c-45c8-b608-026ebdb74615",
"ends_at": "2025-07-04T16:54:17.946049Z",
"errors": [],
"is_backup": false,
"is_backup_access_code_available": false,
"is_external_modification_allowed": false,
"is_managed": true,
"is_offline_access_code": true,
"is_one_time_use": true,
"is_scheduled_on_device": true,
"is_waiting_for_code_assignment": false,
"name": "My Access Code",
"pulled_backup_access_code_id": null,
"starts_at": "2025-07-02T16:54:17.946049Z",
"status": "set",
"type": "time_bound",
"warnings": []
}
```
{% endtab %}
{% endtabs %}
24 changes: 24 additions & 0 deletions docs/api/access_codes/simulate/create_unmanaged_access_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,3 +253,27 @@ Name of the simulated unmanaged access code.

[unmanaged\_access\_code](./)


{% tabs %}
{% tab title="JSON" %}



```json
{
"access_code_id": "88fa1812-bef8-4108-9fb4-4855376c3edf",
"code": "1234",
"created_at": "2025-06-16T16:54:17.946283Z",
"device_id": "b3439f17-7273-46f3-9e20-9a283d9cb5b4",
"ends_at": "2025-06-23T16:54:17.946261Z",
"errors": [],
"is_managed": false,
"name": "My Unmanaged Access Code",
"starts_at": "2025-06-21T16:54:17.946261Z",
"status": "set",
"type": "time_bound",
"warnings": []
}
```
{% endtab %}
{% endtabs %}
24 changes: 24 additions & 0 deletions docs/api/access_codes/unmanaged/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,3 +243,27 @@ ID of the device containing the unmanaged access code that you want to get. You

[unmanaged\_access\_code](./)


{% tabs %}
{% tab title="JSON" %}



```json
{
"access_code_id": "88fa1812-bef8-4108-9fb4-4855376c3edf",
"code": "1234",
"created_at": "2025-06-16T16:54:17.946283Z",
"device_id": "b3439f17-7273-46f3-9e20-9a283d9cb5b4",
"ends_at": "2025-06-23T16:54:17.946261Z",
"errors": [],
"is_managed": false,
"name": "My Unmanaged Access Code",
"starts_at": "2025-06-21T16:54:17.946261Z",
"status": "set",
"type": "time_bound",
"warnings": []
}
```
{% endtab %}
{% endtabs %}
24 changes: 24 additions & 0 deletions docs/api/access_codes/unmanaged/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,3 +247,27 @@ Your user ID for the user by which to filter unmanaged access codes.

Array of [unmanaged\_access\_codes](./)


{% tabs %}
{% tab title="JSON" %}



```json
{
"access_code_id": "88fa1812-bef8-4108-9fb4-4855376c3edf",
"code": "1234",
"created_at": "2025-06-16T16:54:17.946283Z",
"device_id": "b3439f17-7273-46f3-9e20-9a283d9cb5b4",
"ends_at": "2025-06-23T16:54:17.946261Z",
"errors": [],
"is_managed": false,
"name": "My Unmanaged Access Code",
"starts_at": "2025-06-21T16:54:17.946261Z",
"status": "set",
"type": "time_bound",
"warnings": []
}
```
{% endtab %}
{% endtabs %}
50 changes: 50 additions & 0 deletions docs/api/access_grants/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -556,6 +556,56 @@ ID of user identity for whom access is being granted.
[access\_grant](./)


{% tabs %}
{% tab title="JSON" %}



```json
{
"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",
"location_ids": [
"9e8d7c6b-5a4b-3c2d-1e0f-9a8b7c6d5e4f",
"f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f"
],
"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"
],
"user_identity_id": "e3d736c1-540d-4d10-83e5-9a4e135453b4",
"workspace_id": "750fc0bc-4450-4356-8d9f-18c6a3a6b2c7"
}
```
{% endtab %}
{% endtabs %}

---

## Examples
Expand Down
Loading
Loading