A group is a specified collection of users. Groups are used to assign and manage permissions in a cohesive way for a collection of users at once. A group belongs to one organization only. Members of the same group share the same assigned permissions. When you assign a permission set to a group, all members of the group have those permissions.
Group accessibility
When you add a member to a group, all objects that can be accessed by the group are now accessible to the new member. All new members are granted the current permissions to each group provisioned object. When you remove a member from a group, the member that you removed cannot access those objects anymore.
Default groups
For OLP, two initial organization-wide groups are created by default:
| Group | Description | Permission set | User accounts |
|---|
| Org_Name administrators | Groups administrators of this organization and cannot be removed. | aiWARE administrator | User accounts with administrator roles are added to the administrator group of the default organization. |
| Org_Name users | Groups all users of this organization, including administrators. | aiWARE full access | All users are added to the users group, including admins. |
where Org_Name is the organization name.
If you are a member of the administrator group of an organization, you can view, create, delete, and modify groups for the organization, except you cannot delete the default groups. If you are not a member of the administrator group of an organization, you can view, create, delete, or modify only the groups that you have permission for.
View groups of an organization
Members of the admin group can view all groups of an organization.
View groups in Admin Center
- To access Admin Center, log in to your aiWARE administrative account. In the header bar, select
and then Admin Center
. - On the Admin Center's navigation, select Groups
. The list of groups that belong to the organization appears.
View groups via GraphQL
Groups can be viewed via the authGroup GraphQL mutation. An example mutation is:
query authGroup{
authGroup(id: "498a72dc-77b4-4c22-a658-26b7b23fb848"){
id
name
}
}
Create a group
To create a group, you need the group name and description. You can add members at a later time.
Create groups in Admin Center
- To access Admin Center, log in to your aiWARE administrative account. In the header bar, select
and then Admin Center
. - On the Admin Center's navigation, click Groups
. The list of groups that belong to the organization appears. - Select the group that you want to see the details of. The Group Details panel appears.
- Click Create group. The New Group panel appears.
- Follow the instructions on the wizard, and then click Create group.
A group is added to the Groups list.
Create groups via GraphQL
Create groups via the authGroupcreate GraphQL mutation. An example mutation is:
mutation authGroupCreate {
authGroupCreate(input: {
description: "test",
name: "test" }) {
id
name
}
}
Delete a group
Members of the admin group can delete a group from the organization.
[Warning] You cannot undelete a group. When you delete a group, all data access that members of the group had is also removed, which cannot be undone.
Delete groups in Admin Center
- To access Admin Center, log in to your aiWARE administrative account. In the header bar, select
and then Admin Center
. - On the Admin Center's navigation, click Groups
.
The list of groups that belong to the organization appears.
- Select the group that you want to see the details of.
The Group Details panel appears.
- On the Settings tab, click Delete group, and then confirm the deletion.
The group is deleted.
Delete groups via GraphQL
Delete groups via the authGroupdelete GraphQL mutation.
An example mutation is:
mutation authGroupDelete {
authGroupDelete(id: "10230e23-b9ca-4ace-b472-e3cad1e28cb2") {
id
}
}
View details of a group
Members of the admin group can view the details of a group.
Steps
- To access Admin Center, log in to your aiWARE administrative account. In the header bar, select
and then Admin Center
. - On the Admin Center's navigation, select Groups
. The list of groups that belong to the organization appears. - Select the group that you want to see the details of. The Group Details panel appears.
Edit details of a group
Members of the admin group can edit the group name or description.
Edit group details in Admin Center
- To access Admin Center, log in to your aiWARE administrative account. In the header bar, select
and then Admin Center
. - Admin Center's navigation, click Groups
.
The list of groups that belong to the organization appears.
- Select the group that you want to see the details of.
The Group Details panel appears.
- On the Settings tab, edit the group name or description, and then click Save Changes.
Edit group details via GraphQL
Edit group details via the authGroupUpdate GraphQL mutation.
An example mutation is:
mutation authGroupUpdate {
authGroupUpdate(
input: {
id: "10230e23-b9ca-4ace-b472-e3cad1e28cb2"
description: "test2"
name: "test2"
}
) {
id
name
}
}
Add or remove a member of the group
You can add or remove members of the group at any time. When you add a member to a group, all objects that can be accessed by the group are now accessible to the new member. All new members are granted the current permissions to each group-provisioned object.
Add or remove members in Admin Center
- To access Admin Center, log in to your aiWARE administrative account. In the header bar, select
and then Admin Center
. - On the Admin Center's navigation, click Groups
.
The list of groups that belong to the organization appears.
- Select the group that you want to see the details of.
The Group Details panel appears.
- Do one of the following:
- To add a member to the group, click Add Member.
The Add Members panel appears.
a. On the Add members box, type at least three characters of a user's first or last name. You can add more than one user account, and then select Add Members.
The new member is added to the group.
- To remove a member from the group, click Remove from Group.
The user is removed from the group.
Add or remove members via GraphQL
Add or remove members via the authGroupAddMembers GraphQL mutation.
An example mutation is:
mutation authGroupAddMembers($groupId: ID!, $memberId: ID!) {
authGroupAddMembers(
id: $groupId
members: [{ id: $memberId, memberType: User }]
) {
id
name
members {
records {
createdAt
member {
... on User {
name
}
}
}
}
}
}