Automated commit 'ISCARP-15679 :- Added API Doc for source policy hol…

…ders (#1937)

* Added changes for sources policy holders doc

* Added user levels

* Removed get api doc

* Reverted the change

* Minor changes

* Fixed build errors' by github action: 12750871926

idn/sailpoint-api.v2024.yaml

@@ -1653,6 +1653,8 @@ paths:
     $ref: ./v3/paths/source-upload-connector-file.yaml
   /sources/{id}/correlation-config:
     $ref: ./v2024/paths/correlation-config.yaml
+  /sources/{sourceId}/password-policies:
+    $ref: ./v2024/paths/sources-policy-holders.yaml
   /tagged-objects:
     $ref: ./v3/paths/tagged-objects.yaml
   /tagged-objects/{type}:

idn/v2024/paths/sources-policy-holders.yaml

@@ -0,0 +1,49 @@
+patch:
+  operationId: updatePasswordPolicyHolders
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - SOURCE_ADMIN
+    - SOURCE_SUBADMIN
+    - ROLE_SUBADMIN
+  tags:
+    - Sources
+  summary: Update Password Policy
+  description: |
+    This API can be used to set up or update Password Policy in IdentityNow for the specified Source.
+    Source must support PASSWORD feature.
+  parameters:
+    - in: path
+      name: sourceId
+      schema:
+        type: string
+      required: true
+      description: The Source id
+      example: 8c190e6787aa4ed9a90bd9d5344523fb
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../schemas/PasswordPolicyHoldersDto.yaml'
+  responses:
+    '200':
+      description: >-
+        Updated Password Policies
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/PasswordPolicyHoldersDto.yaml'
+    '400':
+      $ref: '../../v3/responses/400.yaml'
+    '401':
+      $ref: '../../v3/responses/401.yaml'
+    '403':
+      $ref: '../../v3/responses/403.yaml'
+    '404':
+      $ref: '../../v3/responses/404.yaml'
+    '429':
+      $ref: '../../v3/responses/429.yaml'
+    '500':
+      $ref: '../../v3/responses/500.yaml'
+  security:
+    - userAuth: [ idn:sources:update ]

idn/v2024/schemas/PasswordPolicyHoldersDto.yaml

@@ -0,0 +1,51 @@
+type: array
+description: List of PasswordPolicyHoldersDto
+items:
+  type: object
+  properties:
+    policyId:
+      type: string
+      description: The password policy Id.
+      example: 2c91808e7d976f3b017d9f5ceae440c8
+    policyName:
+      type: string
+      description: The name of the password policy.
+      example: PasswordPolicy Example
+    selectors:
+      type: object
+      $ref: '../schemas/PasswordPolicyHoldersDtoAttributes.yaml'
+      example:
+        "identityAttr": [
+          {
+            "name": "displayName",
+            "value": "Robert"
+          },
+          {
+            "name": "lastname",
+            "value": "Juice"
+          }
+        ]
+example:
+  [
+    {
+      "policyId": "2c91808e7d976f3b017d9f5ceae440c8",
+      "policyName": "Default",
+      "selectors": null
+    },
+    {
+      "policyId": "2c91808e7d976f3b017d9f5ceae440c8",
+      "policyName": "PasswordPolicy Example",
+      "selectors": {
+        "identityAttr": [
+          {
+            "name": "displayName",
+            "value": "Robert"
+          },
+          {
+            "name": "lastname",
+            "value": "Case"
+          }
+        ]
+      }
+    }
+  ]

idn/v2024/schemas/PasswordPolicyHoldersDtoAttributes.yaml

@@ -0,0 +1,16 @@
+type: object
+properties:
+  identityAttr:
+    description: Attributes of PasswordPolicyHoldersDto
+    type: array
+    items:
+      type: object
+      properties:
+        name:
+          description: Attribute's name
+          type: string
+          example: Country
+        value:
+          description: Attribute's value
+          type: string
+          example: Canada