Creating a user 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
To create a group, you need at least the organization-manager.editor
role for the organization.
-
Log in to Yandex Identity Hub
. -
In the left-hand panel, select
Groups. -
In the top-right corner of the page, click
Create group. -
Enter a name and description for the group.
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.
-
Click Create group.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID>
command. You can also set a different folder for any specific command using the --folder-name
or --folder-id
parameter.
-
See the description of the command for creating a Identity Hub user group:
yc organization-manager group create --help
-
To create a user group in Identity Hub, 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.
-
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the relevant documentation on the Terraform
If you do not have Terraform yet, 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 the resources:
-
In the terminal, go to the directory where you edited the configuration file.
-
Make sure the configuration file is correct using this command:
terraform validate
If the configuration is correct, you will get this message:
Success! The configuration is valid.
-
Run this command:
terraform plan
You will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.
-
Apply the changes:
terraform apply
-
Type
yes
and press Enter to confirm the changes.
Terraform will create all the required resources. You can check the new resources and their settings 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
-
Log in to Yandex Identity Hub
. -
In the left-hand panel, select
Groups and click the row with the name of the group you need. -
Go to the Members tab.
-
Click Add member.
-
In the window that opens, select the needed users or service accounts. You may want to use the search feature.
-
Click Save.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID>
command. You can also set a different folder for any specific command using the --folder-name
or --folder-id
parameter.
-
See the description of the command for adding members to the Identity Hub 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.
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the relevant documentation on the Terraform
If you do not have Terraform yet, 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:
-
In the terminal, go to the directory where you edited the configuration file.
-
Make sure the configuration file is correct using this command:
terraform validate
If the configuration is correct, you will get this message:
Success! The configuration is valid.
-
Run this command:
terraform plan
You will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.
-
Apply the changes:
terraform apply
-
Type
yes
and press Enter to confirm the changes.
Terraform will create all the required resources. You can check the new resources and their settings 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.