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

Automated commit 'Merge pull request #1224 from sailpoint/devrel-862

Browse Source 
devrel-862' by github action: 4639172567
This commit is contained in:
GitHub Action Bot
2023-04-07 15:05:42 +00:00
parent 82f50fd887
commit 1e16879d05
15 changed files with 64 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
idn/beta/paths/ears-entitlement.yaml
View File

@@ -2,9 +2,9 @@ get:
operationId: getEntitlement
tags:
- Entitlements
summary: Get an Entitlement
summary: Get an entitlement
description: >-
This API returns an Entitlement by its ID.
This API returns an entitlement by its ID.
security:
- oauth2: ['idn:entitlement:read']
parameters:
@@ -13,11 +13,11 @@ get:
schema:
type: string
required: true
description: Entitlement Id
description: The entitlement ID
example: 2c91808874ff91550175097daaec161c
responses:
'200':
description: An Entitlement
description: An entitlement
content:
application/json:
schema:
@@ -70,17 +70,17 @@ patch:
operationId: patchEntitlement
tags:
- Entitlements
summary: Patch a specified Entitlement
summary: Patch an entitlement
description: >-
This API updates an existing Entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable:
**requestable**, **privileged**, **segments**, **owner**.
When patching owner, only owner type and owner id need to be provided. Owner name is optional and it won't be
modified. If it is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be
modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.
@@ -89,7 +89,7 @@ patch:
parameters:
- name: id
in: path
description: ID of the Entitlement to patch
description: ID of the entitlement to patch
required: true
schema:
type: string
@@ -109,7 +109,7 @@ patch:
}
]
examples:
Make an Entitlement Requestable and Privileged in One Call:
Make an entitlement requestable and privileged in one call:
description: This example shows how multiple fields may be updated with a single patch call.
value:
[
@@ -125,10 +125,10 @@ patch:
}
]
Assign an Entitlement to a Segment:
Assign an entitlement to a segment:
description: >-
This example illustrates the use of patch to assign an Entitlement to a Segment by adding the Segment's ID to the
Entitlement's segments array.
This example shows how to use patch to assign an entitlement to a segment by adding the segment's ID to the
entitlement's segments array.
value:
[
{
@@ -137,9 +137,9 @@ patch:
"value": "f7b1b8a3-5fed-4fd4-ad29-82014e137e19"
}
]
Assign a owner to an entitlement:
Assign an owner to an entitlement:
description: >-
This example illustrates the use of patch to assign a owner to an entitlement by adding the owner's
This example shows how to use patch to assign an owner to an entitlement by adding the owner's
info to the entitlement.
value:
[
@@ -152,9 +152,9 @@ patch:
}
}
]
Replace a owner for an entitlement:
Replace an owner for an entitlement:
description: >-
This example illustrates the use of patch to replace a new owner to an entitlement by replacing the new
This example shows how to use patch to replace an entitlement's owner by replacing the
owner's info to the entitlement.
value:
[
@@ -169,7 +169,7 @@ patch:
]
responses:
'200':
description: Responds with the Entitlement as updated.
description: Responds with the entitlement as updated.
content:
application/json:
schema:

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

@@ -2,12 +2,12 @@ post:
operationId: runSodAllPoliciesForOrg
tags:
- SOD Policy
summary: Runs all policies for Org.
summary: Runs all policies for org
# security:
# - oauth2: [ORG_ADMIN]
description: >-
Runs multi policy report for the Org. If a policy reports more than 5000 violation, the report mentions Violation limit exceeded for that policy.
If the request is empty, report will run for all policies. Otherwise, report will run only for the filtered policy list provided.
Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy.
If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided.
Requires role of ORG_ADMIN.
requestBody:

4
idn/beta/paths/sod-all-report-status.yaml
View File

@@ -4,14 +4,14 @@ get:
- SOD Policy
summary: Get multi-report run task status
description: >-
This gets status for a violation report for all policy run.
This endpoint gets the status for a violation report for all policy run.
Requires role of ORG_ADMIN.
# security:
# - oauth2: [ORG_ADMIN]
responses:
'200':
description: Status of the violation report run task for all policy run
description: Status of the violation report run task for all policy run.
content:
application/json:
schema:

4
idn/beta/paths/sod-download-custom-report.yaml
View File

