Files
nomad/website/content/docs/commands/acl/index.mdx
Piotr Kazmierczak cdc308a0eb wi: new endpoint for listing workload attached ACL policies (#25588)
This introduces a new HTTP endpoint (and an associated CLI command) for querying
ACL policies associated with a workload identity. It allows users that want
to learn about the ACL capabilities from within WI-tasks to know what sort of
policies are enabled.

---------

Co-authored-by: Tim Gross <tgross@hashicorp.com>
Co-authored-by: Aimee Ukasick <aimee.ukasick@hashicorp.com>
2025-05-19 19:54:12 +02:00

83 lines
4.3 KiB
Plaintext

---
layout: docs
page_title: 'nomad acl command reference'
description: |
The `nomad acl` command interacts with access control list (ACL) policies, roles, tokens, binding rules, and authentication methods.
---
# `nomad acl` command reference
The `acl` command is used to interact with ACL policies and tokens. Learn more
about using Nomad's ACL system in the [Secure Nomad with Access Control
guide][secure-guide].
In [federated][] clusters, all ACL updates are forwarded to the
[`authoritative_region`][] and replicated to non-authoritative regions. This
requires that ACLs have been bootstrapped in the authoritative region.
## Usage
Usage: `nomad acl <subcommand> [options]`
Run `nomad acl <subcommand> -h` for help on that subcommand. The following
subcommands are available:
- [`acl bootstrap`][bootstrap] - Bootstrap the initial ACL token
- [`acl auth-method create`][authmethodcreate] - Create a new ACL auth method
- [`acl auth-method delete`][authmethoddelete] - Delete an existing ACL auth method
- [`acl auth-method info`][authmethodinfo] - Fetch information on an existing ACL auth method
- [`acl auth-method list`][authmethodlist] - List available ACL auth methods
- [`acl auth-method update`][authmethodupdate] - Update existing ACL auth method
- [`acl binding-rule create`][bindingrulecreate] - Create a new ACL binding rule
- [`acl binding-rule delete`][bindingruledelete] - Delete an existing ACL binding rule
- [`acl binding-rule info`][bindingruleinfo] - Fetch information on an existing ACL binding rule
- [`acl binding-rule list`][bindingrulelist] - List available ACL binding rules
- [`acl binding-rule update`][bindingruleupdate] - Update existing ACL binding rule
- [`acl policy apply`][policyapply] - Create or update ACL policies
- [`acl policy delete`][policydelete] - Delete an existing ACL policies
- [`acl policy info`][policyinfo] - Fetch information on an existing ACL policy
- [`acl policy list`][policylist] - List available ACL policies
- [`acl policy self`][policyself] - List ACL policies attached to the current workload
- [`acl role create`][rolecreate] - Create a new ACL role
- [`acl role delete`][roledelete] - Delete an existing ACL role
- [`acl role info`][roleinfo] - Get info on an existing ACL role
- [`acl role list`][rolelist] - List available ACL roles
- [`acl role update`][roleupdate] - Update existing ACL role
- [`acl token create`][tokencreate] - Create new ACL token
- [`acl token delete`][tokendelete] - Delete an existing ACL token
- [`acl token info`][tokeninfo] - Get info on an existing ACL token
- [`acl token list`][tokenlist] - List available ACL tokens
- [`acl token self`][tokenself] - Get info on self ACL token
- [`acl token update`][tokenupdate] - Update existing ACL token
[bootstrap]: /nomad/docs/commands/acl/bootstrap
[authmethodcreate]: /nomad/docs/commands/acl/auth-method/create
[authmethoddelete]: /nomad/docs/commands/acl/auth-method/delete
[authmethodinfo]: /nomad/docs/commands/acl/auth-method/info
[authmethodlist]: /nomad/docs/commands/acl/auth-method/list
[authmethodupdate]: /nomad/docs/commands/acl/auth-method/update
[bindingrulecreate]: /nomad/docs/commands/acl/binding-rule/create
[bindingruledelete]: /nomad/docs/commands/acl/binding-rule/delete
[bindingruleinfo]: /nomad/docs/commands/acl/binding-rule/info
[bindingrulelist]: /nomad/docs/commands/acl/binding-rule/list
[bindingruleupdate]: /nomad/docs/commands/acl/binding-rule/update
[policyapply]: /nomad/docs/commands/acl/policy/apply
[policydelete]: /nomad/docs/commands/acl/policy/delete
[policyinfo]: /nomad/docs/commands/acl/policy/info
[policylist]: /nomad/docs/commands/acl/policy/list
[policyself]: /nomad/docs/commands/acl/policy/self
[tokencreate]: /nomad/docs/commands/acl/token/create
[tokenupdate]: /nomad/docs/commands/acl/token/update
[tokendelete]: /nomad/docs/commands/acl/token/delete
[tokeninfo]: /nomad/docs/commands/acl/token/info
[tokenlist]: /nomad/docs/commands/acl/token/list
[tokenself]: /nomad/docs/commands/acl/token/self
[rolecreate]: /nomad/docs/commands/acl/role/create
[roleupdate]: /nomad/docs/commands/acl/role/update
[roledelete]: /nomad/docs/commands/acl/role/delete
[roleinfo]: /nomad/docs/commands/acl/role/info
[rolelist]: /nomad/docs/commands/acl/role/list
[secure-guide]: /nomad/tutorials/access-control
[federated]: /nomad/tutorials/manage-clusters/federation
[`authoritative_region`]: /nomad/docs/configuration/server#authoritative_region