mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
95 lines
34 KiB
Plaintext
95 lines
34 KiB
Plaintext
---
|
|
id: get-access-request-config
|
|
sidebar_label: Get Access Request Configuration
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW1tz27oR/isY9uEkGVGW5LtfWtlRUp+J49SxJ9OxM3MgEpSQkAALkLFVj/97dxcgRUpyrFzannNGL3FELhZ7/XYXgu4DnQvDC6nVaRwcBRNRDKNIWHsh/lUKW5xolchJ0AmsiEoji1lwdH0fXFlh4E0h7ophWUzhWSBjdcRpZWjc0jCitUdG8Dj4+PCxExR8YpHW7cD8FjaAV7GwkZE5ygFSXE6lZULFuZaqYEYUpVGWFVPBQAgj4Fl7K+a2Kp0iXRDXCJtrZQXsdx8Mej38096jLQQ7aXJgL0XBZWqRU4R6qgIZ8DxPZUQUW58scrkPbDQVGcf/FbNcAF89/iSiAhbmBk1bSCcDrDX6C0/tWWmLYzG6K4RRPG0sHGudCq6CRWOcJqwwpeig/orVfFgGjNhYMPiMmoiYjWdMeL7MzmwhMlRA3PEsT2EH5PLQCXhZ6KHnMlJ8nIp4fSkYVzHzVhfGf/oixS1+MIJ8ZHlWSwt7ZWCwiKfpzMvuiCo9Vkno+Z+rYzHlaXKe+Chc8mHlvHPFHCk7T9qeRPZPOCZN9e3F4o5DNdNKHM/c3/Xsw4mWRVxVFvJhyhJt/NuVDlkpwQho9EyADGdc8YkwawrBMkf+mByQWltTeB1LA+YAilybwi7LBYIVssCPwZJs3h8ou3fjhcikioUZqnhkwdtk/MfcVkUfq1ZRHM3XfasLYz6zV6qQ6ZxFw1gAIQLNt2ist2U2hq11wnA9KzS75RIzCqzkYjSRxqKFnJBdBuZVuv5sKeAr5BGxD/kCsUs6tFJf3ULU0qKK8Agyxcm7PWi6o9cJVJmmmKl1zCC/Y1HcCqEqI9of0Zk41aqBmoVMPNTZb5cu43ffItUZv5NZmTXMtVIQFNdCVcC/aN0aeLw9q1h8yrDAGrcLjvoNNfor1EggM8c8+uziVZgLkawC+va6xeB01PUqWxipJksmuAR9kIKyVisAS0D205ejt5enl//ssksfVFhLQ3zd9EBQ0WFCyvjpzU5jKGhQy5mMW3kf7Pb3Dnr93Xh7kBwc9iLe3z3oD6LD/kHvYHs3HgjcQAG6P73F30uAoRDFRcsA2Ng85TOGi9G/0kvwlGbDVEKdZa+EmZRW4/ZQbGX69P4jJGM8jg3i3jfsyGnHbuJ2/Fu1zGp4GOksaOJiZUeICwFdSSQ+yGL6FlREFCQ5m9TDNaASFVS0IIO/7R5sCUZHc8rVbcyaxW+0tOMapeZVyieuriELcAFrCF7Vna8U9xOdISX1mVCJ1mlB6i0NrcE9I8+F3U4lhJktx5ksCnwDafSIQLFIeJmCjpDeVjQEpM+IrUJJEf9XBDQC3fCD8k0Mrz1VBdV7bEObgPNYYtS117oVJC9xfMyHLmEQlwCSRJYjblAhrPEWXishYhF3b9QZiC5z9IXnX7WpaAkeWpFzCE4gZQh5sFrGNSnW05tmApzfKmFugg48tbo0kWg88G3OTUDNw01wq83nidFlfnQv44eboClL/c6yZxNEcsUhW5l79LzSrbSkQdMFzW1XIP0cNhaF7rDGyk7Vk3Xmkhx5XN3Z2+slO7vxXq+/t9ffjzk/HPR7uwc7LexYTtEKMJoAs2Jwe3hAip1VA9BJKtHNI2MgAkJAEJyyYIoA57rq6hBlrOMZelgqctZPHIliGrJOdLxGPXkllQghTCVKKEjkCBbi8PNFxhi6GbYAjiXiPapAdO0KB5bo9tkxj5uIScqgIQ0Ue+B1ukYNvVIS1rNqCdQXyqRHthX7go/3eoeDnWRvh/PBwU5/f3d8mPDt7d7h7uEh7g4ZYCFImjnMjeGzpa1fC4gpGbFUQ/WQ/xY4gnEskygAbQ5LJEx/9mkfEI81+xNHW6vp5WV4CtCBueP45B3b2WcpV5OSnvPJghFUePV+KYtAc8f43MiJVKtEEQq7tevg5ejV8OrNJTy5GP3javQe/oe8lo4PhgqiNcaw1NRNTvUtSewVuOUW+sgUzIEw9MJzfQEKcX/K4Al9F+9GaeZBAVb43VesaLJmidFZK5Uid2TCnsmu6HYAcuAZtKbRlI05zu/Y4gL5C0zkvAjfeEu+YFNoVYR53mXDOJaoJIAuZGOJ8MqpVYROB1PXMUhKSGUQBroRXRbUQ0ftybNhykVMq9DkTdMpmBwg+RrlJSpKEI7UbGZhHS1eRO8fkNlZri3dZcNoZNKZKnhUHSNE2tDoOgbdJJRWD0foLgvAoyq6GrFaSIrSnDlhXhaa3kW8tGvk3bsU4Cck1eoXX4RPPhqmHBqRNyo3eUTyIwst9lS1u6rEh3lTpPEmdze5u8ndNXN38eWFP/b1b6n16S+3PleKl2BfQ8VzqfUxFD3Y4Hoid/rgHNlhYBDfIv364RIS+7NQSC/uchwTfmJ/5Er58ulZ7Q/3fIztR+2sli9QQLKj0yABJBLxEck9l5gM5Uy1vbzbK23GEgJUrWgRATUNm+mSGndTKkWDje2wWAurfinYlAM++rNHQkB3rB/Suf6mk9x0kptqtKlGf55qtOkkN7m7yd0/Zu5+tZOspaJs8X2SLbOMm5mLNP8eteUMCFh1AYHVKUeuWuxWkBmre6yg3TkE40F/3E/2I7ET8514b/swGUR7A76739/vj3cG+0Gz1l/P87hOsnZONfzt/EgmhibuC/RxJX1bV2gdt4//SjwJThDWEHrqvhlsDib9WPeOg8Pl3vFSa3bG1ay+6dHqIdXcRohpQJshralogYCzCeCiYgBVEuTCUJKZAC54hMxSmcn6JBn4mlk4TPBWgkuUKsjqXaSK0hIkJCRINXbNC9/5mhl1sBNA55/YnXoX/VAnzy5Q4zeoMRvdRXTazurOfXfV+e6p8ldB3jsHP3LQ66YdriAAYCBwmFX3nZv+fNOfb2r8psb/OWr8pj/f5O4md/+YufsN/bnvhh7vz4Fg7f4caLs9VvdSr+hewP+6TadU8RJQeDMd0U3oeN6DU18BoeRvcSOGcLyaHWytvJYd4JVu7AudSKVJgXRaFLk92tq6B0+Bhx66PJfd6gqU0rd4A2prDOZZgTzzW49IwIbvTv1k0SXbGonh67COmDtL1/cswOJ0KvxVztX1sZkuAd2ITQevzflQoscgYg5zxC+WqLsUOkv6gV5XJn34cV0co0d0WWW+r+4G9AwkXVARVfg4v4HfuOqzdA9/XkhwUBssbXaOZAN2LLiBicB9d/Hs1w+Xz9kEW01K9dLSTSCJswEkyzsIEYKyYXWOj4uouhhdTqYk+LD1TQmmDktSUJjdqPdCsOvqptxbwPgLAGUyKS4ShAO46uOzyjux+CJSLH/duSUx8GSstsBCW7y17jmVOpoJpHJ3PfHq240K2Uu64oxXWN0tJ6cijXjsOq/04g29vleIv1TcQp9sxM0+X5DCmfY6cjdvIshfZIGX+dFa37254xc2+IV0oytErosyoCW8HO3vt6LKa98tR4tfiPzactyoD1MJdbS9jDnYYhbKYBqzUxZNtbbir4xh6GAaXE9KyKLvFusWNw0pI8JBryFS6LYMZQhdIcn3BhJDuWDiY6zK1JRo6NdU7FLyN/Is5PxvdO/st5bO9PgaiidSxjqy3y0zbhjihqHDAOvld7UJAwtyG3UgHHABcDL3PyGBF7SBe47XSlQn9lu0BktDBKISF5sfuQ9Hc4Dz/2P0AqlrGoBhbKrrb/zgM/O8HtxPT+bGqo4DFi24LG+qoS4u2M3JWx9HYa38vemLGg/npybnKp39bJR+BEl+P7j7f0K8DdL8GZHGt7kYbrTtwjV8DPJj368tn+JZ+k0P/AtvKVepo4Z5hSYw6mKajPKUFxjVlNXRVAqa/3PBC+z9OtUv2yATq9/fWcdoYoAG0pau9o9l6n9zUO/MKWFcY4l+xc+2pCEE94qmME+KLvsAI5mKwC04juEdC3j3Sfu57D145h39NvJl5WyG99VLhb/qALHLjHEIqSciIpY2Kh1wwVCgRGULTa1fvarKYgw1VIF+ViBMZs8TPFqGqbXh+Cf2Ar9bf64Mpkcvut+TBHNFLoT7SQTStdv2p3hDtIVTkeY4EALqQgMmGjucnV4ucQRmyl3U7moz2fKL7BbSAhMcj1z4bHf73V5I4wI8z7UtYIRtMH8tCva1X5QuxuP9/Gj9J/za1ZcTnAO2cjy7QiFLN5e4KfA6WD0Fwlwx1fiDj+vg/h7PN3AsesDHQIbD8/XH+cSDn4CxO+egsfGzoPmaTkLmI/TydwU4v9TT6esROoI/Ugr9f3Crh4f/AFBRXc0=
|
|
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 Access Request Configuration' (get-access-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 Markdown from "@theme/Markdown";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Get Access Request Configuration</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/access-request-config"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This endpoint returns the current access-request configuration.
|
|
|
|
## Request
|
|
|
|
<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Access 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={false} name={"approvalsMustBeExternal"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, then approvals must be processed by external system.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"autoApprovalEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true and requester and reviewer are the same, then automatically approve the approval.","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requestOnBehalfOfConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Request On Behalf Of Configuration.
|
|
|
|
</div><SchemaItem collapsible={false} name={"allowRequestOnBehalfOfAnyoneByAnyone"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If anyone can request access for anyone.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"allowRequestOnBehalfOfEmployeeByManager"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If a manager can request access for his/her direct reports.","example":true}}></SchemaItem></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"}>approvalReminderAndEscalationConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Approval Reminder and Escalation Configuration.
|
|
|
|
</div><SchemaItem collapsible={false} name={"daysUntilEscalation"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.","format":"int32","example":0,"nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"daysBetweenReminders"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of days to wait between reminder notifications.","format":"int32","example":0,"nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"maxReminders"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","minimum":1,"example":1,"nullable":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>fallbackApproverRef</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}></SchemaItem></div></details></SchemaItem></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"}>entitlementRequestConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Entitlement Request Configuration.
|
|
|
|
</div><SchemaItem collapsible={false} name={"allowEntitlementRequest"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag for allowing entitlement request.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"requestCommentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag for requiring comments while submitting an entitlement request.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"deniedCommentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag for requiring comments while rejecting an entitlement request.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"grantRequestApprovalSchemes"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Approval schemes for granting entitlement request. This can be empty if no approval is needed.\nMultiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"workgroup:{id}\".\nMultiple workgroups (governance groups) can be used.\n","default":"sourceOwner","nullable":true,"example":"entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"approvalsMustBeExternal\": true,\n \"autoApprovalEnabled\": true,\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": true,\n \"allowRequestOnBehalfOfEmployeeByManager\": true\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": 0,\n \"daysBetweenReminders\": 0,\n \"maxReminders\": 1,\n \"fallbackApproverRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": true,\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584\"\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> |