OAuth2 Parameters

The following table describes the OAuth2 parameters:

Parameter

Description

Grant Type

Specifies the following grant types for different use case values::

  • Resource Owner Password Credentials: (Password Credentials) Enables the application to request an access token by sending its credentials, it's client ID and the client secret to the authorization server.
  • Password: Enables the user to provide service credentials (password and user name) directly to the application. Only used if trusted by the user.

OAuth2 API URL

Defines the REST API authorization endpoint. Add parameters by clicking .

Client ID

(Optional) Defines the public identifier for applications. Add parameters by clicking .

Client Secret

(Optional) (Resource Owner Password Credentials grant type) Defines the secret known to the application and the authorization server. Add parameters by clicking .

Username

(Password grant type) Defines that user name of the authorization server. Add parameters by clicking .

Password

(Password grant type) Defines the password of the authorization server. Add parameters by clicking .

Token Parameter

(Password grant type) Defines the access token required by the REST API. This token can be used in the URL request header for authentication.

Authorization=Bearer{{TOKEN_NAME}}

Content-Type

(Optional) Indicates the media type of the resource.

Headers

(Optional) Defines any additional HTTP headers in the following format:

<name>=<value>

NOTE: Separate any pair of names of values by a semi colon. Add parameters by clicking or .

Body

(Optional) Defines any text that is required in the request body. Add parameters by clicking or .

Use Basic Authentication

Add additional authentication to OAuth2 request.

User name Parameter

Defines the user name of the HTTP server from the drop-down list.

Password Parameter

Defines the password of the HTTP server from the drop-down list.