Automated commit 'Merge pull request #1920 from sailpoint/devrel-1932

update to fix issues with SDK documentation' by github action: 12417644319

idn/beta/paths/ears-entitlement-bulk-update.yaml

@@ -3,7 +3,7 @@ post:
   tags:
     - Entitlements
   summary: Bulk update an entitlement list
-  description: >-
+  description: |
     This API applies an update to every entitlement of the list.
 
 
@@ -12,8 +12,8 @@ post:
 
     The JsonPatch update follows the [JSON
     Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations :
-    **{ "op": "replace", "path": "/privileged", "value": boolean }**  **{ "op":
-    "replace", "path": "/requestable","value": boolean }** 
+    `**{ "op": "replace", "path": "/privileged", "value": boolean }**  **{ "op":
+    "replace", "path": "/requestable","value": boolean }**`
 
 
     A token with ORG_ADMIN or API authority is required to call this API.

idn/beta/paths/sp-config-import-status.yaml

@@ -2,17 +2,15 @@ get:
   operationId: getSpConfigImportStatus
   security:
     - userAuth: [ sp:config:manage ]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
   tags:
     - SP-Config
   summary: Get import job status
   description: >-
     This gets the status of the import job identified by the `id` parameter.
 
     For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
-
-    The request will need the following security scope:
-
-    - sp:config:manage
   parameters:
     - in: path
       name: id

idn/beta/paths/sp-config-import.yaml

@@ -1,33 +1,32 @@
 post:
   operationId: importSpConfig
-  # security:
-  #   - oauth2: [sp:config:import]
+  security:
+  - userAuth:
+    - sp:config:manage
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
   tags:
     - SP-Config
   summary: Initiates configuration objects import job
-  description: >-
+  description: |
     This post will import objects from a JSON configuration file into a tenant.
     By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted.
     The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed.
     The backup can be skipped by setting "excludeBackup" to true in the import options.
     If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded 
-    using the /sp-config/export/{exportJobId}/download endpoint.
+    using the `/sp-config/export/{exportJobId}/download` endpoint.
 
     You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. 
 
     For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
-
-    The request will need the following security scope:
-
-    - sp:config:manage
   parameters:
     - in: query
       name: preview
       schema:
         type: boolean
         default: false
       required: false
-      description: >-
+      description: |
         This option is intended to give the user information about how an import operation would proceed, without
         having any effect on the target tenant.
         If this parameter is "true", no objects will be imported. Instead, the import process will pre-process the import file and

idn/beta/paths/suggested-entitlement-description-batches-stats.yaml

@@ -3,10 +3,10 @@ get:
     - Suggested Entitlement Description
   operationId: getSedBatchStats
   summary: Submit Sed Batch Stats Request
-  description: >-
+  description: |
     Submit Sed Batch Stats Request.
 
-    Submits batchId in the path param (e.g. {batchId}/stats).
+    Submits batchId in the path param `(e.g. {batchId}/stats)`.
     API responses with stats of the batchId.
   parameters:
     - name: batchId

idn/beta/schemas/CustomPasswordInstruction.yaml

@@ -2,6 +2,7 @@ type: object
 properties:
   pageId:
     type: string
+    example: change-password:enter-password
     description: The page ID that represents the page for forget user name, reset password and unlock account flow.
     enum:
       - change-password:enter-password
@@ -18,10 +19,11 @@ properties:
       - unlock-account:finish
   pageContent:
     type: string
-    description: >-
+    example: "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter."
+    description: |
       The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks.
-      If the customization text includes a link, like <A HREF=\"URL\">...</A> clicking on this will open the link on the current browser page.
-      If you want your link to be redirected to a different page, please redirect it to "_blank" like this: <a href=\"URL" target=\"_blank\" >link</a>. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target.
+      If the customization text includes a link, like `<A HREF=\"URL\">...</A>` clicking on this will open the link on the current browser page.
+      If you want your link to be redirected to a different page, please redirect it to "_blank" like this: `<a href=\"URL" target=\"_blank\" >link</a>`. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target.
   locale:
     type: string
     example: en

idn/beta/schemas/SlimCampaign.yaml

@@ -11,14 +11,14 @@ properties:
     description: Id of the campaign
     example: 2c9079b270a266a60170a2779fcb0007
   name:
-    description: >-
+    description: |
       The campaign name. If this object is part of a template, special formatting applies; see the
       `/campaign-templates/{id}/generate` endpoint documentation for details.
     type: string
     example: Manager Campaign
   description:
     type: string
-    description: >-
+    description: |
       The campaign description. If this object is part of a template, special formatting applies; see the
       `/campaign-templates/{id}/generate` endpoint documentation for details.
     example: Everyone needs to be reviewed by their manager
@@ -49,7 +49,7 @@ properties:
     example: false
   recommendationsEnabled:
     type: boolean
-    description: >-
+    description: |
       Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off
       then campaigns generated from this template will indicate false. The real value will then be returned if
       IAI is ever enabled for the org in the future.
@@ -72,7 +72,7 @@ properties:
     example: ACTIVE
   correlatedStatus:
     type: string
-    description: >-
+    description: |
       The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated.
       An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).
     enum:

