REST API Authentication Options

The authentication options for a REST API Connection are as follows.

Tip: In addition to the fields specific to these authentication types, there is an additional field name Connection Category. For information on using this field, see Connection Categories.

Basic

For Basic authentication, you must specify a Username and Password.

Token

For Token authentication, you must specify your API Token and indicate the header field in which it should be supplied by providing a Header Name. You can also optionally specify a Value Prefix such as Bearer.

OAuth 2.0 Client Credentials

For this option, you must specify the target API's Access Token URL, Client ID, and Client Secret.

Note: It is a best practice to limit the scope of a REST Connection to what you need. To do so, enter the OAuth 2.0 scopes you need in the Scope field.

There are two options for specifying the Auth Location:

• Basic Header lets you specify the credentials in a header field.

• Body lets you specify the credentials in the request body.

Either way, you can specify a prefix (for example, Bearer) in the Auth Header Prefix field.

To test the Connection, click Test Connection.

OAuth 2.0 Authorization Code

For this option, you must specify the target API's Auth URL, Access Token URL, Client ID, and Client Secret.

To use this option, you must paste the OAuth 2.0 Redirect URI into the redirect field in the target site. (You can retrieve this URI from the REST Properties screen for the Connection, under the configuration fields.) When the target site calls back to allow login, RunMyJobs uses this URL to display a login window.

The other options are the same as for the OAuth 2.0 Client Credentials method (above).

To test the Connection, click Login.