LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 04:19:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Automated commit by github action: 3329814523

Browse Source
This commit is contained in:
GitHub Action Bot
2022-10-26 14:19:02 +00:00
parent ffcc2e0838
commit fafd801a8a
8 changed files with 488 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
static/api-specs/idn/beta/paths/source.yaml
View File

@@ -250,7 +250,22 @@ delete:
content:
application/json:
schema:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- TASK_RESULT
example: TASK_RESULT
id:
type: string
description: ID of the task result
example: 2c91808779ecf55b0179f720942f181a
name:
type: string
description: Human-readable display name of the task result (should be null/empty)
example: null
examples:
deleteSource:
summary: Response returned when deleting a source

30
static/api-specs/idn/beta/schemas/ProvisioningConfig.yaml
View File

@@ -10,10 +10,29 @@ properties:
description: References to sources for the Service Desk integration template. May only be specified if universalManager is false.
type: array
items:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
default:
type: SOURCE
example: []
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- SOURCE
example: SOURCE
id:
type: string
description: ID of the source
example: 2c91808568c529c60168cca6f90c1313
name:
type: string
description: Human-readable display name of the source
example: My Source
example:
- type: "SOURCE"
id: "2c9180855d191c59015d291ceb051111"
name: "My Source 1"
- type: "SOURCE"
id: "2c9180855d191c59015d291ceb052222"
name: "My Source 2"
planInitializerScript:
description: This is a reference to a plan initializer script.
type: object
@@ -21,4 +40,5 @@ properties:
source:
description: This is a Rule that allows provisioning instruction changes.
type: string
example: <rule code>
example: |
<?xml version='1.0' encoding='UTF-8'?>\r\n<!DOCTYPE Rule PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\r\n<Rule name=\"Example Rule\" type=\"BeforeProvisioning\">\r\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\r\n <Source><![CDATA[\r\nimport sailpoint.object.*;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\r\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\r\nimport sailpoint.object.ProvisioningPlan;\r\nimport sailpoint.object.ProvisioningPlan.Operation;\r\n\r\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n}\r\n\r\n ]]></Source>

67
static/api-specs/idn/beta/schemas/ServiceDeskIntegrationDto.yaml
View File

@@ -12,20 +12,50 @@ allOf:
type: string
example: A very nice Service Desk integration
type:
description: Type of the Service Desk integration
description: |
Service Desk integration types
- ServiceNowSDIM
- ServiceNow
type: string
default: ServiceNowSDIM
example: ServiceNowSDIM
ownerRef:
description: Reference to the identity that is the owner of this Service Desk integration
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
default:
type: IDENTITY
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- IDENTITY
example: IDENTITY
id:
type: string
description: ID of the identity
example: 2c91808568c529c60168cca6f90c1313
name:
type: string
description: Human-readable display name of the identity
example: MyName
clusterRef:
description: Reference to the source cluster for this Service Desk integration
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
default:
type: CLUSTER
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- CLUSTER
example: CLUSTER
id:
type: string
description: ID of the cluster
example: 2c9180866166b5b0016167c32ef31a66
name:
type: string
description: Human-readable display name of the cluster
example: Corporate Cluster
cluster:
description: ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)
type: string
@@ -53,10 +83,19 @@ allOf:
}
beforeProvisioningRule:
description: Reference to beforeProvisioningRule for this Service Desk integration
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
default:
type: RULE
example:
type: "RULE"
id: "2c918085708c274401708c2a8a760001"
name: "Example Rule"
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- RULE
example: RULE
id:
type: string
description: ID of the rule
example: 2c91808568c529c60168cca6f90c1333
name:
type: string
description: Human-readable display name of the rule
example: Example Rule

184
static/api-specs/idn/beta/schemas/Source.yaml
View File