@@ -4,7 +4,7 @@ get:
- SOD Policy
summary: Download custom violation report
description: >-
This allows to download a specified named violation report for given report reference.
This allows to download a specified named violation report for a given report reference.
Requires role of ORG_ADMIN.
# security:
@@ -26,7 +26,7 @@ get:
example: custom-name
responses:
'200':
description: Returns zip file with given custom name that contains the violation report file
description: Returns the zip file with given custom name that contains the violation report file.
content:
application/zip:
schema:

4
idn/beta/paths/sod-download-default-report.yaml
View File

@@ -4,7 +4,7 @@ get:
- SOD Policy
summary: Download violation report
description: >-
This allows to download a violation report for given report reference.
This allows to download a violation report for a given report reference.
Requires role of ORG_ADMIN.
# security:
@@ -19,7 +19,7 @@ get:
example: ef38f94347e94562b5bb8424a56397d8
responses:
'200':
description: Returns PolicyReport.zip that contains the violation report file
description: Returns the PolicyReport.zip that contains the violation report file.
content:
application/zip:
schema:

10
idn/beta/paths/sod-exception.yaml
View File

@@ -2,7 +2,7 @@ get:
operationId: getSodExceptionById
tags:
- SOD Exception
summary: Get SOD Exception By ID
summary: Get SOD exception by ID
# security:
# - oauth2: [API]
description: >-
@@ -37,7 +37,7 @@ patch:
operationId: patchExceptionById
tags:
- SOD Exception
summary: Update SOD Exception
summary: Update SOD exception
# security:
# - oauth2: [API]
description: >-
@@ -56,7 +56,7 @@ patch:
requestBody:
required: true
description: |
A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
A list of SOD policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
The following fields are patchable:
* policyId
@@ -93,7 +93,7 @@ delete:
operationId: deleteSodExceptionById
tags:
- SOD Exception
summary: Delete SOD Exception by ID
summary: Delete SOD exception by ID
# security:
# - oauth2: [API]
description: >-
@@ -107,7 +107,7 @@ delete:
schema:
type: string
required: true
description: The ID of the SOD Exception to delete.
description: The ID of the SOD exception to delete.
example: ef38f94347e94562b5bb8424a56397d8
responses:
'204':

2
idn/beta/paths/sod-exceptions-bulk-create.yaml
View File

@@ -2,7 +2,7 @@ post:
operationId: bulkCreateSodExceptions
tags:
- SOD Exception
summary: Create SOD Exceptions in bulk
summary: Create SOD exceptions in bulk
# security:
# - oauth2: [API]
description: >-

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

@@ -2,7 +2,7 @@ post:
operationId: createSodException
tags:
- SOD Exception
summary: Create SOD Exception
summary: Create SOD exception
# security:
# - oauth2: [API]
description: >-
@@ -36,7 +36,7 @@ get:
operationId: listSodExceptions
tags:
- SOD Exception
summary: List SOD Exceptions
summary: List SOD exceptions
# security:
# - oauth2: [API]
description: >-

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

@@ -2,15 +2,15 @@ post:
operationId: createSodPolicy
tags:
- SOD Policy
summary: Create SOD Policy
summary: Create SOD policy
# security:
# - oauth2: [ORG_ADMIN]
description: >-
This creates both General and Conflicting Access Based policy, with a limit
of 50 entitlements for each (left & right) criteria for Conflicting Access
Based SOD policy
Based SOD policy.
Requires role of ORG_ADMIN
Requires role of ORG_ADMIN.
requestBody:
required: true
content:
@@ -233,11 +233,11 @@ get:
operationId: listSodPolicies
tags:
- SOD Policy
summary: List SOD Policies
summary: List SOD policies
# security:
# - oauth2: [ORG_ADMIN]
description: >-
This gets list of all SOD Policies.
This gets list of all SOD policies.
Requires role of ORG_ADMIN
parameters:
@@ -262,7 +262,7 @@ get:
required: false
responses:
"200":
description: List of all SOD Policies.
description: List of all SOD policies.
content:
application/json:
schema:

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

