Automated commit 'Merge pull request #1544 from sailpoint/devrel-1422

devrel-1422' by github action: 7759597013

idn/v3/schemas/AuthUser.yaml

@@ -75,7 +75,6 @@ properties:
         - CERT_ADMIN
         - CLOUD_GOV_ADMIN
         - CLOUD_GOV_USER
-        - DASHBOARD
         - HELPDESK
         - ORG_ADMIN
         - REPORT_ADMIN

idn/v3/schemas/search/model/access/BaseAccess.yaml

@@ -4,24 +4,66 @@ allOf:
     properties:
       description:
         type: string
-        description: The description of the access item
+        description: Access item's description. 
         example: "The admin role"
       created:
-        $ref: "../base/DateTime.yaml"
+        type: string
+        description: ISO-8601 date-time referring to the time when the object was created. 
+        nullable: true
+        format: 'date-time'
+        example: '2018-06-25T20:22:28.104Z'
       modified:
-        $ref: "../base/DateTime.yaml"
+        type: string
+        description: ISO-8601 date-time referring to the time when the object was last modified. 
+        nullable: true
+        format: 'date-time'
+        example: '2018-06-25T20:22:28.104Z'
       synced:
-        $ref: "../base/DateTime.yaml"
+        type: string
+        description: >-
+          ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.  
+
+          This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. 
+
+          There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. 
+        nullable: true
+        format: 'date-time'
+        example: '2018-06-25T20:22:33.104Z'
       enabled:
         type: boolean
+        description: Indicates whether the access item is currently enabled. 
+        default: false
         example: true
       requestable:
         type: boolean
+        description: Indicates whether the access item can be requested.
+        default: true
         example: true
-        description: Indicates if the access can be requested
       requestCommentsRequired:
         type: boolean
-        description: Indicates if comments are required when requesting access
+        description: Indicates whether comments are required for requests to access the item. 
+        default: false
         example: false
       owner:
-        $ref: "../identity/Owner.yaml"
+        type: object
+        description: Owner's identity. 
+        properties:
+          type:
+            type: string 
+            description: Owner's DTO type. 
+            enum: 
+              - IDENTITY
+            example: IDENTITY
+          id:
+            type: string
+            description: Owner's identity ID.
+            example: 2c9180a46faadee4016fb4e018c20639
+          name:
+            type: string
+            description: Owner's display name. 
+            example: Support
+          email: 
+            type: string
+            description: Owner's email. 
+            example: [email protected]
+

idn/v3/schemas/search/model/access/profile/AccessProfileDocument.yaml

@@ -1,18 +1,56 @@
 description: >- 
-  This is more of a complete representation of an access profile.  
+  More complete representation of an access profile.  
 allOf:
-- $ref: '../../base/BaseDocument.yaml'
 - $ref: '../BaseAccess.yaml'
 - type: object
+  required: ["id", "name", "_type"]
   properties:
+    id: 
+      type: string
+      description: Access profile's ID. 
+      example: 2c9180825a6c1adc015a71c9023f0818
+    name: 
+      type: string
+      description: Access profile's name. 
+      example: Cloud Eng
+    _type: 
+      description: >-
+        Access profile's document type. 
+
+        This enum represents the currently supported document types.
+      
+        Additional values may be added in the future without notice.
+      type: string
+      enum:
+        - accessprofile
+        - accountactivity
+        - account
+        - aggregation
+        - entitlement
+        - event
+        - identity
+        - role
+      example: accessprofile
     source:
-      $ref: '../../base/Reference.yaml'
+      type: object
+      description: Access profile's source. 
+      properties: 
+        id: 
+          type: string
+          description: Source's ID. 
+          example: ff8081815757d4fb0157588f3d9d008f
+        name: 
+          type: string
+          description: Source's name. 
+          example: Employees
     entitlements:
       type: array
+      description: Entitlements the access profile has access to. 
       items:
         $ref: '../../entitlement/BaseEntitlement.yaml'
     entitlementCount:
       type: integer
+      description: Number of entitlements. 
       example: 5
     tags:
       $ref: '../../base/Tags.yaml'

idn/v3/schemas/search/model/account/AccountSource.yaml

@@ -5,4 +5,4 @@ allOf:
     type:
       type: string
       example: Delimited File
-      description: the type of source returned
+      description: Type of source returned.

idn/v3/schemas/search/model/account/BaseAccount.yaml

@@ -4,36 +4,44 @@ allOf:
     properties:
       accountId:
         type: string
-        description: The ID of the account
-        example: "john.doe"
+        description: Account ID.
+        example: John.Doe
       source:
         $ref: "AccountSource.yaml"
       disabled:
         type: boolean
-        description: Indicates if the account is disabled
+        description: Indicates whether the account is disabled.
+        default: false
         example: false
       locked:
         type: boolean
-        description: Indicates if the account is locked
+        description: Indicates whether the account is locked.
+        default: false
         example: false
       privileged:
         type: boolean