@@ -10,56 +10,141 @@ properties:
description: Human-readable description of the source
example: "This is the corporate directory."
owner:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
description: Reference to an owning Identity Object
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- IDENTITY
example: IDENTITY
id:
type: string
description: ID of the identity
example: 2c91808568c529c60168cca6f90c1313
name:
type: string
description: Human-readable display name of the identity
example: MyName
cluster:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
description: Reference to the associated Cluster
example:
type: "CLUSTER"
id: "2c9180866166b5b0016167c32ef31a66"
name: "Corporate Cluster"
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- CLUSTER
example: CLUSTER
id:
type: string
description: ID of the cluster
example: 2c9180866166b5b0016167c32ef31a66
name:
type: string
description: Human-readable display name of the cluster
example: Corporate Cluster
accountCorrelationConfig:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
description: Reference to a Correlation Config object
example:
type: "ACCOUNT_CORRELATION_CONFIG"
id: "2c9180855d191c59015d28583727245a"
name: "Directory [source-62867] Account Correlation"
description: Reference to an Account Correlation Config object
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- ACCOUNT_CORRELATION_CONFIG
example: ACCOUNT_CORRELATION_CONFIG
id:
type: string
description: ID of the account correlation config
example: 2c9180855d191c59015d28583727245a
name:
type: string
description: Human-readable display name of the account correlation config
example: Directory [source-62867] Account Correlation
accountCorrelationRule:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
description: >-
Reference to a Rule that can do COMPLEX the correlation, should only be used when accountCorrelationConfig can't
Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't
be used.
example:
type: "RULE"
id: "2c918085708c274401708c2a8a760001"
name: "Example Rule"
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- RULE
example: RULE
id:
type: string
description: ID of the rule
example: 2c918085708c274401708c2a8a760001
name:
type: string
description: Human-readable display name of the rule
example: Example Rule
managerCorrelationMapping:
$ref: './ManagerCorrelationMapping.yaml'
description: >-
Filter Object used during manager correlation to match incoming manager values to an existing manager's
Account/Identity
managerCorrelationRule:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
description: >-
Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.
example:
type: "RULE"
id: "2c918085708c274401708c2a8a760001"
name: "Example Rule"
Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- RULE
example: RULE
id:
type: string
description: ID of the rule
example: 2c918085708c274401708c2a8a760001
name:
type: string
description: Human-readable display name of the rule
example: Example Rule
beforeProvisioningRule:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
description: >-
Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.
example:
type: "RULE"
id: "2c918085708c274401708c2a8a760001"
name: "Example Rule"
Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- RULE
example: RULE
id:
type: string
description: ID of the rule
example: 2c918085708c274401708c2a8a760001
name:
type: string
description: Human-readable display name of the rule
example: Example Rule
schemas:
type: array
items:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- CONNECTOR_SCHEMA
example: CONNECTOR_SCHEMA
id:
type: string
description: ID of the schema
example: 2c91808568c529c60168cca6f90c1777
name:
type: string
description: Human-readable display name of the schema
example: MySchema
description: >-
List of references to Schema objects
example:
@@ -72,13 +157,31 @@ properties:
passwordPolicies:
type: array
items:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- PASSWORD_POLICY
example: PASSWORD_POLICY
id:
type: string
description: ID of the policy
example: 2c91808568c529c60168cca6f90c1777
name:
type: string
description: Human-readable display name of the policy
example: My Password Policy
description: >-
List of references to the associated PasswordPolicy objects.
example:
- type: "PASSWORD_POLICY"
id: "2c9180855d191c59015d291ceb053980"
name: "Corporate Password Policy"
- type: "PASSWORD_POLICY"
id: "2c9180855d191c59015d291ceb057777"
name: "Vendor Password Policy"
features:
type: array
description: >-
@@ -131,8 +234,23 @@ properties:
When true indicates the source is referenced by an IdentityProfile.
example: false
managementWorkgroup:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
description: Reference to Management Workgroup for this Source
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- GOVERNANCE_GROUP
example: GOVERNANCE_GROUP
id:
type: string
description: ID of the management workgroup
example: 2c91808568c529c60168cca6f90c2222
name:
type: string
description: Human-readable display name of the management workgroup
example: My Management Workgroup
healthy:
type: boolean
description: >-