@@ -2,7 +2,7 @@ get:
operationId: getSodPolicy
tags:
- SOD Policy
summary: Get SOD Policy By ID
summary: Get SOD policy by ID
description: >-
This gets specified SOD policy.
@@ -129,7 +129,7 @@ put:
operationId: updateSodPolicy
tags:
- SOD Policy
summary: Update SOD Policy By ID
summary: Update SOD policy by ID
# security:
# - oauth2: [ORG_ADMIN]
description: >-
@@ -240,7 +240,7 @@ put:
}
responses:
'200':
description: SOD Policy by ID.
description: SOD Policy by ID
content:
application/json:
schema:
@@ -350,7 +350,7 @@ delete:
operationId: deleteSodPolicy
tags:
- SOD Policy
summary: Delete SOD Policy by ID
summary: Delete SOD policy by ID
# security:
# - oauth2: [ORG_ADMIN]
description: >-
@@ -370,7 +370,7 @@ delete:
schema:
type: boolean
default: true
description: whether this is soft delete i.e. logical true or hard delete
description: Indicates whether this is a soft delete (logical true) or a hard delete.
required: false
responses:
'204':
@@ -391,12 +391,14 @@ patch:
operationId: patchSodPolicy
tags:
- SOD Policy
summary: Update a SOD Policy
summary: Patch a SOD policy
description: >-
Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
Requires role of ORG_ADMIN.
This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception.
# security:
# - oauth2: [ORG_ADMIN]
@@ -406,7 +408,7 @@ patch:
schema:
type: string
required: true
description: The ID of the SOD Policy being modified.
description: The ID of the SOD policy being modified.
example: 2c9180835d191a86015d28455b4a2329
requestBody:
required: true

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

@@ -2,11 +2,11 @@ post:
operationId: runSodPolicy
tags:
- SOD Policy
summary: Runs SOD Policy Violation Report
summary: Runs SOD policy violation report
# security:
# - oauth2: [ORG_ADMIN]
description: >-
This invokes processing of violation report for given SOD Policy. If 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
violation limit exceeded message.
Requires role of ORG_ADMIN.
@@ -16,7 +16,7 @@ post:
schema:
type: string
required: true
description: The ID of the SOD Policy to run.
description: The SOD policy ID to run.
example: ef38f94347e94562b5bb8424a56397d8
responses:
'200':

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

@@ -2,11 +2,11 @@ get:
operationId: getSodPolicySchedule
tags:
- SOD Policy
summary: Get SOD Policy Schedule
summary: Get SOD policy schedule
description: >-
This gets schedule for a specified SOD policy.
This endpoint gets a specified SOD policy's schedule.
Requires a role of ORG_ADMIN
Requires the role of ORG_ADMIN.
# security:
# - oauth2: [ORG_ADMIN]
parameters:
@@ -44,7 +44,7 @@ put:
description: >-
This updates schedule for a specified SOD policy.
Requires role of ORG_ADMIN
Requires role of ORG_ADMIN.
parameters:
- in: path
name: id
@@ -61,7 +61,7 @@ put:
$ref: '../schemas/SodPolicySchedule.yaml'
responses:
'200':
description: SOD Policy by ID.
description: SOD policy by ID.
content:
application/json:
schema:
@@ -80,7 +80,7 @@ delete:
operationId: deleteSodPolicySchedule
tags:
- SOD Policy
summary: Delete SOD Policy Schedule
summary: Delete SOD policy schedule
# security:
# - oauth2: [ORG_ADMIN]
description: >-
@@ -93,7 +93,7 @@ delete:
schema:
type: string
required: true
description: The ID of the SOD Policy for which the schedule needs to be deleted.
description: The ID of the SOD policy the schedule must be deleted for.
example: ef38f94347e94562b5bb8424a56397d8
responses:
'204':

4
idn/beta/paths/sod-violation-check.yaml
View File

@@ -2,7 +2,7 @@ post:
operationId: violationCheck
tags:
- SOD Policy
summary: Check SOD Violations
summary: Check SOD violations
description: >-
This API initiates a SOD policy verification asynchronously.
@@ -38,7 +38,7 @@ post:
}
responses:
'202':
description: Request id with a timestamp
description: Request ID with a timestamp.
content:
application/json:
schema:

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

@@ -4,7 +4,7 @@ get:
- SOD Policy
summary: Get violation report run status
description: >-
This gets status for a violation report run task invoked already.
This gets the status for a violation report run task that has already been invoked.
Requires role of ORG_ADMIN.
# security:

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

@@ -4,7 +4,7 @@ get:
- SOD Policy
summary: Get SOD violation report status
description: >-
This gets status for a violation report run task invoked already.
This gets the status for a violation report run task that has already been invoked.
Requires role of ORG_ADMIN.
# security: