Configuring access permissions for a digital signature key pair

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

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

If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

To assign a role for an asymmetric digital signature key pair:

1. View the description of the CLI command for assigning roles:

   yc kms asymmetric-signature-key add-access-binding --help
   

2. Get a list of digital signature key pairs with their IDs:

   yc kms asymmetric-signature-key list
   

3. Get the ID of the user, service account, user group, organization, or identity federation to which (or to the users of which) you are assigning a role.

4. To assign a role, run this command:

   yc kms asymmetric-signature-key add-access-binding \
     --id <key_pair_ID> \
     --role <role> \
     --subject <subject_type>:<subject_ID>
   

   Where:

   • --id: ID of the digital signature key pair.

   • --role: Role.

   • --subject: Subject getting the role.

     Subject designations

     To indicate a subject, use the --subject parameter in <subject_type>:<ID> format. For some subject types, the Yandex Cloud CLI provides separate parameters instead of --subject, where you only need to specify the subject name or ID without the type. Possible subject designations and matching CLI parameters:

     Subject type	Subject designation	Yandex Cloud CLI parameter
     userAccount	userAccount:<user_ID>	--user-account-id or --user-yandex-login
     serviceAccount	serviceAccount:<service_account_ID>	--service-account-id or --service-account-name
     federatedUser	federatedUser:<user_ID>	--user-account-id
     group	group:<group_ID>	--group-members
     system	system:allAuthenticatedUsers (All authenticated users group)	--all-authenticated-users
     	system:allUsers (All users group)	—
     	system:group:organization:<organization_ID>:users (All users in organization X group)	--organization-users
     	system:group:federation:<federation_ID>:users (All users in federation N group)	--federation-users
     	system:group:userpool:<pool_ID>:users (All users in userpool P group)	—

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 guides on the Terraform website or its mirror.

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

To manage infrastructure using Terraform under a service account or user accounts (a Yandex account, a federated account, or a local user), authenticate using the appropriate method.

To assign a role for an asymmetric digital signature key pair using Terraform:

1. In the Terraform configuration file, describe the resources you want to create:

   resource "yandex_kms_asymmetric_signature_key_iam_member" "key-viewers" {
     asymmetric_signature_key_id  = "<key_pair_ID>"
   
     role   = "<role_1>"
     member = "<subject_type>:<subject_ID>"
   }
   

   Where:

   • asymmetric_signature_key_id: ID of the digital signature key pair.

   • role: Role.

   • member: Subject getting the role.

     Subject designations

     To indicate a subject, use a combination of its type and unique ID, i.e., <subject_type>:<ID>. Here is how you can designate a subject:

     Subject type	Subject designation
     userAccount	userAccount:<user_ID>
     serviceAccount	serviceAccount:<service_account_ID>
     federatedUser	federatedUser:<user_ID>
     group	group:<group_ID>
     system	system:allAuthenticatedUsers (All authenticated users group)
     	system:allUsers (All users group)
     	system:group:organization:<organization_ID>:users (All users in organization X group)
     	system:group:federation:<federation_ID>:users (All users in federation N group)
     	system:group:userpool:<pool_ID>:users (All users in userpool P group)

   For more on the properties of the yandex_kms_asymmetric_signature_key resource, see this provider guide.

2. Create the resources:

   1. In the terminal, navigate to the configuration file directory.

   2. Make sure the configuration is correct using this command:

      terraform validate
      

      If the configuration is valid, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors in the configuration.

   4. Apply the configuration changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

   Terraform will create all the required resources. You can check the new resources using this CLI command:

   yc kms asymmetric-signature-key list-access-bindings <key_pair_ID>
   

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

• ADD value in the access_binding_deltas[].action parameter to add a role.

• Role in the access_binding_deltas[].access_binding.role_id parameter.

• ID of the subject getting the role in the access_binding_deltas[].access_binding.subject.id parameter.

• Type of the subject getting the role in the access_binding_deltas[].access_binding.subject.type parameter.

  Subject designations

  To indicate a subject, use a combination of its type and unique ID in the subject.type and subject.id fields of the request. Here are possible combinations:

  subject.type	subject.id
  userAccount	<user_ID>
  serviceAccount	<service_account_ID>
  federatedUser	<user_ID>
  group	<group_ID>
  system	allAuthenticatedUsers (All authenticated users group)
  	allUsers (All users group)
  	group:organization:<organization_ID>:users (All users in organization X group)
  	group:federation:<federation_ID>:users (All users in federation N group)
  	group:userpool:<pool_ID>:users (All users in userpool P group)

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

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

If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

To assign multiple roles for a digital signature key pair:

1. Make sure the key pair has no roles assigned that you would not want to lose:

   yc kms asymmetric-signature-key list-access-bindings \
     --id <key_pair_ID>
   

2. View the description of the CLI command for assigning roles:

   yc kms asymmetric-signature-key set-access-bindings --help
   

3. Get a list of digital signature key pairs with their IDs:

   yc kms asymmetric-signature-key list
   

