Configuring access permissions for a symmetric encryption key

Written by

Updated at May 5, 2025

Assigning a role
Assigning multiple roles

You can grant access to a symmetric key to a user, service account, or user group. To do this, assign roles for the key. To choose the ones you need, learn about the service's roles.

Assigning a role

Management console

CLI

Terraform

API

In the management console, select the folder where the secret is stored.
From the list of services, select Key Management Service.
In the left-hand panel, select Symmetric keys.
Click the name of the key you need.
Go to Access bindings and click Assign roles.
Select the group, user, or service account you want to grant access to the key.
Click Add role and select the required roles.
Click Save.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

To assign a role for a symmetric key:

See the description of the CLI role assignment command:
```
yc kms symmetric-key add-access-binding --help
```
Get a list of symmetric keys with their IDs:
```
yc kms symmetric-key list
```
Get the ID of the user, service account, or user group you are assigning a role to.

Use one of these commands to assign a role:

To a user:

yc kms symmetric-key add-access-binding \
   --id <key_ID> \
   --role <role> \
   --user-account-id <user_ID>

To a federated user:

yc kms symmetric-key add-access-binding \
   --id <key_ID> \
   --role <role> \
   --subject federatedUser:<user_ID>

To a service account:

yc kms symmetric-key add-access-binding \
   --id <key_ID> \
   --role <role> \
   --service-account-id <service_account_ID>

To a user group:

yc kms symmetric-key add-access-binding \
   --id <key_ID> \
   --role <role> \
   --subject group:<group_ID>

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the documentation on the Terraform website or mirror website.

If you do not have Terraform yet, install it and configure its Yandex Cloud provider.

To assign a role for a symmetric encryption key using Terraform:

In the Terraform configuration file, define the parameters of the resources you want to create:
```
resource "yandex_kms_symmetric_encryption_key_iam_member" "key-viewers" {
  symmetric_encryption_key_id = "<key_ID>"

  role    = "<role>"
  members = ["<subject_type>:<subject_ID>","<subject_type>:<subject_ID>"]
}
```
Where:
- symmetric_encryption_key_id: ID of the symmetric encryption key.
- role: Role.
- members: List of types and IDs of subjects getting the role. Use this format: userAccount:<user_ID> or serviceAccount:<service_account_ID>.
For more information about the yandex_kms_symmetric_encryption_key_iam_member resource properties, see the provider documentation.
Create resources:
1. In the terminal, change to the folder where you edited the configuration file.
2. Make sure the configuration file is correct using the command:
```
terraform validate
```
  If the configuration is correct, the following message is returned:
```
Success! The configuration is valid.
```
3. Run the command:
```
terraform plan
```
  The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.
4. Apply the configuration changes:
```
terraform apply
```
5. Confirm the changes: type yes in the terminal and press Enter.
Terraform will create all required resources. You can check the new resources using this CLI command:
```
yc kms symmetric-key list-access-bindings <key_ID>
```

Use the updateAccessBindings method for the SymmetricKey resource or the SymmetricKeyService/UpdateAccessBindings gRPC API call and provide the following in the request:

ADD value in the accessBindingDeltas[].action parameter to add a role.
Role in the accessBindingDeltas[].accessBinding.roleId parameter.
ID of the subject you are assigning the role to in the accessBindingDeltas[].accessBinding.subject.id parameter.
Type of the subject you are assigning the role to in the accessBindingDeltas[].accessBinding.subject.type parameter.

Assigning multiple roles

Management console

CLI

Terraform

API

In the management console, select the folder where the secret is stored.
From the list of services, select Key Management Service.
In the left-hand panel, select Symmetric keys.
Click the name of the key you need.
Go to Access bindings and click Assign roles.
Select the group, user, or service account you want to grant access to the key.
Click Add role and select the required roles.
Click Save.

Alert

The set-access-bindings command for assigning multiple roles completely rewrites access permissions for the resource. All current resource roles will be deleted.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

