Ejento APIs

Create Corpus Permissions

POST

/api/corpus/{corpus_id}/permissions

Corpus APIs

This endpoint allows authenticated users to assign access permissions to a specific corpus.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/corpus//permissions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shared_to": "user@example.com",
    "permissions": [
        "view_corpus",
        "change_corpus"
    ]
}'

Response Example

{
    "message": "Permissions successfully assigned to user@example.com"
}

Request

Path Params

corpus_id

integer

required

The ID of the corpus to assign permissions for.

Body Params application/json

shared_to

string <email>

optional

The email address of the user to whom the permissions are being assigned.

Example:

user@example.com

permissions

array[string]

optional

A list of permissions to assign to the user.

Example:

["view_corpus","change_corpus"]

Examples

Responses

🟢201Created

application/json

Corpus permissions successfully created.

Body

message

string

optional

Success message.

Example:

Permissions successfully assigned to user@example.com

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Get Corpus Permissions

Delete Corpus Permissions