Skip to content

Commit b0cca5a

Browse files
committed
ci: Generate docs
1 parent f03109e commit b0cca5a

File tree

6 files changed

+245
-77
lines changed

6 files changed

+245
-77
lines changed

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,7 @@
188188
* [Access Control Systems (ACS)](api/acs/README.md)
189189
* [Access Groups](api/acs/access_groups/README.md)
190190
* [Add an ACS User to an Access Group](api/acs/access_groups/add_user.md)
191+
* [Delete an Access Group](api/acs/access_groups/delete.md)
191192
* [Get an Access Group](api/acs/access_groups/get.md)
192193
* [List Access Groups](api/acs/access_groups/list.md)
193194
* [List ACS Users in an Access Group](api/acs/access_groups/list_users.md)

docs/api/_blueprint.json

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8008,6 +8008,55 @@
80088008
}
80098009
]
80108010
},
8011+
{
8012+
"title": "Delete an Access Group",
8013+
"name": "delete",
8014+
"path": "/acs/access_groups/delete",
8015+
"parentPath": "/acs/access_groups",
8016+
"description": "Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
8017+
"isDeprecated": false,
8018+
"deprecationMessage": "",
8019+
"isUndocumented": false,
8020+
"undocumentedMessage": "",
8021+
"isDraft": false,
8022+
"draftMessage": "",
8023+
"response": {
8024+
"responseType": "void",
8025+
"description": "OK"
8026+
},
8027+
"request": {
8028+
"methods": [
8029+
"DELETE",
8030+
"POST"
8031+
],
8032+
"semanticMethod": "DELETE",
8033+
"preferredMethod": "POST",
8034+
"parameters": [
8035+
{
8036+
"name": "acs_access_group_id",
8037+
"description": "ID of the access group that you want to delete.",
8038+
"isRequired": true,
8039+
"isDeprecated": false,
8040+
"deprecationMessage": "",
8041+
"isUndocumented": false,
8042+
"undocumentedMessage": "",
8043+
"isDraft": false,
8044+
"draftMessage": "",
8045+
"hasDefault": false,
8046+
"format": "id",
8047+
"jsonType": "string"
8048+
}
8049+
]
8050+
},
8051+
"hasPagination": false,
8052+
"authMethods": [
8053+
"client_session_token",
8054+
"personal_access_token",
8055+
"api_key"
8056+
],
8057+
"workspaceScope": "required",
8058+
"codeSamples": []
8059+
},
80118060
{
80128061
"title": "Get an Access Group",
80138062
"name": "get",
@@ -81739,6 +81788,16 @@
8173981788
"undocumentedMessage": "",
8174081789
"isDraft": false,
8174181790
"draftMessage": ""
81791+
},
81792+
{
81793+
"name": "being_deleted",
81794+
"description": "",
81795+
"isDeprecated": false,
81796+
"deprecationMessage": "",
81797+
"isUndocumented": false,
81798+
"undocumentedMessage": "",
81799+
"isDraft": false,
81800+
"draftMessage": ""
8174281801
}
8174381802
]
8174481803
}
@@ -109967,6 +110026,16 @@
109967110026
"undocumentedMessage": "",
109968110027
"isDraft": false,
109969110028
"draftMessage": ""
110029+
},
110030+
{
110031+
"name": "being_deleted",
110032+
"description": "",
110033+
"isDeprecated": false,
110034+
"deprecationMessage": "",
110035+
"isUndocumented": false,
110036+
"undocumentedMessage": "",
110037+
"isDraft": false,
110038+
"draftMessage": ""
109970110039
}
109971110040
]
109972110041
}

docs/api/_report.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -686,6 +686,7 @@ These items are deprecated.
686686
- `/access_methods/get_related`
687687
- `/access_methods/unmanaged/get`
688688
- `/access_methods/unmanaged/list`
689+
- `/acs/access_groups/delete`
689690
- `/connected_accounts/simulate/disconnect`
690691
- `/customers/create_portal`
691692
- `/customers/delete_data`

docs/api/acs/access_groups/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@ Warnings associated with the `acs_access_group`.
187187
<summary>Enum values:</summary>
188188

189189
- <code>unknown_issue_with_acs_access_group</code>
190+
- <code>being_deleted</code>
190191
</details>
191192

192193
</details>
@@ -256,6 +257,11 @@ An ACS access group was deleted.
256257
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).
257258

258259

260+
[**`/acs/access_groups/delete`**](./delete.md)
261+
262+
Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
263+
264+
259265
[**`/acs/access_groups/get`**](./get.md)
260266

261267
Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Delete an Access Group
2+
3+
- [Request Parameters](#request-parameters)
4+
- [Response](#response)
5+
6+
Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
7+
8+
9+
<details>
10+
11+
<summary>Authentication Methods</summary>
12+
13+
- API key
14+
- Client session token
15+
- Personal access token
16+
<br>Must also include the `seam-workspace` header in the request.
17+
18+
To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
19+
</details>
20+
21+
## Request Parameters
22+
23+
**`acs_access_group_id`** *String* (Required)
24+
25+
ID of the access group that you want to delete.
26+
27+
---
28+
29+
30+
## Response
31+
32+
{% hint style="success" %}
33+
Returns:
34+
**void**
35+
36+
{% endhint %}
37+

0 commit comments

Comments
 (0)