Automated commit 'Merge pull request #1526 from sailpoint/iiatsenko/PLTUI-7029

PLTUI-7029: Added spec for GET /v3/brandings api method' by github action: 7665703237
2025-12-06 04:19:09 +00:00 · 2024-01-26 08:31:08 +00:00
parent 25e4a3b14e
commit 053928aec0
5 changed files with 279 additions and 5 deletions
--- a/idn/sailpoint-api.v3.yaml
+++ b/idn/sailpoint-api.v3.yaml
@@ -608,7 +608,7 @@ tags:
      
      In IdentityNow, users can save searches under a name, and then they can access that saved search and run it again when they want. 

-      Refer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them. 
+      Refer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them.
  - name: Scheduled Search
    description: |
      Use this API to implement scheduled search functionality. 
@@ -661,7 +661,7 @@ tags:
      However, data from the operational databases (ex. identities, roles, events, etc) has to be ingested into Elasticsearch. 
      This ingestion process introduces a latency from when the operational data is created to when it is available in search. 
      Depending on the system load, this can take a few seconds to a few minutes. 
-      Please keep this latency in mind when you use search. 
+      Please keep this latency in mind when you use search.
  - name: Segments
    description: |
      Use this API to implement and customize access request segment functionality. 
@@ -680,7 +680,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. 
@@ -734,7 +734,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. 
@@ -813,7 +813,7 @@ tags:
      Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. 

      Well organized, mapped out connections between sources and IdentityNow are essential to achieving comprehensive identity access governance across all the source systems organizations need. 
-      Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. 
+      Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected.
  - name: Tagged Objects
    description: |
      Use this API to implement object tagging functionality. 
@@ -903,6 +903,11 @@ tags:
      Use this API to implement account usage insight functionality.
      With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used.
      This allows organizations to get the information they need to start optimizing and securing source account usage.
+  - name: Branding
+    description: |
+      Use this API to implement and customize branding functionality. 
+      With this functionality in place, administrators can get list of existing branding items, create new branding and configure them for use throughout IdentityNow. 
+      It allows to customise color of navigation bar, action buttons, logo and emailFromAddress.
 paths:
  /access-profiles:
    $ref: './v3/paths/access-profiles.yaml'
@@ -954,6 +959,10 @@ paths:
    $ref: "./v3/paths/auth-org-network-config.yaml"
  /auth-users/{id}:
    $ref: "./v3/paths/auth-user.yaml"
+  /brandings:
+    $ref: './v3/paths/brandings.yaml'
+  /brandings/{name}:
+    $ref: './v3/paths/branding.yaml'
  /campaigns:
    $ref: './v3/paths/campaigns.yaml'
  /campaigns/{id}:
@@ -1393,3 +1402,7 @@ components:
      $ref: './v3/schemas/SourceUsage.yaml'
    SourceUsageStatus:
      $ref: './v3/schemas/SourceUsageStatus.yaml'
