Get users in project

GET 
/api/admin/projects/:projectId/users

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Get users belonging to a project together with their roles as well as a list of roles available to the project. This endpoint is deprecated. Use /:projectId/access instead.

Request

Path Parameters

projectId stringrequired

Responses

200

projectUsersSchema

application/json

Schema

Schema

users

object[]

required

A list of users with access to this project and their role within it.

Array [

isAPI booleandeprecated

Whether this user is authenticated through Unleash tokens or logged in with a session

Example: false

name string

The name of the user

Example: Hunter Burgan

email stringnullable

The user's email address

Example: hunter@hunter.com

id integerrequired

The user's ID in the Unleash system

Example: 1

imageUrl urinullable

A URL pointing to the user's image.

addedAt date-time

When this user was added to the project

Example: 2023-08-01T14:35:16Z

roleId integer

The ID of the role this user has in the given project

Example: 5

roles integer[]

A list of roles this user has in the given project

]

roles

object[]

required

A list of roles that are available for this project

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": [
    {
      "name": "Hunter Burgan",
      "email": "hunter@hunter.com",
      "id": 1,
      "imageUrl": "string",
      "addedAt": "2023-08-01T14:35:16Z",
      "roleId": 5,
      "roles": [
        5
      ]
    }
  ],
  "roles": [
    {
      "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."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

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: NoAccessError
message string
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

Loading...