Get Calling User's Permissions on a Corpus

GET

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

Shows your own role on a corpus, worked out from what you can do on it. Use it to decide which
corpus actions to offer in your interface.

It needs no permission on the corpus, because it only shows your own access. When your role
can't be checked at the moment, it reads as empty instead of failing. X-API-Version: 2.1 is
accepted and changes nothing.

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Your role on the corpus. In the older corpus sharing mode, also the permission names behind it.

Bodyapplication/json

🟠400Bad Request

🟠401Forbidden

🟠403

🟠404

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Your role

{
    "success": true,
    "message": "User permissions retrieved successfully",
    "data": {
        "user_relations": [
            "admin"
        ]
    }
}

Batch Revoke Permissions on a Corpus

Get a User's Permissions on a Corpus