mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 20:37:50 +00:00
Automated commit 'Merge pull request #1553 from sailpoint/mtran/PLTCONN-4135
PLTCONN-4135: Publish v3 API endpoints for connector' by github action: 7978964600
This commit is contained in:
GitHub Action Bot
@@ -318,6 +318,22 @@ tags:
|
||||
Once the campaign filter is created, it can be linked while creating the campaign. The generated campaign will have the items to review as per the campaign filter.
|
||||
|
||||
For example, An inclusion campaign filter is created with a source of Source 1, an operation of Equals, and an entitlement of Entitlement 1. When this filter is selected, only users who have Entitlement 1 are included in the campaign, and only Entitlement 1 is shown in the certification.
|
||||
- name: Connectors
|
||||
description: |
|
||||
Use this API to implement connector functionality.
|
||||
With this functionality in place, administrators can view available connectors.
|
||||
|
||||
Connectors are the bridges IdentityNow uses to communicate with and aggregate data from sources.
|
||||
For example, if it is necessary to set up a connection between IdentityNow and the Active Directory source, a connector can bridge the two and enable IdentityNow to synchronize data between the systems.
|
||||
This ensures account entitlements and states are correct throughout the organization.
|
||||
|
||||
In IdentityNow, administrators can use the Connections drop-down menu and select Sources to view the available source connectors.
|
||||
|
||||
Refer to [IdentityNow Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in IdentityNow.
|
||||
|
||||
Refer to [SaaS Connectivity](https://developer.sailpoint.com/idn/docs/saas-connectivity) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources.
|
||||
|
||||
Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in IdentityNow.
|
||||
- name: Global Tenant Security Settings
|
||||
description: |
|
||||
Use this API to implement and customize global tenant security settings.
|
||||
@@ -1029,6 +1045,18 @@ paths:
|
||||
$ref: "./v3/paths/certification-task.yaml"
|
||||
/certification-tasks:
|
||||
$ref: "./v3/paths/certification-tasks.yaml"
|
||||
/connectors:
|
||||
$ref: './v3/paths/connectors-create-custom-connector.yaml'
|
||||
/connectors/{scriptName}:
|
||||
$ref: './v3/paths/connectors.yaml'
|
||||
/connectors/{scriptName}/source-config:
|
||||
$ref: './v3/paths/connectors-source-config.yaml'
|
||||
/connectors/{scriptName}/translations/{locale}:
|
||||
$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:
|
||||
|
||||
91
idn/v3/paths/connectors-correlation-config.yaml
Normal file
91
idn/v3/paths/connectors-correlation-config.yaml
Normal file
@@ -0,0 +1,91 @@
|
||||
get:
|
||||
tags:
|
||||
- Connectors
|
||||
operationId: getConnectorCorrelationConfig
|
||||
description: >-
|
||||
Fetches a connector's correlation config using its script name.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
parameters:
|
||||
- name: scriptName
|
||||
in: path
|
||||
description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: aScriptName
|
||||
responses:
|
||||
'200':
|
||||
description: The connector's correlation config
|
||||
content:
|
||||
application/xml:
|
||||
schema:
|
||||
type: string
|
||||
'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'
|
||||
security:
|
||||
- UserContextAuth: [ idn:connector-config:read ]
|
||||
put:
|
||||
tags:
|
||||
- Connectors
|
||||
operationId: putCorrelationConfig
|
||||
description: >-
|
||||
Update a connector's correlation config using its script name.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
parameters:
|
||||
- name: scriptName
|
||||
in: path
|
||||
description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: aScriptName
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- file
|
||||
properties:
|
||||
file:
|
||||
type: string
|
||||
description: connector correlation config xml file
|
||||
format: binary
|
||||
responses:
|
||||
'200':
|
||||
description: The connector's update detail
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/UpdateDetail.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'
|
||||
security:
|
||||
- UserContextAuth: [ idn:connector-config:update ]
|
||||
37
idn/v3/paths/connectors-create-custom-connector.yaml
Normal file
37
idn/v3/paths/connectors-create-custom-connector.yaml
Normal file
@@ -0,0 +1,37 @@
|
||||
post:
|
||||
tags:
|
||||
- Connectors
|
||||
operationId: createCustomConnector
|
||||
summary: Create custom connector
|
||||
description: >-
|
||||
Create custom connector.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/V3CreateConnectorDto.yaml'
|
||||
responses:
|
||||
'200':
|
||||
description: A Connector Dto object
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/V3ConnectorDto.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'
|
||||
security:
|
||||
- UserContextAuth: [ idn:connector-config:create ]
|
||||
|
||||
91
idn/v3/paths/connectors-source-config.yaml
Normal file
91
idn/v3/paths/connectors-source-config.yaml
Normal file
@@ -0,0 +1,91 @@
|
||||
get:
|
||||
tags:
|
||||
- Connectors
|
||||
operationId: getConnectorSourceConfig
|
||||
description: >-
|
||||
Fetches a connector's source config using its script name.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
parameters:
|
||||
- name: scriptName
|
||||
in: path
|
||||
description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: aScriptName
|
||||
responses:
|
||||
'200':
|
||||
description: The connector's source template
|
||||
content:
|
||||
application/xml:
|
||||
schema:
|
||||
type: string
|
||||
'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'
|
||||
security:
|
||||
- UserContextAuth: [ idn:connector-config:read ]
|
||||
put:
|
||||
tags:
|
||||
- Connectors
|
||||
operationId: putSourceConfig
|
||||
description: >-
|
||||
Update a connector's source config using its script name.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
parameters:
|
||||
- name: scriptName
|
||||
in: path
|
||||
description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: aScriptName
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- file
|
||||
properties:
|
||||
file:
|
||||
type: string
|
||||
description: connector source config xml file
|
||||
format: binary
|
||||
responses:
|
||||
'200':
|
||||
description: The connector's update detail
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/UpdateDetail.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'
|
||||
security:
|
||||
- UserContextAuth: [ idn:connector-config:update ]
|
||||
91
idn/v3/paths/connectors-source-template.yaml
Normal file
91
idn/v3/paths/connectors-source-template.yaml
Normal file
@@ -0,0 +1,91 @@
|
||||
get:
|
||||
tags:
|
||||
- Connectors
|
||||
operationId: getConnectorSourceTemplate
|
||||
description: >-
|
||||
Fetches a connector's source template using its script name.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
parameters:
|
||||
- name: scriptName
|
||||
in: path
|
||||
description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: aScriptName
|
||||
responses:
|
||||
'200':
|
||||
description: The connector's source template
|
||||
content:
|
||||
application/xml:
|
||||
schema:
|
||||
type: string
|
||||
'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'
|
||||
security:
|
||||
- UserContextAuth: [ idn:connector-config:read ]
|
||||
put:
|
||||
tags:
|
||||
- Connectors
|
||||
operationId: putSourceTemplate
|
||||
description: >-
|
||||
Update a connector's source template using its script name.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
parameters:
|
||||
- name: scriptName
|
||||
in: path
|
||||
description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: aScriptName
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- file
|
||||
properties:
|
||||
file:
|
||||
type: string
|
||||
description: connector source template xml file
|
||||
format: binary
|
||||
responses:
|
||||
'200':
|
||||
description: The connector's update detail
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/UpdateDetail.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'
|
||||
security:
|
||||
- UserContextAuth: [ idn:connector-config:update ]
|
||||
102
idn/v3/paths/connectors-translations.yaml
Normal file
102
idn/v3/paths/connectors-translations.yaml
Normal file
@@ -0,0 +1,102 @@
|
||||
get:
|
||||
tags:
|
||||
- Connectors
|
||||
operationId: getConnectorTranslations
|
||||
description: >-
|
||||
Fetches a connector's translations using its script name.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
parameters:
|
||||
- name: scriptName
|
||||
in: path
|
||||
description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: aScriptName
|
||||
- name: locale
|
||||
in: path
|
||||
required: true
|
||||
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]
|
||||
example: de
|
||||
description: >-
|
||||
The locale to apply to the config. If no viable locale is given, it will default to "en"
|
||||
responses:
|
||||
'200':
|
||||
description: The connector's translations
|
||||
content:
|
||||
text/plain:
|
||||
schema:
|
||||
type: string
|
||||
'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'
|
||||
security:
|
||||
- UserContextAuth: [ idn:connector-config:read ]
|
||||
put:
|
||||
tags:
|
||||
- Connectors
|
||||
operationId: putTranslations
|
||||
description: >-
|
||||
Update a connector's translations using its script name.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
parameters:
|
||||
- name: scriptName
|
||||
in: path
|
||||
description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: aScriptName
|
||||
- name: locale
|
||||
in: path
|
||||
required: true
|
||||
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]
|
||||
example: de
|
||||
description: >-
|
||||
The locale to apply to the config. If no viable locale is given, it will default to "en"
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
type: object
|
||||
responses:
|
||||
'200':
|
||||
description: The connector's update detail
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/UpdateDetail.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'
|
||||
security:
|
||||
- UserContextAuth: [ idn:connector-config:update ]
|
||||
139
idn/v3/paths/connectors.yaml
Normal file
139
idn/v3/paths/connectors.yaml
Normal file
@@ -0,0 +1,139 @@
|
||||
get:
|
||||
tags:
|
||||
- Connectors
|
||||
operationId: getConnector
|
||||
description: >-
|
||||
Fetches a connector that using its script name.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
parameters:
|
||||
- name: scriptName
|
||||
in: path
|
||||
description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: aScriptName
|
||||
- in: query
|
||||
name: locale
|
||||
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 ]
|
||||
example: de
|
||||
description: >-
|
||||
The locale to apply to the config. If no viable locale is given, it will default to "en"
|
||||
responses:
|
||||
'200':
|
||||
description: A Connector Dto object
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/ConnectorDetail.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'
|
||||
security:
|
||||
- UserContextAuth: [ idn:connector-config:read ]
|
||||
delete:
|
||||
tags:
|
||||
- Connectors
|
||||
operationId: deleteCustomConnector
|
||||
description: >-
|
||||
Delete a custom connector that using its script name.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
parameters:
|
||||
- name: scriptName
|
||||
in: path
|
||||
description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: aScriptName
|
||||
responses:
|
||||
'204':
|
||||
$ref: '../../v3/responses/204.yaml'
|
||||
description: The custom connector was successfully deleted.
|
||||
'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'
|
||||
security:
|
||||
- UserContextAuth: [ idn:connector-config:delete ]
|
||||
patch:
|
||||
tags:
|
||||
- Connectors
|
||||
operationId: updateConnector
|
||||
description: >-
|
||||
Patch a custom connector that using its script name.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
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.
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
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.
|
||||
content:
|
||||
application/json-patch+json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "../schemas/JsonPatchOperation.yaml"
|
||||
responses:
|
||||
'200':
|
||||
description: A updated Connector Dto object
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/ConnectorDetail.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'
|
||||
security:
|
||||
- UserContextAuth: [ idn:connector-config:update ]
|
||||
|
||||
84
idn/v3/schemas/ConnectorDetail.yaml
Normal file
84
idn/v3/schemas/ConnectorDetail.yaml
Normal file
@@ -0,0 +1,84 @@
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description: The connector name
|
||||
example: "name"
|
||||
type:
|
||||
type: string
|
||||
description: The connector type
|
||||
example: "ServiceNow"
|
||||
className:
|
||||
type: string
|
||||
description: The connector class name
|
||||
example: "class name"
|
||||
scriptName:
|
||||
type: string
|
||||
description: The connector script name
|
||||
example: "servicenow"
|
||||
applicationXml:
|
||||
type: string
|
||||
description: The connector application xml
|
||||
example: "<?xml version='1.0' encoding='UTF-8'?>\n<!DOCTYPE Application PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\n<Application connector=\"sailpoint.connector.OpenConnectorAdapter\" name=\"custom Atlassian Suite - Cloud\" type=\"custom Atlassian Suite - Cloud\"/>\n"
|
||||
correlationConfigXml:
|
||||
type: string
|
||||
description: The connector correlation config xml
|
||||
example: "<?xml version='1.0' encoding='UTF-8'?>\n<!-- Copyright (C) 2021 SailPoint Technologies, Inc. All rights reserved. -->\n\n<!DOCTYPE CorrelationConfig PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\n\n<CorrelationConfig name=\"custom Atlassian Suite - Cloud Account Correlation Config\">\n\t<AttributeAssignments>\n\t\t<Filter operation=\"EQ\" property=\"email\" value=\"mail\"/>\n\t\t<Filter operation=\"EQ\" property=\"empId\" value=\"employeeNumber\"/>\n\t\t<Filter operation=\"EQ\" property=\"displayName\" value=\"cn\"/>\n\t</AttributeAssignments>\n</CorrelationConfig>\n"
|
||||
sourceConfigXml:
|
||||
type: string
|
||||
description: The connector source config xml
|
||||
example: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns=\"http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd\" connectorName=\"custom Atlassian Suite - Cloud\" directConnect=\"true\" fileUpload=\"true\" name=\"Custom Atlassian Suite - Cloud\" status=\"released\" type=\"SourceConfig\">\n <BaseConfig>\n <Field maxFiles=\"10\" maxSize=\"300\" name=\"fileUpload\" supportedExtensions=\"jar\" type=\"fileupload\" validateJSON=\"false\"/>\n </BaseConfig>\n \n\n \n</Form>"
|
||||
sourceConfig:
|
||||
type: string
|
||||
description: The connector source config
|
||||
example: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns=\"http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd\" connectorName=\"custom Atlassian Suite - Cloud\" directConnect=\"true\" fileUpload=\"true\" name=\"Custom Atlassian Suite - Cloud\" status=\"released\" type=\"SourceConfig\">\n <BaseConfig>\n <Field maxFiles=\"10\" maxSize=\"300\" name=\"fileUpload\" supportedExtensions=\"jar\" type=\"fileupload\" validateJSON=\"false\"/>\n </BaseConfig>\n \n\n \n</Form>"
|
||||
sourceConfigFrom:
|
||||
type: string
|
||||
description: The connector source config origin
|
||||
example: "sp-connect"
|
||||
s3Location:
|
||||
type: string
|
||||
description: storage path key for this connector
|
||||
example: "custom-connector/scriptname"
|
||||
uploadedFiles:
|
||||
type: array
|
||||
description: The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation.
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
example: ["pod/org/connectorFiles/testconnector/test1.jar"]
|
||||
fileUpload:
|
||||
type: boolean
|
||||
description: true if the source is file upload
|
||||
example: true
|
||||
default: false
|
||||
directConnect:
|
||||
type: boolean
|
||||
description: true if the source is a direct connect source
|
||||
example: true
|
||||
default: false
|
||||
translationProperties:
|
||||
type: object
|
||||
description: A map containing translation attributes by loacale key
|
||||
additionalProperties: true
|
||||
example: {
|
||||
"de":"# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved.\n# DO NOT EDIT. This file is generated by \"sailpointTranslate\" command.\nmenuLabel_ConnectionSettings=Verbindungseinstellungen\nmenuLabel_AggregationSettings=Aggregationseinstellungen\nsectionLabel_AuthenticationSettings=Verbindungseinstellungen\nsectionLabel_AggregationSettings=Aggregationseinstellungen\nsectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.<br><br>Geben Sie bei <strong>Zeit\\u00fcberschreitung bei Verbindung</strong> die maximal erlaubte Zeitdauer (in Minuten) f\\u00fcr die Verbindung von IdentityNow mit der Quelle ein.<br><br>Geben Sie die <strong>Host-URL</strong> der Delinea-SCIM-Serverquelle ein.<br><br>Geben Sie den <strong>API-Token</strong> der Quelle zur Authentifizierung ein.\nsectionInfo_AggregationSettings=Geben Sie die Einstellungen f\\u00fcr Ihre Aggregation an.<br><br>Geben Sie in das Feld <strong>Seitengr\\u00f6\\u00dfe</strong> die Anzahl an Kontoeintr\\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\\u00dfe Datens\\u00e4tze durchlaufen werden.<br>\\n<br>Geben Sie im <strong>Kontofilter</strong> die Bedingungen f\\u00fcr den Kontofilter an. Beispiel: userName sw \"S\"<br><br>Geben Sie im <strong>Gruppenfilter</strong> die Gruppenfilterbedingungen an. Beispiel: displayName sw \"S\".\nplaceHolder_accAggregation=userName sw \"S\"\nplaceHolder_grpAggregation=displayName sw \"S\"\nplaceHolder_host=https://{Delinea_SCIM_Server_host}/v2\ndocLinkLabel_AuthenticationSettings=Mehr \\u00fcber Verbindungseinstellungen\ndocLinkLabel_Filters=Mehr \\u00fcber Konto- und Gruppenfilter\nHostURL=Host-URL\nConnectionTimeout=Zeit\\u00fcberschreitung bei Verbindung\nAPI_TOKEN=API-Token\nJSONPathMapping=JSON-Path-Attribut-Mapping\nFilterConditionForAccounts=Kontofilter\nFilterConditionForGroups=Gruppenfilter\nPage_Size=Seitengr\\u00f6\\u00dfe\nSchemaAttribute=Schema-Attribut\nJSONpath=JSON-Pfad\nShortDesc=Das Integrationsmodul IdentityNow f\\u00fcr Delinea Secret Server On-Premise bietet die M\\u00f6glichkeit einer tiefen Governance f\\u00fcr Konten und Gruppen. Es unterst\\u00fctzt au\\u00dferdem das End-to-End-Lebenszyklus-Management.",
|
||||
}
|
||||
connectorMetadata:
|
||||
type: object
|
||||
description: A map containing metadata pertinent to the UI to be used
|
||||
additionalProperties: true
|
||||
example: {
|
||||
"supportedUI": "EXTJS",
|
||||
"platform": "ccg",
|
||||
"shortDesc": "connector description"
|
||||
}
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- DEPRECATED
|
||||
- DEVELOPMENT
|
||||
- DEMO
|
||||
- RELEASED
|
||||
description: The connector status
|
||||
example: "RELEASED"
|
||||
26
idn/v3/schemas/UpdateDetail.yaml
Normal file
26
idn/v3/schemas/UpdateDetail.yaml
Normal file
@@ -0,0 +1,26 @@
|
||||
type: object
|
||||
properties:
|
||||
message:
|
||||
type: string
|
||||
description: The detailed message for an update. Typically the relevent error message when status is error.
|
||||
example: "unsupported xsd version, please ensure latest xsd version http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd is used for source config"
|
||||
scriptName:
|
||||
type: string
|
||||
description: The connector script name
|
||||
example: "servicenow"
|
||||
updatedFiles:
|
||||
type: array
|
||||
description: The list of updated files supported by the connector
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
example: ["pod/org/connectorFiles/testconnector/test1.jar"]
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- ERROR
|
||||
- UPDATED
|
||||
- UNCHANGED
|
||||
- SKIPPED
|
||||
description: The connector update status
|
||||
example: "ERROR"
|
||||
49
idn/v3/schemas/V3ConnectorDto.yaml
Normal file
49
idn/v3/schemas/V3ConnectorDto.yaml
Normal file
@@ -0,0 +1,49 @@
|
||||
title: custom connector response object
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description: The connector name
|
||||
example: "name"
|
||||
type:
|
||||
type: string
|
||||
description: The connector type
|
||||
example: "ServiceNow"
|
||||
scriptName:
|
||||
type: string
|
||||
description: The connector script name
|
||||
example: "servicenow"
|
||||
className:
|
||||
type: string
|
||||
description: The connector class name.
|
||||
example: "sailpoint.connector.OpenConnectorAdapter"
|
||||
features:
|
||||
type: array
|
||||
description: The list of features supported by the connector
|
||||
nullable: true
|
||||
items:
|
||||
type: string
|
||||
example: ["PROVISIONING", "SYNC_PROVISIONING", "SEARCH", "UNSTRUCTURED_TARGETS"]
|
||||
directConnect:
|
||||
type: boolean
|
||||
description: true if the source is a direct connect source
|
||||
example: true
|
||||
default: false
|
||||
connectorMetadata:
|
||||
type: object
|
||||
additionalProperties: true
|
||||
description: A map containing metadata pertinent to the connector
|
||||
example: {
|
||||
"supportedUI": "ANGULAR",
|
||||
"platform": "ccg",
|
||||
"shortDesc": "connector description"
|
||||
}
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- DEPRECATED
|
||||
- DEVELOPMENT
|
||||
- DEMO
|
||||
- RELEASED
|
||||
description: The connector status
|
||||
example: "RELEASED"
|
||||
31
idn/v3/schemas/V3CreateConnectorDto.yaml
Normal file
31
idn/v3/schemas/V3CreateConnectorDto.yaml
Normal file
@@ -0,0 +1,31 @@
|
||||
title: custom connector create request
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
- className
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description: The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints
|
||||
example: "custom connector"
|
||||
type:
|
||||
type: string
|
||||
description: The connector type. If not specified will be defaulted to 'custom '+name
|
||||
example: "custom connector type"
|
||||
className:
|
||||
type: string
|
||||
description: The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter
|
||||
example: "sailpoint.connector.OpenConnectorAdapter"
|
||||
directConnect:
|
||||
type: boolean
|
||||
description: true if the source is a direct connect source
|
||||
default: true
|
||||
example: true
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- DEVELOPMENT
|
||||
- DEMO
|
||||
- RELEASED
|
||||
description: The connector status
|
||||
example: "RELEASED"
|
||||
Reference in New Issue
Block a user