API Authentication
Overview
Starting October 19, 2022, you can connect your corporate identity provider to using the Platform's Identity service. Once connected, Platform will act as an identity broker between your IdP (Identity Provider) and , 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 the 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.
The Digital.ai Agility API supports different authentication types for the requests that it receives. Authentication associates the API request with a specific Member in the system and secures data according to the Roles and Project Memberships assigned to that Member. Most Digital.ai Agility APIs require authentication and respond with a 401 Unauthorized for a request that cannot be authenticated. If no such asset exists, or if you do not have sufficient rights to view it, then the response will be 404 Not Found.
Some endpoints are tied to the authentication mechanism of the Digital.ai Agility application. Although there are multiple options, the selected option will apply everywhere. The following authentication mechanisms are supported by Digital.ai Agility:
- Access Tokens (Recommended)
- Basic
- Windows Integrated Authentication
Note: As of the Winter 2015 release, Digital.ai Agility supports its own type of Access Token Authentication. Digital.ai Agility Access Tokens are far easier to create and use than the other authentication mechanisms, and is the recommended approach as it can be used no matter if your Digital.ai Agility instance is configured for Basic, Windows Integrated Authentication, or a third-party SSO authentication method like SAML.
API Endpoint | Authentication |
---|---|
attachment.img | All |
loc.v1 | None |
meta.v1 | None |
query.v1 | All (NTLM Excluded) |
rest-1.v1/Data | All |
rest-1.v1/Hist | All |
rest-1.v1/New | All |
API Endpoint Security
The following table lists Digital.ai Agility API endpoints and the authentication mechanisms that they support: