mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
87 lines
29 KiB
Plaintext
87 lines
29 KiB
Plaintext
---
|
|
id: get-mfa-duo-config
|
|
sidebar_label: Configuration of Duo MFA method
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW21zE7cW/iuavR8KTGwnTkKafLnjvMBNIU3ISykNmYu8K9uCXclIuyQmk/9+nyNp17u2IUCZ25ZxP1BnVzrnOe/nyPJtpMfC8FxqdZhEO9FQ5EdPevuF3tNqIIfRSpTzoY12LiM8Zv5h4ddHVytRImxs5Nj9uROdj6RlvZNDZkReGGVZPhIsru9hesC4YqDPiF4m8pFO2qzHcv1OKHYt8xE7Pn36397+0eGvjBd4bWQ+YaBrxPtCGpFgKYt5moK459YGSCvighYC6G10YYUB0lzc5D1QIPAyUTvZgLcaYHaM4Ak2L36ZccWHIrq6g5hG2LFWVkARt1F3dZX+Nyv6F0kKbjEhUzmR4ONxKmO3vPPWEp3byMYjkXH6lE/GApR1/62Ic2wcGzJVLj0KAD5yNGtLbW6kIpupIk15P8Wz3BRi1kxHAx7wMMUzgfXihmdjWh4lhW5di350h4eKSNTp97VOBVfRLMHDQU1GslXY2nYrB7xIIe6Ap1bUWBEycBlpm3+9CKRuWPmDMIwIODmYNuzwhPEkgbks6Z/cj4BBcx9kIky7IWr41I51RuLyOMa2Z2LyrWhieD17JyZsACDkurCys64aOucVNrfkvJ9H9f56rbv+av1F2tu8eK/jV+PkYt0cvPtonnX3N7a3JgQVu0A6n/Ry4OsXufh6yMfuA0/bjMB79XmF8ZKokyODj5IAh4Hlr/qalezvFwaeLFNC7EPjpOHBTUA9YuUTACwoPboQUmzq+g4UMR3KD0gYNbdrseC7BGE2dmaVMWVRx+TfVfARjO/IHWCTg9M8n/xxs7aXpC8movvbdd63b836f54lyWRjtyf3fn8bb95QLvE7XsCILw82Nk8fn7/a+nl79Y/f936L7u6gCSjOqQZBOM2ydw2utdCu4rEWjh6lj5vo+vq6XXfkhh9HySP336tooc8E8yy2ThD9saewe79oJNzGotS4l0qwZgfGwHQtdupqA/K49P4WQoP1deLyvFQfeCq/Z6pMRA4593SyME6aYJ9IJVpDwyUhFA5yjI3BvykSMm0E8yTLkHHrmp4PTbTX2C5PIK+Xby8IQz5gePwOtA4XJu8moAslsZ+VWxB8VQgsYCu2BO8/Xt3ubgweb3De/XljbWuzvz3g6+ur25vb28Q9g3ugstkab24Mn8yxfiqUMDJmqUa9lR+hEBRM6N4BcMzJK3KR2ftt4Gh8gf4pG/m1lZgBL6N6vsI42907YRtbLOVqWLjnfDijBNW6OJsLekjuCR8bOZRqERShioy6hf2DJ72L5+d4cnrw4uLgDJ+I1ly/01Pw1oTcElDhCyMkx3wqwDW3KAsp1IFSyB4Fqo8gEA+9UVgo/V92YqFMFiomdgTuC3bUSbOB0VkjlGLf/LAHsi3aK6xPzzKexyPW5xYbYEJa/qiHVDHOW8+DJh+xERoiYR6iIZumYEQjiGL/BIQoN1PoegKDAqEsXNLWBYqwRr0TTVtMVTmbgstE+LxuFAoOIL/fT3pxXgCcE7MehZW3BIjBPsDsNddEd15TmlPpROU8pqqdphOo0RhomCFbMonaHdIRmcsi8ahyXZWx6vndpbsjD2Y/1+5dzAv7BXF3kiL9tJxo1YsPIgSfayFCta1XypCRQkl2m8Oqylxl4LOBFGmyjN1l7C5j9wtjd/blaRgIw1vX+qzNtz4XKoywVDznWh/jvEfpcs796AdHb8gVGmdCi/TLy/MwINNsdTOmMfg79ke+lC/qyIM9/PM+tR+VsRq2IIBOj16CATKRSHYc7ili3yQ6Va3Pc3uiTV/CQdWCFhFZ07CJLhiHykyhFCHhdoUlWlj1U85GHPnRN74+A7oZNGmNtVT5spNcdpLLarSsRj9ONVp2ksvYXcbuPzN2P9tJVqhctIQ+yRZZxs3Ee1p4775dYFjAyq8mWBVyzlSz3QoRY1WPFTU7h6jfXeuvDbZisZHwjeTx+vagGz/u8s2tta21/kZ3K6rX+stpHFdB1oypmr29Hevn9YWCc9lc66R5/Af1GjGgtEapp+qboXOo9KrqHbvbC7580ZodcTUpOyTb6CHVVEeU07A2o7XVkTwW8HCcjFQlgYtcSWYCVAychqUyky54SQrQNZNWb5DTVw8uUEonq7hIFacFELpMkGrqmjUcS0JIMaCeDxRcBztEdv6eXwl5E/2pTp6dksTPSWJ2cBMLQYFede6bi853DwHeUI448wb+xEGvn3a4ggNgIPA5q+o7l/35sj9f1vhljf8xavyyP1/G7jJ2/5mx+xX9eeiGPt2fY8EX9+dY215lVS/1xF2a+X+36S5UAgLn3kzHcWHccXPZg7u+ItxOGAqXQzhdsoo62YB3wn2FTlxeH/Ndv8dTmBTrRnk+tjudzi3MBPPctflYtsvrCUpf0z2GTh+6WZB26H6ADzFa4O6aeQZtp1gjyXd9onPEvZrDDaTIQt3uSPizlMvLMBNdILU5MisMfh78yD0GxDGGiJ+sW912fjMnH+S6MOndn5fFE/qELIvU91luWM+AdEZEEuFqepHujDpuz33uOt20itCU1p1jdkzLumxXcINxwH9x8eCXl+cP2ZD6TBfnhaUWV0gaDBApJ3ARl8d65SE+bXKlxehiOHLAe42vSShu2CCFwOy1OhOCXdbvKJ0iIzuV9moXsbS6elBaJxEfREq1rz3VJDmeTFQHGurwxr6H/jIUDQRS4WPmnrZfqxbbl5R+JNVrWhNEdPMduxyXcvGaXN8K4l8ltZan1nLU7MMZFF61l7G/dhMjeIkET63T1jcz9/RaNXo0PeEJUZ3FQJoIOJpfbsWl1b4ZR4Nei+g1cbxWL0cSRbS5rbwlZlED04QdsniktRX/Zoxch8Lgclggir4Z1jUxbbmIaHVXa5BanmVLttASOnzPERjKOxPvU0l2HYlGs6YSH5JvnGUR828wMCfsTUNm9/gSlZNWJjq234yZGLaIYcvnABvw+8JEjoXYJhlcHvAOsDe1v8sEAWgt73laC7O6I99xe6g0xIDqL5uNd/wfO9MEFz4x94JWV2uQhqmjrr7uo8vAgRZVp4ayyrOAWQ3O4001iuKM3jze6iyKCuXfTV6SuDc9MjlW6eR7Z+lPZJK/T979izLeMtP8iJkm9Ljkbo5tGAbqTr4b+rX5Izw6Yx4J/Iu3LlZdO41hxd9spi6mTmic8py82kV1PJLCDf9jwXPq/VbIs3TmIhFzOoU/RjxHaGiwBmFr0ZPyvkxBzx1Pl5y5CxjfWJJd6W9buAnE/X5ihGFStNlLzGMqhlloFqMLFnj3Voeh7AyWOSHDsv3S2Gi6sqxQdPcbsIuMcbjUPR6RSBsXPnFhKFCi1IV2rV+1q4xicjUSwd3iFiazxwM6V8bIWjP8PbxgdxsOlaF6sqL7nQMGnkqQU5E6z6R1zbb9PtrwttZIpGOaBpF10YCJGoejw/M5iiCmLOTC1K3NsBM22Q6tBREaj7z7rLfX2qstNy7g+VjbHPNrjfje7A9Mmr8umXXH2+mx+l/405xQhWh86IzpvItkK/w44yfHS7rxTuCru+5herwqr7lfRre3dChC49QdPX5fCJq4L6+mkxL9Rb8ncYcjbtz099X98cl07p7/goHmnmqkfXpABuSfKKHhA7G6u/sft1SgNA==
|
|
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 'Configuration of Duo MFA method' (get-mfa-duo-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"}>Configuration of Duo MFA method</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/mfa/duo-web/config"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API returns the configuration of an Duo MFA method. A token with ORG_ADMIN authority is required to call this API.
|
|
|
|
## Request
|
|
|
|
<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
The configuration of an Duo MFA method.
|
|
|
|
</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={"mfaMethod"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Mfa method name","example":"duo-web"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If MFA method is enabled.","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"host"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The server host name or IP address of the MFA provider.","example":"example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"accessKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The secret key for authenticating requests to the MFA provider.","example":"qw123Y3QlA5UqocYpdU3rEkzrK2D497y"}}></SchemaItem><SchemaItem collapsible={false} name={"identityAttribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider.","example":"email"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>configProperties</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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A map with additional config properties for the given MFA method - duo-web.
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"description":"A map with additional config properties for the given MFA method - duo-web.","type":"object","nullable":true,"additionalProperties":true,"example":{"skey":"qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x","ikey":"Q123WE45R6TY7890ZXCV"}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"mfaMethod\": \"duo-web\",\n \"enabled\": true,\n \"host\": \"example.com\",\n \"accessKey\": \"qw123Y3QlA5UqocYpdU3rEkzrK2D497y\",\n \"identityAttribute\": \"email\",\n \"configProperties\": {\n \"skey\": \"qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x\",\n \"ikey\": \"Q123WE45R6TY7890ZXCV\"\n }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"mfaMethod\": \"duo-web\",\n \"enabled\": true,\n \"host\": \"www.example.com\",\n \"accessKey\": \"d******Y\",\n \"identityAttribute\": \"email\",\n \"configProperties\": {\n \"skey\": \"6******B\",\n \"ikey\": \"Q123WE45R6TY7890ZXCV\"\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> |