Users

Search users

Changed on

It will preform a simple search based on name and email matching the given query. Requires minimum 2 characters

get/api/admin/user-admin/search

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/user-admin/search
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Query parameters

qstring

The pattern to search in the username or email

Response

usersSearchSchema

idinteger required

The user id

namestring nullable

Name of the user

emailstring

Email of the user

usernamestring nullable

A unique username for the user

imageUrlstring

URL used for the user profile image

inviteLinkstring

If the user is actively inviting other users, this is the link that can be shared with other users

loginAttemptsinteger

How many unsuccessful attempts at logging in has the user made

emailSentboolean

Is the welcome email sent to the user or not

rootRoleinteger

Which root role this user is assigned

seenAtstring date-time nullable

The last time this user logged in

createdAtstring date-time

The user was created at this time

accountType'User' | 'Service Account'

A user is either an actual User or a Service Account

permissionsstring[]

Deprecated

scimIdstring nullable

The SCIM ID of the user, only present if managed by SCIM

seatTypestring nullable

The seat type of this user

companyRolestring nullable

The role of the user within the company.

productUpdatesEmailConsentboolean nullable

Whether the user has consented to receive product update emails.

activeSessionsinteger nullable

Count of active browser sessions for this user

deletedSessionsnumber

Experimental. The number of deleted browser sessions after last login

Example response

[
  {
    "id": 123,
    "name": "User",
    "email": "user@example.com",
    "username": "hunter",
    "imageUrl": "https://example.com/242x200.png",
    "inviteLink": "http://localhost:4242/invite-link/some-secret",
    "loginAttempts": 3,
    "rootRole": 1,
    "seenAt": "2023-06-30T11:42:00.345Z",
    "createdAt": "2023-06-30T11:41:00.123Z",
    "accountType": "User",
    "scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
    "seatType": "Regular",
    "companyRole": "Developer",
    "activeSessions": 2,
    "deletedSessions": 1
  }
]

Changes

  • 774670258f04Revision changes
    • breaking

      the response's body type changed from object to array for status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

  • 33b1dd229685Revision changes
    • info

      added the optional property // to the response with the status