Permissions by Directory

Operations for managing directory and system permissions

Get Directory Permission

Retrieve a directory permission by its ID

GET

https://dev.officex.app/v1/drive/{organization_id}/permissions/directory/get/{directory_permission_id}

Run In Postman

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123
directory_permission_id (required)	string ID of the directory permission to retrieve	DirectoryPermissionID_3acdba66-1378-4257-bc9b-0563dd9c3bbf

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Responses

success

{
    "ok": {
        "data": {
            "id": "DirectoryPermissionID_3acdba66-1378-4257-bc9b-0563dd9c3bbf",
            "resource_id": "FolderID_b44cfb98-2278-42d8-b846-c16f3c70da2a",
            "resource_path": "DiskID_d2b1fec9-ebf8-4ca5-adb3-8dea93941939::",
            "granted_to": "GroupID_1873ebab-1403-412d-99ea-41a5f0d0c781",
            "granted_by": "UserID_3hrnt-ylswl-acoxp-fx4qh-irpw4-wyyx5-pdjfq-ih5cl-d2xy3-dfbga-tae",
            "permission_types": [
                "DELETE",
                "EDIT",
                "INVITE",
                "MANAGE",
                "UPLOAD",
                "VIEW"
            ],
            "begin_date_ms": 0,
            "expiry_date_ms": -1,
            "inheritable": true,
            "note": "Default permissions for disk root folder owner",
            "created_at": 1755588857475,
            "last_modified_at": 1755588857475,
            "from_placeholder_grantee": null,
            "labels": [],
            "redeem_code": null,
            "resource_name": "",
            "grantee_name": "Group for All",
            "grantee_avatar": null,
            "granter_name": "Owner",
            "permission_previews": [
                "CREATE",
                "VIEW",
                "EDIT",
                "DELETE",
                "INVITE"
            ]
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestGetDirectoryPermission
Response	IResponseGetDirectoryPermission

---

Create Directory Permission

Create a new directory permission

POST

https://dev.officex.app/v1/drive/{organization_id}/permissions/directory/create

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

resource_id (required)	string(DirectoryResourceID) Enum: "FileID_<id>" "FolderID_<id>" Unique identifier for a directory resource (file or folder)	FolderID_b9fa11bc-2926-4a13-944e-e1189df66e5a
granted_to	string (GranteeID) Either a UserID or GroupID
permission_types (required)	Array of permissions	[ "VIEW", "EDIT", "DELETE", "UPLOAD", "INVITE" ]
begin_date_ms	number
expiry_date_ms	number
inheritable	boolean Whether permission applies to sub-resources	false
note	string or null <= 8192 characters Note about the permission
metadata	object or null Additional metadata for the permission
external_id	string (ExternalID) <= 256 characters External identifier for integration purposes
external_payload	string (ExternalPayload) <= 8192 characters Additional data for external integrations. Eg Stringified JSON

Responses

success

{
    "ok": {
        "data": {
            "permission": {
                "id": "DirectoryPermissionID_bddd1bb7-f292-448a-a9dc-6a82bb88627f",
                "resource_id": "FolderID_b9fa11bc-2926-4a13-944e-e1189df66e5a",
                "resource_path": "DiskID_d2b1fec9-ebf8-4ca5-adb3-8dea93941939::../",
                "granted_to": "PlaceholderPermissionGranteeID_2831cde1-1312-4630-b2a8-c371fd57ee35",
                "granted_by": "UserID_3hrnt-ylswl-acoxp-fx4qh-irpw4-wyyx5-pdjfq-ih5cl-d2xy3-dfbga-tae",
                "permission_types": [
                    "DELETE",
                    "EDIT",
                    "INVITE",
                    "UPLOAD",
                    "VIEW"
                ],
                "begin_date_ms": 0,
                "expiry_date_ms": -1,
                "inheritable": false,
                "note": "",
                "created_at": 1755612642222,
                "last_modified_at": 1755612642222,
                "from_placeholder_grantee": null,
                "labels": [],
                "redeem_code": "RedeemTokenID_8b4b9786-60bb-494c-b0a6-b9e66ed06e79",
                "resource_name": "Revised Investigation (2) (2)",
                "grantee_name": "Awaiting Anon",
                "granter_name": "Owner",
                "permission_previews": [
                    "CREATE",
                    "VIEW",
                    "EDIT",
                    "DELETE",
                    "INVITE"
                ]
            }
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestCreateDirectoryPermission
Response	IResponseCreateDirectoryPermission

---

Update Directory Permission

Update directory permission

POST

https://dev.officex.app/v1/drive/{organization_id}/permissions/directory/update

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

id (required)	string (DirectoryPermissionID) Unique identifier for a directory permission	DirectoryPermissionID_bddd1bb7-f292-448a-a9dc-6a82bb88627f
permission_types (required)	Array of permissions	[ "DELETE" ]
begin_date_ms	number
expiry_date_ms	number
inheritable	boolean Whether permission applies to sub-resources	false
note	string or null <= 8192 characters Note about the permission
metadata	object or null Additional metadata for the permission
external_id	string (ExternalID) <= 256 characters External identifier for integration purposes
external_payload	string (ExternalPayload) <= 8192 characters Additional data for external integrations. Eg Stringified JSON

Responses

success

{
    "ok": {
        "data": {
            "permission": {
                "id": "DirectoryPermissionID_bddd1bb7-f292-448a-a9dc-6a82bb88627f",
                "resource_id": "FolderID_b9fa11bc-2926-4a13-944e-e1189df66e5a",
                "resource_path": "DiskID_d2b1fec9-ebf8-4ca5-adb3-8dea93941939::../",
                "granted_to": "PlaceholderPermissionGranteeID_2831cde1-1312-4630-b2a8-c371fd57ee35",
                "granted_by": "UserID_3hrnt-ylswl-acoxp-fx4qh-irpw4-wyyx5-pdjfq-ih5cl-d2xy3-dfbga-tae",
                "permission_types": [
                    "DELETE"
                ],
                "begin_date_ms": 0,
                "expiry_date_ms": -1,
                "inheritable": false,
                "note": "",
                "created_at": 1755612642222,
                "last_modified_at": 1755612642222,
                "from_placeholder_grantee": null,
                "labels": [],
                "redeem_code": "RedeemTokenID_8b4b9786-60bb-494c-b0a6-b9e66ed06e79",
                "resource_name": "Revised Investigation (2) (2)",
                "grantee_name": "Awaiting Anon",
                "granter_name": "Owner",
                "permission_previews": [
                    "CREATE",
                    "VIEW",
                    "EDIT",
                    "DELETE",
                    "INVITE"
                ]
            }
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestUpdateDirectoryPermission
Response	IResponseUpdateDirectoryPermission

---

Delete Directory Permission

Delete an existing directory permission

POST

https://dev.officex.app/v1/drive/{organization_id}/permissions/directory/delete

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

permission_id (required)	string (DirectoryPermissionID) Unique identifier for a directory permission	DirectoryPermissionID_bddd1bb7-f292-448a-a9dc-6a82bb88627f

Responses

success

{
    "ok": {
        "data": {
            "deleted_id": "DirectoryPermissionID_bddd1bb7-f292-448a-a9dc-6a82bb88627f"
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestDeleteDirectoryPermission
Response	IResponseDeleteDirectoryPermission

---

Check Permissions by Directory

Check what permissions a user has for a specific resource

POST

https://dev.officex.app/v1/drive/{organization_id}/permissions/directory/check

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

resource_id (required)	string (DirectoryResourceID) Enum: "FileID_" "FolderID_" Unique identifier for a directory resource (file or folder)	FolderID_b9fa11bc-2926-4a13-944e-e1189df66e5a
grantee_id (required)	string (GranteeID) Either a UserID or GroupID	UserID_wocat-vmb4r-rs5oj-ixung-f6e4c-r3zpk-ae2tm-jcmqr-vchpb-umcdf-fqe

Responses

success

{
    "ok": {
        "data": {
            "resource_id": "FolderID_b9fa11bc-2926-4a13-944e-e1189df66e5a",
            "grantee_id": "UserID_wocat-vmb4r-rs5oj-ixung-f6e4c-r3zpk-ae2tm-jcmqr-vchpb-umcdf-fqe",
            "permissions": [
                "DELETE",
                "EDIT",
                "INVITE",
                "UPLOAD",
                "VIEW"
            ]
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestCheckDirectoryPermissions
Response	IResponseCheckDirectoryPermissions

---

Redeem Directory Permission

Redeem a placeholder permission for a specific user

POST

https://dev.officex.app/v1/drive/{organization_id}/permissions/directory/redeem

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

permission_id (required)	string (DirectoryPermissionID) Unique identifier for a directory permission	DirectoryPermissionID_ccb14bfc-2aa1-40af-a5ec-01740f0b2f37
user_id (required)	string (UserID) Unique identifier for a user	UserID_wocat-vmb4r-rs5oj-ixung-f6e4c-r3zpk-ae2tm-jcmqr-vchpb-umcdf-fqe
redeem_code (required)	string Optional redeem code for the permission	RedeemTokenID_8e82fb3c-7c7d-4aec-8329-935d27747b44
note	string Optional note for the redemption	Hello World

Responses

success

{
    "ok": {
        "data": {
            "permission": {
                "id": "DirectoryPermissionID_e7c84df4-2f4a-4de8-8598-ba3c125eb739",
                "resource_id": "FolderID_b9fa11bc-2926-4a13-944e-e1189df66e5a",
                "resource_path": "DiskID_d2b1fec9-ebf8-4ca5-adb3-8dea93941939::../",
                "granted_to": "UserID_wocat-vmb4r-rs5oj-ixung-f6e4c-r3zpk-ae2tm-jcmqr-vchpb-umcdf-fqe",
                "granted_by": "UserID_3hrnt-ylswl-acoxp-fx4qh-irpw4-wyyx5-pdjfq-ih5cl-d2xy3-dfbga-tae",
                "permission_types": [
                    "DELETE",
                    "EDIT",
                    "INVITE",
                    "UPLOAD",
                    "VIEW"
                ],
                "begin_date_ms": 0,
                "expiry_date_ms": -1,
                "inheritable": false,
                "note": "Hello World",
                "created_at": 1755614678534,
                "last_modified_at": 1755614702963,
                "from_placeholder_grantee": "PlaceholderPermissionGranteeID_7c7c2517-c7f7-4ae9-8448-701bc5feaedd",
                "labels": [],
                "redeem_code": null,
                "resource_name": "Revised Investigation (2) (2)",
                "grantee_name": "Unknown User (UserID_wocat-vmb4r-rs5oj-ixung-f6e4c-r3zpk-ae2tm-jcmqr-vchpb-umcdf-fqe)",
                "granter_name": "Owner",
                "permission_previews": [
                    "CREATE",
                    "VIEW",
                    "EDIT",
                    "DELETE",
                    "INVITE"
                ]
            }
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestRedeemDirectoryPermission
Response	IResponseRedeemDirectoryPermission