mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
95 lines
32 KiB
Plaintext
95 lines
32 KiB
Plaintext
---
|
|
id: get-source-entitlement-request-config
|
|
sidebar_label: Get Source Entitlement Request Configuration
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW0tz2zgS/iso7WESlyjZkh3HvmwptuLVVGJn/ZgcnNQMREISEhLgAqQdjUv/fbsbIEWK8iPJ7M5MSpfEBIFGv/trCLxrWRHmRmbz1uH1XevKCnOkVSa+ZIM8m8FYS0bq0OrchMIeGsGjVrs2lHDFp6L1cfGx3dKpMDyTWo2i1mFrKrILmjRUmcxikQiVnYv/5MJmsMVEToFSxqcWN3ETbQuIRMKGRqZIBohczqRlg3cjBtQsy2aCAbcGKDGxpMqMI8tCops7JthEG8aZY7TDiJJ7CGJxI+KV2Xam8zhiPE3juVsax7RhZSPLpKIxT/SD+qAGITBuSxYyzbiaP7Co2Gii41jfwgtgq85JrmKkCKyLlMNYjYW1vAOJSEykEhGwFLBjMKiaMl7jrO22qmngcR3qG2GMBJuQBNNYj3nMtJlyJX+nGev4ISb+pW/hjWmv6nCtAM/kpJDgeW3PB23m9A8q/ywUu5XZjJ2dn/w6OH47Om2zi7Or86Nh8QT29AMXV69ojHFwcI2ej+pD6aUREdovdJZ3jtcBLzXCplpZ8M/Du1Zvexv/q7up819W8XTmXZ0d1QQ9FhmXsUWqIcaZypAYOp0MaUb3k0WKdy0bzkTC8a9sngrYQ48/iTBrrUbIo3vCitRgaGbSSeD8oh6Ka7ZZWZTC8w2PL5AtN+QXcGP4vMHWmYkE6jOWwI+esGI9s5lILQUYOkbdRztsmKRgkNsZGFTp5aKKhVB1MhOJfSrPwlzSrHK2zTA8YLZQeYLZZ3h6Obp8M3wL//969v50eA7vvLcUj28Hp4MT+uvk7Jfh+engFF6enJ9dvWvmrGN6GvuYkSqSNzLKKW7Y1Og8hXGeOZnIseQ4Fi7lqLqeOuwXHoNiGDegKutzhiW/39pqsL21dcjObpUwqHDSrrU6lJBBoqprutVVAR9a6FzbrfFawOlvKe+XC0YRhbjLnLczndBokVNA1LHAlJTwyJNaVSPSHLATNJfiCmLpBDXlssfoGLe5nclwhqRsKkI5kcDbeE7vt7YKS4+irS0Gr2IsU+ILT9IYLd6w2aLdWi5Z5xoqj2M+xsWZycWqhUdRIbfnJWQFuTbLLXCmVezduOqEyH2Dlyqjoi/4+OVeL3jZ39kLdl/sT4KDSOwH+9si4gf7kxf98GVrAdyTMevRP6hFKM0yRYwnRfHFCKrIO9Y6Flw1onc0qdoPzJzkYEakD3kZKlPoKLJoXaXpELkJz2NIbhMeW1EREdW5wPdK8vg7GLuR4vZ+vkjzsMccuVuTZx7ikJ7v0/Ga1LnK4lEDhPhdK5qCKlNFCDWTPgKaFiWrlONORMa8KL44NqvTJSigPqeGjQpEEmv9GfL1Z0Eac7kGeQZlGjcmKDuvlALKcFC8KN9BXqvkbZe4qpn7BvPZA0WoUWauP97vxt5y9/iStyPoC3Xk5SaUoJUoWWxqa6QAAVhBRYtZUEC8nO3ykacVPqS1bxP2rpaWMAm1V6pYvTAtHtBOkbi+UjkJeIlMKzLbB1VUTid8Zqul3j5dWWykPNgLheJG6vZKxPqIx1CnYe+yUw3LoFBMZyVcL9QFc3AphBG8mf/PzNHEDov2V1txZUXrYE/s9V/yftDfDneC3X6fB3yyDQVhLKKD/f54HPZ6rQbNZpX7Xu9YkIfsrkO8R7HERDs0BjJJAMgzyw2gdyZrlYONdUT4WipQrIy+C/fWwV1ESPpIR2uhXZ3Z19BYBFPDsb9gglgOYaEvHARMtMEciSSL0k7zOrXyDJro7LBXPKoibRIG87fh4WegtR5Q1Bm6UhLWs2IJk1GJiNdsK/YBFbzYPujtTl7sct57ubuzvzc+mPB+f/tg7+AAdweHtQDIHgfmJwJwHgCWWEOfI38HhUBXb32los2fDrCJxhP0jwXIzS3F9PwyPGqAYGevjt6x3X0WczXNaZxPV5SggquLBjIDyR3hMyOnUj2E8o+HrwdXby5h5Hz476vhBfyFtBrwfaCKiqYJ3s6oSy8FuOWYWWJQB1Q0tuWpboFAXNnqROme7BwAVFLUX1jhd1+zokqaTcwKiA7duQz0yh3RaQOghrGEZ4CJx9xBTgeGEaOkWfDGa3KLzQSgbvO8wwZRJFFI6C5uXF+R8DkQYjyKMHQdgUkOoSyoGOgcy3kmQ1G3xVKVqzi5ADFvqkbB4ADOH/eTQZhhn0RiVqOw9BbPYoE4Iq+5OneXFaWRSucq4yFIgYUA1GgMaJiNQTaZWebTETUWkHhUMa/MWDUoiNy8dcwcZ5rehTy3T4i7dzGkn4BEK1/cCB98hAhLGLs0k89ImSaxabGfVZqrCPyy7dnE7iZ2N7H7lNhdfXnuz/n8W4I+O03oc6X80SEWzwb0MeQ92AT5Sa4PdIakg0gPkX5+f+mPLmG++JIWLdIfhI9cKW8wPyjt4cbHRYdclP6lLZBB0qPvZCETieiQ+F5y3FqixH5zt9fajCU4qFoDESFrGjbXuesRc6WoP7ZtFmlh1U8Zm/EbUWmYqT8QKgpSLVW2QZIbJLmpRptq9ONUow2S3MTuJnb/nrH7IJKsH9h7nGTzJOFm7jzNv3dHzjCh+GEQRoqQKw8vq2gFibESY7XqyKE17u2Mdyb7odiN+G70on8w6YUvenxvf2d/Z7zb229Va/31Mo7LIKvHVMXezo6kYgBxN4DjcgXOZTOto/rxX44ntxNMa3QzosDNoHNQ6ccSO/YO1vxqoTX+yjgvEJKtYUi11BHmNJib4FxTzIUJnE0hLyoGqUpq94udTARQoTsVsUwkBS9KAXTNPBhM8KcuFyiFk5W7SBXGOV5KwEwQa0TNGhxLgpBigpgPKBCCnUJ2/gPRqTfRdyF5do4Sv0GJ2fBLKAQGeonc99ad746AeYM54sIZ+J6DXtftcLy0Ag2By1kl7tzg8w0+39T4TY3/MWr8Bp9vYncTu3/P2P0KfO7R0P34HCY8GZ/D3M42K7HUa7px9P+G6RQqngN3CUiHdIs6WmJwwhXgSv7iNuYQjve/W11/0bt7J6NFt3qP1xsvCItrUK4VcEzmJobFsyxL7WG3ewe2A5stOjyVHemvCip92wl10h2DwtbkIrw04OIOJ9AdcLeBu8phJDq0y35E3One3+lqWbABnRM/SFnxhIw6BxmZI9Nm4PzeuWgYWEyhs/jJ0uwOOVNDPpDrysSL75fFEbpHlnXqe3A3mM+A0xURUYSP7fLif+VGb+P6/7K0YOvWa2x2htN67JXgBnoE92vGs5/fXz5nUwSfFPw53qFiQmK3AOHzDlyEktugONnHRVRv3EUeZHxQ++0Eg4lNYhCYfVAXQrDr4rrpKWT9c0jTpFJcJCgz4KqPzwrrRHgzCQtiZ6lJdDwZqS5oqMtr655T8aMuQSr4M1leaT+WmJMkFnGc40Wkpo9dp4VcvCLXtzLxj4Ja4KgFRM0+X+HCqfY6dHdxQohod9/Jkra+eXNHL6jQw5YKRpDqKg+oCc9H/RevsLDaN/NRoxcgvTofH9R7uhNcX8ZcIiuuiI1YONPain8yhq6DYXA9zSGKvpktuogcUEQEve0KS4HbMpAB4ETi7w0EhnLOxMdYpwmmaEBwKnIh+RtZFmL+N+iiI/ZbTWYavoZyijMjHdpv5hk3DHDDwOUA6/l31QodC2IbZaA84BzgaGl/ygSe0Urec7TWZnUi36U1WBpCYJWo2PTQPRwuE1xxN5Ve4OxyDqRhhNnlb4B4yc/TwpJVU1ZxQLCqwSa/sYZKuaI3x295QIXV868mL0o8WJ6jnKl4/kdn6XsyyV8n7/5JGW+TaX7ETOOBL7obbes7hKqTv/J4rXmuZ+kOM/wLbylWCWNDB+OuUWeVj2KQUBrzDL2aojqcSUEnAqngGWK/NnqWTigS/RVn6PuI0NTAHAhbC5iUj2UM9OjMutiZU8A4YIl2xWebU1tCH7PNoMMUHfYeP8ILwSzYoOGtC3j3SftO7QIs8w4Ny44LYzO8FJwr/0lPnjAOLvWIR0TShrlLXNAUKFHoQhP0K1cVUYyuhiJ0qFUxiT2b4GEz9LEVwz+yF9jd+pNmUD1aEVE6dkGlIOciJs/EeXXY/hht8LZgJuIUW0TIugDARGWHt6PLBkUgpvy3odpMu36R7eJcIILtkXOffmensx1QuwDjqbYZNLUV4ngr/6kfFa765t3y4H3z/ezm+9k///tZj06wreymeDiKPp+7NtcdM1y3/DEDzD6U9PHe/ScN0LvOIGBw1d0dnqph673AYZiGRzb4zVDRVeMT7OZO1+ho4rOgUx06f1se3DR/ocIeuTwTORlisPN74Jb/A7daLP4LGuVdRg==
|
|
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 'Get Source Entitlement Request Configuration' (get-source-entitlement-request-config)"
|
|
---
|
|
|
|
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 TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Get Source Entitlement Request Configuration</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/sources/{id}/entitlement-request-config"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source.
|
|
|
|
Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined.
|
|
- During access request, this source-level entitlement request configuration overrides the global organization-level configuration.
|
|
- However, the entitlement-level configuration (if defined) overrides this source-level configuration.
|
|
|
|
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
|
|
## Request
|
|
|
|
<div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Source Entitlement Request Configuration Details.
|
|
|
|
</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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>accessRequestConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Configuration for requesting access to entitlements
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approvalSchemes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Ordered list of approval steps for the access request. Empty when no approval is required.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"approverType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ENTITLEMENT_OWNER`, `SOURCE_OWNER`, `MANAGER`, `GOVERNANCE_GROUP`]"} schema={{"type":"string","enum":["ENTITLEMENT_OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**ENTITLEMENT_OWNER**: Owner of the associated Entitlement\n\n**SOURCE_OWNER**: Owner of the associated Source\n\n**MANAGER**: Manager of the Identity for whom the request is being made\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"}}></SchemaItem><SchemaItem collapsible={false} name={"approverId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"e3eab852-8315-467f-9de7-70eda97f63c8"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"requestCommentRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If the requester must provide a comment during access request.","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"denialCommentRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If the reviewer must provide a comment when denying the access request.","default":false,"example":false}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"e3eab852-8315-467f-9de7-70eda97f63c8\"\n }\n ],\n \"requestCommentRequired\": true,\n \"denialCommentRequired\": false\n }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Get default config"} value={"Get default config"}><ResponseSamples responseExample={"{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Get config with one approval"} value={"Get config with one approval"}><ResponseSamples responseExample={"{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverId\": null,\n \"approverType\": \"SOURCE_OWNER\"\n }\n ],\n \"requestCommentRequired\": true,\n \"denialCommentRequired\": false\n }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Get config with multiple approvals"} value={"Get config with multiple approvals"}><ResponseSamples responseExample={"{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverId\": null,\n \"approverType\": \"ENTITLEMENT_OWNER\"\n },\n {\n \"approverId\": null,\n \"approverType\": \"SOURCE_OWNER\"\n },\n {\n \"approverId\": \"95e538a3-30c1-433a-af05-4bed973bbc22\",\n \"approverType\": \"GOVERNANCE_GROUP\"\n }\n ],\n \"requestCommentRequired\": true,\n \"denialCommentRequired\": false\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"}><p> An example of a 403 response object</p><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"}><p> An example of a 500 response object</p><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> |