From 00cba5f9bec1326dad5bc57875ace5b2ece149a9 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot <tyler.mairose@sailpoint.com> Date: Mon, 18 Mar 2024 18:20:48 +0000 Subject: [PATCH] Automated commit 'Merge pull request #1599 from sailpoint/khartzke/IDNARC-2202 IDNARC-2202 Add reset entitlements to the beta api docs' by github action: 8331705064 --- idn/beta/paths/reset-entitlements.yaml | 36 +++++++++++++++++++ idn/sailpoint-api.beta.yaml | 2 ++ ...ntitlementSourceResetBaseReferenceDto.yaml | 14 ++++++++ 3 files changed, 52 insertions(+) create mode 100644 idn/beta/paths/reset-entitlements.yaml create mode 100644 idn/v3/schemas/EntitlementSourceResetBaseReferenceDto.yaml diff --git a/idn/beta/paths/reset-entitlements.yaml b/idn/beta/paths/reset-entitlements.yaml new file mode 100644 index 00000000..8274acd9 --- /dev/null +++ b/idn/beta/paths/reset-entitlements.yaml @@ -0,0 +1,36 @@ +post: + operationId: resetSourceEntitlements + tags: + - Entitlements + summary: Reset Source Entitlements + description: >- + Removes all entitlements on a specific source. + + + parameters: + - name: id + in: path + description: ID of source for the entitlement reset + required: true + schema: + type: string + example: 2c91808a7813090a017814121919ecca + responses: + '202': + description: Entitlement source reset task result + content: + application/json: + schema: + $ref: '../../v3/schemas/EntitlementSourceResetBaseReferenceDto.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '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:entitlement:update] diff --git a/idn/sailpoint-api.beta.yaml b/idn/sailpoint-api.beta.yaml index 6a0ca3d7..4dc83332 100644 --- a/idn/sailpoint-api.beta.yaml +++ b/idn/sailpoint-api.beta.yaml @@ -1205,6 +1205,8 @@ paths: $ref: './beta/paths/ears-entitlement-bulk-update.yaml' /entitlements/{id}/entitlement-request-config: $ref: "./beta/paths/entitlement-request-config.yaml" + /entitlements/reset/sources/{id}: + $ref: './beta/paths/reset-entitlements.yaml' /entitlements/aggregate/sources/{id}: $ref: "./beta/paths/load-entitlements.yaml" /generate-password-reset-token/digit: diff --git a/idn/v3/schemas/EntitlementSourceResetBaseReferenceDto.yaml b/idn/v3/schemas/EntitlementSourceResetBaseReferenceDto.yaml new file mode 100644 index 00000000..bf7a4619 --- /dev/null +++ b/idn/v3/schemas/EntitlementSourceResetBaseReferenceDto.yaml @@ -0,0 +1,14 @@ +type: object +properties: + type: + type: string + description: The DTO type + example: TASK_RESULT + id: + type: string + description: The task ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies + example: Entitlement Source Reset \ No newline at end of file