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
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@
* [Access Control Systems (ACS)](api/acs/README.md)
* [Access Groups](api/acs/access_groups/README.md)
* [Add an ACS User to an Access Group](api/acs/access_groups/add_user.md)
* [Delete an Access Group](api/acs/access_groups/delete.md)
* [Get an Access Group](api/acs/access_groups/get.md)
* [List Access Groups](api/acs/access_groups/list.md)
* [List ACS Users in an Access Group](api/acs/access_groups/list_users.md)
Expand Down
69 changes: 69 additions & 0 deletions docs/api/_blueprint.json
Original file line number Diff line number Diff line change
Expand Up @@ -8008,6 +8008,55 @@
}
]
},
{
"title": "Delete an Access Group",
"name": "delete",
"path": "/acs/access_groups/delete",
"parentPath": "/acs/access_groups",
"description": "Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"response": {
"responseType": "void",
"description": "OK"
},
"request": {
"methods": [
"DELETE",
"POST"
],
"semanticMethod": "DELETE",
"preferredMethod": "POST",
"parameters": [
{
"name": "acs_access_group_id",
"description": "ID of the access group that you want to delete.",
"isRequired": true,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "id",
"jsonType": "string"
}
]
},
"hasPagination": false,
"authMethods": [
"client_session_token",
"personal_access_token",
"api_key"
],
"workspaceScope": "required",
"codeSamples": []
},
{
"title": "Get an Access Group",
"name": "get",
Expand Down Expand Up @@ -81739,6 +81788,16 @@
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "being_deleted",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
}
]
}
Expand Down Expand Up @@ -109967,6 +110026,16 @@
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "being_deleted",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
}
]
}
Expand Down
1 change: 1 addition & 0 deletions docs/api/_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -686,6 +686,7 @@ These items are deprecated.
- `/access_methods/get_related`
- `/access_methods/unmanaged/get`
- `/access_methods/unmanaged/list`
- `/acs/access_groups/delete`
- `/connected_accounts/simulate/disconnect`
- `/customers/create_portal`
- `/customers/delete_data`
Expand Down
6 changes: 6 additions & 0 deletions docs/api/acs/access_groups/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ Warnings associated with the `acs_access_group`.
<summary>Enum values:</summary>

- <code>unknown_issue_with_acs_access_group</code>
- <code>being_deleted</code>
</details>

</details>
Expand Down Expand Up @@ -256,6 +257,11 @@ An ACS access group was deleted.
Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).


[**`/acs/access_groups/delete`**](./delete.md)

Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).


[**`/acs/access_groups/get`**](./get.md)

Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
Expand Down
37 changes: 37 additions & 0 deletions docs/api/acs/access_groups/delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Delete an Access Group

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

Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).


<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

**`acs_access_group_id`** *String* (Required)

ID of the access group that you want to delete.

---


## Response

{% hint style="success" %}
Returns:
**void**

{% endhint %}

Loading
Loading