Get a list of groups that belong to the connected tenant with optional filtering.

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

ParameterDescription
AttributesA comma-separated list of attributes to include in the response. If not specified, all available attributes are returned by default.
CountThe maximum number of results to return per page.

Set to 0 to get only the total count without the results.
FilterThe query to filter results by, must be in the format of {parameter} {operator} {value}.

For example:
* userName eq "john"
* name.familyName eq "Marley"

For all the supported search operators, refer to IBM API documentation.
Full TextA text to search for across all records.
Return All PagesAutomatically fetch all resources, page by page.
Sort ByAn attribute name to sort the results by.
Sort OrderThe sort direction for the results. Must be used in conjunction with Sort By parameter.
Start IndexThe starting index for pagination.

​
Example Output

{
	"schemas": [
		"string"
	],
	"Resources": [
		{
			"schemas": [
				"string"
			],
			"id": "string",
			"displayName": "string",
			"bookmark": "string",
			"urn:ietf:params:scim:schemas:extension:ibm:2.0:Group": {
				"description": "string",
				"groupType": "standard",
				"membersPerPage": 0,
				"totalMembers": 0,
				"memberStartIndex": 0,
				"owners": [
					{
						"value": "string",
						"$ref": "string",
						"displayName": "string"
					}
				],
				"attachedPasswordPolicy": {
					"value": "string",
					"$ref": "string",
					"name": "string"
				}
			},
			"meta": {
				"resourceType": "string",
				"created": "string",
				"lastModified": "string",
				"location": "string",
				"deactivated": "api"
			},
			"members": [
				{
					"id": "string",
					"externalId": "string",
					"userName": "string",
					"title": "string",
					"name": {
						"formatted": "string",
						"familyName": "string",
						"givenName": "string",
						"middleName": "string"
					},
					"displayName": "string",
					"preferredLanguage": "string",
					"active": true,
					"emails": [
						{
							"value": "string",
							"type": "work"
						}
					],
					"addresses": [
						{
							"locality": "string",
							"country": "string",
							"type": "work",
							"streetAddress": "string",
							"postalCode": "string",
							"formatted": "string",
							"primary": true,
							"region": "string"
						}
					],
					"phoneNumbers": [
						{
							"value": "string",
							"type": "work"
						}
					],
					"type": "user",
					"urn:ietf:params:scim:schemas:extension:ibm:2.0:User": {
						"userCategory": "regular",
						"emailVerified": "string",
						"realm": "string",
						"unqualifiedUserName": "string",
						"twoFactorAuthentication": true,
						"pwdReset": true,
						"pwdChangedTime": 0,
						"pwdAccountLockedTime": "string",
						"pwdExpirationWarned": "string",
						"pwdFailureTime": [
							"string"
						],
						"pwdGraceUseTime": [
							"string"
						],
						"delegate": "string",
						"customAttributes": [
							{
								"name": "string",
								"values": [
									"string"
								]
							}
						],
						"linkedAccounts": [
							{
								"externalId": "string",
								"realm": "string"
							}
						],
						"lastLogin": "string",
						"lastLoginType": "string",
						"lastLoginRealm": "string",
						"lastMFA": [
							{
								"type": "string",
								"value": "string"
							}
						],
						"accountExpires": "string",
						"attachedPasswordPolicy": {
							"value": "string",
							"$ref": "string",
							"name": "string"
						}
					},
					"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
						"department": "string",
						"employeeNumber": "string",
						"manager": {
							"value": "string",
							"$ref": "string",
							"displayName": "string"
						}
					},
					"value": "string",
					"$ref": "string"
				}
			],
			"externalId": "string"
		}
	]
}

​
Workflow Library Example

List Groups with Ibm Security Verify and Send Results Via Email

Preview this Workflow on desktop