Search Tenant Users

Gets users for a tenant.

Notes

  • This API provides minimal user details.
  • To get the complete details of a user, use the Get User API.
get
/api/v2/tenants/{tenantId}/users/search

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Query Parameters

  • pageNointeger

    page no

    Default: 1

  • pageSizeinteger

    page size

    Default: 100

  • sortNamestring

    Sort order by field

    Default: id

  • isDescendingOrderboolean

    List in ascending or descending

  • queryStringstring

    Custom query string for filtering

  • uniqueIdstring

    ID of user.

  • loginNamestring

    Login name of user.

  • firstNamestring

    First name of user.

  • lastNamestring

    Last name of user.

  • mailIdstring

    User email.

  • startCreationDatestring

    Filter the users created within a date range. Provide the from date.Example: 2016-11-01T11:54:24 0000

  • endCreationDatestring

    Filter the users created within a date range. Provide the to date.Example: 2016-11-03T11:54:24 0000

  • startUpdationDatestring

    Filter the users updated within a date range. Provide the to date.Example: 2016-11-01T11:54:24 0000

  • endUpdationDatestring

    Filter the users updated within a date range. Provide the to date.Example: 2016-11-03T11:54:24 0000

  • statusstring

    To get a list of active users, provide status: active. To fetch list of inactive users, provide status: inactive.

00