Login
Safely stores the Service Account Key ID and Secret key locally.
Read time 1 minuteLast updated 3 months ago
Safely stores the Service Account Key ID and Secret key locally.
Note
This is a base command specific to the CLI that allows you to make authenticated calls to our apis. It is not related to the Authentication Unity Service.
Interactive usage
By default, calling this command prompts you to enter your service account and .
key-idsecret-keyugs loginEnter your key-id: <your-key-id>Enter your secret-key: <your-secret-key>
Automated usage
You can automate login by using both the option and the option.
The option expects your service account as argument.
The option expects your in the standard input.
--service-key-id--secret-key-stdinThe
--service-key-idkey-idThe
--secret-key-stdinsecret-keyugs login --service-key-id "your-key-id" --secret-key-stdin < "secret-key-file"
Where is your service account , and is the path to a file containing
your service account .
"your-key-id"key-id"secret-key-file"secret keyOptions
Alias | Description | |
|---|---|---|
| key-id | --service-key-id | The key-id of your service account. Must be used with "--secret-key-stdin". |
| secret-key | --secret-key-stdin | The secret-key of your service account. Must be used with "--service-key-id". |
| help | -?, -h, --help | Display help and usage information. |
| quiet | -q, --quiet | Reduce logging to a minimum. |
| json | -j, --json | Use JSON as the output format. |
Environment Variables
Logging in with Environment Variables
To log in manually use the command.
ugs loginTo log in with system environment variables, set and to your
system's environment variables.
UGS_CLI_SERVICE_KEY_IDUGS_CLI_SERVICE_SECRET_KEYAuthenticated calls follow an order of priority for authentication:
local configurationService Account Key ID and Secret key environment variables