mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-10 04:19:19 +00:00
Apply automatic changes
This commit is contained in:
tyler-mairose-sp
committed by
github-actions[bot]
github-actions[bot]
parent
a64965377f
commit
c8046964e1
@@ -132443,12 +132443,12 @@
|
|||||||
},
|
},
|
||||||
"/notification-preferences/{key}": {
|
"/notification-preferences/{key}": {
|
||||||
"get": {
|
"get": {
|
||||||
"operationId": "getNotificationPreference",
|
"operationId": "listNotificationPreferences",
|
||||||
"tags": [
|
"tags": [
|
||||||
"Notifications"
|
"Notifications"
|
||||||
],
|
],
|
||||||
"summary": "Get Notification Preferences for tenant.",
|
"summary": "List Notification Preferences for tenant.",
|
||||||
"description": "Returns the notification preferences for tenant. Note that if the key doesn't exist, then a 404 will be returned.",
|
"description": "Returns a list of notification preferences for tenant.",
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"UserContextAuth": [
|
"UserContextAuth": [
|
||||||
@@ -132456,24 +132456,14 @@
|
|||||||
]
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
|
||||||
{
|
|
||||||
"in": "path",
|
|
||||||
"name": "key",
|
|
||||||
"required": true,
|
|
||||||
"example": "cloud_manual_work_item_summary",
|
|
||||||
"schema": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"description": "The notification key."
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"responses": {
|
"responses": {
|
||||||
"200": {
|
"200": {
|
||||||
"description": "Return preference for the given notification key.",
|
"description": "Return preference for the given notification key.",
|
||||||
"content": {
|
"content": {
|
||||||
"application/json": {
|
"application/json": {
|
||||||
"schema": {
|
"schema": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"description": "Maps an Identity's attribute key to a list of preferred notification mediums.",
|
"description": "Maps an Identity's attribute key to a list of preferred notification mediums.",
|
||||||
"properties": {
|
"properties": {
|
||||||
@@ -132509,532 +132499,6 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
|
||||||
"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."
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"put": {
|
|
||||||
"operationId": "putNotificationPreference",
|
|
||||||
"tags": [
|
|
||||||
"Notifications"
|
|
||||||
],
|
|
||||||
"summary": "Overwrite preferences notification key.",
|
|
||||||
"description": "Allows admins to opt in to or out of certain notifications for their org. The default state is opted in. `key` is optional but if it is provided and doesn't match the key in the URI, then a 400 will be thrown.",
|
|
||||||
"security": [
|
|
||||||
{
|
|
||||||
"UserContextAuth": [
|
|
||||||
"idn:notification-preferences:create"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"parameters": [
|
|
||||||
{
|
|
||||||
"in": "path",
|
|
||||||
"name": "key",
|
|
||||||
"required": true,
|
|
||||||
"example": "cloud_manual_work_item_summary",
|
|
||||||
"schema": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"description": "The notification key."
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requestBody": {
|
|
||||||
"required": true,
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "Maps an Identity's attribute key to a list of preferred notification mediums.",
|
|
||||||
"properties": {
|
|
||||||
"key": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The template notification key.",
|
|
||||||
"example": "cloud_manual_work_item_summary"
|
|
||||||
},
|
|
||||||
"mediums": {
|
|
||||||
"type": "array",
|
|
||||||
"description": "List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future.",
|
|
||||||
"items": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"EMAIL",
|
|
||||||
"SMS",
|
|
||||||
"PHONE",
|
|
||||||
"SLACK",
|
|
||||||
"TEAMS"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"example": [
|
|
||||||
"EMAIL"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"modified": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Modified date of preference",
|
|
||||||
"format": "date-time",
|
|
||||||
"example": "2020-05-15T14:37:06.909Z"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"description": "The preferences were successfully replaced, and an echo of the new preferences are sent back to caller.",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "Maps an Identity's attribute key to a list of preferred notification mediums.",
|
|
||||||
"properties": {
|
|
||||||
"key": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The template notification key.",
|
|
||||||
"example": "cloud_manual_work_item_summary"
|
|
||||||
},
|
|
||||||
"mediums": {
|
|
||||||
"type": "array",
|
|
||||||
"description": "List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future.",
|
|
||||||
"items": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"EMAIL",
|
|
||||||
"SMS",
|
|
||||||
"PHONE",
|
|
||||||
"SLACK",
|
|
||||||
"TEAMS"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"example": [
|
|
||||||
"EMAIL"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"modified": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Modified date of preference",
|
|
||||||
"format": "date-time",
|
|
||||||
"example": "2020-05-15T14:37:06.909Z"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"400": {
|
"400": {
|
||||||
|
|||||||
@@ -98976,408 +98976,22 @@ paths:
|
|||||||
text: An internal fault occurred.
|
text: An internal fault occurred.
|
||||||
'/notification-preferences/{key}':
|
'/notification-preferences/{key}':
|
||||||
get:
|
get:
|
||||||
operationId: getNotificationPreference
|
operationId: listNotificationPreferences
|
||||||
tags:
|
tags:
|
||||||
- Notifications
|
- Notifications
|
||||||
summary: Get Notification Preferences for tenant.
|
summary: List Notification Preferences for tenant.
|
||||||
description: 'Returns the notification preferences for tenant. Note that if the key doesn''t exist, then a 404 will be returned.'
|
description: Returns a list of notification preferences for tenant.
|
||||||
security:
|
security:
|
||||||
- UserContextAuth:
|
- UserContextAuth:
|
||||||
- 'idn:notification-preferences:read'
|
- 'idn:notification-preferences:read'
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: key
|
|
||||||
required: true
|
|
||||||
example: cloud_manual_work_item_summary
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: The notification key.
|
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: Return preference for the given notification key.
|
description: Return preference for the given notification key.
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
|
||||||
description: Maps an Identity's attribute key to a list of preferred notification mediums.
|
|
||||||
properties:
|
|
||||||
key:
|
|
||||||
type: string
|
|
||||||
description: The template notification key.
|
|
||||||
example: cloud_manual_work_item_summary
|
|
||||||
mediums:
|
|
||||||
type: array
|
type: array
|
||||||
description: 'List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future.'
|
|
||||||
items:
|
items:
|
||||||
type: string
|
|
||||||
enum:
|
|
||||||
- EMAIL
|
|
||||||
- SMS
|
|
||||||
- PHONE
|
|
||||||
- SLACK
|
|
||||||
- TEAMS
|
|
||||||
example:
|
|
||||||
- EMAIL
|
|
||||||
modified:
|
|
||||||
type: string
|
|
||||||
description: Modified date of preference
|
|
||||||
format: date-time
|
|
||||||
example: '2020-05-15T14:37:06.909Z'
|
|
||||||
'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.
|
|
||||||
put:
|
|
||||||
operationId: putNotificationPreference
|
|
||||||
tags:
|
|
||||||
- Notifications
|
|
||||||
summary: Overwrite preferences notification key.
|
|
||||||
description: 'Allows admins to opt in to or out of certain notifications for their org. The default state is opted in. `key` is optional but if it is provided and doesn''t match the key in the URI, then a 400 will be thrown.'
|
|
||||||
security:
|
|
||||||
- UserContextAuth:
|
|
||||||
- 'idn:notification-preferences:create'
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: key
|
|
||||||
required: true
|
|
||||||
example: cloud_manual_work_item_summary
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: The notification key.
|
|
||||||
requestBody:
|
|
||||||
required: true
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
description: Maps an Identity's attribute key to a list of preferred notification mediums.
|
|
||||||
properties:
|
|
||||||
key:
|
|
||||||
type: string
|
|
||||||
description: The template notification key.
|
|
||||||
example: cloud_manual_work_item_summary
|
|
||||||
mediums:
|
|
||||||
type: array
|
|
||||||
description: 'List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future.'
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
enum:
|
|
||||||
- EMAIL
|
|
||||||
- SMS
|
|
||||||
- PHONE
|
|
||||||
- SLACK
|
|
||||||
- TEAMS
|
|
||||||
example:
|
|
||||||
- EMAIL
|
|
||||||
modified:
|
|
||||||
type: string
|
|
||||||
description: Modified date of preference
|
|
||||||
format: date-time
|
|
||||||
example: '2020-05-15T14:37:06.909Z'
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: 'The preferences were successfully replaced, and an echo of the new preferences are sent back to caller.'
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
type: object
|
||||||
description: Maps an Identity's attribute key to a list of preferred notification mediums.
|
description: Maps an Identity's attribute key to a list of preferred notification mediums.
|
||||||
properties:
|
properties:
|
||||||
|
|||||||
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