Automated commit 'Merge pull request #1468 from sailpoint/sdhus/IDNLA…

…NAI-9545 IDNLANAI-9545 - Updated the documentation for support DtoType in tagged objects' by github action: 6720968148
sailpoint-oss · Nov 1, 2023 · 2204c1a · 2204c1a
1 parent 822e16e
commit 2204c1a
Show file tree

Hide file tree

Showing 10 changed files with 87 additions and 18 deletions.
diff --git a/idn/beta/paths/bulk-add-tagged-objects.yaml b/idn/beta/paths/bulk-add-tagged-objects.yaml
@@ -1,5 +1,7 @@
 post:
-  operationId: addTagsToManyObjects
+  operationId: setTagsToManyObjects
+  security:
+    - UserContextAuth: [ idn:tag:manage ]
   tags:
     - Tagged Objects
   summary: Tag Multiple Objects
@@ -11,7 +13,7 @@ post:
     authority is required to call this API.
   requestBody:
     required: true
-    description: Supported object types are ROLE, IDENTITY and SOD_POLICY.
+    description: Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
     content:
       application/json:
         schema:

diff --git a/idn/beta/paths/bulk-remove-tagged-objects.yaml b/idn/beta/paths/bulk-remove-tagged-objects.yaml
@@ -1,5 +1,7 @@
 post:
-  operationId: removeTagsToManyObject
+  operationId: deleteTagsToManyObject
+  security:
+    - UserContextAuth: [ idn:tag:manage ]
   tags:
     - Tagged Objects
   summary: Remove Tags from Multiple Objects
@@ -10,7 +12,7 @@ post:
     A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN
     authority is required to call this API.
   requestBody:
-    description: Supported object types are ROLE, IDENTITY and SOD_POLICY.
+    description: Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
     required: true
     content:
       application/json:

diff --git a/idn/beta/paths/tagged-object.yaml b/idn/beta/paths/tagged-object.yaml
@@ -13,9 +13,14 @@ get:
       schema:
         type: string
         enum:
-          - ROLE
+          - ACCESS_PROFILE
+          - APPLICATION
+          - CAMPAIGN
+          - ENTITLEMENT
           - IDENTITY
+          - ROLE
           - SOD_POLICY
+          - SOURCE
       required: true
       description: The type of tagged object to retrieve.
       example: ROLE
@@ -44,7 +49,7 @@ get:
     '500':
       $ref: '../../v3/responses/500.yaml'
 put:
-  operationId: updateTaggedObject
+  operationId: putTaggedObject
   security:
     - UserContextAuth: [ idn:tag:manage ]
   tags:
@@ -58,9 +63,14 @@ put:
       schema:
         type: string
         enum:
-          - ROLE
+          - ACCESS_PROFILE
+          - APPLICATION
+          - CAMPAIGN
+          - ENTITLEMENT
           - IDENTITY
+          - ROLE
           - SOD_POLICY
+          - SOURCE
       required: true
       description: The type of tagged object to update.
       example: ROLE
@@ -109,9 +119,14 @@ delete:
       schema:
         type: string
         enum:
-          - ROLE
+          - ACCESS_PROFILE
+          - APPLICATION
+          - CAMPAIGN
+          - ENTITLEMENT
           - IDENTITY
+          - ROLE
           - SOD_POLICY
+          - SOURCE
       required: true
       description: The type of tagged object to delete.
       example: ROLE

diff --git a/idn/beta/paths/tags-get-shared.yaml b/idn/beta/paths/tags-get-shared.yaml
@@ -1,5 +1,7 @@
 post:
-  operationId: getSharedTags
+  operationId: searchSharedTags
+  security:
+    - UserContextAuth: [ idn:tag:manage ]
   tags:
     - Tags
   summary: Get Shared Tags
@@ -11,7 +13,7 @@ post:
     authority is required to call this API.
   requestBody:
     required: true
-    description: Supported object types are ROLE, IDENTITY and SOD_POLICY.
+    description: Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
     content:
       application/json:
         schema:

