News HashiCorp to join IBM to accelerate multi-cloud automation. Read the blog →
Consul
Consul Home

You are viewing documentation for version v1.16.x. View latest version.

Consul ACL Token Read

Command: consul acl token read

Corresponding HTTP API Endpoint: [GET] /v1/acl/token/:AccessorID

The acl token read command reads and displays a token 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
acl:read

Usage

Usage: consul acl token read [options] [args]

Command Options

  • -id=<string> - The ID of the policy to read. It may be specified as a unique ID prefix but will error if the prefix matches multiple policy IDs.

  • -meta - Indicates that policy metadata such as the content hash and raft indices should be shown for each entry.

  • -self - Indicates that the current HTTP token should be read by secret ID instead of expecting a -id option.

  • -expanded - Indicates that the contents of the policies and roles affecting the token should also be shown.

  • -format={pretty|json} - Command output format. The default value is pretty.

Enterprise Options

  • -partition=<string> - Specifies the partition to query. If not provided, the partition will be inferred from the request's ACL token, or will default to the default partition. Partitions are a Consul Enterprise feature added in v1.11.0.
  • -namespace=<string> - Specifies the namespace to query. If not provided, the namespace will be inferred from the request's ACL token, or will default to the default namespace. Namespaces are a Consul Enterprise feature added in v1.7.0.

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.

  • -datacenter=<name> - Name of the datacenter to query. If unspecified, the query will default to the datacenter of the Consul agent at the HTTP address.

  • -stale - Permit any Consul server (non-leader) to respond to this request. This allows for lower latency and higher throughput, but can result in stale data. This option has no effect on non-read operations. The default value is false.

Examples

Get token details:

$ consul acl token read -id 986AccessorID:   986193b5-e2b5-eb26-6264-b524ea60cc6dSecretID:     ec15675e-2999-d789-832e-8c4794daa8d7Description:  Read Nodes and ServicesLocal:        falseCreate Time:  2018-10-22 15:33:39.01789 -0400 EDTPolicies:   06acc965-df4b-5a99-58cb-3250930c6324 - node-services-read

Get token details using the token secret ID:

$consul acl token read -selfAccessorID:   4d123dff-f460-73c3-02c4-8dd64d136e01SecretID:     86cddfb9-2760-d947-358d-a2811156bf31Description:  Bootstrap Token (Global Management)Local:        falseCreate Time:  2018-10-22 11:27:04.479026 -0400 EDTPolicies:   00000000-0000-0000-0000-000000000001 - global-management

Get token details (Builtin Tokens)

$ consul acl token read -id anonymousAccessorID:   00000000-0000-0000-0000-000000000002SecretID:     anonymousDescription:  Anonymous TokenLocal:        falseCreate Time:  0001-01-01 00:00:00 +0000 UTCPolicies:

Get token details (Expanded)

$ consul acl token read -expanded -id 986AccessorID:   986193b5-e2b5-eb26-6264-b524ea60cc6dSecretID:     ec15675e-2999-d789-832e-8c4794daa8d7Description:  Read Nodes and ServicesLocal:        falseCreate Time:  2018-10-22 15:33:39.01789 -0400 EDTPolicies:    Policy Name: foo        ID: beb04680-815b-4d7c-9e33-3d707c24672c        Description: user policy on token        Rules:            service_prefix "" {              policy = "read"            }     Policy Name: bar        ID: 18788457-584c-4812-80d3-23d403148a90        Description: other user policy on token        Rules:            operator = "read" === End of Authorizer Layer 0: Token ====== Start of Authorizer Layer 2: Agent Configuration Defaults (Inherited) ===Description: Defined at request-time by the agent that resolves the ACL token; other agents may have different configuration defaultsResolved By Agent: "leader" Default Policy: allow    Description: Backstop rule used if no preceding layer has a matching rule (refer to default_policy option in agent configuration) Down Policy: deny    Description: Defines what to do if this Token's information cannot be read from the primary_datacenter (refer to down_policy option in agent configuration)