Tạo vai trò
Một tên và một danh sách quyền. Những gì trả về dài hơn những gì bạn đã gửi.
Chạy lệnh gọi thật với không gian làm việc của bạn, bằng khóa của chính bạn.
POST /roles
Một tên và một danh sách quyền. Những gì trả về dài hơn những gì bạn đã gửi.
Ví dụ
Cần roles:write. Trả về 201. Vai trò tùy chỉnh có builtin: null, editable: true và deletable: true, và không ai giữ nó cho đến khi có người được chuyển sang.
curl -X POST "$OE/roles" -H "$AUTH" -H "Content-Type: application/json" \ -d '{ "name": "Support", "description": "Answers the shared inboxes and nothing else.", "permissions": ["emails:send", "threads:write", "labels:write", "contacts:read"] }'{ "object": "role", "id": "role_2b81de079c1f0a4b7e05d386", "name": "Support", "description": "Answers the shared inboxes and nothing else.", "permissions": [ "emails:send", "emails:read", "threads:read", "threads:write", "labels:read", "labels:write", "contacts:read" ], "builtin": null, "editable": true, "deletable": true, "members": 0, "apiKeys": 0, "createdAt": "2026-08-30T10:41:02.000Z", "updatedAt": "2026-08-30T10:41:02.000Z"}Bốn quyền được gửi vào và bảy quyền được trả về. emails:send ngụ ý emails:read, threads:write ngụ ý threads:read, labels:write ngụ ý labels:read. Một vai trò có thể lưu trữ một luồng thư mà nó không mở được là một ô đánh dấu ai đó quên chứ không phải chính sách mà ai đó thực sự muốn, nên sự ngụ ý được lưu lại thay vì bị từ chối. Danh sách cũng được trả về theo thứ tự chuẩn, nhờ đó client có thể so sánh hai vai trò dưới dạng JSON và quyết định có bật nút Lưu hay không.
Quyền không xác định SẼ bị từ chối ở đây thay vì bị bỏ đi: templates:writ là invalid_parameter, mã 422, nêu rõ chuỗi đó. Dịch vụ chuẩn hóa một cách lặng lẽ vì nó cũng là đường seed và đường MCP, nơi mà làm hỏng cả một vai trò chỉ vì một từ không nhận ra sẽ còn tệ hơn. Điều đó là sai với một lệnh gọi mà ai đó thực hiện có chủ đích. Một mã 200 kèm vai trò không thể chỉnh sửa mẫu chẳng cho họ biết gì, và họ sẽ mất cả buổi chiều vì nó.
Tên trùng lặp trong cùng không gian làm việc là role_name_taken, mã 409. Vai trò tùy chỉnh thứ 25 là role_limit_reached, mã 422. Giới hạn này ngăn một ma trận lớn đến mức không ai rà soát nổi, và không phải là ranh giới của gói.
Tạo một vai trò không trao nó cho ai. Chuyển người sang vai trò đó là PATCH /members/{userId}, và gán một khóa cho nó được thực hiện ở nơi khóa được cấp.