Create a new Permission for a Corpus

POST

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

Enables authorized users to share a specific corpus with another user by providing the user's email and the desired permissions.

Purpose:

Allows for collaborative access to a corpus by assigning specific permissions to other users.

Helps in managing and sharing access to a corpus among multiple users.

Path Parameters:

corpus_id: The id of the corpus to share with the user

Request Body:

shared_to (str): Email of the user to share the corpus with

permissions (list): List of permissions to assign to the user

Returns

A response containing the email and permissions assigned to the user

Current Version:

2.0.0

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///api/v2/corpora//permissions' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shared_to": "user@example.com",
    "permissions": [
        "string"
    ]
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "email": "user@example.com",
        "permissions": [
            null
        ]
    }
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Success

Body

🟠400Bad Request

🟠403Forbidden

🔴500Server Error

Get all Permissions for a Corpus

Delete a user permission for a corpus