Creating a user group

Written by

Updated at October 17, 2024

Create a group
Add users to the group

Group users if you want to assign the same roles to them. For example, you may want to group employees with the same job duties or from the same department. You can group users by any attribute.

To form a group of users, create it and add users to it.

Create a group

Cloud Organization interface

CLI

Terraform

API

Log in as the organization administrator.
Go to Yandex Cloud Organization.
In the left-hand panel, select Groups .
In the top-right corner, click Create group and enter a group name and description.

The name must be unique within the organization and satisfy the relevant requirements:
- It must be from 1 to 63 characters long.
- It may contain lowercase Latin letters, numbers, and hyphens.
- It must start with a letter and cannot end with a hyphen.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

See the description of the command for creating a Cloud Organization user group:
```
yc organization-manager group create --help
```
To create a user group in Cloud Organization, run this command:
```
yc organization-manager group create \
  --name <group_name> \
  --organization-id <organization_ID> \
  --description <group_description>
```
Where:
- --name: User group name. This is a required parameter. The name must be unique within the organization and satisfy the relevant requirements:
  - It must be from 1 to 63 characters long.
  - It may contain lowercase Latin letters, numbers, and hyphens.
  - It must start with a letter and cannot end with a hyphen.
- --organization-id: Organization ID. This is an optional parameter.
- --description: Text description of the user group. This is an optional parameter.

Terraform allows you to quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. Configuration files store the infrastructure description in the HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Business Source License.

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

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

In the configuration file, describe the group parameters:
```
resource "yandex_organizationmanager_group" "my-group" {
  name            = "<group_name>"
  description     = "<group_description>"
  organization_id = "<organization_ID>"
}
```
Where:
- name: Group name. The name must be unique within the organization and satisfy the relevant requirements:
  - It must be from 1 to 63 characters long.
  - It may contain lowercase Latin letters, numbers, and hyphens.
  - It must start with a letter and cannot end with a hyphen.
- description: Group description. This is an optional parameter.
- organization_id: ID of the organization to add the group to.
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 the required resources. You can check the new resources and their configuration using the management console or this CLI command:
```
yc organization-manager group list \
  --organization-id <organization_ID>
```

Use the Group.create REST API method for the Group resource or the GroupService/Create gRPC API call.

Add users to the group

Cloud Organization interface

CLI

Terraform

API

Go to Yandex Cloud Organization.
In the left-hand panel, select Groups and click the line with the group name.
Go to the Members tab.
Click Add member.
In the Adding participants window, select users from the list or search by user. You can also add service accounts to a group.
Click Save.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

See the description of the command for adding members to the Cloud Organization user group:
```
yc organization-manager group add-members --help
```
To add members to a user group, run this command:
```
yc organization-manager group add-members \
  --name <group_name> \
  --organization-id <organization_ID> \
  --subject-id <member_ID>
```
Where:
- --name: User group name. This is a required parameter.
- --organization-id: Organization ID.
- --subject-id: ID of the member to add to the group.

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

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

In the configuration file, describe the new group members:

resource "yandex_organizationmanager_group_membership" "group-members" {
   group_id = "<group_ID>"
   members  = [
     "<member_1_ID>",
     "<member_2_ID>"
   ]
}

Where:

group_id: ID of the group to add the member to.
members: IDs of the members to add to the group.

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 the required resources. You can check the new resources and their configuration using the management console or this CLI command:
```
yc organization-manager group list-memebers \
  --name <group_name> \
  --organization-id <organization_ID>
```

Use the Group.updateMembers REST API method for the Group resource or the GroupService/UpdateMembers gRPC API call.

Creating a user group

Create a groupCreate a group

Add users to the groupAdd users to the group

Was the article helpful?

Create a group

Add users to the group