open-nomad/website/content/docs/commands/acl/token/update.mdx
James Rasell 986355bcd9
docs: add documentation for ACL token expiration and ACL roles. (#14332)
The ACL command docs are now found within a sub-dir like the
operator command docs. Updates to the ACL token commands to
accommodate token expiry have also been added.

The ACL API docs are now found within a sub-dir like the operator
API docs. The ACL docs now include the ACL roles endpoint as well
as updated ACL token endpoints for token expiration.

The configuration section is also updated to accommodate the new
ACL and server parameters for the new ACL features.
2022-08-31 16:13:47 +02:00

58 lines
1.5 KiB
Plaintext

---
layout: docs
page_title: 'Commands: acl token update'
description: |
The token update command is used to update existing ACL tokens.
---
# Command: acl token update
The `acl token update` command is used to update existing ACL tokens.
## Usage
```plaintext
nomad acl token update [options] <token_accessor_id>
```
The `acl token update` command requires an existing token's accessor ID.
## General Options
@include 'general_options_no_namespace.mdx'
## Create Options
- `-name`: Sets the human readable name for the ACL token.
- `-type`: Sets the type of token. Must be one of "client" (default), or
"management".
- `-global`: Toggles the global mode of the token. Global tokens are replicated
to all regions. Defaults false.
- `-policy`: Specifies a policy to associate with the token. Can be specified
multiple times, but only with client type tokens.
## Examples
Update an existing ACL token:
```shell-session
$ nomad acl token update -name="example-acl-token-updated" ef851ca0-b331-da5d-bbeb-7ede8f7c9151
Accessor ID = ef851ca0-b331-da5d-bbeb-7ede8f7c9151
Secret ID = 11d5348a-8768-5baa-6185-c154980e1488
Name = example-acl-token-updated
Type = client
Global = false
Create Time = 2022-08-23 12:16:09.680699039 +0000 UTC
Expiry Time = <never>
Create Index = 140
Modify Index = 151
Policies = [example-acl-policy]
Roles
ID Name
2fe0c403-4502-e99d-4c79-a2821355e66d example-acl-role-updated
```