Files
developer.sailpoint.com/docs/api/beta/list-identity-access-items.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

91 lines
43 KiB
Plaintext

---
id: list-identity-access-items
sidebar_label: Gets a list of access items for the identity filtered by item type
hide_title: true
hide_table_of_contents: true
api: eJztXFlz2zgS/iso7UOOsihZlq3IL1uO7WQ9lcPro/LguCoQCUlIKIADgLYVl//7djdAiZTkM6mdJMWXiQwCjb77a5CY64bOhOFOanWQNLYbqbTuIBHKSTfdiWNh7YETE9tYazg+so3ts0bxlP0HpmozbZyvNRJhYyMzpAI0TsbSsolwY50wI5yR4kJYxhnSZnrIONFlEgizoTbMjQWTBdWhTJ0wImGDKT0oT3bTTLAj8XcuDRLMYQcjvxPzzMYgCFJ/JhO1XZBrjj2T20bw5BkDMTJuOPAmDApz3ZDIcMbdGB4peAB/yQR+23gsJryxfd3ATWHUghxq1LhZaxjPAGjLmVwsC18ShkiJKz7JUqTxKl7vt8VW71WP865I+rzfHiT9ZHOj293sbAwHQD1w9HcuQLMzloiHO5laZoKUdY+2I3YwZEo7lhl9AYPJGsxjiRjyPHWWOY2rda5cRYxi7OYclWEzraywyFWn3cZ/lnlZYXkbAc1YKwec4CKeZamMyZatrxZXXi/Ly43hqBYigONaiY9DMmSYoQdfRYzsgnjE7NyJ/a9Do8HFxFHgm1T+oLUo8mNXZdkjV+wrGpuIR+91pMtCnd/czCxGivITWZB+2Uo7qjBO5qewwrKw2wVPc0Fa9nNOgjXKCkWrYALpxP31V+1Xvd7WhtjqJ/32Ov7qdUS/N2y3t4Zzp7ben8CtdW5i8cGP7nHHj2MpVCzwpxVuNoMSVKfX39AbneQSQ2tBhjI/rMk+afMt4dPWrnTyu1B2LLMgJC6VNkv5tNjVRGzHQFSwIz3iY8Xe76HLz62xSx6/vd5ZQ0/dqywGM9Mv0PpaI3jKbRrGZw9TbQi7hyvVyQtRJGdYk5iIo0QRCRQlP6To1Zq4X4deJVm2Wh1Z9hBVwOpH+xYvm6QUVCv5KAnHoFSR2m9hpjT1EUxxB3l6kDukMDI6z+x8h8Zpdgl2YhM9kCnWjJmHhpinBT8xSkra+PEYIf1i6lmhWGb0g9IITvuB7FHdFXm5WyzMjTeYHrurqtVuKlEx+8ZAqWwC2HC5UYBG5JAKJ9Z+AbVsoBOo7lDJFAglk6fUslkuh4QLEMxJn6gT4bhMd3Uiluv8orBvpBLNkeESORTEcgwLQzWHFeBVRjBPEusvikDzokpBB01E6+w1TwhcoXy7QRhQkzM8/ga00K/uY+hUSVjPiiWAM2aQY8W2oif4YKvd73SHW13OO6+6673NQX/INzba/c1+H3efgMn4yKtmAQRUt34rlDAyZqmOwSLfBUJPDronBmjzMm642wZE4wH6J2hDc2diBn6ZE1duDTDv691D1u2xlKtRTuN8tKAE1Tw9RrfO05QPcAhRJUjuCX80ciTVKlaEyieIx/f23+ycvjuBkaP9/57uH8MvpLWEyiHRSZWgWwKr4AtjfUkcBwEuuWVWpKAOkUTsZaD6EgTiypYnSv+XnVpElAErwoqw+4oVZdJsaPSkEkoUN1eOPZeRiNbYAMcm3MVjNoC8ljAwIU5/idU9c813QZMv2RggvTAvICkliUQhecooxUDzwadAiPEkwdD1BIY5hDIwI6FryB2iXhmLqi3mqqxaY4633pWNgsEBnN/vJzuxy4E5ErMchTNvCSwG+wDPXnNV7k5KSiOVTpXjMUjB03QKajQGNMygzAC+tiykIzSXhcSjinmzjIUpsBCL0t17z8ye0/Qs5rl9QNwdppB+miTa7MGFCMFHLUToLdAahZlCRoKHKDYtLjqQQhdF4ENDKNKkjt06duvYfWDsLj4s2sLwlKDP+jL0OVXFiQoIsQR9DHmP0gvHLt6QawwUEiDSX59OILC/AUyE+eIqw6OSn4iPfClfgTYLe/jxAcKPmbEqtkAGSY9egiFkIpFsE99zjklRXlUby7u90WYgE4TCyxARsqZhU50zDiozuVLICbdrLNHCqmeOjfnF7FiLMiDuqpJmpqVyNZKskWRdjepq9OdUoxpJ1rFbx+7vGbt3IsnqC4aAk2w+mXAzDQer/jm9+WEwYXYYyGYhF84Eq2gFibEZxmpUkUNj0FkfrA97segmvJtsbfSHnXirwzd76731QbfTa5Rr/dk8jmdBVo2pkr29HUnFAOIuAMflCpzLOq2T6vFfjof4Q0xr9JKswM2g86g4YCTs2F3Gjh+0A9mAMGBHc8vx4unRO6QPWxN51Bud7SLM9qqD6dwRpKT3d+JKWldDxxo61uWnLj9/TPmpoWMdu3Xs/p6x+yjo2L0POnYfAR27DCHWECHWPwkdE8AdCM2GYBSQIc5BvfTtRwaiwK9w+hjC3nEzEm4G9MoocnPVe+oDMI5Bhz32u93ywtqf2nIFQFZcZT6AZiCoBos1WKwLTl1w/oyCU4PFOnbr2P09Y/cRYDGgodvBIkx4MFiEuVGbzbDUG3Su/ztmpFAJHJB7Mx0TWkzmKJBwBV6ogPkj+tiT7ixsN1r+ggOquxm+6oe00rqWyU3Lv2NuynCBw+NSz2RuUlg8di6z263WNdgObHYT8UxGxd0ApS+jWE9aA1DYilyEHz/6uMMJbOfwIADfiLRtJDq0z35E3Oue5EPXBRvQ++47KeOnnmjUKWBi5sms4b2G4Fw0DCxmXE2fWZodkTMtyQdynZr05sdl8YRukWWV+u7cDeYz4HRBRBThHM0FTkCfcoO9ToGfXZ+6dnI0/Nl5ec4xQnXP4dLMefnBY+rOEkMfcVqHvRbcQB/hv9x4/tenkxdshACVEkRuERsLiR0FhNghuBElwJ3iKwZcRDXJ6Hw0JuF2Kt+JYMCxYQpKYZ/VsRDsrPhU/QNUhiNI5aR2XCQoe+Cq8+eFBRNxIVIsmtFc2+icMlEt0GKLV9a9oAJJnYRU8HNCo9Fn1WR7EvOWxEKPc4KI9IkGO8sKuXhJrqcy8a+CWjPEIVGzLxa48Ko9i/13xzFEPZLgqSVtPXlzT69ZoodtF4wg1UUeUBOBj+rXPXFhtSfzUaHXRHpVPj6rT2MJ1be6rLg9ZqF4pgk7YPFYayv+zRi6DobK2SiHSHsyW5e4aZMiotlpl1hq+i2bsglYkvh7B4GhvDPxAdZygjLa9/UUtl/IspAXvkCnnbAvFZlp+AxKLs5MdGyfzDNu2MQNmz5P2MC/r2joWBDbKAPlAe8Au3P7UyYIjJZyo6e1MvMT+RatwfKBF+yIis22/R/b8yQYfvlreDh7NgdSdaO4K0Rvs9KUBVpY1irKKg4RFjW4zG+qoZou6M3zO3sZhxX2V5P3xl+HKc5aPqp0+rOz9C2Z5NfJu/9QxqszzZ+YaQI4RnejbUMXUXby1wHTLZ/9QYMAcsN/4SnFKuFw6HKobyMUUyaUpdyhV/t7sWO81ozHuYI7xIdr6Fl6QpEIDT6GP/SGRGhkYA6ErQXcyv01r4idzHfmFDAefKJd8W+bh/f8GlwSulARsU/QyKkYzIJNHH5hCs++6tDNHYNlDtGwbK8wNoCuySRXdKtam3zCOLjUPR6RSBvnPnFBT6dEoQtN0G+2qohidDUUIaJ2xkzsxyEeSEOvWzL8PXuB3W04jQbVoxXDFa+5IEciJc/EeVVofx9t8LbmWKQZtpGQdQXeRJvv8P7gZIkiEFPhEF6bUSsssi2cC0SwhfLusxGtR+0mtRQwnmnroPEtEX8r3C233u3d195nd90XPfZ6fmT/a1+yD7UMm5BWhsdtqKHcN06+cT1rrGxcYe02XZqv9K7Q6YxBvbjq+hrPabCZu8Fhf08eOyQwOEYhNMhDSEGL1/Krmvv5l+NXCvxN4PlEMGRx3ZNuzRc95SM5fx7MkrzA7LHwvxlYyUJxEKqmZRYK1mAdXeD0Z1vEjH/gT79KS5beD6EUsxOJt/sQGjf/A6q8FUo=
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 'Gets a list of access items for the identity filtered by item type' (list-identity-access-items)"
---
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"}>Gets a list of access items for the identity filtered by item type</h1>
<MethodEndpoint method={"get"} path={"/historical-identities/{id}/access-items"}></MethodEndpoint>
This method retrieves a list of access item for the identity filtered by the access item type Requires authorization scope of 'idn:identity-history: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"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"}}></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":"type","schema":{"type":"string"},"description":"The type of access item for the identity. If not provided, it defaults to account","example":"account"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
The list of access items.
</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><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"AccessItemAccessProfileResponse"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"accessProfile","description":"the access item type. accessProfile in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"sample","description":"the access profile name"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"DataScienceDataset","description":"the name of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2793o32dwd","description":"the id of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"AccessProfile - Workday/Citizenship access","description":"the description for the access profile"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":12,"description":"the number of entitlements the access profile will create"}}></SchemaItem><SchemaItem collapsible={false} name={"appDisplayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"AppName","description":"the name of app"}}></SchemaItem></TabItem><TabItem label={"AccessItemAccountResponse"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"account","description":"the access item type. account in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"nativeIdentity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"dr.arden.ogahn.d","description":"the native identifier used to uniquely identify an acccount"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"DataScienceDataset","description":"the name of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2793o32dwd","description":"the id of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":12,"description":"the number of entitlements the account will create"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}></SchemaItem></TabItem><TabItem label={"AccessItemAppResponse"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"app","description":"the access item type. entitlement in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Display Name","description":"the access profile display name"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"appName","description":"the associated source name if it exists"}}></SchemaItem></TabItem><TabItem label={"AccessItemEntitlementResponse"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"entitlement","description":"the access item type. entitlement in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"groups","description":"the entitlement attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Upward mobility access","description":"the associated value"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"entitlement","description":"the type of entitlement"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"DataScienceDataset","description":"the name of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2793o32dwd","description":"the id of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Entitlement - Workday/Citizenship access","description":"the description for the entitlment"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}></SchemaItem></TabItem><TabItem label={"AccessItemRoleResponse"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"role","description":"the access item type. role in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"sample","description":"the role display name"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Role - Workday/Citizenship access","description":"the description for the role"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Source Name","description":"the associated source name if it exists"}}></SchemaItem></TabItem></SchemaTabs></div><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 {},\n {},\n {},\n {}\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Access Profile"} value={"Access Profile"}><ResponseSamples responseExample={"[\n {\n \"accessType\": \"accessProfile\",\n \"id\": \"2c918087763e69d901763e72e97f006f\",\n \"name\": \"sample\",\n \"sourceName\": \"DataScienceDataset\",\n \"sourceId\": \"2793o32dwd\",\n \"description\": \"AccessProfile - Workday/Citizenship access\",\n \"displayName\": \"Dr. Arden Rogahn MD\",\n \"entitlementCount\": 12,\n \"appDisplayName\": \"AppName\"\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Account"} value={"Account"}><ResponseSamples responseExample={"[\n {\n \"accessType\": \"account\",\n \"id\": \"2c918087763e69d901763e72e97f006f\",\n \"nativeIdentity\": \"dr.arden.ogahn.d\",\n \"sourceName\": \"DataScienceDataset\",\n \"sourceId\": \"2793o32dwd\",\n \"entitlementCount\": 12,\n \"displayName\": \"Dr. Arden Rogahn MD\"\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"App"} value={"App"}><ResponseSamples responseExample={"[\n {\n \"accessType\": \"app\",\n \"id\": \"2c918087763e69d901763e72e97f006f\",\n \"name\": \"appName\"\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Entitlement"} value={"Entitlement"}><ResponseSamples responseExample={"[\n {\n \"accessType\": \"entitlement\",\n \"id\": \"2c918087763e69d901763e72e97f006f\",\n \"attribute\": \"groups\",\n \"value\": \"Upward mobility access\",\n \"type\": \"group\",\n \"sourceName\": \"DataScienceDataset\",\n \"sourceId\": \"2793o32dwd\",\n \"description\": \"Entitlement - Workday/Citizenship access\",\n \"displayName\": \"Dr. Arden Rogahn MD\"\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Role"} value={"Role"}><ResponseSamples responseExample={"[\n {\n \"accessType\": \"role\",\n \"id\": \"2c918087763e69d901763e72e97f006f\",\n \"name\": \"sample\",\n \"description\": \"Role - Workday/Citizenship access\"\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={"404"} value={"404"}><div>
Not Found - returned if the request URL refers to a resource or object that does not exist
</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={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\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>