LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/v3/get-auth-user.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

93 lines
38 KiB
Plaintext
Raw Blame History

---
id: get-auth-user
sidebar_label: Auth User Details
hide_title: true
hide_table_of_contents: true
api: eJztXFtz2zYW/isY7UOTjCVbN1vWy65iK6m7ju2V7WZmnUwKkZCEhgJVgIyj9fi/73cAkCIl+drsts2oD6kEAud+Dr4DEb6pxDOheSJjdRRWupWxSHppMrk0Qle2Kgkfm0r3qkJDzI593KqEwgRazmgJFgxEkmrFkolgZiYCOZIiZCmm/mAYxzKhEhlY+szMTSKmLBQJl5Gpgf6Maz4VidDE5aYiieCMJxM8UniAbzKsLHM8ColmMmdHh3imxW+p1AKyJzoVWxUTTMSUV7o3lWQ+Iwom0VKNK7dbFfGVT2cRjYlRszPabzVbe2K/1d5tDNvDYafVaPH2bnN/L+xUbqGnEUGqwceKRsofxCoRX619yChm1iUFq6RsVwseVj7SMi3MLFZGGJKhsbND/ysrcPEsWwXEXSVEjs9mkZ+4/ashmjeresfDX0WQkJE1uTiRTiLQ4I5K2T7LVr6w8xi5gbgvbJcIk1Q9FRgVDnqQVsFjZVqNYL/e2em02h0u9nhrtFNvd4b14XDU4aOd3UaHGKRP4QBDpkr+lgom3QjZWJeZXssoqpmphBdvrXVGksYfZHHI4pGNc3IV8+sYNyYOJE/gyWuQXEwgvz5B2732rjMniT3y3j1Jp0Mk3YOy9TKG0F+AWzwXgim7uCxCfb/abncgQsMmxBTB9VTqWLJqT8mnzqT/8OO1IJ5a805i9QjjFlnYJWulb+f/EenrWH8+ezp5WvZoHkgc5BeP+k+3VLb0ySYbSW0SV/6ews8uW5Ov78GLyEb8OVRp1Rqi51n6hNLMIj4/eTJhosmkYp4A0mcU6ylPVoVnOTMOo5mnsbFL7st/UvAMSYywCA8mXI3FIZL5YSY0iwqCNdDME2CBpbCU9juNenWnWd3pXDQa3eZet9ms7e/U/51xP47HUl3IKeoqlqzZLrJHWf2xLCNaxV5EsRozkpR94VEqXhJrL7jEfjG227izrBvabRWFq+9ix2vs1TvtTrMBebDjaRSgJ4vk1/2vpOIzPpSRzPawJXdrzeel2ux9X1xWkIDTfHyV2GDXRpNAXaAN/qA/uPjUO3x3dILBg+PTy8NPb09/XjNyed4fYODH/vHZYf/8n/h4Onibzxv0z04LhAanx/3yl/PL19n3817v/NO73knvbf9d/2SxaHl80O8dWp7np5eDgwU9/7VAMeSmm8oqD6dSSajIk1gvhlFyACW4CsSnKVfcOSZbkoayNDnkCa+aAGgCY4R+ZIAxMxnGXIdVi4DWjF8DQwnCjYuMWFjn9hbuxTZth3PgeWuHW+uw00EkKc76WseaVZlDnyge0rmf0CAikw3jcM6kQYFBAMrwG+Inh8gO4vARNeKNVKI61lyShMKKHGAhYYcvMsQKNo218CAvi2A7r1xBYIlanb3mIfR1+h14Zch6mgefQevoETDp0mGjbAlAElXdu9iKPcGHuzv7jdZot8V5o9Oq77WH+yPebO7st/f3iTvqgEHYFPMoy68y67dCCS0DVIgAHvkPDIKAge2tAJb5mpS8wweWxiPsT0Dbzc3V9PIyAvJbjLPXB2estYeSqsapHefjJSOo6uU59SNpFPEhDVGfQaXbEj7VcizVfVXksP+md3l8YQvBvy775/hEtFYaqZ5CtIYUlhAVsTCJr121dwpcc8OMiGAOEdbYK0/1FRTiyhQnSvctbyBGPI0SrPDc16wokmYjHU9LqRS4roe9kDVR22JDGkPdDiZsyA0WxK75e9ULAjFLqsfekq/YBAVB6Jc11gtRSKTFQnY7MFg/ByHGw5BS1xEYpUhlYUF0nAJzxOiFlnbShSnL3liUkOOiUyg5IPkjAEOQpBDOqlnMwjxavIjeP5DZWa4s3UXBaNakc5XwgDq6KJrDjNghA1Qm6CYTw3w5IncZFB6VzcsrVrEy2nL3zglzmMT2WcBT84i8O4tQfqpWtfzBF+GTD2EQ+2pkvZG5yVckPCS17WI/K3dXlvjAnSIKN7m7yd1N7j4yd5cfDvyJkX9qoU99FfpcKgK3sbab5wr00TZ6VMyySe4cyTlyi8EgHiL99P4Cif1ZKJovvs7o8Owb4iO3la+C9NwfbnxI8CN3VskXJKC1o9NghEokwq6VeyGxNZQzVXOV25tYDyUCVK2BiNQcsHmcMg6T6VQpkoSbLRbGwqgfEjbhqI8cGWGMq4DEVYXVWYxGZYMkN0hysxttdqPvZzfaIMlN7m5y96+Zu/ciyVwqmy0eJ5l0OuV67iLNPydtOcMElv12yfKUs65aRitEjOUYq1JGDpVhoz6sj/YC0Qp5K9xt7o8awW6Dt/fqe/Vhq7FXKe71V4s8zpOsnFMFfzs/ut9Phf4CHJcqBJdJ4jgsH//BvFqMqKxR6clxM2wOk35cYMfWKnY8iRPoBsLAjvqO48XLwTHRB2tLnuwWpzoQBLOd6TCdJxZSUgzD0tIkG+i4gY6b7Wez/Xw3288GOm5yd5O7f83cfRJ0bD0EHVtPgI4tRhBrRBDrj4SOIXAHQbMRnAIdsjcYtJhBFXzyp48+7ROuxyLJgV4JRTb217whEcfsHVfzDCyZ0kmkWpiLyhvmTmmuzuZiAmdjlEhFrxFJoFuKKjkVhEnpxZNITqXNY1IIdPW82hsl0MrlTBZvORepgiiFhLYouLczYsSYRDiJEcE/ULDnoGMU6m94xum99bvOg9mAND4mjVn/ayAE5Xx+/tte95bAEYTXVC7Ona/veF3AnZlzhTZCfJ258pVD0A1U30D1zXa/2e6/j+1+A9U3ubvJ3b9m7j4Bqns0dDdUx4RHQ3XMre2wHEu9oeD6vyN2mypeAhveLA4sVg8XGNziCoSSv8BENYQuEXUr2/kFHbN9I8PbCt3qIUTohEl1hEmTJJmZ7vb2jbvUclvjM1nz10fmKr6m9/K3vzTXVBx6wdRlF2pWmAa2Y+idHfkWo2YtqyUF79LdG5+qFKawt32z4F769m15OHCO7oM5Mlv0grUPJDtM7/Kii/Dv1tds4KzoCN0udXT7kD4/N+/TwxG5Q4915ruXF+YzSLmkHolfuIR1TnDbcV+5irXYQsjdjRVmpzStwV4LrtELuHdfXvz0/uIlGxPItEmeGsK3QlJXgDQ5yy5v9LL3QGiR3Vd0nI7dNZ9e6U0bSho2iqAw+6DOhWBX2aWkE1T3AcqxNWmvdM/r44vMM6H4IiLa+GoLS1LgyVBtw0Lb5fthL+0mZ7sBqdyL9BitfVBVdiip9kjarGmOV9E2d+wqv5TCC3o9V4i/ZdSqjlrVUjMvl6Rwpr0K3JvbATKXSPDIWGs9m7mjVy3Qo9YJI0R1WQayhJej/H5UkHnt2XKU6FWJXlmOD+r9RGIHXbrg5woWM9gAo5AdsWASx0b8nTEKHUqDq3GKLHq2WNfEtGozotrYKYhUdSyrkuqile8YiaFcMPEh7ccWjsTuZMSm5C/Ws8j5X9Ath+yXks52+ArbJs0M48A8W2ZiWCWG/n6h8fL7W5AQFrlNOtg64ALgYOF/Wwm8oIWa52itreqW/LZdQ1sDXW2wVMys6750FwXOf2KFCxB+Dkowwen8jTF8Z54WbU0lY2UHAcsWXJXXXqVZspuTN/85k3bJP5u+pHFvcV5yqqL5t67Sd1SSP0/d/YMq3qbSfI+VxgNcCjfL1ncCxSB3aG319I6OlycC/+KpzVSLpNGnLK4qF8nMIp5QTNucDiZS2L5/JnhCyG+L4iqe2jwE3KXkR3dnCY015iBpDdCou3E3r7H3aKxUABNTU0Xv24Lqr7Hvrs5h5TNyEjvMHAcANZ2miq6JQ4h0yjjC4wHvhtIEqStC6LGUyDSLLYzLV2UZSWFDprCXAYWemtMRHRCj9yw48QFe8KHxp8MwJHnE/6WChSIDEdkoo3ll+P0QbUROdSKimb0aCrHQpBU4vDu6WKEIYsr/JBHr8bZfZLZpLohQq+OCoVlDM2evNMcmQQ9aoJv/dQc4w4b/ciTdLA7Df9/fe/A7AEH37RkdNNkL/q6VcC3bVWXRsmFBV4Z0dXACmenZzQ2dQ1ADc0vD6L+pyb36uOhPbF8Hc9JntIMjJKu4R5sXA//nI16y8p+VWCtpdnCm5oueuYKPnwW12hAVDSmEtWchVhD3wJ2WFJas/J5AnU7ewb7tk5v5HZum/wClURb+CwgchT0=
sidebar_class_name: "get api-method"
info_path: docs/api/v3/identitynow-v-3-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 'Auth User Details' (get-auth-user)"
---
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"}>Auth User Details</h1>
<MethodEndpoint method={"get"} path={"/auth-users/{id}"}></MethodEndpoint>
Return the specified user's authentication system details.
## 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","description":"Identity ID","required":true,"schema":{"type":"string"},"example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
The specified user's authentication system details.
</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={"tenant"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Tenant name.","example":"test-tenant"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity ID.","example":"2c91808458ae7a4f0158b1bbf8af0628"}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity's unique identitifier.","example":"will.smith"}}></SchemaItem><SchemaItem collapsible={false} name={"profile"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the auth profile associated with the auth user.","example":"2c91808458ae7a4f0158b1bbf8af0756"}}></SchemaItem><SchemaItem collapsible={false} name={"identificationNumber"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's employee number.","example":"19-5588452"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's email.","example":"william.smith@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's phone number.","example":"5555555555"}}></SchemaItem><SchemaItem collapsible={false} name={"workPhone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's work phone number.","example":"5555555555"}}></SchemaItem><SchemaItem collapsible={false} name={"personalEmail"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's personal email.","example":"william.smith@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"firstname"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's first name.","example":"Will"}}></SchemaItem><SchemaItem collapsible={false} name={"lastname"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's last name.","example":"Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's name in displayed format.","example":"Will Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"alias"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's alias.","example":"will.smith"}}></SchemaItem><SchemaItem collapsible={false} name={"lastPasswordChangeDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Date of last password change.","example":"2021-03-08T22:37:33.901Z"}}></SchemaItem><SchemaItem collapsible={false} name={"lastLoginTimestamp"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"Timestamp of the last login (long type value).","type":"integer","format":"int64","example":1656327185832}}></SchemaItem><SchemaItem collapsible={false} name={"currentLoginTimestamp"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"Timestamp of the current login (long type value).","type":"integer","format":"int64","example":1656327185832}}></SchemaItem><SchemaItem collapsible={false} name={"capabilities"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`CERT_ADMIN`, `CLOUD_GOV_ADMIN`, `CLOUD_GOV_USER`, `HELPDESK`, `ORG_ADMIN`, `REPORT_ADMIN`, `ROLE_ADMIN`, `ROLE_SUBADMIN`, `SAAS_MANAGEMENT_ADMIN`, `SAAS_MANAGEMENT_READER`, `SOURCE_ADMIN`, `SOURCE_SUBADMIN`, `das:ui-administrator`, `das:ui-compliance_manager`, `das:ui-auditor`, `das:ui-data-scope`, `sp:aic-dashboard-read`, `sp:aic-dashboard-write`]"} schema={{"description":"Array of the auth user's capabilities.","type":"array","items":{"type":"string","enum":["CERT_ADMIN","CLOUD_GOV_ADMIN","CLOUD_GOV_USER","HELPDESK","ORG_ADMIN","REPORT_ADMIN","ROLE_ADMIN","ROLE_SUBADMIN","SAAS_MANAGEMENT_ADMIN","SAAS_MANAGEMENT_READER","SOURCE_ADMIN","SOURCE_SUBADMIN","das:ui-administrator","das:ui-compliance_manager","das:ui-auditor","das:ui-data-scope","sp:aic-dashboard-read","sp:aic-dashboard-write"],"example":"ORG_ADMIN"}}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"tenant\": \"test-tenant\",\n \"id\": \"2c91808458ae7a4f0158b1bbf8af0628\",\n \"uid\": \"will.smith\",\n \"profile\": \"2c91808458ae7a4f0158b1bbf8af0756\",\n \"identificationNumber\": \"19-5588452\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"workPhone\": \"5555555555\",\n \"personalEmail\": \"william.smith@example.com\",\n \"firstname\": \"Will\",\n \"lastname\": \"Smith\",\n \"displayName\": \"Will Smith\",\n \"alias\": \"will.smith\",\n \"lastPasswordChangeDate\": \"2021-03-08T22:37:33.901Z\",\n \"lastLoginTimestamp\": 1656327185832,\n \"currentLoginTimestamp\": 1656327185832,\n \"capabilities\": [\n \"ORG_ADMIN\"\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={"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"}><p> An example of a 404 response object</p><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={"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>
Reference in New Issue View Git Blame Copy Permalink