Skip to main content

Lists a page of users

POST 
/api/web/v4/userspaged

Returns users for the provided search parameters. Caller requires the USERS:VIEW permission. The following searchByAttributes are supported:

  • userId: a String value (it matches both the User ID or any alias). Allowed operators are: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH.
  • groupId: a String value should be a UUID of an existing group. Allowed operator: EQUALS.
  • roleId: a String value should be a UUID of an existing role. Allowed operator: EQUALS.
  • authenticator: a String with value ENTRUST_SOFT_TOKEN or FIDO or GOOGLE_AUTHENTICATOR or GRID or HARDWARE_TOKEN or KBA or OTP or PASSWORD or SMARTCREDENTIALPUSH or TEMP_ACCESS_CODE or FACE. Allowed operator: EQUALS, NOT_EQUALS.
  • state: ACTIVE or INACTIVE. Allowed operator: EQUALS.
  • locked: 'true' is the only value allowed. Allowed operator: EQUALS.
  • userType: a String with value LOCAL or SYNC or EXTERNAL. Allowed operator: EQUALS.
  • registrationRequired: true or false. Allowed operator: EQUALS.
  • verificationRequired: true or false. Allowed operator: EQUALS.
  • lastAuthTime: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, EXISTS, NOT_EXISTS.
  • passwordExpirationTime: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, EXISTS, NOT_EXISTS.
  • organizationId: a String value should be a UUID of an existing organization. Allowed operator: EQUALS.
If you provide more than one search attribute, they are joined with an AND condition.

The orderByAttribute supports these attribute names: userId, state, lastAuthTime.

The following attributes can be optionally included in the returned User object: grids, tokens, smartCredentials, tempAccessCode, fidoTokens, userAttributeValues, userAliases, groups, oauthRoles, authenticatorLockoutStatus, organizations

Request​

Responses​

Successful