mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
87 lines
34 KiB
Plaintext
87 lines
34 KiB
Plaintext
---
|
|
id: get-evaluate-reassignment-configuration
|
|
sidebar_label: Evaluate Reassignment Configuration
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXFlz2zgS/isobtVOkrJk3YdfthRHTmnWOdaSNw9OKoZIUMKEArkEaUfr8n/f7gZ4WZKvSe3OZPWSWCTQ6BtftwDdOGEkYp7IUE0858hZiGR8xYOUJ+JMcK3lQq2ESo5D5ctFagY6B07CF9o5unA+hfE3Vh7ofDlwPKHdWEY09MjJyGmWLEVlLKtQZX4YM67Y5cSDdzJZX7IkZJ5IRLySSjDps2tcTSZipWkw0tORcKUvhceSdQQfl2EaeGwuWGwXEl6dTXzGGbAhvfvWl0g1VV5OW1pG2F/NyrjCAb5RQC4Iw29phJOkkokEAT12vZTuElZ201jLKxGsmS8Sd/k40XGIEt8TdjnjMZihUEMK/wdMhWwVxiiYToNEMw5/G35Rb2zFv4OyomTJQp9162y25EnGZBJzIACsRnF4BVJ5wDOtB7SiUGkBevfogS8VD0q6K3RgZ1iKgdQJEoxFksY4jhsZL7Ops3DiXeJ64F3JmkwAAjxF+4VlS3ZwaY6xNRnCSPGvVGg0QKYzNnnDrmUQoCOkeid76JmF7Ea0GelKhZ7IKYhVBCKA12u0LJAHz79xzrWIQYQETDZKkyVGg/TUUVwSseaWRTwSNhKcL7cQJRGP+Qq9WxM5ibEScSB04Ch4AZ8yuSEwDxwUUsYCYjSJUwG8gF+tuHN046AyYLROYqkWzu3d+EuVBPWUDInUxHe+igKc1nKHzUFj0B80eb/pefNGc9CcDxvDxrzrdhsdAQS3MmdEm+Haj2duIzeodGV8CZzWBGgeaWgxcGEXUgLYQItAuGhiyhL3OBIKB1TRHKPj4/F0+vVs/I/z8XQ2hTfH47PZ5GRyPJpNPrzHB+9G789Hp19no+nfp5i6Cr1sTgbt0ZvjXHJkf1PhFd5ycSpK564rtD4zfqsLFcPneF3oWHx3g1QD1RMZkKOUNe3zQG9TNY9jjjQoT27xjw1+x9kqEP20jFG8JzWfB4KBn0K2AfuYUCvJZv0ZZtbZxxCe43CKKZOd0LACk3EQXh+xGrucjk9PQKP/nIw/fX0zPh2/JTtcHkGygvCncCORIfY8sPeCaNPaYH6/FosrKa4rPOiKWrfTdzDaskxHGmk1Gvjf9n3qvj0CVnMx5GGfg/k8igLp0ovD3zQSuXm8OcL5b+DQGxExK2fleeityeEz3u5nzWZbaYQsp7qHIxHXrWRP2sqK7dQY35WRxJXBIlyty/uxxsewX/Msb7tbt8+KuQa9YbvVmPfmPb/d4c3ecN5r9gfzJh/0uqLX8zG0Skl5i1KrMpzaRFJWUrarzNeU30F0hhvizr1WqjvZ5a6Sn2BHT/iEDSCySGGFgiH+w9hDZkBlD2AD2GaupCt22ld4T7DwmyyQc1aul6G1oy7v+0n4ZFMVs0/icPXjWfKBaoWpbnPYGfCB3270eEf0+ZD3/IHf9Rrtls+7Q1FmChVLm9VG3FdUb330LtvZjmK3i7PxaDqdvH3/bvx+dgCvR+ezD+8g1xxvffN1PD0enVIqwkc7klR189lKsLQHnd0Ry+xEt8WAU4qbaSIieFx6XoB7k2Nokl2Y3IrADmWydLXisBsVc4rEdI3Q63F4DpimLWEzJWXQo9XlPbfJPbfR7AIGcYeNVttvDJoD5074X3y5pYygFnk+eJBJBOoQZlUjZ3D4hzO4GZUZjU633x00W90u0IC/ho1ex2+354Ohsy1wHrPypmfvchuEFxt8NfoQ0J1hp+m3/c7QbczbvO12hl7TbfaF3xD38vUYaZ7JV7vpDd1eu+l3u31YpsmH7S7nHAK9B+t5/na+niDNM/lq9Yee6DZaouu5HVhk0O0IAMo9v9t3u/3BDr6eIM0j+CL/Ryh0RkjokQFQxk55lYVFz4orvhAx1o9hvGDcgzqbQW7kQR7CBHHEPkb+f2NkF6b+A8fILe14nW0g/zgg/DqOY3D6GmwLtn0h/XInwQBvau1QUVp/Bu7PcWEVtXkigTA4Dj3xMDw6kUrUFhA2yKEgll3sS5guDqJHaggZkhmKonH1Ck4CTdSb7DXHysbId2yFQWAQcxdh8WPw2rlpJWRTAOHn3Zoty4q+4PNeY9jq+L0O561Bp9nvzoc+b7cbw+5wiKuvoAyGHKQfxPZvhRIxFBVBCOlJ/hsUgj5hW2e0+H3YvGoDovEI/c+oKYRjczEtvwy7PgeQW18ff2SdPgu4WqT0nC/uKEHVzrF5oNIgwHLadEgIxiDhD7FcSLWNlQxyvhmfjM5PEfvZVoRzgLQ22qwjyNfKQ7fEdO6zZXhtu1okwDXXeQ+lzl5Zqq9AIK50eaA0n/QaavcVljA8DRKYYVffMqNMmkB6JZRc0yJjL2Rd1A+glIRnK55AcTnn2JkLTQ/v1ch1RZTUTq0mX7Gl4J6IX9bZyPOoiOJB1lxY8TXWpNwrtTL9FEIZe3YJ1KwJgNMEiqaqLQpVVq1RRs0lo2BwAOcP+8nITVJgjsQsR2HuLZZFax/g2Wiuyt2spDRS6Vol3AUpeBCsQY0xlN+QmUA2CVWtTUdoLg2JR2Xj8oxVAf3IzTvDzBuo7PCdy1P9iLj7GED6qZFo+YsrYYNPY/lqe8pojcxMNiPZ2pYm3+08Z4HPfCkCbx+7+9jdx+4jY/fuy6yUt28J+jQ3oc+54inoN6bNcwP6xOQ9UNJng0wJYAx5gCWChUi/fppBYH8TVB6I7xE2o38gPjJb+Qbzo9we5vmcemeZsSq2QAZJj/arNchEwjsivguOnQIltjdXOwnjuQQHVVsgImTNmK3DlDrccaoUcsL1AfNCodUvCVtyyI+mwW8yIK6qvFoUSpXskeQeSe53o/1u9PPsRnskuY/dfez+OWP3XiRZ/VrI4qSi3QyeZt/Tl5sMBhSd5zzk8q5xGa0gMZZjLKeKHJx5qzlv+n1XdDze8Xrtod9yey3e7Tf7zXmn1XfKe/1FEcd5kFVjqmRvY0dSMX6pCjguVeBcOglDr9r+A/XGwse0Rt9pZ7gZdF4vdxhbw03sOAtD9g6/HM9Od1QwpCp0hDkNxq5wbJyNpa+fF5AXFYNUJYEvdCW5EkAlxuZ+IFeSgndG3xon8bo28hMQxQTKxsEuqeg8haZMQF+FwbrXXIKQwkfMBxQIwS4gO/9AdGpN9LuQPDtDiU9RYjb+7gqBgZ4j9+62/u4EmI8xR0yNgXc0ek21wxU4ABQEJmfluHOPz/f4fL/H7/f4n2OP3+PzfezuY/fPGbtPwOcWDe3G5zDg0fgcxtYbLMdSJ+hc/3WYTqFiOSD3ZqHrpjG1mzMMTrgCXMneXMEcgofUj5zD3cfw9eFNcbD+9jA7lH94U5xov3XwmA0CSMN7GgdAc5kkkT46PLwBk4Ipb+s8kvWMlAqv6264OpyDHrekKDxLYMIRB7DRx4ktQepkhFiin5ukSMSNSUhs9GgwDbWP76WMh8bR1uswhTRIZA7wQKP1OXoMLEZQcPyiaXSdfGxDPpDrPA5uf78shtAOWbap797VYDwDTu+IiCJ8Ka5mTBGdm9U3LmgUOw5WdK2NxT7gsBZ7LXgMpYP5kuPFr59mL9kCMSnlhFQjHBYSiwiIqo/gIpTzRlnDHyfRNhSH6WJJjI8qX6lgjDE/AIHZZzUVgl1kB1/fw2ZwBtmbVIqTBCUMnPXlRWYdT1yJAPfJeqFJdDzpqUPQ0CGvzHtJeyIVD1LBnytzXP+zqrE3ElMVHbDHMVZEqgXZRZTJxUtyPZeJv2TUaoZajajpl3e4MKq9cM0RHRcCHUnwQJO2nr24oVcr0cNKC54g1bs8oCYsH9UvwtzMas/mo0KvhvSqfHxWn+jMfXUaM/ktO4k/Ye4yDLX4G2PoOhgGF4sUoujZbNFB/xpFRK3VKLFUM0vWZA3gI/F3CoGhjDPxOW7fhF5CvDTmmZC8JMtCzF/SAcPLisz0+AJ2WRzpha5+Ns+4YA0XrJkcoC3/ZhNDx4LYRhkoDxgHOC7sT5nAMlrKe4bW1qxO5A9pDm4NLrBKVHR0ZD4cFQnO/sXoBY7Ox0AadrK7P9RXCgJmaeFOVlFW1je4q8FNfoMQNtA7ejP85n0r3FT/aPKixKOivfJBBesfnaV3ZJI/Tt79H2W8fab5GTONxcPobrSsLRzKTv7a4rXNdp+mG17wL7ylWCXoDYUNlWqV6zlIKAp4gl5NUe0upaBGQSR4gtjvAD0rXFEkQk2P4S+0IbQAXI7dajpkPpeBxLvBs2JlTgFjgCXaFT/rlKoVXMtdQuEp6uwT1G7KBbNg3YaHMeDdb6Et4KZgmY9oWPYmMzaArtUqVXi5CNhOV4yDSz3gEZ7UbmoSF1QGSmS6CAn65bOyKEZXQxHqVMHEK/3Bn9qbW4XhH1gL7K5tAxpUj1a0F0ELQc6EOZyP46qw/SHa4G21pQgiulUHbOHln2KFd5PZBkUgpjTIBRV6GC8O7SR9iGOBCJZHxn3a9Wa9UaNyAZ5HoU6g1i0Rf9z1xYpL3hRt+P0vCOx/QeBn+QUBC22wJj2MsOGKAZOaGtm0Li6ce1oXQOGo8qsA+U8KwIvSjXwoiJcQhUjt5gY7eFjP3+Jjc8Mcmxr2fndxk3x3/P3JL4hvVfo3gV2yLTfsbUvMoWvjWTvjiRp7cWav6b9kW39+YStHWXderctcZJyWzI4tm2fxsvOXCZ7BT8nbbr/AaNMIJj2ZAaZVXJq68WUqKjhv370d4wbEd5QA9g+6Anr7H3H1kbU=
|
|
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 'Evaluate Reassignment Configuration' (get-evaluate-reassignment-configuration)"
|
|
---
|
|
|
|
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"}>Evaluate Reassignment Configuration</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/reassignment-configurations/{identityId}/evaluate/{configType}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty.
|
|
|
|
## Request
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"identityId","required":true,"schema":{"type":"string"},"description":"unique identity id","example":"2c91808781a71ddb0181b9090b5c504e"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"path","name":"configType","required":true,"schema":{"type":"string","description":"Enum list of valid work types that can be selected for a Reassignment Configuration","enum":["ACCESS_REQUESTS","CERTIFICATIONS","MANUAL_TASKS"],"example":"ACCESS_REQUESTS","title":"ConfigTypeEnum"},"description":"Reassignment work type","example":"accessRequests"}}></ParamsItem></ul></div></details><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":"exclusionFilters","required":false,"schema":{"type":"array","items":{"type":"string"}},"description":"Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments","example":"SELF_REVIEW_DELEGATION"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Evaluated Reassignment Configuration
|
|
|
|
</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={"reassignToId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Identity ID which should be the recipient of any work items sent to a specific identity & work type","example":"869320b6b6f34a169b6178b1a865e66f"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>lookupTrail</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"reassignedToId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the Identity who work is reassigned to","example":"869320b6b6f34a169b6178b1a865e66f"}}></SchemaItem><SchemaItem collapsible={false} name={"reassignedFromId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the Identity who work is reassigned from","example":"51948a8f306a4e7a9a6f8f5d032fa59e"}}></SchemaItem><SchemaItem collapsible={false} name={"reassignmentType"} required={false} schemaName={"ReassignmentTypeEnum"} qualifierMessage={"**Possible values:** [`MANUAL_REASSIGNMENT,`, `AUTOMATIC_REASSIGNMENT,`, `AUTO_ESCALATION,`, `SELF_REVIEW_DELEGATION`]"} schema={{"description":"Reassignment type","type":"string","enum":["MANUAL_REASSIGNMENT,","AUTOMATIC_REASSIGNMENT,","AUTO_ESCALATION,","SELF_REVIEW_DELEGATION"],"example":"AUTOMATIC_REASSIGNMENT","title":"ReassignmentTypeEnum"}}></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 \"reassignToId\": \"869320b6b6f34a169b6178b1a865e66f\",\n \"lookupTrail\": [\n {\n \"reassignedToId\": \"869320b6b6f34a169b6178b1a865e66f\",\n \"reassignedFromId\": \"51948a8f306a4e7a9a6f8f5d032fa59e\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n }\n ]\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"empty"} value={"empty"}><Markdown> Evaluate response when no Reassignment Configuration is found</Markdown><ResponseSamples responseExample={"{\n \"reassignToId\": \"2c9180825a6c1adc015a71c9023f0818\",\n \"lookupTrail\": []\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"longTrail"} value={"longTrail"}><Markdown> Evaluate response when a long Reassignment trail is found</Markdown><ResponseSamples responseExample={"{\n \"reassignToId\": \"2c9180825a6c1adc015a71c9023f0818\",\n \"lookupTrail\": [\n {\n \"reassignedToId\": \"2c918084575812550157589064f33b89\",\n \"reassignedFromId\": \"2c9180825a6c1adc015a71c9023f0818\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n },\n {\n \"reassignedToId\": \"073204941f3f49c0b3a3c49d1c17ef0e\",\n \"reassignedFromId\": \"2c918084575812550157589064f33b89\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n },\n {\n \"reassignedToId\": \"31d9c631f5574571a935aaa48a6255df\",\n \"reassignedFromId\": \"073204941f3f49c0b3a3c49d1c17ef0e\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n },\n {\n \"reassignedToId\": \"279de502e5dc43f4854e1b96f57c578f\",\n \"reassignedFromId\": \"31d9c631f5574571a935aaa48a6255df\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"selfReview"} value={"selfReview"}><Markdown> Evaluate response when a self-review is found and manager or org admin escalation is applied</Markdown><ResponseSamples responseExample={"{\n \"reassignToId\": \"2c9180825a6c1adc015a71c9023f0818\",\n \"lookupTrail\": [\n {\n \"reassignedToId\": \"2c918084575812550157589064f33b89\",\n \"reassignedFromId\": \"2c9180825a6c1adc015a71c9023f0818\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n },\n {\n \"reassignedToId\": \"073204941f3f49c0b3a3c49d1c17ef0e\",\n \"reassignedFromId\": \"2c918084575812550157589064f33b89\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n },\n {\n \"reassignedToId\": \"31d9c631f5574571a935aaa48a6255df\",\n \"reassignedFromId\": \"073204941f3f49c0b3a3c49d1c17ef0e\",\n \"reassignmentType\": \"SELF_REVIEW_DELEGATION\"\n },\n {\n \"reassignedToId\": \"279de502e5dc43f4854e1b96f57c578f\",\n \"reassignedFromId\": \"31d9c631f5574571a935aaa48a6255df\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\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> |