Batch grant permissions on a corpus

POST

/api/v2/corpora/{corpus_id}/permissions/batch

Grants permissions to multiple users or teams on a corpus in a single request.
Useful for onboarding a team or setting up initial access.

Path Parameters:

corpus_id (int): The ID of the corpus

Request Body:

grants (array, required): List of grants, each with:

subject_type (str): "user" or "team"

subject_id (str): ID of the user or team

relation (str): Role to grant — "admin", "editor", or "viewer"

Authorization:

Requires admin role on the corpus

Returns:

A response listing successfully granted and failed items

Current Version:

2.0.0

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Batch grant operation completed

Body

🟠400

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///api/v2/corpora//permissions/batch' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "grants": [
        {
            "subject_type": "user",
            "subject_id": "string",
            "relation": "viewer"
        }
    ]
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "corpus_id": 0,
        "granted": [
            {
                "subject_type": "string",
                "subject_id": "string",
                "subject_name": "string",
                "relation": "string"
            }
        ],
        "failed": [
            {
                "property1": "string",
                "property2": "string"
            }
        ],
        "granted_at": "string"
    }
}

Update a permission on a corpus

Revoke permission on a corpus