Search users

GET 
<your-unleash-url>/api/admin/user-admin/search

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

Request

Query Parameters

q string

The pattern to search in the username or email

Responses

200

usersSchema

application/json

Schema

Schema

users object[]required
A list of users in the Unleash instance.
Array [
idintegerrequired
The user id
Example: 123
isAPIbooleandeprecated
Deprecated in v5. Used internally to know which operations the user should be allowed to perform
Example: true
namestringnullable
Name of the user
Example: User
emailstring
Email of the user
Example: user@example.com
usernamestringnullable
A unique username for the user
Example: hunter
imageUrlstring
URL used for the user profile image
Example: https://example.com/242x200.png
inviteLinkstring
If the user is actively inviting other users, this is the link that can be shared with other users
Example: http://localhost:4242/invite-link/some-secret
loginAttemptsinteger
How many unsuccessful attempts at logging in has the user made
Example: 3
emailSentboolean
Is the welcome email sent to the user or not
Example: false
rootRoleinteger
Which root role this user is assigned
Example: 1
seenAtdate-timenullable
The last time this user logged in
Example: 2023-06-30T11:42:00.345Z
createdAtdate-time
The user was created at this time
Example: 2023-06-30T11:41:00.123Z
accountTypestring
A user is either an actual User or a Service Account
Example: User
permissionsstring[]
Deprecated
scimIdstringnullable
The SCIM ID of the user, only present if managed by SCIM
Example: 01HTMEXAMPLESCIMID7SWWGHN6
activeSessionsintegernullable
Count of active browser sessions for this user
Example: 2
deletedSessionsnumber
Experimental. The number of deleted browser sessions after last login
Example: 1
]
rootRoles object[]
A list of root roles in the Unleash instance.
Array [
idintegerrequired
The role id
Example: 9
typestringrequired
A role can either be a global root role (applies to all projects) or a project role
Example: root
namestringrequired
The name of the role
Example: Editor
descriptionstring
A more detailed description of the role and what use it's intended for
Example: 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.
projectstringnullable
What project the role belongs to
Example: default
]

Example (auto)

{
  "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",
      "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"
    }
  ]
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '<your-unleash-url>/api/admin/user-admin/search' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

q — query

ResponseClear

Click the Send API Request button above and see the response here!