Automated commit by github action: 3329814523

static/api-specs/idn/beta/paths/source.yaml

@@ -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

static/api-specs/idn/beta/schemas/ProvisioningConfig.yaml

@@ -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'
+      type: object
-      default:
+      properties:
-        type: SOURCE
+        type:
-    example: []
+          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>

static/api-specs/idn/beta/schemas/ServiceDeskIntegrationDto.yaml

@@ -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'
+        type: object
-        default:
+        properties:
-          type: IDENTITY
+          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'
+        type: object
-        default:
+        properties:
-          type: CLUSTER
+          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'
+        type: object
-        default:
+        properties:
-          type: RULE
+          type:
-        example:
+            description: The type of object being referenced
-          type: "RULE"
+            type: string
-          id: "2c918085708c274401708c2a8a760001"
+            enum:
-          name: "Example Rule"
+              - 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

static/api-specs/idn/beta/schemas/Source.yaml

@@ -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: object
-      type: "CLUSTER"
+    properties:
-      id: "2c9180866166b5b0016167c32ef31a66"
+      type:
-      name: "Corporate Cluster"
+        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 an Account Correlation Config object
-    description: Reference to a Correlation Config object
+    type: object
-    example:
+    properties:
-      type: "ACCOUNT_CORRELATION_CONFIG"
+      type:
-      id: "2c9180855d191c59015d28583727245a"
+        description: The type of object being referenced
-      name: "Directory [source-62867] Account Correlation"
+        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: object
-      type: "RULE"
+    properties:
-      id: "2c918085708c274401708c2a8a760001"
+      type:
-      name: "Example Rule"
+        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.
+      Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.
-    example:
+    type: object
-      type: "RULE"
+    properties:
-      id: "2c918085708c274401708c2a8a760001"
+      type:
-      name: "Example Rule"
+        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.
+      Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.
-    example:
+    type: object
-      type: "RULE"
+    properties:
-      id: "2c918085708c274401708c2a8a760001"
+      type:
-      name: "Example Rule"
+        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: >-

static/api-specs/idn/v3/paths/source.yaml

@@ -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

static/api-specs/idn/v3/schemas/ProvisioningConfig.yaml

@@ -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'
+      type: object
-      default:
+      properties:
-        type: SOURCE
+        type:
-    example: []
+          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>

static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml

@@ -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'
+        type: object
-        default:
+        properties:
-          type: IDENTITY
+          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'
+        type: object
-        default:
+        properties:
-          type: CLUSTER
+          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'
+        type: object
-        default:
+        properties:
-          type: RULE
+          type:
-        example:
+            description: The type of object being referenced
-          type: "RULE"
+            type: string
-          id: "2c918085708c274401708c2a8a760001"
+            enum:
-          name: "Example Rule"
+              - 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

static/api-specs/idn/v3/schemas/Source.yaml

@@ -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: object
-      type: "CLUSTER"
+    properties:
-      id: "2c9180866166b5b0016167c32ef31a66"
+      type:
-      name: "Corporate Cluster"
+        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 an Account Correlation Config object
-    description: Reference to a Correlation Config object
+    type: object
-    example:
+    properties:
-      type: "ACCOUNT_CORRELATION_CONFIG"
+      type:
-      id: "2c9180855d191c59015d28583727245a"
+        description: The type of object being referenced
-      name: "Directory [source-62867] Account Correlation"
+        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: object
-      type: "RULE"
+    properties:
-      id: "2c918085708c274401708c2a8a760001"
+      type:
-      name: "Example Rule"
+        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: object
-      type: "RULE"
+    properties:
-      id: "2c918085708c274401708c2a8a760001"
+      type:
-      name: "Example Rule"
+        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: object
-      type: "RULE"
+    properties:
-      id: "2c918085708c274401708c2a8a760001"
+      type:
-      name: "Example Rule"
+        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: >-