---
id: export-role-mining-potential-role-async
sidebar_label: Asynchronously export details for a potential role in a role mining session and upload to S3
hide_title: true
hide_table_of_contents: true
api: eJztG2tz0zr2r2i8Hy4wdV5NH+mXndCWO2Xgtpu2w4fSWWRbSQSO5JXsltDJf99zjuTETtIHvezuhQ3MgGNJR+f9snQX6EwYnkutTpLgIBBfM23ygU7Fe6mkGp3pXKhc8hRf9e1UxcFWkPORDQ6ugpP+CcP3zM0NrreCRNjYyAzhAbSLsbRMqCTTUuWsyFLNE8t4mrJ8LJhUQ20mtDeDJ8ZZVu7GDIKVCt7R04Q2YFZYi7Nzzc63GQdQLNG3CsHyCKZ9kxnjJh7LG9Fg7ETFaQEIMZkg1FzCI1cJox+pmMD/FvdAXOo7N4DIjBs+EbkwSOpdIJGejOdjGFIwAL88NsC3rcDGYzHhwcFdkE8zGswNsmS2FRjxr0IaAdzNTSFWWSTWkigRqvjKJ1mK4Pbjdq8ldvfC/T3Ow65IeiHvtaIw6SU7293uTmd7GMFma/HMqjL8c9j2V0SU3CulGv6dvf3tnR7fDVvdaC/s7u72wl53dz/sdbrxcGe/1dvt8mB27fYXNn+tkyniF2uF++Ejz7JUxqQuzc8W0blbJURHn0Wco/gMKjbKHEcBs+OF1M90VqTcyHxaWQkaKkbCBOsEhIRNigkQXy5kfKKB1IpmeUUiRtyOZTwGXauqGpsUNmdjfiNQfSPUblLPZL5SoOlVudYCefhZh3oCG/bjGHhbQTrSsB1XK0ifDNmQp1ZsgX0wpfNys7ru52Oeg70INpajcTotyfO0IU44Hca1GQEHvhHvqwiiisxmlRcPcbp1DzEEBJwKrgHU7/E9x84xOe0IZrMZ6arNtLJOxJ1WB/+r8+Gtjth5EU1knoukwQYiL4xCt+GYfZI4HsQgKpBIYUEaIJzSpxAL0KdoFQsWa6QxF8CAJ2sluLrTIfmPjX7+X+nn1mMSd4EWY+6yE94KXFiEN0VBYWCJd0dzRTViKIxA5cwp0n5dllDQinfjJNrbDdudDvhdzochH3baYbvXSaJkGA15q4tu3+Y8L+yqAaF2uTGmh/fu8o/L48vjI8wMligRqphgpjCfcPLHP88Gp78Pjs/P4df55eGhezoeDE4HmEA8ic3ngJFAJ3Bdk+2Cp0+je0H2AsH/tH44j+UdWLfVWmX5YSrRHI+NgZwo9D4LzXDozZBUjEUQIZlEu77hqUwa3+OWHlbNRORcpoc6EeuUs47sG6lEODJcIoaCUI5hIQOINzLBbGCiwUAdSKdCws1r1DQIONFos9fgc70JsUNPDLLW8PgLwFpvLXWELpWE9axcggkK5pb3bCv2BI92W5CFDCEB4Z39bntvJ+oN+fZ2q7fT6+HuE5AyH4mqW+PG8OnK1r8LJYyMWapjkMg3YIgR3PrkljaHJTIXE/u4DAjGE/iP9unmzsn0+LJcfM23INS9Pjxj3T2WcjUq6D0fLTFBhZdog6pIU0yj5yrtAJ8aOZJqHSqldR8dv+lfvruAN4NjMKRzeEJYK+VAH9JalaBaAqqgC2N9Sxh7Am4hobciBXZgrH7lob4Cgriy1YnS/bJTC8wE3RryIs1hhd99zYoqaDY0elIzJbKbrzl7IRuisQWxD96BA4YQGXH0tNoFwFdo8VkevvOcfMXGgifCvGywfpJIJBLSYrBGAArrpxhEeVKJoMMCTBmQkflYFznGPRmLuiwWrKxLY+Ff3lWFgsYBmD+uJ/04LwA5IrNqhXNt8Sh6+QDOjnN17C4qTCOWTlXOY6AC8pwpsNEY4DCLgDYJ4du7IxSXBcejynlzjzWruE1yd+8dMke5prGYF/YJdneWgvsJibT5wI3wxmcxTjpvRNIoxeQ9Egwi2bTYz5qLqzR8NpQiTTa2u7Hdje0+0XaXB8u8x49S6tNeTX0uFS+Av4aC50rqY0h7lGblJNc6coLcgiKgTJHefrgAw/4iFHPpKvYzfmB+5EL5CvL9uTzc+0iWRYoP/QtZIILER9/8Ak8kkgPCe4ExMcqxant1tzfaRBIUVK1JEcFrGjbVBdVOplDUleEWiy1h1W++yuOUvzoP6Np0IfXpNpnkJpPcRKNNNPp1otEmk9zY7sZ2f07bfTCTnGNF1uLzJFtMJtxMnab5caSWM5jAym8GbG5yJKrlbAWBsXmOFdQzhyDqtKP2cC8W3YR3k93t3rAT73b4zl57rx11O3tBNdZfLex4bmR1m6rI28nRtV2FuYE8rlCgXDbXOqm3/4C9RgzRraHrmefNwHNg6XWZO+6s6zCegEQMaum52+KeVqPLt7kCFCAldVYzz3w2GeImQ9xEmU2U+TWizCZD3NjuxnZ/Ttv9jgzRZ0P3Z4gw4ckZIsxttNg8l3qDyvVfTxTJVDwGpN5Mx3FhqOFZZoGUV4AqIUKZtuRE8IDYQdDE0yChO7YV+mNbtnk3P9g2a86Pe4U4FcaWDpPNmu6je8j92UCXtTpqCpPCJuM8z+xBs3kHC0G4swbPZMMfTJkqfduI9aQZAWfXOC38vu0MFCew/tmJT4sbJBYjUfOdmyTgTkjECNRxEBa1NB+EjKfkUPpTXYBjJDBbDKzEayG9xrM/XE1/szS7QVq3Qh/QdWnS2Z+nxQG6h5Z17HtwN5jPANMlEv3pCStAW+h4A8jrEvA5dD6uX6CCXF1X55xjTu8wXJm5iFNYiXRWEDrFaR32WnADBYdrzr94++HiJRthJkuepLCYRAuJpQfY4hmoEXnKftmoxkUUvIwuRmMirl/7FICWyYYpMIV9VOdCsKsTz6g/IIQMwOcT23GRIDeDq65flBJMxI1IMbo2FtxG5ZSJagIXm7y27iVFUio5KidZGx9VyI4kOjg0JprjSaQuPLvKSrp4ha7nIvG3ElrooIUEzb5cwsKx9ip2R0ticA/OiC1x69mbO3hhBR7WZ/AGoS7jgJzweNQ/4MSl1J6NRw1eiPDqeHxUH9yJt9oy5rwisxBl04SdsHistRV/ZwxVB03lalSApT0bLTpmF5JFhJ1WBaXQbRnKEJJOwu8dGIZyysQjDPqU82hIB1XizPYTSRb8wic6xPypRjO9voLYjDMTHdtn44wbhrhh6PyE9fi70IeKhQfUgAbyA04BDhfyJ0/gEa34Rgdrrecn8E1ag+EjBlQJis0O3I+DhRP0T4wGcPZ8DrhqzNnnn7TwjLmHhfGvxqyy27DMwVV8Uw1hd4lvDt95vwVD8V+NXqS4v2jKnKp0+qO99D2e5K/jd/9HHm/jaX5FT+OzaGxuDhb3E45/wKli1GCixFcwVbt57dPE1b6jxQO/Av6FUTJ/qgGgwqKakRKjKqAs5TkaCjmKeCwFdSwywXNMObdQWfWEjDszGtGDupQAjQzMAU9gIRXmkUwBXoNdLHbmZIMun0VVwd+2oLIJ94rHUAGLBvuAB7VjkDQWkHguAcY+a19JnoOwz+h+0FGpPwxZVSg8xg5oFxPGQUsfUbJE2rhwvhDqSSVKXmjKJuerSseA2oskNKiUMhN7OsRmONTZFV16ZC9QJes74cB6lKK/cLMgZCBSUnacV68WHoMNChyORZphCQuOXOCh4cUO708uViACMGWBrlg0tBk1/SLbxLkABKsypz7bjXajFVKVAu+xIoSiuwKcrnlBjq10YaEAcgWeb2LZ77yphVrh7n25S1vLuly54fNT3xbzcRULomaGPUJkbeGKOFdsXwXrim1YelC9R7ZUb+Pw6vWtWskNBdoYi3rY4O4O+1BYg87wNTgqbHJcXS/KSyrzQMXwOQkO3B2M+yXyYuBvg71kFw/dU1tLfdlHVdNFCyWAxy8COy8LorGSfhZK33kZ7RlILrN+dg1LXDOPOOlm+a9H4cWUkrQSyspnMSTUrXANwgfnXleaNmen2CoNIn8nbuL6T4bfwkv89yD4CH/hh86cs4FJ9P4uKLu5MMfBxT//BhnVXAQ=
sidebar_class_name: "post 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 'Asynchronously export details for a potential role in a role mining session and upload to S3' (export-role-mining-potential-role-async)"
---

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"}>Asynchronously export details for a potential role in a role mining session and upload to S3</h1>

