LukeParke/api-specs
1
0
Fork 0
mirror of https://github.com/LukeHagar/api-specs.git synced 2025-12-09 12:27:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Automated commit 'Merge pull request #1636 from sailpoint/devrel-1469

Browse Source 
devrel-1469' by github action: 8662077694
This commit is contained in:
GitHub Action Bot
2024-04-12 12:31:55 +00:00
parent 0dee840bf7
commit 2e12377390
17 changed files with 61 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
idn/beta/paths/access-profile-bulk-delete.yaml
View File

@@ -4,17 +4,20 @@ post:
tags: tags:
- Access Profiles - Access Profiles
description: >- 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 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. be deleted.
A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this endpoint. In addition,
A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN can only use this endpoint to delete access profiles associated with sources they're able
a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able
to administer. to administer.
requestBody: requestBody:
required: true required: true

14
idn/beta/paths/role-bulk-delete.yaml
View File

@@ -1,15 +1,19 @@
post: post:
operationId: bulkDeleteRoles operationId: deleteBulkRoles
summary: Delete Role(s) summary: Delete Role(s)
tags: tags:
- Roles - Roles
description: >- 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 This endpoint can only bulk delete up to a limit of 50 roles per request.
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. 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: requestBody:
required: true required: true
content: content:

4
idn/beta/paths/sod-policies.yaml
View File

@@ -1,7 +1,7 @@
post: post:
operationId: createSodPolicy operationId: createSodPolicy
tags: tags:
- SOD Policy - SOD Policies
summary: Create SOD policy summary: Create SOD policy
deprecated: true deprecated: true
security: security:
@@ -233,7 +233,7 @@ post:
get: get:
operationId: listSodPolicies operationId: listSodPolicies
tags: tags:
- SOD Policy - SOD Policies
summary: List SOD policies summary: List SOD policies
deprecated: true deprecated: true
security: security:

8
idn/beta/paths/sod-policy.yaml
View File

@@ -1,7 +1,7 @@
get: get:
operationId: getSodPolicy operationId: getSodPolicy
tags: tags:
- SOD Policy - SOD Policies
summary: Get SOD policy by ID summary: Get SOD policy by ID
deprecated: true deprecated: true
security: security:
@@ -129,7 +129,7 @@ get:
put: put:
operationId: putSodPolicy operationId: putSodPolicy
tags: tags:
- SOD Policy - SOD Policies
summary: Update SOD policy by ID summary: Update SOD policy by ID
deprecated: true deprecated: true
security: security:
@@ -351,7 +351,7 @@ put:
delete: delete:
operationId: deleteSodPolicy operationId: deleteSodPolicy
tags: tags:
- SOD Policy - SOD Policies
summary: Delete SOD policy by ID summary: Delete SOD policy by ID
deprecated: true deprecated: true
security: security:
@@ -394,7 +394,7 @@ delete:
patch: patch:
operationId: patchSodPolicy operationId: patchSodPolicy
tags: tags:
- SOD Policy - SOD Policies
summary: Patch a SOD policy summary: Patch a SOD policy
deprecated: true deprecated: true
security: security:

2
idn/beta/paths/sod-report-run.yaml
View File

@@ -1,7 +1,7 @@
post: post:
operationId: startSodPolicy operationId: startSodPolicy
tags: tags:
- SOD Policy - SOD Policies
summary: Runs SOD policy violation report summary: Runs SOD policy violation report
deprecated: true deprecated: true
security: security:

6
idn/beta/paths/sod-schedule.yaml
View File

@@ -1,7 +1,7 @@
get: get:
operationId: getSodPolicySchedule operationId: getSodPolicySchedule
tags: tags:
- SOD Policy - SOD Policies
summary: Get SOD policy schedule summary: Get SOD policy schedule
deprecated: true deprecated: true
security: security:
@@ -38,7 +38,7 @@ get:
put: put:
operationId: putPolicySchedule operationId: putPolicySchedule
tags: tags:
- SOD Policy - SOD Policies
summary: Update SOD Policy schedule summary: Update SOD Policy schedule
deprecated: true deprecated: true
security: security:
@@ -81,7 +81,7 @@ put:
delete: delete:
operationId: deleteSodPolicySchedule operationId: deleteSodPolicySchedule
tags: tags:
- SOD Policy - SOD Policies
summary: Delete SOD policy schedule summary: Delete SOD policy schedule
deprecated: true deprecated: true
security: security:

2
idn/beta/paths/sod-violation-report.yaml
View File

@@ -1,7 +1,7 @@
get: get:
operationId: getSodViolationReportStatus operationId: getSodViolationReportStatus
tags: tags:
- SOD Policy - SOD Policies
summary: Get SOD violation report status summary: Get SOD violation report status
deprecated: true deprecated: true
security: security:

15
idn/v3/paths/access-profile-bulk-delete.yaml
View File

@@ -4,17 +4,20 @@ post:
tags: tags:
- Access Profiles - Access Profiles
description: >- 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 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. be deleted.
A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this endpoint. In addition,
A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN can only use this endpoint to delete access profiles associated with sources they're able
a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able
to administer. to administer.
requestBody: requestBody:
required: true required: true

4
idn/v3/paths/auth-user.yaml
View File

@@ -1,7 +1,7 @@
get: get:
operationId: getAuthUser operationId: getAuthUser
tags: tags:
- Auth User - Auth Users
summary: Auth User Details summary: Auth User Details
description: >- description: >-
Return the specified user's authentication system details. Return the specified user's authentication system details.
@@ -39,7 +39,7 @@ get:
patch: patch:
operationId: patchAuthUser operationId: patchAuthUser
tags: tags:
- Auth User - Auth Users
summary: Auth User Update summary: Auth User Update
description: >- description: >-
Use a PATCH request to update an existing user in the authentication system. Use a PATCH request to update an existing user in the authentication system.

12
idn/v3/paths/role-bulk-delete.yaml
View File

@@ -4,12 +4,16 @@ post:
tags: tags:
- Roles - Roles
description: >- 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 This endpoint can only bulk delete up to a limit of 50 roles per request.
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. 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: requestBody:
required: true required: true
content: content:

4
idn/v3/paths/sod-policies.yaml
View File

@@ -3,7 +3,7 @@ post:
- UserContextAuth: [idn:sod-policy:write] - UserContextAuth: [idn:sod-policy:write]
operationId: createSodPolicy operationId: createSodPolicy
tags: tags:
- SOD Policy - SOD Policies
summary: Create SOD policy summary: Create SOD policy
description: >- description: >-
This creates both General and Conflicting Access Based policy, with a limit This creates both General and Conflicting Access Based policy, with a limit
@@ -234,7 +234,7 @@ get:
- UserContextAuth: [idn:sod-policy:read] - UserContextAuth: [idn:sod-policy:read]
operationId: listSodPolicies operationId: listSodPolicies
tags: tags:
- SOD Policy - SOD Policies
summary: List SOD policies summary: List SOD policies
description: >- description: >-
This gets list of all SOD policies. This gets list of all SOD policies.

2
idn/v3/paths/sod-policy-evaluate.yaml
View File

@@ -3,7 +3,7 @@ post:
- UserContextAuth: [idn:sod-violation:write] - UserContextAuth: [idn:sod-violation:write]
operationId: startEvaluateSodPolicy operationId: startEvaluateSodPolicy
tags: tags:
- SOD Policy - SOD Policies
summary: Evaluate one policy by ID summary: Evaluate one policy by ID
description: >- description: >-
Runs the scheduled report for the policy retrieved by passed policy ID. Runs the scheduled report for the policy retrieved by passed policy ID.

8
idn/v3/paths/sod-policy.yaml
View File

