mirror of
https://github.com/status-im/consul.git
synced 2025-01-10 13:55:55 +00:00
85c1a33c42
Co-authored-by: Ashlee Boyer <ashlee.boyer@hashicorp.com> Co-authored-by: Ashlee M Boyer <43934258+ashleemboyer@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@gmail.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> Co-authored-by: HashiBot <62622282+hashibot-web@users.noreply.github.com> Co-authored-by: Kevin Wang <kwangsan@gmail.com>
45 lines
1.1 KiB
Plaintext
45 lines
1.1 KiB
Plaintext
---
|
|
layout: commands
|
|
page_title: 'Commands: Logout'
|
|
description: >
|
|
The `logout` command will destroy the provided token if it was created from
|
|
`consul login`.
|
|
---
|
|
|
|
# Consul Logout
|
|
|
|
Command: `consul logout`
|
|
|
|
Corresponding HTTP API Endpoint: [\[POST\] /v1/acl/logout](/api-docs/acl#logout-from-auth-method)
|
|
|
|
The `logout` command will destroy the provided token if it was created from
|
|
`consul login`.
|
|
|
|
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
|
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/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.
|
|
|
|
#### API Options
|
|
|
|
@include 'http_api_options_client.mdx'
|
|
|
|
### Examples
|
|
|
|
Logout and delete a login token.
|
|
|
|
```shell-session
|
|
$ consul logout -token-file 'consul.token'
|
|
```
|