diff --git a/codegen/data/paths.yaml b/codegen/data/paths.yaml index ce4bd8dfe..f904d60a9 100644 --- a/codegen/data/paths.yaml +++ b/codegen/data/paths.yaml @@ -200,3 +200,6 @@ /locks/simulate: title: Lock Simulations + +/instant_keys: + title: Instant Keys diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index d7ba2225f..f43b3fff3 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -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) diff --git a/docs/api/_report.md b/docs/api/_report.md index 2b5092875..aa8d87749 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -4,7 +4,6 @@ ### Routes -- `/instant_keys` - `/thermostats/daily_programs` - `/user_identities/enrollment_automations` diff --git a/docs/api/instant_keys/README.md b/docs/api/instant_keys/README.md new file mode 100644 index 000000000..4b4a4a5f1 --- /dev/null +++ b/docs/api/instant_keys/README.md @@ -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). + + diff --git a/docs/api/instant_keys/delete.md b/docs/api/instant_keys/delete.md new file mode 100644 index 000000000..1f8da53f4 --- /dev/null +++ b/docs/api/instant_keys/delete.md @@ -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). + + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication). +
+ +## Request Parameters + +**`instant_key_id`** *String* (Required) + +ID of the Instant Key that you want to delete. + +--- + + +## Response + +void + diff --git a/docs/api/instant_keys/get.md b/docs/api/instant_keys/get.md new file mode 100644 index 000000000..eadef0647 --- /dev/null +++ b/docs/api/instant_keys/get.md @@ -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). + + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication). +
+ +## 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 %} diff --git a/docs/api/instant_keys/list.md b/docs/api/instant_keys/list.md new file mode 100644 index 000000000..f65c10924 --- /dev/null +++ b/docs/api/instant_keys/list.md @@ -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). + + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication). +
+ +## 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 %}