+        description: Indicates whether the account is privileged. 
+        default: false
         example: false
       manuallyCorrelated:
         type: boolean
-        description:
-          Indicates if the account has been manually correlated to an identity
+        description: Indicates whether the account has been manually correlated to an identity.
+        default: false
         example: false
       passwordLastSet:
         $ref: "../base/DateTime.yaml"
       entitlementAttributes:
         type: object
         nullable: true
-        description: "a map or dictionary of key/value pairs"
+        description: Map or dictionary of key/value pairs.
         additionalProperties: true
         example:
           moderator: true
           admin: true
           trust_level: "4"
       created:
-        $ref: "../base/DateTime.yaml"
+        type: string
+        description: ISO-8601 date-time referring to the time when the object was created. 
+        nullable: true
+        format: 'date-time'
+        example: '2018-06-25T20:22:28.104Z'

idn/v3/schemas/search/model/account/activity/AccountActivityDocument.yaml

@@ -5,62 +5,79 @@ allOf:
     properties:
       action:
         type: string
-        description: The type of action that this activity performed
+        description: Type of action performed in the activity. 
         externalDocs:
           description: Learn more about account activity action types
           url: https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data
         example: Identity Refresh.
       created:
-        $ref: "../../base/DateTime.yaml"
+        type: string
+        description: ISO-8601 date-time referring to the time when the object was created. 
+        nullable: true
+        format: 'date-time'
+        example: '2018-06-25T20:22:28.104Z'
       modified:
-        $ref: "../../base/DateTime.yaml"
+        type: string
+        description: ISO-8601 date-time referring to the time when the object was last modified. 
+        nullable: true
+        format: 'date-time'
+        example: '2018-06-25T20:22:28.104Z'
       stage:
         type: string
-        description: The current stage of the activity
+        description: Activity's current stage. 
         example: Completed
       origin:
         type: string
+        description: Activity's origin. 
         nullable: true
         example: null
       status:
         type: string
-        description: the current status of the activity
+        description: Activity's current status. 
         example: Complete
       requester:
         $ref: "../AccountSource.yaml"
       recipient:
         $ref: "../AccountSource.yaml"
       trackingNumber:
         type: string
+        description: Account activity's tracking number. 
         example: 61aad0c9e8134eca89e76a35e0cabe3f
       errors:
         type: array
+        description: Errors provided by the source while completing account actions. 
         items:
           type: string
         nullable: true
         example: null
       warnings:
         type: array
+        description: Warnings provided by the source while completing account actions. 
         items:
           type: string
         nullable: true
         example: null
       approvals:
         type: array
+        description: Approvals performed on an item during activity. 
         items:
           $ref: "Approval.yaml"
       originalRequests:
         type: array
+        description: Original actions that triggered all individual source actions related to the account action. 
         items:
           $ref: "OriginalRequest.yaml"
       expansionItems:
         type: array
+        description: Controls that translated the attribute requests into actual provisioning actions on the source. 
         items:
           $ref: "ExpansionItem.yaml"
       accountRequests:
         type: array
+        description: Account data for each individual source action triggered by the original requests. 
         items:
           $ref: "AccountRequest.yaml"
       sources:
         type: string
+        description: Sources involved in the account activity. 
         example: "smartsheet-test, airtable-v4, IdentityNow"

idn/v3/schemas/search/model/account/activity/AttributeRequest.yaml

@@ -2,13 +2,13 @@ type: object
 properties:
   name:
     type: string
-    description: The attribute name
+    description: Attribute name. 
     example: groups
   op:
     type: string
-    description: The operation to perform
+    description: Operation to perform on attribute. 
     example: Add
   value:
     type: string
-    description: The value of the attribute
+    description: Value of attribute.
     example: "3203537556531076"

idn/v3/schemas/search/model/account/activity/OriginalRequest.yaml

@@ -2,15 +2,17 @@ type: object
 properties:
   accountId:
     type: string
-    description: the account id
+    description: Account ID. 
     example: CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com
   attributeRequests:
     type: array
+    description: Attribute changes requested for account. 
     items:
       $ref: 'AttributeRequest.yaml'
   op:
     type: string
-    description: the operation that was used
+    description: Operation used. 
     example: add
   source:
+    description: Account's source. 
     $ref: '../AccountSource.yaml'

idn/v3/schemas/search/model/base/BaseAccessProfile.yaml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  id:
+    type: string
+    example: 2c91809c6faade77016fb4f0b63407ae
+    description: Access profile's unique ID. 
+  name:
+    type: string
+    example: Admin Access
+    description: Access profile's display name. 

idn/v3/schemas/search/model/base/BaseSegment.yaml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  id:
+    type: string
+    example: b009b6e3-b56d-41d9-8735-cb532ea0b017
+    description: Segment's unique ID. 
+  name:
+    type: string
+    example: Test Segment
+    description: Segment's display name. 

idn/v3/schemas/search/model/base/Tags.yaml

@@ -1,4 +1,5 @@
 type: array
+description: Tags that have been applied to the object.
 items:
   type: string
 example: