LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/get-common-access.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-common-access
sidebar_label: Get a paginated list of common access
hide_title: true
hide_table_of_contents: true
api: eJztW+lvGzcW/1eI6Ycmgka+7drAYqH4KFQksetjs4BjbKkZSmI7Iickx45q+H/f9x45oxkdjuMW3birL4nF4/Hd/D0OeR/pXBjupFa9NDqIhsId6vFYq26SCGujduT40EYH11Gv22O+i4W+m3aUCpsYmeN0mHw5kpYJleZaKseMcIVRlrmRYElhjIC2xBPgRIANtGEc+qzTY2E67BJG+lkiZdKJsWUJV6wv2EBmThho5SplVhsn0g47F58KaYRlvHAjbeTvJAazCYjE9IBJLg/8SvFYpyKTanhgBE9BqJwbPhZAEkW7jyRy/6kQZgJ9Cnrgpx4MrHDRrIyn1MxAQE2SDYosA6ZtkTkGHR12ZQueZRNmc5HIgQSe76QbsVYmx9K1GEzL+VAq7gTMN7oYjoiOJ2E7H9WFEOz6X1use9ZjFw4E5iYFzWeZSEi+s4r3m1cj53J7sLaWiluRoSU7lsuM9N8BXa/JVK3xXK7ZQCdOKjrxVAevyRJjbQTIBX+OSZEdkN14FYNnDHhmRTsSn/k4z0A/6+3IJiMx5tHBfeQmOaoMVhVDYWCeJ+KbtjahYSyVHBdjmpeKAQdZ4e+Hh/Zi5ZOy5nT/jn9mqhj3hUHzBo2hRr3TvBjdbe78Ae2N+Wf/N1GpdAm/lmoz0YWa12ZvwFrOFKIFoQY+Cm6c67zIvGMK1vp3fKkdz+JDnN1CdedaWcFGEEJgAfJqHLjAIiMOFHWRpRi704geVFGAYdzyEdZidwKVN1SgwxRsCFaUKsF5IIZ1ELWQJByywkgQygkjfiugGaxGysLxcpzzxLVRGkhDRmCugWQECyvt0EuswFVbROQfJHkLeSJub3lWCK8FHA1sF7bk5kX4FMqzwKn6WmeCq6jmKTRzqa/4TGvnvOWE2isTFxbtguYvRWF2ohwEqJ/WR3urv1hv33nmgbM48PkaDXhStqJf2CLPaf8gHVMGB1L6DrshW2epJef0u6I29gAptFqwsCtsq3XAWuJTm9m7lm834laKO5G+mVxZYcChoDt0+a2nI9P5WaELbRQ6mx1oC+qwd20221mzS31MVHOGqLYA9LGP0fnp2+OP0SIPsm5CU9DPiEaewWa51KGsQ01GS/2HNmfyn2VTa/kNQ5THVqAJwSTRw6zXXQC1b9znUOBZj7vwbU/zNzBh3e5tVvoaUnozYSFwPY5q4CcPkTikCQ+JWH/CPAluE0h2sEZnkVuQqR5u0Bl8Trdopc31dfxvxgAFTBGph1sez3GWSesw3z+K5mDhRMOWBjsPUOV5nsmE8tjarxZJ3887CDeGoyuRXLV23f8V9I6wzaCdnPQMy3SRczX5v1ISHJT1jpDfxRpsaGhnZ4f3t/d4vJ5ubcbbP2xsxfvru4OYp4Otnd29VOzybXRTP39eXwvJ/3ExDhtke0fIgp8xy0BzJCWAVxj8DKzTPTw8vrj4z9n56Unv7fHrKWfVqkIhsriOmiOhA0kg4HfSkZ7qRcIlEnkoM8DXieJdcWbM15Go9wETgMd5v9wRgbK+U8K8fwZrNLFikH71vtpUngga7GGx8nrgIqGeesBkjKH/hEVO35/0zt8dH6FZj47f947JJTJu3VWeUi5dQAOLn1OVTcrkXuVhnBE76SVtbmlLsESdGSSGQAoQkwFgBkWbVgNpxpCQgLtUKCyCgmSByfOwxjO5XGDmBKa5LzBdB0C1oC8B0UL7nIcUCQZ8wDHbi7LkYSaxuj02BgSOQ6b0iNfXdoRkWV+nE9wTpAK4KdPnpMglOSQVDvauQ9q4v+Q7J1KJeGi4RA4FsZzARAYUbyXuGR55epJl2qRxzc0ENNHZYG94SoU4yncYhEFVGp78BrSeEjEhR5dTmJzulQuWFXuC93fX9ze3B7vbnG/+sL2xt9PfH/CtrfX9nf19XH0MhuNDYRfsLc2lfxQQnjJhmU7AIr+DQsCNQPfEAC3+9O2IaDxB/3jK4cdWYgZ+mROfoYDh7M3hGdveYxlXw4La+cxGLlR8dbEoDDzhUyOHcmEiLRP80fFJ9+rtJWb245+vji/gL6Q1d6TTVeCtKbqlphJvpO+I4yDAHUS7FYiKECG0AtUWCMTDyU8YKP0vO7GgzBLSwIyw+oIZddJsYPS4EUoUN58deyU7otOGeg3aIEskI9bnFhOP8kUsBnHu4rdBk61Qvb7usG6aShQSykoq/izMn2Dhx9PUA0l/vAOhLKjY1YXD2lAmommLqSqb1pjmk7d1o2BwAOdf9pNu4gpgjsSsR2HlLYHFYB/g2Wuuyd1lTWmkUkTMAGITOqRKtIFCGTITyCadZSEdEXCFxKPKcVXGqqdJSnfvPDNHTlNfwgv7hLg7yyD9xCRa1XErQvDRkY7PRmSN0kwhI4WDN5ocRlXmKgPfQ+tV7K5idxW7T4zd2c4S+IRegj4b89DnSpWn7yDEHPQx5D1KzxzRe0O2ER4GiPTTh0sI7N+EwvHic45HFH8iPvJb+Rzz3coe4QShPGAot/6pLZBB0qOXYACZSKQHxPeUYw8SSVVb86udaNOX4KBqAUQk7DzRBVXzplCKjj1tm6VaWPW9CweeoarDDOg/tcT+vGKFJFdIcrUbrXajv81utEKSq9hdxe7LjN1HkWTFFUVLwEm2GI+5mXhPC/0oLWcwYPrluQo5MtUsWkFirMJYURM5RP3Njf7GYC8R2ynfTne39gebye4m39nb2Nvob2/uRfW9/noax1WQNWOqZm9vR1IxgLhbwHGFAueyTuu0efxX4LesAaY1TD0Vbgadg0pvSuy4s+iEsQcWMeilF36JJUeNHm9zBSwAJPVRUyGfFUJcIcTVLrPaZf4eu8wKIa5idxW7LzN2vwIhBjS0HCHCgCcjRBjbWWcVljqh78F/NVCkUAkc+Js9OqH70ekUBRKuAFcKV7Ixh3A3gh9r/oJJzMvr2R5yelYKk8GQ8l7TPVgILPPQ4bnsQOICI7mJ0nd0uakPalmQcfDjtI8uHEDXqPwCHdKpkei2PscRca/h8F09qu5PPUoZb1Sg6Sa6gKxGZNp4USW4EDUDizlXk+/9BZEOucycfCDXlcke/rgsntASWRap79HVYDwDTmdERBFu0FxgaiBE9sKrCoc+QXULNO/1TX3MBQJyz+HcyOkmg2XE5hxDpzhsk70R3EC14E/WX/304fI1GyIMpTTg79MJiXUDBNIZuBGluW55yoyTaOeZXlPvNs7xMazYIAOlsHBPthcU9R7y/zkkbFI7ThKUI3DW02/e8ca8JbdiP6qYHUnjL+b5W2hBRH9z+Dov5eI1uZ7LxHcltRCBMVHDW38NLrxqrxN/LySB2EYSPLOkrWcv7unFNXpYXEELUp3lATUR+Gh+fUlKqz2bjwa9GOk1+fioPowk7LHNacynNGZHdDW8x5KR1lb8kzF0HQyV62EBkfZstu5w0ZgiIt5cr7EU+yVjGQNiJP7eQmAo70y8jzs2ARYNWE6lPmx/IctCXviFLgT/0pCZmq9hY8WRqU6+4jrpDM+4YIwLxj5P2MC/37fQsSC2UQbKA94BDqf2p0wQGK3lRk9rYeYn8ms0B7cPfCxDVGx+4H8cTJNgefWUOnB0NQZSdVTeJ6XDjCxjgRZuXg1llUcFsxqc5zfTsGfO6M3zWx2W4D76rcmLEnenJyp4ee3PztJLMsm3k3f/RxlvlWn+jpkmQGB0N1o21Ap1J38TMN38CZ+l90vwL/RSrBLahlpm+mSpTijPuEOvpqhORlLQ2UAuuEN82EbP0mOKRCjjMfyhAiRCQ7pxaoBlDtWczIAePWEsV+YUMB58ol3pnn5BBQqulYyg1hQd9gHKNZWAWbBUwxsA0PerDjXbBVjmjF5THpXGpkeYhYLVMC6LMePgUl/wiFTapPCJCyo3JUpdaIJ+1awyitHVUIQOFS1mbE8HeOwMFW3N8F9YC+xuw5kzqB6tGB6ITAU5Fxl5Jo5rQvsv0QZvi0ciy+k6MbCF93OnK7zrXc5RBGLKglxQlGszXAuT7BqOBSJYQnn32epsdNZjKimgPdfWQXlbI/6jcPjuLDzhTBe/hZh1yvvp2fsLeiQb9i4sOtZyPERDjRS+UPLl6HXULEeheBmBxrDj/h4PWLA+e8Bm/0oIix6wIQbW9AHSUk39fz21Xajt3wQeeVRPkcOpRhRhNfx0Rb6sd7OPKKJ8FvxMPaxevL68F6+PeEP5rPmZ3rB60frtv2h9xPrTh8rPtP/qbemf8Lb0EQNNXwJPDXQzPXml007AC5RbCRn4af5LTG3W3F0FpFKdjv94DADu4b8gXjJo
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 'Get a paginated list of common access' (get-common-access)"
---
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"}>Get a paginated list of common access</h1>
<MethodEndpoint method={"get"} path={"/common-access"}></MethodEndpoint>
This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read
## 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":"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><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","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**status**: *eq, sw*\n\n**reviewedByUser** *eq*\n\n**access.id**: *eq, sw*\n\n**access.type**: *eq*\n\n**access.name**: *sw, eq*\n\n**access.description**: *sw, eq*","example":"access.type eq \"ROLE\"","required":false,"style":"form","explode":true,"schema":{"type":"string"}}}></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: **access.name, status**\n\nBy default the common access items are sorted by name, ascending.","example":"access.name"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
Succeeded. Returns a list of common access for a customer.
</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":"Unique ID of the common access item","example":"555ab47a-0d32-4813-906f-adf3567de6a4"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
common access item
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common access ID"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"CommonAccessType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`]"} schema={{"description":"Common access type (ROLE or ACCESS_PROFILE)","type":"string","enum":["ACCESS_PROFILE","ROLE"],"title":"CommonAccessType"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common access name"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common access description","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"ownerName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common access owner name"}}></SchemaItem><SchemaItem collapsible={false} name={"ownerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common access owner ID"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"CONFIRMED or DENIED"}}></SchemaItem><SchemaItem collapsible={false} name={"lastUpdated"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","readOnly":true,"format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"reviewedByUser"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"true if user has confirmed or denied status"}}></SchemaItem><SchemaItem collapsible={false} name={"lastReviewed"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","readOnly":true,"format":"date-time","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"createdByUser"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"example":false}}></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\": \"555ab47a-0d32-4813-906f-adf3567de6a4\",\n \"access\": {\n \"id\": \"string\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"ownerName\": \"string\",\n \"ownerId\": \"string\"\n },\n \"status\": \"string\",\n \"lastUpdated\": \"2024-03-01T13:18:59.973Z\",\n \"reviewedByUser\": true,\n \"lastReviewed\": \"2024-03-01T13:18:59.974Z\",\n \"createdByUser\": false\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={"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