HashiConf 2024 Now streaming live from Boston! Attend for free
Consul
Consul Home

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

Consul ACL Token Create

Command: consul acl token create

Corresponding HTTP API Endpoint: [PUT] /v1/acl/token

This command creates new tokens. When creating a new token, policies may be linked using either the -policy-id or the -policy-name options. When specifying policies by IDs you may use a unique prefix of the UUID as a shortcut for specifying the entire UUID.

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:write

Usage

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

Command Options

  • -accessor=<string> - Create the token with this Accessor ID. It must be a UUID. If not specified one will be auto-generated

  • -description=<string> - A description of the token.

  • -expires-ttl=<duration> - Duration of time this token should be valid for.

  • -local - Create this as a datacenter local token.

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

  • -node-identity=<value> - Name of a node identity to use for this role. May be specified multiple times. Format is NODENAME:DATACENTER. Added in Consul 1.8.1.

  • -policy-id=<value> - ID of a policy to use for this token. May be specified multiple times.

  • -policy-name=<value> - Name of a policy to use for this token. May be specified multiple times.

  • -role-id=<value> - ID of a role to use for this token. May be specified multiple times.

  • -role-name=<value> - Name of a role to use for this token. May be specified multiple times.

  • -service-identity=<value> - Name of a service identity to use for this token. May be specified multiple times. Format is the SERVICENAME or SERVICENAME:DATACENTER1,DATACENTER2,...

  • -secret=<string> - Create the token with this Secret ID. It must be a UUID. If not specified one will be auto-generated. Note: The SecretID is used to authorize operations against Consul and should be generated from an appropriate cryptographic source.

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

Enterprise Options

  • -partition=<string> - Enterprise Specifies the partition to query. If not provided, the partition is inferred from the request's ACL token, or defaults to the default partition.
  • -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

The following examples describe how to create ACL tokens for common scenarios.

Create a token with policy by name

The following example creates a token that includes a policy by its name.

$ consul acl token create -description "Read Nodes and Services" -policy-name node-services-read
AccessorID:   986193b5-e2b5-eb26-6264-b524ea60cc6d
SecretID:     ec15675e-2999-d789-832e-8c4794daa8d7
Description:  Read Nodes and Services
Local:        false
Create Time:  2018-10-22 15:33:39.01789 -0400 EDT
Policies:
   06acc965-df4b-5a99-58cb-3250930c6324 - node-services-read

Create a token for a service

The following example creates a token with the privileges necessary for registering a service named my-api. If my-api is in the service mesh, the token also has the privileges necessary to register its associated sidecar proxy and must be provided to the proxy when launched with consul connect envoy.

$ consul acl token create -description 'my-api token' -service-identity 'my-api'
AccessorID:       0c083aca-6c15-f0cc-c4d9-30578db54cd9
SecretID:         930dafb6-5c08-040b-23fb-a368a95256f9
Description:      api token
Local:            false
Create Time:      2019-04-25 16:45:49.337687334 -0500 CDT
Service Identities:
   my-api (Datacenters: all)

Create a temporary and highly-privileged token

The following example creates a token with a lifetime of 15 minutes that includes the built-in global-management policy.

$ consul acl token create -description "Temp Super User" -policy-name global-management -expires-ttl '15m'
AccessorID:   59f86a9b-d3b6-166c-32a0-be4ab3f94caa
SecretID:     ada7f751-f654-8872-7f93-498e799158b6
Description:  Temp Super User
Local:        false
Create Time:      2019-04-25 16:45:49.337687334 -0500 CDT
Expiration Time:  2019-04-25 17:00:49.337687334 -0500 CDT
Policies:
   00000000-0000-0000-0000-000000000001 - global-management

Create a local token with policy by ID

The following example creates a token that is only valid in this datacenter and includes a policy by its UUID.

$ consul acl token create -description "Read Nodes and Services" -policy-id 06acc965 -local
AccessorID:   986193b5-e2b5-eb26-6264-b524ea60cc6d
SecretID:     ec15675e-2999-d789-832e-8c4794daa8d7
Description:  Read Nodes and Services
Local:        true
Create Time:  2018-10-22 15:33:39.01789 -0400 EDT
Policies:
   06acc965-df4b-5a99-58cb-3250930c6324 - node-services-read