LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/get-role-assigned-identities.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

83 lines
32 KiB
Plaintext
Raw Blame History

---
id: get-role-assigned-identities
sidebar_label: Identities assigned a Role
hide_title: true
hide_table_of_contents: true
api: eJztXHtz2zYS/yoY9o8mGlEvO3asmZs7xXF67jiNz4/LzTieBiIhCQ0JsAAZW+fxd7/dBUiKkvyIm+s1Pd1MrxYB7HsXvwXB3gQ6E4bnUqvDOBgGU5Gf6ESMrJVTJeLDWKhc5lLYoB3kfGqD4UWAE2xw2Q4ybngqcmHw8U0gFRDIeD6DuQoG4JeM4W8bzUTKg+FNkM8zfGpzI9U0uG0HsbCRkRmyh+eHr5mesHwmGLJgE23Y1UxGM3rEvUislolxI1iu2ViwRNpcIDNxzdMsQS6DaK//sveS777sb/X2erzXh7+2+4O+gH9e9F/CZCN+LaSBdcPcFOK27XX4tRBmXiuRyFTmwbKwb/k1U0U6FgaFNsIWSW5RGiPywqjOB3UqBLv45xYbHR+y05yrmJuY7eskERHSYMeV+S6fzfI8s8NuNxafRYIu6Vguk0xLlXcinXZlrLo8k13r6YRRRSes3fCcbJZqMItU8GdKju00NJ3wxIoFOw1e9Na4CPiKqTCw0pFxj7YG8CCVSqZFGgxhXcqv3d9EJRYTDlagX7d3WVNPJlasmvMdPQaxwYLo7kmRJN6qDAY67NwWPEnmzGYikhMJgXAl8xlrkXdaaPiMT6XiOYTEzOhi6sLGO+abccdvcEZl/ruNH+lCrdr+cMJamAAtJnOwKhg+01mROFMK1vpXeKZznoT7uLqFJs20soLNBI8h/MkPOHFNOsw4UNRFEmOSuswAz8lJ5TewH2u5mGixK4GmmiqwWAweA59JFeE6UMPmUDMYB0eDKIwUYRFXbMY/Q3Fg4CMyDs6XacajvI3aSAurwWOpUDEwVjrHSLECubaIyF9I8xbKRNJ+5kkhnBVwNohd2FKabyKCUJ81QTTWUFO5ChbihFbeGSsTmVBp/4IC/oaWVN4vLLoMI6PUktm5yqFwumVjDAX1O5v0O6cXSBZ6OZ+jb9+UTzFkbJFl2sCGQuancgSk9BUOQ+lJYktx67ZObewQKbRaMm61hqwlfoXQUy33jCeS25+AdzVkr/wQ2FQmq49Vc3IbYr3V2NhwAgywH7UI7nKeRfHvdd5CMcH84KEVaCTcRVf8egrU/uBeRYWXfXrqnj3Oo2BwcGCboQHbrHJbm3k3NVxQD5O9by8xIV1VtGjqQa+H/2pa8QgwChbHRQBTgpoS9ACXSEO5hyoN63mWJTKinO/+YpHIzao/uTEcPS9zkdqF53r8C5hppdiPwBZj3Go91PLxDL+gmHrR5h53geE4S0VZ1TmJiNUnM+gpwoXAEFDemvBqsj0DVjW+K/msAWx8e2fCYV8R273+zmS8LXr9l9Ggt7O1h3FZGf5xHGk662IJN5Q29/HPOyKWaOXbMo0ew2JWwKYDYcdjPgbQChSyhM/Zg9zOZjoF2Q4qlhRnD/M8wGmMxzEEnH2UPn+TflTpK0wpZGYqkA87Y36qCxOt1VcoBBcXwWh//+D09OeTg3+cH5yewcDJu6ODn98evH11cHL698NjbAeWbAOUyjBSMUYxxPtMX+FezSF0IgAYpg44Pc65xExoDPuUqHVakQMW08DJGoVQhAD2t8akylS3+L92sL0uVfcTCbPYgTFQLUJ2sgBcHKgkQMLGOp5jkkgFqEHGnSdkb5WlzZSKBZgj2dfxI6LwDdgtnBpnPkEiR7CQAcXPMsYKRwDCkSwjhuZ1GrYFS3T67BWPQV+n375XBk1oePQJaB0+ItfPlYT1rFzCZF1117AVu4KPd3p7g+3Jzjbng5fb/d0X470J34K27cUepX0Ksc6nwq4pe03WPwgFu3jEEh2BR/4NBoHMBNuTAMT8vkrZ9AHReGQVcHMrNb28LBfXgEM5e7V/zLZ3WcLVtKDnfLpkBBWen+L2DW0P1pGyI/VCvDNyKtV9Cfr64M3o/Igys8wNpLWSliNVpqOmmo4ZmdcKXEFJsgL3V8C8rOWptkAhruziROl+2Tn03SnzkBJWeO5rViySZhOj00YqUd5c5+yZ7IhOG2A3PAN0AtVjzAF/M3Ah9SKjKBJZHh55S7Z8E/K8w0ZxLFFJ6A4Iw1tYP0f8DrXSQRLXV0IqC+pZdJEjxJeRaPqiNmXTG3UdOVp0CiYHSP5wnIyiHFpYiolGFlbR4kUsy2XsLddZ2jdqo5FJEXsBHIqoO460gX4HKhPoJgGs+XJEEAgKjyrnVRVrsTxSuXvrhHmdaxqLeGEfkXfHCZSfkFSrBj4Ln3x0LOKqEXmjdJOvSL7jp8V+VuWuMvEdTNnk7iZ3N7n7yNxdHjzxDYofJejTX4U+54oXYF9Dm+cK9DEUPUqzchLBG+/INgODeIj04/szSOxPQuF8cZ3hWcVXxEduK18RflT5w/eiZatabv21L1BAsqPTYAKVSMRDkruW2IFEMtXWKrc32owlBKhaAxGx42BzXdAZtSmUotMr22axFlZ9n/tzK8gIa10FRK4qDl3nu0GSGyS52Y02u9GfZjfaIMlN7m5y99vM3XuRZCUVZYvHSbZIU27mLtL8uDtBhgn1C8Qq5chVy2gFibEKYwVN5BCMB/1xf7Ibie2Yb8c7W3uTQbQz4C92+7v98fZgN1jc6y/qPK6SrJlTC/52fiQTA4j7DDiuUBBcNtc6bh7/FfhWZIJlDUtPhZvB5mDSywo7DvZWseOZ1uwtV/MSIdkGhlS1jbCmwdwU55pyLkzgbAp1UeGLTwlyYSjJVAAVfIfD6O0qJi9qAXTNPBxN8N2cf2frg6ziIlWUFLE/oU00omYNgSXxBegEMR9QIAQ7her8FdGpd9FvQvLsBDU+Qo3ZwXUkBCZ6hdxfrDvfPQThDdaIU+fgOw56XbfDFQQANASuZlW4c4PPN/h8s8dv9vg/xx6/weeb3N3k7reZu1+Azz0auhufw4RH43OY2+mxCku9oVtlvzdMp1TxElB4Mx1FhaHj5hKDgxGsgIf42h+ZnAOu33ehPALQjpkpYzXESxFhoQC4RZ9EPMQ7HViHVkfARQhaF8YeHiFql7crqb7uNhAvLz6kAhLA38vGyoeXq4dBFwnb7o2Mb7vlmlAuXtV2fYuzaGESWFNes7qBQIMAu+3wTHaWLoZ0x+DdNYUTbzi4IoET6FaXY9Ch0DASs8+VaiLuAsVfMgyq61z3Ui7vy8x1AcWZyLQZZKrPBHoMImbQBn1vaXaHIn9FP9Dr3CS3v10XR+gOXdaZ715uMJ+BpEsqogqXdXCeYs/guK+EaL0PYp85WGH2DqcN2CvBDTQ07tXLsx/fnz1nU0TKVKnc1T0hsbWBIDuGEKFKPCpfQ+Ai2hzrC9SjxosezHw2SUBh5u/DlvdpfoIt6gT2FDIpLhJUxnDV4y/58ca6O26/flAhey2NuwNoaY5X0d0QvshKvfiCXk8V4ruSWuiohUQNLxg2pHCmvYjcxaEIyg+S4Iklaz2ZuaMXLtDD/g+eINVlGdASXo7m67mo9NqT5WjQC5FeU44P6j1d9WouY65+MTujK+CHLJppbcVfGcPQwTS4mBaQRU8Wi+6XhZQR4aC3IFLoWIYyBFBL8h1BYigXTHyMoIIwlQa4qWKXkh/Js5DzH+l278eGzvT4AvZ+nBnr6Aturi7JjAxDZBi6GmC9/G5rxcCC3EYdqA64ANiv/U+VwAu6UPccrbVVnch3aQ1uDRGISlRsNnQ/hnWB838xGsDZ1Rwow9gTVC8s4TfztHB/bRirPM1YtuCqvImGbX3Jbk7e6jQNt/o/mr6o8ag+9HmnkvnXrtJ3VJI/Tt39H1W8TaX5M1Yaj9Ix3Iitb2cWg/yVx2urh5CWvlOC/4dRylVqCKDdqj9NWiSUJTzHqKasjmZS0PFFJniO2K+NkaVTysTMaEx/gOZEaAoYHs/QLWBSPpYJ0KMD9pIzp4RxwBL9ir9tQT0U8opm0A6LDnsPHaWKwC3YTeIVERj7Rfu28hQ8c4yOZa9LZwPoStNC4S1pELtIGYeQeiAiYmmjwhUuaC6VKG2hCfpVq8osxlBDFTrUV5nUvpvgybjES+HBI3mB360/FgfToxf9tyi1IiciocjEeU3Y/hBtiLZwJpIM+1mougDAxAKHt4dnKxSBmLJ0DbyjzbTrF9kuzgUi2B658Nnq9Du9kNoFeJ5pm0MTt0D83gatEYlV8UfU3s3woAxJFq6LcM3bBV29RwMM6ePYdf0bdAQzEAMn39zgwQo2NLf42H3lg10dGAajtf7+a0mS6u3EN/ah6loLfhJ4VFF+h+sPIwL6+Onxdvj/+sL0HjtWX+A+0ZCbz0W/vc9F7wmH8pvgJ0bD5pvP/943n/d4rf4694l+23zT2XrAxPU3tLWJL+tDwi/chp+d+C+2n7Ov8d+5WCt3+eJOzReFLvUBvHF7CbNcHSbx3YB7W7OwZOU+A+pdnUX/cIBoi9/R7/o/hhd49v4f2LAAgw==
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 '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 Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Identities assigned a Role</h1>
<MethodEndpoint method={"get"} path={"/roles/{id}/assigned-identities"}></MethodEndpoint>
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 label={undefined} id={undefined}><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"}><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>
Reference in New Issue View Git Blame Copy Permalink