Search users | Unleash Documentation

import requests
url = "https://app.unleash-instance.example.com/api/admin/user-admin/search"
headers = {"Authorization": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "users": [
    {
      "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,
      "emailSent": false,
      "rootRole": 1,
      "seenAt": "2023-06-30T11:42:00.345Z",
      "createdAt": "2023-06-30T11:41:00.123Z",
      "accountType": "User",
      "permissions": [
        "string"
      ],
      "scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
      "seatType": "Regular",
      "activeSessions": 2,
      "deletedSessions": 1
    }
  ],
  "rootRoles": [
    {
      "id": 9,
      "type": "root",
      "name": "Editor",
      "description": "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.",
      "project": "default"
    }
  ]
}

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

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Query parameters

qstringOptional

The pattern to search in the username or email

Response

usersSchema

userslist of objects

A list of users in the Unleash instance.

rootRoleslist of objects or null

A list of root roles in the Unleash instance.

Authentication

Query parameters

Response

Errors