Chuyển tới nội dung
Sursa Developers

Đối tượng

ApiKeyUpdate

Các thay đổi của khóa. Trường không được truyền giữ nguyên, và data_profile là tùy chọn. Danh sách scopes trống nghĩa là phạm vi theo vai trò, collection_ids và allowed_cidrs trống nghĩa là không giới hạn, còn expires_at bằng null nghĩa là khóa không hết hạn. Khóa mà chính nó bị giới hạn trong một số bộ sưu tập không thể gỡ bỏ hoặc nới rộng giới hạn theo bộ sưu tập (collection_ids).

Trường

  • data_profilestring

    Hồ sơ dữ liệu mới của khóa. Hồ sơ dữ liệu không áp dụng cho vai trò admin, nên với khóa quản trị viên, hồ sơ khác full trả về 400 api_keys.data_profile_not_applicable.

  • scopesarray of ApiKeyScope

    Phạm vi quyền của khóa. Phạm vi system không được cấp qua API.

  • collection_idsarray of integer

    Giới hạn khóa trong các bộ sưu tập này. Danh sách trống nghĩa là không giới hạn. Khóa gọi yêu cầu mà chính nó bị giới hạn trong một số bộ sưu tập chỉ thấy và thay đổi các khóa trong bộ sưu tập của nó (các khóa khác trả về 404 api_keys.not_found) và chỉ có thể đặt một danh sách không trống gồm các bộ sưu tập của chính nó. 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. Khi không có trường này, các bộ sưu tập của khóa giữ nguyên.

    items ≤ 100

  • allowed_cidrsarray of string

    Các mạng được phép dùng khóa.

    items ≤ 50

  • expires_atstring (date-time) | null

    Thời điểm hết hạn (trong tương lai). null nghĩa là khóa không hết hạn.

Được dùng trong