<MethodEndpoint method={"post"} path={"/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async"}></MethodEndpoint>



This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive.  Includes identities and entitlements in the potential role.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"path","name":"potentialRoleId","schema":{"type":"string"},"required":true,"description":"A potential role id in a role mining session","example":"278359a6-04b7-4669-9468-924cf580964a"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"minEntitlementPopularity"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The minimum popularity among identities in the role which an entitlement must have to be included in the report","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"includeCommonAccess"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If false, do not include entitlements that are highly popular among the entire orginization","example":true}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>

Job Submitted. Returns a reportId that can be used to download the zip once complete

</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={"minEntitlementPopularity"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The minimum popularity among identities in the role which an entitlement must have to be included in the report","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"includeCommonAccess"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If false, do not include entitlements that are highly popular among the entire orginization","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"exportId"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"ID used to reference this export","example":"0c6cdb76-1227-4aaf-af21-192dbdfbfa04"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"RoleMiningPotentialRoleExportState"} qualifierMessage={"**Possible values:** [`QUEUED`, `IN_PROGRESS`, `SUCCESS`, `ERROR`]"} schema={{"description":"The status of this export","example":"QUEUED","type":"string","enum":["QUEUED","IN_PROGRESS","SUCCESS","ERROR"],"title":"RoleMiningPotentialRoleExportState"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"exportId\": \"0c6cdb76-1227-4aaf-af21-192dbdfbfa04\",\n  \"status\": \"QUEUED\",\n  \"minEntitlementPopularity\": 0,\n  \"includeCommonAccess\": true\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={"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>