-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Automated commit 'IDNLANAI-8700: Promote /roles/bulk-delete endpoint …
…from /beta to /v3 (#1445) * IDNLANAI-8700: Promote /roles/bulk-delete endpoint from /beta to /v3 * IDNLANAI-8700: Promote /roles/bulk-delete endpoint from /beta to /v3 * IDNLANAI-8700: Promote /roles/bulk-delete endpoint from /beta to /v3' by github action: 6510812318
- Loading branch information
1 parent
5b52d69
commit d46d0bf
Showing
2 changed files
with
81 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
post: | ||
operationId: deleteBulkRoles | ||
summary: Delete Role(s) | ||
tags: | ||
- Roles | ||
description: >- | ||
This API initiates a bulk deletion of one or more Roles. | ||
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a | ||
token with ROLE_SUBADMIN authority may only call this API if all Roles included in the request are associated | ||
to Sources with management workgroups of which the ROLE_SUBADMIN is a member. | ||
requestBody: | ||
required: true | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '../../v3/schemas/access/RoleBulkDeleteRequest.yaml' | ||
example: | ||
{ | ||
"roleIds": [ "2c91808876438bb2017668b91919ecca","2c91808876438ba801766e129f151816" ] | ||
} | ||
responses: | ||
'202': | ||
description: Returns an object with the id of the task performing the delete operation. | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '../../v3/schemas/BaseReferenceDto.yaml' | ||
example: | ||
{ | ||
"type": "TASK_RESULT", | ||
"id": "464ae7bf791e49fdb74606a2e4a89635", | ||
"name": null | ||
} | ||
'400': | ||
description: Client Error - Returned if the request body is invalid. | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '../../v3/schemas/ErrorResponseDto.yaml' | ||
examples: | ||
400.1 Bad Request Content: | ||
description: Response for bad request content | ||
value: | ||
detailCode: 400.1 Bad Request Content | ||
trackingId: 1ea1adcb84da4dcb890145e05745774e | ||
messages: | ||
- locale: en-US | ||
localeOrigin: DEFAULT | ||
text: The request was syntactically correct but its content is semantically invalid. | ||
400.1 Role ids limit violation: | ||
description: Role ids limit violation response | ||
value: | ||
detailCode: 400.1 Bad Request Content | ||
trackingId: 77aa89ac6f0e422dbc588866abc22be9 | ||
messages: | ||
- locale: en-US | ||
localeOrigin: DEFAULT | ||
text: roleIds count exceeded max limit of 50 for bulk-delete. | ||
400.1.404 Referenced object not found: | ||
description: Referenced object not found response | ||
value: | ||
detailCode: 400.1.404 Referenced object not found | ||
trackingId: 77aa89ac6f0e422dbc588866abc22be9 | ||
messages: | ||
- locale: en-US | ||
localeOrigin: DEFAULT | ||
text: Referenced roleIds ["2c91808876438bb2017668b91919ecca"] was not found. | ||
'401': | ||
$ref: '../../v3/responses/401.yaml' | ||
'403': | ||
$ref: '../../v3/responses/403.yaml' | ||
'429': | ||
$ref: '../../v3/responses/429.yaml' | ||
'500': | ||
$ref: '../../v3/responses/500.yaml' | ||
security: | ||
- UserContextAuth: [idn:role-unchecked:manage, idn:role-checked:manage] |