List Users

Get a list of users that belong to the current 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)
• readUsers (Read all users but not group memberships)
• readUsersGroupMembership (Read all users and group memberships)
• readUsersStandardGroupMembership (Read all users and standard group memberships)
• manageUsers (Manage all users)
• manageUsersInStandardGroups (Manage users in standard groups)

External Documentation

To learn more, visit the IBM Security Verify documentation.

​

Basic Parameters

Parameter	Description
Attributes	A comma-separated list of attributes to include in the response. If not specified, all available attributes are returned by default.
Count	The maximum number of results to return per page. Set to 0 to get only the total count without the results.
Filter	The 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 Text	A text to search for across all records.
Include Groups	Select whether to Include group membership information in the user response.
Return All Pages	Automatically fetch all resources, page by page.
Sort By	An attribute name to sort the results by.
Sort Order	The sort direction for the results. Must be used in conjunction with Sort By parameter.
Start Index	The starting index for pagination.

​

Advanced Parameters

Parameter	Description
Hashed	A comma-separated list of attribute names whose values should be hashed in the response.

​

Example Output

{
	"schemas": [
		"string"
	],
	"totalResults": 0,
	"startIndex": 0,
	"itemsPerPage": 0,
	"Resources": [
		{
			"schemas": [
				"string"
			],
			"id": "string",
			"externalId": "string",
			"meta": {
				"resourceType": "string",
				"created": "string",
				"lastModified": "string",
				"location": "string",
				"deactivated": "api"
			},
			"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"
				}
			],
			"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"
				}
			}
		}
	]
}