diff --git a/idn/beta/schemas/BulkTaggedObject.yaml b/idn/beta/schemas/BulkTaggedObject.yaml
@@ -3,7 +3,7 @@ properties:
   objectRefs:
     type: array
     items:
-      $ref: '../../v3/schemas/BaseReferenceDto.yaml'
+      $ref: '../../v3/schemas/TaggedObjectDto.yaml'
   tags:
     type: array
     items:

diff --git a/idn/beta/schemas/TaggedObject.yaml b/idn/beta/schemas/TaggedObject.yaml
@@ -1,7 +1,30 @@
 type: object
 properties:
   objectRef:
-    $ref: '../../v3/schemas/BaseReferenceDto.yaml'
+    type: object
+    properties:
+      type:
+        type: string
+        enum:
+          - ACCESS_PROFILE
+          - APPLICATION
+          - CAMPAIGN
+          - ENTITLEMENT
+          - IDENTITY
+          - ROLE
+          - SOD_POLICY
+          - SOURCE
+        example: IDENTITY
+        description: DTO type
+      id:
+        type: string
+        description: ID of the object to which this reference applies
+        example: 2c91808568c529c60168cca6f90c1313
+      name:
+        nullable: true
+        type: string
+        description: Human-readable display name of the object to which this reference applies
+        example: William Wilson
   tags:
     type: array
     items:

diff --git a/idn/v3/paths/bulk-add-tagged-objects.yaml b/idn/v3/paths/bulk-add-tagged-objects.yaml
@@ -13,7 +13,7 @@ post:
     authority is required to call this API.
   requestBody:
     required: true
-    description: Supported object types are ROLE, IDENTITY and SOD_POLICY.
+    description: Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
     content:
       application/json:
         schema:

diff --git a/idn/v3/paths/bulk-remove-tagged-objects.yaml b/idn/v3/paths/bulk-remove-tagged-objects.yaml
@@ -12,7 +12,7 @@ post:
     A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN
     authority is required to call this API.
   requestBody:
-    description: Supported object types are ROLE, IDENTITY and SOD_POLICY.
+    description: Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
     required: true
     content:
       application/json:

diff --git a/idn/v3/paths/tagged-object.yaml b/idn/v3/paths/tagged-object.yaml
@@ -13,9 +13,14 @@ get:
       schema:
         type: string
         enum:
-          - ROLE
+          - ACCESS_PROFILE
+          - APPLICATION
+          - CAMPAIGN
+          - ENTITLEMENT
           - IDENTITY
+          - ROLE
           - SOD_POLICY
+          - SOURCE
       required: true
       description: The type of tagged object to retrieve.
       example: ROLE
@@ -58,9 +63,14 @@ put:
       schema:
         type: string
         enum:
-          - ROLE
+          - ACCESS_PROFILE
+          - APPLICATION
+          - CAMPAIGN
+          - ENTITLEMENT
           - IDENTITY
+          - ROLE
           - SOD_POLICY
+          - SOURCE
       required: true
       description: The type of tagged object to update.
       example: ROLE
@@ -109,9 +119,14 @@ delete:
       schema:
         type: string
         enum:
-          - ROLE
+          - ACCESS_PROFILE
+          - APPLICATION
+          - CAMPAIGN
+          - ENTITLEMENT
           - IDENTITY
+          - ROLE
           - SOD_POLICY
+          - SOURCE
       required: true
       description: The type of tagged object to delete.
       example: ROLE

diff --git a/idn/v3/schemas/TaggedObjectDto.yaml b/idn/v3/schemas/TaggedObjectDto.yaml
@@ -1,7 +1,17 @@
 type: object
 properties:
   type:
-    $ref: '../../v3/schemas/DtoType.yaml'
+    type: string
+    enum:
+      - ACCESS_PROFILE
+      - APPLICATION
+      - CAMPAIGN
+      - ENTITLEMENT
+      - IDENTITY
+      - ROLE
+      - SOD_POLICY
+      - SOURCE
+    example: IDENTITY
     description: DTO type
   id:
     type: string