Get User Permissions on Multiple Projects

GET

/api/v2/projects/users/{user_id}/permissions

Shows the role a user holds on each of several projects, worked out from what the user can do
on each one. Use it to check which projects in a list a user can open.

Only projects in the request's organization are checked: the one the Organization-Id header
names, otherwise your subscription key's, otherwise your own. Projects the user can't access
are left out of projects; projects that couldn't be checked are listed in omitted_ids.

You can always read your own roles. Reading another user's roles requires being a member of
the organization (view on it).

Request

Path Params

Query Params

Header Params

Responses

🟢200

application/json

The user's role on each requested project they can access.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/projects/users//permissions?project_ids=' \
--header 'X-Authorization-Consistency-Token;' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Roles on two projects

{
    "success": true,
    "message": "User permissions on projects retrieved successfully",
    "data": {
        "user_id": 15,
        "user_name": "Dana Lee",
        "email": "[email protected]",
        "projects": [
            {
                "project_id": 7,
                "project_name": "Customer Care",
                "relations": [
                    "admin"
                ]
            },
            {
                "project_id": 8,
                "project_name": "Billing",
                "relations": [
                    "member"
                ]
            }
        ],
        "omitted_ids": [
            77
        ]
    }
}

Get User Permissions on a Specific Project

Retrieve all Projects