To assign multiple roles for a symmetric encryption key:

Make sure the symmetric key has no roles assigned that you would not want to lose:
```
yc kms symmetric-key list-access-bindings \
   --id <key_ID>
```
See the description of the CLI role assignment command:
```
yc kms symmetric-key set-access-bindings --help
```
Get a list of symmetric encryption keys with their IDs:
```
yc kms symmetric-key list
```
Get the ID of the user, service account, or user group you are assigning roles to.

Use one of the commands below to assign roles:

To a Yandex account user:

yc kms symmetric-key set-access-bindings \
   --id <key_ID> \
   --access-binding role=<role>,user-account-id=<user_ID>

To a federated user:

yc kms symmetric-key set-access-bindings \
   --id <key_ID> \
   --access-binding role=<role>,subject=federatedUser:<user_ID>

To a service account:

yc kms symmetric-key set-access-bindings \
   --id <key_ID> \
   --access-binding role=<role>,service-account-id=<service_account_ID>

To a user group:

yc kms symmetric-key set-access-bindings \
   --id <key_ID> \
   --access-binding role=<role>,subject=group:<group_ID>

Provide a separate --access-binding flag for each role. For example:

yc kms symmetric-key set-access-bindings \
  --id <key_ID> \
  --access-binding role=<role_1>,service-account-id=<service_account_ID> \
  --access-binding role=<role_2>,service-account-id=<service_account_ID> \
  --access-binding role=<role_3>,service-account-id=<service_account_ID>

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the documentation on the Terraform website or mirror website.

If you do not have Terraform yet, install it and configure its Yandex Cloud provider.

To assign multiple roles for a symmetric encryption key using Terraform:

In the Terraform configuration file, define the parameters of the resources you want to create:
```
# Role 1
resource "yandex_kms_symmetric_encryption_key_iam_member" "key-viewers" {
  symmetric_encryption_key_id = "<key_ID>"

  role    = "<role_1>"
  members = ["<subject_type>:<subject_ID>"]
}

# Role 2
resource "yandex_kms_symmetric_encryption_key_iam_member" "key-editors" {
  symmetric_encryption_key_id = "<key_ID>"

  role    = "<role_2>"
  members = ["<subject_type>:<subject_ID>"]
}
```
Where:
- symmetric_encryption_key_id: ID of the symmetric encryption key.
- role: Role.
- members: List of types and IDs of subjects getting the role. Use this format: userAccount:<user_ID> or serviceAccount:<service_account_ID>.
For more information about the yandex_kms_symmetric_encryption_key_iam_member resource properties, see the provider documentation.
Create resources:
1. In the terminal, change to the folder where you edited the configuration file.
2. Make sure the configuration file is correct using the command:
```
terraform validate
```
  If the configuration is correct, the following message is returned:
```
Success! The configuration is valid.
```
3. Run the command:
```
terraform plan
```
  The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.
4. Apply the configuration changes:
```
terraform apply
```
5. Confirm the changes: type yes in the terminal and press Enter.
Terraform will create all required resources. You can check the new resources using this CLI command:
```
yc kms symmetric-key list-access-bindings <key_ID>
```

Alert

The setAccessBindings method for assigning multiple roles completely rewrites access permissions for the resource. All current resource roles will be deleted.

Use the setAccessBindings method for the SymmetricKey resource or the SymmetricKeyService/SetAccessBindings gRPC API call. In your request, provide an array of objects, each one corresponding to a particular role and containing the following data:

Role in the accessBindings[].roleId parameter.
ID of the subject getting the roles in the accessBindings[].subject.id parameter.
Type of the subject getting the roles in the accessBindings[].subject.type parameter.

Configuring access permissions for a symmetric encryption key

Assigning a roleAssigning a role

Assigning multiple rolesAssigning multiple roles

Was the article helpful?

Assigning a role

Assigning multiple roles