HashiCorp Developer AI Private beta now available Sign up today
Consul
Consul Home

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

Consul ACL Token Update

Command: consul acl token update

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

The acl token update command will update a token. Some parts of the token like whether the token is local to the datacenter cannot be changed.

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 update [options]

Command Options

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

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

  • -merge-node-identities - Deprecated. Merge the new node identities with the existing node identities. ~> This is deprecated and will be removed in a future Consul version. Use append-node-identity instead.

  • -merge-policies - Deprecated. Merge the new policies with the existing policies.

This is deprecated and will be removed in a future Consul version. Use append-policy-id or append-policy-name instead.

  • -merge-roles - Deprecated. Merge the new roles with the existing roles.

This is deprecated and will be removed in a future Consul version. Use append-role-id or append-role-name instead.

This is deprecated and will be removed in a future Consul version. Use append-service-identity instead.

  • -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. Overwrites existing node identity. May be specified multiple times. Format is NODENAME:DATACENTER. Added in Consul 1.8.1.

  • -append-node-identity=<value> - Name of a node identity to add to this role. May be specified multiple times. The token retains existing node identities. Format is NODENAME:DATACENTER.

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

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

-policy-id and -policy-name will overwrite existing token policies. Use -append-policy-id or -append-policy-name to retain existing policies.

  • -append-policy-id=<value> - ID of policy to be added for this token. The token retains existing policies. May be specified multiple times.

  • -append-policy-name=<value> - Name of a policy to be added for this token. The token retains existing policies. May be specified multiple times.

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

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

-role-id and -role-name will overwrite existing roles. Use -append-role-id or -append-role-name to retain the existing roles.

  • -append-role-id=<value> - ID of a role to add to this token. The token retains existing roles. May be specified multiple times.

  • -append-role-name=<value> - Name of a role to add to this token. The token retains existing roles. May be specified multiple times.

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

  • -append-service-identity=<value> - Name of a service identity to add to this token. May be specified multiple times. The token retains existing service identities. Format is the SERVICENAME or SERVICENAME:DATACENTER1,DATACENTER2,...

  • -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

Update the anonymous token:

$ consul acl token update -id anonymous -policy-id 06acc
Token updated successfully.
AccessorID:   00000000-0000-0000-0000-000000000002
SecretID:     anonymous
Description:  Anonymous Token
Local:        false
Create Time:  0001-01-01 00:00:00 +0000 UTC
Policies:
   06acc965-df4b-5a99-58cb-3250930c6324 - node-services-read

Update a token description and take the policies from the existing token:

$ consul acl token update -id 986193 -description "WonderToken" -merge-policies
Token updated successfully.
AccessorID:   986193b5-e2b5-eb26-6264-b524ea60cc6d
SecretID:     ec15675e-2999-d789-832e-8c4794daa8d7
Description:  WonderToken
Local:        false
Create Time:  2018-10-22 15:33:39.01789 -0400 EDT
Policies:
   06acc965-df4b-5a99-58cb-3250930c6324 - node-services-read