Get users and groups in project

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

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

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

Request

Path Parameters

projectId string required

Responses

projectAccessSchema

application/json

Schema
Example (from schema)

Schema

groups object[]required
A list of groups that have access to this project
Array [
name string
The name of the group
id integer required
The group's ID in the Unleash system
addedAt date-time
When this group was added to the project
roleId integer
The ID of the role this group has in the given project
roles integer[]
A list of roles this user has in the given project
description string nullable
A custom description of the group
mappingsSSO string[]
A list of SSO groups that should map to this Unleash group
rootRole number nullable
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.
createdBy string nullable
A user who created this group
createdAt date-time nullable
When was this group created
users object[]
A list of users belonging to this group
Array [
joinedAt date-time
The date when the user joined the group
createdBy string nullable
The username of the user who added this user to this group
user objectrequired
An Unleash user
id integer required
The user id
isAPI boolean deprecated
Deprecated in v5. Used internally to know which operations the user should be allowed to perform
name string nullable
Name of the user
email string
Email of the user
username string nullable
A unique username for the user
imageUrl string
URL used for the user profile image
inviteLink string
If the user is actively inviting other users, this is the link that can be shared with other users
loginAttempts integer
How many unsuccessful attempts at logging in has the user made
emailSent boolean
Is the welcome email sent to the user or not
rootRole integer
Which root role this user is assigned
seenAt date-time nullable
The last time this user logged in
createdAt date-time
The user was created at this time
accountType string
A user is either an actual User or a Service Account
permissions string[]
Deprecated
scimId string nullable
The SCIM ID of the user, only present if managed by SCIM
]
scimId string nullable
The SCIM ID of the group, only present if managed by SCIM
]
users object[]required
A list of users and their roles within this project
Array [
isAPI boolean deprecated
Whether this user is authenticated through Unleash tokens or logged in with a session
name string
The name of the user
email string nullable
The user's email address
id integer required
The user's ID in the Unleash system
imageUrl uri nullable
A URL pointing to the user's image.
addedAt date-time
When this user was added to the project
roleId integer
The ID of the role this user has in the given project
roles integer[]
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 [
id integer required
The role id
type string required
A role can either be a global root role (applies to all projects) or a project role
name string required
The name of the role
description string
A more detailed description of the role and what use it's intended for
project string nullable
What project the role belongs to
]

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

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema
Example (from schema)

Schema

id string
The ID of the error instance
name string
The name of the error kind
message string
A description of what went wrong.

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

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

application/json

Schema
Example (from schema)

Schema

id string
The ID of the error instance
name string
The name of the error kind
message string
A description of what went wrong.

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

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL

<your-unleash-url>

Security Scheme

apiKey

projectId — path required

curl / cURL
curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

python / requests
curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

go / native
curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

nodejs / native
curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

ruby / Net::HTTP
curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

csharp / httpclient
curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

php / cURL
curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

java / OkHttp
curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

powershell / RestMethod
curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/access' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

Get users and groups in project

Authorization

Request​

Path Parameters

Authorization

Request

Request