From d7c8a4cf3220c3bc810d0ef13f160c1fbc70e4a3 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 23 Sep 2025 13:40:31 +0000 Subject: [PATCH 1/2] feat: Update to @seamapi/types@1.585.0 --- package-lock.json | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index 5c14c5fb8..3b7215db4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.51.3", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.584.0", + "@seamapi/types": "1.585.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", @@ -983,9 +983,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.584.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.584.0.tgz", - "integrity": "sha512-+oQT8zsb5DUSfLd5ZSec/dyKunkua3oyG8s+Q3sy0N3AoHxZVkw141HdSq110fHf4QVdjt9B+Bl6lTRx+hNdnA==", + "version": "1.585.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.585.0.tgz", + "integrity": "sha512-Nxzw4vBtne74FH0Lb7InIZVLufS/yAX5JWuYD48vbnT/nYlZZGLOvepyl3SAYuPIv5msewEy55cLCGVuiwa6Jw==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 5cbf4e39f..113398a06 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.51.3", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.584.0", + "@seamapi/types": "1.585.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", From df007b60101b37b447b5021135ddb31461233d9b Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 23 Sep 2025 13:42:18 +0000 Subject: [PATCH 2/2] ci: Generate docs --- docs/SUMMARY.md | 9 + docs/api/_blueprint.json | 412 +++++++++++++++++++ docs/api/_report.md | 18 + docs/api/access_grants/unmanaged/README.md | 15 + docs/api/access_grants/unmanaged/get.md | 33 ++ docs/api/access_grants/unmanaged/list.md | 45 ++ docs/api/access_methods/unmanaged/README.md | 15 + docs/api/access_methods/unmanaged/get.md | 32 ++ docs/api/access_methods/unmanaged/list.md | 50 +++ docs/api/user_identities/unmanaged/README.md | 15 + docs/api/user_identities/unmanaged/get.md | 32 ++ docs/api/user_identities/unmanaged/list.md | 33 ++ 12 files changed, 709 insertions(+) create mode 100644 docs/api/access_grants/unmanaged/README.md create mode 100644 docs/api/access_grants/unmanaged/get.md create mode 100644 docs/api/access_grants/unmanaged/list.md create mode 100644 docs/api/access_methods/unmanaged/README.md create mode 100644 docs/api/access_methods/unmanaged/get.md create mode 100644 docs/api/access_methods/unmanaged/list.md create mode 100644 docs/api/user_identities/unmanaged/README.md create mode 100644 docs/api/user_identities/unmanaged/get.md create mode 100644 docs/api/user_identities/unmanaged/list.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index ec0a9b2c8..19f85f2fc 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -236,12 +236,18 @@ * [Get related Access Grant resources](api/access_grants/get_related.md) * [List Access Grants](api/access_grants/list.md) * [Update an Access Grant](api/access_grants/update.md) + * [Unmanaged](api/access_grants/unmanaged/README.md) + * [Get an Unmanaged Access Grant](api/access_grants/unmanaged/get.md) + * [List Unmanaged Access Grants](api/access_grants/unmanaged/list.md) * [Access Methods](api/access_methods/README.md) * [Delete an Access Method](api/access_methods/delete.md) * [Encode an Access Method](api/access_methods/encode.md) * [Get an Access Method](api/access_methods/get.md) * [Get related Access Method resources](api/access_methods/get_related.md) * [List Access Methods](api/access_methods/list.md) + * [Unmanaged](api/access_methods/unmanaged/README.md) + * [Get an Unmanaged Access Method](api/access_methods/unmanaged/get.md) + * [List Unmanaged Access Methods](api/access_methods/unmanaged/list.md) * [Action Attempts](api/action_attempts/README.md) * [Get an Action Attempt](api/action_attempts/get.md) * [List Action Attempts](api/action_attempts/list.md) @@ -368,6 +374,9 @@ * [Remove an ACS User from a User Identity](api/user_identities/remove_acs_user.md) * [Revoke Access to a Device from a User Identity](api/user_identities/revoke_access_to_device.md) * [Update a User Identity](api/user_identities/update.md) + * [Unmanaged](api/user_identities/unmanaged/README.md) + * [Get an Unmanaged User Identity](api/user_identities/unmanaged/get.md) + * [List Unmanaged User Identities](api/user_identities/unmanaged/list.md) * [Webhooks](api/webhooks/README.md) * [Create a Webhook](api/webhooks/create.md) * [Delete a Webhook](api/webhooks/delete.md) diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index d78025c63..fcb741b6e 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -6304,6 +6304,149 @@ "isDeprecated": false, "isDraft": true }, + { + "path": "/access_grants/unmanaged", + "name": "unmanaged", + "namespacePath": null, + "endpoints": [ + { + "title": "Get an Unmanaged Access Grant", + "name": "get", + "path": "/access_grants/unmanaged/get", + "parentPath": "/access_grants/unmanaged", + "description": "Get an unmanaged Access Grant (where is_managed = false).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": true, + "draftMessage": "Early access.", + "response": { + "responseType": "resource", + "responseKey": "access_grant", + "resourceType": "unknown", + "description": "OK", + "actionAttemptType": null + }, + "request": { + "methods": [ + "GET", + "POST" + ], + "semanticMethod": "GET", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_grant_id", + "description": "ID of unmanaged Access Grant to get.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "personal_access_token", + "api_key", + "client_session_token" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "List Unmanaged Access Grants", + "name": "list", + "path": "/access_grants/unmanaged/list", + "parentPath": "/access_grants/unmanaged", + "description": "Gets unmanaged Access Grants (where is_managed = false).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": true, + "draftMessage": "Early access.", + "response": { + "responseType": "resource_list", + "responseKey": "access_grants", + "resourceType": "unknown", + "description": "OK", + "actionAttemptType": null + }, + "request": { + "methods": [ + "GET", + "POST" + ], + "semanticMethod": "GET", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_entrance_id", + "description": "ID of the entrance by which you want to filter the list of unmanaged Access Grants.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the access system by which you want to filter the list of unmanaged Access Grants.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of user identity by which you want to filter the list of unmanaged Access Grants.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "personal_access_token", + "api_key", + "client_session_token" + ], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "parentPath": "/access_grants", + "isUndocumented": false, + "isDeprecated": false, + "isDraft": true + }, { "path": "/access_methods", "name": "access_methods", @@ -7099,6 +7242,161 @@ "isDeprecated": false, "isDraft": false }, + { + "path": "/access_methods/unmanaged", + "name": "unmanaged", + "namespacePath": null, + "endpoints": [ + { + "title": "Get an Unmanaged Access Method", + "name": "get", + "path": "/access_methods/unmanaged/get", + "parentPath": "/access_methods/unmanaged", + "description": "Gets an unmanaged access method (where is_managed = false).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": true, + "draftMessage": "Early access.", + "response": { + "responseType": "resource", + "responseKey": "access_method", + "resourceType": "unknown", + "description": "OK", + "actionAttemptType": null + }, + "request": { + "methods": [ + "GET", + "POST" + ], + "semanticMethod": "GET", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_method_id", + "description": "ID of unmanaged access method to get.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "List Unmanaged Access Methods", + "name": "list", + "path": "/access_methods/unmanaged/list", + "parentPath": "/access_methods/unmanaged", + "description": "Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": true, + "draftMessage": "Early access.", + "response": { + "responseType": "resource_list", + "responseKey": "access_methods", + "resourceType": "unknown", + "description": "OK", + "actionAttemptType": null + }, + "request": { + "methods": [ + "GET", + "POST" + ], + "semanticMethod": "GET", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_grant_id", + "description": "ID of Access Grant to list unmanaged access methods for.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_entrance_id", + "description": "ID of the entrance for which you want to retrieve all unmanaged access methods.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device for which you want to retrieve all unmanaged access methods.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "space_id", + "description": "ID of the space for which you want to retrieve all unmanaged access methods.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "parentPath": "/access_methods", + "isUndocumented": false, + "isDeprecated": false, + "isDraft": true + }, { "path": "/acs/access_groups", "name": "access_groups", @@ -64591,6 +64889,120 @@ "isDeprecated": false, "isDraft": false }, + { + "path": "/user_identities/unmanaged", + "name": "unmanaged", + "namespacePath": null, + "endpoints": [ + { + "title": "Get an Unmanaged User Identity", + "name": "get", + "path": "/user_identities/unmanaged/get", + "parentPath": "/user_identities/unmanaged", + "description": "Returns a specified unmanaged [user identity](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) (where is_managed = false).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "user_identity", + "resourceType": "unknown", + "description": "OK", + "actionAttemptType": null + }, + "request": { + "methods": [ + "GET", + "POST" + ], + "semanticMethod": "GET", + "preferredMethod": "POST", + "parameters": [ + { + "name": "user_identity_id", + "description": "ID of the unmanaged user identity that you want to get.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "api_key", + "personal_access_token" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "List Unmanaged User Identities", + "name": "list", + "path": "/user_identities/unmanaged/list", + "parentPath": "/user_identities/unmanaged", + "description": "Returns a list of all unmanaged [user identities](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) (where is_managed = false).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "user_identities", + "resourceType": "unknown", + "description": "OK", + "actionAttemptType": null + }, + "request": { + "methods": [ + "GET", + "POST" + ], + "semanticMethod": "GET", + "preferredMethod": "POST", + "parameters": [ + { + "name": "search", + "description": "String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "api_key", + "client_session_token", + "personal_access_token" + ], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "parentPath": "/user_identities", + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, { "path": "/webhooks", "name": "webhooks", diff --git a/docs/api/_report.md b/docs/api/_report.md index 379c97ac7..4b5d2f09d 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -440,6 +440,8 @@ These items have been marked as draft. ### Routes - `/access_grants`: No draft message provided +- `/access_grants/unmanaged`: No draft message provided +- `/access_methods/unmanaged`: No draft message provided - `/spaces`: No draft message provided ### Endpoints @@ -450,10 +452,14 @@ These items have been marked as draft. - `/access_grants/get_related`: Early access. - `/access_grants/list`: Early access. - `/access_grants/update`: Early access. +- `/access_grants/unmanaged/get`: Early access. +- `/access_grants/unmanaged/list`: Early access. - `/access_methods/delete`: Early access. - `/access_methods/get`: Early access. - `/access_methods/get_related`: Early access. - `/access_methods/list`: Early access. +- `/access_methods/unmanaged/get`: Early access. +- `/access_methods/unmanaged/list`: Early access. - `/spaces/add_acs_entrances`: Early access. - `/spaces/add_devices`: Early access. - `/spaces/create`: Early access. @@ -566,7 +572,11 @@ These items are deprecated. ### Missing resources - `/access_grants/get_related`: `batch` +- `/access_grants/unmanaged/get`: `access_grant` +- `/access_grants/unmanaged/list`: `access_grants` - `/access_methods/get_related`: `batch` +- `/access_methods/unmanaged/get`: `access_method` +- `/access_methods/unmanaged/list`: `access_methods` - `/bridges/get`: `bridge` - `/bridges/list`: `bridges` - `/seam/console/v1/get_resource_locator`: `resource_locator` @@ -579,13 +589,19 @@ These items are deprecated. - `/seam/instant_key/v1/preview/get`: `instant_key_preview` - `/seam/partner/v1/building_blocks/spaces/auto_map`: `spaces` - `/spaces/get_related`: `batch` +- `/user_identities/unmanaged/get`: `user_identity` +- `/user_identities/unmanaged/list`: `user_identities` - `/workspaces/find_anything`: `batch` ### Endpoints without code samples - `/access_grants/get_related` +- `/access_grants/unmanaged/get` +- `/access_grants/unmanaged/list` - `/access_methods/encode` - `/access_methods/get_related` +- `/access_methods/unmanaged/get` +- `/access_methods/unmanaged/list` - `/customers/create_portal` - `/customers/delete_data` - `/customers/push_data` @@ -595,6 +611,8 @@ These items are deprecated. - `/instant_keys/list` - `/locks/get` - `/spaces/get_related` +- `/user_identities/unmanaged/get` +- `/user_identities/unmanaged/list` ### Resources without resource samples diff --git a/docs/api/access_grants/unmanaged/README.md b/docs/api/access_grants/unmanaged/README.md new file mode 100644 index 000000000..ad247ad1b --- /dev/null +++ b/docs/api/access_grants/unmanaged/README.md @@ -0,0 +1,15 @@ +# Unmanaged + +## Endpoints + + +[**`/access_grants/unmanaged/get`**](./get.md) + +Get an unmanaged Access Grant (where is_managed = false). + + +[**`/access_grants/unmanaged/list`**](./list.md) + +Gets unmanaged Access Grants (where is_managed = false). + + diff --git a/docs/api/access_grants/unmanaged/get.md b/docs/api/access_grants/unmanaged/get.md new file mode 100644 index 000000000..49acf8398 --- /dev/null +++ b/docs/api/access_grants/unmanaged/get.md @@ -0,0 +1,33 @@ +# Get an Unmanaged Access Grant + +- [Request Parameters](#request-parameters) +- [Response](#response) + +Get an unmanaged Access Grant (where is_managed = false). + + +
+ +Authentication Methods + +- API key +- Client session token +- 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 + +**`access_grant_id`** *String* (Required) + +ID of unmanaged Access Grant to get. + +--- + + +## Response + +[unknown](./) + diff --git a/docs/api/access_grants/unmanaged/list.md b/docs/api/access_grants/unmanaged/list.md new file mode 100644 index 000000000..d2dbf3c03 --- /dev/null +++ b/docs/api/access_grants/unmanaged/list.md @@ -0,0 +1,45 @@ +# List Unmanaged Access Grants + +- [Request Parameters](#request-parameters) +- [Response](#response) + +Gets unmanaged Access Grants (where is_managed = false). + + +
+ +Authentication Methods + +- API key +- Client session token +- 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 + +**`acs_entrance_id`** *String* + +ID of the entrance by which you want to filter the list of unmanaged Access Grants. + +--- + +**`acs_system_id`** *String* + +ID of the access system by which you want to filter the list of unmanaged Access Grants. + +--- + +**`user_identity_id`** *String* + +ID of user identity by which you want to filter the list of unmanaged Access Grants. + +--- + + +## Response + +Array of [unknowns](./) + diff --git a/docs/api/access_methods/unmanaged/README.md b/docs/api/access_methods/unmanaged/README.md new file mode 100644 index 000000000..41f8f5271 --- /dev/null +++ b/docs/api/access_methods/unmanaged/README.md @@ -0,0 +1,15 @@ +# Unmanaged + +## Endpoints + + +[**`/access_methods/unmanaged/get`**](./get.md) + +Gets an unmanaged access method (where is_managed = false). + + +[**`/access_methods/unmanaged/list`**](./list.md) + +Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant. + + diff --git a/docs/api/access_methods/unmanaged/get.md b/docs/api/access_methods/unmanaged/get.md new file mode 100644 index 000000000..e2f91455b --- /dev/null +++ b/docs/api/access_methods/unmanaged/get.md @@ -0,0 +1,32 @@ +# Get an Unmanaged Access Method + +- [Request Parameters](#request-parameters) +- [Response](#response) + +Gets an unmanaged access method (where is_managed = false). + + +
+ +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 + +**`access_method_id`** *String* (Required) + +ID of unmanaged access method to get. + +--- + + +## Response + +[unknown](./) + diff --git a/docs/api/access_methods/unmanaged/list.md b/docs/api/access_methods/unmanaged/list.md new file mode 100644 index 000000000..213af2ac1 --- /dev/null +++ b/docs/api/access_methods/unmanaged/list.md @@ -0,0 +1,50 @@ +# List Unmanaged Access Methods + +- [Request Parameters](#request-parameters) +- [Response](#response) + +Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant. + + +
+ +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 + +**`access_grant_id`** *String* (Required) + +ID of Access Grant to list unmanaged access methods for. + +--- + +**`acs_entrance_id`** *String* + +ID of the entrance for which you want to retrieve all unmanaged access methods. + +--- + +**`device_id`** *String* + +ID of the device for which you want to retrieve all unmanaged access methods. + +--- + +**`space_id`** *String* + +ID of the space for which you want to retrieve all unmanaged access methods. + +--- + + +## Response + +Array of [unknowns](./) + diff --git a/docs/api/user_identities/unmanaged/README.md b/docs/api/user_identities/unmanaged/README.md new file mode 100644 index 000000000..a1d3cd36e --- /dev/null +++ b/docs/api/user_identities/unmanaged/README.md @@ -0,0 +1,15 @@ +# Unmanaged + +## Endpoints + + +[**`/user_identities/unmanaged/get`**](./get.md) + +Returns a specified unmanaged [user identity](../../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) (where is_managed = false). + + +[**`/user_identities/unmanaged/list`**](./list.md) + +Returns a list of all unmanaged [user identities](../../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) (where is_managed = false). + + diff --git a/docs/api/user_identities/unmanaged/get.md b/docs/api/user_identities/unmanaged/get.md new file mode 100644 index 000000000..a6fa74442 --- /dev/null +++ b/docs/api/user_identities/unmanaged/get.md @@ -0,0 +1,32 @@ +# Get an Unmanaged User Identity + +- [Request Parameters](#request-parameters) +- [Response](#response) + +Returns a specified unmanaged [user identity](../../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) (where is_managed = false). + + +
+ +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* (Required) + +ID of the unmanaged user identity that you want to get. + +--- + + +## Response + +[unknown](./) + diff --git a/docs/api/user_identities/unmanaged/list.md b/docs/api/user_identities/unmanaged/list.md new file mode 100644 index 000000000..f8ced21b5 --- /dev/null +++ b/docs/api/user_identities/unmanaged/list.md @@ -0,0 +1,33 @@ +# List Unmanaged User Identities + +- [Request Parameters](#request-parameters) +- [Response](#response) + +Returns a list of all unmanaged [user identities](../../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) (where is_managed = false). + + +
+ +Authentication Methods + +- API key +- Client session token +- 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 + +**`search`** *String* + +String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`. + +--- + + +## Response + +Array of [unknowns](./) +