Skip to content

stackit_auth_activate-service-account.md

Latest commit

 

History

History
59 lines (42 loc) · 3.13 KB

stackit_auth_activate-service-account.md

File metadata and controls

59 lines (42 loc) · 3.13 KB
Raw

stackit auth activate-service-account

Authenticates using a service account

Synopsis

Authenticates to the CLI using service account credentials. Subsequent commands will be authenticated using the service account credentials provided. For more details on how to configure your service account, check our Authentication guide at https://github.com/stackitcloud/stackit-cli/blob/main/AUTHENTICATION.md.

stackit auth activate-service-account [flags]

Examples

  Activate service account authentication in the STACKIT CLI using a service account key which includes the private key
  $ stackit auth activate-service-account --service-account-key-path path/to/service_account_key.json

  Activate service account authentication in the STACKIT CLI using the service account key and explicitly providing the private key in a PEM encoded file, which will take precedence over the one in the service account key
  $ stackit auth activate-service-account --service-account-key-path path/to/service_account_key.json --private-key-path path/to/private.key

  Activate service account authentication in the STACKIT CLI using the service account token
  $ stackit auth activate-service-account --service-account-token my-service-account-token

  Only print the corresponding access token by using the service account token. This access token can be stored as environment variable (STACKIT_ACCESS_TOKEN) in order to be used for all subsequent commands.
  $ stackit auth activate-service-account --service-account-token my-service-account-token --only-print-access-token

  Authenticate via Workload Identity Federation (OIDC) and print the short-lived access token. Use --use-oidc to explicitly enable OIDC (takes precedence over STACKIT_USE_OIDC); no service account key file is required.
  $ STACKIT_SERVICE_ACCOUNT_EMAIL=ci@sa.stackit.cloud stackit auth activate-service-account --use-oidc --only-print-access-token

Options

  -h, --help                              Help for "stackit auth activate-service-account"
      --only-print-access-token           If this is set to true the credentials are not stored in either the keyring or a file
      --private-key-path string           RSA private key path. It takes precedence over the private key included in the service account key, if present
      --service-account-key-path string   Service account key path
      --service-account-token string      Service account long-lived access token
      --use-oidc                          Use Workload Identity Federation (OIDC). If set, this takes precedence over STACKIT_USE_OIDC

Options inherited from parent commands

  -y, --assume-yes             If set, skips all confirmation prompts
      --async                  If set, runs the command asynchronously
  -o, --output-format string   Output format, (one of: [json, pretty, none, yaml])
  -p, --project-id string      Project ID
      --region string          Target region for region-specific requests
      --verbosity string       Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")

SEE ALSO