17
static/api-specs/idn/v3/paths/source.yaml
View File

@@ -251,7 +251,22 @@ delete:
content:
application/json:
schema:
$ref: '../schemas/BaseReferenceDto.yaml'
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- TASK_RESULT
example: TASK_RESULT
id:
type: string
description: ID of the task result
example: 2c91808779ecf55b0179f720942f181a
name:
type: string
description: Human-readable display name of the task result (should be null/empty)
example: null
examples:
deleteSource:
summary: Response returned when deleting a source

30
static/api-specs/idn/v3/schemas/ProvisioningConfig.yaml
View File

@@ -10,10 +10,29 @@ properties:
description: References to sources for the Service Desk integration template. May only be specified if universalManager is false.
type: array
items:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
default:
type: SOURCE
example: []
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- SOURCE
example: SOURCE
id:
type: string
description: ID of the source
example: 2c91808568c529c60168cca6f90c1313
name:
type: string
description: Human-readable display name of the source
example: My Source
example:
- type: "SOURCE"
id: "2c9180855d191c59015d291ceb051111"
name: "My Source 1"
- type: "SOURCE"
id: "2c9180855d191c59015d291ceb052222"
name: "My Source 2"
planInitializerScript:
description: This is a reference to a plan initializer script.
type: object
@@ -21,4 +40,5 @@ properties:
source:
description: This is a Rule that allows provisioning instruction changes.
type: string
example: <rule code>
example: |
<?xml version='1.0' encoding='UTF-8'?>\r\n<!DOCTYPE Rule PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\r\n<Rule name=\"Example Rule\" type=\"BeforeProvisioning\">\r\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\r\n <Source><![CDATA[\r\nimport sailpoint.object.*;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\r\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\r\nimport sailpoint.object.ProvisioningPlan;\r\nimport sailpoint.object.ProvisioningPlan.Operation;\r\n\r\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n}\r\n\r\n ]]></Source>

67
static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml
View File

@@ -12,20 +12,50 @@ allOf:
type: string
example: A very nice Service Desk integration
type:
description: Type of the Service Desk integration
description: |
Service Desk integration types
- ServiceNowSDIM
- ServiceNow
type: string
default: ServiceNowSDIM
example: ServiceNowSDIM
ownerRef:
description: Reference to the identity that is the owner of this Service Desk integration
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
default:
type: IDENTITY
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- IDENTITY
example: IDENTITY
id:
type: string
description: ID of the identity
example: 2c91808568c529c60168cca6f90c1313
name:
type: string
description: Human-readable display name of the identity
example: MyName
clusterRef:
description: Reference to the source cluster for this Service Desk integration
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
default:
type: CLUSTER
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- CLUSTER
example: CLUSTER
id:
type: string
description: ID of the cluster
example: 2c9180866166b5b0016167c32ef31a66
name:
type: string
description: Human-readable display name of the cluster
example: Corporate Cluster
cluster:
description: ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)
type: string
@@ -53,10 +83,19 @@ allOf:
}
beforeProvisioningRule:
description: Reference to beforeProvisioningRule for this Service Desk integration
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
default:
type: RULE
example:
type: "RULE"
id: "2c918085708c274401708c2a8a760001"
name: "Example Rule"
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- RULE
example: RULE
id:
type: string
description: ID of the rule
example: 2c91808568c529c60168cca6f90c1333
name:
type: string
description: Human-readable display name of the rule
example: Example Rule

180
static/api-specs/idn/v3/schemas/Source.yaml
View File

@@ -10,56 +10,141 @@ properties:
description: Human-readable description of the source
example: "This is the corporate directory."
owner:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
description: Reference to an owning Identity Object
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- IDENTITY
example: IDENTITY
id:
type: string
description: ID of the identity
example: 2c91808568c529c60168cca6f90c1313
name:
type: string
description: Human-readable display name of the identity
example: MyName
cluster:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
description: Reference to the associated Cluster
example:
type: "CLUSTER"
id: "2c9180866166b5b0016167c32ef31a66"
name: "Corporate Cluster"
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- CLUSTER
example: CLUSTER
id:
type: string
description: ID of the cluster
example: 2c9180866166b5b0016167c32ef31a66
name:
type: string
description: Human-readable display name of the cluster
example: Corporate Cluster
accountCorrelationConfig:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
description: Reference to a Correlation Config object
example:
type: "ACCOUNT_CORRELATION_CONFIG"
id: "2c9180855d191c59015d28583727245a"
name: "Directory [source-62867] Account Correlation"
description: Reference to an Account Correlation Config object
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- ACCOUNT_CORRELATION_CONFIG
example: ACCOUNT_CORRELATION_CONFIG
id:
type: string
description: ID of the account correlation config
example: 2c9180855d191c59015d28583727245a
name:
type: string
description: Human-readable display name of the account correlation config
example: Directory [source-62867] Account Correlation
accountCorrelationRule:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
description: >-
Reference to a Rule that can do COMPLEX the correlation, should only be used when accountCorrelationConfig can't
Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't
be used.
example:
type: "RULE"
id: "2c918085708c274401708c2a8a760001"
name: "Example Rule"
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- RULE
example: RULE
id:
type: string
description: ID of the rule
example: 2c918085708c274401708c2a8a760001
name:
type: string
description: Human-readable display name of the rule
example: Example Rule
managerCorrelationMapping:
$ref: '../../v3/schemas/ManagerCorrelationMapping.yaml'
description: >-
Filter Object used during manager correlation to match incoming manager values to an existing manager's
Account/Identity
managerCorrelationRule:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
description: >-
Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.
example:
type: "RULE"
id: "2c918085708c274401708c2a8a760001"
name: "Example Rule"
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- RULE
example: RULE
id:
type: string
description: ID of the rule
example: 2c918085708c274401708c2a8a760001
name:
type: string
description: Human-readable display name of the rule
example: Example Rule
beforeProvisioningRule:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
description: >-
Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.
example:
type: "RULE"
id: "2c918085708c274401708c2a8a760001"
name: "Example Rule"
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- RULE
example: RULE
id:
type: string
description: ID of the rule
example: 2c918085708c274401708c2a8a760001
name:
type: string
description: Human-readable display name of the rule
example: Example Rule
schemas:
type: array
items:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- CONNECTOR_SCHEMA
example: CONNECTOR_SCHEMA
id:
type: string
description: ID of the schema
example: 2c91808568c529c60168cca6f90c1777
name:
type: string
description: Human-readable display name of the schema
example: MySchema
description: >-
List of references to Schema objects
example:
@@ -72,13 +157,31 @@ properties:
passwordPolicies:
type: array
items:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- PASSWORD_POLICY
example: PASSWORD_POLICY
id:
type: string
description: ID of the policy
example: 2c91808568c529c60168cca6f90c1777
name:
type: string
description: Human-readable display name of the policy
example: My Password Policy
description: >-
List of references to the associated PasswordPolicy objects.
example:
- type: "PASSWORD_POLICY"
id: "2c9180855d191c59015d291ceb053980"
name: "Corporate Password Policy"
- type: "PASSWORD_POLICY"
id: "2c9180855d191c59015d291ceb057777"
name: "Vendor Password Policy"
features:
type: array
description: >-
@@ -131,8 +234,23 @@ properties:
When true indicates the source is referenced by an IdentityProfile.
example: false
managementWorkgroup:
$ref: '../../v3/schemas/BaseReferenceDto.yaml'
description: Reference to Management Workgroup for this Source
type: object
properties:
type:
description: The type of object being referenced
type: string
enum:
- GOVERNANCE_GROUP
example: GOVERNANCE_GROUP
id:
type: string
description: ID of the management workgroup
example: 2c91808568c529c60168cca6f90c2222
name:
type: string
description: Human-readable display name of the management workgroup
example: My Management Workgroup
healthy:
type: boolean
description: >-