4. Get the ID of the user, service account, user group, organization, or identity federation to which (or to the users of which) you are assigning roles.

5. To assign roles, run this command:

   yc kms asymmetric-signature-key set-access-bindings \
     --id <key_pair_ID> \
     --access-binding role=<role>,subject=<subject_type>:<subject_ID>
   

   Where:

   • --id: ID of the digital signature key pair.

   • Where --access-binding is the role and the subject the role is assigned to.

     Subject designations

     To indicate a subject, use the --subject parameter in <subject_type>:<ID> format. For some subject types, the Yandex Cloud CLI provides separate parameters instead of --subject, where you only need to specify the subject name or ID without the type. Possible subject designations and matching CLI parameters:

     Subject type	Subject designation	Yandex Cloud CLI parameter
     userAccount	userAccount:<user_ID>	--user-account-id or --user-yandex-login
     serviceAccount	serviceAccount:<service_account_ID>	--service-account-id or --service-account-name
     federatedUser	federatedUser:<user_ID>	--user-account-id
     group	group:<group_ID>	--group-members
     system	system:allAuthenticatedUsers (All authenticated users group)	--all-authenticated-users
     	system:allUsers (All users group)	—
     	system:group:organization:<organization_ID>:users (All users in organization X group)	--organization-users
     	system:group:federation:<federation_ID>:users (All users in federation N group)	--federation-users
     	system:group:userpool:<pool_ID>:users (All users in userpool P group)	—

   Provide a separate --access-binding parameter for each role. Here is an example:

   yc kms asymmetric-signature-key set-access-bindings \
     --id <key_pair_ID> \
     --access-binding role=<role1>,subject=<subject_type>:<subject_ID> \
     --access-binding role=<role2>,subject=<subject_type>:<subject_ID> \
     --access-binding role=<role3>,subject=<subject_type>:<subject_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 guides on the Terraform website or its mirror.

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

To manage infrastructure using Terraform under a service account or user accounts (a Yandex account, a federated account, or a local user), authenticate using the appropriate method.

To assign multiple roles for an asymmetric digital signature key pair using Terraform:

1. In the Terraform configuration file, describe the resources you want to create:

   # Role 1
   resource "yandex_kms_asymmetric_signature_key_iam_member" "key-viewers" {
     asymmetric_signature_key_id = "<key_pair_ID>"
   
     role   = "<role_1>"
     member = "<subject_type>:<subject_ID>"
   }
   
   # Role 2
   resource "yandex_kms_asymmetric_signature_key_iam_member" "key-editors" {
     asymmetric_signature_key_id = "<key_pair_ID>"
     
     role   = "<role_2>"
     member = "<subject_type>:<subject_ID>"
   }
   

   Where:

   • asymmetric_signature_key_id: ID of the digital signature key pair.

   • role: Role.

   • member: Subject getting the role.

     Subject designations

     To indicate a subject, use a combination of its type and unique ID, i.e., <subject_type>:<ID>. Here is how you can designate a subject:

     Subject type	Subject designation
     userAccount	userAccount:<user_ID>
     serviceAccount	serviceAccount:<service_account_ID>
     federatedUser	federatedUser:<user_ID>
     group	group:<group_ID>
     system	system:allAuthenticatedUsers (All authenticated users group)
     	system:allUsers (All users group)
     	system:group:organization:<organization_ID>:users (All users in organization X group)
     	system:group:federation:<federation_ID>:users (All users in federation N group)
     	system:group:userpool:<pool_ID>:users (All users in userpool P group)

   For more on the properties of the yandex_kms_asymmetric_signature_key resource, see this provider guide.

2. Create the resources:

   1. In the terminal, navigate to the configuration file directory.

   2. Make sure the configuration is correct using this command:

      terraform validate
      

      If the configuration is valid, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors in the configuration.

   4. Apply the configuration changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

   Terraform will create all the required resources. You can check the new resources using this CLI command:

   yc kms asymmetric-signature-key list-access-bindings <key_pair_ID>
   

Use the SetAccessBindings method for the AsymmetricSignatureKey resource or the AsymmetricSignatureKeyService/SetAccessBindings gRPC API call. In your request, provide an array of objects, each one matching a particular role and containing the following data:

• Role in the access_bindings[].role_id parameter.

• ID of the subject getting the roles in the access_bindings[].subject.id parameter.

• Type of the subject getting the roles in the access_bindings[].subject.type parameter.

  Subject designations

  To indicate a subject, use a combination of its type and unique ID in the subject.type and subject.id fields of the request. Here are possible combinations:

  subject.type	subject.id
  userAccount	<user_ID>
  serviceAccount	<service_account_ID>
  federatedUser	<user_ID>
  group	<group_ID>
  system	allAuthenticatedUsers (All authenticated users group)
  	allUsers (All users group)
  	group:organization:<organization_ID>:users (All users in organization X group)
  	group:federation:<federation_ID>:users (All users in federation N group)
  	group:userpool:<pool_ID>:users (All users in userpool P group)