From d46d0bf57ef127ea448d84957ac5dc879d0c6743 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Fri, 13 Oct 2023 16:39:14 +0000 Subject: [PATCH] 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 --- idn/sailpoint-api.v3.yaml | 2 + idn/v3/paths/role-bulk-delete.yaml | 79 ++++++++++++++++++++++++++++++ 2 files changed, 81 insertions(+) create mode 100644 idn/v3/paths/role-bulk-delete.yaml diff --git a/idn/sailpoint-api.v3.yaml b/idn/sailpoint-api.v3.yaml index 64be5ff8..2b79c2b5 100644 --- a/idn/sailpoint-api.v3.yaml +++ b/idn/sailpoint-api.v3.yaml @@ -986,6 +986,8 @@ paths: $ref: './v3/paths/roles.yaml' /roles/{id}: $ref: './v3/paths/role.yaml' + /roles/bulk-delete: + $ref: './v3/paths/role-bulk-delete.yaml' /roles/{id}/assigned-identities: $ref: './v3/paths/role-assigned-identities.yaml' /saved-searches: diff --git a/idn/v3/paths/role-bulk-delete.yaml b/idn/v3/paths/role-bulk-delete.yaml new file mode 100644 index 00000000..a01cecb9 --- /dev/null +++ b/idn/v3/paths/role-bulk-delete.yaml @@ -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]