OAuth 2.0 Parameter Sets (ttaad0108m000)

Use this session tomanage different sets of OAuth 2.0 parameters, which can be used by other LN sessions when performing HTTP requests that require OAuth 2.0 authentication. In this session you can specify data such as the Access Token URL, the Client ID, and the Client Secret.

Note: If you started this session by zooming, you can only find and select a record.

Actions

These options are available:

Import IONAPI File
Use this command to import an IONAPI (*.ionapi) file containing OAuth 2.0 credentials data. After specifying the location of the file, the data from the file is displayed. After clicking OK, the data is stored.
Get new Access Token
Use this command to manually obtain or refresh the access token using the credentials stored in the OAuth 2.0 parameter set. You can also use this command to verify if communication to the authorization server is successful.

Field Information

Parameter Set
The identification code of an OAuth 2.0 parameter set. When importing an IONAPI file, this code is generated based on the contents of the IONAPI file.
Description
The description of the Oauth 2.0 parameter set. When importing an IONAPI file, this description is generated based on the contents of the IONAPI file.
Grant Type

The type of grant. LN supports these grant types:

  • Client Credentials

    This grant type allows the Client ID and the Client Secret to be specified.

  • Password Credentials

    This grant type allows the Client ID, the Client Secret, the user name, and the password to be specified

Access Token URL
The URL of the authentication server that is used to obtain or refresh the OAuth 2.0 access token.
Client Authentication

Specifies the way the Client ID and the Client Secret are sent to the authorization server:

  • As Basic Auth Header

    The Client ID and the Client Secret are sent using the Basic Authentication scheme in the Authorization HTTP request header.

  • Client Credentials in Body

    The Client ID and the Client Secret are sent in the request body.

Scope
Specifies any scopes that apply to the OAuth 2.0 authentication. The value of the scope parameter is expressed as a list of space-delimited, case-sensitive strings. The strings are defined by the authorization server.
Client ID
A unique string that identifies the client when retrieving an access token from the authorization server.
Client Secret
A secret (or password) which together with the client ID is used to identify the client when retrieving an access token from the authorization server.
Username
The user name of the user who wants to retrieve an access token. This field is available if grant type Password Credentials is selected.
Password
The password of the user who want to retrieve an access token. This field is available if grant type Password Credentials is selected.
Access Token
Token Available
This field shows whether an access token has been retrieved previously.
Token Valid
This field shows whether the current access token is valid. Valid means that the token has not yet expired.
Expires In [secs]
The time until the access token expires expressed in seconds.
Expires After
The date and time after which the access token is no longer valid.
Change Information
Creation Date
The date and time on which the OAuth 2.0 parameter set was created.
Created by
The username of the user who created the OAuth 2.0 parameter set.
Name
The name of the user who created the OAuth 2.0 parameter set.
Last Change Date
The date and tiime when the OAuth 2.0 parameter set was last changed. This field is empty if, after creating the OAuth 2.0 parameter set, no changes have been made.
Note: This field is updated only if one of these fields are changed and saved:
  • Description
  • Grant Type
  • Access Token URL
  • Client Authentication
  • Scope
  • Client ID
  • Client Secret
  • Username
  • Password
Last Changed by
The username of the user who made the most recent change to the OAuth 2.0 parameter set.
Name
The name of the user who made the most recent change to the OAuth 2.0 parameter set.
Note: This field is updated only if one of these fields are changed and saved:
  • Description
  • Grant Type
  • Access Token URL
  • Client Authentication
  • Scope
  • Client ID
  • Client Secret
  • Username
  • Password