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-saved-potential-roles.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-saved-potential-roles
sidebar_label: Retrieves all saved potential roles
hide_title: true
hide_table_of_contents: true
api: eJztW+tv3DYS/1cI3YcmC2tffsUGDoeN4xRb2LXPj8uhroFyJe4uE4lUSSr21vD/fjNDSvv0o07Qa9r9kqwlcjjv+Q1F3kW6EIY7qVU/jfajkXDn/LNIT7UTykmenelM2Ggjcnxko/2rqN/rM3zGjqWSahRdb0SpsImRBdIAChdjaVku3FinzAhXGmUZzzJmkSwrKrrMIGH2KjV86Pwfr5uwjhVJaaSbwFp30aUV5kArJ25dr3RjeHZ9DwsW3HBYQRhLoyQu+2spzATmK3gDf1pt6P1GZMSvpTQChBvyzApYwU0yHDLUJof34rbIdAoPnCnxbTIWOY/27yI3KYiSMyjnBo3nDp4kOs95bAWy4YDw/aIKzmFxkN2WmbOstDCdubFg1nGVcpMyO1GO3zI/aQBakYpd/WeT9U777LwadKCzTCRIkZ3W8l6/GjtX2P1WKxWfRYa2a1ous0JL5ZrAWEumqsUL2aoWi5OaTjzVW+s1QyaRM7CWLYsC9ZUykJFYHcIkfYOvh1Jkqd1njUauUwl/pY0GaY3nBamxegxqWG0KPRxa4aJFJZ3QYxDdab9kCU7ilcbgRZNd2hL8ZsJsIRJagd1IN2aNTObSNRhMK/hIKjABzDe6HI2JTtB782d1LsQfrNbXpMBcGwFyeX+BAc1VXlgrsL3C52BVMRJm1ung0WYXHuQQdnmZ07xUDDnICr/vH1I+KWtJ98fgfarMB8IwPaw9FTTqA/ab0V13+wu0l/Nb/5uo1LqEvx7UZqJLtazN/pA1MHk0mHTgo+DGhS7KzDumYI3/xhfa8Sw+wNkNVHehlRVsLHgKFiCvxoErLDLmQFGXWcoGIhgH08WwjgLQKGv4CGuwG4HKGynQYQo2BCtKleA8EMNSsHMwMrDCSBCWcMXGkJbhMViNlIXjZV7wxG2gNJAcjMB8J1QKCyvt0EuswFUbROSfJHkDeSJuP/OsFF4LOBrYLm3FzTfhUw+UgYGGEsVVNOMpNPMeC1JlUosTuu02/rdQEsokEQJ02GRnVVFkmbQOzT1TA4lhTr9ZThUWtG1t4DrBWggeCOR5UWQyIXlaHy2ucbfMNDeGo/tKJ3I781wPPoKu4EVhULdOes7nWF4ugPMSvauZZrMvZkvDKZgA7Hoz1izYEWqNHrobbgRWTZkiFnCTfmqfwXTgY6naXkDoVJoMFGVQpEMs8oAuazavom6y13nT3mvv7nT4NudJu7O70+1sJ1s7fKebbr+B0SuGdLvtesxWN7oGxmjxTEC0uK8n0wxRkO8Fgr3hIM7W7naHk2DDzl66s7MN7Ke1YKuG7CYwRHi5bpOsBOc9nLKySrpHZAgEFoVpPqqTGUnau7w92BKYwzub+IO3ibMafTwG2FJIxbGTkMIXeTziwF9Fg+G4OQfutrvtuL0Xd3YuOm/2t/b2N7vNznb7J2TOl4SnouRHGIUKwPw+DfO5RQhvs7Njdu5tyGLW3m112riIJ76YTM6WDc9o5BzZ08ODfu+o/9Phu2hjiUuhsPJdLYw6ODk+PvkRMT1ZKSzlkT7+ukAq9/erXgfmKSvg03dOw8h7HLy1KiEeZBJ94NAYcOc4JEVf2zyKo5rFBjqdYBWSCgqLTF+SBB9Mdg4qygFB/6es+F4qEY8Ml8ihIJYTmMiA4meZohmoxniSlblp3FxAoiaaHfaWg7mDfAdBGNSp4cknoNVf6czzDF0qCfNZNQVCqYbuK5YVu4IPdtp73a3hzhbn3Tdbnd3twd6Qb26297b39nD1HOzHR+LpsP5eKGFkwjKdgEV+E9jlcUzzyAAt/vyCQzSeoX9KJTS2FjPwy7A33ICK+fbglG3tsoyrUUnP+WhBCSq+PEcoB30GH1SVHiT3hE+MHMmVZa8KlXeH73uXRxfw5Ozw35eH5/ALaS01wD0F3pqiW2oCc2N9QxwHAW44FEGBWAXBQCNQbYBAXNnZgdL/ZScWlMkC6oAZYfUVM2ZJs6HR+VwoJb6RZq9kUzQ3AJlh6uMuGbMBB4jGMIkgXO0BUilcfBQ02Qg49XWT9dJUopAAIAnmQZ/PJwjxeJr6LtY3chDKgmCtLh2iQJmIeVtMVTlvjWliOZo1CgYHcP60n/QSBz0j+cRcFNbeElgM9gGevebmubuYURqpFNt1gJYJtaOJNgCJITOBbBIwekhH1EdD4lHVuDpjzeZLSnfHnhmfISGf8dI+I+5OM0g/MYlWv/gsQvBR8+azEVmjMlPISKHFpslhVG2uKvB9p7+O3XXsrmP3mbG7+PIstIEV9kHo01mGPpeKl6BfQ8VzCfoY8h6lWTWI4E0w5AYDhQSI9MOHCwjsT0LheHFbYDv7FfGRL+VLzPdqe4Tty2p3syr9U1sgg6RHL8EQMpFI94nvKcceJJKqNpdXe6/NQIKDqhUQEbKmYRNdMugmmSkVwWFuN1iqhVXfubC1ARFhrc+AuKpKY7+LsEaSayS5rkbravSXqUZrJLmO3XXsfpux+yiSrLmiaAk4yZZ5zs3Ee1p4j9JyBgOm35jqkCNTLaIVJMZqjBXNI4do0O0MOsPdRGylfCvd2dwbdpOdLt/e7ex2Blvd3Wi21l9N47gOsvmYmrG3tyOpGEDcZ8BxpQLnsk7rdH77r8QP6UNMa5h6atwMOgeVXtfYsbu3jB0vtGbHXE0qhGTnMKSa6ghzGozNcaypxsIAzkaQFxV+G5PAF7qSzAVQwc/+jD7AYfCiFEDXTOLe0IEo4bNecLJ6FaloC9xSJsg0omYNjiXxG9kQMR9QIAQ7guz8FdFpMNEXIXl2hhIfocTs8NZ/yGI1ct9etb/bB+YN5ohzb+AHNnp9t8MVOAA0BD5n1bhzjc/X+Hxd49c1/q9R49f4fB2769j9NmP3d+DzgIYexucw4Nn4HMY226zGUu/p4NEfDdMpVAIH5N5MJ0lpaLu5wuCEK/DMb0RniDGHcDywG7XwvEPsDyvE9enfmA47tehMcISHfhEjevZKk8G06vzXHUwAa903eSGb1XkhpW/oENgAVLUiC+FxAR9xOICOm/kFmqRnI9GVfd4j4l7r4VBXVJ8ze5SyCuc6JrqETEdkNvAMRnAregwsFtBTfGdpdJPcaEk+kOvSZPdfLosn9IAsq9T36GowngGnCyKiCNfTM9rnCMD96ksntadFBZu27tJiJzisy94KbqA78N8xXv3w4eI1GyHspLD3R6eFxD4BAscfJwMn7FV7+jiJKs30+G9v7qsJhhEbZiAwC+cP+0EJP0K+P4METSrFSYJyAs56/ulDPjfvgdOGP6uYvZPGH070x7eCiP5E5lVRycVn5HopE/+oqMWeWkzU7OsFLrxqrxJ/CieBWPaBaUlbL17c04tn6GEzBU+Q6iIPqInAx/y3rqSy2ov5mKMXI715Pn5WH8YSaur8tOragh3Tkds+S8ZaW/EvxtB1MAyuRiVE0YvZusFFY4qIuNueYSn2S8YyBoRI/B1BYCjvTHyAFZoAigbsplIfkr+QZSHmf6FTwL/MyUyPr6CQ4shUJ7/jSO0Cz7hgjAvGPgfYwL+vU+hYeNQOZKA84B3gYGp/ygSB0Zm852mtzOpEvkVzsDQkwCpRscW+/2N/muDCL0YvcHQ9BtIwAuz66x9dQfG0sFjNKavaGljU4DK/mYYauaA3z2+9NYV1888mL0rcm+6gnKhs8rWz9AOZ5M+Td/9PGW+daf6KmSZAXnQ3Wjb0BrNO/jbgteUdPUv3QuBfeEuxSugaepfpVZBZQkXGHXo1RXUyloL2AgrBHWK/DfQsnVMkQtuO4Q8dHxEaGRgDYWsBk/KBzIAe7VZXK3MKGA8s0a74ty2pIcG1kjH0lqLJPkB7phIwC7ZmeN4C3n3UoUc7B8ucomHZu8rYALryvFSwGsZlmTMOLvWER6TSJqVPXNCpKVHpQhP0q2dVUYyuhiI0qUkxuT0Z4jYzdLAzhn9iLbC7DXvMoHq0YrjkMxXkTGTkmThuHrY/RRu8LR6LrMDmELIuADAxs8Jx/2KJIhBTFuSCJlybUStMsi0cC0SwPfLus9nsNNsxtQvwvNDWQTs7Qxw/RaCPPHLrctEl76Y77V96fTOUE+wDWgXuYyGTpe9LfEd4FT3SEWIYUk8IXcYYRMPhd3e484FN0j0+9leysFMEZWMETO/wPCjU3+BC5krFfxK4ATG9Cxs2GSK6q/l89f29rmo+osn6KusLFflt3bt8RBHVtdIX6mF9Y/LbuzH5iDdU12Kn3nA93ZyiS/uQzcl0lLf9JL+BPTNr6RMvUqk3Fb8/xJrJH+hawg9c6v7+f4bvt38=
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 'Retrieves all saved potential roles' (get-saved-potential-roles)"
---
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"}>Retrieves all saved potential roles</h1>
<MethodEndpoint method={"get"} path={"/role-mining-potential-roles/saved"}></MethodEndpoint>
This method returns all saved potential roles (draft roles).
## Request
<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":"sorters","required":false,"style":"form","explode":true,"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 is supported for the following fields: **modified**","example":"modified"}}></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":"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":"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></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
Succeeded. Returns a list of draft roles for a role mining session.
</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={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Draft role description","example":"Person who develops software"}}></SchemaItem><SchemaItem collapsible={false} name={"identityIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The list of identities for this role mining session.","example":["2c918090761a5aac0176215c46a62d58","2c918090761a5aac01722015c46a62d42"]}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The list of entitlement ids for this role mining session.","example":["2c91808a7624751a01762f19d665220d","2c91808a7624751a01762f19d67c220e"]}}></SchemaItem><SchemaItem collapsible={false} name={"excludedEntitlements"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The list of excluded entitlement ids.","items":{"type":"string"},"example":["07a0b4e2","13b4e2a0"]}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Last modified date","example":"2020-09-16T18:49:32.150Z"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the draft role","example":"Saved RM Session - 07/10"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"RoleMiningRoleType"} qualifierMessage={"**Possible values:** [`SPECIALIZED`, `COMMON`]"} schema={{"description":"Role mining session type","example":"SPECIALIZED","type":"string","enum":["SPECIALIZED","COMMON"],"title":"RoleMiningRoleType"}}></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 \"description\": \"Person who develops software\",\n \"identityIds\": [\n \"2c918090761a5aac0176215c46a62d58\",\n \"2c918090761a5aac01722015c46a62d42\"\n ],\n \"entitlementIds\": [\n \"2c91808a7624751a01762f19d665220d\",\n \"2c91808a7624751a01762f19d67c220e\"\n ],\n \"excludedEntitlements\": [\n \"07a0b4e2\",\n \"13b4e2a0\"\n ],\n \"modified\": \"2020-09-16T18:49:32.150Z\",\n \"name\": \"Saved RM Session - 07/10\",\n \"type\": \"SPECIALIZED\"\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