Get all user permissions for a corpus

GET

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

Retrieves the specific access permissions assigned to users for a given corpus.
This endpoint is particularly useful for administrators who need to verify or manage user access rights within collaborative environments.

Purpose:

Enables visibility into what actions a users can perform on the specified corpus.

Path Parameters:

corpus_id: The id of the corpus to get the user permissions for.

Returns

A response containing the user permissions for the corpus

If the corpus is not found/ does not exist, the endpoint will return a 404 error

Current Version:

2.0.0

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///api/v2/corpora//permissions/users' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "user_permissions": [
            null
        ]
    }
}

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Success

Body

🟠400Bad Request

🟠403Forbidden

🔴500Server Error

Delete a user permission for a corpus

Get a Document