mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 20:37:50 +00:00
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
This commit is contained in:
GitHub Action Bot
@@ -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'
|
||||
|
||||
116
idn/v3/paths/branding.yaml
Normal file
116
idn/v3/paths/branding.yaml
Normal file
@@ -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'
|
||||
65
idn/v3/paths/brandings.yaml
Normal file
65
idn/v3/paths/brandings.yaml
Normal file
@@ -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'
|
||||
41
idn/v3/schemas/BrandingItem.yaml
Normal file
41
idn/v3/schemas/BrandingItem.yaml
Normal file
@@ -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
|
||||
39
idn/v3/schemas/BrandingItemCreate.yaml
Normal file
39
idn/v3/schemas/BrandingItemCreate.yaml
Normal file
@@ -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
|
||||
Reference in New Issue
Block a user