diff --git a/idn/beta/paths/access-profile-bulk-delete.yaml b/idn/beta/paths/access-profile-bulk-delete.yaml index eef2a57..739bfc7 100644 --- a/idn/beta/paths/access-profile-bulk-delete.yaml +++ b/idn/beta/paths/access-profile-bulk-delete.yaml @@ -4,17 +4,20 @@ post: tags: - Access Profiles description: >- - This API initiates a bulk deletion of one or more Access Profiles. + This endpoint initiates a bulk deletion of one or more access profiles. + When the request is successful, the endpoint returns the bulk delete's task result ID. + To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. - By default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse** + This endpoint can only bulk delete up to a limit of 50 access profiles per request. + + By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is - **true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will + **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. - - A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, - a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able + A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this endpoint. In addition, + a SOURCE_SUBADMIN can only use this endpoint to delete access profiles associated with sources they're able to administer. requestBody: required: true diff --git a/idn/beta/paths/role-bulk-delete.yaml b/idn/beta/paths/role-bulk-delete.yaml index 8aa487b..c134ca6 100644 --- a/idn/beta/paths/role-bulk-delete.yaml +++ b/idn/beta/paths/role-bulk-delete.yaml @@ -1,15 +1,19 @@ post: - operationId: bulkDeleteRoles + operationId: deleteBulkRoles summary: Delete Role(s) tags: - Roles description: >- - This API initiates a bulk deletion of one or more Roles. + This endpoint initiates a bulk deletion of one or more roles. + When the request is successful, the endpoint returns the bulk delete's task result ID. + To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. - 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. + This endpoint can only bulk delete up to a limit of 50 roles per request. + + A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a + token with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated + with sources with management workgroups the ROLE_SUBADMIN is a member of. requestBody: required: true content: diff --git a/idn/beta/paths/sod-policies.yaml b/idn/beta/paths/sod-policies.yaml index af2c533..5860654 100644 --- a/idn/beta/paths/sod-policies.yaml +++ b/idn/beta/paths/sod-policies.yaml @@ -1,7 +1,7 @@ post: operationId: createSodPolicy tags: - - SOD Policy + - SOD Policies summary: Create SOD policy deprecated: true security: @@ -233,7 +233,7 @@ post: get: operationId: listSodPolicies tags: - - SOD Policy + - SOD Policies summary: List SOD policies deprecated: true security: diff --git a/idn/beta/paths/sod-policy.yaml b/idn/beta/paths/sod-policy.yaml index 71b7ce6..2c1dece 100644 --- a/idn/beta/paths/sod-policy.yaml +++ b/idn/beta/paths/sod-policy.yaml @@ -1,7 +1,7 @@ get: operationId: getSodPolicy tags: - - SOD Policy + - SOD Policies summary: Get SOD policy by ID deprecated: true security: @@ -129,7 +129,7 @@ get: put: operationId: putSodPolicy tags: - - SOD Policy + - SOD Policies summary: Update SOD policy by ID deprecated: true security: @@ -351,7 +351,7 @@ put: delete: operationId: deleteSodPolicy tags: - - SOD Policy + - SOD Policies summary: Delete SOD policy by ID deprecated: true security: @@ -394,7 +394,7 @@ delete: patch: operationId: patchSodPolicy tags: - - SOD Policy + - SOD Policies summary: Patch a SOD policy deprecated: true security: diff --git a/idn/beta/paths/sod-report-run.yaml b/idn/beta/paths/sod-report-run.yaml index 359fa6e..56d5d45 100644 --- a/idn/beta/paths/sod-report-run.yaml +++ b/idn/beta/paths/sod-report-run.yaml @@ -1,7 +1,7 @@ post: operationId: startSodPolicy tags: - - SOD Policy + - SOD Policies summary: Runs SOD policy violation report deprecated: true security: diff --git a/idn/beta/paths/sod-schedule.yaml b/idn/beta/paths/sod-schedule.yaml index c6d6922..208de0e 100644 --- a/idn/beta/paths/sod-schedule.yaml +++ b/idn/beta/paths/sod-schedule.yaml @@ -1,7 +1,7 @@ get: operationId: getSodPolicySchedule tags: - - SOD Policy + - SOD Policies summary: Get SOD policy schedule deprecated: true security: @@ -38,7 +38,7 @@ get: put: operationId: putPolicySchedule tags: - - SOD Policy + - SOD Policies summary: Update SOD Policy schedule deprecated: true security: @@ -81,7 +81,7 @@ put: delete: operationId: deleteSodPolicySchedule tags: - - SOD Policy + - SOD Policies summary: Delete SOD policy schedule deprecated: true security: diff --git a/idn/beta/paths/sod-violation-report.yaml b/idn/beta/paths/sod-violation-report.yaml index 566ddba..7ac2c9d 100644 --- a/idn/beta/paths/sod-violation-report.yaml +++ b/idn/beta/paths/sod-violation-report.yaml @@ -1,7 +1,7 @@ get: operationId: getSodViolationReportStatus tags: - - SOD Policy + - SOD Policies summary: Get SOD violation report status deprecated: true security: diff --git a/idn/v3/paths/access-profile-bulk-delete.yaml b/idn/v3/paths/access-profile-bulk-delete.yaml index eef2a57..739bfc7 100644 --- a/idn/v3/paths/access-profile-bulk-delete.yaml +++ b/idn/v3/paths/access-profile-bulk-delete.yaml @@ -4,17 +4,20 @@ post: tags: - Access Profiles description: >- - This API initiates a bulk deletion of one or more Access Profiles. + This endpoint initiates a bulk deletion of one or more access profiles. + When the request is successful, the endpoint returns the bulk delete's task result ID. + To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. - By default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse** + This endpoint can only bulk delete up to a limit of 50 access profiles per request. + + By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is - **true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will + **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. - - A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, - a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able + A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this endpoint. In addition, + a SOURCE_SUBADMIN can only use this endpoint to delete access profiles associated with sources they're able to administer. requestBody: required: true diff --git a/idn/v3/paths/auth-user.yaml b/idn/v3/paths/auth-user.yaml index 4e5ceb6..f9a39c0 100644 --- a/idn/v3/paths/auth-user.yaml +++ b/idn/v3/paths/auth-user.yaml @@ -1,7 +1,7 @@ get: operationId: getAuthUser tags: - - Auth User + - Auth Users summary: Auth User Details description: >- Return the specified user's authentication system details. @@ -39,7 +39,7 @@ get: patch: operationId: patchAuthUser tags: - - Auth User + - Auth Users summary: Auth User Update description: >- Use a PATCH request to update an existing user in the authentication system. diff --git a/idn/v3/paths/role-bulk-delete.yaml b/idn/v3/paths/role-bulk-delete.yaml index 54db24e..c134ca6 100644 --- a/idn/v3/paths/role-bulk-delete.yaml +++ b/idn/v3/paths/role-bulk-delete.yaml @@ -4,12 +4,16 @@ post: tags: - Roles description: >- - This API initiates a bulk deletion of one or more Roles. + This endpoint initiates a bulk deletion of one or more roles. + When the request is successful, the endpoint returns the bulk delete's task result ID. + To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. - 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. + This endpoint can only bulk delete up to a limit of 50 roles per request. + + A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a + token with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated + with sources with management workgroups the ROLE_SUBADMIN is a member of. requestBody: required: true content: diff --git a/idn/v3/paths/sod-policies.yaml b/idn/v3/paths/sod-policies.yaml index edf6aec..1c66723 100644 --- a/idn/v3/paths/sod-policies.yaml +++ b/idn/v3/paths/sod-policies.yaml @@ -3,7 +3,7 @@ post: - UserContextAuth: [idn:sod-policy:write] operationId: createSodPolicy tags: - - SOD Policy + - SOD Policies summary: Create SOD policy description: >- This creates both General and Conflicting Access Based policy, with a limit @@ -234,7 +234,7 @@ get: - UserContextAuth: [idn:sod-policy:read] operationId: listSodPolicies tags: - - SOD Policy + - SOD Policies summary: List SOD policies description: >- This gets list of all SOD policies. diff --git a/idn/v3/paths/sod-policy-evaluate.yaml b/idn/v3/paths/sod-policy-evaluate.yaml index d916130..6a9bb00 100644 --- a/idn/v3/paths/sod-policy-evaluate.yaml +++ b/idn/v3/paths/sod-policy-evaluate.yaml @@ -3,7 +3,7 @@ post: - UserContextAuth: [idn:sod-violation:write] operationId: startEvaluateSodPolicy tags: - - SOD Policy + - SOD Policies summary: Evaluate one policy by ID description: >- Runs the scheduled report for the policy retrieved by passed policy ID. diff --git a/idn/v3/paths/sod-policy.yaml b/idn/v3/paths/sod-policy.yaml index 17eaa46..c9a3659 100644 --- a/idn/v3/paths/sod-policy.yaml +++ b/idn/v3/paths/sod-policy.yaml @@ -3,7 +3,7 @@ get: - UserContextAuth: [idn:sod-policy:read] operationId: getSodPolicy tags: - - SOD Policy + - SOD Policies summary: Get SOD policy by ID description: >- This gets specified SOD policy. @@ -130,7 +130,7 @@ put: - UserContextAuth: [idn:sod-policy:write] operationId: putSodPolicy tags: - - SOD Policy + - SOD Policies summary: Update SOD policy by ID description: >- This updates a specified SOD policy. @@ -342,7 +342,7 @@ delete: - UserContextAuth: [idn:sod-policy:write] operationId: deleteSodPolicy tags: - - SOD Policy + - SOD Policies summary: Delete SOD policy by ID description: >- This deletes a specified SOD policy. @@ -387,7 +387,7 @@ patch: - UserContextAuth: [idn:sod-policy:write] operationId: patchSodPolicy tags: - - SOD Policy + - SOD Policies summary: Patch SOD policy by ID description: >- Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. diff --git a/idn/v3/paths/sod-report-run.yaml b/idn/v3/paths/sod-report-run.yaml index cfc5028..c07b721 100644 --- a/idn/v3/paths/sod-report-run.yaml +++ b/idn/v3/paths/sod-report-run.yaml @@ -3,7 +3,7 @@ post: - UserContextAuth: [idn:sod-violation:write] operationId: startSodPolicy tags: - - SOD Policy + - SOD Policies summary: Runs SOD policy violation report description: >- This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with diff --git a/idn/v3/paths/sod-schedule.yaml b/idn/v3/paths/sod-schedule.yaml index e6d2f4d..be61cbc 100644 --- a/idn/v3/paths/sod-schedule.yaml +++ b/idn/v3/paths/sod-schedule.yaml @@ -3,7 +3,7 @@ get: - UserContextAuth: [idn:sod-policy:read] operationId: getSodPolicySchedule tags: - - SOD Policy + - SOD Policies summary: Get SOD policy schedule description: >- This endpoint gets a specified SOD policy's schedule. @@ -37,7 +37,7 @@ put: - UserContextAuth: [idn:sod-policy:write] operationId: putPolicySchedule tags: - - SOD Policy + - SOD Policies summary: Update SOD Policy schedule description: >- This updates schedule for a specified SOD policy. @@ -77,7 +77,7 @@ delete: - UserContextAuth: [idn:sod-policy:write] operationId: deleteSodPolicySchedule tags: - - SOD Policy + - SOD Policies summary: Delete SOD policy schedule description: >- This deletes schedule for a specified SOD policy by ID. diff --git a/idn/v3/paths/sod-violation-report-status.yaml b/idn/v3/paths/sod-violation-report-status.yaml index 1e59566..cc08dbe 100644 --- a/idn/v3/paths/sod-violation-report-status.yaml +++ b/idn/v3/paths/sod-violation-report-status.yaml @@ -3,7 +3,7 @@ get: - UserContextAuth: [idn:sod-violation:read] operationId: getSodViolationReportRunStatus tags: - - SOD Policy + - SOD Policies summary: Get violation report run status description: >- This gets the status for a violation report run task that has already been invoked. diff --git a/idn/v3/paths/sod-violation-report.yaml b/idn/v3/paths/sod-violation-report.yaml index 6f0d391..88df53b 100644 --- a/idn/v3/paths/sod-violation-report.yaml +++ b/idn/v3/paths/sod-violation-report.yaml @@ -3,7 +3,7 @@ get: - UserContextAuth: [idn:sod-violation:read] operationId: getSodViolationReportStatus tags: - - SOD Policy + - SOD Policies summary: Get SOD violation report status description: >- This gets the status for a violation report run task that has already been invoked.