Grant permission on a project

POST

/api/v2/projects/{project_id}/permissions

Grants access to a project for a user or team.
This endpoint creates a direct permission relationship, allowing the specified user or team to access the project with the specified role.

Path Parameters:

project_id (int): The ID of the project

Request Body:

subject_type (str, required): Type of subject ("user" or "team")

subject_id (str, required): Unique identifier of the user or team

relation (str, required): Role to grant ("admin" or "member")

Roles:

admin: Full control over the project (can manage, edit, delete, and grant access to others)

member: Can view and use the project

For Teams:

If relation is "admin", team admins will get admin access to the project

If relation is "member", team members will get member access to the project

Authorization:

Requires manage permission on the project

The user/team must belong to the same organization as the project

Returns:

A response containing the granted permission details

Current Version:

2.0.0

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Successfully granted permission

Body

🟠400

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

cURL

Grant user permissionGrant team permission

curl --location -g --request POST 'https:///api/v2/projects//permissions' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "subject_type": "user",
    "subject_id": "456",
    "relation": "admin"
}'

Response Example

201 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "project_id": 0,
        "subject_type": "string",
        "subject_id": "string",
        "subject_name": "string",
        "relation": "string",
        "granted_at": "2019-08-24T14:15:22.123Z",
        "granted_by": {
            "user_id": "string",
            "email": "[email protected]",
            "name": "string"
        }
    }
}

List all permissions on a project

Update a permission on a project