developer.sailpoint.com/docs/api/v3/get-role-assigned-identities.api.mdx

---
id: get-role-assigned-identities
sidebar_label: List Identities assigned a Role
hide_title: true
hide_table_of_contents: true
api: eJztXHtz27gR/yoY3h+XaES9/Io102kVx7k641xcy24643guEAlJuJAAQ5C2VY+/e3cXIClKsq340muSqjPXk/FY7Bu/BYG79XQiUp5JrY5Cr+9NRHaqIzEwRk6UCI9CoTKZSWG8ppfxifH6Fx4OMN5l00t4ymORiRSbbz2pgEDCsymMVdABf8kQfptgKmLu9W+9bJZgq8lSqSbeXdMLhQlSmeDy0H70iukxy6aC4RJsrFN2PZXBlJq4Y4lVPDGeCpZpNhIskiYTuJi44XES4Sq9YL/7ovOC773obnX2O7zThV/b3V5XwD873RcwOBWfc5nCvH6W5uKu6WT4nIt0VgkRyVhm3iKzb/kNU3k8EikynQqTR5lBblKR5alqfVBDIdjFP7fY4OSIDTOuQp6G7EBHkQiQBjsp1Xf5bJpliem326G4EhGapGW4jBItVdYKdNyWoWrzRLaNo+MHJR2/MsNz0lmsQS1Swc+YDNuqSTrmkRFzeurtdFaYCNYVE5HCTEvGNm31oCGWSsZ57PVhXsxv7G+iEooxBy3QX3f3aVOPx0Ysq/MdNQPboEE09ziPIqdVBh0tdm5yHkUzZhIRyLEER7iW2ZQ1yDoNVHzCJ1LxDFximup8Yt3GGea7MccfMEap/vuVH+hcLev+aMwaGAANJjPQKig+0UkeWVUK1viXf6YzHvkHOLuBKk20MoJNBQ/B/ckOOHBFOEw5UNR5FGKQ2sgAy8lxaTfQH2tYn2iwa4GqmijQWAgWA5tJFeA8EMNkkDMYB0MDK4wEYQFXbMqvIDkwsBEpB8fLOOFB1kRppIHZYLFYqBAWVjpDTzECV20Qkb+Q5A3kibi94lEurBZwNLCdm4Kb78KDUJ4VTjTSkFO58ub8hGbe6ytjGVFq/4IE/pqmlNbPDZoMPaOQkpmZyiBx2mkjdAX1J6v0JysXcOY7Pp+jbV8XregyJk8SncKGQuqndASk9DV2Q+qJQkN+a7dOnZo+Umg0ZNho9FlDfAbXUw3bxiPJza+wdtllrl0X6FRGy82qPrgJvt6obWw4ADrYGy28+4xnkP0HjTeXTDA+uG8EKgl30SW7DoHaN25VFHjRpkPbtp5FQeFgwCZDBTZZabYmc2aqmaDqJn3fXWJA2qxoUNW9Tgf/VdfiMWAUTI7zAKYANQXogVUCDekesjTM50kSyYBivv27QSK3y/bkacrR8jITsZlr16PfQU1LyX4AuhjhVuuglvNn+AuSqWNt5nAXKI6zWBRZnROLmH2SFC1FuBAWBJS3wr3qy57BUhW+K9ZZAdj49u6Yw74itjvd3fFoW3S6L4JeZ3drH/2yVPx6K9Jw1sYUnlLYPLR+1hKhRC3fFWG0zhLTHDYdcDse8hGAVqCQRHzGHl3tbKpj4O2wXJL87PE1D3EY42EIDmfWkudv0vUqfY0hhYulJciHnTEb6jwNVsorFIKLC29wcHA4HP52eviP88PhGXScvjs+/O3t4duXh6fDvx+dYDmwoBugVLiRCtGLwd+n+hr3ag6uEwDASCuH06OMS4yEWrcLiUqmJT5gMnWcrhAIWfBgf6sNKlV1h/9returQvUgkjCKHaYpZAufnc4BFwsqCZCwkQ5nGCRSAWqQYesJ0VtGaT2kQgHqiA50uIYXvga9+ZPUqk8QywFMZEDxSoaY4QhAWJKFx9C4Vk23oIlWl73kIchr5TtwwqAKUx58AlpHa8T6uZIwnxVTmKyy7oplxZ7go93Ofm97vLvNee/FdndvZ7Q/5ltQtu3sU9jH4Ot8IsyKtFdf+hehYBcPWKQDsMi/QSEQmaB7YoAWfyhT1m1ANNbMAnZsKabjl2XiBnAoZy8PTtj2Hou4muTUzicLSlD++RC3byh7MI8UFalj4l0qJ1I9FKCvDl8Pzo8pMovYQFpLYTlQRThqyukYkVklwDWkJCNwfwXMyxqOagME4srMD5T2LzODujtmDlLCDLf6ihnzpNk41XEtlChubjL2TLZEqwmwG9oAnUD2GHHA3wxMSLXIIAhEkvnHTpMNV4Q8b7FBGEoUEqoDwvAG5s8Qv0OutJDE1pUQyoJqFp1nCPFlIOq2qFRZt0aVR47njYLBAZw/7ieDIIMSlnyiFoWltzgWi3QZOs21FvaNSmmkUsReAIcCqo4DnUK9A5kJZJMA1lw6IggEiUcV48qMNZ8eKd29tcy8yjT1BTw3a8TdSQTpxyfRyo4r4YKPjkVsNiJrFGZyGclV/DTZjSrNVQS+hSmb2N3E7iZ214zdxc5TV6C4XoI+3WXoc654DvpNafNcgj4peY/SrBhE8MYZsslAIQ4ivXl/BoH9SSgcL24SPKv4ivjIbuVLzA9Ke7hatChVi62/sgUySHq0EowhE4mwT3xXHFuQSKraWl7ttU5HEhxUrYCIWHGwmc7pjDrNlaLTK9NkoRZG/Zy5cyuICGNsBsRVVejbyneDJDdIcrMbbXajH2Y32iDJTexuYvf7jN0HkWTJFUWLw0kmj2OezqynuX57ggwDqg+IZciRqRbRChJjJcby6sjBG/W6o+54LxDbId8Od7f2x71gt8d39rp73dF2b8+b3+svqjgug6weU3P2tnYkFQOIuwIclytwLpNpHdaP/3L8KjLGtIapp8TNoHNQ6WWJHXv7y9jxTGv2lqtZgZBMDUOqSkeY02BsjGPTYiwM4GwCeVHhh08JfKEryVgAFfyGw+jrKgYvSgF005k/GOO3OffN1jlZuYpUQZSH7oQ20oiaNTiWxA+gY8R8QIEQ7ASy81dEp85EfwjJs1OU+BglZoc3gRAY6CVy31l1vnsEzKeYI4bWwPcc9NpqhytwACgIbM4qcecGn2/w+WaP3+zxP8Yev8Hnm9jdxO73GbtfgM8dGrofn8OAtfE5jG11WImlXtOtsj8bplOoOA7IvZkOgjyl4+YCg4MSjIBG/OyPi5wDrj+wrjwA0I6RKUPVx0sRfq4AuAWfRNjHOx2Yh5Z7wEQIWuf6Hu8hapd3S6FOt4JWXQnixe2HWEAUuMvZmP7whnXfayN1076V4V27mOPL+fvatnixas3TCOYUd61uwdvAy+5aPJGthdsh7autFbkTLznYPAHZN8ztNS683mUXaZGPpBLD0OZsWsB6jLtt6JX3uh6kX1ycmekcsjSRaTIIWRcS1AxsJlAP/WxodItCYElGkO08je4ek8ddU7tHDkvkHjlWqe/BtWA8Ay4XxEP2LysPHWLhYFdf8tNqM8Ris7e02Dsc1mMvBU+hqrHfX569eX/2nE0QLlO6svf3hMT6BpzsBFyE0vGg+BaBk2iHrG5RD2pfezD82TgCgZm7FFtcqvkV9qlT2FhIpThJUC7DWevf9OO1efdcgf2gfPZKpvYioKExTkR7TfgiKeTic3I9lYmfCmq+peYTNbxlWOPCqvYisLeHAshBSIJHhrT15MUtPX+OHhaB0IJUF3lATTg+6t/ogsJqT+ajRs9HenU+Pqj3dN+rPo3Z/MXMlO6BH7FgqrURf2UMXQfD4GKSQxQ9mS26ZOZTRPi9zhxLvl3Slz4gW+LvGAJDWWfiI0QWBKw0YE4V2pD8SJaFmP9IV3w/1mSm5gsAADgy1MEXXF9d4BkX9HFB3+YA4/i3+ys6FsQ2ykB5wDrAQWV/ygSO0bmcZ2mtzOpEvk1zcGsIgFWiYpK+/aNfJTj3i1EHji7HQArGwqD8agl/M0cLN9masoojjUUNLvMbadjbF/Rm+S2P1HC//9bkRYkH1cnPOxXNvnaWvieTfDt593+U8TaZ5kfMNA6qo7vRsq6mmXdyi9aWzyENPVWC/4deilSqCaDiql4nzZNJIp6hT1NMB1Mp6AQjETxD5NdEv9IxxSHAXQx+AOZEaAIwHo/RDaBRPpIR0Gux91AiqgBUjOUh3vkAqr9rVycOQcsnaCT2qjAcAKg4zhVeewYm8phxcI9HrBtKE+Q2CUG1qEQhmSYYV84qIhLdBlXRokIpjc27MR51S7zl7a25FtjQuHNuUCRaxD0uqQQ5FRF5GY6rw+/HaIPn+FMRJVigQgYFMCXmVnh7dLZEEYgpQ/e6WzqdtN0k08axQARLHesMWy0oS7Ep0SaDgmyO7uPFVs2vykSOCLyd4MkX0s1tRWALsQu6S48K6NNr11W1GKD7KfCCg29v8aQEC5M7bLbPdrBCA8Wg71UPuhY4KT83fGcvT1dq8JPAs4fiYa07XfDoNdP6evj/ejL6gB7LJ7VPVOTm/ef39/7zAXcoHvk+0Rs2jzj/e484H7Ba9dz2iXbbPNJsPKLi6lFspeLL6sDvC7fhZ6fuCfZz9jX+wxUr+S6+xKnZPNOFPIA37i5hlM3DxL7tsJ9f5qYsXVBAuctz5V8OEW3xe2pX96N/gYfp/wGOC+/e
sidebar_class_name: "get api-method"
info_path: docs/api/v3/identitynow-v-3-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 'List Identities assigned a Role' (get-role-assigned-identities)"
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List Identities assigned a Role</h1>

