Permissions by System

Operations for managing directory and system permissions

Get System Permission

Retrieve a system permission by its ID

GET

https://dev.officex.app/v1/drive/{organization_id}/permissions/system/get/{system_permission_id}

Run In Postman

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123
system_permission_id (required)	string ID of the system 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 System Permission

Create a new system permission

POST

https://dev.officex.app/v1/drive/{organization_id}/permissions/system/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)	SystemTableResource (object) or SystemRecordResource (object) (SystemResourceID) Unique identifier for a system resource (table or record)	TABLE_CONTACTS
granted_to	string (GranteeID) Either a UserID or GroupID	UserID_wocat-vmb4r-rs5oj-ixung-f6e4c-r3zpk-ae2tm-jcmqr-vchpb-umcdf-fqe
permission_types (required)	Array of permissions Items Enum: "CREATE" "EDIT" "DELETE" "VIEW" "INVITE"	[ "VIEW", "CREATE", ]
begin_date_ms	number	1753290541568
expiry_date_ms	number	-1
inheritable	boolean Whether permission applies to sub-resources
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": "SystemPermissionID_8743dd9e-7f1a-457a-8560-b3c995da7591",
                "resource_id": "TABLE_CONTACTS",
                "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": [
                    "CREATE",
                    "VIEW"
                ],
                "begin_date_ms": 1753290541568,
                "expiry_date_ms": -1,
                "note": "",
                "created_at": 1755655944656,
                "last_modified_at": 1755655944656,
                "from_placeholder_grantee": null,
                "labels": [],
                "redeem_code": null,
                "resource_name": "TABLE_CONTACTS",
                "grantee_name": "User: UserID_wocat-vmb4r-rs5oj-ixung-f6e4c-r3zpk-ae2tm-jcmqr-vchpb-umcdf-fqe",
                "grantee_avatar": "",
                "granter_name": "Owner",
                "permission_previews": [
                    "CREATE",
                    "VIEW",
                    "EDIT",
                    "DELETE",
                    "INVITE"
                ]
            }
        }
    }
}

error

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

Typescript Types

	type
Request	IRequestCreateSystemPermission
Response	IResponseCreateSystemPermission

---

Update System Permission

Update system permission

POST

https://dev.officex.app/v1/drive/{organization_id}/permissions/system/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	SystemPermissionID_8743dd9e-7f1a-457a-8560-b3c995da7591
resource_id	string ID of the user/group to grant permission to
granted_to	string (GranteeID) Either a UserID or GroupID
permission_types	Array of permissions	[ "CREATE", "VIEW", "EDIT" ]
begin_date_ms	number	1753290541568
expiry_date_ms	number	0
inheritable	boolean Whether permission applies to sub-resources
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": {
            "id": "SystemPermissionID_8743dd9e-7f1a-457a-8560-b3c995da7591",
            "resource_id": "TABLE_CONTACTS",
            "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": [
                "CREATE",
                "EDIT",
                "VIEW"
            ],
            "begin_date_ms": 1753290541568,
            "expiry_date_ms": 0,
            "note": "",
            "created_at": 1755655944656,
            "last_modified_at": 1755656836765,
            "from_placeholder_grantee": null,
            "labels": [],
            "redeem_code": null,
            "resource_name": "TABLE_CONTACTS",
            "grantee_name": "User: UserID_wocat-vmb4r-rs5oj-ixung-f6e4c-r3zpk-ae2tm-jcmqr-vchpb-umcdf-fqe",
            "grantee_avatar": "",
            "granter_name": "Owner",
            "permission_previews": [
                "CREATE",
                "VIEW",
                "EDIT",
                "DELETE",
                "INVITE"
            ]
        }
    }
}

error

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

Typescript Types

	type
Request	IRequestUpdateSystemPermission
Response	IResponseUpdateSystemPermission

---

Delete System Permission

Delete an existing system permission

POST

https://dev.officex.app/v1/drive/{organization_id}/permissions/system/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 (SystemPermissionID) Unique identifier for a system permission	SystemPermissionID_0298d45b-561a-4abe-8f16-2255cca5896a

Responses

success

{
    "ok": {
        "data": {
            "deleted_id": "SystemPermissionID_0298d45b-561a-4abe-8f16-2255cca5896a"
        }
    }
}

error

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

Typescript Types

	type
Request	IRequestDeleteSystemPermission
Response	IResponseDeleteSystemPermission

---

Check Permissions by System (PENDING)

Check what permissions a user has for a specific system resource

POST

https://dev.officex.app/v1/drive/{organization_id}/permissions/system/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)	SystemTableResource (object) or SystemRecordResource (object) (SystemResourceID) Unique identifier for a system resource (table or record)	TABLE_CONTACTS
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": "TABLE_CONTACTS",
            "grantee_id": "UserID_wocat-vmb4r-rs5oj-ixung-f6e4c-r3zpk-ae2tm-jcmqr-vchpb-umcdf-fqe",
            "permissions": [
                "CREATE",
                "VIEW"
            ]
        }
    }
}

error

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

Typescript Types

	type
Request	IRequestCheckSystemPermissions
Response	IResponseCheckSystemPermissions

---

Redeem System Permission

Redeem a placeholder permission for a specific user

POST

https://dev.officex.app/v1/drive/{organization_id}/permissions/system/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 (SystemPermissionID) Unique identifier for a system permission	SystemPermissionID_0298d45b-561a-4abe-8f16-2255cca5896a
user_id (required)	string (UserID) Unique identifier for a user	UserID_dfyb3-s744h-ld6eq-dgrdk-behew-vcdto-kqacs-htufx-u7a4j-clpdf-5qe
redeem_code (required)	string Optional redeem code for the permission	REDEEM_1755657620659000
note	string Optional note for the redemption

Responses

success

{
    "ok": {
        "data": {
            "id": "SystemPermissionID_0298d45b-561a-4abe-8f16-2255cca5896a",
            "resource_id": "TABLE_CONTACTS",
            "granted_to": "UserID_dfyb3-s744h-ld6eq-dgrdk-behew-vcdto-kqacs-htufx-u7a4j-clpdf-5qe",
            "granted_by": "UserID_3hrnt-ylswl-acoxp-fx4qh-irpw4-wyyx5-pdjfq-ih5cl-d2xy3-dfbga-tae",
            "permission_types": [
                "CREATE",
                "VIEW"
            ],
            "begin_date_ms": 1753290541568,
            "expiry_date_ms": -1,
            "note": "",
            "created_at": 1755657620659,
            "last_modified_at": 1755657681427,
            "from_placeholder_grantee": "PlaceholderPermissionGranteeID_0f4bd9a3-08db-4740-8626-2a417bfe0a34",
            "labels": [],
            "redeem_code": null,
            "resource_name": "TABLE_CONTACTS",
            "grantee_name": "User: UserID_dfyb3-s744h-ld6eq-dgrdk-behew-vcdto-kqacs-htufx-u7a4j-clpdf-5qe",
            "grantee_avatar": "",
            "granter_name": "Owner",
            "permission_previews": [
                "CREATE",
                "VIEW",
                "EDIT",
                "DELETE",
                "INVITE"
            ]
        }
    }
}

error

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

Typescript Types

	type
Request	IRequestRedeemSystemPermission
Response	IResponseRedeemSystemPermission