mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-06 12:27:48 +00:00
Apply automatic changes
This commit is contained in:
tyler-mairose-sp
committed by
github-actions[bot]
github-actions[bot]
parent
aa3530bba3
commit
201e9c57e9
@@ -266,6 +266,10 @@
|
||||
{
|
||||
"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.\n"
|
||||
},
|
||||
{
|
||||
"name": "Icons",
|
||||
"description": "Use this API to implement functionality related to object icons (application icons for example). \nWith this functionality in place, administrators can set or remove an icon for specific object type for use throughout IdentityNow.\n"
|
||||
}
|
||||
],
|
||||
"security": [
|
||||
@@ -277067,6 +277071,955 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/icons/{objectType}/{objectId}": {
|
||||
"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": {
|
||||
"description": "Client Error - Returned if the request body is invalid.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detailCode": {
|
||||
"type": "string",
|
||||
"description": "Fine-grained error code providing more detail of the error.",
|
||||
"example": "400.1 Bad Request Content"
|
||||
},
|
||||
"trackingId": {
|
||||
"type": "string",
|
||||
"description": "Unique tracking id for the error.",
|
||||
"example": "e7eab60924f64aa284175b9fa3309599"
|
||||
},
|
||||
"messages": {
|
||||
"type": "array",
|
||||
"description": "Generic localized reason for error",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"causes": {
|
||||
"type": "array",
|
||||
"description": "Plain-text descriptive reasons to provide additional detail to the text provided in the messages field",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"error": {
|
||||
"description": "A message describing the error",
|
||||
"example": "JWT validation failed: JWT is expired"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detailCode": {
|
||||
"type": "string",
|
||||
"description": "Fine-grained error code providing more detail of the error.",
|
||||
"example": "400.1 Bad Request Content"
|
||||
},
|
||||
"trackingId": {
|
||||
"type": "string",
|
||||
"description": "Unique tracking id for the error.",
|
||||
"example": "e7eab60924f64aa284175b9fa3309599"
|
||||
},
|
||||
"messages": {
|
||||
"type": "array",
|
||||
"description": "Generic localized reason for error",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"causes": {
|
||||
"type": "array",
|
||||
"description": "Plain-text descriptive reasons to provide additional detail to the text provided in the messages field",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"403": {
|
||||
"summary": "An example of a 403 response object",
|
||||
"value": {
|
||||
"detailCode": "403 Forbidden",
|
||||
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
|
||||
"messages": [
|
||||
{
|
||||
"locale": "en-US",
|
||||
"localeOrigin": "DEFAULT",
|
||||
"text": "The server understood the request but refuses to authorize it."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found - returned if the request URL refers to a resource or object that does not exist",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detailCode": {
|
||||
"type": "string",
|
||||
"description": "Fine-grained error code providing more detail of the error.",
|
||||
"example": "400.1 Bad Request Content"
|
||||
},
|
||||
"trackingId": {
|
||||
"type": "string",
|
||||
"description": "Unique tracking id for the error.",
|
||||
"example": "e7eab60924f64aa284175b9fa3309599"
|
||||
},
|
||||
"messages": {
|
||||
"type": "array",
|
||||
"description": "Generic localized reason for error",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"causes": {
|
||||
"type": "array",
|
||||
"description": "Plain-text descriptive reasons to provide additional detail to the text provided in the messages field",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"404": {
|
||||
"summary": "An example of a 404 response object",
|
||||
"value": {
|
||||
"detailCode": "404 Not found",
|
||||
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
|
||||
"messages": [
|
||||
{
|
||||
"locale": "en-US",
|
||||
"localeOrigin": "DEFAULT",
|
||||
"text": "The server did not find a current representation for the target resource."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"message": {
|
||||
"description": "A message describing the error",
|
||||
"example": " Rate Limit Exceeded "
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error - Returned if there is an unexpected error.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detailCode": {
|
||||
"type": "string",
|
||||
"description": "Fine-grained error code providing more detail of the error.",
|
||||
"example": "400.1 Bad Request Content"
|
||||
},
|
||||
"trackingId": {
|
||||
"type": "string",
|
||||
"description": "Unique tracking id for the error.",
|
||||
"example": "e7eab60924f64aa284175b9fa3309599"
|
||||
},
|
||||
"messages": {
|
||||
"type": "array",
|
||||
"description": "Generic localized reason for error",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"causes": {
|
||||
"type": "array",
|
||||
"description": "Plain-text descriptive reasons to provide additional detail to the text provided in the messages field",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"500": {
|
||||
"summary": "An example of a 500 response object",
|
||||
"value": {
|
||||
"detailCode": "500.0 Internal Fault",
|
||||
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
|
||||
"messages": [
|
||||
{
|
||||
"locale": "en-US",
|
||||
"localeOrigin": "DEFAULT",
|
||||
"text": "An internal fault occurred."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": {
|
||||
"description": "No content - indicates the request was successful but there is no content to be returned in the response."
|
||||
},
|
||||
"400": {
|
||||
"description": "Client Error - Returned if the request body is invalid.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detailCode": {
|
||||
"type": "string",
|
||||
"description": "Fine-grained error code providing more detail of the error.",
|
||||
"example": "400.1 Bad Request Content"
|
||||
},
|
||||
"trackingId": {
|
||||
"type": "string",
|
||||
"description": "Unique tracking id for the error.",
|
||||
"example": "e7eab60924f64aa284175b9fa3309599"
|
||||
},
|
||||
"messages": {
|
||||
"type": "array",
|
||||
"description": "Generic localized reason for error",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"causes": {
|
||||
"type": "array",
|
||||
"description": "Plain-text descriptive reasons to provide additional detail to the text provided in the messages field",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"error": {
|
||||
"description": "A message describing the error",
|
||||
"example": "JWT validation failed: JWT is expired"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detailCode": {
|
||||
"type": "string",
|
||||
"description": "Fine-grained error code providing more detail of the error.",
|
||||
"example": "400.1 Bad Request Content"
|
||||
},
|
||||
"trackingId": {
|
||||
"type": "string",
|
||||
"description": "Unique tracking id for the error.",
|
||||
"example": "e7eab60924f64aa284175b9fa3309599"
|
||||
},
|
||||
"messages": {
|
||||
"type": "array",
|
||||
"description": "Generic localized reason for error",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"causes": {
|
||||
"type": "array",
|
||||
"description": "Plain-text descriptive reasons to provide additional detail to the text provided in the messages field",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"403": {
|
||||
"summary": "An example of a 403 response object",
|
||||
"value": {
|
||||
"detailCode": "403 Forbidden",
|
||||
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
|
||||
"messages": [
|
||||
{
|
||||
"locale": "en-US",
|
||||
"localeOrigin": "DEFAULT",
|
||||
"text": "The server understood the request but refuses to authorize it."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found - returned if the request URL refers to a resource or object that does not exist",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detailCode": {
|
||||
"type": "string",
|
||||
"description": "Fine-grained error code providing more detail of the error.",
|
||||
"example": "400.1 Bad Request Content"
|
||||
},
|
||||
"trackingId": {
|
||||
"type": "string",
|
||||
"description": "Unique tracking id for the error.",
|
||||
"example": "e7eab60924f64aa284175b9fa3309599"
|
||||
},
|
||||
"messages": {
|
||||
"type": "array",
|
||||
"description": "Generic localized reason for error",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"causes": {
|
||||
"type": "array",
|
||||
"description": "Plain-text descriptive reasons to provide additional detail to the text provided in the messages field",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"404": {
|
||||
"summary": "An example of a 404 response object",
|
||||
"value": {
|
||||
"detailCode": "404 Not found",
|
||||
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
|
||||
"messages": [
|
||||
{
|
||||
"locale": "en-US",
|
||||
"localeOrigin": "DEFAULT",
|
||||
"text": "The server did not find a current representation for the target resource."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"message": {
|
||||
"description": "A message describing the error",
|
||||
"example": " Rate Limit Exceeded "
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error - Returned if there is an unexpected error.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"detailCode": {
|
||||
"type": "string",
|
||||
"description": "Fine-grained error code providing more detail of the error.",
|
||||
"example": "400.1 Bad Request Content"
|
||||
},
|
||||
"trackingId": {
|
||||
"type": "string",
|
||||
"description": "Unique tracking id for the error.",
|
||||
"example": "e7eab60924f64aa284175b9fa3309599"
|
||||
},
|
||||
"messages": {
|
||||
"type": "array",
|
||||
"description": "Generic localized reason for error",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"causes": {
|
||||
"type": "array",
|
||||
"description": "Plain-text descriptive reasons to provide additional detail to the text provided in the messages field",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The locale for the message text, a BCP 47 language tag.",
|
||||
"example": "en-US",
|
||||
"nullable": true
|
||||
},
|
||||
"localeOrigin": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"REQUEST",
|
||||
null
|
||||
],
|
||||
"description": "An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.",
|
||||
"example": "DEFAULT",
|
||||
"nullable": true
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Actual text of the error message in the indicated locale.",
|
||||
"example": "The request was syntactically correct but its content is semantically invalid."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"500": {
|
||||
"summary": "An example of a 500 response object",
|
||||
"value": {
|
||||
"detailCode": "500.0 Internal Fault",
|
||||
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
|
||||
"messages": [
|
||||
{
|
||||
"locale": "en-US",
|
||||
"localeOrigin": "DEFAULT",
|
||||
"text": "An internal fault occurred."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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: []
|
||||
components:
|
||||
@@ -210013,3 +210017,683 @@ paths:
|
||||
- locale: en-US
|
||||
localeOrigin: DEFAULT
|
||||
text: An internal fault occurred.
|
||||
'/icons/{objectType}/{objectId}':
|
||||
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':
|
||||
description: Client Error - Returned if the request body is invalid.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
description: Fine-grained error code providing more detail of the error.
|
||||
example: 400.1 Bad Request Content
|
||||
trackingId:
|
||||
type: string
|
||||
description: Unique tracking id for the error.
|
||||
example: e7eab60924f64aa284175b9fa3309599
|
||||
messages:
|
||||
type: array
|
||||
description: Generic localized reason for error
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
causes:
|
||||
type: array
|
||||
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
'401':
|
||||
description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
description: A message describing the error
|
||||
example: 'JWT validation failed: JWT is expired'
|
||||
'403':
|
||||
description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
description: Fine-grained error code providing more detail of the error.
|
||||
example: 400.1 Bad Request Content
|
||||
trackingId:
|
||||
type: string
|
||||
description: Unique tracking id for the error.
|
||||
example: e7eab60924f64aa284175b9fa3309599
|
||||
messages:
|
||||
type: array
|
||||
description: Generic localized reason for error
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
causes:
|
||||
type: array
|
||||
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
examples:
|
||||
'403':
|
||||
summary: An example of a 403 response object
|
||||
value:
|
||||
detailCode: 403 Forbidden
|
||||
trackingId: b21b1f7ce4da4d639f2c62a57171b427
|
||||
messages:
|
||||
- locale: en-US
|
||||
localeOrigin: DEFAULT
|
||||
text: The server understood the request but refuses to authorize it.
|
||||
'404':
|
||||
description: Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
description: Fine-grained error code providing more detail of the error.
|
||||
example: 400.1 Bad Request Content
|
||||
trackingId:
|
||||
type: string
|
||||
description: Unique tracking id for the error.
|
||||
example: e7eab60924f64aa284175b9fa3309599
|
||||
messages:
|
||||
type: array
|
||||
description: Generic localized reason for error
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
causes:
|
||||
type: array
|
||||
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
examples:
|
||||
'404':
|
||||
summary: An example of a 404 response object
|
||||
value:
|
||||
detailCode: 404 Not found
|
||||
trackingId: b21b1f7ce4da4d639f2c62a57171b427
|
||||
messages:
|
||||
- locale: en-US
|
||||
localeOrigin: DEFAULT
|
||||
text: The server did not find a current representation for the target resource.
|
||||
'429':
|
||||
description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
message:
|
||||
description: A message describing the error
|
||||
example: ' Rate Limit Exceeded '
|
||||
'500':
|
||||
description: Internal Server Error - Returned if there is an unexpected error.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
description: Fine-grained error code providing more detail of the error.
|
||||
example: 400.1 Bad Request Content
|
||||
trackingId:
|
||||
type: string
|
||||
description: Unique tracking id for the error.
|
||||
example: e7eab60924f64aa284175b9fa3309599
|
||||
messages:
|
||||
type: array
|
||||
description: Generic localized reason for error
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
causes:
|
||||
type: array
|
||||
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
examples:
|
||||
'500':
|
||||
summary: An example of a 500 response object
|
||||
value:
|
||||
detailCode: 500.0 Internal Fault
|
||||
trackingId: b21b1f7ce4da4d639f2c62a57171b427
|
||||
messages:
|
||||
- locale: en-US
|
||||
localeOrigin: DEFAULT
|
||||
text: An internal fault occurred.
|
||||
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':
|
||||
description: No content - indicates the request was successful but there is no content to be returned in the response.
|
||||
'400':
|
||||
description: Client Error - Returned if the request body is invalid.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
description: Fine-grained error code providing more detail of the error.
|
||||
example: 400.1 Bad Request Content
|
||||
trackingId:
|
||||
type: string
|
||||
description: Unique tracking id for the error.
|
||||
example: e7eab60924f64aa284175b9fa3309599
|
||||
messages:
|
||||
type: array
|
||||
description: Generic localized reason for error
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
causes:
|
||||
type: array
|
||||
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
'401':
|
||||
description: 'Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
description: A message describing the error
|
||||
example: 'JWT validation failed: JWT is expired'
|
||||
'403':
|
||||
description: 'Forbidden - Returned if the user you are running as, doesn''t have access to this end-point.'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
description: Fine-grained error code providing more detail of the error.
|
||||
example: 400.1 Bad Request Content
|
||||
trackingId:
|
||||
type: string
|
||||
description: Unique tracking id for the error.
|
||||
example: e7eab60924f64aa284175b9fa3309599
|
||||
messages:
|
||||
type: array
|
||||
description: Generic localized reason for error
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
causes:
|
||||
type: array
|
||||
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
examples:
|
||||
'403':
|
||||
summary: An example of a 403 response object
|
||||
value:
|
||||
detailCode: 403 Forbidden
|
||||
trackingId: b21b1f7ce4da4d639f2c62a57171b427
|
||||
messages:
|
||||
- locale: en-US
|
||||
localeOrigin: DEFAULT
|
||||
text: The server understood the request but refuses to authorize it.
|
||||
'404':
|
||||
description: Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
description: Fine-grained error code providing more detail of the error.
|
||||
example: 400.1 Bad Request Content
|
||||
trackingId:
|
||||
type: string
|
||||
description: Unique tracking id for the error.
|
||||
example: e7eab60924f64aa284175b9fa3309599
|
||||
messages:
|
||||
type: array
|
||||
description: Generic localized reason for error
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
causes:
|
||||
type: array
|
||||
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
examples:
|
||||
'404':
|
||||
summary: An example of a 404 response object
|
||||
value:
|
||||
detailCode: 404 Not found
|
||||
trackingId: b21b1f7ce4da4d639f2c62a57171b427
|
||||
messages:
|
||||
- locale: en-US
|
||||
localeOrigin: DEFAULT
|
||||
text: The server did not find a current representation for the target resource.
|
||||
'429':
|
||||
description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
message:
|
||||
description: A message describing the error
|
||||
example: ' Rate Limit Exceeded '
|
||||
'500':
|
||||
description: Internal Server Error - Returned if there is an unexpected error.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
description: Fine-grained error code providing more detail of the error.
|
||||
example: 400.1 Bad Request Content
|
||||
trackingId:
|
||||
type: string
|
||||
description: Unique tracking id for the error.
|
||||
example: e7eab60924f64aa284175b9fa3309599
|
||||
messages:
|
||||
type: array
|
||||
description: Generic localized reason for error
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
causes:
|
||||
type: array
|
||||
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
locale:
|
||||
type: string
|
||||
description: 'The locale for the message text, a BCP 47 language tag.'
|
||||
example: en-US
|
||||
nullable: true
|
||||
localeOrigin:
|
||||
type: string
|
||||
enum:
|
||||
- DEFAULT
|
||||
- REQUEST
|
||||
- null
|
||||
description: 'An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.'
|
||||
example: DEFAULT
|
||||
nullable: true
|
||||
text:
|
||||
type: string
|
||||
description: Actual text of the error message in the indicated locale.
|
||||
example: The request was syntactically correct but its content is semantically invalid.
|
||||
examples:
|
||||
'500':
|
||||
summary: An example of a 500 response object
|
||||
value:
|
||||
detailCode: 500.0 Internal Fault
|
||||
trackingId: b21b1f7ce4da4d639f2c62a57171b427
|
||||
messages:
|
||||
- locale: en-US
|
||||
localeOrigin: DEFAULT
|
||||
text: An internal fault occurred.
|
||||
|
||||
@@ -22849,9 +22849,7 @@
|
||||
"description": "This API endpoint returns a list of branding items.\n\nA token with API, ORG_ADMIN authority is required to call this API.",
|
||||
"security": [
|
||||
{
|
||||
"UserContextAuth": [
|
||||
"idn:branding:read"
|
||||
]
|
||||
"UserContextAuth": []
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
@@ -23302,9 +23300,7 @@
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"UserContextAuth": [
|
||||
"idn:branding:write"
|
||||
]
|
||||
"UserContextAuth": []
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
@@ -23696,9 +23692,7 @@
|
||||
"description": "This API endpoint retrieves information for an existing branding item by name.\nA token with API, ORG_ADMIN authority is required to call this API.",
|
||||
"security": [
|
||||
{
|
||||
"UserContextAuth": [
|
||||
"idn:branding:read"
|
||||
]
|
||||
"UserContextAuth": []
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
@@ -24270,9 +24264,7 @@
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"UserContextAuth": [
|
||||
"idn:branding:write"
|
||||
]
|
||||
"UserContextAuth": []
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
@@ -24762,9 +24754,7 @@
|
||||
"description": "This API endpoint delete information for an existing branding item by name.\nA token with API, ORG_ADMIN authority is required to call this API.",
|
||||
"security": [
|
||||
{
|
||||
"UserContextAuth": [
|
||||
"idn:branding:write"
|
||||
]
|
||||
"UserContextAuth": []
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
|
||||
@@ -18014,8 +18014,7 @@ paths:
|
||||
|
||||
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.
|
||||
@@ -18347,8 +18346,7 @@ paths:
|
||||
description: png file with logo
|
||||
example: \x00\x00\x00\x02
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- 'idn:branding:write'
|
||||
- UserContextAuth: []
|
||||
responses:
|
||||
'201':
|
||||
description: Branding item created
|
||||
@@ -18635,8 +18633,7 @@ paths:
|
||||
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'
|
||||
- UserContextAuth: []
|
||||
parameters:
|
||||
- in: path
|
||||
name: name
|
||||
@@ -19055,8 +19052,7 @@ paths:
|
||||
description: png file with logo
|
||||
example: \x00\x00\x00\x02
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- 'idn:branding:write'
|
||||
- UserContextAuth: []
|
||||
responses:
|
||||
'200':
|
||||
description: Branding item updated
|
||||
@@ -19415,8 +19411,7 @@ paths:
|
||||
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'
|
||||
- UserContextAuth: []
|
||||
parameters:
|
||||
- in: path
|
||||
name: name
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user