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
2 changes: 2 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,7 @@
* [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)
* [Update an Unmanaged Access Grant](api/access_grants/unmanaged/update.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)
Expand Down Expand Up @@ -378,6 +379,7 @@
* [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)
* [Update an Unmanaged User Identity](api/user_identities/unmanaged/update.md)
* [Webhooks](api/webhooks/README.md)
* [Create a Webhook](api/webhooks/create.md)
* [Delete a Webhook](api/webhooks/delete.md)
Expand Down
154 changes: 154 additions & 0 deletions docs/api/_blueprint.json
Original file line number Diff line number Diff line change
Expand Up @@ -6568,6 +6568,83 @@
],
"workspaceScope": "required",
"codeSamples": []
},
{
"title": "Update an Unmanaged Access Grant",
"name": "update",
"path": "/access_grants/unmanaged/update",
"parentPath": "/access_grants/unmanaged",
"description": "Updates an unmanaged Access Grant to make it managed.\n\nThis endpoint can only be used to convert unmanaged access grants to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed access grants back to unmanaged.\n\nWhen converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": true,
"draftMessage": "Early access.",
"response": {
"responseType": "void",
"description": "OK"
},
"request": {
"methods": [
"PATCH",
"POST"
],
"semanticMethod": "PATCH",
"preferredMethod": "PATCH",
"parameters": [
{
"name": "access_grant_id",
"description": "ID of the unmanaged Access Grant to update.",
"isRequired": true,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "id",
"jsonType": "string"
},
{
"name": "access_grant_key",
"description": "Unique key for the access grant. If not provided, the existing key will be preserved.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "string",
"jsonType": "string"
},
{
"name": "is_managed",
"description": "Must be set to true to convert the unmanaged access grant to managed.",
"isRequired": true,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "boolean",
"jsonType": "boolean"
}
]
},
"hasPagination": false,
"authMethods": [
"personal_access_token",
"api_key",
"client_session_token"
],
"workspaceScope": "required",
"codeSamples": []
}
],
"parentPath": "/access_grants",
Expand Down Expand Up @@ -65637,6 +65714,83 @@
],
"workspaceScope": "required",
"codeSamples": []
},
{
"title": "Update an Unmanaged User Identity",
"name": "update",
"path": "/user_identities/unmanaged/update",
"parentPath": "/user_identities/unmanaged",
"description": "Updates an unmanaged [user identity](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) to make it managed.\n\nThis endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"response": {
"responseType": "void",
"description": "OK"
},
"request": {
"methods": [
"PATCH",
"POST"
],
"semanticMethod": "PATCH",
"preferredMethod": "PATCH",
"parameters": [
{
"name": "is_managed",
"description": "Must be set to true to convert the unmanaged user identity to managed.",
"isRequired": true,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "boolean",
"jsonType": "boolean"
},
{
"name": "user_identity_id",
"description": "ID of the unmanaged user identity that you want to update.",
"isRequired": true,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "id",
"jsonType": "string"
},
{
"name": "user_identity_key",
"description": "Unique key for the user identity. If not provided, the existing key will be preserved.",
"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",
Expand Down
3 changes: 3 additions & 0 deletions docs/api/_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,7 @@ These items have been marked as draft.
- `/access_grants/update`: Early access.
- `/access_grants/unmanaged/get`: Early access.
- `/access_grants/unmanaged/list`: Early access.
- `/access_grants/unmanaged/update`: Early access.
- `/access_methods/delete`: Early access.
- `/access_methods/get`: Early access.
- `/access_methods/get_related`: Early access.
Expand Down Expand Up @@ -610,6 +611,7 @@ These items are deprecated.
- `/access_grants/request_access_methods`
- `/access_grants/unmanaged/get`
- `/access_grants/unmanaged/list`
- `/access_grants/unmanaged/update`
- `/access_methods/encode`
- `/access_methods/get_related`
- `/access_methods/unmanaged/get`
Expand All @@ -627,6 +629,7 @@ These items are deprecated.
- `/spaces/get_related`
- `/user_identities/unmanaged/get`
- `/user_identities/unmanaged/list`
- `/user_identities/unmanaged/update`

### Resources without resource samples

Expand Down
5 changes: 5 additions & 0 deletions docs/api/access_grants/unmanaged/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,8 @@ Get an unmanaged Access Grant (where is_managed = false).
Gets unmanaged Access Grants (where is_managed = false).


[**`/access_grants/unmanaged/update`**](./update.md)

Updates an unmanaged Access Grant to make it managed.


49 changes: 49 additions & 0 deletions docs/api/access_grants/unmanaged/update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Update an Unmanaged Access Grant

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

Updates an unmanaged Access Grant to make it managed.

This endpoint can only be used to convert unmanaged access grants to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed access grants back to unmanaged.

When converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.


<details>

<summary>Authentication Methods</summary>

- API key
- Client session token
- 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

**`access_grant_id`** *String* (Required)

ID of the unmanaged Access Grant to update.

---

**`is_managed`** *Boolean* (Required)

Must be set to true to convert the unmanaged access grant to managed.

---

**`access_grant_key`** *String*

Unique key for the access grant. If not provided, the existing key will be preserved.

---


## Response

void

5 changes: 5 additions & 0 deletions docs/api/user_identities/unmanaged/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,8 @@ Returns a specified unmanaged [user identity](../../../capability-guides/mobile-
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).


[**`/user_identities/unmanaged/update`**](./update.md)

Updates an unmanaged [user identity](../../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) to make it managed.


47 changes: 47 additions & 0 deletions docs/api/user_identities/unmanaged/update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Update an Unmanaged User Identity

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

Updates an unmanaged [user identity](../../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) to make it managed.

This endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.


<details>

<summary>Authentication Methods</summary>

- API key
- Client session token
- 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

**`is_managed`** *Boolean* (Required)

Must be set to true to convert the unmanaged user identity to managed.

---

**`user_identity_id`** *String* (Required)

ID of the unmanaged user identity that you want to update.

---

**`user_identity_key`** *String*

Unique key for the user identity. If not provided, the existing key will be preserved.

---


## Response

void

8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"@prettier/plugin-ruby": "^4.0.4",
"@seamapi/blueprint": "^0.51.3",
"@seamapi/smith": "^0.5.2",
"@seamapi/types": "1.594.0",
"@seamapi/types": "1.595.0",
"@types/command-exists": "^1.2.3",
"change-case": "^5.4.4",
"command-exists": "^1.2.9",
Expand Down
Loading