Add code sample for /user_identities/generate_instant_key

docs/api/_blueprint.json

@@ -31457,7 +31457,105 @@
             "personal_access_token"
           ],
           "workspaceScope": "required",
-          "codeSamples": []
+          "codeSamples": [
+            {
+              "title": "Generate an Instant Key",
+              "description": "Specify the `user_identity_id` to receive the instant key.",
+              "request": {
+                "path": "/user_identities/generate_instant_key",
+                "parameters": {
+                  "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f"
+                }
+              },
+              "response": {
+                "body": {
+                  "instant_key": {
+                    "instant_key_id": "33fb0384-b2b3-445e-b780-3fad784e9baa",
+                    "instant_key_url": "https://ik.seam.co/EXAMPLE",
+                    "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+                    "client_session_id": "7cc9b16b-d139-45e2-8042-5cef6ee101ea",
+                    "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+                    "created_at": "2024-01-09T05:45:33.068Z",
+                    "expires_at": "2024-02-09T05:45:33.068Z"
+                  }
+                }
+              },
+              "code": {
+                "javascript": {
+                  "title": "JavaScript",
+                  "sdkName": "javascript",
+                  "request": "await seam.userIdentities.generateInstantKey({\n  user_identity_id: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n});",
+                  "response": "{\n  \"instant_key_id\": \"33fb0384-b2b3-445e-b780-3fad784e9baa\",\n  \"instant_key_url\": \"https://ik.seam.co/EXAMPLE\",\n  \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n  \"client_session_id\": \"7cc9b16b-d139-45e2-8042-5cef6ee101ea\",\n  \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n  \"created_at\": \"2024-01-09T05:45:33.068Z\",\n  \"expires_at\": \"2024-02-09T05:45:33.068Z\"\n}",
+                  "request_syntax": "javascript",
+                  "response_syntax": "json"
+                },
+                "python": {
+                  "title": "Python",
+                  "sdkName": "python",
+                  "request": "seam.user_identities.generate_instant_key(\n    user_identity_id=\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\"\n)",
+                  "response": "InstantKey(\n    instant_key_id=\"33fb0384-b2b3-445e-b780-3fad784e9baa\",\n    instant_key_url=\"https://ik.seam.co/EXAMPLE\",\n    user_identity_id=\"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n    client_session_id=\"7cc9b16b-d139-45e2-8042-5cef6ee101ea\",\n    workspace_id=\"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n    created_at=\"2024-01-09T05:45:33.068Z\",\n    expires_at=\"2024-02-09T05:45:33.068Z\",\n)",
+                  "request_syntax": "python",
+                  "response_syntax": "python"
+                },
+                "ruby": {
+                  "title": "Ruby",
+                  "sdkName": "ruby",
+                  "request": "seam.user_identities.generate_instant_key(user_identity_id: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\")",
+                  "response": "{\n  \"instant_key_id\" => \"33fb0384-b2b3-445e-b780-3fad784e9baa\",\n  \"instant_key_url\" => \"https://ik.seam.co/EXAMPLE\",\n  \"user_identity_id\" => \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n  \"client_session_id\" => \"7cc9b16b-d139-45e2-8042-5cef6ee101ea\",\n  \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n  \"created_at\" => \"2024-01-09T05:45:33.068Z\",\n  \"expires_at\" => \"2024-02-09T05:45:33.068Z\",\n}",
+                  "request_syntax": "ruby",
+                  "response_syntax": "ruby"
+                },
+                "php": {
+                  "title": "PHP",
+                  "sdkName": "php",
+                  "request": "<?php\n$seam->user_identities->generate_instant_key(\n    user_identity_id: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\"\n);",
+                  "response": "<?php\n[\n    \"instant_key_id\" => \"33fb0384-b2b3-445e-b780-3fad784e9baa\",\n    \"instant_key_url\" => \"https://ik.seam.co/EXAMPLE\",\n    \"user_identity_id\" => \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n    \"client_session_id\" => \"7cc9b16b-d139-45e2-8042-5cef6ee101ea\",\n    \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n    \"created_at\" => \"2024-01-09T05:45:33.068Z\",\n    \"expires_at\" => \"2024-02-09T05:45:33.068Z\",\n];",
+                  "request_syntax": "php",
+                  "response_syntax": "php"
+                },
+                "seam_cli": {
+                  "title": "Seam CLI",
+                  "sdkName": "seam_cli",
+                  "request": "seam user-identities generate-instant-key --user_identity_id \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\"",
+                  "response": "{\n  \"instant_key_id\": \"33fb0384-b2b3-445e-b780-3fad784e9baa\",\n  \"instant_key_url\": \"https://ik.seam.co/EXAMPLE\",\n  \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n  \"client_session_id\": \"7cc9b16b-d139-45e2-8042-5cef6ee101ea\",\n  \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n  \"created_at\": \"2024-01-09T05:45:33.068Z\",\n  \"expires_at\": \"2024-02-09T05:45:33.068Z\"\n}",
+                  "request_syntax": "bash",
+                  "response_syntax": "json"
+                },
+                "go": {
+                  "title": "Go",
+                  "sdkName": "go",
+                  "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.UserIdentities.GenerateInstantKey(\n\t\tcontext.Background(),\n\t\tapi.UserIdentitiesGenerateInstantKeyRequest{\n\t\t\tUserIdentityId: api.String(\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\"),\n\t\t},\n\t)\n}",
+                  "response": "api.InstantKey{InstantKeyId: \"33fb0384-b2b3-445e-b780-3fad784e9baa\", InstantKeyUrl: \"https://ik.seam.co/EXAMPLE\", UserIdentityId: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\", ClientSessionId: \"7cc9b16b-d139-45e2-8042-5cef6ee101ea\", WorkspaceId: \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\", CreatedAt: \"2024-01-09T05:45:33.068Z\", ExpiresAt: \"2024-02-09T05:45:33.068Z\"}",
+                  "request_syntax": "go",
+                  "response_syntax": "go"
+                },
+                "java": {
+                  "title": "Java",
+                  "sdkName": "java",
+                  "request": "seam.userIdentities().generateInstantKey(UserIdentitiesGenerateInstantKeyRequest.builder().userIdentityId(\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\").build());",
+                  "response": "{\n  \"instant_key_id\": \"33fb0384-b2b3-445e-b780-3fad784e9baa\",\n  \"instant_key_url\": \"https://ik.seam.co/EXAMPLE\",\n  \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n  \"client_session_id\": \"7cc9b16b-d139-45e2-8042-5cef6ee101ea\",\n  \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n  \"created_at\": \"2024-01-09T05:45:33.068Z\",\n  \"expires_at\": \"2024-02-09T05:45:33.068Z\"\n}",
+                  "request_syntax": "java",
+                  "response_syntax": "json"
+                },
+                "csharp": {
+                  "title": "C#",
+                  "sdkName": "csharp",
+                  "request": "seam.UserIdentities.GenerateInstantKey(userIdentityId: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\")",
+                  "response": "{\n  \"instant_key_id\": \"33fb0384-b2b3-445e-b780-3fad784e9baa\",\n  \"instant_key_url\": \"https://ik.seam.co/EXAMPLE\",\n  \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n  \"client_session_id\": \"7cc9b16b-d139-45e2-8042-5cef6ee101ea\",\n  \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n  \"created_at\": \"2024-01-09T05:45:33.068Z\",\n  \"expires_at\": \"2024-02-09T05:45:33.068Z\"\n}",
+                  "request_syntax": "csharp",
+                  "response_syntax": "json"
+                },
+                "curl": {
+                  "title": "cURL",
+                  "sdkName": "curl",
+                  "request": "curl --include --request POST \"https://connect.getseam.com/user_identities/generate_instant_key\" \\\n  --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n  --json @- <<EOF\n{\n  \"user_identity_id\": \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\"\n}\nEOF",
+                  "response": "{\n  \"instant_key\": {\n    \"instant_key_id\": \"33fb0384-b2b3-445e-b780-3fad784e9baa\",\n    \"instant_key_url\": \"https://ik.seam.co/EXAMPLE\",\n    \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n    \"client_session_id\": \"7cc9b16b-d139-45e2-8042-5cef6ee101ea\",\n    \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n    \"created_at\": \"2024-01-09T05:45:33.068Z\",\n    \"expires_at\": \"2024-02-09T05:45:33.068Z\"\n  }\n}",
+                  "request_syntax": "bash",
+                  "response_syntax": "json"
+                }
+              }
+            }
+          ]
         },
         {
           "title": "Get a User Identity",

docs/api/_report.md

@@ -706,7 +706,6 @@ These items are deprecated.
 - `/unstable_partner/building_blocks/manage_devices`
 - `/unstable_partner/building_blocks/organize_spaces`
 - `/unstable_partner/resources/push`
-- `/user_identities/generate_instant_key`
 - `/user_identities/update`
 - `/webhooks/create`
 - `/webhooks/delete`

docs/api/user_identities/generate_instant_key.md

@@ -7,6 +7,204 @@
 Generates a new [instant key](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/instant-keys) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
 
 
+{% tabs %}
+{% tab title="JavaScript" %}
+
+Specify the `user_identity_id` to receive the instant key.
+
+#### Code
+
+```javascript
+await seam.userIdentities.generateInstantKey({
+  user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+});
+```
+
+#### Output
+
+```javascript
+{
+  "instant_key_id": "33fb0384-b2b3-445e-b780-3fad784e9baa",
+  "instant_key_url": "https://ik.seam.co/EXAMPLE",
+  "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+  "client_session_id": "7cc9b16b-d139-45e2-8042-5cef6ee101ea",
+  "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+  "created_at": "2024-01-09T05:45:33.068Z",
+  "expires_at": "2024-02-09T05:45:33.068Z"
+}
+```
+{% endtab %}
+
+{% tab title="cURL" %}
+
+Specify the `user_identity_id` to receive the instant key.
+
+#### Code
+
+```curl
+curl --include --request POST "https://connect.getseam.com/user_identities/generate_instant_key" \
+  --header "Authorization: Bearer $SEAM_API_KEY" \
+  --json @- <<EOF
+{
+  "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f"
+}
+EOF
+```
+
+#### Output
+
+```curl
+{
+  "instant_key": {
+    "instant_key_id": "33fb0384-b2b3-445e-b780-3fad784e9baa",
+    "instant_key_url": "https://ik.seam.co/EXAMPLE",
+    "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+    "client_session_id": "7cc9b16b-d139-45e2-8042-5cef6ee101ea",
+    "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+    "created_at": "2024-01-09T05:45:33.068Z",
+    "expires_at": "2024-02-09T05:45:33.068Z"
+  }
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+
+Specify the `user_identity_id` to receive the instant key.
+
+#### Code
+
+```python
+seam.user_identities.generate_instant_key(
+    user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f"
+)
+```
+
+#### Output
+
+```python
+InstantKey(
+    instant_key_id="33fb0384-b2b3-445e-b780-3fad784e9baa",
+    instant_key_url="https://ik.seam.co/EXAMPLE",
+    user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+    client_session_id="7cc9b16b-d139-45e2-8042-5cef6ee101ea",
+    workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+    created_at="2024-01-09T05:45:33.068Z",
+    expires_at="2024-02-09T05:45:33.068Z",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+
+Specify the `user_identity_id` to receive the instant key.
+
+#### Code
+
+```ruby
+seam.user_identities.generate_instant_key(user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f")
+```
+
+#### Output
+
+```ruby
+{
+  "instant_key_id" => "33fb0384-b2b3-445e-b780-3fad784e9baa",
+  "instant_key_url" => "https://ik.seam.co/EXAMPLE",
+  "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+  "client_session_id" => "7cc9b16b-d139-45e2-8042-5cef6ee101ea",
+  "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+  "created_at" => "2024-01-09T05:45:33.068Z",
+  "expires_at" => "2024-02-09T05:45:33.068Z",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+
+Specify the `user_identity_id` to receive the instant key.
+
+#### Code
+
+```php
+<?php
+$seam->user_identities->generate_instant_key(
+    user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f"
+);
+```
+
+#### Output
+
+```php
+<?php
+[
+    "instant_key_id" => "33fb0384-b2b3-445e-b780-3fad784e9baa",
+    "instant_key_url" => "https://ik.seam.co/EXAMPLE",
+    "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+    "client_session_id" => "7cc9b16b-d139-45e2-8042-5cef6ee101ea",
+    "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+    "created_at" => "2024-01-09T05:45:33.068Z",
+    "expires_at" => "2024-02-09T05:45:33.068Z",
+];
+```
+{% endtab %}
+
+{% tab title="Go" %}
+
+Specify the `user_identity_id` to receive the instant key.
+
+#### Code
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+	client.UserIdentities.GenerateInstantKey(
+		context.Background(),
+		api.UserIdentitiesGenerateInstantKeyRequest{
+			UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"),
+		},
+	)
+}
+```
+
+#### Output
+
+```go
+api.InstantKey{InstantKeyId: "33fb0384-b2b3-445e-b780-3fad784e9baa", InstantKeyUrl: "https://ik.seam.co/EXAMPLE", UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", ClientSessionId: "7cc9b16b-d139-45e2-8042-5cef6ee101ea", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z", ExpiresAt: "2024-02-09T05:45:33.068Z"}
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+
+Specify the `user_identity_id` to receive the instant key.
+
+#### Code
+
+```seam_cli
+seam user-identities generate-instant-key --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f"
+```
+
+#### Output
+
+```seam_cli
+{
+  "instant_key_id": "33fb0384-b2b3-445e-b780-3fad784e9baa",
+  "instant_key_url": "https://ik.seam.co/EXAMPLE",
+  "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+  "client_session_id": "7cc9b16b-d139-45e2-8042-5cef6ee101ea",
+  "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+  "created_at": "2024-01-09T05:45:33.068Z",
+  "expires_at": "2024-02-09T05:45:33.068Z"
+}
+```
+{% endtab %}
+
+{% endtabs %}
+
+
 <details>
 
 <summary>Authentication Methods</summary>
@@ -37,3 +235,8 @@ Maximum number of times the instant key can be used. Default: 1.
 
 [instant\_key](./)
 
+
+---
+
+## Examples
+

src/data/code-sample-definitions/user-identities.yaml

@@ -266,3 +266,20 @@
       enrollment_automation_id: '05505650-aa57-49ab-8f19-429738758895'
   response:
     body: null
+
+- title: Generate an Instant Key
+  description: Specify the `user_identity_id` to receive the instant key.
+  request:
+    path: /user_identities/generate_instant_key
+    parameters:
+      user_identity_id: '5c945ab5-c75e-4bcb-8e5f-9410061c401f'
+  response:
+    body:
+      instant_key:
+        instant_key_id: '33fb0384-b2b3-445e-b780-3fad784e9baa'
+        instant_key_url: 'https://ik.seam.co/EXAMPLE'
+        user_identity_id: '48500a8e-5e7e-4bde-b7e5-0be97cae5d7a'
+        client_session_id: '7cc9b16b-d139-45e2-8042-5cef6ee101ea'
+        workspace_id: '398d80b7-3f96-47c2-b85a-6f8ba21d07be'
+        created_at: '2024-01-09T05:45:33.068Z'
+        expires_at: '2024-02-09T05:45:33.068Z'