Automated commit 'IDNPALM-5548 Create Dimension API documentation in …

…V2024 (#1836) * Dynamic Roles chnages to existing create , patch and list roles API. * Dynamic Roles chnages to existing create , patch and list roles API. * Dimension create and list api documentation. * Dimension create and list api documentation. * Dimension create and list api documentation. * Dimension create and list api documentation. * Dimension create and list api documentation. * Dimension list access profiles and entitlements api docs * Dimension bulk delete dimensinsions API docs * Dimension bulk delete dimensinsions API docs * Dimension bulk delete dimensinsions API docs * Dimension bulk delete dimensinsions API docs * Dimension membership criteria changes. * resolved concflicts * resolved concflicts * issues fixed. * issues fixed. * Tag added * end points added * patch api example fixed. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation. * Dimensions V2024 API documentation.' by github action: 11219995457
sailpoint-oss · Oct 7, 2024 · 18c5010 · 18c5010
1 parent 5900874
commit 18c5010
Show file tree

Hide file tree

Showing 24 changed files with 2,072 additions and 7 deletions.
diff --git a/idn/beta/paths/dimension-access-profiles.yaml b/idn/beta/paths/dimension-access-profiles.yaml
@@ -0,0 +1,98 @@
+get:
+    operationId: listDimensionAccessProfiles
+    tags:
+      - Dimensions
+    summary: List Dimension's Access Profiles
+    description: >-
+        This API lists the Access Profiles associated with a given Dimension
+
+
+        A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a
+        token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated
+        to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
+    parameters:
+      - in: path
+        name: roleId
+        required: true
+        schema:
+          type: string
+        description: Parent Role Id of the dimension.
+        example: 6603fba3004f43c687610a29195252ce
+      - in: path
+        name: dimensionId
+        schema:
+          type: string
+        required: true
+        description: Id of the Dimension
+        example: 2c9180835d191a86015d28455b4a2329
+      - $ref: '../../v3/parameters/limit.yaml'
+      - $ref: '../../v3/parameters/offset.yaml'
+      - $ref: '../../v3/parameters/count.yaml'
+      - in: query
+        name: filters
+        schema:
+          type: string
+        description: >-
+          Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
+          Filtering is supported for the following fields and operators:
+
+
+          **id**: *eq, in*
+
+
+          **name**: *eq, sw*
+
+
+          **created**: *gt, lt, ge, le*
+
+
+          **modified**: *gt, lt, ge, le*
+
+
+          **owner.id**: *eq, in*
+
+
+          **source.id**: *eq, in*
+        example: source.id eq "2c91808982f979270182f99e386d00fa"
+        required: false
+      - in: query
+        name: sorters
+        schema:
+          type: string
+          format: comma-separated
+        description: >-
+          Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+          Sorting is supported for the following fields: **name, created, modified**
+        example: name,-modified
+        required: false
+    responses:
+      '200':
+        description: List of Access Profiles
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '../../v3/schemas/access/AccessProfile.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:role-unchecked:read, idn:role-unchecked:manage, idn:role-checked:manage, idn:role-checked:read ]
+    x-sailpoint-userLevels:
+      - ORG_ADMIN
+      - ROLE_ADMIN
+      - ROLE_SUBADMIN
diff --git a/idn/beta/paths/dimension-bulk-delete.yaml b/idn/beta/paths/dimension-bulk-delete.yaml
@@ -0,0 +1,95 @@
+post:
+  operationId: deleteBulkDimensions
+  summary: Delete Dimension(s)
+  tags:
+    - Dimensions
+  description: >-
+    This endpoint initiates a bulk deletion of one or more dimensions.
+
+    When the request is successful, the endpoint returns the bulk delete's task result ID. 
+    To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. 
+
+    This endpoint can only bulk delete up to a limit of 50 roles per request. 
+
+    A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a
+    token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated
+    with sources with management workgroups the ROLE_SUBADMIN is a member of.
+  parameters:
+    - in: path
+      name: roleId
+      required: true
+      schema:
+        type: string
+      description: Parent Role Id of the dimensions.
+      example: 6603fba3004f43c687610a29195252ce
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../../v3/schemas/access/DimensionBulkDeleteRequest.yaml'
+        example:
+          {
+            "dimensionIds": [ "2c91808876438bb2017668b91919ecca","2c91808876438ba801766e129f151816" ]
+          }
+  responses:
+    '202':
+      description: Returns an object with the id of the task performing the delete operation.
+      content:
+        application/json:
+          schema:
+            $ref: '../../v3/schemas/TaskResultDto.yaml'
+          example:
+            {
+              "type": "TASK_RESULT",
+              "id": "464ae7bf791e49fdb74606a2e4a89635",
+              "name": null
+            }
+    '400':
+      description: Client Error - Returned if the request body is invalid.
+      content:
+        application/json:
+          schema:
+            $ref: '../../v3/schemas/ErrorResponseDto.yaml'
+          examples:
+            400.1 Bad Request Content:
+              description: Response for bad request content
+              value:
+                detailCode: 400.1 Bad Request Content
+                trackingId: 1ea1adcb84da4dcb890145e05745774e
+                messages:
+                  - locale: en-US
+                    localeOrigin: DEFAULT
+                    text: The request was syntactically correct but its content is semantically invalid.
+            400.1 Dimension ids limit violation:
+              description: Dimension ids limit violation response
+              value:
+                detailCode: 400.1 Bad Request Content
+                trackingId: 77aa89ac6f0e422dbc588866abc22be9
+                messages:
+                  - locale: en-US
+                    localeOrigin: DEFAULT
+                    text: dimensionIds count exceeded max limit of 50 for bulk-delete.
+            400.1.404 Referenced object not found:
+              description: Referenced object not found response
+              value:
+                detailCode: 400.1.404 Referenced object not found
+                trackingId: 77aa89ac6f0e422dbc588866abc22be9
+                messages:
+                  - locale: en-US
+                    localeOrigin: DEFAULT
+                    text: Referenced dimensionIds ["2c91808876438bb2017668b91919ecca"] was not found.
+    '401':
+      $ref: '../../v3/responses/401.yaml'
+    '403':
+      $ref: '../../v3/responses/403.yaml'
+    '429':
+      $ref: '../../v3/responses/429.yaml'
+    '500':
+      $ref: '../../v3/responses/500.yaml'
+  security:
+    - userAuth: [idn:role-unchecked:manage, idn:role-checked:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - ROLE_ADMIN
+    - ROLE_SUBADMIN
diff --git a/idn/beta/paths/dimension-entitlements.yaml b/idn/beta/paths/dimension-entitlements.yaml
@@ -0,0 +1,102 @@
+get:
+    operationId: getDimensionEntitlements
+    tags:
+      - Dimensions
+    summary: List Dimension's Entitlements
+    description: >-
+        This API lists the Entitlements associated with a given dimension.
+      
+      
+        A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
+    parameters:
+      - in: path
+        name: roleId
+        required: true
+        schema:
+          type: string
+        description: Parent Role Id of the dimension.
+        example: 6603fba3004f43c687610a29195252ce
+      - in: path
+        name: dimensionId
+        schema:
+          type: string
+        required: true
+        description: Id of the Dimension
+        example: 2c9180835d191a86015d28455b4a2329
+      - $ref: '../../v3/parameters/limit.yaml'
+      - $ref: '../../v3/parameters/offset.yaml'
+      - $ref: '../../v3/parameters/count.yaml'
+      - in: query
+        name: filters
+        schema:
+          type: string
+        description: >-
+          Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
+          Filtering is supported for the following fields and operators:
+
+
+          **id**: *eq, in*
+
+
+          **name**: *eq, sw*
+
+
+          **attribute**: *eq, sw*
+
+
+          **value**: *eq, sw*
+
+
+          **created**: *gt, lt, ge, le*
+
+
+          **modified**: *gt, lt, ge, le*
+
+
+          **owner.id**: *eq, in*
+
+
+          **source.id**: *eq, in*
+        example: attribute eq "memberOf"
+        required: false
+      - in: query
+        name: sorters
+        schema:
+          type: string
+          format: comma-separated
+        description: >-
+          Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+          Sorting is supported for the following fields: **name, attribute, value, created, modified**
+        example: name,-modified
+        required: false
+    responses:
+      '200':
+        description: List of Entitlements
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '../schemas/Entitlement.yaml'
+      '400':
+        $ref: '../../v3/responses/400.yaml'
+      '401':
+        $ref: '../../v3/responses/401.yaml'
+      '403':
+        $ref: '../../v3/responses/403.yaml'
+      '429':
+        $ref: '../../v3/responses/429.yaml'
+      '500':
+        $ref: '../../v3/responses/500.yaml'
+    security:
+      - userAuth: [ idn:role-unchecked:read, idn:role-unchecked:manage, idn:role-checked:manage, idn:role-checked:read ]
+    x-sailpoint-userLevels:
+      - ORG_ADMIN
+      - ROLE_ADMIN
+      - ROLE_SUBADMIN
+
+