Đối tượng

ApiKeyCreate

Trường

• namestringbắt buộc

  length ≥ 1, length ≤ 64

• rolestring

  Mặc định: "editor"

• data_profilestring | null

  Hồ sơ dữ liệu của khóa. Nếu không có, khóa nhận hồ sơ mặc định của tổ chức. Hồ sơ dữ liệu không áp dụng cho vai trò admin. Khóa quản trị viên thấy mọi dữ liệu của tổ chức, và hồ sơ khác full trả về 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Thời điểm hết hạn của khóa (ISO 8601, trong tương lai). null hoặc không có giá trị nghĩa là khóa không hết hạn.

• scopesarray of ApiKeyScope | null

  Phạm vi quyền của khóa. Nếu không có, phạm vi theo vai trò: admin nhận read, write, admin; editor và verifier nhận read, write; viewer nhận read. Phạm vi system chỉ do quản trị viên của bản cài đặt cấp. Phạm vi chi tiết dạng resource:action (ApiKeyScope) cũng được chấp nhận; các phạm vi cũ read, write và admin được mở rộng thành các tập phạm vi.

• collection_idsarray of integer | null

  Giới hạn khóa trong các bộ sưu tập này của tổ chức. Thẻ, tìm kiếm, câu trả lời và sự kiện chỉ hoạt động trong các bộ sưu tập đó, ngoài giới hạn của vai trò và hồ sơ dữ liệu. Không có giá trị hoặc danh sách trống nghĩa là không giới hạn. Nếu chính khóa gọi yêu cầu bị giới hạn trong một số bộ sưu tập, khóa mới chỉ có thể nằm trong các bộ sưu tập của nó. Khi không có trường này, khóa mới nhận các bộ sưu tập của khóa gọi yêu cầu. Danh sách trống hoặc bộ sưu tập nằm ngoài danh sách của khóa gọi trả về 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Các mạng được phép dùng khóa, ví dụ 10.0.0.0/8 hoặc 2001:db8::/32. Một địa chỉ đơn lẻ là mạng chỉ gồm một địa chỉ. Yêu cầu từ địa chỉ khác trả về 403 api_keys.ip_not_allowed. Không có giá trị nghĩa là không giới hạn.

  items ≤ 50

Được dùng trong

• POST/v1/api-keysTạo khóa API