This command is used to fetch the fresh access tokens for a particular profile based on the name.
The name can be a profile alias that you can set via the interactive mode or the silent mode by the application name, environment name or profile name.
For AWS profiles checkout, you need to install and configure AWS CLI before using this britive checkout command. Skip these steps if AWS CLI is already installed and configured.
- Install AWS CLI. For more information, see Installing AWS CLI.
- Configure AWS CLI. For more information, see Configuring AWS CLI. Make sure to use sample values while using aws configure command. This command creates a config file in .aws folder.
- Make sure to check a config file is created under .aws folder before proceeding with Britive CLI.
|$ britive checkout [PROFILENAME]|
where [PROFILENAME] is the profile name of the environment that is checked out.
Modes of Operation
The britive checkout command supports both silent and interactive modes to check out the profile. If the [PROFILENAME] is not specified then by default, the interactive mode is available to the end-user.
The britive checkout command also supports the non-interactive mode where the user can check out profiles manually by specifying the profile name and the required command options. For example, for checking out an AWS profile in the non-interactive mode, you can use the -r or --region option to specify the region.
Command Arguments and Options
Use the command britive checkout --help to know more about the arguments and options available for the britive checkout command.
Command Options- Flags
Specifies the checkout mode. The checkout mode options are available only for AWS.
Note: For more information about the outputs of the checkout modes for AWS, see britive checkout in Non-Interactive Mode.
|-a||--alias||Specify an alias for the profile. This option is used in the non-interactive mode of britive checkout command.|
Note: The new alias that you provide via the -a option will override the existing alias, if any.
|-r||--region||Specify the region flag during manual checkout. This option is used only for AWS applications.|
|-s||--silent||Specify this option to use britive checkout command in the silent mode.|
For more information about the usage of this option, see britive checkout in Silent Mode.
|-t||--token=<token value>||This option is used in token-based authentication and checkout of profiles. Specify the token value in this option.|
For more information about the usage of this option, see Examples: Usage of Service Identities in Britive CLI.
|--auth=token||Specify this option before the -t or --token option. This option specifies that the token authentication method is used while running the britive checkout command.|
|-j||--justification||Specify justification for approval. This command option is supported only when the Britive Profiles enhancement feature is enabled.|
|-b||--blocktime||Specify block time for polling, in minutes. Default value is 5 minutes. This command option is supported only when the Britive Profiles enhancement feature is enabled.|
|--maxpolltime||Specify maximum polling time, in minutes. Default value is 10 minutes. This command option is supported only when the Britive Profiles enhancement feature is enabled.|
|-c||--console||Checkout only the console access for the profile.|
|--cancel||Withdraw the profile approval request.|
|--proxy=proxy||Specify the proxy details for the checkout.|
For more information about the output of britive checkout command in the interactive mode (for various applications like AWS, Azure, and GCP), see About Interactive Mode in britive checkout.
For more information about the output of britive checkout command in the silent mode (for various applications like AWS, Azure, and GCP), see britive checkout in Silent Mode.
For more information about the output of britive checkout command in the non-interactive mode, see the section britive checkout in Non-Interactive Mode.