Get Group

Get the details of a group and its associated members.

The response behavior depends on your tenant’s group size configuration:

• Large group support enabled: Retrieve status code 207 when groups have more than 10,000 members. Get the returned status code by selecting Include Full Response in the settings menu.
• Large group support disabled: Retrieve paginated results with up to 2,500 members per call using bookmarks.

At least one of the following entitlements is required for using this action:

• readUserGroups (Read users and groups)
• manageUserGroups (Manage users and groups)
• manageAllUserGroups (Synchronize users and groups)
• manageUserStandardGroups (Manage users and standard groups)
• readGroups (Read all groups but not their members)
• readStandardGroups (Read standard groups but not their members)
• readGroupMembers (Read all groups and their members)
• readStandardGroupMembers (Read standard groups and their members)
• manageGroups (Manage all groups but not their members)
• manageStandardGroups (Manage standard groups but not their members)
• manageGroupMembers (Manage all group and their members)
• manageStandardGroupMembers (Manage standard groups and their members)

External Documentation

To learn more, visit the IBM Security Verify documentation.

​

Parameters

Parameter	Description
ID	The unique identifier of the group to get details on.
Member Attributes	A comma-separated list of member attributes to include in the response.
Member Count	The maximum number of group members to return. Set to 0 to return only the total count, excluding the list of members.
Member Start Index	The starting index for paginated member results.
Membership Type	Selects the type of group members to retrieve.
Next Page	A pagination token for retrieving the next page of members. Obtained from previous response when results are paginated.

​

Example Output

{
	"schemas": [
		"string"
	],
	"id": "string",
	"displayName": "string",
	"urn:ietf:params:scim:schemas:extension:ibm:2.0:Group": {
		"description": "string",
		"groupType": "standard",
		"totalMembers": 0,
		"attachedPasswordPolicy": {
			"value": "string",
			"$ref": "string",
			"name": "string"
		}
	},
	"meta": {
		"resourceType": "string",
		"created": "string",
		"lastModified": "string",
		"location": "string",
		"deactivated": "api"
	},
	"externalId": "string"
}