File tree Expand file tree Collapse file tree 7 files changed +161
-1
lines changed
Expand file tree Collapse file tree 7 files changed +161
-1
lines changed Original file line number Diff line number Diff line change 200200
201201/locks/simulate :
202202 title : Lock Simulations
203+
204+ /instant_keys :
205+ title : Instant Keys
Original file line number Diff line number Diff line change 272272* [ Events] ( api/events/README.md )
273273 * [ Get an Event] ( api/events/get.md )
274274 * [ List Events] ( api/events/list.md )
275+ * [ Instant Keys] ( api/instant_keys/README.md )
276+ * [ Delete an Instant Key] ( api/instant_keys/delete.md )
277+ * [ Get an Instant Key] ( api/instant_keys/get.md )
278+ * [ List Instant Keys] ( api/instant_keys/list.md )
275279* [ Locks] ( api/locks/README.md )
276280 * [ Get a Lock] ( api/locks/get.md )
277281 * [ List Locks] ( api/locks/list.md )
Original file line number Diff line number Diff line change 44
55### Routes
66
7- - ` /instant_keys `
87- ` /thermostats/daily_programs `
98- ` /user_identities/enrollment_automations `
109
Original file line number Diff line number Diff line change 1+ # Instant Keys
2+
3+ ## Endpoints
4+
5+
6+ [ ** ` /instant_keys/delete ` ** ] ( ./delete.md )
7+
8+ Deletes a specified [ Instant Key] ( ../../capability-guides/instant-keys/README.md ) .
9+
10+
11+ [ ** ` /instant_keys/get ` ** ] ( ./get.md )
12+
13+ Gets an [ instant key] ( https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys ) .
14+
15+
16+ [ ** ` /instant_keys/list ` ** ] ( ./list.md )
17+
18+ Returns a list of all [ instant keys] ( https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys ) .
19+
20+
Original file line number Diff line number Diff line change 1+ # Delete an Instant Key
2+
3+ - [ Request Parameters] ( #request-parameters )
4+ - [ Response] ( #response )
5+
6+ Deletes a specified [ Instant Key] ( ../../capability-guides/instant-keys/README.md ) .
7+
8+
9+ <details >
10+
11+ <summary >Authentication Methods</summary >
12+
13+ - API key
14+ - Personal access token
15+ <br >Must also include the ` seam-workspace ` header in the request.
16+
17+ To learn more, see [ Authentication] ( https://docs.seam.co/latest/api/authentication ) .
18+ </details >
19+
20+ ## Request Parameters
21+
22+ ** ` instant_key_id ` ** * String* (Required)
23+
24+ ID of the Instant Key that you want to delete.
25+
26+ ---
27+
28+
29+ ## Response
30+
31+ void
32+
Original file line number Diff line number Diff line change 1+ # Get an Instant Key
2+
3+ - [ Request Parameters] ( #request-parameters )
4+ - [ Response] ( #response )
5+
6+ Gets an [ instant key] ( https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys ) .
7+
8+
9+ <details >
10+
11+ <summary >Authentication Methods</summary >
12+
13+ - API key
14+ - Personal access token
15+ <br >Must also include the ` seam-workspace ` header in the request.
16+
17+ To learn more, see [ Authentication] ( https://docs.seam.co/latest/api/authentication ) .
18+ </details >
19+
20+ ## Request Parameters
21+
22+ ** ` instant_key_id ` ** * String* (Required)
23+
24+ ID of the instant key to get.
25+
26+ ---
27+
28+
29+ ## Response
30+
31+ [ instant\_ key] ( ./../user_identities )
32+
33+
34+ {% tabs %}
35+ {% tab title="JSON" %}
36+
37+
38+
39+ ``` json
40+ {
41+ "client_session_id" : " bfe3b1c6-fb9e-48b1-9b5b-c762b2983af6" ,
42+ "created_at" : " 2025-06-14T16:54:17.946559Z" ,
43+ "expires_at" : " 2025-06-16T16:54:17.946559Z" ,
44+ "instant_key_id" : " 1d05c2f6-5b6f-4a9c-b80d-1eca26be12b9" ,
45+ "instant_key_url" : " https://ik.seam.co/ABCXYZ" ,
46+ "user_identity_id" : " e7a94acb-bd8a-4462-b6fb-8612d35cd7c3" ,
47+ "workspace_id" : " 4d1c24b2-781e-4d1a-8d77-15249ad57c8a"
48+ }
49+ ```
50+ {% endtab %}
51+ {% endtabs %}
Original file line number Diff line number Diff line change 1+ # List Instant Keys
2+
3+ - [ Request Parameters] ( #request-parameters )
4+ - [ Response] ( #response )
5+
6+ Returns a list of all [ instant keys] ( https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys ) .
7+
8+
9+ <details >
10+
11+ <summary >Authentication Methods</summary >
12+
13+ - API key
14+ - Personal access token
15+ <br >Must also include the ` seam-workspace ` header in the request.
16+
17+ To learn more, see [ Authentication] ( https://docs.seam.co/latest/api/authentication ) .
18+ </details >
19+
20+ ## Request Parameters
21+
22+ ** ` user_identity_id ` ** * String*
23+
24+ ID of the user identity by which you want to filter the list of Instant Keys.
25+
26+ ---
27+
28+
29+ ## Response
30+
31+ Array of [ instant\_ keys] ( ./../user_identities )
32+
33+
34+ {% tabs %}
35+ {% tab title="JSON" %}
36+
37+
38+
39+ ``` json
40+ {
41+ "client_session_id" : " bfe3b1c6-fb9e-48b1-9b5b-c762b2983af6" ,
42+ "created_at" : " 2025-06-14T16:54:17.946559Z" ,
43+ "expires_at" : " 2025-06-16T16:54:17.946559Z" ,
44+ "instant_key_id" : " 1d05c2f6-5b6f-4a9c-b80d-1eca26be12b9" ,
45+ "instant_key_url" : " https://ik.seam.co/ABCXYZ" ,
46+ "user_identity_id" : " e7a94acb-bd8a-4462-b6fb-8612d35cd7c3" ,
47+ "workspace_id" : " 4d1c24b2-781e-4d1a-8d77-15249ad57c8a"
48+ }
49+ ```
50+ {% endtab %}
51+ {% endtabs %}
You can’t perform that action at this time.
0 commit comments