Authentication

Version 22.0.8209


Authentication

Version 22.0.8209


Each configured CData Arc user has an Auth Token that can be used to authenticate to the Admin API. For more information about configuring users and user roles, see User Roles.

Using Auth Tokens

Auth Tokens can be used within API requests in several ways:

  • Include an x-cdata-authtoken header in the HTTP request with the value set to an appropriate User’s Auth Token
  • Treat the User and Auth Token as a username/password combination for HTTP Basic Authentication
  • Include the Auth Token in the request URL as a query parameter

To include the Auth Token in the request URL, follow these steps:

  1. Open the Settings page.

  2. Select the Admin API tab.

  3. In the Other Settings section, select Allow Authtoken in URL.

The syntax of the Auth Token query parameter is @authtoken=myAuthTokenValue.