Skip to content

airt token

Get application token for airt service from a username/password pair.

To access the airt service, you must create a developer account. Please contact us by email info@airt.ai to get one.

Finally, you need an application token to access all the APIs in airt service. Please run the command airt token with the username/password to get one. You can either pass the username, password, and server address as command line arguments or store them in the AIRT_SERVICE_USERNAME, AIRT_SERVICE_PASSWORD, and AIRT_SERVER_URL environment variables.

In case of MFA enabled user, along with the username/password the dynamically generated six-digit verification code also needs to be passed when requesting an auth token.

You can also enable Single sign-on (SSO) for your account and generate tokens. Currently, we support only Google and Github as the external authentication providers (SSO). More authentication providers will be supported in the upcoming releases.

Authenticating using Single sign-on (SSO) is also a three-step process:

  1. Enable the SSO provider by calling the command airt user sso enable method with a valid SSO provider and an email address.

  2. In order to get the token, you must have to complete the SSO authentication with the provider. Calling the command airt token with a valid SSO provider will give you an authorization URL. Please copy and paste it into your preferred browser and initiate the authentication process with the SSO provider.

  3. Once the authentication is successful, an access token will be generated and will be returned.

Upon receiving the application token, please set it in the environment variable AIRT_SERVICE_TOKEN for accessing the airt service.

Usage:

$ airt token [OPTIONS]

Options:

  • -u, --username TEXT: Username for the developer account. If None (default value), then the value from AIRT_SERVICE_USERNAME environment variable is used.
  • -p, --password TEXT: Password for the developer account. If None (default value), then the value from AIRT_SERVICE_PASSWORD environment variable is used.
  • -s, --server TEXT: The airt server uri. If None (default value), then the value from AIRT_SERVER_URL environment variable is used. If the variable is not set as well, then the default public server will be used. Please leave this setting to default unless you are running the service in your own server (please email us to info@airt.ai for that possibility).
  • --otp TEXT: Dynamically generated six-digit verification code from the authenticator app. Please do not pass this parameter if you haven't enabled the multi-factor authentication for your account.
  • -sp, --sso_provider TEXT: Name of the Single sign-on (SSO) provider. Please pass this parameter only if you have successfully enabled SSO for this provider.
  • -q, --quiet: Output authentication token only.
  • -d, --debug: Set logger level to DEBUG and output everything.
  • --install-completion [bash|zsh|fish|powershell|pwsh]: Install completion for the specified shell.
  • --show-completion [bash|zsh|fish|powershell|pwsh]: Show completion for the specified shell, to copy it or customize the installation.
  • --help: Show this message and exit.
Back to top