Agility API Authentication Methods

Overview

Depending upon where your Agility instance is installed and how it's configured, there are special considerations for accessing the REST API. In most of the documentation, you'll see the rest-1.v1 endpoint referenced in examples. You may instead need to use rest-1.oauth.v1 under certain conditions.

Currently, if your instance is configured with Windows Integrated Authentication Mode and you want your code to use Access Tokens, you will need to use a slight variation named rest-1.oauth.v1.

Note

We will remove the rest-1.oauth.v1 endpoint in a future release. When we do this, we will change rest-1.v1 to work only with Access Tokens.

Current Options

This table summarizes the current options:

Installation Type Authentication Mode rest-1.v1 supports: rest-1.oauth.v1 supports:
On-Premise Agility Access Token Access Token
On-Premise Windows Integrated Authentication Windows Integrated Authentication (for capable clients) Access Token
On-Demand Agility Access Token Access Token
On-Demand SSO Not Available Access Token

Basic Auth Information

You may currently use Basic Auth (username/password) anywhere the table shows Access Token above with the exceptions of an On-Premise instance configured in Windows Integrated Authentication Mode and an On-Demand SSO instance. But, like the rest-1.oauth.v1 endpoint, this capability will be removed in a future release. Thus, we recommend transitioning to Access Tokens now.

Future Options

As mentioned above, we will remove rest-1.oauth.v1 and Basic Auth completely in a future release. The following table summarizes what the options will look like at that time:

Installation Type Authentication Mode rest-1.v1 supports:
On-Premise Agility Access Token
On-Premise Windows Integrated Authentication Access Token
On-Demand Agility Access Token
On-Demand SSO Access Token

 

 

 

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.