idn/beta/schemas/app/AccessProfileDetails.yaml

@@ -96,15 +96,15 @@ properties:
     ]
   approvalSchemes:
     type: string
-    description: >-
+    description: |
       Comma-separated list of approval schemes. Each approval scheme is one of -
-      manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId>
+      manager - appOwner - sourceOwner - accessProfileOwner - workgroup:&lt;workgroupId&gt;
     example: accessProfileOwner
   revokeRequestApprovalSchemes:
     type: string
-    description: >-
+    description: |
       Comma-separated list of revoke request approval schemes. Each approval
-      scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId>
+      scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:&lt;workgroupId&gt;
     example: accessProfileOwner
   requestCommentsRequired:
     type: boolean

idn/v2024/paths/ears-entitlement-bulk-update.yaml

@@ -7,12 +7,13 @@ post:
     - userAuth: []
   x-sailpoint-userLevels:
     - ORG_ADMIN
-  description: "This API applies an update to every entitlement of the list.\n\nThe\
+  description: |
+   "This API applies an update to every entitlement of the list.\n\nThe\
     \ number of entitlements to update is limited to 50 items maximum.\n\nThe JsonPatch\
     \ update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\
-    \ allowed operations : **{ \"op\": \"replace\", \"path\": \"/privileged\", \"\
+    \ allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"\
     value\": boolean }**  **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\"\
-    : boolean }**"
+    : boolean }**`"
   requestBody:
     required: true
     content:

idn/v2024/paths/sp-config-import-status.yaml

@@ -3,17 +3,16 @@ get:
   security:
   - userAuth:
     - sp:config:manage
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
   tags:
   - SP-Config
   summary: Get import job status
-  description: 'This gets the status of the import job identified by the `id` parameter.
+  description: |
+   'This gets the status of the import job identified by the `id` parameter.
 
     For more information about the object types that currently support import functionality,
-    refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
-
-    The request will need the following security scope:
-
-    - sp:config:manage'
+    refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).'
   parameters:
   - in: path
     name: id

idn/v2024/paths/sp-config-import.yaml

@@ -1,29 +1,35 @@
 post:
   operationId: importSpConfig
+  security:
+  - userAuth:
+    - sp:config:manage
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
   tags:
   - SP-Config
   summary: Initiates configuration objects import job
-  description: "This post will import objects from a JSON configuration file into\
+  description: |
+   "This post will import objects from a JSON configuration file into\
     \ a tenant. By default, every import will first export all existing objects supported\
     \ by sp-config as a backup before the import is attempted. The backup is provided\
     \ so that the state of the configuration prior to the import is available for\
     \ inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\"\
     \ to true in the import options. If a backup is performed, the id of the backup\
     \ will be provided in the ImportResult as the \"exportJobId\". This can be downloaded\
-    \  using the /sp-config/export/{exportJobId}/download endpoint.\nYou cannot currently\
+    \  using the `/sp-config/export/{exportJobId}/download` endpoint.\nYou cannot currently\
     \ import from the Non-Employee Lifecycle Management (NELM) source. You cannot\
     \ use this endpoint to back up or store NELM data. \nFor more information about\
     \ the object types that currently support import functionality, refer to [SaaS\
-    \ Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).\n\
-    The request will need the following security scope:\n- sp:config:manage"
+    \ Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects)."
   parameters:
   - in: query
     name: preview
     schema:
       type: boolean
       default: false
     required: false
-    description: This option is intended to give the user information about how an
+    description: |
+      This option is intended to give the user information about how an
       import operation would proceed, without having any effect on the target tenant.
       If this parameter is "true", no objects will be imported. Instead, the import
       process will pre-process the import file and attempt to resolve references within
@@ -40,7 +46,8 @@ post:
       default: true
     required: true
   requestBody:
-    description: "The form-data \"name\" attribute for the file content must be \"\
+    description: |
+     "The form-data \"name\" attribute for the file content must be \"\
       data\".\n\n__Example__\n\n    data: \"config_export_0340b957-5caa-44f6-ada2-d3c4c5bd0b19.json\"\
       ,\n    options: {\n      \"excludeTypes\": [],\n      \"includeTypes\": [\"\
       TRIGGER_SUBSCRIPTION\"],\n      \"objectOptions\": {\n        \"TRIGGER_SUBSCRIPTION\"\

idn/v2024/paths/suggested-entitlement-description-batches-stats.yaml

@@ -3,9 +3,10 @@ get:
   - Suggested Entitlement Description
   operationId: getSedBatchStats
   summary: Submit Sed Batch Stats Request
-  description: 'Submit Sed Batch Stats Request.
+  description: |
+   'Submit Sed Batch Stats Request.
 
-    Submits batchId in the path param (e.g. {batchId}/stats). API responses with stats
+    Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats
     of the batchId.'
   parameters:
   - name: batchId

idn/v2024/schemas/app/AccessProfileDetails.yaml

@@ -96,15 +96,15 @@ properties:
     ]
   approvalSchemes:
     type: string
-    description: >-
+    description: |
       Comma-separated list of approval schemes. Each approval scheme is one of -
-      manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId>
+      manager - appOwner - sourceOwner - accessProfileOwner - workgroup:&lt;workgroupId&gt;
     example: accessProfileOwner
   revokeRequestApprovalSchemes:
     type: string
-    description: >-
+    description: |
       Comma-separated list of revoke request approval schemes. Each approval
-      scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId>
+      scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:&lt;workgroupId&gt;
     example: accessProfileOwner
   requestCommentsRequired:
     type: boolean

idn/v3/paths/access-requests.yaml

@@ -47,7 +47,11 @@ post:
           $ref: '../schemas/AccessRequest.yaml'
   responses:
     '202':
-      $ref: '../responses/202.yaml'
+      description: Access Request Response.
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/access-requests/AccessRequestResponse.yaml'
     '400':
       $ref: '../responses/400.yaml'
     '401':

idn/v3/paths/auth-org-lockout-config.yaml

@@ -5,6 +5,8 @@ get:
   summary: Get Auth Org Lockout Configuration.
   description: >-
     This API returns the details of an org's lockout auth configuration.
+  security:
+    - userAuth: [ sp:auth-org:read ]
   responses:
     "200":
       description: Lockout configuration for the tenant's auth org.
@@ -24,16 +26,18 @@ get:
       $ref: "../../v3/responses/429.yaml"
     "500":
       $ref: "../../v3/responses/500.yaml"
-  security:
-    - userAuth: [sp:auth-org:read]
 patch:
   operationId: patchAuthOrgLockoutConfig
   tags:
     - Global Tenant Security Settings
   summary: Update Auth Org Lockout Configuration
-  description: >-
+  description: |
     This API updates an existing lockout configuration for an org using PATCH
-     Requires security scope of:  'sp:auth-org:update'
+  security:
+    - userAuth: [ sp:auth-org:manage ]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - HELPDESK
   requestBody:
     required: true
     description: >-
@@ -42,9 +46,9 @@ patch:
 
       Ensures that the patched Lockout Config conforms to certain logical
       guidelines, which are:
-        1. maximumAttempts >= 1 && maximumAttempts <= 15
+        `1. maximumAttempts >= 1 && maximumAttempts <= 15
         2. lockoutDuration >= 5 && lockoutDuration <= 60
-        3. lockoutWindow >= 5 && lockoutDuration <= 60
+        3. lockoutWindow >= 5 && lockoutDuration <= 60`
     content:
       application/json-patch+json:
         schema:
@@ -77,5 +81,3 @@ patch:
       $ref: "../../v3/responses/429.yaml"
     "500":
       $ref: "../../v3/responses/500.yaml"
-  security:
-   - userAuth: []

idn/v3/paths/auth-org-network-config.yaml

@@ -5,7 +5,6 @@ get:
   summary: Get security network configuration.
   description: >-
     This API returns the details of an org's network auth configuration.
-    Requires security scope of: 'sp:auth-org:read'
   security:
     - userAuth: [ sp:auth-org:read ]
   responses: