Automated commit 'Merge pull request #1929 from sailpoint/devrel-1749…

…-2024

devrel-1749, devrel-1750 2024' by github action: 12436800992

idn/beta/paths/accounts.yaml

@@ -4,9 +4,7 @@ get:
     - Accounts
   summary: Accounts List
   description: >-
-    This returns a list of accounts.  
-    
-    A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
+    List accounts.  
   security:
     - userAuth: [idn:accounts:read, idn:accounts:manage]
   x-sailpoint-userLevels:
@@ -22,8 +20,8 @@ get:
         type: string
         enum: [ SLIM, FULL ]
       description: >-
-        Determines whether Slim, or increased level of detail is provided for each account in the returned list.
-        FULL is the default behavior.
+        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
     - $ref: '../../v3/parameters/limit.yaml'
     - $ref: '../../v3/parameters/offset.yaml'
@@ -101,7 +99,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:
@@ -167,7 +165,7 @@ post:
     - Accounts
   summary: Create Account
   description: |
-    This API submits an account creation task and returns the task ID.  
+    Submits an account creation task - the API then returns the task ID.  
 
     The `sourceId` where this account will be created must be included in the `attributes` object.
 
@@ -178,8 +176,6 @@ post:
     The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. 
 
     By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account.
-    
-    A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
   security:
     - userAuth: [idn:accounts:manage]
   x-sailpoint-userLevels:
@@ -194,7 +190,7 @@ post:
           $ref: "../schemas/AccountAttributesCreate.yaml"
   responses:
     '202':
-      description: Async task details
+      description: Async task details.
       content:
         application/json:
           schema:

idn/beta/paths/managed-clients.yaml

@@ -30,6 +30,7 @@ get:
 
 
         **clusterId**: *eq*
+      required: false
       example: name eq "client name"
   responses:
     "200":
@@ -54,12 +55,14 @@ 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
   summary: Create Managed Client
   description: >-
-    Create a new managed client.
+    Created managed client.
 
     The API returns a result that includes the managed client ID.
   operationId: createManagedClient
