From 8c04ddb6f79403815672fe13096683b9872fdb75 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Tue, 26 Nov 2024 21:32:14 +0000 Subject: [PATCH] Automated commit 'IDNPALM-5470: Add detail to metadata's API document (#1895) * IDNPALM-5470: Add detail * IDNPALM-5470: linter check * IDNPALM-5470: Add x-sailpoint-userLevels' by github action: 12039374164 --- idn/sailpoint-api.v2024.yaml | 2 ++ .../role-bulk-update-status.yaml | 14 +++++----- .../role-id-access-model-metadata.yaml | 1 + .../RoleGetAllBulkUpdateResponse.yaml | 27 +++++++++++++++++++ ...RoleMetadataBulkUpdateByFilterRequest.yaml | 8 +++--- .../RoleMetadataBulkUpdateByIdRequest.yaml | 8 +++--- .../RoleMetadataBulkUpdateByQueryRequest.yaml | 8 +++--- 7 files changed, 50 insertions(+), 18 deletions(-) create mode 100644 idn/v2024/schemas/role-metadata/RoleGetAllBulkUpdateResponse.yaml diff --git a/idn/sailpoint-api.v2024.yaml b/idn/sailpoint-api.v2024.yaml index a63e3ad9..8e9e741b 100644 --- a/idn/sailpoint-api.v2024.yaml +++ b/idn/sailpoint-api.v2024.yaml @@ -2266,6 +2266,8 @@ components: $ref: ./v3/schemas/BrandingItemCreate.yaml RoleBulkUpdateResponse: $ref: "./v2024/schemas/role-metadata/RoleBulkUpdateResponse.yaml" + RoleGetAllBulkUpdateResponse: + $ref: "./v2024/schemas/role-metadata/RoleGetAllBulkUpdateResponse.yaml" RoleListFilterDTO: $ref: "./v2024/schemas/role-metadata/RoleListFilterDTO.yaml" RoleMetadataBulkUpdateByFilterRequest: diff --git a/idn/v2024/paths/role-access-model-metadata/role-bulk-update-status.yaml b/idn/v2024/paths/role-access-model-metadata/role-bulk-update-status.yaml index 7bc6be05..4dd72f1a 100644 --- a/idn/v2024/paths/role-access-model-metadata/role-bulk-update-status.yaml +++ b/idn/v2024/paths/role-access-model-metadata/role-bulk-update-status.yaml @@ -2,23 +2,25 @@ get: operationId: getBulkUpdateStatus summary: Get Bulk-Update Statuses description: >- - This API returns a list of all bulk update process status of the tenant. - - A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + This API returns a list of all unfinished bulk update process status of the tenant. + x-sailpoint-userLevels: + - ORG_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN security: - - UserContextAuth: [ idn:role:update, idn:role-checked:update ] + - userAuth: [ idn:role:update, idn:role-checked:update ] tags: - Roles responses: '200': - description: successfully get the status of all bulk updates. + description: successfully get the status of all unfinished bulk updates request. content: application/json: schema: type: array items: - $ref: '../../schemas/role-metadata/RoleBulkUpdateResponse.yaml' + $ref: '../../schemas/role-metadata/RoleGetAllBulkUpdateResponse.yaml' '400': $ref: '../../../v3/responses/400.yaml' diff --git a/idn/v2024/paths/role-access-model-metadata/role-id-access-model-metadata.yaml b/idn/v2024/paths/role-access-model-metadata/role-id-access-model-metadata.yaml index e094c694..305fb672 100644 --- a/idn/v2024/paths/role-access-model-metadata/role-id-access-model-metadata.yaml +++ b/idn/v2024/paths/role-access-model-metadata/role-id-access-model-metadata.yaml @@ -4,6 +4,7 @@ post: description: This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. tags: - Roles diff --git a/idn/v2024/schemas/role-metadata/RoleGetAllBulkUpdateResponse.yaml b/idn/v2024/schemas/role-metadata/RoleGetAllBulkUpdateResponse.yaml new file mode 100644 index 00000000..94a14d5d --- /dev/null +++ b/idn/v2024/schemas/role-metadata/RoleGetAllBulkUpdateResponse.yaml @@ -0,0 +1,27 @@ +type: object +properties: + id: + type: string + description: ID of the task which is executing the bulk update. This also used + in to the bulk-update/** API to track status. + example: 2c9180867817ac4d017817c491119a20 + type: + type: string + description: Type of the bulk update object. + example: Role + status: + type: string + description: The status of the bulk update request, only list unfinished request's status, the status could also checked by + getBulkUpdateStatus API + enum: + - CREATED + - PRE_PROCESS + - POST_PROCESS + - CHUNK_PENDING + - CHUNK_PROCESSING + example: CREATED + created: + type: string + description: Time when the bulk update request was created + format: date-time + example: 2020-10-08T18:33:52.029Z \ No newline at end of file diff --git a/idn/v2024/schemas/role-metadata/RoleMetadataBulkUpdateByFilterRequest.yaml b/idn/v2024/schemas/role-metadata/RoleMetadataBulkUpdateByFilterRequest.yaml index 26ba4e14..50a4b3ed 100644 --- a/idn/v2024/schemas/role-metadata/RoleMetadataBulkUpdateByFilterRequest.yaml +++ b/idn/v2024/schemas/role-metadata/RoleMetadataBulkUpdateByFilterRequest.yaml @@ -32,10 +32,10 @@ properties: description: The operation to be performed type: string enum: - - "add" - - "remove" - - "replace" - example: "replace" + - "ADD" + - "REMOVE" + - "REPLACE" + example: "REPLACE" replaceScope: description: The choice of update scope. type: string diff --git a/idn/v2024/schemas/role-metadata/RoleMetadataBulkUpdateByIdRequest.yaml b/idn/v2024/schemas/role-metadata/RoleMetadataBulkUpdateByIdRequest.yaml index 0aaf1705..533adfb9 100644 --- a/idn/v2024/schemas/role-metadata/RoleMetadataBulkUpdateByIdRequest.yaml +++ b/idn/v2024/schemas/role-metadata/RoleMetadataBulkUpdateByIdRequest.yaml @@ -17,10 +17,10 @@ properties: description: The operation to be performed type: string enum: - - "add" - - "remove" - - "replace" - example: "replace" + - "ADD" + - "REMOVE" + - "REPLACE" + example: "REPLACE" replaceScope: description: The choice of update scope. type: string diff --git a/idn/v2024/schemas/role-metadata/RoleMetadataBulkUpdateByQueryRequest.yaml b/idn/v2024/schemas/role-metadata/RoleMetadataBulkUpdateByQueryRequest.yaml index 1522b84e..1f115f52 100644 --- a/idn/v2024/schemas/role-metadata/RoleMetadataBulkUpdateByQueryRequest.yaml +++ b/idn/v2024/schemas/role-metadata/RoleMetadataBulkUpdateByQueryRequest.yaml @@ -34,10 +34,10 @@ properties: description: The operation to be performed type: string enum: - - "add" - - "remove" - - "replace" - example: "replace" + - "ADD" + - "REMOVE" + - "REPLACE" + example: "REPLACE" replaceScope: description: The choice of update scope. type: string