AuthCli¶

AuthCli is used by UnityCatalogCli to handle auth sub-commands.

$ ./bin/uc auth --help
Please provide a valid sub-command for auth.
Valid sub-commands for auth are: login
For detailed help on auth sub-commands, use bin/uc auth <sub-command> --help

Exchange and Login¶

login and exchange use doExchange for authentication with the following difference:

• login uses Oauth2CliExchange to authenticate and generate an identity token.
• exchange expects an identity token to be given (using identity_token option on command line).

Handle Command Line¶

void handle(
  CommandLine cmd,
  ApiClient apiClient)

handle handles the given cmd.

handle is used when:

• UnityCatalogCli is launched on command line with auth command

Exchange¶

String exchange(
  ApiClient apiClient,
  JSONObject json)

exchange de-serializes the given json object into a collection (that is supposed to include identityToken key based on identity_token CLI parameter).

exchange doExchange with the identityToken identity token.

login is used when:

• AuthCli is requested to handle login subcommand with identity_token option used on the command line

Login¶

String login(
  ApiClient apiClient,
  JSONObject json)

login creates a Oauth2CliExchange to authenticate (and create an identity token).

In the end, login doExchange with the identity token as the value of identityToken key in the login input map).

login is used when:

• AuthCli is requested to handle login subcommand with no identity_token option used on the command line

doExchange¶

String doExchange(
  ApiClient apiClient,
  Map<String, String> login)

doExchange requests the given ApiClient for the base URI to access /auth/tokens API endpoint with the following query parameters:

doExchange sends a POST request to /auth/tokens API endpoint with application/x-www-form-urlencoded content type.

In the end, doExchange creates a LoginInfo with access_token (from the response).