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/create-oauth-client.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

81 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: eJztXOtz2zYS/1cwug9NMpKsly1bX24UP1r1HNvnRzNTx5NCJCShpQCWIO2oHv3vt7sAKVKiZcdxL2lG00ktkeBid7GP34IL3Vd0KCIeS60GfqVX8SLBY3HKk3iyH0ih4kq1YoSXRDKeVXrX95UrI6J9rWLxKe7DILhWMWFP4wM1j57oTbniY1G5md9UKzEfGxxzioOZJWkqcMMXxotkiBPDtJcTaZid2zCumB1u6dWBhUj8mQgTv9U+cHFPX2UkgOE4SkS14iFDwCvc4mEYSI8E2vrdIPH7ivEmYsrxUzwLBUynh78LD0ULIxQ/lsLg3WFipBLGnPCpyI02cSTVGEarJAj4MBDptMsyCKbgSaZHLIbPKTX60j8bOOmZmegk8NlQBFqNWayBsPjEpyHSrfS9qahd6IBHlXm1MtFTEYIur6LgefykBNjV+THjxmhPgop9didBvciXvlMiSjleMFngaRLHYW9rK9AeDybaxL1mq93ZRv7UsxTVZ5MEbKQGy+3jKKu1kY7WMXEgpjp/b75E9fOZyH1/RAF9RXesObLEgAJTbtHudST/IoP76GlfVFkkRpEwk4+x/kOoKpiz7x79CBbuw1/JA8NGgb4zKAb3PLCSSxz8Cw+kD552IcCifbLJEhtLpkO7ZsYOQ4exRBhNycZCoU9nbIJv5ewPvt3iPHgTxHRqk+BBY4EX4PKUx/ZSu5VXRHe7MUdfJPG+iOFUR89hOGNnd6fTaDwuALHsQ7jw4qtImpyp8CjisxJLkbGYmlWTWjY5sKFAmjg1Hog8kb4FGdLZwOkGps7O4Kr0wdUU/IvYVEeC7rC7CYgOTinHSmIkQAO8uvzp9Hzwa/9ycHrycf/04JCNIw46QE5AWaA5Je5YPprW8yq5fshZb4B5onQJhD5LB0WRaeYW+5GYQloLC8ocb+E4+8eDw5PLj/vnhwfwd9A/vsDbYA/IaenNVQXAxfPDo/PDi58+Xp7+5/AEk0csY6L/YyrRurWxymrVGzlVmhUj88CJhsI6N0bHolZL2SoVYInXhX+TksrcI3VdXOFXWgXS2okejfDja2teBWYLOj49OjoenByWrYNT9OmJG5AOzWmwv2BunlIoY5K4W4mS7FWYDCHdIr/g2SPpotvrohWcnhwNnIrWsLk07Ozq7fFgP8+rnTPlFf09UjyfGIdaB4KryootKCaVj6iA9IqOB3Isp5uCCWAccqDDsHQqMgyp6DnwdT/xit43grgu5igRepL/cpzB6juaxBhwmJ8WHRZmBYUCoEBjv0jCUEfxS3JgLEnD7CyU93CtLdIqU4IXcDk1fycreB3QKNiby7/40EX/3TGzc9sAm3n0A/maEnGZAMbToXh+tkDpRjwJMBEBQiZqpseDYDVWXdC9Vfeqs8GIKc3oWTQCEwpPjqTwqzTSAZI7GQRouBY/54R1DLjnPxTZ+FCpM4LdU1iLFZBKNCf8FjQGH/BmJMeTOGPS4sa7ic5mlcuZyAfE1uOhdGVBjabujWRkYlJO2V0LECBszqs5kH9tgWZRbWuBUyHZFULwwjvzkcVWPf2s6jm3rl+Zzy0nJtTK2LzZajRWQ6QbD7YJMwHG81EXL1SVSL/cuPLzDw7ShclXToUo3PL2mruN3fa23xLbzZ3dRnPbb7dGu3sNjze3d5tolqD+SMSPT3dB48qmZK/IpsBGocSBD5DPZhBI4yRSYCPaxk5JScJZDoTdIKgXM8a21275/t6w1eT+cLvpdbvdvY7f2RHdpi+azS5v+g3fH7Z3eHc02us0R7wF8nT4sOuLljdqoyyPFXNfu3j7Zoq1r1KcbYqx9bUNlFpPrGy+t2LsJYuvz0/+zy+gNgXTpmDaFExLBVOs2eDgZFMjfa81kgP/ZRk+C/w+jKjFcgXAWz/Bu5SVcUSV+YBx0GqQjynUINJmqarlc7lI4elLA78IdRvNbq3RrTWbl83dXme71+7WG3u7v6IXTLVPFdRXZDngEGeT0C/je7fW2Km1ti9bjV6r1Wvt1puNDvH9DVSjf195J/1KVnwsIfcijq4+oxJcB5GW0Mi6sjG2f7Ioughh5WFl1bsX7pIzw3Rl11ejtv505WinrAJ19nUYRRAYauw8LbmkXUYXmtlQ+zMMlVIRinvBMtUXMZfBPkSLx/H+EaxvDVQtkUNBLFOYCWmrHDfDaZfckkwtkcYVjBA1UW+yt9xnaQG+74TB3Bxx7w+gNXhC/XylJDzP0keYXBQVJdOKruDDncZeqzPa6XCoPTvN7vZwb8Tb7cbe9t4exRmwHDDaMqRYnPpHhNuACAhwyr8IwnLQPTFAk5eA4gfWgGg8sdq1YzMxHb8MX+xCmcTe7p+xThdilRondJ2Pl5SgalcXKwEIJLeETyM5lqWlXwpfDg6P+lfHlwQB/3t1eAGfkNbKu+HllDfRd8SxEwAjqhEBqEP4dfbGUX2T29ZyA6XLhjMDykz3xuAJN3vJE3nSbBTpacGVPPsWnL2SdVGvAhCCa5A+vAkbcrPY7HiDiDGMa8dOk2/YBEprEb2us74PsQiEBKAE3ghE4fkZIiru++i6lsAoAVcWlJ51EjOlAVGI4losVLmcDtKYcpxfFHQO4PwJdbkXJ4jiUMy8F2bWItMNHVof4NlqrsjdZU5ppNKZirmHuCgIZqDGiOq1IcgmAbG4cETbnRB4VDoui1gYAlOxKNy9s8wcxJrueTwxT/C7M4jOqkaiZTduhXM+LN5dNKLVSJfJRSSX7elhNypbrtTx7R7Yxnc3vrvx3Sf67vLNFPe4uwR9mqvQ50qlFQsIsQJ9IrIepYtljVvIKhbiDiL9/P7S7YBhKfkpRHD6gvjIpvIV5vvZetjrw7QVIE39i7VABkmPVoIRRCLh94jvBcekKKuq9upsRzoaSjBQVQIRIWpGbKYTxkFlUaKoKYEbLHCEUT/E7nVQurdp91iE8muhlrY62CDJDZLcZKNNNvo+stEGSW58d+O7/0zfXYskM67IWxxOMsl0yqOZtTR3H6XlDAawtAOEZS5HS7WMVpAYyzBWpYgcKsNWc9gcdT3R8XnH32nvjVreTotvd5vd5rDT6lbyuf564ceZkxV9Krfedh1JxQDibgHHJQqMy8Ra+8XtP1BvJEYY1qibNMXN1L0zv8mwY2uv5K2W1uwdV7MUIZkChlQLHWFMg7FTHJt7JQSqHENcVAxClQS+0JTkVAAVfNvMAjmV5LwoBdCNZrX+KAZRrKOkRpbNIpUXJMAhRQLXjQGGJUFIMULMBxQIwY4hOr8gOnVL9EVInp2jxMcoMTv8ZDuGWIbct8v2dwfpK7ULu8APbPTaaocrMAAoCGzMynDnBp9v8Pkmx29y/PeR4zf4fOO7G9/9Z/ruZ+Bzh4Yexucw4Mn4HMbWGyzDUkfUEfH/hunkKo4D26CvPS+JaLs5xeCEK8CUkKFQU0tFyPG4bWUrf9bWUN8EAkLLS4K9xtTCaHpbW/ewRLA08zoPZd22msUzpe/qnp5u3bZLAg52Bpj8+RbcaMYWEDtJnRQbSbRdG+hoAqvmrL0E1E1bwmvpp83WM51AaCMyVWyac3ZEl4HNEIqIHwyNrpPdrMgIsl1FwfwxeX5pr5PDEnlAjjL1rZ0LxjPgckk8ZP9mcZr6AtG2nX3lTPUig+Bat1Ymc02lbwWPsPeLXlq8+vn95etc8y420YyZkNQextkZmAjFsH6+OZnSSqSTse386hdekeynnV919kFdCMGuB04JJxDczyEak0r7hTa3m1fpyvjiVgSY9+oLTaLhSV9tgYa2iu1xrynHUTEglW3Egqv1D6rGDqhBR2KuxjFORKrt2HWYypVvun4uE/9KqdUstRpRM6+XuLCqvXYt6Mt95M+e3LVK5ejVqB2phlSXebA9jsRH8cVW1q/3bD4K9GpIr8jHB/V+IiGBFh9jNl6lJyQGzJtobcS/GUPTQTe4HifgRc9m6w4nrdno12rkWKrZKWuyBnCQ+DsGx1DWmPgQ0zGhEQ1ATfnWJX+jlQWf/406+X4ryEyXryFr4khfe+bZPOOENZywZmOAcfzbpISGBb5tDx+A01sD2F+sP0UCx2gu5llapVGdyG/RM2lrGVFZ9PwtAlzheBiOLvQF9iqLV314BszRwsxUUFa6D7CswVV+Aw0JcUlvlt9sHwqT5LcmL0rcX2yXnKpg9tJR+oFI8u3E3a8U8TaR5nuMNA7f4rbj+eJ3XQ7TSmT5d1jyx+qWTtU9dFgnPey2cjCtpGr9uw6TrT9LRue71h7ecgeqiqelHj6eVDyd9AUHcIrnb1ZPyyydOlmcKqEzAbmDHba0LT1x4YauHH9w112v+xf2mCNvI02G7UrNfBi19cDq9jC+v5gIQ43vlAtIQCiEF+cj8mTCgMcYNSlreBMpaGMpFDxGLVTRivSUIj0UVKhWYSyhMTV5R+ASPOBDGQC9OnsPlbvywImxasdWHKD6u3bl+wX48RmGAXaQhgaA6NNpouBZNNtkyjgEoEfihy+Nl9g0B4pSIpVMU6GQPZXGfAxMqIo61a/R1JyO8A2E9EQuTDwyF0QJ414/gCJxRTL3TAU5FwE5Go4rFniP0UYDmIggxH0DyNEC++QXM7wbXK5QBGLKgFyeqOtovOUeMls4FohgMW2NoV1v1Bt4CSvwKVc5urZHv/BDLMu2dL943/Lo71s538IKcCvE7UqcNbEVqa37ryvFuv8GQyG4Ady4v8etLCyC53gZIiruk1zfLGpc/IYnkmlLizYK/hC4leLeodTcEQe3Z7L6cgjLbvuE3SZbO/Ymt3VxdoobhpWh+92uqd2FiTgeJsL/9yof4D/4okO7+jCIrt9X0j1NGGPppsizDHi5DyjmfP4/kPGq/w==
sidebar_class_name: "post 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 '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 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={{"description":"The number of seconds an access token generated for this API Client is valid for","type":"integer","format":"int32","example":750}}></SchemaItem><SchemaItem collapsible={false} name={"refreshTokenValiditySeconds"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"The number of seconds a refresh token generated for this API Client is valid for","example":86400,"type":"integer","format":"int32"}}></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"]}}></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><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={{"description":"The number of seconds an access token generated for this API Client is valid for","example":750,"type":"integer","format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"refreshTokenValiditySeconds"} required={true} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"The number of seconds a refresh token generated for this API Client is valid for","example":86400,"type":"integer","format":"int32"}}></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"}><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