Skip to main content

Get users in project

GET 

<your-unleash-url>/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

projectUsersSchema

Schema
    users object[]required

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

  • Array [
  • isAPIbooleandeprecated

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

    Example: false
    namestring

    The name of the user

    Example: Hunter Burgan
    emailstringnullable

    The user's email address

    Example: hunter@hunter.com
    idintegerrequired

    The user's ID in the Unleash system

    Example: 1
    imageUrlurinullable

    A URL pointing to the user's image.

    addedAtdate-time

    When this user was added to the project

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

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

    Example: 5
    rolesinteger[]

    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 [
  • 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
  • ]

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
curl -L '<your-unleash-url>/api/admin/projects/:projectId/users' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'
Request Collapse all
Base URL
<your-unleash-url>
Auth
Parameters
— pathrequired
ResponseClear

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