<MethodEndpoint method={"get"} path={"/roles/{id}/assigned-identities"}></MethodEndpoint>



List Identities assigned a 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":"id","schema":{"type":"string"},"description":"ID of the Role for which the assigned Identities are to be listed","example":"2c91808a7813090a017814121e121518","required":true}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*","example":"name sw Joe"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id, name, aliasName, email**","example":"aliasName,name"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

List of Identities assigned the Role

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the Identity","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"aliasName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The alias / username of the Identity","example":"t.edison"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The human-readable display name of the Identity","example":"Thomas Edison"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address of the Identity","example":"t.edison@identitynow.com"}}></SchemaItem><SchemaItem collapsible={false} name={"roleAssignmentSource"} required={false} schemaName={"RoleAssignmentSourceType"} qualifierMessage={"**Possible values:** [`ACCESS_REQUEST`, `ROLE_MEMBERSHIP`]"} schema={{"type":"string","enum":["ACCESS_REQUEST","ROLE_MEMBERSHIP"],"description":"Type which indicates how a particular Identity obtained a particular Role","example":"ACCESS_REQUEST","title":"RoleAssignmentSourceType"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n  {\n    \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n    \"aliasName\": \"t.edison\",\n    \"name\": \"Thomas Edison\",\n    \"email\": \"t.edison@identitynow.com\",\n    \"roleAssignmentSource\": \"ACCESS_REQUEST\"\n  }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Client Error - Returned if the request body is invalid.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"403 Forbidden\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The server understood the request but refuses to authorize it.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal Server Error - Returned if there is an unexpected error.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"500.0 Internal Fault\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"An internal fault occurred.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>