---
id: list-personal-access-tokens
sidebar_label: List Personal Access Tokens
hide_title: true
hide_table_of_contents: true
api: eJztW21z2zYS/isY9kMajyhLsvymLzeO7XTcSRtfLF/mansmEAlKaEhAB5B2dB7/99tdgKQo0S9JO9deT19siQQW+77PQsB9oOfC8FxqdRYHoyCVNj8XxmrF06MoEtaO9WehbNAJrIgKI/NFMLq6Dy6tMMda5eJLflTkM3gW2PkoW4RzPznkNDvMafrICB4jjafGZFzxqXCjeJo+T+qJQZ7WzcNNJ8j51CKDpVzMCca8ZDAiFjYyco5aAB2MZ9Kyqcgt4yzSaSoifMF0wsrFmFuMucUYt1ZHkuciZncyn7F8JpgmajD0k75TwoQy/tRl7F+FMAs254ZnIhemy84SGl0PWh3CgBedyRyIdxgI/BgPLNEG+M2F4ioHNmDkRDAjciPFLc6dFDktFQERIJsVNmczfivo4SsZq+d0/ooZOZ3lXdB9xZ0lZ5CoNeIb3il4A19LgYJ17QomY6FycCV2doJqJX3heHY301Y8JqKd6SKNUSz0UhGDPkF910EmroPOsmx+YCVdAkbUd1JNnQQjJ+7TzvrqWgFxroCHvABWHH/IL5hkzWht5mJS0TAjQDU277CvZ/E5i3QZcblEd8ZtGz1Sj2IuKuKX+vGSgGsOVSrRUXySS3AB1IE0AjJMwlMrIHqjmch4MLoP8sUc/cUCXTUlb0l4kebBSBVp2gnEF57NUxwxiA77B72Dvf3Jbi/uHRz0+vBpd7i3N0gmg4O+CB4eOu2+mMiUfPUr+HhYddu3RAPkt8CcZYVF3aKmbc5VzE3M7ELl/Atz0ybO/lf/2GFH52fsohx0XOeT8yqIbr6f5fncjra3Y1Btihm5a7lM51qqvBvpbBtUvc3ncrtcLKzzUlgH43dOUOAs9Hy+vlbX6m35FJ3TFvO5NmhiTBhNV0mkSGNwAxUzVxW0sSOksLWVcptDzo+3tkZsKxUdIIX22QqWLVQOYqlgg95gJ+wNwt7uuN8b7R6OBvvdQX/4S4AZGbiba2WFRcUPej3811T3O4jwxzMu5qAIq4/KcSqfz1MZURHb/tXi/Pt1w3JjOPqEzEVml57rya+gSExqBoXOpeMKMlerc66msjqDtbLKvs81xk2BavGxCZ8NeiZZ4A23MmJYQ193G8o82Ev6cbSXiINkdzjsDw93e8PdYTSZ9PuD/YOEo4s6/34Jm7TeU4x22TFXSufILLk1TgCGNXwxjyUMzA+QkBdQeFCopgA/61j8eMHOwExThzCQZRvpuWgxC3oTn+DE3BRi3Uzr+QERAFGzmCfXI/aC3q0J3ZR6meMrIJDpUWsqC2mlUSKNzYmJZwYCWNIqBvzRcZWwzeGa7J63ug9NfmWritldc1RH9TkfeJr6yfg9w/mkDlVkqIuzk9Ofx2fjfyI+qo1aPQXBXhIiL5MKoqjpOy7X8+FewnksxLDX30smQ9HrH0SD3t7O4cud/2kGZgUUsBCrFPoei6Wdp3xB0dJk6MKlTawxAXBMz855/p5sC88ioJGLVoVAlGcc/TWGEWEuM9EaofiWUi+O6LAYWARmyXczKL7SeVQHIJJAXAGpvD3h3EHQem5WdAoFM+zth/3+uH8wGu6Odva7vcODX5D9MnO38b8amX+APMieS6FAYSoU1ibhwNlyBiPgjstBmczmsCSEP6Y0wPKsmMcEbKDwQo0FhH1+NAaSAF4cNNYqXcCfCMgC6wtPzIfaAuCV8mk8KVJK3M53kwUWzruZjGZIEYqngWSrWarVFPImgEcJFX3h8z9owxMykEBuv8ZCHmgtGWiidSq4Wk6JHtRUFP33pnEQMKIhndKdkuFDiQ0hm6ONLgB/nCP+YBAROdq8Q/xLp9JbaSVGjMe4mP3hM8CMhEeiy96CgjwXHfZRm88JQAzrUKRzzuewKKoYqVrsCco5dyWlLgVijeauAuo0KCWUNabMvHVw3tSx+4Noa3M/eFwC1B9wgWEbNDlOJVienRoDLIbsg8gLg2XQdwUe7rOJjheoLalueSrjb4Esj0CTWORgnGMor8+nv7dSiRDKr0QOBbEcwUR07FsZo+9mGjzWkSxrJY1ruiZootsHsBKDvE6+Yy8MJkTDo89A6+wFBeFSSZjPyikQRhUQbVlW7As+2esdDobJ3pDzwcGwv787OUz4zk7vcPeQ6gCEO4axbQEVzaV/wMQBYCvV0CzJf4NCwC9A98QALf5yeEg0Xoi93NhKTM8vw70TiCn25vicDfchx6lpQc/5dEUJKry8WEvEmLWJ8Hvo8KRqY6Us5Senb48u343hyYfTv1+eXsAnpLW28XEEiUDF6JbAKvjCTN8Rx14AzMRWYNuBvfeWp7oFAnFllwdK980uoEvPmM9OMMOv3jJjmTRLjM4aoRS5jSb2veyKLqRrfAYlCFLuhFuX03H4FkbyPA/feU1usRkUdmFed9lRHEu/HwPRCERh/gLzMI/julNPCghlQb2vhpIAeU5GKzigVuVqWSwzy7tlo2BwAOfP+8mR22UgMZejsPIWz6K3D/ZYtE6Tu/GS0kil2JJCCcLNAahh2hjQMJU7CT2sT0fUFULiUeW4KmMtgx1Kdz85Zk5yTe8iXtgXxN15CuknJNGqF7fCBx8mfJ+NyBqlmXxG8oiBJvtRlbnKwHd96yZ2N7G7id0Xxu7qyxL4+LcEffrr0OdS8QL0a6h4rkEfIxw6ZOUggjfekJ2ljdMfP45r3Cm+zBHD/Y74yJXyNeaPKnv4LbpyB68s/bUtkEHSo5MggUyEO574uObYgURS1c76aoCAJxIcVLVARELLC11Qs2AKpZATbjvUsahXfl++wsMOqAsVh25DcIMkN0hyU4021egvU402SHITu5vY/d+M3SeRZMUVRYvHSbbIMm4WztP8e5SWMxjAyp8GWRVyZKpVtILEWIWxgiZyCCaD/qSf7EdiGPNhvLdzmAyivQHf3e/v9yfDwX6wXOuv6jiugqwZU0v2dnYkFQOIuwUcVyhwLptrHTe3/0C9RiSY1jD1VLgZdA4qvamw4+BwHTuOtWY/cbUoEZJtYEhV6whzGozNcKwpx8IAzqaQFxXurUrgC11JZgKo0L55KjNJwYtSAF2zCI8S/HHbBUp9bsGvIlWUFsAhZQLc2MZ177jE3woTxHxAgRDsFLLz74hOvYl+E5JnH1DidygxO/0SCYGBXiH33bb9XfzB0mCOuHAGfmSj13U7XIEDQEPgclaFOzf4fIPPNzV+U+P/GjV+g883sbuJ3f/N2P0KfO7R0OP4HAa8GJ/D2G6PVVjqLR1Q+G/DdAoVzwG5N9NRVBjabi4xOOEKcCVkaCooh3A80B5st59pxfMFBAwdT4VJYWx5fvPenb9+6PK57Janm5S+o0OcE9BPS+rBMwIuzHAAHRd1C3RJuUai/7pkR8SdqqtDcOU50Scpl8f/Frow/ox4B098eV+ix8DiHBqJV9Yff3qg87Qr8oFclyZ9+O2yOEKPyNKmvidXg/EMOF0REUW4qS8uXCDqdquvXV+oKwl2aoO1xd7jsAF7I7iBlsAf7fzx4/h1dRwp9meChaQTk5ytXjfwJ8+wvBhdTN01gaPGTyUYOwwPuODB7gsh2NWZV8LPkOQ/QFYmleIkQYkAZ7389DBvzHtNtY6aAqncoS542r1WITuRxh0ududwvIjU47Gr1gM738rEd+1B9nqFC6faq8gdvYkggJEETy1p65sXd/TCJXrYQcETpLrKgzuRRHw0f+CKSqt9Mx8NeiHSa/JxrT7SCbPmNObyVnmX4IxFM62t+Btj6DoYBlfTAqLom9miY20hRUQ46C2xFLolQxkCLCT+3kFgKOdMfIJlmVCJBsCmYheSn8iyEPOf6BzZp4bM9PgKqieOjHX0FUfiV3jGBUNcMHQ5wHr+XXFCx8IjmXiGDIPeOcBxbX/KBJ7RpbznaLVmdSK/TXPKo2dEpT6dXCc4/4mVB9SaJ5gBVVc/+eFNH08LK1RDWeV+wKoG1/lNNRTGFb05fqv9KCyWfzZ5UeKjetvkvUoXv3eWfiST/Hny7h+U8TaZ5q+YaTzORXejZX1DsOzkbzxeW9/Gs3QhBP7CW4pVgtTQsNSXHZcJlceFKaqjGV4Wg6ZhLniO2K+DnqUzikTo1TH8hXWEpnRK1wDLHFo2meJtB9yiLlfmFDAOWKJd8bstqAvBtaIZNJSiyz5CT6YiMAv2Y3jIAt79qn1jVp9qPimNDaArywqFtxCA7SJjHFzqGY+IpY0Kl7igPVOi1IW7LFPNKqMYXQ1F6FJnYjL7PsG9ZWhblwz/zFpgd+s3lkH1aEV/ua0W5INIyTNxXBO2P0cbvC2ciXROVwGALTwCXa/w09l4jSIQUxbkgs5bm+m2n2S3cSwQwfbIuc9Ot9/thdQuwPO5tjn0sEvE6aLXIzdzV1zxvt5W39zRffaOrq+U2OJsz3FfDvVfuJbLdbhXwSMdLvRMMzAUjri/x80bbPke8LG7WIl9L7gOxnPcfsmgaarNhd//uwu/rd73WeCu0tLNcL91FAS40/Byj9rcxX3sLu4Taq8vQddav6k3ZSCo8bKi24ulCHfT3G7t0qy13zORSrWD9sMp1gr+CFr3H3Cph4f/ABiVWkc=
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 'List Personal Access Tokens' (list-personal-access-tokens)"
---

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

