From f92a27df2a12699e716b0a4d2ee6b6f473d00f3e Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Thu, 19 Dec 2024 21:00:48 +0000 Subject: [PATCH] Automated commit by github action: 12420684165 --- .../api-specs/idn/beta/paths/connectors.yaml | 12 ++- .../idn/beta/paths/correlation-config.yaml | 16 ++-- .../idn/beta/paths/identities-invite.yaml | 10 +-- .../identity-send-account-verification.yaml | 17 ++-- static/api-specs/idn/sailpoint-api.beta.yaml | 2 +- static/api-specs/idn/sailpoint-api.v2024.yaml | 6 ++ static/api-specs/idn/sailpoint-api.v3.yaml | 2 - .../idn/v2024/paths/correlation-config.yaml | 89 +++++++++++++++++++ .../idn/v2024/paths/identities-invite.yaml | 51 +++++++++++ .../identity-send-account-verification.yaml | 48 ++++++++++ .../idn/v2024/schemas/CorrelationConfig.yaml | 54 +++++++++++ static/api-specs/idn/v3/paths/connector.yaml | 40 ++++++--- .../paths/connectors-correlation-config.yaml | 14 ++- .../v3/paths/connectors-source-config.yaml | 18 ++-- .../v3/paths/connectors-source-template.yaml | 18 ++-- .../idn/v3/paths/connectors-translations.yaml | 14 ++- static/api-specs/idn/v3/paths/connectors.yaml | 16 ++-- .../idn/v3/paths/correlation-config.yaml | 89 +++++++++++++++++++ .../idn/v3/schemas/CorrelationConfig.yaml | 54 +++++++++++ 19 files changed, 507 insertions(+), 63 deletions(-) create mode 100644 static/api-specs/idn/v2024/paths/correlation-config.yaml create mode 100644 static/api-specs/idn/v2024/paths/identities-invite.yaml create mode 100644 static/api-specs/idn/v2024/paths/identity-send-account-verification.yaml create mode 100644 static/api-specs/idn/v2024/schemas/CorrelationConfig.yaml create mode 100644 static/api-specs/idn/v3/paths/correlation-config.yaml create mode 100644 static/api-specs/idn/v3/schemas/CorrelationConfig.yaml diff --git a/static/api-specs/idn/beta/paths/connectors.yaml b/static/api-specs/idn/beta/paths/connectors.yaml index f8e5c964365..b4649eeb749 100644 --- a/static/api-specs/idn/beta/paths/connectors.yaml +++ b/static/api-specs/idn/beta/paths/connectors.yaml @@ -2,14 +2,13 @@ get: tags: - Connectors operationId: getConnectorList - summary: Gets connector list + summary: Get Connector List description: >- Fetches list of connectors that have 'RELEASED' status using filtering and pagination. - - A token with ORG_ADMIN authority is required to call this API. parameters: - in: query name: filters + required: false schema: type: string description: >- @@ -38,6 +37,7 @@ get: - $ref: '../../v3/parameters/count.yaml' - in: query name: locale + required: false schema: type: string enum: [de, no, fi, sv, ru, pt, ko, zh-TW, en, it, fr, zh-CN, hu, es, cs, ja, pl, da, nl] @@ -66,4 +66,8 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [ idn:connector-source-config:read ] + - userAuth: [ idn:connector-config:read, idn:connector-config:manage ] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN \ No newline at end of file diff --git a/static/api-specs/idn/beta/paths/correlation-config.yaml b/static/api-specs/idn/beta/paths/correlation-config.yaml index 6853c182198..c902cc42273 100644 --- a/static/api-specs/idn/beta/paths/correlation-config.yaml +++ b/static/api-specs/idn/beta/paths/correlation-config.yaml @@ -4,12 +4,14 @@ get: - Sources summary: Get Source Correlation Configuration security: - - userAuth: [idn:sources:read] + - userAuth: [idn:sources:read, idn:sources:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN description: >- This API returns the existing correlation configuration for a source specified by the given ID. - - A token with ORG_ADMIN authority is required to call this API. parameters: - in: path name: id @@ -44,12 +46,14 @@ put: - Sources summary: Update Source Correlation Configuration security: - - userAuth: [idn:sources:update] + - userAuth: [idn:sources:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN description: >- Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - - A token with ORG_ADMIN authority is required to call this API. parameters: - in: path name: id diff --git a/static/api-specs/idn/beta/paths/identities-invite.yaml b/static/api-specs/idn/beta/paths/identities-invite.yaml index 01551fdaf39..edecf591ef3 100644 --- a/static/api-specs/idn/beta/paths/identities-invite.yaml +++ b/static/api-specs/idn/beta/paths/identities-invite.yaml @@ -8,15 +8,13 @@ post: This task will send an invitation email only for unregistered identities. - The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status) - - A token with ORG_ADMIN or HELPDESK authority is required to call this API. + The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). externalDocs: description: 'Learn more about inviting identities here' url: 'https://documentation.sailpoint.com/saas/help/common/users/inviting_users.html' - security: - - userAuth: - - "idn:password-user-invite:create" + x-sailpoint-userLevels: + - ORG_ADMIN + - HELPDESK requestBody: required: true content: diff --git a/static/api-specs/idn/beta/paths/identity-send-account-verification.yaml b/static/api-specs/idn/beta/paths/identity-send-account-verification.yaml index 5c511b0a8e6..47cfae0da73 100644 --- a/static/api-specs/idn/beta/paths/identity-send-account-verification.yaml +++ b/static/api-specs/idn/beta/paths/identity-send-account-verification.yaml @@ -5,11 +5,18 @@ post: summary: Send password reset email description: | This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - - A token with ORG_ADMIN or HELPDESK authority is required to call this API. - security: - - userAuth: - - "idn:password-user-invite:create" + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + description: Identity ID + example: ef38f94347e94562b5bb8424a56397d8 + x-sailpoint-userLevels: + - ORG_ADMIN + - HELPDESK requestBody: required: true content: diff --git a/static/api-specs/idn/sailpoint-api.beta.yaml b/static/api-specs/idn/sailpoint-api.beta.yaml index 5805fa527ef..38dd2ba828a 100644 --- a/static/api-specs/idn/sailpoint-api.beta.yaml +++ b/static/api-specs/idn/sailpoint-api.beta.yaml @@ -1359,7 +1359,7 @@ paths: /identities/{id}: $ref: './beta/paths/identity.yaml' /identities/invite: - $ref: './beta/paths/identities-invite.yaml' + $ref: './beta/paths/identities-invite.yaml' /identities/{id}/verification/account/send: $ref: './beta/paths/identity-send-account-verification.yaml' /identities/process: diff --git a/static/api-specs/idn/sailpoint-api.v2024.yaml b/static/api-specs/idn/sailpoint-api.v2024.yaml index 7c51cd65bed..75ac9a879cc 100644 --- a/static/api-specs/idn/sailpoint-api.v2024.yaml +++ b/static/api-specs/idn/sailpoint-api.v2024.yaml @@ -1631,6 +1631,8 @@ paths: $ref: ./v3/paths/source-entitlements-schema.yaml /sources/{sourceId}/upload-connector-file: $ref: ./v3/paths/source-upload-connector-file.yaml + /sources/{id}/correlation-config: + $ref: ./v2024/paths/correlation-config.yaml /tagged-objects: $ref: ./v3/paths/tagged-objects.yaml /tagged-objects/{type}: @@ -1813,6 +1815,10 @@ paths: $ref: ./v2024/paths/identities.yaml /identities/{id}: $ref: ./v2024/paths/identity.yaml + /identities/invite: + $ref: ./v2024/paths/identities-invite.yaml + /identities/{id}/verification/account/send: + $ref: ./v2024/paths/identity-send-account-verification.yaml /identities/process: $ref: ./v2024/paths/identities-process.yaml /identities/{id}/reset: diff --git a/static/api-specs/idn/sailpoint-api.v3.yaml b/static/api-specs/idn/sailpoint-api.v3.yaml index f1cdbbfe4d1..5b4478ea586 100644 --- a/static/api-specs/idn/sailpoint-api.v3.yaml +++ b/static/api-specs/idn/sailpoint-api.v3.yaml @@ -1138,8 +1138,6 @@ paths: $ref: './v3/paths/connectors-translations.yaml' /connectors/{scriptName}/source-template: $ref: './v3/paths/connectors-source-template.yaml' - /connectors/{scriptName}/correlation-config: - $ref: './v3/paths/connectors-correlation-config.yaml' /identities/{identity-id}/set-lifecycle-state: $ref: "./v3/paths/identity-set-lifecycle-state.yaml" /identity-profiles/{identity-profile-id}/lifecycle-states: diff --git a/static/api-specs/idn/v2024/paths/correlation-config.yaml b/static/api-specs/idn/v2024/paths/correlation-config.yaml new file mode 100644 index 00000000000..30281004671 --- /dev/null +++ b/static/api-specs/idn/v2024/paths/correlation-config.yaml @@ -0,0 +1,89 @@ +get: + operationId: getCorrelationConfig + tags: + - Sources + summary: Get Source Correlation Configuration + security: + - userAuth: [idn:sources:read, idn:sources:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + description: >- + This API returns the existing correlation configuration for a source specified by the + given ID. + parameters: + - in: path + name: id + required: true + schema: + type: string + description: The source id + example: 2c9180835d191a86015d28455b4a2329 + responses: + '200': + description: Correlation configuration for a source + content: + application/json: + schema: + $ref: '../schemas/CorrelationConfig.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + +put: + operationId: putCorrelationConfig + tags: + - Sources + summary: Update Source Correlation Configuration + security: + - userAuth: [idn:sources:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + description: >- + Replaces the correlation configuration for the source specified by the given ID with the + configuration provided in the request body. + parameters: + - in: path + name: id + required: true + schema: + type: string + description: The source id + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/CorrelationConfig.yaml' + responses: + '200': + description: Updated correlation configuration for a source + content: + application/json: + schema: + $ref: '../schemas/CorrelationConfig.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/v2024/paths/identities-invite.yaml b/static/api-specs/idn/v2024/paths/identities-invite.yaml new file mode 100644 index 00000000000..2997c3de452 --- /dev/null +++ b/static/api-specs/idn/v2024/paths/identities-invite.yaml @@ -0,0 +1,51 @@ +post: + operationId: startIdentitiesInvite + tags: + - Identities + summary: Invite identities to register + description: | + This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. + + This task will send an invitation email only for unregistered identities. + + The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). + externalDocs: + description: 'Learn more about inviting identities here' + url: 'https://documentation.sailpoint.com/saas/help/common/users/inviting_users.html' + x-sailpoint-userLevels: + - ORG_ADMIN + - HELPDESK + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + required: true + content: + application/json: + schema: + $ref: "../../beta/schemas/InviteIdentitiesRequest.yaml" + responses: + "202": + description: Responds with an initial TaskStatus for the executed task + content: + application/json: + schema: + $ref: "../../beta/schemas/TaskStatus.yaml" + "400": + $ref: "../../v3/responses/400.yaml" + "401": + $ref: "../../v3/responses/401.yaml" + "403": + $ref: "../../v3/responses/403.yaml" + "404": + $ref: "../../v3/responses/404.yaml" + "429": + $ref: "../../v3/responses/429.yaml" + "500": + $ref: "../../v3/responses/500.yaml" diff --git a/static/api-specs/idn/v2024/paths/identity-send-account-verification.yaml b/static/api-specs/idn/v2024/paths/identity-send-account-verification.yaml new file mode 100644 index 00000000000..76161a1eb28 --- /dev/null +++ b/static/api-specs/idn/v2024/paths/identity-send-account-verification.yaml @@ -0,0 +1,48 @@ +post: + operationId: sendIdentityVerificationAccountToken + tags: + - Identities + summary: Send password reset email + description: | + This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. + x-sailpoint-userLevels: + - ORG_ADMIN + - HELPDESK + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + description: Identity ID + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + content: + application/json: + schema: + $ref: "../../beta/schemas/SendAccountVerificationRequest.yaml" + responses: + "200": + description: The email was successfully sent + "400": + $ref: "../../v3/responses/400.yaml" + "401": + $ref: "../../v3/responses/401.yaml" + "403": + $ref: "../../v3/responses/403.yaml" + "404": + $ref: "../../v3/responses/404.yaml" + "429": + $ref: "../../v3/responses/429.yaml" + "500": + $ref: "../../v3/responses/500.yaml" diff --git a/static/api-specs/idn/v2024/schemas/CorrelationConfig.yaml b/static/api-specs/idn/v2024/schemas/CorrelationConfig.yaml new file mode 100644 index 00000000000..d2b739f5cea --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/CorrelationConfig.yaml @@ -0,0 +1,54 @@ +type: object +description: Source configuration information that is used by correlation process. +properties: + id: + type: string + description: The ID of the correlation configuration. + example: 2c9180835d191a86015d28455b4a2329 + name: + type: string + description: The name of the correlation configuration. + example: Source [source] Account Correlation + attributeAssignments: + type: array + description: The list of attribute assignments of the correlation configuration. + items: + type: object + description: The attribute assignment of the correlation configuration. + properties: + property: + type: string + description: The property of the attribute assignment. + example: first_name + value: + type: string + description: The value of the attribute assignment. + example: firstName + operation: + type: string + description: The operation of the attribute assignment. + enum: + - EQ + example: EQ + complex: + type: boolean + description: Whether or not the it's a complex attribute assignment. + default: false + example: false + ignoreCase: + type: boolean + description: Whether or not the attribute assignment should ignore case. + default: false + example: false + matchMode: + type: string + description: The match mode of the attribute assignment. + enum: + - ANYWHERE + - START + - END + example: ANYWHERE + filterString: + type: string + description: The filter string of the attribute assignment. + example: first_name == "John" diff --git a/static/api-specs/idn/v3/paths/connector.yaml b/static/api-specs/idn/v3/paths/connector.yaml index 055b64c3170..ed4a11f9bbf 100644 --- a/static/api-specs/idn/v3/paths/connector.yaml +++ b/static/api-specs/idn/v3/paths/connector.yaml @@ -2,13 +2,13 @@ get: tags: - Connectors operationId: getConnector - summary: Gets connector by script name + summary: Get Connector by Script Name description: >- Fetches a connector that using its script name. parameters: - name: scriptName in: path - description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. required: true style: simple explode: false @@ -17,6 +17,7 @@ get: example: aScriptName - in: query name: locale + required: false schema: type: string enum: [ de, no, fi, sv, ru, pt, ko, zh-TW, en, it, fr, zh-CN, hu, es, cs, ja, pl, da, nl ] @@ -43,20 +44,22 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [ idn:connector-config:read ] + - userAuth: [ idn:connector-config:read, idn:connector-config:manage ] x-sailpoint-userLevels: - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN delete: tags: - Connectors operationId: deleteCustomConnector - summary: Deletes connector by script name + summary: Delete Connector by Script Name description: >- Delete a custom connector that using its script name. parameters: - name: scriptName in: path - description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. required: true style: simple explode: false @@ -80,26 +83,34 @@ delete: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [ idn:connector-config:delete ] + - userAuth: [ idn:connector-config:manage ] x-sailpoint-userLevels: - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN patch: tags: - Connectors operationId: updateConnector - summary: Update connector by script name - description: >- - Patch a custom connector that using its script name. + summary: Update Connector by Script Name + description: | + This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: + + * connectorMetadata + * applicationXml + * correlationConfigXml + * sourceConfigXml + parameters: - name: scriptName in: path - description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. required: true style: simple explode: false @@ -108,9 +119,8 @@ patch: example: aScriptName requestBody: required: true - description: >- - A list of connector detail update operations according to - the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + description: | + A list of connector detail update operations content: application/json-patch+json: schema: @@ -137,7 +147,9 @@ patch: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [ idn:connector-config:update ] + - userAuth: [ idn:connector-config:manage ] x-sailpoint-userLevels: - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN diff --git a/static/api-specs/idn/v3/paths/connectors-correlation-config.yaml b/static/api-specs/idn/v3/paths/connectors-correlation-config.yaml index 4089824c0ed..2ea5c0c7073 100644 --- a/static/api-specs/idn/v3/paths/connectors-correlation-config.yaml +++ b/static/api-specs/idn/v3/paths/connectors-correlation-config.yaml @@ -2,6 +2,7 @@ get: tags: - Connectors operationId: getConnectorCorrelationConfig + summary: Get Connector Correlation Configuration description: >- Fetches a connector's correlation config using its script name. parameters: @@ -34,13 +35,16 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [ idn:connector-config:read ] + - userAuth: [ idn:connector-config:read, idn:connector-config:manage ] x-sailpoint-userLevels: - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN put: tags: - Connectors - operationId: putCorrelationConfig + operationId: putConnectorCorrelationConfig + summary: Update Connector Correlation Configuration description: >- Update a connector's correlation config using its script name. parameters: @@ -86,6 +90,8 @@ put: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [ idn:connector-config:update ] + - userAuth: [ idn:connector-config:manage ] x-sailpoint-userLevels: - - ORG_ADMIN \ No newline at end of file + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v3/paths/connectors-source-config.yaml b/static/api-specs/idn/v3/paths/connectors-source-config.yaml index 7821b2a263b..e0e810a6a33 100644 --- a/static/api-specs/idn/v3/paths/connectors-source-config.yaml +++ b/static/api-specs/idn/v3/paths/connectors-source-config.yaml @@ -2,12 +2,13 @@ get: tags: - Connectors operationId: getConnectorSourceConfig + summary: Get Connector Source Configuration description: >- Fetches a connector's source config using its script name. parameters: - name: scriptName in: path - description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. required: true style: simple explode: false @@ -34,19 +35,22 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [ idn:connector-config:read ] + - userAuth: [ idn:connector-config:read, idn:connector-config:manage ] x-sailpoint-userLevels: - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN put: tags: - Connectors - operationId: putSourceConfig + operationId: putConnectorSourceConfig + summary: Update Connector Source Configuration description: >- Update a connector's source config using its script name. parameters: - name: scriptName in: path - description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. required: true style: simple explode: false @@ -86,6 +90,8 @@ put: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [ idn:connector-config:update ] + - userAuth: [ idn:connector-config:manage ] x-sailpoint-userLevels: - - ORG_ADMIN \ No newline at end of file + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v3/paths/connectors-source-template.yaml b/static/api-specs/idn/v3/paths/connectors-source-template.yaml index bfa07916378..9ce6ea65cf2 100644 --- a/static/api-specs/idn/v3/paths/connectors-source-template.yaml +++ b/static/api-specs/idn/v3/paths/connectors-source-template.yaml @@ -2,12 +2,13 @@ get: tags: - Connectors operationId: getConnectorSourceTemplate + summary: Get Connector Source Template description: >- Fetches a connector's source template using its script name. parameters: - name: scriptName in: path - description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. required: true style: simple explode: false @@ -34,19 +35,22 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [ idn:connector-config:read ] + - userAuth: [ idn:connector-config:read, idn:connector-config:manage ] x-sailpoint-userLevels: - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN put: tags: - Connectors - operationId: putSourceTemplate + operationId: putConnectorSourceTemplate + summary: Update Connector Source Template description: >- Update a connector's source template using its script name. parameters: - name: scriptName in: path - description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. required: true style: simple explode: false @@ -86,6 +90,8 @@ put: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [ idn:connector-config:update ] + - userAuth: [ idn:connector-config:manage ] x-sailpoint-userLevels: - - ORG_ADMIN \ No newline at end of file + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v3/paths/connectors-translations.yaml b/static/api-specs/idn/v3/paths/connectors-translations.yaml index e972e84e71e..883e1526253 100644 --- a/static/api-specs/idn/v3/paths/connectors-translations.yaml +++ b/static/api-specs/idn/v3/paths/connectors-translations.yaml @@ -2,6 +2,7 @@ get: tags: - Connectors operationId: getConnectorTranslations + summary: Get Connector Translations description: >- Fetches a connector's translations using its script name. parameters: @@ -43,13 +44,16 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [ idn:connector-config:read ] + - userAuth: [ idn:connector-config:read, idn:connector-config:manage ] x-sailpoint-userLevels: - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN put: tags: - Connectors - operationId: putTranslations + operationId: putConnectorTranslations + summary: Update Connector Translations description: >- Update a connector's translations using its script name. parameters: @@ -97,6 +101,8 @@ put: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [ idn:connector-config:update ] + - userAuth: [ idn:connector-config:manage ] x-sailpoint-userLevels: - - ORG_ADMIN \ No newline at end of file + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v3/paths/connectors.yaml b/static/api-specs/idn/v3/paths/connectors.yaml index 34db842279a..3d0b258ae73 100644 --- a/static/api-specs/idn/v3/paths/connectors.yaml +++ b/static/api-specs/idn/v3/paths/connectors.yaml @@ -2,12 +2,13 @@ get: tags: - Connectors operationId: getConnectorList - summary: Gets connector list + summary: Get Connector List description: >- Fetches list of connectors that have 'RELEASED' status using filtering and pagination. parameters: - in: query name: filters + required: false schema: type: string description: >- @@ -40,6 +41,7 @@ get: - $ref: '../../v3/parameters/count.yaml' - in: query name: locale + required: false schema: type: string enum: [de, no, fi, sv, ru, pt, ko, zh-TW, en, it, fr, zh-CN, hu, es, cs, ja, pl, da, nl] @@ -68,14 +70,16 @@ get: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [ idn:connector-source-config:read ] + - userAuth: [ idn:connector-config:read, idn:connector-config:manage ] x-sailpoint-userLevels: - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN post: tags: - Connectors operationId: createCustomConnector - summary: Create custom connector + summary: Create Custom Connector description: >- Create custom connector. requestBody: @@ -104,6 +108,8 @@ post: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [ idn:connector-config:create ] + - userAuth: [ idn:connector-config:manage ] x-sailpoint-userLevels: - - ORG_ADMIN \ No newline at end of file + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v3/paths/correlation-config.yaml b/static/api-specs/idn/v3/paths/correlation-config.yaml new file mode 100644 index 00000000000..3849d28d1f4 --- /dev/null +++ b/static/api-specs/idn/v3/paths/correlation-config.yaml @@ -0,0 +1,89 @@ +get: + operationId: getCorrelationConfig + tags: + - Sources + summary: Get Source Correlation Configuration + security: + - userAuth: [idn:sources:read, idn:sources:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + description: >- + This API returns the existing correlation configuration for a source specified by the + given ID. + parameters: + - in: path + name: id + required: true + schema: + type: string + description: The source id + example: 2c9180835d191a86015d28455b4a2329 + responses: + '200': + description: Correlation configuration for a source + content: + application/json: + schema: + $ref: '../schemas/CorrelationConfig.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + +put: + operationId: putCorrelationConfig + tags: + - Sources + summary: Update Source Correlation Configuration + security: + - userAuth: [idn:sources:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + description: >- + Replaces the correlation configuration for the source specified by the given ID with the + configuration provided in the request body. + parameters: + - in: path + name: id + required: true + schema: + type: string + description: The source id + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/CorrelationConfig.yaml' + responses: + '200': + description: Updated correlation configuration for a source + content: + application/json: + schema: + $ref: '../schemas/CorrelationConfig.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v3/schemas/CorrelationConfig.yaml b/static/api-specs/idn/v3/schemas/CorrelationConfig.yaml new file mode 100644 index 00000000000..d2b739f5cea --- /dev/null +++ b/static/api-specs/idn/v3/schemas/CorrelationConfig.yaml @@ -0,0 +1,54 @@ +type: object +description: Source configuration information that is used by correlation process. +properties: + id: + type: string + description: The ID of the correlation configuration. + example: 2c9180835d191a86015d28455b4a2329 + name: + type: string + description: The name of the correlation configuration. + example: Source [source] Account Correlation + attributeAssignments: + type: array + description: The list of attribute assignments of the correlation configuration. + items: + type: object + description: The attribute assignment of the correlation configuration. + properties: + property: + type: string + description: The property of the attribute assignment. + example: first_name + value: + type: string + description: The value of the attribute assignment. + example: firstName + operation: + type: string + description: The operation of the attribute assignment. + enum: + - EQ + example: EQ + complex: + type: boolean + description: Whether or not the it's a complex attribute assignment. + default: false + example: false + ignoreCase: + type: boolean + description: Whether or not the attribute assignment should ignore case. + default: false + example: false + matchMode: + type: string + description: The match mode of the attribute assignment. + enum: + - ANYWHERE + - START + - END + example: ANYWHERE + filterString: + type: string + description: The filter string of the attribute assignment. + example: first_name == "John"