HashiConf 2025 Don't miss the live stream of HashiConf Day 2 happening now View live stream
Consul Home

Consul Logout

Command: consul logout

Corresponding HTTP API Endpoint: [POST] /v1/acl/logout

The logout command will destroy the provided token if it was created from consul login.

If you created the token by logging in with an OIDC auth method and identity provider logout is available, the command also prints the identity provider logout URL so that you can end the provider session. Refer to OIDC logout for details.

The table below shows this command's required ACLs. Configuration of blocking queries and agent caching are not supported from commands, but may be from the corresponding HTTP endpoint.

ACL Required
none

Usage

Usage: consul logout [options]

The token to delete should be specified with the -token argument, the CONSUL_HTTP_TOKEN environment variable, the -token-file argument, or the CONSUL_HTTP_TOKEN_FILE environment variable.

Command Options

  • -open-browser - Also open the identity provider logout URL in your default browser. Applies only to tokens created by consul login -type=oidc when identity provider logout is available. Consul always prints the URL. Do not use this option in non-interactive environments, such as CI pipelines. You can also set this option with the CONSUL_LOGOUT_OPEN_BROWSER environment variable. The flag takes precedence over the environment variable. Defaults to false.

API Options

  • -ca-file=<value> - Path to a CA file to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CACERT environment variable.

  • -ca-path=<value> - Path to a directory of CA certificates to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CAPATH environment variable.

  • -client-cert=<value> - Path to a client cert file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_CERT environment variable.

  • -client-key=<value> - Path to a client key file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_KEY environment variable.

  • -http-addr=<addr> - Address of the Consul agent with the port. This can be an IP address or DNS address, but it must include the port. This can also be specified via the CONSUL_HTTP_ADDR environment variable. In Consul 0.8 and later, the default value is http://127.0.0.1:8500, and https can optionally be used instead. The scheme can also be set to HTTPS by setting the environment variable CONSUL_HTTP_SSL=true. This may be a unix domain socket using unix:///path/to/socket if the agent is configured to listen that way.

  • -tls-server-name=<value> - The server name to use as the SNI host when connecting via TLS. This can also be specified via the CONSUL_TLS_SERVER_NAME environment variable.

  • -token=<value> - ACL token to use in the request. This can also be specified via the CONSUL_HTTP_TOKEN environment variable. If unspecified, the query will default to the token of the Consul agent at the HTTP address.

  • -token-file=<value> - File containing the ACL token to use in the request instead of one specified via the -token argument or CONSUL_HTTP_TOKEN environment variable. This can also be specified via the CONSUL_HTTP_TOKEN_FILE environment variable.

Examples

Logout and delete a login token.

$ consul logout -token-file 'consul.token'

Log out, delete a login token created with an OIDC auth method, and open the identity provider logout URL in your default browser:

$ consul logout -token-file 'consul.token' -open-browser
Edit this page on GitHub