+    BrandingItem:
+      $ref: './v3/schemas/BrandingItem.yaml'
+    BrandingItemCreate:
+      $ref: './v3/schemas/BrandingItemCreate.yaml'
--- a/idn/v3/paths/branding.yaml
+++ b/idn/v3/paths/branding.yaml
@@ -0,0 +1,116 @@
+get:
+  operationId: getBranding
+  tags:
+    - Branding
+  summary: Get a branding item
+  description: >-
+    This API endpoint retrieves information for an existing branding item by name.
+    
+    A token with API, ORG_ADMIN authority is required to call this API.
+  security:
+    - UserContextAuth: [ idn:branding:read ]
+  parameters:
+    - in: path
+      name: name
+      schema:
+        type: string
+      required: true
+      description: The name of the branding item to be retrieved
+      example: default
+  responses:
+    '200':
+      description: A branding item object
+      content:
+        application/json:
+          schema:
+            $ref: "../schemas/BrandingItem.yaml"
+    '400':
+      $ref: '../responses/400.yaml'
+    '401':
+      $ref: '../responses/401.yaml'
+    '403':
+      $ref: '../responses/403.yaml'
+    '404':
+      $ref: '../responses/404.yaml'
+    '429':
+      $ref: '../responses/429.yaml'
+    '500':
+      $ref: '../responses/500.yaml'
+put:
+  operationId: setBrandingItem
+  tags:
+    - Branding
+  summary: Update a branding item
+  description: >-
+    This API endpoint updates information for an existing branding item.
+
+    A token with API, ORG_ADMIN authority is required to call this API.
+  parameters:
+    - in: path
+      name: name
+      schema:
+        type: string
+      required: true
+      description: The name of the branding item to be retrieved
+      example: default
+  requestBody:
+    required: true
+    content:
+      multipart/form-data:
+        schema:
+          $ref: '../schemas/BrandingItemCreate.yaml'
+  security:
+    - UserContextAuth: [ idn:branding:write ]
+  responses:
+    '200':
+      description:  Branding item updated
+      content:
+        application/json:
+          schema:
+            $ref: "../schemas/BrandingItem.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'
+delete:
+  operationId: deleteBranding
+  tags:
+    - Branding
+  summary: Delete a branding item
+  description: >-
+    This API endpoint delete information for an existing branding item by name.
+    
+    A token with API, ORG_ADMIN authority is required to call this API.
+  security:
+    - UserContextAuth: [ idn:branding:write ]
+  parameters:
+    - in: path
+      name: name
+      schema:
+        type: string
+      required: true
+      description: The name of the branding item to be deleted
+      example: default
+  responses:
+    '204':
+      $ref: "../responses/204.yaml"
+    '400':
+      $ref: '../responses/400.yaml'
+    '401':
+      $ref: '../responses/401.yaml'
+    '403':
+      $ref: '../responses/403.yaml'
+    '404':
+      $ref: '../responses/404.yaml'
+    '429':
+      $ref: '../responses/429.yaml'
+    '500':
+      $ref: '../responses/500.yaml'
--- a/idn/v3/paths/brandings.yaml
+++ b/idn/v3/paths/brandings.yaml
@@ -0,0 +1,65 @@
+get:
+  operationId: getBrandingList
+  tags:
+    - Branding
+  summary: List of branding items
+  description: >-
+    This API endpoint returns a list of branding items.
+
+
+    A token with API, ORG_ADMIN authority is required to call this API.
+  security:
+    - UserContextAuth: [ idn:branding:read ]
+  responses:
+    '200':
+      description: A list of branding items.
+      content:
+        application/json:
+          schema:
+            type: array
+            items:
+              $ref: "../schemas/BrandingItem.yaml"
+    '400':
+      $ref: '../responses/400.yaml'
+    '401':
+      $ref: '../responses/401.yaml'
+    '403':
+      $ref: '../responses/403.yaml'
+    '429':
+      $ref: '../responses/429.yaml'
+    '500':
+      $ref: '../responses/500.yaml'
+post:
+  operationId: createBrandingItem
+  tags:
+    - Branding
+  summary: Create a branding item
+  description: >-
+    This API endpoint creates a branding item.
+
+    A token with API, ORG_ADMIN authority is required to call this API.
+  requestBody:
+    required: true
+    content:
+      multipart/form-data:
+        schema:
+          $ref: '../schemas/BrandingItemCreate.yaml'
+  security:
+    - UserContextAuth: [ idn:branding:write ]
+  responses:
+    '201':
+      description:  Branding item created
+      content:
+        application/json:
+          schema:
+            $ref: "../schemas/BrandingItem.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'
--- a/idn/v3/schemas/BrandingItem.yaml
+++ b/idn/v3/schemas/BrandingItem.yaml
@@ -0,0 +1,41 @@
+type: object
+properties:
+  name:
+    type: string
+    description: name of branding item
+    example: "default"
+  productName:
+    type: string
+    description: product name
+    example: "product name"
+    nullable: true
+  actionButtonColor:
+    type: string
+    description: hex value of color for action button
+    example: "0074D9"
+    nullable: true
+  activeLinkColor:
+    type: string
+    description: hex value of color for link
+    example: "011E69"
+    nullable: true
+  navigationColor:
+    type: string
+    description: hex value of color for navigation bar
+    example: "011E69"
+    nullable: true
+  emailFromAddress:
+    type: string
+    description: email from address
+    example: "no-reply@sailpoint.com"
+    nullable: true
+  standardLogoURL:
+    type: string
+    description: url to standard logo
+    example: ""
+    nullable: true
+  loginInformationalMessage:
+    type: string
+    description: login information message
+    example: ""
+    nullable: true
--- a/idn/v3/schemas/BrandingItemCreate.yaml
+++ b/idn/v3/schemas/BrandingItemCreate.yaml
@@ -0,0 +1,39 @@
+type: object
+required:
+  - name
+  - productName
+properties:
+  name:
+    type: string
+    description: name of branding item
+    example: "custom-branding-item"
+  productName:
+    type: string
+    description: product name
+    example: "product name"
+    nullable: true
+  actionButtonColor:
+    type: string
+    description: hex value of color for action button
+    example: "0074D9"
+  activeLinkColor:
+    type: string
+    description: hex value of color for link
+    example: "011E69"
+  navigationColor:
+    type: string
+    description: hex value of color for navigation bar
+    example: "011E69"
+  emailFromAddress:
+    type: string
+    description: email from address
+    example: "no-reply@sailpoint.com"
+  loginInformationalMessage:
+    type: string
+    description: login information message
+    example: ""
+  fileStandard:
+    type: string
+    format: binary
+    description: png file with logo
+    example: \x00\x00\x00\x02