diff --git a/idn/beta/paths/service-desk-integration-configuration.yaml b/idn/beta/paths/service-desk-integration-configuration.yaml index c200512e..9a110662 100644 --- a/idn/beta/paths/service-desk-integration-configuration.yaml +++ b/idn/beta/paths/service-desk-integration-configuration.yaml @@ -2,7 +2,7 @@ get: tags: - Service Desk Integration summary: Get the time check configuration - description: Get the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + description: Get the time check configuration of queued SDIM tickets. operationId: getStatusCheckDetails responses: "200": @@ -24,16 +24,17 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:read, idn:service-desk-admin:manage, idn:service-desk-integration:read, idn:service-desk-integration:manage] - + - userAuth: [idn:service-desk-integration:read, idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN put: tags: - Service Desk Integration summary: Update the time check configuration - description: Update the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + description: Update the time check configuration of queued SDIM tickets. operationId: updateStatusCheckDetails requestBody: - description: the modified time check configuration + description: The modified time check configuration content: application/json: schema: @@ -59,4 +60,6 @@ put: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:manage ,idn:service-desk-integration:manage] + - userAuth: [idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN \ No newline at end of file diff --git a/idn/beta/paths/service-desk-integration-template.yaml b/idn/beta/paths/service-desk-integration-template.yaml index a666b6b9..4af53913 100644 --- a/idn/beta/paths/service-desk-integration-template.yaml +++ b/idn/beta/paths/service-desk-integration-template.yaml @@ -1,8 +1,8 @@ get: tags: - Service Desk Integration - summary: Service Desk integration template by scriptName. - description: This API endpoint returns an existing Service Desk integration template by scriptName. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + summary: Service Desk integration template by scriptName + description: This API endpoint returns an existing Service Desk integration template by scriptName. operationId: getServiceDeskIntegrationTemplate parameters: - name: scriptName @@ -34,4 +34,6 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:read,idn:service-desk-integration:read] + - userAuth: [idn:service-desk-integration:read, idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN \ No newline at end of file diff --git a/idn/beta/paths/service-desk-integration-types.yaml b/idn/beta/paths/service-desk-integration-types.yaml index cfaf9bfd..559d46a8 100644 --- a/idn/beta/paths/service-desk-integration-types.yaml +++ b/idn/beta/paths/service-desk-integration-types.yaml @@ -1,8 +1,8 @@ get: tags: - Service Desk Integration - summary: Service Desk Integration Types List. - description: This API endpoint returns the current list of supported Service Desk integration types. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + summary: List Service Desk integration types + description: This API endpoint returns the current list of supported Service Desk integration types. operationId: getServiceDeskIntegrationTypes responses: "200": @@ -26,4 +26,6 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:read, idn:service-desk-admin:manage, idn:service-desk-integration:read, idn:service-desk-integration:manage] + - userAuth: [idn:service-desk-integration:read, idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN \ No newline at end of file diff --git a/idn/beta/paths/service-desk-integration.yaml b/idn/beta/paths/service-desk-integration.yaml index a2cc5aca..33806c43 100644 --- a/idn/beta/paths/service-desk-integration.yaml +++ b/idn/beta/paths/service-desk-integration.yaml @@ -2,7 +2,7 @@ get: tags: - Service Desk Integration summary: Get a Service Desk integration - description: Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + description: Get an existing Service Desk integration by ID. operationId: getServiceDeskIntegration parameters: - name: id @@ -34,13 +34,15 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:read,idn:service-desk-integration:read] + - userAuth: [idn:service-desk-integration:read, idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN put: tags: - Service Desk Integration summary: Update a Service Desk integration - description: Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + description: Update an existing Service Desk integration by ID. operationId: putServiceDeskIntegration parameters: - name: id @@ -79,13 +81,15 @@ put: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:manage,idn:service-desk-integration:manage] + - userAuth: [idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN delete: tags: - Service Desk Integration summary: Delete a Service Desk integration - description: Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + description: Delete an existing Service Desk integration by ID. operationId: deleteServiceDeskIntegration parameters: - name: id @@ -113,14 +117,16 @@ delete: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:manage,idn:service-desk-integration:manage] + - userAuth: [idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN patch: operationId: patchServiceDeskIntegration tags: - Service Desk Integration - summary: Service Desk Integration Update PATCH - description: Update an existing ServiceDeskIntegration by ID with a PATCH request. + summary: Patch a Service Desk Integration + description: Update an existing Service Desk integration by ID with a PATCH request. parameters: - name: id in: path @@ -138,7 +144,7 @@ patch: Only `replace` operations are accepted by this endpoint. - A 403 Forbidden Error indicates that you attempted to PATCH a operation that is not allowed. + A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. content: application/json-patch+json: schema: @@ -150,18 +156,18 @@ patch: type: array items: $ref: '../schemas/JsonPatchOperation.yaml' - example: >- - [ - { - "op": "replace", - "path": "/ownerRef", - "value": { - "id": "2c9180867d05b227017d09921a205b4d", - "type": "IDENTITY", - "name": "Angelo2 tester" - } - } - ] + example: + [ + { + "op": "replace", + "path": "/ownerRef", + "value": { + "id": "2c9180867d05b227017d09921a205b4d", + "type": "IDENTITY", + "name": "Angelo Medici" + } + } + ] responses: "200": description: ServiceDeskIntegrationDto as updated @@ -182,4 +188,6 @@ patch: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:manage,idn:service-desk-integration:manage] + - userAuth: [idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN \ No newline at end of file diff --git a/idn/beta/paths/service-desk-integrations.yaml b/idn/beta/paths/service-desk-integrations.yaml index e6c03983..1799a4d1 100644 --- a/idn/beta/paths/service-desk-integrations.yaml +++ b/idn/beta/paths/service-desk-integrations.yaml @@ -1,8 +1,8 @@ get: tags: - Service Desk Integration - summary: List existing Service Desk Integrations - description: Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + summary: List existing Service Desk integrations + description: Get a list of Service Desk integration objects. operationId: getServiceDeskIntegrationList parameters: - $ref: '../../v3/parameters/offset.yaml' @@ -69,12 +69,15 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:read,idn:service-desk-integration:read] + - userAuth: [idn:service-desk-integration:read, idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + post: tags: - Service Desk Integration summary: Create new Service Desk integration - description: Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + description: Create a new Service Desk integration. operationId: createServiceDeskIntegration requestBody: description: The specifics of a new integration to create @@ -85,7 +88,7 @@ post: required: true responses: "200": - description: details of the created integration + description: Details of the created integration content: application/json: schema: @@ -103,4 +106,6 @@ post: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:manage,idn:service-desk-integration:manage] + - userAuth: [idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN \ No newline at end of file diff --git a/idn/beta/schemas/QueuedCheckConfigDetails.yaml b/idn/beta/schemas/QueuedCheckConfigDetails.yaml index 05466ea5..6f31a321 100644 --- a/idn/beta/schemas/QueuedCheckConfigDetails.yaml +++ b/idn/beta/schemas/QueuedCheckConfigDetails.yaml @@ -1,14 +1,14 @@ -description: Configuration of maximum number days and interval for checking Service Desk integration queue status +description: Configuration of maximum number of days and interval for checking Service Desk integration queue status. required: - provisioningStatusCheckIntervalMinutes - provisioningMaxStatusCheckDays type: object properties: provisioningStatusCheckIntervalMinutes: - description: interval in minutes between status checks + description: Interval in minutes between status checks type: string example: 30 provisioningMaxStatusCheckDays: - description: maximum number of days to check + description: Maximum number of days to check type: string example: 2 diff --git a/idn/v3/paths/service-desk-integration-configuration.yaml b/idn/v3/paths/service-desk-integration-configuration.yaml index 29918738..9a110662 100644 --- a/idn/v3/paths/service-desk-integration-configuration.yaml +++ b/idn/v3/paths/service-desk-integration-configuration.yaml @@ -24,7 +24,7 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:read,idn:service-desk-integration:read] + - userAuth: [idn:service-desk-integration:read, idn:service-desk-integration:manage] x-sailpoint-userLevels: - ORG_ADMIN put: @@ -34,7 +34,7 @@ put: description: Update the time check configuration of queued SDIM tickets. operationId: updateStatusCheckDetails requestBody: - description: the modified time check configuration + description: The modified time check configuration content: application/json: schema: @@ -60,6 +60,6 @@ put: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:manage,idn:service-desk-integration:manage] + - userAuth: [idn:service-desk-integration:manage] x-sailpoint-userLevels: - - ORG_ADMIN + - ORG_ADMIN \ No newline at end of file diff --git a/idn/v3/paths/service-desk-integration-template.yaml b/idn/v3/paths/service-desk-integration-template.yaml index 5852c540..4af53913 100644 --- a/idn/v3/paths/service-desk-integration-template.yaml +++ b/idn/v3/paths/service-desk-integration-template.yaml @@ -1,7 +1,7 @@ get: tags: - Service Desk Integration - summary: Service Desk integration template by scriptName. + summary: Service Desk integration template by scriptName description: This API endpoint returns an existing Service Desk integration template by scriptName. operationId: getServiceDeskIntegrationTemplate parameters: @@ -34,6 +34,6 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:read,idn:service-desk-integration:read] + - userAuth: [idn:service-desk-integration:read, idn:service-desk-integration:manage] x-sailpoint-userLevels: - - ORG_ADMIN + - ORG_ADMIN \ No newline at end of file diff --git a/idn/v3/paths/service-desk-integration-types.yaml b/idn/v3/paths/service-desk-integration-types.yaml index 9959e8f5..559d46a8 100644 --- a/idn/v3/paths/service-desk-integration-types.yaml +++ b/idn/v3/paths/service-desk-integration-types.yaml @@ -1,7 +1,7 @@ get: tags: - Service Desk Integration - summary: Service Desk Integration Types List. + summary: List Service Desk integration types description: This API endpoint returns the current list of supported Service Desk integration types. operationId: getServiceDeskIntegrationTypes responses: @@ -26,6 +26,6 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:read,idn:service-desk-integration:read] + - userAuth: [idn:service-desk-integration:read, idn:service-desk-integration:manage] x-sailpoint-userLevels: - - ORG_ADMIN + - ORG_ADMIN \ No newline at end of file diff --git a/idn/v3/paths/service-desk-integration.yaml b/idn/v3/paths/service-desk-integration.yaml index 5a00132e..8fc2e932 100644 --- a/idn/v3/paths/service-desk-integration.yaml +++ b/idn/v3/paths/service-desk-integration.yaml @@ -34,7 +34,7 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:read,idn:service-desk-integration:read] + - userAuth: [idn:service-desk-integration:read, idn:service-desk-integration:manage] x-sailpoint-userLevels: - ORG_ADMIN @@ -42,7 +42,7 @@ put: tags: - Service Desk Integration summary: Update a Service Desk integration - description: Update an existing Service Desk integration by ID with updated value in JSON form as the request body. + description: Update an existing Service Desk integration by ID. operationId: putServiceDeskIntegration parameters: - name: id @@ -81,7 +81,7 @@ put: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:manage,idn:service-desk-integration:manage] + - userAuth: [idn:service-desk-integration:manage] x-sailpoint-userLevels: - ORG_ADMIN @@ -117,7 +117,7 @@ delete: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:manage,idn:service-desk-integration:manage] + - userAuth: [idn:service-desk-integration:manage] x-sailpoint-userLevels: - ORG_ADMIN @@ -125,8 +125,8 @@ patch: operationId: patchServiceDeskIntegration tags: - Service Desk Integration - summary: Service Desk Integration Update PATCH - description: Update an existing ServiceDeskIntegration by ID with a PATCH request. + summary: Patch a Service Desk Integration + description: Update an existing Service Desk integration by ID with a PATCH request. parameters: - name: id in: path @@ -144,7 +144,7 @@ patch: Only `replace` operations are accepted by this endpoint. - A 403 Forbidden Error indicates that you attempted to PATCH a operation that is not allowed. + A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. content: application/json-patch+json: schema: @@ -156,7 +156,7 @@ patch: type: array items: $ref: '../schemas/JsonPatchOperation.yaml' - example: >- + example: [ { "op": "replace", @@ -164,7 +164,7 @@ patch: "value": { "id": "2c9180867d05b227017d09921a205b4d", "type": "IDENTITY", - "name": "Angelo2 tester" + "name": "Angelo Medici" } } ] @@ -188,6 +188,6 @@ patch: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:manage,idn:service-desk-integration:manage] + - userAuth: [idn:service-desk-integration:manage] x-sailpoint-userLevels: - - ORG_ADMIN + - ORG_ADMIN \ No newline at end of file diff --git a/idn/v3/paths/service-desk-integrations.yaml b/idn/v3/paths/service-desk-integrations.yaml index 4e8b8d4a..8ae44c71 100644 --- a/idn/v3/paths/service-desk-integrations.yaml +++ b/idn/v3/paths/service-desk-integrations.yaml @@ -1,8 +1,8 @@ get: tags: - Service Desk Integration - summary: List existing Service Desk Integrations - description: Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. + summary: List existing Service Desk integrations + description: Get a list of Service Desk integration objects. operationId: getServiceDeskIntegrations parameters: - $ref: '../../v3/parameters/offset.yaml' @@ -69,7 +69,7 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:read,idn:service-desk-integration:read] + - userAuth: [idn:service-desk-integration:read, idn:service-desk-integration:manage] x-sailpoint-userLevels: - ORG_ADMIN @@ -77,7 +77,7 @@ post: tags: - Service Desk Integration summary: Create new Service Desk integration - description: Create a new Service Desk Integrations. + description: Create a new Service Desk integration. operationId: createServiceDeskIntegration requestBody: description: The specifics of a new integration to create @@ -88,7 +88,7 @@ post: required: true responses: "200": - description: details of the created integration + description: Details of the created integration content: application/json: schema: @@ -106,6 +106,6 @@ post: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:service-desk-admin:manage,idn:service-desk-integration:manage] + - userAuth: [idn:service-desk-integration:manage] x-sailpoint-userLevels: - - ORG_ADMIN + - ORG_ADMIN \ No newline at end of file diff --git a/idn/v3/schemas/QueuedCheckConfigDetails.yaml b/idn/v3/schemas/QueuedCheckConfigDetails.yaml index 45d05aa2..72444440 100644 --- a/idn/v3/schemas/QueuedCheckConfigDetails.yaml +++ b/idn/v3/schemas/QueuedCheckConfigDetails.yaml @@ -1,14 +1,14 @@ -description: Configuration of maximum number days and interval for checking Service Desk integration queue status +description: Configuration of maximum number of days and interval for checking Service Desk integration queue status. required: - provisioningStatusCheckIntervalMinutes - provisioningMaxStatusCheckDays type: object properties: provisioningStatusCheckIntervalMinutes: - description: interval in minutes between status checks + description: Interval in minutes between status checks type: string - example: "30" + example: 30 provisioningMaxStatusCheckDays: - description: maximum number of days to check + description: Maximum number of days to check type: string - example: "2" + example: 2 \ No newline at end of file