Objetos

ApiKeyCreate

Campos

• namestringobrigatório

  length ≥ 1, length ≤ 64

• rolestring

  Padrão: "editor"

• data_profilestring | null

  Perfil de dados da chave. Sem ele, a chave recebe o perfil padrão da organização. Um perfil de dados não se aplica à função admin. Uma chave de administrador vê todos os dados da organização, e um perfil diferente de full retorna 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Momento de expiração da chave (ISO 8601, no futuro). null ou a ausência de valor significa que a chave não expira.

• scopesarray of ApiKeyScope | null

  Escopos da chave. Se ausentes, os escopos seguem a função: admin recebe read, write, admin; editor e verifier recebem read, write; viewer recebe read. O escopo system só é concedido pelo administrador da instalação. Escopos granulares resource:action (ApiKeyScope) também são aceitos; os anteriores read, write e admin se expandem em conjuntos de escopos.

• collection_idsarray of integer | null

  Restringe a chave a estas coleções da organização. Cartões, busca, respostas e eventos funcionam só nelas, além da função e do perfil de dados. A ausência de valor ou uma lista vazia significa sem restrição. Se a própria chave que faz a chamada estiver restrita a coleções, a chave nova só pode ficar nas coleções dela. Sem este campo, a chave nova recebe as coleções da chave que faz a chamada. Uma lista vazia ou uma coleção fora da lista dela retorna 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Redes das quais a chave pode ser usada, como 10.0.0.0/8 ou 2001:db8::/32. Um endereço único é uma rede de um endereço. Uma requisição de outro endereço retorna 403 api_keys.ip_not_allowed. A ausência de valor significa sem restrição.

  items ≤ 50

Usado em

• POST/v1/api-keysCriar uma chave de API