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
2019acc760
commit
fc3665d681
@@ -111467,6 +111467,845 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/mfa/kba/config": {
|
||||||
|
"get": {
|
||||||
|
"operationId": "getMFAKbaConfig",
|
||||||
|
"tags": [
|
||||||
|
"MFA Configuration"
|
||||||
|
],
|
||||||
|
"summary": "Configuration of KBA MFA method",
|
||||||
|
"description": "This API returns the KBA configuration for MFA. A token with USER or ORG_ADMIN authority is required to call this API.",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"in": "query",
|
||||||
|
"name": "allLanguages",
|
||||||
|
"required": false,
|
||||||
|
"schema": {
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"description": "Indicator whether the question text should be returned in all configured languages\n * If true, the question text is returned in all languages that it is configured in.\n * If false, the question text is returned in the user locale if available, else for the default locale. \n * If not passed, it behaves the same way as passing this parameter as false",
|
||||||
|
"example": "allLanguages=true"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"security": [
|
||||||
|
{
|
||||||
|
"UserContextAuth": [
|
||||||
|
"idn:mfa-kba:read"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "The configuration for KBA MFA method.",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"description": "KBA Configuration",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"id": {
|
||||||
|
"type": "string",
|
||||||
|
"nullable": false,
|
||||||
|
"description": "KBA Question Id",
|
||||||
|
"example": "143cfd3b-c23f-426b-ae5f-d3db06fa5919"
|
||||||
|
},
|
||||||
|
"text": {
|
||||||
|
"type": "string",
|
||||||
|
"nullable": false,
|
||||||
|
"description": "KBA Question description",
|
||||||
|
"example": "[{\"text\":\"Nouvelle question MFA -1 ?\",\"locale\":\"fr\"},{\"text\":\"MFA new question -1 ?\",\"locale\":\"\"}]"
|
||||||
|
},
|
||||||
|
"hasAnswer": {
|
||||||
|
"type": "boolean",
|
||||||
|
"nullable": false,
|
||||||
|
"description": "Denotes whether the KBA question has an answer configured for any user in the tenant",
|
||||||
|
"example": true
|
||||||
|
},
|
||||||
|
"numAnswers": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int32",
|
||||||
|
"nullable": false,
|
||||||
|
"description": "Denotes the number of KBA configurations for this question",
|
||||||
|
"example": 5
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"id",
|
||||||
|
"text",
|
||||||
|
"hasAnswer",
|
||||||
|
"numAnswers"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"example": [
|
||||||
|
{
|
||||||
|
"id": "143cfd3b-c23f-426b-ae5f-d3db06fa5919",
|
||||||
|
"text": "MFA new question -1 ?",
|
||||||
|
"hasAnswer": false,
|
||||||
|
"numAnswers": 0
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "173421",
|
||||||
|
"text": "What is your alphanumeric PIN?",
|
||||||
|
"hasAnswer": false,
|
||||||
|
"numAnswers": 3
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"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."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"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."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/mfa/kba/config/answers": {
|
||||||
|
"post": {
|
||||||
|
"operationId": "setMFAKBAConfig",
|
||||||
|
"tags": [
|
||||||
|
"MFA Configuration"
|
||||||
|
],
|
||||||
|
"summary": "Set MFA KBA configuration",
|
||||||
|
"description": "This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration.\nA token with USER authority is required to call this API.",
|
||||||
|
"requestBody": {
|
||||||
|
"required": true,
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"id": {
|
||||||
|
"type": "string",
|
||||||
|
"nullable": false,
|
||||||
|
"description": "Question Id",
|
||||||
|
"example": "c54fee53-2d63-4fc5-9259-3e93b9994135"
|
||||||
|
},
|
||||||
|
"answer": {
|
||||||
|
"type": "string",
|
||||||
|
"nullable": false,
|
||||||
|
"description": "An answer for the KBA question",
|
||||||
|
"example": "Your answer"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"id",
|
||||||
|
"answer"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"example": [
|
||||||
|
{
|
||||||
|
"id": "173423",
|
||||||
|
"answer": "822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "c54fee53-2d63-4fc5-9259-3e93b9994135",
|
||||||
|
"answer": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"security": [
|
||||||
|
{
|
||||||
|
"UserContextAuth": [
|
||||||
|
"idn:mfa-kba:authenticate"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "The new KBA configuration for the user.",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"id": {
|
||||||
|
"type": "string",
|
||||||
|
"nullable": false,
|
||||||
|
"description": "Question Id",
|
||||||
|
"example": "c54fee53-2d63-4fc5-9259-3e93b9994135"
|
||||||
|
},
|
||||||
|
"question": {
|
||||||
|
"type": "string",
|
||||||
|
"nullable": false,
|
||||||
|
"description": "Question description",
|
||||||
|
"example": "[{\"text\":\"Nouvelle question MFA -1 ?\",\"locale\":\"fr\"},{\"text\":\"MFA new question -1 ?\",\"locale\":\"\"}]"
|
||||||
|
},
|
||||||
|
"hasAnswer": {
|
||||||
|
"type": "boolean",
|
||||||
|
"nullable": false,
|
||||||
|
"description": "Denotes whether the KBA question has an answer configured for the current user",
|
||||||
|
"example": true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"id",
|
||||||
|
"question",
|
||||||
|
"hasAnswer"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"example": [
|
||||||
|
{
|
||||||
|
"id": "143cfd3b-c23f-426b-ae5f-d3db06fa5919",
|
||||||
|
"question": "[{\"text\":\"Nouvelle question MFA -1 ?\",\"locale\":\"fr\"},{\"text\":\"MFA new question -1 ?\",\"locale\":\"\"}]",
|
||||||
|
"hasAnswer": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "173421",
|
||||||
|
"question": "[{\"text\":\"What is your alphanumeric PIN?\",\"locale\":\"\"}]",
|
||||||
|
"hasAnswer": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "c54fee53-2d63-4fc5-9259-3e93b9994135",
|
||||||
|
"question": "[{\"text\":\"Nouvelle question MFA - 2 ?\",\"locale\":\"fr\"},{\"text\":\"MFA new question - 2 ?\",\"locale\":\"\"}]",
|
||||||
|
"hasAnswer": true
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"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."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"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."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"/mfa/{method}/test": {
|
"/mfa/{method}/test": {
|
||||||
"get": {
|
"get": {
|
||||||
"operationId": "testMFAConfig",
|
"operationId": "testMFAConfig",
|
||||||
@@ -113484,61 +114323,39 @@
|
|||||||
"content": {
|
"content": {
|
||||||
"application/json": {
|
"application/json": {
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "object",
|
"type": "array",
|
||||||
"properties": {
|
"items": {
|
||||||
"answers": {
|
"type": "object",
|
||||||
"nullable": false,
|
"properties": {
|
||||||
"type": "array",
|
"id": {
|
||||||
"items": {
|
"type": "string",
|
||||||
"type": "object",
|
"nullable": false,
|
||||||
"properties": {
|
"description": "Question Id",
|
||||||
"questionId": {
|
"example": "c54fee53-2d63-4fc5-9259-3e93b9994135"
|
||||||
"type": "string",
|
|
||||||
"nullable": false,
|
|
||||||
"description": "Question Id",
|
|
||||||
"example": "089899f13a8f4da7824996191587bab9"
|
|
||||||
},
|
|
||||||
"answer": {
|
|
||||||
"type": "string",
|
|
||||||
"nullable": false,
|
|
||||||
"description": "An answer for the KBA question",
|
|
||||||
"example": "Your answer"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": [
|
|
||||||
"questionId",
|
|
||||||
"answer"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"description": "Kba answers",
|
"answer": {
|
||||||
"example": [
|
"type": "string",
|
||||||
{
|
"nullable": false,
|
||||||
"questionId": "089899f13a8f4da7824996191587bab9",
|
"description": "An answer for the KBA question",
|
||||||
"answer": "Your answer"
|
"example": "Your answer"
|
||||||
},
|
}
|
||||||
{
|
|
||||||
"questionId": "067899f13a8f4da7824996191587bab9",
|
|
||||||
"answer": "Your answer1"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": [
|
|
||||||
"answers"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"example": {
|
|
||||||
"answers": [
|
|
||||||
{
|
|
||||||
"questionId": "089899f13a8f4da7824996191587bab9",
|
|
||||||
"answer": "Your answer"
|
|
||||||
},
|
},
|
||||||
{
|
"required": [
|
||||||
"questionId": "067899f13a8f4da7824996191587bab9",
|
"id",
|
||||||
"answer": "Your answer1"
|
"answer"
|
||||||
}
|
]
|
||||||
]
|
}
|
||||||
}
|
},
|
||||||
|
"example": [
|
||||||
|
{
|
||||||
|
"id": "173423",
|
||||||
|
"answer": "822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "c54fee53-2d63-4fc5-9259-3e93b9994135",
|
||||||
|
"answer": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -83525,6 +83525,610 @@ paths:
|
|||||||
- locale: en-US
|
- locale: en-US
|
||||||
localeOrigin: DEFAULT
|
localeOrigin: DEFAULT
|
||||||
text: An internal fault occurred.
|
text: An internal fault occurred.
|
||||||
|
/mfa/kba/config:
|
||||||
|
get:
|
||||||
|
operationId: getMFAKbaConfig
|
||||||
|
tags:
|
||||||
|
- MFA Configuration
|
||||||
|
summary: Configuration of KBA MFA method
|
||||||
|
description: This API returns the KBA configuration for MFA. A token with USER or ORG_ADMIN authority is required to call this API.
|
||||||
|
parameters:
|
||||||
|
- in: query
|
||||||
|
name: allLanguages
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
description: |-
|
||||||
|
Indicator whether the question text should be returned in all configured languages
|
||||||
|
* If true, the question text is returned in all languages that it is configured in.
|
||||||
|
* If false, the question text is returned in the user locale if available, else for the default locale.
|
||||||
|
* If not passed, it behaves the same way as passing this parameter as false
|
||||||
|
example: allLanguages=true
|
||||||
|
security:
|
||||||
|
- UserContextAuth:
|
||||||
|
- 'idn:mfa-kba:read'
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: The configuration for KBA MFA method.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
description: KBA Configuration
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
nullable: false
|
||||||
|
description: KBA Question Id
|
||||||
|
example: 143cfd3b-c23f-426b-ae5f-d3db06fa5919
|
||||||
|
text:
|
||||||
|
type: string
|
||||||
|
nullable: false
|
||||||
|
description: KBA Question description
|
||||||
|
example: '[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]'
|
||||||
|
hasAnswer:
|
||||||
|
type: boolean
|
||||||
|
nullable: false
|
||||||
|
description: Denotes whether the KBA question has an answer configured for any user in the tenant
|
||||||
|
example: true
|
||||||
|
numAnswers:
|
||||||
|
type: integer
|
||||||
|
format: int32
|
||||||
|
nullable: false
|
||||||
|
description: Denotes the number of KBA configurations for this question
|
||||||
|
example: 5
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- text
|
||||||
|
- hasAnswer
|
||||||
|
- numAnswers
|
||||||
|
example:
|
||||||
|
- id: 143cfd3b-c23f-426b-ae5f-d3db06fa5919
|
||||||
|
text: MFA new question -1 ?
|
||||||
|
hasAnswer: false
|
||||||
|
numAnswers: 0
|
||||||
|
- id: '173421'
|
||||||
|
text: What is your alphanumeric PIN?
|
||||||
|
hasAnswer: false
|
||||||
|
numAnswers: 3
|
||||||
|
'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.
|
||||||
|
'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.
|
||||||
|
/mfa/kba/config/answers:
|
||||||
|
post:
|
||||||
|
operationId: setMFAKBAConfig
|
||||||
|
tags:
|
||||||
|
- MFA Configuration
|
||||||
|
summary: Set MFA KBA configuration
|
||||||
|
description: |-
|
||||||
|
This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration.
|
||||||
|
A token with USER authority is required to call this API.
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
nullable: false
|
||||||
|
description: Question Id
|
||||||
|
example: c54fee53-2d63-4fc5-9259-3e93b9994135
|
||||||
|
answer:
|
||||||
|
type: string
|
||||||
|
nullable: false
|
||||||
|
description: An answer for the KBA question
|
||||||
|
example: Your answer
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- answer
|
||||||
|
example:
|
||||||
|
- id: '173423'
|
||||||
|
answer: 822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34
|
||||||
|
- id: c54fee53-2d63-4fc5-9259-3e93b9994135
|
||||||
|
answer: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08
|
||||||
|
security:
|
||||||
|
- UserContextAuth:
|
||||||
|
- 'idn:mfa-kba:authenticate'
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: The new KBA configuration for the user.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
nullable: false
|
||||||
|
description: Question Id
|
||||||
|
example: c54fee53-2d63-4fc5-9259-3e93b9994135
|
||||||
|
question:
|
||||||
|
type: string
|
||||||
|
nullable: false
|
||||||
|
description: Question description
|
||||||
|
example: '[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]'
|
||||||
|
hasAnswer:
|
||||||
|
type: boolean
|
||||||
|
nullable: false
|
||||||
|
description: Denotes whether the KBA question has an answer configured for the current user
|
||||||
|
example: true
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- question
|
||||||
|
- hasAnswer
|
||||||
|
example:
|
||||||
|
- id: 143cfd3b-c23f-426b-ae5f-d3db06fa5919
|
||||||
|
question: '[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]'
|
||||||
|
hasAnswer: false
|
||||||
|
- id: '173421'
|
||||||
|
question: '[{"text":"What is your alphanumeric PIN?","locale":""}]'
|
||||||
|
hasAnswer: true
|
||||||
|
- id: c54fee53-2d63-4fc5-9259-3e93b9994135
|
||||||
|
question: '[{"text":"Nouvelle question MFA - 2 ?","locale":"fr"},{"text":"MFA new question - 2 ?","locale":""}]'
|
||||||
|
hasAnswer: true
|
||||||
|
'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.
|
||||||
|
'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.
|
||||||
'/mfa/{method}/test':
|
'/mfa/{method}/test':
|
||||||
get:
|
get:
|
||||||
operationId: testMFAConfig
|
operationId: testMFAConfig
|
||||||
@@ -84979,41 +85583,28 @@ paths:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: array
|
||||||
properties:
|
items:
|
||||||
answers:
|
type: object
|
||||||
nullable: false
|
properties:
|
||||||
type: array
|
id:
|
||||||
items:
|
type: string
|
||||||
type: object
|
nullable: false
|
||||||
properties:
|
description: Question Id
|
||||||
questionId:
|
example: c54fee53-2d63-4fc5-9259-3e93b9994135
|
||||||
type: string
|
answer:
|
||||||
nullable: false
|
type: string
|
||||||
description: Question Id
|
nullable: false
|
||||||
example: 089899f13a8f4da7824996191587bab9
|
description: An answer for the KBA question
|
||||||
answer:
|
example: Your answer
|
||||||
type: string
|
required:
|
||||||
nullable: false
|
- id
|
||||||
description: An answer for the KBA question
|
- answer
|
||||||
example: Your answer
|
|
||||||
required:
|
|
||||||
- questionId
|
|
||||||
- answer
|
|
||||||
description: Kba answers
|
|
||||||
example:
|
|
||||||
- questionId: 089899f13a8f4da7824996191587bab9
|
|
||||||
answer: Your answer
|
|
||||||
- questionId: 067899f13a8f4da7824996191587bab9
|
|
||||||
answer: Your answer1
|
|
||||||
required:
|
|
||||||
- answers
|
|
||||||
example:
|
example:
|
||||||
answers:
|
- id: '173423'
|
||||||
- questionId: 089899f13a8f4da7824996191587bab9
|
answer: 822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34
|
||||||
answer: Your answer
|
- id: c54fee53-2d63-4fc5-9259-3e93b9994135
|
||||||
- questionId: 067899f13a8f4da7824996191587bab9
|
answer: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08
|
||||||
answer: Your answer1
|
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: KBA authenticated status.
|
description: KBA authenticated status.
|
||||||
|
|||||||
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