Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions website/content/api-docs/acl/auth-methods.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ The `/acl/auth-method` endpoints [create](#create-an-auth-method),
[list](#list-auth-methods) and [delete](#delete-an-auth-method)
ACL auth methods in Consul.

For more information on how to setup ACLs, please check
the [ACL tutorial](/consul/tutorials/security/access-control-setup-production).
For more information on how to setup ACLs, refer to the following resources:

- [Access control list (ACL) overview](/consul/docs/security/acl)
- [ACL tutorial](/consul/tutorials/security/access-control-setup-production)

## Create an Auth Method

Expand Down Expand Up @@ -439,7 +441,7 @@ listing and must be retrieved by the [auth method reading endpoint](#read-an-aut
]
```

## Methods to Specify Namespace <EnterpriseAlert inline />
## Methods to specify namespace <EnterpriseAlert inline />

Auth method create, read, update, and delete endpoints
support several methods for specifying the namespace of the auth method resource.
Expand Down
99 changes: 88 additions & 11 deletions website/content/api-docs/acl/binding-rules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ The `/acl/binding-rule` endpoints [create](#create-a-binding-rule),
[list](#list-binding-rules) and [delete](#delete-a-binding-rule) ACL binding
rules in Consul.

For more information on how to setup ACLs, please check
the [ACL tutorial](/consul/tutorials/security/access-control-setup-production).
For more information on how to setup ACLs, refer to the following resources:

- [Access control list (ACL) overview](/consul/docs/security/acl)
- [ACL tutorial](/consul/tutorials/security/access-control-setup-production)

## Create a Binding Rule

Expand Down Expand Up @@ -57,9 +59,9 @@ The corresponding CLI command is [`consul acl binding-rule create`](/consul/comm
```

- `BindType` `(string: <required>)` - Specifies the way the binding rule
affects a token created at login.
affects a token created at login. You can specify one of the following:

- `BindType=service` - The computed bind name value is used as an
- `service` - The computed bind name value is used as an
`ACLServiceIdentity.ServiceName` field in the token that is created.

<CodeBlockConfig heading="Equivalent payload for Consul token API endpoint">
Expand All @@ -78,7 +80,7 @@ The corresponding CLI command is [`consul acl binding-rule create`](/consul/comm

</CodeBlockConfig>

- `BindType=node` - The computed bind name value is used as an
- `node` - The computed bind name value is used as an
`ACLNodeIdentity.NodeName` field in the token that is created.

<CodeBlockConfig heading="Equivalent payload for Consul token API endpoint">
Expand All @@ -98,7 +100,7 @@ The corresponding CLI command is [`consul acl binding-rule create`](/consul/comm

</CodeBlockConfig>

- `BindType=role` - The computed bind name value is used as a `RoleLink.Name`
- `role` - The computed bind name value is used as a `RoleLink.Name`
field in the token that is created. This binding rule will only apply if a
role with the given name exists at login-time. If it does not then this
rule is ignored.
Expand All @@ -118,6 +120,29 @@ The corresponding CLI command is [`consul acl binding-rule create`](/consul/comm
```

</CodeBlockConfig>

- `templated-policy` - The bind name value is used as an
`ACLTemplatedPolicy.TemplateName` field in the token that is created. The computed
`BindVars` values are used in the `ACLTemplatedPolicy.TemplateVariables` field.

<CodeBlockConfig heading="Equivalent payload for Consul token API endpoint">

```json
{
"AccessorID": "<token accessor ID>",
"SecretID": "<token secret ID>",
"TemplatedPolicies": [
{
"TemplateName": "<template name>",
"TemplateVariables": {
"Name": "<name>"
}
}
]
}
```

</CodeBlockConfig>

- `BindName` `(string: <required>)` - The name to bind to a token at
login-time. What it binds to can be adjusted with different values of the
Expand All @@ -129,6 +154,20 @@ The corresponding CLI command is [`consul acl binding-rule create`](/consul/comm
prefixed-${serviceaccount.name}
```

- `BindVars` `(<ACLTemplatedPolicyVariables>)` - Specifies the templated policy
variables when `BindType` field is set to `templated-policy`. Consul populates
the `TemplatedPolicies.TemplateVariables` field with the computed `BindVars` values
in the token it creates. You can specify either a plain text string or templated
string using [HIL syntax](https://github.com/hashicorp/hil).
Consul interpolates templated strings with values that are usable by the `Selector` syntax.
For example:

```
"BindVars": {
"Name": "prefixed-${serviceaccount.name}"
}
```

- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the binding rule you create.
This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace).
Expand Down Expand Up @@ -270,9 +309,9 @@ The corresponding CLI command is [`consul acl binding-rule update`](/consul/comm
```

- `BindType` `(string: <required>)` - Specifies the way the binding rule
affects a token created at login.
affects a token created at login. You can specify one of the following:

- `BindType=service` - The computed bind name value is used as an
- `service` - The computed bind name value is used as an
`ACLServiceIdentity.ServiceName` field in the token that is created.

<CodeBlockConfig heading="Equivalent payload for Consul token API endpoint">
Expand All @@ -291,7 +330,7 @@ The corresponding CLI command is [`consul acl binding-rule update`](/consul/comm

</CodeBlockConfig>

- `BindType=node` - The computed bind name value is used as an
- `node` - The computed bind name value is used as an
`ACLNodeIdentity.NodeName` field in the token that is created.

<CodeBlockConfig heading="Equivalent payload for Consul token API endpoint">
Expand All @@ -311,7 +350,7 @@ The corresponding CLI command is [`consul acl binding-rule update`](/consul/comm

</CodeBlockConfig>

- `BindType=role` - The computed bind name value is used as a `RoleLink.Name`
- `role` - The computed bind name value is used as a `RoleLink.Name`
field in the token that is created. This binding rule will only apply if a
role with the given name exists at login-time. If it does not then this
rule is ignored.
Expand All @@ -331,6 +370,30 @@ The corresponding CLI command is [`consul acl binding-rule update`](/consul/comm
```

</CodeBlockConfig>

- `templated-policy` - Consul populates the `TemplatedPolicies.TemplateName` with
the value specified in the `BindName` field in the token that is created. Consul
also populates the `TemplatedPolicies.TemplateVariables` field with the computed
`BindVars` values.

<CodeBlockConfig heading="Equivalent payload for Consul token API endpoint">

```json
{
"AccessorID": "<token accessor ID>",
"SecretID": "<token secret ID>",
"TemplatedPolicies": [
{
"TemplateName": "<template name>",
"TemplateVariables": {
"Name": "<name>"
}
}
]
}
```

</CodeBlockConfig>

- `BindName` `(string: <required>)` - The name to bind to a token at
login-time. What it binds to can be adjusted with different values of the
Expand All @@ -342,6 +405,20 @@ The corresponding CLI command is [`consul acl binding-rule update`](/consul/comm
prefixed-${serviceaccount.name}
```

- `BindVars` `(<ACLTemplatedPolicyVariables>)` - Specifies the templated policy
variables when the `BindType` field is set to `templated-policy`. Consul
populates the `TemplatedPolicies.TemplateVariables` field with the computed
`BindVars` values in the token it creates. You can specify either a plain text
string or templated string using [HIL syntax](https://github.com/hashicorp/hil).
Consul interpolates templated strings with values that are usable by the `Selector`
syntax. For example:

```
"BindVars": {
"Name": "prefixed-${serviceaccount.name}"
}
```

- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the binding rule you update.
This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace).
Expand Down Expand Up @@ -486,7 +563,7 @@ $ curl --request GET http://127.0.0.1:8500/v1/acl/binding-rules
]
```

## Methods to Specify Namespace <EnterpriseAlert inline />
## Methods to specify namespace <EnterpriseAlert inline />

Binding rule create, read, update, and delete endpoints
support several methods for specifying the namespace of the auth method resource
Expand Down
8 changes: 5 additions & 3 deletions website/content/api-docs/acl/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ description: The /acl endpoints manage the Consul's ACL system.

The `/acl` endpoints are used to manage ACL tokens and policies in Consul, [bootstrap the ACL system](#bootstrap-acls) and [check ACL replication status](#check-acl-replication). There are additional pages for managing [tokens](/consul/api-docs/acl/tokens) and [policies](/consul/api-docs/acl/policies) with the `/acl` endpoints.

For more information on how to setup ACLs, please check
the [ACL tutorial](/consul/tutorials/security/access-control-setup-production).
For more information on how to setup ACLs, refer to the following resources:

- [Access control list (ACL) overview](/consul/docs/security/acl)
- [ACL tutorial](/consul/tutorials/security/access-control-setup-production)

## Bootstrap ACLs

Expand Down Expand Up @@ -506,7 +508,7 @@ $ curl \
}
```

## Methods to Specify Namespace <EnterpriseAlert inline />
## Methods to specify namespace <EnterpriseAlert inline />

Some ACL endpoints support several methods for specifying the namespace of the resource
with the following order of precedence:
Expand Down
2 changes: 1 addition & 1 deletion website/content/api-docs/acl/policies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ retrieved by the [policy reading endpoint](#read-a-policy)
]
```

## Methods to Specify Namespace <EnterpriseAlert inline />
## Methods to specify namespace <EnterpriseAlert inline />

ACL policy endpoints
support several methods for specifying the namespace of the ACL policy resources
Expand Down
81 changes: 76 additions & 5 deletions website/content/api-docs/acl/roles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,10 @@ description: The /acl/role endpoints manage Consul's ACL Roles.
The `/acl/role` endpoints [create](#create-a-role), [read](#read-a-role),
[update](#update-a-role), [list](#list-roles) and [delete](#delete-a-role) ACL roles in Consul.

For more information on how to setup ACLs, please check
the [ACL tutorial](/consul/tutorials/security/access-control-setup-production).
For more information on how to setup ACLs, refer to the following resources:

- [Access control list (ACL) overview](/consul/docs/security/acl)
- [ACL tutorial](/consul/tutorials/security/access-control-setup-production)

## Create a Role

Expand Down Expand Up @@ -55,9 +57,17 @@ The corresponding CLI command is [`consul acl role create`](/consul/commands/acl
linking roles internally by IDs, Consul enables policy renaming without
breaking tokens.

- `TemplatedPolicies` `(list of maps)` - The list of [templated policies](/consul/docs/security/acl#templated-policies)
that should be applied to the role.

- `TemplateName` `(string: <required>)` - The templated policy name.

- `TemplateVariables` `(map of strings|maps: <optional>)` - The templated policy variables. Not all templated policies
require variables.

- `ServiceIdentities` `(array<ServiceIdentity>)` - The list of [service
identities](/consul/docs/security/acl#service-identities) that should be
applied to the role. Added in Consul 1.5.0.
applied to the role.

- `ServiceName` `(string: <required>)` - The name of the service. The name
must be no longer than 256 characters, must start and end with a lowercase
Expand All @@ -71,7 +81,7 @@ The corresponding CLI command is [`consul acl role create`](/consul/commands/acl

- `NodeIdentities` `(array<NodeIdentity>)` - The list of [node
identities](/consul/docs/security/acl#node-identities) that should be
applied to the role. Added in Consul 1.8.1.
applied to the role.

- `NodeName` `(string: <required>)` - The name of the node. The name
must be no longer than 256 characters, must start and end with a lowercase
Expand Down Expand Up @@ -99,6 +109,17 @@ The corresponding CLI command is [`consul acl role create`](/consul/commands/acl
"Name": "node-read"
}
],
"TemplatedPolicies": [
{
"TemplateName": "builtin/service",
"TemplateVariables": {
"Name": "api"
}
},
{
"TemplateName": "builtin/dns"
}
],
"ServiceIdentities": [
{
"ServiceName": "web"
Expand Down Expand Up @@ -153,6 +174,19 @@ $ curl --request PUT \
"Datacenter": "dc2"
}
],
"TemplatedPolicies": [
{
"TemplateID": "00000000-0000-0000-0000-000000000003",
"TemplateName": "builtin/service",
"TemplateVariables": {
"Name": "api"
}
},
{
"TemplateID": "00000000-0000-0000-0000-000000000005",
"TemplateName": "builtin/dns"
}
],
"Hash": "mBWMIeX9zyUTdDMq8vWB0iYod+mKBArJoAhj6oPz3BI=",
"CreateIndex": 57,
"ModifyIndex": 57
Expand Down Expand Up @@ -223,6 +257,19 @@ $ curl --request GET http://127.0.0.1:8500/v1/acl/role/aa770e5b-8b0b-7fcf-e5a1-8
"Datacenter": "dc2"
}
],
"TemplatedPolicies": [
{
"TemplateID": "00000000-0000-0000-0000-000000000003",
"TemplateName": "builtin/service",
"TemplateVariables": {
"Name": "api"
}
},
{
"TemplateID": "00000000-0000-0000-0000-000000000005",
"TemplateName": "builtin/dns"
}
],
"Hash": "mBWMIeX9zyUTdDMq8vWB0iYod+mKBArJoAhj6oPz3BI=",
"CreateIndex": 57,
"ModifyIndex": 57
Expand Down Expand Up @@ -293,6 +340,19 @@ $ curl --request GET http://127.0.0.1:8500/v1/acl/role/name/example-role
"Datacenter": "dc2"
}
],
"TemplatedPolicies": [
{
"TemplateID": "00000000-0000-0000-0000-000000000003",
"TemplateName": "builtin/service",
"TemplateVariables": {
"Name": "api"
}
},
{
"TemplateID": "00000000-0000-0000-0000-000000000005",
"TemplateName": "builtin/dns"
}
],
"Hash": "mBWMIeX9zyUTdDMq8vWB0iYod+mKBArJoAhj6oPz3BI=",
"CreateIndex": 57,
"ModifyIndex": 57
Expand Down Expand Up @@ -379,6 +439,11 @@ The corresponding CLI command is [`consul acl role update`](/consul/commands/acl
"NodeName": "node-1",
"Datacenter": "dc2"
}
],
"TemplatedPolicies": [
{
"TemplateName": "builtin/dns"
}
]
}
```
Expand Down Expand Up @@ -414,6 +479,12 @@ $ curl --request PUT \
"Datacenter": "dc2"
}
],
"TemplatedPolicies": [
{
"TemplateID": "00000000-0000-0000-0000-000000000005",
"TemplateName": "builtin/dns"
}
],
"Hash": "OtZUUKhInTLEqTPfNSSOYbRiSBKm3c4vI2p6MxZnGWc=",
"CreateIndex": 14,
"ModifyIndex": 28
Expand Down Expand Up @@ -550,7 +621,7 @@ $ curl --request GET http://127.0.0.1:8500/v1/acl/roles
]
```

## Methods to Specify Namespace <EnterpriseAlert inline />
## Methods to specify namespace <EnterpriseAlert inline />

ACL role endpoints
support several methods for specifying the namespace of the ACL role resources
Expand Down
Loading