Authentication

There are two ways to authenticate against the CLI:

Federated authentication

This is the most common scenario. You should just use the following command to log in:

> conveyor auth login

Access key and secret key

When you want to integrate conveyor within your CI/CD pipelines, the best way to set it up is to use the following environment variables to authenticate:

> export CONVEYOR_AUTH_KEY=XX
> export CONVEYOR_AUTH_SECRET=YY

To get the access key and secret you can go to the settings page in Conveyor, and find them in the CI/CD tab there.

caution

When using this method of authentication and doing frequent calls (more then 1 call per hour), we recommend caching the access token until the token expires.