@@ -90,3 +93,5 @@ post:
       $ref: '../../v3/responses/500.yaml'
   security:
     - userAuth: [idn:remote-client:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN

idn/beta/paths/tagged-object.yaml

@@ -110,9 +110,9 @@ delete:
     - userAuth: [ idn:tag:manage ]
   tags:
     - Tagged Objects
-  summary: Delete Tagged Object
+  summary: Delete Object Tags
   description: >-
-    This deletes a tagged object for the specified type.
+    Delete all tags from a tagged object.
   parameters:
     - in: path
       name: type
@@ -128,14 +128,14 @@ delete:
           - SOD_POLICY
           - SOURCE
       required: true
-      description: The type of tagged object to delete.
+      description: The type of object to delete tags from. 
       example: ROLE
     - in: path
       name: id
       schema:
         type: string
       required: true
-      description: The ID of the object reference to delete.
+      description: The ID of the object to delete tags from. 
       example: ef38f94347e94562b5bb8424a56397d8
   responses:
     '204':

idn/sailpoint-api.beta.yaml

@@ -301,6 +301,13 @@ tags:
 
       Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts.
   - name: Connector Rule Management
+    description: |
+      Use this API to implement connector rule management functionality. 
+      With this functionality in place, administrators can implement connector-executed rules in a programmatic, scalable way. 
+
+      In Identity Security Cloud (ISC), [rules](https://developer.sailpoint.com/docs/extensibility/rules) serve as a flexible configuration framework you can leverage to perform complex or advanced configurations. 
+      [Connector-executed rules](https://developer.sailpoint.com/docs/extensibility/rules/connector-rules) are rules that are executed in the ISC virtual appliance (VA), usually extensions of the [connector](https://documentation.sailpoint.com/connectors/isc/landingpages/help/landingpages/isc_landing.html) itself, the bridge between the data source and ISC. 
+      This API allows administrators to view existing connector-executed rules, make changes to them, delete them, and create new ones from the available types.
   - name: Connectors
     description: |
       Use this API to implement connector functionality.
@@ -485,9 +492,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 write operations for managing 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: Operations for accessing and managing 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
@@ -537,7 +548,9 @@ tags:
       With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API.
       Refer to [Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information about OAuth and how it works with the Identity Security Cloud REST API.
   - name: Org Config
-    description: Operations for managing org configuration settings (eg. time zone)
+    description: |
+      Use this API to implement organization configuration functionality. 
+      Administrators can use this functionality to manage organization settings, such as time zones. 
   - name: Password Configuration
     description: |
       Use this API to implement organization password configuration functionality.

idn/sailpoint-api.v2024.yaml

@@ -384,6 +384,14 @@ tags:
 
       Refer to [Using the SailPoint Configuration Hub](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html) for more information about Configuration Hub.
   - name: Connector Rule Management
+    description: |
+      Use this API to implement connector rule management functionality. 
+      With this functionality in place, administrators can implement connector-executed rules in a programmatic, scalable way. 
+
+      In Identity Security Cloud (ISC), [rules](https://developer.sailpoint.com/docs/extensibility/rules) serve as a flexible configuration framework you can leverage to perform complex or advanced configurations. 
+      [Connector-executed rules](https://developer.sailpoint.com/docs/extensibility/rules/connector-rules) are rules that are executed in the ISC virtual appliance (VA), usually extensions of the [connector](https://documentation.sailpoint.com/connectors/isc/landingpages/help/landingpages/isc_landing.html) itself, the bridge between the data source and ISC. 
+
+      This API allows administrators to view existing connector-executed rules, make changes to them, delete them, and create new ones from the available types.
   - name: Connectors
     description: |
       Use this API to implement connector functionality.
@@ -582,9 +590,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: Manual Discover Applications
     description: |
       Use this API to manually upload application names to be correlated to an ISC connector.
@@ -635,7 +647,9 @@ tags:
       With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API.
       Refer to [Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information about OAuth and how it works with the Identity Security Cloud REST API.
   - name: Org Config
-    description: Operations for managing org configuration settings (eg. time zone)
+    description: |
+      Use this API to implement organization configuration functionality. 
+      Administrators can use this functionality to manage organization settings, such as time zones. 
   - name: Password Configuration
     description: |
       Use this API to implement organization password configuration functionality. 

idn/v2024/paths/connector-rule-validate.yaml

@@ -1,19 +1,19 @@
 post:
   tags:
   - Connector Rule Management
-  operationId: validateConnectorRule
+  operationId: testConnectorRule
   summary: Validate Connector Rule
-  description: Returns a list of issues within the code to fix, if any.
+  description: Detect issues within the connector rule's code to fix and list them. 
   requestBody:
     required: true
-    description: The code to validate
+    description: Code to validate.
     content:
       application/json:
         schema:
           $ref: ../../beta/schemas/SourceCode.yaml
   responses:
     '200':
-      description: The status of the code's eligibility as a connector rule
+      description: Status of the code's eligibility as a connector rule.
       content:
         application/json:
           schema:

idn/v2024/paths/connector-rule.yaml

@@ -1,13 +1,13 @@
 get:
   tags:
   - Connector Rule Management
-  summary: Connector-Rule by ID
+  summary: Get Connector Rule
   operationId: getConnectorRule
-  description: Returns the connector rule specified by ID.
+  description: Get a connector rule by ID.
   parameters:
   - name: id
     in: path
-    description: ID of the connector rule to retrieve
+    description: ID of the connector rule to get.
     required: true
     style: simple
     explode: false
@@ -24,7 +24,7 @@ get:
     required: true
   responses:
     '200':
-      description: Connector rule with the given ID
+      description: Connector rule with the given ID.
       content:
         application/json:
           schema:
@@ -50,14 +50,14 @@ get:
 put:
   tags:
   - Connector Rule Management
-  summary: Update a Connector Rule
-  description: 'Updates an existing connector rule with the one provided in the request
-    body. Note that the fields ''id'', ''name'', and ''type'' are immutable.'
-  operationId: updateConnectorRule
+  summary: Update Connector Rule
+  description: >-
+    Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type`
+  operationId: putConnectorRule
   parameters:
   - name: id
     in: path
-    description: ID of the connector rule to update
+    description: ID of the connector rule to update.
     required: true
     style: simple
     explode: false
@@ -73,14 +73,14 @@ put:
       default: true
     required: true
   requestBody:
-    description: The connector rule with updated data
+    description: Connector rule with updated data.
     content:
       application/json:
         schema:
           $ref: ../../beta/schemas/ConnectorRuleUpdateRequest.yaml
   responses:
     '200':
-      description: The updated connector rule
+      description: Updated connector rule.
       content:
         application/json:
           schema:
@@ -105,13 +105,13 @@ put:
 delete:
   tags:
   - Connector Rule Management
-  summary: Delete a Connector-Rule
-  description: Deletes the connector rule specified by the given ID.
+  summary: Delete Connector Rule
+  description: Delete the connector rule for the given ID.
   operationId: deleteConnectorRule
   parameters:
   - name: id
     in: path
-    description: ID of the connector rule to delete
+    description: ID of the connector rule to delete.
     required: true
     style: simple
     explode: false

idn/v2024/paths/connector-rules.yaml

@@ -3,10 +3,10 @@ get:
   - Connector Rule Management
   operationId: getConnectorRuleList
   summary: List Connector Rules
-  description: Returns the list of connector rules.
+  description: List existing connector rules.
   responses:
     '200':
-      description: A list of connector rules
+      description: List of connector rules.
       content:
         application/json:
           schema:
@@ -38,22 +38,25 @@ get:
       type: string
       default: true
     required: true
+  - $ref: '../../v3/parameters/limit50.yaml'
+  - $ref: '../../v3/parameters/offset.yaml'
+  - $ref: '../../v3/parameters/count.yaml'
 post:
   tags:
   - Connector Rule Management
   operationId: createConnectorRule
   summary: Create Connector Rule
-  description: Creates a new connector rule.
+  description: Create a connector rule from the available types.
   requestBody:
     required: true
-    description: The connector rule to create
+    description: Connector rule to create.
     content:
       application/json:
         schema:
           $ref: ../../beta/schemas/ConnectorRuleCreateRequest.yaml
   responses:
     '201':
-      description: The created connector rule
+      description: Created connector rule.
       content:
         application/json:
           schema:

idn/v2024/paths/org-config-valid-time-zones.yaml

@@ -2,15 +2,17 @@ get:
   operationId: getValidTimeZones
   tags:
   - Org Config
-  summary: Get list of time zones
+  summary: Get Valid Time Zones
   security:
   - userAuth:
     - idn:org-configs:read
     - idn:org-configs-user:read
-  description: Get a list of valid time zones that can be set in org configurations.
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+  description: List the valid time zones that can be set in organization configurations.
   responses:
     '200':
-      description: Request successful
+      description: Request successful.
       content:
         application/json:
           schema:
@@ -45,3 +47,6 @@ get:
       type: string
       default: true
     required: true
+  - $ref: '../../v3/parameters/limit50.yaml'
+  - $ref: '../../v3/parameters/offset.yaml'
+  - $ref: '../../v3/parameters/count.yaml'