Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions codegen/data/paths.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -200,3 +200,6 @@
/locks/simulate:
title: Lock Simulations

/instant_keys:
title: Instant Keys
4 changes: 4 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,10 @@
* [Events](api/events/README.md)
* [Get an Event](api/events/get.md)
* [List Events](api/events/list.md)
* [Instant Keys](api/instant_keys/README.md)
* [Delete an Instant Key](api/instant_keys/delete.md)
* [Get an Instant Key](api/instant_keys/get.md)
* [List Instant Keys](api/instant_keys/list.md)
* [Locks](api/locks/README.md)
* [Get a Lock](api/locks/get.md)
* [List Locks](api/locks/list.md)
Expand Down
1 change: 0 additions & 1 deletion docs/api/_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

### Routes

- `/instant_keys`
- `/thermostats/daily_programs`
- `/user_identities/enrollment_automations`

Expand Down
20 changes: 20 additions & 0 deletions docs/api/instant_keys/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Instant Keys

## Endpoints


[**`/instant_keys/delete`**](./delete.md)

Deletes a specified [Instant Key](../../capability-guides/instant-keys/README.md).


[**`/instant_keys/get`**](./get.md)

Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).


[**`/instant_keys/list`**](./list.md)

Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).


32 changes: 32 additions & 0 deletions docs/api/instant_keys/delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Delete an Instant Key

- [Request Parameters](#request-parameters)
- [Response](#response)

Deletes a specified [Instant Key](../../capability-guides/instant-keys/README.md).


<details>

<summary>Authentication Methods</summary>

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
</details>

## Request Parameters

**`instant_key_id`** *String* (Required)

ID of the Instant Key that you want to delete.

---


## Response

void

51 changes: 51 additions & 0 deletions docs/api/instant_keys/get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Get an Instant Key

- [Request Parameters](#request-parameters)
- [Response](#response)

Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).


<details>

<summary>Authentication Methods</summary>

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
</details>

## Request Parameters

**`instant_key_id`** *String* (Required)

ID of the instant key to get.

---


## Response

[instant\_key](./../user_identities)


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



```json
{
"client_session_id": "bfe3b1c6-fb9e-48b1-9b5b-c762b2983af6",
"created_at": "2025-06-14T16:54:17.946559Z",
"expires_at": "2025-06-16T16:54:17.946559Z",
"instant_key_id": "1d05c2f6-5b6f-4a9c-b80d-1eca26be12b9",
"instant_key_url": "https://ik.seam.co/ABCXYZ",
"user_identity_id": "e7a94acb-bd8a-4462-b6fb-8612d35cd7c3",
"workspace_id": "4d1c24b2-781e-4d1a-8d77-15249ad57c8a"
}
```
{% endtab %}
{% endtabs %}
51 changes: 51 additions & 0 deletions docs/api/instant_keys/list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# List Instant Keys

- [Request Parameters](#request-parameters)
- [Response](#response)

Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).


<details>

<summary>Authentication Methods</summary>

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
</details>

## Request Parameters

**`user_identity_id`** *String*

ID of the user identity by which you want to filter the list of Instant Keys.

---


## Response

Array of [instant\_keys](./../user_identities)


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



```json
{
"client_session_id": "bfe3b1c6-fb9e-48b1-9b5b-c762b2983af6",
"created_at": "2025-06-14T16:54:17.946559Z",
"expires_at": "2025-06-16T16:54:17.946559Z",
"instant_key_id": "1d05c2f6-5b6f-4a9c-b80d-1eca26be12b9",
"instant_key_url": "https://ik.seam.co/ABCXYZ",
"user_identity_id": "e7a94acb-bd8a-4462-b6fb-8612d35cd7c3",
"workspace_id": "4d1c24b2-781e-4d1a-8d77-15249ad57c8a"
}
```
{% endtab %}
{% endtabs %}
Loading