LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/get-access-request-recommendations.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

87 lines
36 KiB
Plaintext
Raw Blame History

---
id: get-access-request-recommendations
sidebar_label: Identity Access Request Recommendations
hide_title: true
hide_table_of_contents: true
api: eJztXHtz2zYS/yoYdm7aaExZku049szNjeJHq44T+2y5uRnHk0IkJKHlqwBpR/X4u9/uAnyJkqy4aS/p6Z/EIoHFvve3IMgHJ06E4qmMo4HvHDoTkfY9T2h9KX7LhE4vhReHoYh8GqKdLSflE+0c3jiD/oCZocyOZfODb7ccX2hPyQR/A/XhVGrWvxgwJdJMRZqlU8G4IaIsEVUnwsaxomE6EZ4cS+Ez6YsolemszYZw3RdjngVpcZXBEq1QtNj9VHpTJiNfejwVZi0vUwqGsUwL1QZhEq54KFKhUKQHRyKTwIaawb0I7sDPnK4rfWdenu9Fug77PCq4G/htw91qvrQ3FSF3Dh+cdJYgFzpVMpoQAyQuXALuHrccXFcqAbYb80CLLUd85GES4Jyed9B91Xm1t9/Z6e50u51Od7+z2xl1Xo53dneFdwDTF4scyFCmDWHf8I8sysKRUCweg5wa2ADuY2tMZLvBTEMOGaViIhSMDWUkwyx0DjvwN/9o/u7uVSTs7j0u4zAej7VosnhOl0G3wBWqdZwFgeWUwY02u9YZD4JZxZnuZTplLZK4hcIkfCIjsAvMV3E2mRIdK2z7fXQlBLv5aYec+CrlYGbls6M4CISHPLCLwqFuv5umaaIPt7d9cScCDLO25jJIYmCvDU6yLf1omydyW1s6rlfQcUvHfEEuFMZKgFzwZ0iOtVDbhek7KzVviJhLO705UxTa7yxVvhdnUVP3gzFrpSpD105Bq6D4JE6ywKhSsNZ/3GGc8sA9wtktVGkC8SHYVHAfXIrsgAMXuNiUA8U4C3w2EtbbMA2MC7uB/ljL+ATEvUBVTSLQmA8WA5vJyBN5gEIUMQ6GBlYYCcI8CM8pv4NExMBGpBwcL8OEe+kWSiN1GdawcBSn6Cla4KotIvJPkryFPBG3dzzIhNECjga2IbItN1+FB6E8C5xoFMeB4FE1D9HMpb4Cqg8yX7ip4pEOaGE3hHzJJ0J/igtxFkjIruAVFUospwRy5XFKTrUwhS7lfZUe7IjFwo1lQKVjeb5+nBfxlKYUrp1p9Ecqb7kr6FmUQqY100bo59Ff7C/fGLmAM9fy+QId9zS/ivGgsySJVQrs5fV5DKTie7wNeTXwNQWlARex0odIodUyxbKN+mu1DhkET6t2A7VHN8RvEHlR/WZFk3byFrPjnGrdqywCIc7eO9yHDPfeWVrvNEqy0o6VpIl5gLtaoL5A/qaJr4DaF25gFHjevFfm2nrGBe1XbbnFavZDcq9nBTIzkVmHRRySkTZrjGZsKidTBE9eHI0RKUH6HUul07bzeIvRaaJao116nQ7+V1f5mc0Na0LJEoyBYWHNFH4iUZ4kAYIyGLz9i0bKD02P4Epx9B2ZilBXrsejX0DRiCkVGiaVht/KWqu86vp6cNzMhzmkHRwXvNdlcj4R79nYWIftZ7B7XLEBqgfqHrpMpXa2FzG8s+f3xF735atOd8/f6Y1fHXQ83t171UWGDQtNVkSEgOXG6R8dnVxdfbi4PD8dnJ3Ajctz+G9B5wEwBEjMcVjnp0ELlG9uLG+JBkBliLw95ulkEWavsvIW8xIWsrL3QVZqnJzA//FMCBcW4SOuBYQq9917BSMbGeepBY/LX0+tSw0amW4CZTbFJM6E5YUhC5TViY2choXaOaPOI2ABx8KvhdV3DmPUeX03FUAN4J8yMKsSrQDSgJ8AuZgxbxoD/sLFzVIwsorSLMKxpR2M9tfwkieeZczcSXH/uTlRwuRq6GoM+aWrF7jr+ckMUqVKAIHz9TxvUMJNxkdxBqhuOpt3QHbP9fIccbD3D3TaWZwpgOdQvAxWJxlt0XHQ4+ZDtSr9GyO4GVfCxzcVfTSzxSq86WzNK7Bg+ObB+VXM4E4pkXKhJLd/6n14dzL4/ofhh9OT/vD68gTzzPH10fDD4O3w5PLi8mTYHw7O3374AQYBRWohaKdlf48UC/U7DbFS3WJRXNNixMtTZkJxYWCeHBZIXDPJH5PssRSt4YZNtsxQAAbKoACf4FS8jE+9wJdLKF4aaYFOKz40bPiIyWprloNjiA8Z4BSctLsIsBwFErd7TpSCkHbZZaWnNUXe5JFR7NN+loxAD5Ii41PhyhK/8InHo9hfo2Cdyki4UA8kciiIZQ8mMqB4J8kg1FsakrkT0bh6KIMm2l32GopIvmF4ZIUxcen9CrQW46Q6Q9eRhPksnwK5sIBHC5YV+4KPXnYOervjl7uc917tdvf3RgdjvrPTOdg7OHgiNc7v+EXQA3ksiD2wyO+gEKgBoHtigBZfP5sSjTX0T9mIxhZiWn5ZKj6mAL7Z66MLtrvPAh5NMrrOJ3NKiNzrK+x4siDgo7zOgOSG8LmSE7kwoec46/jktH99NkSAdfLv65Mr+AtpNYBWP8q3NmPaxJnG98SxFQBzvRbYkgjcCbVUWyAQt9vBdqA0v/RMY4mwrQTMsKsvmFElzcYqDmuhRHHzMWXfybZobwEyhWtQmbwpQ9QCnarZQWhhbCepe2Y12bL7Uy/arO/7EoXkQZ6VQj7DrR3u+6aLM1uOEMqCtrOw3kG5lp6o26JUZd0aZYI5qxoFgwM4f9pP+l6aAXMkZjUKC2+xLOZbz77VXJ27YUVppFJsV6GD9GjjlBKxB5kJZJOpZjYdUdcIiSfKxxUZq5o3Kd3ZjHqcxnTP45leI+4uAkg/LolW3LgTNvgIhJpsRNbIzWQzUl4ucLIdVZir2EGivnYTu5vY3cTumrE7f/PSbtPYuwR9uk3ocx3xDPSrqHg2oI8i74lilg8y8M4YcgsbIAuRfnw3hMD+FfouGC8+Jrh9+xnxkSnlDeb7hT3s9l2+u5eX/tIWyCDp0Ugwhkwk/EPiu+TYgERS1U5ztdNYjSQ4aLQAIuKTQuyKaCdNZVFEDzb0FvNjoaNvU/tIo9Kj46qR75rNwg2S3CDJTTXaVKO/TTXaIMlN7G5i9+uM3ZVIsuCKosXiJJ2FIVcz42n2Pj3aYTCgPFtShByZah6tIDFWYCynjhycUa876o73PbHr813/5c7BuOe97PG9/e5+d7Tb23eqtf6mjOMiyOoxVbG3sSOpGEDcHeC4DPdSdRrHfn37L8NnmGNMa5h6CtwMOscnowV27B0s2MKOY/aGR7McIekahoxKHWFOg7EhjlX5WBjA2QTyYoRnYiTwha4kQwFU8LE3o4M3GLwoBdBVM7c/xpMN9jjP3IEMZs+BaMoEQWw2ce+5xLMxY3p+o2aEYCeQnT8jOs33r/8IkmeXKPEZSsxOPnpCYKAXyH1v0f7uAB+UYI64MgZestFruh0egQNAQ2ByVoE7N/h8g883NX5T4/8eNX6Dzzexu4ndrzN2PwGfWzS0HJ/DgLXxOYxtd1iBpU7p0O5fDdMpVCwH5jxj7NHrGn6JwQlXgCvZN2gwh/B0Cj+2uXTNHqxrreWqxhs1pgkw7GUqgGn5Mc8HsBpY67GNxyzyEz9RfE9nPUegqgVZCI8LmIjDAXSq1CzQJj0ria5s8h4RN1rPXyopjpOupBzZI2x0KseQ2cLjddat6DKwmEBP8a2m0W1yo4Z8INe1Ch7/uCyG0BJZFqlv5WowngGncyKiCLdoLjA/ECJ7XQM/RyZp9TM0+c1tdcwVgnTDYWNkWXiwses1GDrHYT32WnAFHYR51vHdj++GL9gEoSmlBnO8WEg6HcbZBbgRpb5+vu+Pk6galS+z9GtPVjDU2DgApTD7bkJ+6vQt1IRLSOKkdpwkKG/grPUPIvPavCVvIryPXHYslTmnbI7pWhHN2xo3SS4Xr8j1XCa+yanlkUnU8BB0jQuj2hvPnNTxIN6RBA80aevZixt6boWeS0ctXaQ6zwNqwvJRfx7m5VZ7Nh81ei7Sq/PxPnpH78/VpzGT5pie0us4Azz7GGvxL8bQdTBUbiYZRNqz2aKX9lyKCLfXqbDkmiVd6QKKJP7OIDAi40zmbCGBmBjwXeSbsP2ZLAt54Wc6tvpzTWa6fAPFFkf6sfcJp+vneMYFXVzQNXlCW/5NLUPHgthGGSgPGAc4Ku1PmcAyWsmNhtbCzE/kt2kOlg8PWCUqOjk0Pw7LJJgfwqcbOLoYA6nayV+WoO2lIGCWFha0mrLy7YN5DTb5DWKoo3N6M/wW21dYW780eVHifrnLch4Fs8+dpZdkki8n7/6PMt4m0/wdM42FxehutKztH6pO/tpiuuaun6Z3RuFfuEuxSggc+pvyNdEqoSTgKXo1RbU3lYL2CxKBryQE+HJSlsYhRSK09hj+0BUSoYmCMRC2GnArH8kgf6k8X5lTwBjwiXalt5YyalpwLW8K/ados3fQwkUemAXbNzyTAfd+iW0fdwWWuUDDsuPc2AC6wjCL8PQ+sJ2FjINLPeERvtReZhIXdHORyHURE/QrZuVRjK6GIrSpkVGhPh/jVjR0uRXDP7EW2F3bfWhQPVrRvi9XCnIpgqKNqUP7p2iDt7lTESTYQELWBQAmKiu8GQwbFIFYpEEuaNRjNdm2k/Q2jsVD5SC8cZ+ddrfdcamlgOtJrFNoeSvEi9eqnvh8QeM1m2JH/sv7kIEtUthdbCe4g4aiZ6YjMr3ojfN0LwqdyxTUhYMfHnDHBZuzR7xs3pjEjgcMiFFVviu7VEl/2tcRFgpr3rqof63BbiuYNz/XZ3yNLx2sYCH/esIzF///+obBCj0W33h4piI3HyT4+j5IsMId8q9OfH5v+PRvC6xKQKs/ePBM7jefDfizPhuwwpTl5x2eabXNlwA+45cAVpqq/IJDaarbcouYtmUB21Bmr7yjaR4jVWY1DloglWJr//sTQJqP/wUeqHVc
sidebar_class_name: "get api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Identity Access Request Recommendations' (get-access-request-recommendations)"
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Identity Access Request Recommendations</h1>
<MethodEndpoint method={"get"} path={"/ai-access-request-recommendations"}></MethodEndpoint>
This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"identity-id","description":"Get access request recommendations for an identityId. *me* indicates the current user.","schema":{"type":"string","default":"me"},"required":false,"example":"2c91808570313110017040b06f344ec9"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.","required":false,"schema":{"type":"integer","minimum":0,"maximum":15,"default":15}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"include-translation-messages","description":"If *true* it will populate a list of translation messages in the response.","schema":{"type":"boolean","default":false},"required":false,"example":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**access.name**: *co*\n\n**access.type**: *eq, in*\n\n**access.description**: *co, eq, in*","example":"access.name co \"admin\""}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **access.name, access.type**\n\nBy default the recommendations are sorted by highest confidence first."}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
List of access request recommendations for the identityId
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Identity ID for the recommendation","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"AccessRequestRecommendationItemType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE","title":"AccessRequestRecommendationItemType"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the access item","example":"Employee-database-read-write"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the access item","example":"This item grants an employee read and write access to the database"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"ignored"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true,"description":"Whether or not the identity has already chosen to ignore this recommendation."}}></SchemaItem><SchemaItem collapsible={false} name={"requested"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true,"description":"Whether or not the identity has already chosen to request this recommendation."}}></SchemaItem><SchemaItem collapsible={false} name={"viewed"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true,"description":"Whether or not the identity reportedly viewed this recommendation."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"interpretation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Information about why the access item was recommended.","example":"95% of your peers have this access."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>translationMessages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The list of translation messages
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"key"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The key of the translation message","example":"recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH"}}></SchemaItem><SchemaItem collapsible={false} name={"values"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The values corresponding to the translation messages","items":{"type":"string"},"example":["75","department"]}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"identityId\": \"2c91808570313110017040b06f344ec9\",\n \"access\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"Employee-database-read-write\",\n \"description\": \"This item grants an employee read and write access to the database\"\n },\n \"ignored\": true,\n \"requested\": true,\n \"viewed\": true,\n \"messages\": [\n {\n \"interpretation\": \"95% of your peers have this access.\"\n }\n ],\n \"translationMessages\": [\n {\n \"key\": \"recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH\",\n \"values\": [\n \"75\",\n \"department\"\n ]\n }\n ]\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"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,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"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."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"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,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"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."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"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,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"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."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"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,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"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."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
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.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"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,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"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."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"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,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"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."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink