Automated commit by github action: 12437878037

static/api-specs/idn/sailpoint-api.v3.yaml

@@ -412,9 +412,13 @@ tags:
 
       Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states.
   - name: Managed Clients
-    description: Read and create operations for client data and statuses
+    description: |
+      Use this API to implement managed client functionality. 
+      With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. 
   - name: Managed Clusters
-    description: Read and create pperations for client Clusters, including Log Configuration
+    description: |
+      Use this API to implement managed cluster functionality. 
+      With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones. 
   - name: MFA Configuration
     description: Configure and test multifactor authentication (MFA) methods
   - name: MFA Controller

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

@@ -4,7 +4,7 @@ get:
     - Accounts
   summary: Accounts List
   description: >-
-    This returns a list of accounts.  
+    List accounts. 
   security:
     - userAuth: [idn:accounts:read]
   x-sailpoint-userLevels:
@@ -16,6 +16,15 @@ get:
     - $ref: "../parameters/limit.yaml"
     - $ref: "../parameters/offset.yaml"
     - $ref: "../parameters/count.yaml"
+    - in: query
+      name: detailLevel
+      schema:
+        type: string
+        enum: [ SLIM, FULL ]
+      description: >-
+        This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list.
+        `FULL` is the default behavior.
+      example: FULL
     - in: query
       name: filters
       schema:
@@ -91,7 +100,7 @@ get:
         Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType**
   responses:
     "200":
-      description: List of account objects
+      description: List of account objects.
       content:
         application/json:
           schema:
@@ -114,7 +123,7 @@ post:
     - Accounts
   summary: Create Account
   description: |
-    This API submits an account creation task and returns the task ID.  
+    Submit an account creation task - the API then returns the task ID.  
 
     You must include the `sourceId` where the account will be created in the `attributes` object.
 
@@ -139,7 +148,7 @@ post:
           $ref: "../schemas/AccountAttributesCreate.yaml"
   responses:
     "202":
-      description: Async task details
+      description: Async task details.
       content:
         application/json:
           schema:

static/api-specs/idn/v3/paths/managed-client.yaml

@@ -1,21 +1,21 @@
 get:
   tags:
     - Managed Clients
-  summary: Get a Managed Client
+  summary: Get Managed Client
   description: >-
-    Get a Managed Client.
+    Get managed client by ID. 
   operationId: getManagedClient
   parameters:
     - name: id
       in: path
-      description: Managed Client ID.
+      description: Managed client ID.
       required: true
       example: 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7
       schema:
         type: string
   responses:
     "200":
-      description: Responds with a Managed Client
+      description: Managed client response. 
       content:
         application/json:
           schema:
@@ -34,6 +34,8 @@ get:
       $ref: '../../v3/responses/500.yaml'
   security:
     - userAuth: [idn:remote-client:read, idn:remote-client:manage, idn:managed-client-status:read, idn:managed-client-status:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
 patch:
   tags:
     - Managed Clients
@@ -79,6 +81,8 @@ patch:
       $ref: '../../v3/responses/500.yaml'
   security:
     - userAuth: [idn:remote-client:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
 delete:
   operationId: deleteManagedClient
   tags:
@@ -97,7 +101,7 @@ delete:
   responses:
     '204':
       $ref: '../../v3/responses/204.yaml'
-      description: Managed Client was successfully deleted.
+      description: Managed client was successfully deleted.
     '400':
       $ref: '../../v3/responses/400.yaml'
     '401':
@@ -110,3 +114,5 @@ delete:
       $ref: '../../v3/responses/500.yaml'
   security:
     - userAuth: [idn:remote-client:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN

static/api-specs/idn/v3/paths/managed-clients.yaml

@@ -30,6 +30,7 @@ get:
 
 
         **clusterId**: *eq*
+      required: false
       example: name eq "client name"
   responses:
     "200":
@@ -52,6 +53,8 @@ get:
       $ref: '../../v3/responses/500.yaml'
   security:
     - userAuth: [idn:remote-client:read, idn:remote-client:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
 post:
   tags:
     - Managed Clients
@@ -69,7 +72,7 @@ post:
           $ref: '../schemas/ManagedClientRequest.yaml'
   responses:
     "200":
-      description: Created ManagedClient.
+      description: Created managed client.
       content:
         application/json:
           schema:
@@ -86,3 +89,5 @@ post:
       $ref: '../../v3/responses/500.yaml'
   security:
     - userAuth: [idn:remote-client:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN

static/api-specs/idn/v3/paths/managed-cluster-log-config.yaml

@@ -1,21 +1,21 @@
 get:
   tags:
     - Managed Clusters
-  summary: Get Managed Cluster's log configuration
-  description: Get managed cluster's log configuration.
+  summary: Get Managed Cluster Log Configuration
+  description: Get a managed cluster's log configuration.
   operationId: getClientLogConfiguration
   parameters:
     - name: id
       in: path
-      description: ID of ManagedCluster to get log configuration for
+      description: ID of managed cluster to get log configuration for.
       required: true
       schema:
         type: string
         format: uuid
       example: 2b838de9-db9b-abcf-e646-d4f274ad4238
   responses:
     "200":
-      description: Log configuration of ManagedCluster matching given cluster ID
+      description: Log configuration of managed cluster for given cluster ID.
       content:
         application/json:
           schema:
@@ -41,20 +41,20 @@ get:
 put:
   tags:
     - Managed Clusters
-  summary: Update Managed Cluster's log configuration
-  description: Update managed cluster's log configuration.  Only one of `durationMinutes` or `expiration` may be specified, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` will be 240.
+  summary: Update Managed Cluster Log Configuration
+  description: Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240.
   operationId: putClientLogConfiguration
   parameters:
     - name: id
       in: path
-      description: ID of ManagedCluster to update log configuration for
+      description: ID of the managed cluster to update the log configuration for.
       required: true
       schema:
         type: string
         format: uuid
       example: 2b838de9-db9b-abcf-e646-d4f274ad4238
   requestBody:
-    description: ClientLogConfiguration for given ManagedCluster
+    description: Client log configuration for the given managed cluster.
     content:
       application/json:
         schema:
@@ -69,7 +69,7 @@ put:
     required: true
   responses:
     "200":
-      description: Responds with updated ClientLogConfiguration for given ManagedCluster
+      description: Response with updated client log configuration for the given managed cluster.
       content:
         application/json:
           schema:

static/api-specs/idn/v3/paths/managed-cluster.yaml

@@ -1,13 +1,13 @@
 get:
   tags:
     - Managed Clusters
-  summary: Get a specified Managed Cluster.
-  description: Retrieve a ManagedCluster by ID.
+  summary: Get Managed Cluster
+  description: Get a managed cluster by ID.
   operationId: getManagedCluster
   parameters:
     - name: id
       in: path
-      description: ManagedCluster ID.
+      description: Managed cluster ID.
       required: true
       example: 2c9180897de347a2017de8859e8c5039
       style: simple
@@ -16,7 +16,7 @@ get:
         type: string
   responses:
     "200":
-      description: Responds with ManagedCluster having the given ID.
+      description: Response with managed cluster for the given ID.
       content:
         application/json:
           schema:
@@ -35,24 +35,26 @@ get:
       $ref: '../../v3/responses/500.yaml'
   security:
     - userAuth: [idn:remote-client:read, idn:remote-client:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
 patch:
   tags:
     - Managed Clusters
-  summary: Update a Managed Cluster
+  summary: Update Managed Cluster
   description: >-
-    Update an existing Managed Cluster.
+    Update an existing managed cluster.
   operationId: updateManagedCluster
   parameters:
     - in: path
       name: id
       schema:
         type: string
       required: true
-      description: Managed Cluster ID.
+      description: Managed cluster ID.
       example: 2c9180897de347a2017de8859e8c5039
   requestBody:
     required: true
-    description: The JSONPatch payload used to update the object.
+    description: JSONPatch payload used to update the object.
     content:
       application/json-patch+json:
         schema:
@@ -61,7 +63,7 @@ patch:
             $ref: "../schemas/JsonPatchOperation.yaml"
   responses:
     "200":
-      description: The updated Managed Cluster
+      description: Updated managed cluster.
       content:
         application/json:
           schema:
@@ -80,33 +82,35 @@ patch:
       $ref: '../../v3/responses/500.yaml'
   security:
     - userAuth: [idn:remote-client:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
 delete:
   operationId: deleteManagedCluster
   tags:
     - Managed Clusters
-  summary: Delete a Managed Cluster
+  summary: Delete Managed Cluster
   description: >-
-    Delete an existing Managed Cluster.
+    Delete an existing managed cluster.
   parameters:
     - in: path
       name: id
       schema:
         type: string
       required: true
-      description: Managed Cluster ID.
+      description: Managed cluster ID.
       example: 2c9180897de347a2017de8859e8c5039
     - in: query
       name: removeClients
       schema:
         type: boolean
         default: false
       required: false
-      description: Flag to determine the need to delete a cluster with clients
+      description: Flag to determine the need to delete a cluster with clients.
       example: false
   responses:
     '204':
       $ref: '../../v3/responses/204.yaml'
-      description: The Managed Cluster was successfully deleted.
+      description: Managed cluster was successfully deleted.
     '400':
       $ref: '../../v3/responses/400.yaml'
     '401':
@@ -119,3 +123,5 @@ delete:
       $ref: '../../v3/responses/500.yaml'
   security:
     - userAuth: [idn:remote-client:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN

static/api-specs/idn/v3/paths/managed-clusters.yaml

@@ -1,8 +1,8 @@
 get:
   tags:
     - Managed Clusters
-  summary: Retrieve all Managed Clusters.
-  description: Retrieve all Managed Clusters for the current Org, based on request context.
+  summary: Get Managed Clusters
+  description: List current organization's managed clusters, based on request context.
   operationId: getManagedClusters
   parameters:
     - $ref: '../../v3/parameters/offset.yaml'
@@ -20,10 +20,11 @@ get:
 
 
         **operational**: *eq*
+      required: false
       example: operational eq "operation"
   responses:
     "200":
-      description: Responds with a list of ManagedCluster.
+      description: Response with a list of managed clusters.
       content:
         application/json:
           schema:
@@ -42,14 +43,16 @@ get:
       $ref: '../../v3/responses/500.yaml'
   security:
     - userAuth: [idn:remote-client:read, idn:remote-client:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
 post:
   tags:
     - Managed Clusters
-  summary: Create a new Managed Cluster
+  summary: Create Create Managed Cluster
   description: >-
     Create a new Managed Cluster.
 
-    The API returns a result that includes the Managed Cluster ID.
+    The API returns a result that includes the managed cluster ID.
   operationId: createManagedCluster
   requestBody:
     required: true
@@ -59,7 +62,7 @@ post:
           $ref: '../schemas/ManagedClusterRequest.yaml'
   responses:
     "200":
-      description: The created ManagedClient
+      description: Created managed cluster.
       content:
         application/json:
           schema:
@@ -76,3 +79,5 @@ post:
       $ref: '../../v3/responses/500.yaml'
   security:
     - userAuth: [idn:remote-client:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN

static/api-specs/idn/v3/paths/set-password.yaml

@@ -15,7 +15,7 @@ post:
     To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command:
 
     ```bash
-    echo "myPassword" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64
+    echo -n "myPassword" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64
     ```
     
     In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint.