Merge branch 'main' of github.com:sailpoint-oss/api-specs

idn/beta/paths/delete-lifecycle-state.yaml

@@ -28,7 +28,7 @@ delete:
       content:
         application/json:
           schema:
-            $ref: '../schemas/BaseReferenceDto.yaml'
+            $ref: '../../v3/schemas/LifecyclestateDeleted.yaml'
     '401':
       $ref: '../../v3/responses/401.yaml'
     '403':

idn/beta/paths/role-bulk-delete.yaml

@@ -26,7 +26,7 @@ post:
       content:
         application/json:
           schema:
-            $ref: '../../v3/schemas/BaseReferenceDto.yaml'
+            $ref: '../../v3/schemas/TaskResultDto.yaml'
           example:
             {
               "type": "TASK_RESULT",

idn/beta/paths/workgroups/workgroup-members.yaml

@@ -35,7 +35,23 @@ get:
           schema:
             type: array
             items:
-              $ref: "../../../v3/schemas/BaseReferenceDto.yaml"
+              type: object
+              description: Identity of workgroup member. 
+              properties:
+                type:
+                  type: string 
+                  description: Workgroup member identity DTO type. 
+                  enum: 
+                    - IDENTITY
+                  example: IDENTITY
+                id:
+                  type: string
+                  description: Workgroup member identity ID. 
+                  example: 2c7180a46faadee4016fb4e018c20642
+                name:
+                  type: string
+                  description: Workgroup member identity display name. 
+                  example: Michael Michaels
     '400':
       $ref: '../../../v3/responses/400.yaml'
     '401':

idn/beta/schemas/AccessItemOwnerDto.yaml

@@ -0,0 +1,17 @@
+type: object
+description: Access item owner's identity. 
+properties:
+  type:
+    type: string 
+    description: Access item owner's DTO type. 
+    enum: 
+      - IDENTITY
+    example: IDENTITY
+  id:
+    type: string
+    description: Access item owner's identity ID.
+    example: 2c9180a46faadee4016fb4e018c20639
+  name:
+    type: string
+    description: Access item owner's human-readable display name. 
+    example: Support

idn/beta/schemas/AccessItemRequestedForDto.yaml

@@ -0,0 +1,17 @@
+type: object
+description: Identity the access item is requested for.
+properties:
+  type:
+    type: string 
+    description: DTO type of identity the access item is requested for.
+    enum: 
+      - IDENTITY
+    example: IDENTITY
+  id:
+    type: string
+    description: ID of identity the access item is requested for. 
+    example: 2c4180a46faadee4016fb4e018c20626
+  name:
+    type: string
+    description: Human-readable display name of identity the access item is requested for. 
+    example: Robert Robinson

idn/beta/schemas/AccessItemRequesterDto.yaml

@@ -0,0 +1,17 @@
+type: object
+description: Access item requester's identity. 
+properties:
+  type:
+    type: string 
+    description: Access item requester's DTO type. 
+    enum: 
+      - IDENTITY
+    example: IDENTITY
+  id:
+    type: string
+    description: Access item requester's identity ID. 
+    example: 2c7180a46faadee4016fb4e018c20648
+  name:
+    type: string
+    description: Access item owner's human-readable display name. 
+    example: William Wilson

idn/beta/schemas/AccessReference.yaml

@@ -16,7 +16,7 @@ properties:
   type:
     $ref: '../../v3/schemas/RequestableObjectType.yaml'
   owner:
-    $ref: '../../v3/schemas/BaseReferenceDto.yaml'
+    $ref: './AccessItemOwnerDto.yaml'
   requestCommentsRequired:
     type: boolean
     description: If comments are required while requesting the access item.

idn/beta/schemas/ActivityDataSource.yaml

@@ -1,6 +1,6 @@
 description: A reference to the source of activity
 allOf:
-  - $ref: '../../v3/schemas/BaseReferenceDto.yaml'
+  - $ref: '../../v3/schemas/SourceDto.yaml'
   - type: object
     properties:
       integrationType:

idn/beta/schemas/ApplicationReference.yaml

@@ -14,4 +14,4 @@ properties:
     description: Description of the application.
     example: Access to research information, lab results, and schematics
   owner:
-    $ref: '../../v3/schemas/BaseReferenceDto.yaml'
+    $ref: './AccessItemOwnerDto.yaml'

idn/beta/schemas/AttrSyncSourceConfig.yaml

@@ -6,12 +6,7 @@ required:
   - attributes
 properties:
   source:
-    $ref: '../../v3/schemas/BaseReferenceDto.yaml'
-    description: Reference to the source which is the target of the attribute synchronization
-    example:
-      - type: 'SOURCE'
-        id: '2c9180835d191a86015d28455b4b232a'
-        name: 'HR Active Directory'
+    $ref: '../../v3/schemas/AttrSyncSource.yaml'
   attributes:
     type: array
     description: Attribute synchronization configuration for specific identity attributes in the context of a source

idn/beta/schemas/AttrSyncTenantSyncTarget.yaml

@@ -2,12 +2,7 @@
 type: object
 properties:
   source:
-    $ref: '../../v3/schemas/BaseReferenceDto.yaml'
-    description: Reference to the source which is the target of the attribute synchronization
-    example:
-      - type: 'SOURCE'
-        id: '2c9180835d191a86015d28455b4b232a'
-        name: 'HR Active Directory'
+    $ref: '../../v3/schemas/AttrSyncSource.yaml'
   attribute:
     type: string
     description: Name of the source account attribute to which the identity attribute values should be synchronized

idn/beta/schemas/BulkTaggedObject.yaml

@@ -8,7 +8,7 @@ properties:
     type: array
     items:
       type: string
-    description: Label to be applied to an Object
+    description: Label to be applied to object. 
     example: [ "BU_FINANCE", "PCI" ]
   operation:
     type: string

idn/beta/schemas/CertificationReference.yaml

@@ -1,15 +1,9 @@
-description: The previous certification
+description: Previous certification. 
 type: object
 allOf:
-- $ref: '../../v3/schemas/BaseReferenceDto.yaml'
+- $ref: '../../v3/schemas/CertificationReferenceDto.yaml'
 - type: object
   properties:
     reviewer:
       $ref: './Reviewer.yaml'
       description: Certification reviewer
-properties:
-  type:
-    description: The type of object that the reviewer is.
-    enum:
-    - "CERTIFICATION"
-    example: CERTIFICATION

idn/beta/schemas/CommentDto.yaml

@@ -1,4 +1,29 @@
 type: object
 properties:
   comment:
-    type: string
+    type: string
+    nullable: true
+    description: Comment content. 
+    example: This is a comment. 
+  author:
+    type: object
+    properties:
+      type:
+        type: string
+        description: DTO type of the commenting identity. 
+        enum: 
+          - IDENTITY
+        example: IDENTITY
+      id:
+        type: string
+        description: ID of the commenting identity. 
+        example: 2c91808568c529c60168cca6f90c1313
+      name:
+        type: string
+        description: Display name of the commenting identity. 
+        example: Adam Kennedy
+  created:
+    type: string
+    format: 'date-time'
+    description: Date and time comment was created.
+    example: '2017-07-11T18:45:37.098Z'

idn/beta/schemas/CompletedApproval.yaml

@@ -27,25 +27,40 @@ properties:
     $ref: '../../v3/schemas/AccessRequestType.yaml'
     description: If the access-request was for granting or revoking access.
   requester:
-    $ref: '../../v3/schemas/BaseReferenceDto.yaml'
-    description: The identity that requested the item.
+    $ref: './AccessItemRequesterDto.yaml'
   requestedFor:
-    $ref: '../../v3/schemas/BaseReferenceDto.yaml'
-    description: The identity for whom the item is requested for.
+    $ref: './AccessItemRequestedForDto.yaml'
   reviewedBy:
-    $ref: '../../v3/schemas/BaseReferenceDto.yaml'
-    description: The identity who has reviewed the approval.
+    type: object
+    description: Identity who reviewed the access item request. 
+    properties:
+      type:
+        type: string 
+        description: DTO type of identity who reviewed the access item request. 
+        enum: 
+          - IDENTITY
+        example: IDENTITY
+      id:
+        type: string
+        description: ID of identity who reviewed the access item request. 
+        example: 2c3780a46faadee4016fb4e018c20652
+      name:
+        type: string
+        description: Human-readable display name of identity who reviewed the access item request. 
+        example: Allen Albertson
   owner:
-    $ref: '../../v3/schemas/BaseReferenceDto.yaml'
-    description: The owner or approver of the approval.
+    $ref: './AccessItemOwnerDto.yaml'
   requestedObject:
     $ref: './RequestableObjectReference.yaml'
     description: The requested access item.
   requesterComment:
     $ref: '../../v3/schemas/CommentDto.yaml'
     description: The requester's comment.
   reviewerComment:
-    $ref: '../../v3/schemas/CommentDto.yaml'
+    allOf:
+      - $ref: './CommentDto.yaml'
+    type: object
+    nullable: true 
     description: The approval's reviewer's comment.
   previousReviewersComments:
     type: array
@@ -66,6 +81,7 @@ properties:
     description: The final state of the approval
   removeDate:
     type: string
+    nullable: true
     description: The date the role or access profile is no longer assigned to the specified identity.
     format: 'date-time'
     example: '2020-07-11T00:00:00Z'
@@ -75,6 +91,7 @@ properties:
     description: If true, then the request was to change the remove date or sunset date.
   currentRemoveDate:
     type: string
+    nullable: true
     description: The remove date or sunset date that was assigned at the time of the request.
     format: 'date-time'
     example: '2020-07-11T00:00:00Z'

idn/beta/schemas/ConfigObject.yaml

@@ -7,7 +7,7 @@ properties:
     description: Current version of configuration object.
     example: 1
   self:
-    $ref: '../../v3/schemas/BaseReferenceDto.yaml'
+    $ref: '../../v3/schemas/SelfImportExportDto.yaml'
   object:
     description: Object details. Format dependant on the object type.
     additionalProperties: true

idn/beta/schemas/CreatePersonalAccessTokenResponse.yaml

@@ -21,8 +21,7 @@ properties:
     description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.
     example: "NodeJS Integration"
   owner:
-    $ref: '../../v3/schemas/BaseReferenceDto.yaml'
-    description: Details about the owner of the personal access token.
+    $ref: '../../v3/schemas/PatOwner.yaml'
   created:
     type: string
     format: 'date-time'

idn/beta/schemas/EntitlementDto.yaml

@@ -28,9 +28,4 @@ allOf:
         description: Determines if this Entitlement is goverened in the cloud.
         type: boolean
       source:
-        $ref: '../../v3/schemas/BaseReferenceDto.yaml'
-        description: Reference to the source this entitlment belongs to.
-        example:
-          - type: 'SOURCE'
-            id: '2c9180835d191a86015d28455b4b232a'
-            name: 'HR Active Directory'
+        $ref: '../../v3/schemas/EntitlementSource.yaml'

idn/beta/schemas/EntitlementRef.yaml

@@ -0,0 +1,17 @@
+type: object
+description: Entitlement including a specific set of access.
+properties:
+  type:
+    type: string 
+    description: Entitlement's DTO type. 
+    enum: 
+      - ENTITLEMENT
+    example: ENTITLEMENT
+  id:
+    type: string
+    description: Entitlement's ID. 
+    example: 2c91809773dee32014e13e122092014e
+  name:
+    type: string
+    description: Entitlement's display name. 
+    example: "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"

idn/beta/schemas/GetPersonalAccessTokenResponse.yaml

@@ -17,8 +17,7 @@ properties:
     description: Scopes of the personal  access token.
     example: [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ]
   owner:
-    $ref: '../../v3/schemas/BaseReferenceDto.yaml'
-    description: Details about the owner of the personal access token.
+    $ref: '../../v3/schemas/PatOwner.yaml'
   created:
     type: string
     format: 'date-time'

idn/beta/schemas/Identity.yaml

@@ -36,7 +36,23 @@ allOf:
           - LOCKED
         example: LOCKED
       managerRef:
-        $ref: '../../v3/schemas/BaseReferenceDto.yaml'
+        type: object
+        description: Identity's manager.
+        properties:
+          type:
+            type: string 
+            description: DTO type of identity's manager. 
+            enum: 
+              - IDENTITY
+            example: IDENTITY
+          id:
+            type: string
+            description: ID of identity's manager. 
+            example: 2c4180a46faadee4016fb4e018c20626
+          name:
+            type: string
+            description: Human-readable display name of identity's manager.
+            example: Robert Robinson
       isManager:
         type: boolean
         description: Whether this identity is a manager of another identity

idn/beta/schemas/IdentityEntitlements.yaml

@@ -1,10 +1,10 @@
 type: object
 properties:
   objectRef:
-    $ref: '../../v3/schemas/BaseReferenceDto.yaml'
+    $ref: '../../v3/schemas/TaggedObjectDto.yaml'
   tags:
     type: array
     items:
       type: string
-    description: Labels to be applied to an Object
+    description: Labels to be applied to object.
     example: [ "BU_FINANCE", "PCI" ]