ORorangelogic

OAuth 2.0 client registration

Create an account for a third-party application

post/oauth2/registerclient_23X_v1

Request

  • Base URL
    https://OrangeLogicURL/webapi/security
  • URL
    https://OrangeLogicURL/webapi/security/oauth2/registerclient_23X_v1
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://example.com/oauth2/token

Request body

namestring required

The name of the application account.

descriptionstring

A description of the application account.

iconIDstring

The <a href="https://orangedam.readme.io/docs/assets#record-id">record ID</a> of an asset in Orange Logic.<br></br>Choose an image file, such as a logo, to identify the account. An account icon image is not required, but we recommend using one because users see this image when they authorize the third-party application.

redirectURIsstring required

The URL the user is redirected to after authorizing the application.<br></br>A redirect URI is often the home page or login page of the third-party application. Check the API documentation of the third-party application to find a recommended URI redirect address.

seedstring

A unique value that allows any new accounts created with the same name and seed to generate the same OAuth credentials.<br></br>Seeds are optional. However, we strongly recommend using them to simplify your configuration by creating consistent credentials across environments or sites. You can enter any string, but we recommend including the account name. Keep seeds confidential and document their purpose clearly to simplify future account management.

groupsstring

A list of the <a href="https://link.orangelogic.com/CMS4/Permalinks/2P7YOHDZQUNL" target="_blank">groups</a> the application account is assigned to.

Response

200

Example response

{
  "info": {
    "id": "hoVe5vyeD2TtImZy.canva.orangelogic.com",
    "name": "Canva",
    "description": "Oauth credential account for Canva integration",
    "iconID": "2QDTWAWHUT7",
    "redirectURIs": [
      "https://www.canva.com/login/"
    ]
  },
  "credentials": {
    "id": "hoVe5vyeD2TtImZy.canva.mangovations.com",
    "secret": "DjZoRf8FnNmDYP8hX2nOErOs9iOGF70oMlQ_yYF91pQ"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.