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

200

projectAccessSchema

application/json

Schema

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
]

Example (auto)

{
  "groups": [
    {
      "name": "DX team",
      "id": 1,
      "addedAt": "2023-08-01T14:35:16Z",
      "roleId": 5,
      "roles": [
        5
      ],
      "description": "Current members of the DX squad",
      "mappingsSSO": [
        "SSOGroup1",
        "SSOGroup2"
      ],
      "rootRole": 1,
      "createdBy": "admin",
      "createdAt": "2023-06-30T11:41:00.123Z",
      "users": [
        {
          "joinedAt": "2023-06-30T11:41:00.123Z",
          "createdBy": "admin",
          "user": {
            "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
          }
        }
      ],
      "scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
    }
  ],
  "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

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

403

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

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

Example (auto)

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

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/projects/:projectId/access' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

projectId — pathrequired

ResponseClear

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