auth
Command¶
Authenticate as a user of this system if needed by configured Trust Requirements.
Usage¶
enclave auth [<VALUE>]
[--profile <VALUE>]
[--verbosity|-v <VALUE>]
[--daemon|-d]
[--logout]
[--no-browser]
[--no-storage]
[--non-interactive|-n]
Parameters¶
Position | Name | Short Name | Description |
---|---|---|---|
0 | An explicit authentication token to use for authentication | ||
profile | Each Enclave requires a profile. A profile is the name of an Enclave network, and refers to a configuration file that contains settings and certificate of each Enclave network. Multiple Enclave instances can run simultaneously on a single system, each with its own profile, settings, network and connections. | ||
verbosity | v | If specified, overrides the level of log verbosity defined in an Enclave Profile. 0 is the lowest level, no log output, and 5 is the highest which includes a hexadecimal dump of each packet passing through the fabric. Value range 0 to 5. If set to -1, the verbosity will be determined by the Profile configuration. (Use with caution) | |
daemon | d | Continue running until terminated, trying to silently authenticate from saved credentials | |
logout | Clear all saved credentials and log out | ||
no-browser | Do not attempt to open a web browser to complete authentication if required | ||
no-storage | Indicate that Enclave should not save any refresh tokens for automatic user authentication in future. Each time this command is called, you will need to go through the interactive login flow. | ||
non-interactive | n | Only authenticate using saved credentials; do not go through a new authentication flow |
Parameter (Position 0)¶
An explicit authentication token to use for authentication
Position: | 0 |
Required: | No |
Default value: | None |
profile
Parameter¶
Each Enclave requires a profile. A profile is the name of an Enclave network, and refers to a configuration file that contains settings and certificate of each Enclave network. Multiple Enclave instances can run simultaneously on a single system, each with its own profile, settings, network and connections.
Name: | profile |
Position: | Named parameter |
Required: | No |
Default value: | None |
verbosity
Parameter¶
If specified, overrides the level of log verbosity defined in an Enclave Profile. 0 is the lowest level, no log output, and 5 is the highest which includes a hexadecimal dump of each packet passing through the fabric. Value range 0 to 5. If set to -1, the verbosity will be determined by the Profile configuration. (Use with caution)
Name: | verbosity |
Short name: | v |
Position: | Named parameter |
Required: | No |
Default value: | -1 |
daemon
Parameter¶
Continue running until terminated, trying to silently authenticate from saved credentials
Name: | daemon |
Short name: | d |
Position: | None (Switch Parameter) |
Required: | No (Switch Parameter) |
Default value: | false |
logout
Parameter¶
Clear all saved credentials and log out
Name: | logout |
Position: | None (Switch Parameter) |
Required: | No (Switch Parameter) |
Default value: | false |
no-browser
Parameter¶
Do not attempt to open a web browser to complete authentication if required
Name: | no-browser |
Position: | None (Switch Parameter) |
Required: | No (Switch Parameter) |
Default value: | false |
no-storage
Parameter¶
Indicate that Enclave should not save any refresh tokens for automatic user authentication in future. Each time this command is called, you will need to go through the interactive login flow.
Name: | no-storage |
Position: | None (Switch Parameter) |
Required: | No (Switch Parameter) |
Default value: | false |
non-interactive
Parameter¶
Only authenticate using saved credentials; do not go through a new authentication flow
Name: | non-interactive |
Short name: | n |
Position: | None (Switch Parameter) |
Required: | No (Switch Parameter) |
Default value: | false |
Documentation generated by MdDocs