API Authentication Methods
Starting October 19, 2022, you can connect your corporate identity provider to Digital.ai using the Digital.ai Platform's Identity service. Once connected, Digital.ai Platform acts as an identity broker between your Identity Provider (IdP) and Digital.ai Agility, allowing your users to securely access all products and the support, documentation, and community portals using the same credentials they use throughout your enterprise.
If you have not yet migrated your single sign-on (SSO) and user management to Digital.ai Platform and want to do so, write to support@digital.ai for assistance.
If you have any further questions, please reach out to your contact or write to support@digital.ai.
Depending upon where your Digital.ai 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 need to use rest-1.oauth.v1 instead under certain conditions.
If your instance is configured with Windows Integrated Authentication Mode and you want your code to use Access Tokens, you will need to use rest-1.oauth.v1.
Authentication Options
This table summarizes the current options:
| Installation Type | Authentication Mode | rest-1.v1supports: | rest-1.oauth.v1supports: |
| On-Premise | Digital.ai Agility | Access Token | Access Token |
| On-Premise | Windows Integrated Authentication | Windows Integrated Authentication (for capable clients) | Access Token |
| On-Demand | Digital.ai Agility | Access Token | Access Token |
| On-Demand | SSO | Access Token | Access Token |
Basic Auth Information
You can use Basic Auth (username and password) anywhere the table shows Access Token above, with the following exceptions:
- On-Premise instances configured with Windows Integrated Authentication Mode
- On-Demand SSO instances
However, we recommend using Access Tokens instead of Basic Auth for better security and future compatibility.
Single Sign-On Authentication Considerations
With modern OpenID Connect (OIDC) or Security Assertion Markup Language (SAML) federated authentication setups, both rest-1.v1 and rest-1.oauth.v1 endpoints support Access Token authentication for both On-Premise and On-Demand instances.