Permissions

Grant or revoke filesystem-level read/write access for members, groups, or service accounts on specific directory paths.

GET

/api/v1/filespaces/{filespaceId}/permissions

Returns a paginated list of all permissions granted on this filespace. Filter by principal using the optional `principalId` query parameter.

Parameters

Parameter	Type	Description
`principalId`	`string`	Filter permissions by principal ID
`limit`	`number`	Maximum number of results to return
`nextCursor`	`string`	Cursor for pagination
`filespaceId`	`string`	Required.

principalId

Type: string
Description: Filter permissions by principal ID

limit

Type: number
Description: Maximum number of results to return

nextCursor

Type: string
Description: Cursor for pagination

filespaceId

Type: string
Description: Required.

Responses

Status	Description
`200`	Permissions have been successfully fetched.
`400`	Query parameters are invalid.
`401`	Invalid or missing credentials.

200

Description: Permissions have been successfully fetched.

400

Description: Query parameters are invalid.

401

Description: Invalid or missing credentials.

200 response

{    "data": {        "permissions": [            {                "id": "bWVtYmVyMTIzZmlsZTQ1Ng==",                "path": "/Documents/Project",                "permissions": [                    "read",                    "write"                ],                "principalId": "123e4567-e89b-12d3-a456-426614174000",                "principalType": "member"            },            {                "id": "Z3JvdXA0NTZmaWxlNzg5",                "path": "/Shared",                "permissions": [                    "read"                ],                "principalId": "456e7890-e12b-34d5-b678-901234567890",                "principalType": "group"            }        ],        "nextCursor": "bWVtYmVyMTIzZmlsZTQ1Ng=="    }}

400 response

{    "error": {        "message": "limit must not be greater than 100"    }}

401 response

{    "error": {        "message": "Invalid or expired token"    }}

POST

/api/v1/filespaces/{filespaceId}/permissions

Grant access to a principal for a particular filesystem entry.

Parameters

Parameter	Type	Description
`filespaceId`	`string`	Required.

filespaceId

Type: string
Description: Required.

Request body

Field	Type	Description
`path`	`string`	Required. Full path to a directory. The path of the root directory is: "/"
`permissions`	`Permission[]`	Required. Array of permissions
`principalId`	`string`	Required. ID of the principal to grant access to: a member ID, group ID, or service account ID.

path

Type: string
Description: Required. Full path to a directory. The path of the root directory is: "/"

permissions

Type: Permission[]
Description: Required. Array of permissions

principalId

Type: string
Description: Required. ID of the principal to grant access to: a member ID, group ID, or service account ID.

Responses

Status	Description
`201`	Access has been granted.
`400`	1. PermissionCreateDto is invalid. 2. Access has already been granted.
`401`	Invalid or missing credentials.
`404`	1. File system entry does not exist. 2. Principal does not exist.

201

Description: Access has been granted.

400

Description: 1. PermissionCreateDto is invalid. 2. Access has already been granted.

401

Description: Invalid or missing credentials.

404

Description: 1. File system entry does not exist. 2. Principal does not exist.

401 response

{    "error": {        "message": "Invalid or expired token"    }}

PATCH

/api/v1/filespaces/{filespaceId}/permissions/{permissionId}

Replaces the permission set for an existing permission entry.

Parameters

Parameter	Type	Description
`filespaceId`	`string`	Required. Filespace ID
`permissionId`	`string`	Required. Permission ID

filespaceId

Type: string
Description: Required. Filespace ID

permissionId

Type: string
Description: Required. Permission ID

Request body

Field	Type	Description
`permissions`	`Permission[]`	Required. Array of permissions

permissions

Type: Permission[]
Description: Required. Array of permissions

Responses

Status	Description
`200`	Access has been updated.
`400`	1. PermissionUpdateDto is invalid. 2. Permission id is invalid.
`401`	Invalid or missing credentials.
`404`	Permission id not found.

200

Description: Access has been updated.

400

Description: 1. PermissionUpdateDto is invalid. 2. Permission id is invalid.

401

Description: Invalid or missing credentials.

404

Description: Permission id not found.

401 response

{    "error": {        "message": "Invalid or expired token"    }}

DELETE

/api/v1/filespaces/{filespaceId}/permissions/{permissionId}

Revokes a permission. The member or group will immediately lose the associated access.

Parameters

Parameter	Type	Description
`filespaceId`	`string`	Required. Filespace ID
`permissionId`	`string`	Required. Permission ID

filespaceId

Type: string
Description: Required. Filespace ID

permissionId

Type: string
Description: Required. Permission ID

Responses

Status	Description
`200`	Access has been revoked.
`400`	Permission id is invalid.
`401`	Invalid or missing credentials.
`404`	Permission id not found.

200

Description: Access has been revoked.

400

Description: Permission id is invalid.

401

Description: Invalid or missing credentials.

404

Description: Permission id not found.

401 response

{    "error": {        "message": "Invalid or expired token"    }}