@@ -3,7 +3,7 @@ get:
- UserContextAuth: [idn:sod-policy:read] - UserContextAuth: [idn:sod-policy:read]
operationId: getSodPolicy operationId: getSodPolicy
tags: tags:
- SOD Policy - SOD Policies
summary: Get SOD policy by ID summary: Get SOD policy by ID
description: >- description: >-
This gets specified SOD policy. This gets specified SOD policy.
@@ -130,7 +130,7 @@ put:
- UserContextAuth: [idn:sod-policy:write] - UserContextAuth: [idn:sod-policy:write]
operationId: putSodPolicy operationId: putSodPolicy
tags: tags:
- SOD Policy - SOD Policies
summary: Update SOD policy by ID summary: Update SOD policy by ID
description: >- description: >-
This updates a specified SOD policy. This updates a specified SOD policy.
@@ -342,7 +342,7 @@ delete:
- UserContextAuth: [idn:sod-policy:write] - UserContextAuth: [idn:sod-policy:write]
operationId: deleteSodPolicy operationId: deleteSodPolicy
tags: tags:
- SOD Policy - SOD Policies
summary: Delete SOD policy by ID summary: Delete SOD policy by ID
description: >- description: >-
This deletes a specified SOD policy. This deletes a specified SOD policy.
@@ -387,7 +387,7 @@ patch:
- UserContextAuth: [idn:sod-policy:write] - UserContextAuth: [idn:sod-policy:write]
operationId: patchSodPolicy operationId: patchSodPolicy
tags: tags:
- SOD Policy - SOD Policies
summary: Patch SOD policy by ID summary: Patch SOD policy by ID
description: >- description: >-
Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.

2
idn/v3/paths/sod-report-run.yaml
View File

@@ -3,7 +3,7 @@ post:
- UserContextAuth: [idn:sod-violation:write] - UserContextAuth: [idn:sod-violation:write]
operationId: startSodPolicy operationId: startSodPolicy
tags: tags:
- SOD Policy - SOD Policies
summary: Runs SOD policy violation report summary: Runs SOD policy violation report
description: >- description: >-
This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with

6
idn/v3/paths/sod-schedule.yaml
View File

@@ -3,7 +3,7 @@ get:
- UserContextAuth: [idn:sod-policy:read] - UserContextAuth: [idn:sod-policy:read]
operationId: getSodPolicySchedule operationId: getSodPolicySchedule
tags: tags:
- SOD Policy - SOD Policies
summary: Get SOD policy schedule summary: Get SOD policy schedule
description: >- description: >-
This endpoint gets a specified SOD policy's schedule. This endpoint gets a specified SOD policy's schedule.
@@ -37,7 +37,7 @@ put:
- UserContextAuth: [idn:sod-policy:write] - UserContextAuth: [idn:sod-policy:write]
operationId: putPolicySchedule operationId: putPolicySchedule
tags: tags:
- SOD Policy - SOD Policies
summary: Update SOD Policy schedule summary: Update SOD Policy schedule
description: >- description: >-
This updates schedule for a specified SOD policy. This updates schedule for a specified SOD policy.
@@ -77,7 +77,7 @@ delete:
- UserContextAuth: [idn:sod-policy:write] - UserContextAuth: [idn:sod-policy:write]
operationId: deleteSodPolicySchedule operationId: deleteSodPolicySchedule
tags: tags:
- SOD Policy - SOD Policies
summary: Delete SOD policy schedule summary: Delete SOD policy schedule
description: >- description: >-
This deletes schedule for a specified SOD policy by ID. This deletes schedule for a specified SOD policy by ID.

2
idn/v3/paths/sod-violation-report-status.yaml
View File

@@ -3,7 +3,7 @@ get:
- UserContextAuth: [idn:sod-violation:read] - UserContextAuth: [idn:sod-violation:read]
operationId: getSodViolationReportRunStatus operationId: getSodViolationReportRunStatus
tags: tags:
- SOD Policy - SOD Policies
summary: Get violation report run status summary: Get violation report run status
description: >- description: >-
This gets the status for a violation report run task that has already been invoked. This gets the status for a violation report run task that has already been invoked.

2
idn/v3/paths/sod-violation-report.yaml
View File

@@ -3,7 +3,7 @@ get:
- UserContextAuth: [idn:sod-violation:read] - UserContextAuth: [idn:sod-violation:read]
operationId: getSodViolationReportStatus operationId: getSodViolationReportStatus
tags: tags:
- SOD Policy - SOD Policies
summary: Get SOD violation report status summary: Get SOD violation report status
description: >- description: >-
This gets the status for a violation report run task that has already been invoked. This gets the status for a violation report run task that has already been invoked.