Using the API with User Authentication Enabled - AWS Elemental Conductor Live 3

This is version 3.17 of the AWS Elemental Conductor Live 3 documentation. This is the latest version. For prior versions, see the Previous Versions section of AWS Elemental Conductor Live 3 Documentation.

Using the API with User Authentication Enabled

Your cluster deployment is configured for local or PAM user authentication (users must provide valid credentials to access Conductor). Check with the person who performed the initial configuration of the cluster, or see the AWS Elemental Conductor Live 3 Configuration Guide.

If authentication is enabled, then the header of each request must also include the following:

Header Description

X-Auth-User

The username of the user who is using the API. Note that the user’s password is not included in the header.

X-Auth-Expires

The date and time at which the individual REST request expires. Enter the date in Unix time (POSIX or Epoch time).

The recommended value is 30 seconds in the future, but, if the client clock and Conductor node clock are not completely in sync, you may want to make adjustments to accommodate the difference.

X-Auth-Key

An MD5 hash of the API key for the user who is using the API.

An administrator generates this key as follows:

  • Log on via the web interface and go to Settings > User Profile.

  • Click the Reset API Key (key icon) for the applicable users.

  • Provide the individual user with a key, for example, via email.

For information on hashing the key, see the next section.