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
635251752f
commit
030c28532e
@@ -6450,6 +6450,439 @@
|
|||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/access-profiles/bulk-update-requestable": {
|
||||||
|
"post": {
|
||||||
|
"operationId": "updateAccessProfilesInBulk",
|
||||||
|
"summary": "Update Access Profile(s) requestable field.",
|
||||||
|
"tags": [
|
||||||
|
"Access Profiles"
|
||||||
|
],
|
||||||
|
"description": "This API initiates a bulk update of field requestable for one or more Access Profiles.\n\n> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated**\n list of the response.Requestable field of these Access Profiles marked as **true** or **false**.\n\n> If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated.\n> A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.",
|
||||||
|
"requestBody": {
|
||||||
|
"required": true,
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"description": "List of Access profiles to be updated.",
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "Access Profile's basic details.",
|
||||||
|
"properties": {
|
||||||
|
"id": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Access Profile ID.",
|
||||||
|
"example": "464ae7bf-791e-49fd-b746-06a2e4a8"
|
||||||
|
},
|
||||||
|
"requestable": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Access Profile is requestable or not.",
|
||||||
|
"example": false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"example": [
|
||||||
|
{
|
||||||
|
"id": "464ae7bf-791e-49fd-b746-06a2e4a8",
|
||||||
|
"requestable": false
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"required": [
|
||||||
|
"id",
|
||||||
|
"requestable"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"example": [
|
||||||
|
{
|
||||||
|
"id": "464ae7bf-791e-49fd-b746-06a2e4a89635",
|
||||||
|
"requestable": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"responses": {
|
||||||
|
"207": {
|
||||||
|
"description": "List of updated and not updated Access Profiles.",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"description": "Access Profile Bulk update response.",
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"id": {
|
||||||
|
"description": "Identifier of Access Profile in bulk update request.",
|
||||||
|
"type": "string",
|
||||||
|
"example": "2c7180a46faadee4016fb4e018c20642"
|
||||||
|
},
|
||||||
|
"requestable": {
|
||||||
|
"description": "Access Profile requestable or not.",
|
||||||
|
"type": "boolean",
|
||||||
|
"example": false
|
||||||
|
},
|
||||||
|
"status": {
|
||||||
|
"description": "\nThe HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation.\n\n> 201 - Access profile is updated successfully.\n\n> 404 - Access profile not found.\n",
|
||||||
|
"type": "string",
|
||||||
|
"example": "201"
|
||||||
|
},
|
||||||
|
"description": {
|
||||||
|
"description": "Human readable status description and containing additional context information about success or failures etc.\n",
|
||||||
|
"type": "string",
|
||||||
|
"example": "\n> Access profile is updated successfully.\n\n> Referenced Access profile with Id \"2c7180a46faadee4016fb4e018c20642\" was not found.\n"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"id",
|
||||||
|
"requestable",
|
||||||
|
"status"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"example": [
|
||||||
|
{
|
||||||
|
"id": "464ae7bf-791e-49fd-b746-06a2e4a8",
|
||||||
|
"status": "201",
|
||||||
|
"requestable": false,
|
||||||
|
"description": "Access Profile updated successfully."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"example": [
|
||||||
|
{
|
||||||
|
"id": "464ae7bf-791e-49fd-b746-06a2e4a89635",
|
||||||
|
"status": "201",
|
||||||
|
"requestable": false,
|
||||||
|
"description": "Access Profile updated successfully."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
"localeOrigin": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": [
|
||||||
|
"DEFAULT",
|
||||||
|
"REQUEST"
|
||||||
|
],
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
"localeOrigin": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": [
|
||||||
|
"DEFAULT",
|
||||||
|
"REQUEST"
|
||||||
|
],
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
"localeOrigin": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": [
|
||||||
|
"DEFAULT",
|
||||||
|
"REQUEST"
|
||||||
|
],
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
"localeOrigin": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": [
|
||||||
|
"DEFAULT",
|
||||||
|
"REQUEST"
|
||||||
|
],
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
"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."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"412": {
|
||||||
|
"description": "Precondition Failed - Returned in response if API/Feature not enabled for an organization.",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"message": {
|
||||||
|
"description": "A message describing the error",
|
||||||
|
"example": " API/Feature not enabled for your organization."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
"localeOrigin": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": [
|
||||||
|
"DEFAULT",
|
||||||
|
"REQUEST"
|
||||||
|
],
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
"localeOrigin": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": [
|
||||||
|
"DEFAULT",
|
||||||
|
"REQUEST"
|
||||||
|
],
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
"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."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"security": [
|
||||||
|
{
|
||||||
|
"UserContextAuth": [
|
||||||
|
"idn:access-profile:manage"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
"/access-profiles/{id}/entitlements": {
|
"/access-profiles/{id}/entitlements": {
|
||||||
"get": {
|
"get": {
|
||||||
"operationId": "getAccessProfileEntitlements",
|
"operationId": "getAccessProfileEntitlements",
|
||||||
|
|||||||
@@ -5709,6 +5709,324 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- UserContextAuth:
|
- UserContextAuth:
|
||||||
- 'idn:access-profile:manage'
|
- 'idn:access-profile:manage'
|
||||||
|
/access-profiles/bulk-update-requestable:
|
||||||
|
post:
|
||||||
|
operationId: updateAccessProfilesInBulk
|
||||||
|
summary: Update Access Profile(s) requestable field.
|
||||||
|
tags:
|
||||||
|
- Access Profiles
|
||||||
|
description: |-
|
||||||
|
This API initiates a bulk update of field requestable for one or more Access Profiles.
|
||||||
|
|
||||||
|
> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated**
|
||||||
|
list of the response.Requestable field of these Access Profiles marked as **true** or **false**.
|
||||||
|
|
||||||
|
> If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated.
|
||||||
|
> A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
description: List of Access profiles to be updated.
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
description: Access Profile's basic details.
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: Access Profile ID.
|
||||||
|
example: 464ae7bf-791e-49fd-b746-06a2e4a8
|
||||||
|
requestable:
|
||||||
|
type: boolean
|
||||||
|
description: Access Profile is requestable or not.
|
||||||
|
example: false
|
||||||
|
example:
|
||||||
|
- id: 464ae7bf-791e-49fd-b746-06a2e4a8
|
||||||
|
requestable: false
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- requestable
|
||||||
|
example:
|
||||||
|
- id: 464ae7bf-791e-49fd-b746-06a2e4a89635
|
||||||
|
requestable: false
|
||||||
|
responses:
|
||||||
|
'207':
|
||||||
|
description: List of updated and not updated Access Profiles.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
description: Access Profile Bulk update response.
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
description: Identifier of Access Profile in bulk update request.
|
||||||
|
type: string
|
||||||
|
example: 2c7180a46faadee4016fb4e018c20642
|
||||||
|
requestable:
|
||||||
|
description: Access Profile requestable or not.
|
||||||
|
type: boolean
|
||||||
|
example: false
|
||||||
|
status:
|
||||||
|
description: |
|
||||||
|
|
||||||
|
The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation.
|
||||||
|
|
||||||
|
> 201 - Access profile is updated successfully.
|
||||||
|
|
||||||
|
> 404 - Access profile not found.
|
||||||
|
type: string
|
||||||
|
example: '201'
|
||||||
|
description:
|
||||||
|
description: |
|
||||||
|
Human readable status description and containing additional context information about success or failures etc.
|
||||||
|
type: string
|
||||||
|
example: |
|
||||||
|
|
||||||
|
> Access profile is updated successfully.
|
||||||
|
|
||||||
|
> Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found.
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- requestable
|
||||||
|
- status
|
||||||
|
example:
|
||||||
|
- id: 464ae7bf-791e-49fd-b746-06a2e4a8
|
||||||
|
status: '201'
|
||||||
|
requestable: false
|
||||||
|
description: Access Profile updated successfully.
|
||||||
|
example:
|
||||||
|
- id: 464ae7bf-791e-49fd-b746-06a2e4a89635
|
||||||
|
status: '201'
|
||||||
|
requestable: false
|
||||||
|
description: Access Profile updated successfully.
|
||||||
|
'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
|
||||||
|
localeOrigin:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- DEFAULT
|
||||||
|
- REQUEST
|
||||||
|
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
|
||||||
|
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
|
||||||
|
localeOrigin:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- DEFAULT
|
||||||
|
- REQUEST
|
||||||
|
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
|
||||||
|
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
|
||||||
|
localeOrigin:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- DEFAULT
|
||||||
|
- REQUEST
|
||||||
|
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
|
||||||
|
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
|
||||||
|
localeOrigin:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- DEFAULT
|
||||||
|
- REQUEST
|
||||||
|
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
|
||||||
|
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.
|
||||||
|
'412':
|
||||||
|
description: Precondition Failed - Returned in response if API/Feature not enabled for an organization.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
message:
|
||||||
|
description: A message describing the error
|
||||||
|
example: ' API/Feature not enabled for your organization.'
|
||||||
|
'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
|
||||||
|
localeOrigin:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- DEFAULT
|
||||||
|
- REQUEST
|
||||||
|
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
|
||||||
|
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
|
||||||
|
localeOrigin:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- DEFAULT
|
||||||
|
- REQUEST
|
||||||
|
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
|
||||||
|
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.
|
||||||
|
security:
|
||||||
|
- UserContextAuth:
|
||||||
|
- 'idn:access-profile:manage'
|
||||||
'/access-profiles/{id}/entitlements':
|
'/access-profiles/{id}/entitlements':
|
||||||
get:
|
get:
|
||||||
operationId: getAccessProfileEntitlements
|
operationId: getAccessProfileEntitlements
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user