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
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/create-oauth-client.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

83 lines
39 KiB
Plaintext
Raw Blame History

---
id: create-oauth-client
sidebar_label: Create OAuth Client
hide_title: true
hide_table_of_contents: true
api: eJztXG1z2zYS/isY3ocmGVGWZMmy9eVG8UurnmP7/HKZqeNJIRKS0FIAjyDjqB7999tdgBIp0XbiOJc0o+mklkhwsbvYl2fBhe48HYuEp1KrQej1vCARPBWnPEsn+5EUKvVqnhFBlsh05vWu77wrI5J9rVLxMe3DILjmmbin8QE/oCd6U674WHg385ual/KxwTGnOJhZksaDG6EwQSJjnBimvZxIw+zchnHF7HBLrw4sJOK/mTDpax0CF3f0VSYCGE6TTNS8ABkCXuEWj+NIBiTQ1h8Gid95JpiIKcdP6SwWMJ0e/iECFC1OUPxUCoN3h5mRShhzwqeiMNqkiVRjGK2yKOLDSOTTrsogmIInmR6xFD7n1OhL/2zgpGdmorMoZEMRaTVmqQbC4iOfxkjX6wdT4V/oiCfevOZN9FTEoMurJHoaPzkBdnV+zLgxOpCg4pDdSlAv8qVvlUhyjpdMlniapGnc29qKdMCjiTZpr9nabneQP/UkRfXZJAMb8WG5QxxltTbSyUNMHIipLt6br1D9fCYK3x9RQF/RHWuOLDOgwJxbtHudyL/I4N4HOhQ1lohRIszkfar/FKoG5hy6R9+DhYfwV/LIsFGkbw2KwYMArOQSB/+HRzIET7sQYNGhKUglwcDHIgG2YOYpT+2l7ZZXaYXZdGhX1VhC6FJ2GkZMsbFQ6PULQcD7ChYK3z4gJ3izqIhupzFHXyTxvjLDuRa/iOHdnXbDshxCuAjSq0QWeeRJwmcVliJTMTXrJrVqcmBDkTRpbjwQeRL9ATjMZwOnG5g6O4OrMgRXU/AvYVOdCLrDbicgGDilHCuJkQAN8Oryl9PzwW/9y8Hpyfv904NDNk44SIicgCpAL0rcsmI0rRcFvr7PWWvrN3a6u3sNiNI1j6a4hBk+SzllXRBLLfYzcYu04NFVj1x61P7x4PDk8v3++eEB/B30jy/wNpgBilB5c10zcPH88Oj88OKX95en/zo8waySypTo/5xL9NCiWS226o2Cjs2abQXgO0NhvR7DZlndlWxVCrDC69LxSUmr6kSvyD0Wl/6FVpG0BqRHI/z40tpdidmSjk+Pjo4HJ4dV6+AUfXriBuRDCxrsL5mb5xSqmCTu1sInexFnQ8jDyC849Ei6sPeybAWnJ0cDp6IH2FwZdnb1+niwX+TVzpnzipEnUbyYMYdaR4KrtdgDgV2qEOEC6RU9EuRYzUMlE8Dw49CIYflUZBhS0XMQBMIsKLvlCAK+mKNE6Enh83EGq+9oEmPAYXFadFiYFRQKSAON/SKLY52kz8mBsSQNs7NQQsS1thCsSglBxOXUfE1W8DrAVLA3l5jxoYv+m2Nm57aRd+HR9yRyytBVAphAx+LpaQSlG/EswpQI0JmomR6PovVYdUH31t2rzgYjpjSjZ9EITCwCOZIirNFIh1RuZRSh4VpgXRDWMeCef1dm451XZ4THp7AWa+iVaE74B9AYfMCbiRxP0gWTFlDeTvRiVrmaokKAcj0eS1cv+DR1byQTk5Jyqu5aXABhc14roP9ri0DLansQUZWSXSkEL72zGFlsOdRflEPn1vW9+dxyYmKtjM2brUZjPUS68WCbMBOAvxB18Uzligyrjas4/+AgX5hiSVWKwq1gr7nb2N3uhC3Rae7sNpqdcLs1AnAQ8GZnt4lmCepPRPr4dBc0rmpK9oJsCmwUah/4APlsBoE0zRIFNqJt7JSUJJzlQNiNono5Y3SC7VYY7g1bTR4OO82g2+3utcP2jug2Q9FsdnkzbIThcHuHd0ejvXZzxFsgT5sPu6FoBaNtlOWxKu9bV3XfTRX3Taq2TZW2qdKqq7TnrMo+P/nfW1k9WkBtCqZNwbQpmFYKplSzwcHJpkb6UWskB/6rMvwi04Qwwk/lGoC3foJ3KSvjiBoLAeOg1SAfU6hBpM1BNcvnapHC87cJYRnqNppdv9H1m83L5m6v3eltd+uNvd3f0AumOqQK6huyHHGIs1kcVvG96zd2/FbnstXotVq91m692WgT399BNfr1yjsZeoviYwW5l3F07QmV4EMQaQWNPFQ2pvbPIoouQ1h1WFn37qW7FMwwX9mHq1Fbf7pytF1VgTr7OkwSCAw+O89LLmmX0YVmNtThDEOlVITRnrFMDUXKZbQP0eJxvH8E6+uDqiVyKIhlCjMx7aHjLjltn1uSuSXSuJIRoibqTfaahywvwPedMJibEx78CbQGn1A/XykJz7P8ESaXRUXFtKIr+HCnsddqj3baHGrPdrPbGe6N+PZ2Y6+zt0dxBiwHjLYKKZan/hnBNCACApzyL4KwHHRPDNDkFaD4njUgGp9Y7dqxCzEdvwzf+EKZxF7vn7F2F2KVGmd0nY9XlKD8q4u1AASSW8KniRzLytIvhy8Hh0f9q+NLgoD/vjq8gE9Ia+2l8WrKm+hb4tgJgBHViAjUIcI6e+Wovipsa7mB0mXDmQFl5ntj8ISbveKJImk2SvS05EqBfT3OXsi6qNcACME1SB/BhA25WW52vELEGKf+sdPkKzaB0lokL+usH0IsAiEBKIE3AlF4foaIiochuq4lMMrAlQWlZ52lTGlAFKK8FktVrqaDPKYcFxcFnQM4/4S6PEgzRHEoZtELF9Yi8w0dWh/g2WquzN1lQWmk0plKeYC4KIpmoMaE6rUhyCYBsbhwRNudEHhUPm4RsTAE5mJRuHtjmTlINd0LeGY+we/OIDorn0Rb3PggnPNhae6iEa1GvkwuIrlsTw+7UYvlyh3f7oFtfHfjuxvf/UTfXb2Z4x53l6BPcx36XKm8YgEh1qBPQtajdLmscQtZw0LcQaRf3166/S0sJT/GCE6fER/ZVL7GfH+xHvb6MO8RyFP/ci2QQdKjlWAEkUiEPeJ7yTEpyqpqe322I50MJRioqoCIEDUTNtMZ46CyJFPUrcANFjjCqJ9S9zoo37m0eyxChX6spa0ONkhygyQ32WiTjX6MbLRBkhvf3fju39N3H0SSC67IWxxOMtl0ypOZtTR3H6XlDAawvAOELVyOlmoVrSAxtsBYXhk5eMNWc9gcdQPRDnk73NneG7WCnRbvdJvd5rDd6nrFXH+99OOFk5V9qrDedh1JxQDiPgCOyxQYl0m1Dsvbf6DeRIwwrFGbaY6bqXtnfrPAjq29irdaWrM3XM1yhGRKGFItdYQxDcZOcWzhlRCocgxxUTEIVRL4QlOSUwFU8F0yi+RUkvOiFEA3mfn9UQqiWEfJjWwxi1RBlAGHFAlcNwYYlgQhxQgxH1AgBDuG6PyM6NQt0RcheXaOEh+jxOzwo+0YYgvk3qna3x3kr9Qu7ALfs9Frqx2uwACgILAxa4E7N/h8g883OX6T43+MHL/B5xvf3fju39N3PwOfOzR0Pz6HAZ+Mz2FsvcEWWOqIOiL+3zCdXMVxYBv0dRBkCW035xiccAWYEjIUa2qpiDmew/W2iodwDfVNICC0vGTYa0wtjKa3tXUHSwRLM6/zWNZtq1k6U/q2Hujp1hD0UhFysDfAuhcOoPYPO0GdlJpItFsb5Ii4VfGitQRUTdvBD1LOG61nOoOwRmRq2DDnbIguA4sxFBA/GRpdJ5tZkw/kukqi+ZfLYgndI0uV+h6cDcYz4HRFRBThZnnM+gLRtp197bD1MoPgWq+36bqm0teCJ9j7RS8tXvz69vJloTUXm2jGTEhqD+PsDEyEYli/2HpMaSXR2dh2fvVLr0j2886vOnunLoRg1wOnhBMI7ucQjUml/VKb282LfHVC8UFEmPfqS02i4clQbYGGtsrtcS8px1ExIJVtxIKr9XfKZwfUoCMxV+MYJyLVduw6zuUqtlQ/lYl/5NR8S80naublChdWtdeuBX21j/zJk7tWqQI9n9qRfKS6yoPtcSQ+yi+2Fv16T+ajRM9HemU+3qm3EwkJtPwYs/EqPyExYMFEayP+yRiaDrrB9TgDL3oyW7c4qW+jX6tRYMm3U/rSBzhI/B2DYyhrTHyI6ZjQiAagpkLrkr/TyoLP/06dfL+XZKbL15A1cWSoA/NknnFCHyf0bQwwjn+blNCwwLft4QNwemsA+8v1p0jgGC3EPUurMqoT+S16Jm8tIyrLnr9lgCsdD8PRpb7Anrd81YdnwBwtzEwlZeX7AKsaXOc30pAQV/Rm+V3sQ2GS/N7kRYn7y+2SUxXNnjtK3xNJvp+4+40i3ibS/IiRxuFb3HY8X/7gy2Feiaz+QEvxWN3Kqbr7fwbBHnZbO5hWUbV+rcNkD58l63YajxzeouNSq6elnvDDD+VjS19wMqd8MGf9GM3KcZTlcRM6LFA48WFr3sqjGG7o2rkId901wX9h8znyNtJk8a4GLcbX165UWN85xlcbE2GoJ57SBIkINfLy6ESRUBzxFAMqJZRgIgXtOcWCp6iHGhqYnlISiBONihXGEhpT/3cC3sIjPpQR0KO3IvnMnGK1rWnQBPG7yajwxbmCCVdjUWdvBRMqgIiAWwDY1wP3/tBuL+ACgsIZxhR2kMcZwPvTaaZgNvSBbMo4RLNHglEoTZDZnAnKVSLXhaaqY/FUnkAwyqEIdSqGk6k5HeHrDBmIQsx5ZC4IOca9ywDV4youfD0X5FxE5LU4rlwxPkYbjWYiohg3ISDhC2y6X87wZnC5RhGIKQNyBaKuk/GWe8hs4VgggpW5NZ/terPe8KlShetY00+5KhC3Xf+l33xZNcG75RucR39Kyzkl1pRbMW6A4qyZrXHtTsK1V95JuMHgCv4DN+7ucHMMS+s5XoYYjTsv1zfLqhm/4Rln2iSjrYc/BW7OuLcyvjs04XZh1l83YTFvn7Abbw+OvSlshpyd4hakN3Q/ETa1+zoJx+NJ+P+e9w7+gy86tiYAg+j6nZfvksIYSzfHslVQzn1AMefz/wH6lc6/
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 OAuth Client' (create-oauth-client)"
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Create OAuth Client</h1>
<MethodEndpoint method={"post"} path={"/oauth-clients"}></MethodEndpoint>
This creates an OAuth client.
## 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><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"businessName"} required={false} 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={false} 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","nullable":true,"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={false} 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={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"items":{"type":"string"},"description":"A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client.","example":["http://localhost:12345","http://localhost:67890"]}}></SchemaItem><SchemaItem collapsible={false} name={"grantTypes"} required={true} schemaName={"GrantType[]"} qualifierMessage={"**Possible values:** [`CLIENT_CREDENTIALS`, `AUTHORIZATION_CODE`, `REFRESH_TOKEN`]"} schema={{"type":"array","nullable":true,"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={false} 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={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"An indicator of whether the API Client can be used for requests internal within the product.","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={false} 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={false} 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={"scope"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it.","example":["demo:api-client-scope:first","demo:api-client-scope:second"]}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
Request succeeded.
</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":"ID of the OAuth client","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"secret"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret of the OAuth client (This field is only returned on the intial create call.)","example":"5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3"}}></SchemaItem><SchemaItem collapsible={false} name={"businessName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","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","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","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","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={"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></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"secret\": \"5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3\",\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 \"scope\": [\n \"demo:api-client-scope:first\",\n \"demo:api-client-scope:second\"\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"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"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink