The groups in the environment.

Table-Specific Information

We recommend using the built-in Client Application Developer role to read and write data for this table.

SELECT

Reading data from this table requires Read Group/dir:read:group permissions.

The add-in uses the PingOne Platform API to process WHERE clause conditions built with the following columns and operators.

• Id supports the following operators: =, IN.

All other filters are processed client-side within the add-in.

For example, the following queries are processed server-side:

SELECT * FROM Administrators.Groups WHERE Id = '13344eb0-1d6a-4715-9800-fce13f591925';
SELECT * FROM Administrators.Groups WHERE Id IN ('13344eb0-1d6a-4715-9800-fce13f591925', '76a9afd6-fd1c-4d55-9e84-7eea805f05c5');

In order to read the TotalUsersCount and TotalChildGroupsCount columns from this table, the Id column must be specified in the criteria as shown in the examples above, otherwise null values will be pushed in the result set for these columns.

INSERT

Creating data in this table requires Create Group/dir:create:group permission.

Refer to the query example below:

INSERT INTO Administrators.Groups (Name, Description, PopulationId, CustomData) VALUES ('My Group', 'My Group', '497d9767-00c1-4171-aa9d-f2eb62576463', '{\"my\":{\"custom\":\"data\"}}')

UPDATE

Updating data in this table requires Update Group/dir:update:group permission.

Refer to the query example below:

UPDATE Administrators.Groups SET Name = 'Test Group', Description = 'Test Group', CustomData = '{\"my\":\"data\"}' WHERE Id = '13344eb0-1d6a-4715-9800-fce13f591925';

DELETE

Deleting data from this table requires Delete Group/dir:delete:group permission.

Refer to the query example below:

DELETE FROM Administrators.Groups WHERE Id = '13344eb0-1d6a-4715-9800-fce13f591925'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The group identifier (UUID).
Name	String	False		The name of the group.
Description	String	False		The group's description.
PopulationId	String	False	Populations.Id	The identifier (UUID) of the population in which the group belongs to. If 'null' or empty, then it means the group belongs to the environment and not to a specific population in the environment.
DirectUsersCount	Integer	True		The number of users which are directly related with the group (don't belong to child groups).
DirectChildGroupsCount	Integer	True		The number of groups which are directly related with the group (are not child groups of child groups).
TotalUsersCount	Integer	True		The total number of users present in the group (including those from child groups).
TotalChildGroupsCount	Integer	True		The total number of groups present in the group (including child groups of child groups).
EnvironmentId	String	True	Information.Environments.Id	The identifier (UUID) of the environment in which the group exists.
CreatedAt	Datetime	True		The time at which the group was created.
UpdatedAt	Datetime	True		The time at which the group was last updated.
DynamicMembersFilter	String	False		A SCIM filter that determines which users are dynamically added to the group.
HasAdminRoles	Boolean	True		Boolean value indicating whether there are any administrator roles assigned to the group.
CustomData	String	False		User-defined custom data for the group. This information is represented in JSON format (aggregate).
SourceId	String	True		The group identifier as defined in the source/external system. Populated when the group is created with Just In Time (JIT) provisioning.
SourceType	String	True		The type of the source/external system from which the group originates. Populated when the group is created with Just In Time (JIT) provisioning. Possible values are: 'GATEWAY' and 'IDP'.