<h1 className={"openapi__heading"}>List Personal Access Tokens</h1>

<MethodEndpoint method={"get"} path={"/personal-access-tokens"}></MethodEndpoint>



This gets a collection of personal access tokens associated with the optional `owner-id`.  query parameter. If the `owner-id` query parameter is omitted, all personal access tokens  for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right.

## 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":"owner-id","description":"The identity ID of the owner whose personal access tokens should be listed.  If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read'\nIf an actual owner ID or if the `owner-id` parameter is omitted in the request,  the caller should have the following right: 'idn:all-personal-access-tokens:read'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'","required":false,"schema":{"type":"string","default":null,"example":"2c9180867b50d088017b554662fb281e"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**lastUsed**: *le, isnull*","example":"lastUsed le 2023-02-05T10:59:27.214Z"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

List of personal access tokens.

</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={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the personal access token (to be used as the username for Basic Auth).","example":"86f1dc6fe8f54414950454cbb11278fa"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.","example":"NodeJS Integration"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the personal  access token.","example":["demo:personal-access-token-scope:first","demo:personal-access-token-scope:second"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Personal access token owner's identity.

</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Personal access token owner's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Personal access token owner's identity ID.","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Personal access token owner's human-readable display name.","example":"Support"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"created"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when this personal access token was created.","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem><SchemaItem collapsible={false} name={"lastUsed"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"format":"date-time","description":"The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed.","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem><SchemaItem collapsible={false} name={"managed"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"example":false,"description":"If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows."}}></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\": \"86f1dc6fe8f54414950454cbb11278fa\",\n    \"name\": \"NodeJS Integration\",\n    \"scope\": [\n      \"demo:personal-access-token-scope:first\",\n      \"demo:personal-access-token-scope:second\"\n    ],\n    \"owner\": {\n      \"type\": \"IDENTITY\",\n      \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n      \"name\": \"Support\"\n    },\n    \"created\": \"2017-07-11T18:45:37.098Z\",\n    \"lastUsed\": \"2017-07-11T18:45:37.098Z\",\n    \"managed\": 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"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"403 Forbidden\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The server understood the request but refuses to authorize it.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>

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

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

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

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

Generic localized reason for error

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

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

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