Search users

GET 
/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 [

id integerrequired

The user id

Example: 123

isAPI booleandeprecated

Deprecated in v5. Used internally to know which operations the user should be allowed to perform

Example: true

name stringnullable

Name of the user

Example: User

email string

Email of the user

Example: user@example.com

username stringnullable

A unique username for the user

Example: hunter

imageUrl string

URL used for the user profile image

Example: https://example.com/242x200.png

inviteLink string

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

loginAttempts integer

How many unsuccessful attempts at logging in has the user made

Example: 3

emailSent boolean

Is the welcome email sent to the user or not

Example: false

rootRole integer

Which root role this user is assigned

Example: 1

seenAt date-timenullable

The last time this user logged in

Example: 2023-06-30T11:42:00.345Z

createdAt date-time

The user was created at this time

Example: 2023-06-30T11:41:00.123Z

accountType string

A user is either an actual User or a Service Account

Example: User

permissions string[]

Deprecated

scimId stringnullable

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

Example: 01HTMEXAMPLESCIMID7SWWGHN6

]

rootRoles

object[]

A list of root roles in the Unleash instance.

Array [

id integerrequired

The role id

Example: 9

type stringrequired

A role can either be a global root role (applies to all projects) or a project role

Example: root

name stringrequired

The name of the role

Example: Editor

description string

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.

project stringnullable

What project the role belongs to

Example: default

]

Example (from schema)

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

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
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 (from schema)

{
  "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."
}

Loading...