Skip to main content

Get users and groups in project

GET 

<your-unleash-url>/api/admin/projects/:projectId/access

Get all groups, users and their roles, and available roles for the given project.

Request

Path Parameters

    projectId stringrequired

Responses

projectAccessSchema

Schema
    groups object[]required

    A list of groups that have access to this project

  • Array [
  • namestring

    The name of the group

    Example: DX team
    idintegerrequired

    The group's ID in the Unleash system

    Example: 1
    addedAtdate-time

    When this group was added to the project

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

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

    Example: 5
    rolesinteger[]

    A list of roles this user has in the given project

    descriptionstringnullable

    A custom description of the group

    Example: Current members of the DX squad
    mappingsSSOstring[]

    A list of SSO groups that should map to this Unleash group

    Example: ["SSOGroup1","SSOGroup2"]
    rootRolenumbernullable

    A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role.

    Example: 1
    createdBystringnullable

    A user who created this group

    Example: admin
    createdAtdate-timenullable

    When was this group created

    Example: 2023-06-30T11:41:00.123Z
    users object[]

    A list of users belonging to this group

  • Array [
  • joinedAtdate-time

    The date when the user joined the group

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

    The username of the user who added this user to this group

    Example: admin
    user objectrequired

    An Unleash user

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

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

    Example: 01HTMEXAMPLESCIMID7SWWGHN7
  • ]
  • users object[]required

    A list of users and their roles within this project

  • 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 within 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/access' \
-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!