Pular para o conteúdo
Sursa Developers

Objetos

ApiKeyUpdate

Alterações da chave. Os campos não passados ficam como estão, e data_profile é opcional. Uma lista scopes vazia significa escopos pela função, collection_ids e allowed_cidrs vazios significam sem restrição, e expires_at igual a null significa que a chave não expira. Uma chave que esteja ela mesma restrita a coleções não pode remover nem ampliar uma restrição a coleções (collection_ids).

Campos

  • data_profilestring

    Novo perfil de dados da chave. Um perfil de dados não se aplica à função admin; por isso, para uma chave de administrador, um perfil diferente de full retorna 400 api_keys.data_profile_not_applicable.

  • scopesarray of ApiKeyScope

    Escopos da chave. O escopo system não é concedido pela API.

  • collection_idsarray of integer

    Restringe a chave a estas coleções. Uma lista vazia significa sem restrição. Uma chave que faz a chamada e está ela mesma restrita a coleções vê e altera só chaves nas coleções dela (as outras chaves retornam 404 api_keys.not_found) e só pode definir uma lista não vazia das próprias coleções. Uma lista vazia ou uma coleção fora da lista dela retorna 400 api_keys.invalid_collections. Sem este campo, as coleções da chave ficam como estão.

    items ≤ 100

  • allowed_cidrsarray of string

    Redes das quais a chave pode ser usada.

    items ≤ 50

  • expires_atstring (date-time) | null

    Momento de expiração (no futuro). null significa que a chave não expira.

Usado em