---
id: create-personal-access-token
sidebar_label: Create Personal Access Token
hide_title: true
hide_table_of_contents: true
api: eJztW21v2zgS/iuE7kNfYDm249ixvxzSJD1k0W1yiYPiLg1QWqJsthKpJaWmviD//WaGlPyaxNvt3u0ujAJpQpHDmeG8PEON7gOdC8MLqdVZHAyDyAheiAthrFY8PYoiYe1IfxEqaARWRKWRxSwY3twH11aYY60K8a04KospjAU2H2azMPdrQ06LwwJX22HGFZ8IpJIPeZo+M+324bYRFHxikW7FDXPsMOLHBjAjFjYyMkfugffRVFrmBLCMs2oH5nZgtEMTODDil1LY4o2OQZT7FSLveSYYVzGzEWiG6eRpOtIIUFthStEIIlSHKpAmz/NURqTWvc8WCd8HNpqKjONvxSwXsJUefxZREayKcU7DLNGG2VxEMplJNWHFVDCFvAFHj8gGP734QDM3eLCFFBZ3xJULO9vCAM21nUcLe+B+m3d5eXE0eoV7jYXfLm6yY66ULnAIF1pSIhwCjE2FYbCC6TslYjae0YQSrIckvJvqDEbg4HAO/DcWKG1FF1gU33iWp8j1ex2Ln67YGWh54kw2eAB7wnNakI0bw2ewTpVpyse40J2OLERmN+sg4WVa4FA+JGoWLRRpL6vnip49qZwmO0uY0t54QBx3glLEDVrkNHgn03RBe/B3MaXHnhW//OMyQx+DJiMTzwRX9okDIvJT/hWOAH7BeUZOpkXNOZ4Eab5mQBZLmr4BwTM93OiiITE0TKSxznSfmQhBQ6sYHPph0WFunEWik8uCDvf4scBz6bw1eHhwJGyulXVW3Wm11h34uDLJ97oQLHTGJZ2+tErB/iQY5+aY8oIBu0YUjBdgHeMSCFRnFUubp3zmbPK7PX3ZK2W8nU+enTzjkc4Zwali9LrKwciV0cnecCsjhmH61bJHHfaSdhz1EnGYHHS77e7goNU96Ebjcbvd6R8mnPyLNLIdo157v5bZnFt7p038NLPtuD0WSWc8SLqd3v7hfrfbT3rdpDfY7w6SqB/xqN3vtbqdg/5h3GkdRJ2D3pjvJ/v96GDA4/HgDxEs1pLI7+t0jR8Z+R+L8i7Gb1xi52Gfk01uE9EpPj2fJy82mhctfgEeH4ODAlhprnmdo/qcRp6mfjI6Z7iexFFlhsd3dnL6fnQ2+hdGtbmI9SgIto2/bycVhIRlTXaiQfuwxbu9hPNYiG6r3UvGXdFqH0adVm+fjH87U3iagWkJCC2EEBuju1RRkWxnmaGrMs+1wbA9j/EXvDins4Uxn3o28QNRIOPoYjHMCDFcb7RXfEpIDWc0WAwsIipBy8wgaEvnBA1IdAiNMAs8ki653Yw3Oq12P2z1w3Z71D4cdg+G+/1ma3D472A1l8G51nGyijFe3ZU1zwXeLue5LOeTXndjnksl2AI7NQaCZsguRVEadDXpPNiDXDYGlIvpT6qvPJU/MnvFouAyPQYXft6o3kolQnBxiRwKYjmChQwofpUxIr5MG8Q/SLIKQjRv+UhAE802pIiYeVjAjr0waGaGR1+A1tkWbnatJKxn1RJwLEo+j2wr+oKPe61BB9JNl/POYbfdP4BExPf3W4ODAXlXBocHpYvdkF2Wt/6HAIOAFJfqCE7kP6AQMAPQPTFAmwfrCeiRMyAaW8Z3N7cW0/PLsIJrQHR+c3zBun2WcjUpaZxPVpSgwuurtVwJkjvC5wAypdrEShUgT07fHl2/G8HI5ek/r0+v4DektVbHHSmw1hjNElgFW5jqO+LYC4D+akUK6kCU99pTfb0Ai/1ED/rszIIyK2wNK/zuG1YskmaJodJk7kqRK3fZS9kUzQZkQRiDQBVN2ZgjmtGKpr9GR86L8J3X5Gs2hXApzKsmO4pjiUJCCAJvBKKwfobplMcxuq4jkJTgyoKqAl0WUE4UMlqJrnNVriKXKra8WzwUdA7g/Hk7OYqKEpgjMRe9sLYWz6I/H+DZaW6Zu9GC0kilM1XwCKQApDQDNRqDBS7Aayg8LPPhiKolCDyqmldHrMUUQuHuZ8fMSaHpWcRLu4XfXaQQfkISrX7wVXjnw2TgoxGdRnVMPiL5vEKL/az6uCrHZ1DmpfHOd3e+u/PdLX139WGFe/xTgj7tdehzrTiUh9pQ8lyDPoasR2lWTSJ44w+ywUAhHiL99GHkISDMF99yhHM/EB+5VL7G/FF9Hm58XN3uVal/fhbIIOnRSZBAJBLxkPiec0yKcqraX9/trTZjCQaqNkBEuoSb6ZJxUJkplUJOuEUoLax6Ufg7pAorOwwtVBzmWqpihyR3SHKXjXbZ6K+TjXZIcue7O9/9c/ruk0iy5oq8xeMkW2YZNzNnaf65e7kKE1j1nonVLkdHtYpWkBirMVawjByCcac9bif9SHRj3o17+4OkE/U6/KDf7rfH3U4/WMz1N3M/rp1s2acWztudo3/nYr4CjisVGJcttI6Xr/9AvUYkGNYw9NS4mV75PdzW2LEzWMeOI63Zz1zNKoRklzCkmusIYxrMzXCuqebCBM4mEBcV3rtK4AtNCd+9hczg1W0qM0nOi1IAXTMLj5ICRHGOUhlZvYtUUVoChxQJUo2oWYNhSXwfkSDmAwqEYCcQnX8gOvVH9JuQPLtEid+hxOz0WyQEOnqN3A823e/iSxGDMeLKHfAjF72u2uEKDAAKAhezaty5w+c7fL7L8bsc/9fI8Tt8vvPdne/+OX33V+Bzj4Yex+cwYWt8DnObLVZjqbfUvPO/hunkKp4D1+Cno6g0dN1cYXDCFWBKyFCuqc0n59hXG+xtbpWllgNEho6p0qQwd1oUuR3u7d3DWcEZPTR5LptV04jSd81IZ3tjUNCG2DNvk8MJ7OjizNcWTdKukWjALtoRcafruh0KdE73wk9SrnqMZrqE+EZkGthI442JhoHFHCqJF9Z3laBu1uQDua5N+vDbZXGEHpFlk/qe3A3mM+B0RUQU4XbeP32FsNvtvtZFPU8lWKp11jY7x2kd9kZwAzWB76j76cPoFZsg2CRnLy3iXCGpLYuvtTr6hh7ML0aXE9d5erT0rgSdhyUpCMw+qish2M2ZV8J7iPKXEJZJpbhIUCTAVbcvq9OJxVeRYgJszjWJhidjtQca2uNL615RsqOqQCrX+wOjzY8qZCcSY5DEpI1zvIhU5LGbjd0838vE3zY72asVLpxqbyLXexOBByMJnlrS1ndv7uiFC/SwhIIRpLrKA2rC87H8hiuqTu27+ViiFyK9ZT4+qg9TCZl0eRlzgYtZSIRpzM5YNNXair8zhqaDbnAzKcGLvputO9w0JI8IO60FlkK3ZShDwIXE3ztwDOWMiY8xLxMs0YDYVOxc8hOdLPj8J2oe+7QkMw3fQPrEmbGO7HfzjBuGuGHoYoD1/LvshIaFnW4gA8UBZwDH8/OnSOAZXYh7jtbGqE7k94rqWw1qP6U8WvepzgPcUp950FjpZQVYXb/zww5yTwtT1JKyqguBVQ2u85tqyIwrenP81hdSmC3/aPKixEfze5Nzlc5+dJR+JJL8ceLu/yni7SLNXzHSeKCL94+X84+wTquSpPpOaVNfeN27/zv1yaMLkCp8lbLoeG88hly/W7TUCQ8/4SnFD8L5UEXNv+lZJJSnvEBPo0gTTaWgW4lc8ALxaAOtXWcUHXKjkVuoPYnQhDqFDaiRQx0pU2xsx3vzamdOTuzALtoa/m1L9yEZfhU2hSpXNNkHKBRVBKaCRSJ2fsCzz9pXi1dgLRdobOykMkAAgllWKmw4B7bLjHEw82esNJY2Kl0wBeUqUenCfSVQr6oiC5o/itCkcslk9jzBC2+opReM8Zm9wBatv+0G1S/Y0VyQS5GSHeG85VLiOdrgAeFUpDmWqZAJBLZlz3f4+Wy0RhGIKQtyRaKpzWTPL7J7OBeIYMnmzGe/2W62QiphYByrPiisF4i7/vDN3yqt2uL9/LJ/6w8hfRLD6mMvxzszZKN01ZArPm+CR4pPKGemWKXCjPt7vFjBauwBh8GtsWq/uZ0XWvgXUHYXLFStfhFY2Psb/XA0o6zsK/j1VxVY/7kV7tLmybm3C4X0xTleXwVj/6Vn5u4EDL+DQfw5DD7CP/hD5844YBKNQ5Hv74VgjqNbwZ9N2d//gmI+PPwX8q/Dww==
sidebar_class_name: "post 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 'Create Personal Access Token' (create-personal-access-token)"
---

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"}>Create Personal Access Token</h1>

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



This creates a personal access token.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Name and scope of personal access token.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created.","example":"NodeJS Integration"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it.","example":["demo:personal-access-token-scope:first","demo:personal-access-token-scope:second"]}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed.

</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={"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={"secret"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The secret of the personal access token (to be used as the password for Basic Auth).","example":"1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9"}}></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={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={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></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"86f1dc6fe8f54414950454cbb11278fa\",\n  \"secret\": \"1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9\",\n  \"scope\": [\n    \"demo:personal-access-token-scope:first\",\n    \"demo:personal-access-token-scope:second\"\n  ],\n  \"name\": \"NodeJS Integration\",\n  \"owner\": {\n    \"type\": \"IDENTITY\",\n    \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n    \"name\": \"Support\"\n  },\n  \"created\": \"2017-07-11T18:45:37.098Z\"\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>