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

81 lines
35 KiB
Plaintext
Raw Blame History

---
id: list-oauth-clients
sidebar_label: List OAuth Clients
hide_title: true
hide_table_of_contents: true
api: eJztXFtz27YS/isY9aGJR5Ql2fJFL2cUX1K1ju1jyc1MHU8KkZCElgRYgrSjevzfz+4CpEhdHMdNTy+jPsS2CC6+XezlWwjoQ03HIuGp1Kof1Lq1UJr0gmfp9CiUQqWmVq8Z4WeJTGe17s1D7dqI5EirVHxKezAKPquZuKvxDc+nV7oRV3wiarePt/VayicGx1zgYJbLhAeBMH4iY5wXZh1OpWETkRrGGSJgeszsK1amaQCOmCc8EqlIDCGR+OJvmUhm8EzBE/hzLEN6Xq8l4rdMJgJUGvPQCNDCn4qI17oPtXQW41iTJlJNao+LWE5JBkuEyUIAlBkYxdKpYCblKuBJwMxMpfwTs6+NRMCkYjc/7rDeZZ8N8kFHOgyFjzLZZQH89tU0TWPT3d4OxJ0I0fQNw2UYa6nShq+jbRmobR7L7Xwyzy/keHMDfGMVBWSew/n6g/qgTvNPGZjTZHGskxTgjXVCCoxBlL7Hx2MpwgCMrQJml18nposStrZCblJY5GBrq8u2QlEHUSoLwy2wqfjEozhE2+WDWChYu9ne8Zptr9kZtprdzmG3vd9ot3Z/quH6A7pYKyMMGr7dbOKPqrnP1i23j16mUnyDx3EofXLS7V8MvvawvJ48STi6gkxFZEqf69EvYD/0nwR1TaUFI4NlX1h0hf4xIkPTldFVLNH2D1sHzYOdTtAWndbeQbPVCXba44PDps9bnYMW+tcIfUgYc05Oujwp2pePUFyaZGI5NgRD986h5NLoD3Q5G1XMTHUWBmwEboUOqyswe34kvIEOeYKApjoSMcTodRK+DE8ugF1fnTFujPYlR0+7l2AlxKXvFcSQQzwHWcGEoQCREGqfh1Nt0m6rvbPbQXxqjaGqQHpsmkGugQjgAcK1Vsqdfc2kxyLS5WeL4f+l1uix0t+fUbin6In1IkgspdDE/KkT+Tv5+EdfBxB4iRhD+Ew/pvpXoeoUrPbVjz4kNvgpIbOxMYS0QTW474NXDHHwjzyUAWTsgYAgCsrBAGlGTEQCsGDmiKf2o532knHJ67JoZFfRWEGAgdlpGIGClK0wexSKQNopeST8dYdI8GHZEPud5iOmBlLvTwacW/EPAT7Y221ayAHUFD+9TqRZkXkWPWUxE62rOL2i5pErxJCo7gBhPhsEWd9Ydynia9lfyBHKoG/WBdgtAJgkXKVDgLVKjwJ3FSblwDZ7i68yfBeGLgbL3NmPzvon58OPR1cnx/Cz3zsb4GNYIUS28mHvevjdxVX/p96wf3H+8eji+AQ+vDo5vToZfPdxePHDyTkSh1SmJP9trsFT9rRpu91oMlKYIVyztOw+uPVIzC1cteJKWCsVWMA6j0ky0qI50WHzYIIB7JVWISR2ptGBx/jra+sSFbAVG1+cnp71z09WrYMz9MW5G5APLVmwNwf3mEtYBZLQLWU29irORlCVES/E2li6jPS66gUX56d9Z6InYC4Mu7x+c9Y/KmO1c+ZYMSkkipeL10jrUHC1XCQUsLMAyQPZld1PBeixWCIqLoCZAemjMED/8qkgf7D+8XlZOSKWj6gEBn3w9cDAgjuZhAVAlafF3AKzgg2hzqN/D3Ki9/UQOO4IJJJmoXSDy2s52Coj+CGXkfkzoRAFB3YLCdqmPXxp0Ht3xuzcKEB9eZosFAAaUQVeeGlReQIY4aUyEiurDz6lKo0j6iwADoRegzgiGUJKoppUtzgXtLznhuUIKvSy2dr3mvteqzVsHXR3O92d/Ubz8OAnjIJIBxKI/F8JGfsAlsXBKtwHXnPPa3eG7Wa33e62Dxqt5i7hzpuH55CtP0ePavqfK4K+A6/lJGGR7jQY9ak4B7RnUQzzQDVROsXWNTcDA8eE3i6ZlafIDJDlOlB3qEoqnME/PkgH2DMn0/Ums1IiGmchhb9NrOMZ9m33U+lPS4KB4CRAezRDzg+xw6FRhL5yZlUhxmjlJUB7gVM0nu1cxtexeDnHwUUac2hM8aO4S9JMl4fhcrUe0LPlAtOoluEANOhCZ+x2GTwS2R3LxKQ026qndtmhEj+WNwRusPdb6MqqPZHrQKpIn2TYT9PZBeZYoV8VkuAqZKnCzcvL6pS/nHnnqayUIvIFLRMokRI9sta+co167RH/q9d2V/XqzptPkgT80mNXIs0Shfsfdu1c0WQjHcywiElFbPolzfyapj0QKZfhEeTxz7eHp7C6HhhaIkJBkKkAILuG1YFoijQEjxWZux+Nq0YJWKLRYm94APpa/Y6cMsiaEu7/CrL6z9hNuFYS3mf5K0zO278V04p9wUd7zcP27nhvl/P2wW5rvzM6HPOdneZh5/CQKgD4DbjsKg5fnfotZjTgatQKyN+pueBgewJAkz9/44RkPMP+mJft2EJNh5fh7iE0tOzN0SXb3YfkqyYZfc4nC0ZQ3vVgKetgDSHBF4mcyJVNe04sj09Oe9dnQyLn/70+GcBvKGtpA3KRjEz1PSF2CmCJMAL34SCHsi0ndQsU4sqUB0rHU2YGjMlcDoQ33Owr3iiLZuNER5VQ8u1WK3slG6IBBQQ/g4IIRWDEjS02OHwLuXycemfOkltsKnggktcN1gsgE4GSQGEhGkEovD/DksCDwG5d0tZgBqEsiDhpKFJQ06QvqmsxN+ViDcgzyll5UTA4APkztnH8NEN+jWqWo7DwFgfRrQ9uOtI8VXTDktHIpLhH6yNjDaEc+jqhThoLsISq6dIRbZNC4lH5uCJjYQrM1aJ0986COU41PfN5Zp4Rd5eQm5VHqhUP7oQLPmQVLhvRauTL5DKS4y/0shtVLFce+HYjdxO7m9jdxO4zY3fxYU583FOiPq1l6nOt8l4SlFiiPgl5D/DwSsPpFrKOWySOIn3/fuh2IrHJ/xQjI/2K/MiW8iXwvWI93HdW+VdaeemfrwUCJDtaDcaQiUTQJdxzxJYkkql2lmc71clIgoOqFRQRsmbCZjqjviXJlEIk3NSplVLfpmzK7+bbYtr2akIFnv2GbMMkN0xyU4021ehfU402THITu5vY/WfG7pNMskBF0eJ4ksmiiCcz62nuOWrLGQxg+VkZVoQcLdUiW0FhrOBYtSpzqI3arVFrvO+L3YDvBns7h+O2v9fmnf3Wfmu0296vlWv9zTyOiyCrxlRpve06komBxN0Bj8sUOJdJtQ6q239g3kSMMa1h6il4M9gcTHpbcMf24YrvG7Vm77ia5QzJVDikmtsIcxqMjXBs6cs6MOUE8qJikKok4EJXkpEAKbShH8pIUvCiFiA3mXm9MZ72soGSO1kxi1R+mAFCygTuXA04lgQlxRg5H0ggBjuB7PwV2alboj/E5NkVanyGGrOTT74QGOgFc++s2t/t5192DuwCr9notd0OV+AA0BDYnFXwzg0/3/DzTY3f1Ph/R43f8PNN7G5i958Zu1/Azx0bWs/PYcCz+TmMbTRZwaVO6RjE/5umU6g4BOTeTPt+ltB2c87BiVeAKyGgiaAcwvFKR227fJ/DXgFBPmihZHhovJbfY3iAFYKVeWzwWDbsUZV0pvQ9XWa421mRb/BggI0tyFhBZq9I4LEPO0mD7JpIdF2b52gCa+XiSEl+Z+JJ+fmp+ZnOILORmDqeZnRuRB8DzBh6iG8NjW6Q2yzpCLpdJ+Hj5/RxV0DW6GGFrNFjlfmenAvGM0C5oB7Cv53f2Bkg2bazL93bmRcQXOvl89TutO8bwRM8lEffWbz6/v3wdekMtb0bIySd2+PsElyEUlivfEacqkqis4k9kterfENylB/Ja7APaiAEu+k7I5xDbr+CZEwm7VXOHz7/Fk313OJrKnHUC0hlT5bBp40PymPHdDpHYqnGMU5Fau3YTZzrVT4M9lIQ3+TSPCvNI2l4f6eCwpr2xt0VWDzw/+LJ3fGokjyPziJ5KHURgz18Sjiq32sVBylfjKMiz0N5VRwf1Hs66lZ9jdl0lV916TN/qrUR/2EMXQfD4GaSQRS9GBadr/Ns9ms3S5A8O6UnPWCDhO8MAkNZZ+IjrMZERjTwNBXYkPyZVhZi/mc6ifdzRWf6+AaKJo4MtP8FV8MWMOOEHk7o2RxgHH5bk9CxILbtLREIeusAR/P1p0zggJZynpW1MquT+G16Jz9XRlLm5/zmCc79xuzps/rCWcBubf5NH/zNnCwsTBVj5dsAixZcxhtqqIcLdrN4i20orJF/N31R4958t+RChbOvnaXXZJK/T979izLeJtP8GzONo7fobjSt6wPKTm7Z2vLeHW4uT4Who8gUqcSjoUuZXysoi4lDnqJPU0z7Uymo648FT5H51dGvdERxCHQXgx96OxI0oVO6CQDm0KfJEOQ12Htoq5QPJsaWCs9JgNRftOutBmDlS1wkdpwvHBCoKMoUvIsxlkWMg3t8ZnUDafzMJiHosJTINdNE44q38ohEt0FTNKi5SCJzMcbtYeg8S4v4mblgDY3bGwZD4oq4C9tzRa5ESF6G46r0+3Oy8dj3VIQx3S0AWHiKeT7Du/5wSSIIUwb0guZZJ5Nt95LZxrEgBFsd6ww7DWjl8KNYmxQ60JJcurdcvda+dJW02At/3gV3l+qRo2/HuJ+EM2e2Z7Cd2U2t2pnd4rl1k+KDhwfca8A25RE/thfjsV8DM7n7Se4m/FqQm5vv626+r1yZXwXuFMz/lwNuN6BGF9/z1g+WAC8C2o0eWg/7mt0KKr219GUJSina87cn6MV8DSdwv+BUj4//A/Pa83I=
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 'List OAuth Clients' (list-oauth-clients)"
---
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 OAuth Clients</h1>
<MethodEndpoint method={"get"} path={"/oauth-clients"}></MethodEndpoint>
This gets a list of OAuth clients.
## 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":"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 OAuth clients.
</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":"ID of the OAuth client","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"businessName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The name of the business the API Client should belong to","example":"Acme-Solar"}}></SchemaItem><SchemaItem collapsible={false} name={"homepageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The homepage URL associated with the owner of the API Client","example":"http://localhost:12345"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A human-readable name for the API Client","example":"Demo API Client"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"A description of the API Client","example":"An API client used for the authorization_code, refresh_token, and client_credentials flows"}}></SchemaItem><SchemaItem collapsible={false} name={"accessTokenValiditySeconds"} required={true} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"The number of seconds an access token generated for this API Client is valid for","example":750}}></SchemaItem><SchemaItem collapsible={false} name={"refreshTokenValiditySeconds"} required={true} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"The number of seconds a refresh token generated for this API Client is valid for","example":86400}}></SchemaItem><SchemaItem collapsible={false} name={"redirectUris"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"items":{"type":"string"},"description":"A list of the approved redirect URIs used with the authorization_code flow","example":["http://localhost:12345"]}}></SchemaItem><SchemaItem collapsible={false} name={"grantTypes"} required={true} schemaName={"GrantType[]"} qualifierMessage={"**Possible values:** [`CLIENT_CREDENTIALS`, `AUTHORIZATION_CODE`, `REFRESH_TOKEN`]"} schema={{"type":"array","items":{"description":"OAuth2 Grant Type","type":"string","example":"CLIENT_CREDENTIALS","enum":["CLIENT_CREDENTIALS","AUTHORIZATION_CODE","REFRESH_TOKEN"],"title":"GrantType"},"description":"A list of OAuth 2.0 grant types this API Client can be used with","example":["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"]}}></SchemaItem><SchemaItem collapsible={false} name={"accessType"} required={true} schemaName={"AccessType"} qualifierMessage={"**Possible values:** [`ONLINE`, `OFFLINE`]"} schema={{"description":"The access type (online or offline) of this API Client","example":"OFFLINE","type":"string","enum":["ONLINE","OFFLINE"],"title":"AccessType"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"ClientType"} qualifierMessage={"**Possible values:** [`CONFIDENTIAL`, `PUBLIC`]"} schema={{"description":"The type of the API Client (public or confidential)","example":"CONFIDENTIAL","type":"string","enum":["CONFIDENTIAL","PUBLIC"],"title":"ClientType"}}></SchemaItem><SchemaItem collapsible={false} name={"internal"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"An indicator of whether the API Client can be used for requests internal to IDN","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"An indicator of whether the API Client is enabled for use","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"strongAuthSupported"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"An indicator of whether the API Client supports strong authentication","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"claimsSupported"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow","example":false}}></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 the API Client was created","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was last updated","example":"2018-06-25T20:22:28.104Z"}}></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 API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.","example":"2017-07-11T18:45:37.098Z"}}></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 API Client.","example":["demo:api-client-scope:first","demo:api-client-scope:second"]}}></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\": \"2c9180835d2e5168015d32f890ca1581\",\n \"businessName\": \"Acme-Solar\",\n \"homepageUrl\": \"http://localhost:12345\",\n \"name\": \"Demo API Client\",\n \"description\": \"An API client used for the authorization_code, refresh_token, and client_credentials flows\",\n \"accessTokenValiditySeconds\": 750,\n \"refreshTokenValiditySeconds\": 86400,\n \"redirectUris\": [\n \"http://localhost:12345\"\n ],\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": false,\n \"enabled\": true,\n \"strongAuthSupported\": false,\n \"claimsSupported\": false,\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"lastUsed\": \"2017-07-11T18:45:37.098Z\",\n \"scope\": [\n \"demo:api-client-scope:first\",\n \"demo:api-client-scope:second\"\n ]\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>
Reference in New Issue View Git Blame Copy Permalink