Search

REST V2 Connector

REST V2 Connector

Back Next

API key authentication

API key authentication

API key authentication allows you to provide a unique key and a corresponding value to authenticate API calls made to the REST endpoint.

The following table describes the basic connection properties for API key authentication:

Property	Description
Key	The unique API key that REST V2 Connector uses to authenticate the API calls made to the REST endpoint.
Value	The value corresponding to the API key that is required to make the API calls.
Add API Key to	Determines if the API key and its corresponding value must be sent as a request header or a query parameter to make API calls to the REST endpoint. Select one of the following options: Request Header Query Parameter
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.

Authentication types

Watch

Comments

Cloud Connectivity Homepage

0 COMMENTS

We’d like to hear from you! Log in to comment.