Automated commit 'Merge pull request #1534 from sailpoint/iiatsenko/PLTUI-7030

PLTUI-7030: Added spec for api method to update icon' by github action: 8420645682
2025-12-06 12:27:48 +00:00 · 2024-03-25 13:11:20 +00:00
parent 4e7f779d92
commit aa3530bba3
5 changed files with 121 additions and 12 deletions
--- a/idn/beta/paths/icon.yaml
+++ b/idn/beta/paths/icon.yaml
@@ -0,0 +1,103 @@
+put:
+  operationId: setIcon
+  tags:
+    - Icons
+  summary: Update an icon
+  description: >-
+    This API endpoint updates an icon by object type and object id.
+    A token with ORG_ADMIN authority is required to call this API.
+  parameters:
+    - in: path
+      name: objectType
+      schema:
+        type: string
+      required: true
+      description: Object type. Available options ['application']
+      example: application
+    - in: path
+      name: objectId
+      schema:
+        type: string
+      required: true
+      description: Object id.
+      example: a291e870-48c3-4953-b656-fb5ce2a93169
+  requestBody:
+    required: true
+    content:
+      multipart/form-data:
+        schema:
+          type: object
+          required:
+            - image
+          properties:
+            image:
+              type: string
+              format: binary
+              description: file with icon. Allowed mime-types ['image/png', 'image/jpeg']
+              example: \x00\x00\x00\x02
+  security:
+    - UserContextAuth: [ ]
+  responses:
+    '200':
+      description:  Icon updated
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              icon:
+                type: string
+                description: url to file with icon
+                example: ""
+    '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'
+delete:
+  operationId: deleteIcon
+  tags:
+    - Icons
+  summary: Delete an icon
+  description: >-
+    This API endpoint delete an icon by object type and object id.
+    A token with ORG_ADMIN authority is required to call this API.
+  parameters:
+    - in: path
+      name: objectType
+      schema:
+        type: string
+      required: true
+      description: Object type. Available options ['application']
+      example: application
+    - in: path
+      name: objectId
+      schema:
+        type: string
+      required: true
+      description: Object id.
+      example: a291e870-48c3-4953-b656-fb5ce2a93169
+  security:
+    - UserContextAuth: [ ]
+  responses:
+    '204':
+      $ref: '../../v3/responses/204.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'
--- a/idn/sailpoint-api.beta.yaml
+++ b/idn/sailpoint-api.beta.yaml
@@ -695,7 +695,7 @@ tags:

      When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. 

-      Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in IdentityNow. 
+      Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in IdentityNow.
  - name: Service Desk Integration
    description: |
      Use this API to build an integration between IdentityNow and a service desk ITSM (IT service management) solution.
@@ -749,7 +749,7 @@ tags:

      Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies. 

-      Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. 
+      Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions.
  - name: SOD Violations
    description: |
      Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. 
@@ -769,7 +769,7 @@ tags:
      Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. 
      This second option is a good way to prevent SOD violations from triggering at all. 

-      Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. 
+      Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations.
  - name: Source Usages
    description: |
      Use this API to implement source usage insight functionality.
@@ -890,7 +890,7 @@ tags:

      - Risk levels 

-      Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in IdentityNow. 
+      Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in IdentityNow.
  - name: Task Management
  - name: Tenant
    description: API for reading tenant details.
@@ -972,6 +972,10 @@ tags:
  - name: Workflows
    description: |
      Workflows allow administrators to create custom automation scripts directly within IdentityNow.  These automation scripts respond to [event triggers](https://developer.sailpoint.com/idn/docs/event-triggers#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the IdentityNow UI.  Workflows can be configured via a graphical user interface within IdentityNow, or by creating and uploading a JSON formatted script to the Workflow service.  The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST.
+  - name: Icons
+    description: |
+      Use this API to implement functionality related to object icons (application icons for example). 
+      With this functionality in place, administrators can set or remove an icon for specific object type for use throughout IdentityNow.
 security:
  - UserContextAuth: [ ]

@@ -1725,3 +1729,5 @@ paths:
    $ref: "./beta/paths/account-usages.yaml"
  /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}:
    $ref: "./beta/paths/access-request-identity-metrics.yaml"
+  /icons/{objectType}/{objectId}:
+    $ref: './beta/paths/icon.yaml'
--- a/idn/sailpoint-api.v3.yaml
+++ b/idn/sailpoint-api.v3.yaml
@@ -585,7 +585,7 @@ tags:
    description: |
      Use this API to implement reports lifecycle managing and monitoring.
      With this functionality in place, users can run reports, view their results, and cancel reports in progress. 
-      This can be potentially helpful for auditing purposes. 
+      This can be potentially helpful for auditing purposes.
  - name: Requestable Objects
    description: |
      Use this API to implement requestable object functionality. 
@@ -787,7 +787,7 @@ tags:
      Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. 
      This second option is a good way to prevent SOD violations from triggering at all. 

-      Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. 
+      Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations.
  - name: Source Usages
    description: |
      Use this API to implement source usage insight functionality.
@@ -906,7 +906,7 @@ tags:

      - Risk levels 

-      Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in IdentityNow. 
+      Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in IdentityNow.
  - name: Transforms
    description: |
      The purpose of this API is to expose functionality for the manipulation of Transform objects.
--- a/idn/v3/paths/branding.yaml
+++ b/idn/v3/paths/branding.yaml
@@ -8,7 +8,7 @@ get:
    
    A token with API, ORG_ADMIN authority is required to call this API.
  security:
-    - UserContextAuth: [ idn:branding:read ]
+    - UserContextAuth: [ ]
  parameters:
    - in: path
      name: name
@@ -60,7 +60,7 @@ put:
        schema:
          $ref: '../schemas/BrandingItemCreate.yaml'
  security:
-    - UserContextAuth: [ idn:branding:write ]
+    - UserContextAuth: [ ]
  responses:
    '200':
      description:  Branding item updated
@@ -90,7 +90,7 @@ delete:
    
    A token with API, ORG_ADMIN authority is required to call this API.
  security:
-    - UserContextAuth: [ idn:branding:write ]
+    - UserContextAuth: [ ]
  parameters:
    - in: path
      name: name
--- a/idn/v3/paths/brandings.yaml
+++ b/idn/v3/paths/brandings.yaml
@@ -9,7 +9,7 @@ get:

    A token with API, ORG_ADMIN authority is required to call this API.
  security:
-    - UserContextAuth: [ idn:branding:read ]
+    - UserContextAuth: [ ]
  responses:
    '200':
      description: A list of branding items.
@@ -45,7 +45,7 @@ post:
        schema:
          $ref: '../schemas/BrandingItemCreate.yaml'
  security:
-    - UserContextAuth: [ idn:branding:write ]
+    - UserContextAuth: [ ]
  responses:
    '201':
      description:  Branding item created