Table of Contents

Search

  1. Preface
  2. Introduction to REST V2 Connector
  3. Connections for REST V2
  4. REST V2 operations
  5. Mappings and mapping tasks with REST V2 Connector
  6. Swagger File Generation
  7. Appendix A: Swagger objects
  8. OpenAPI objects

REST V2 Connector

REST V2 Connector

OAuth 2.0 client credentials authentication

OAuth 2.0 client credentials authentication

OAuth 2.0 client credentials authentication requires at a minimum the client ID, access token URL, client secret, scope, and the access token.
The following table describes the basic connection properties for OAuth 2.0 client credentials authentication:
Property
Description
Access Token URL
Access token URL configured in your application.
Client ID
Client ID of your application.
Client Secret
Client secret of your application.
Scope
Specifies access control if the API endpoint has defined custom scopes. Enter scope attributes, each separated by a space. For example:
root_readonly root_readwrite manage_app_users
Access Token Parameters
Additional parameters to use with the access token URL. Define the parameters in the JSON format.
For example,
[{"Name":"resource","Value":"https://<serverName>"}]
Client Authentication
Select an option to send the client ID and client secret for authorization either in the request body or in the request header.
Default is
Send Client Credentials in Body
.
Generate Access Token
Generates an access token based on the information provided in the above fields.
Access Token
The access token value.
Enter the access token value or click
Generate Access Token
to populate the access token value.
To pass the generate access token call through a proxy server, you must configure an unauthenticated proxy server in the Secure Agent properties. The proxy configured in the connection configuration does not apply to the generate access token call.
Swagger File Path
The path of the Swagger file or OpenAPI file.
You can specify one of the following file paths:
  • Path and file name of the Swagger or OpenAPI file on the Secure Agent machine.
  • The URL on which the Swagger or OpenAPI file is hosted. The hosted URL must return the content of the file without prompting for further authentication and redirection.
For example, the path of the swagger file can be:
C:\swagger\sampleSwagger.json
The user must have the read permission for the folder and the file.

0 COMMENTS

We’d like to hear from you!