Anar al contingut
Sursa Developers

Objectes

ApiKeyUpdate

Canvis de la clau. Els camps que no es passen no canvien, i data_profile és opcional. Una llista scopes buida vol dir àmbits segons el rol, collection_ids i allowed_cidrs buits volen dir sense restricció, i expires_at amb el valor null vol dir que la clau no caduca. Una clau que està limitada a col·leccions no pot eliminar ni ampliar una restricció a col·leccions (collection_ids).

Camps

  • data_profilestring

    Perfil de dades nou de la clau. Un perfil de dades no s’aplica al rol admin; per tant, en una clau d’administrador, un perfil diferent de full retorna 400 api_keys.data_profile_not_applicable.

  • scopesarray of ApiKeyScope

    Àmbits de la clau. L’àmbit system no es concedeix a través de l’API.

  • collection_idsarray of integer

    Limita la clau a aquestes col·leccions. Una llista buida vol dir sense restricció. Una clau que fa la crida i que està limitada a col·leccions només veu i canvia claus dins de les seves col·leccions (les altres claus retornen 404 api_keys.not_found) i només pot definir una llista no buida de les seves pròpies col·leccions. Una llista buida o una col·lecció fora de la seva llista retorna 400 api_keys.invalid_collections. Sense aquest camp, les col·leccions de la clau no canvien.

    items ≤ 100

  • allowed_cidrsarray of string

    Xarxes des de les quals es pot fer servir la clau.

    items ≤ 50

  • expires_atstring (date-time) | null

    Moment de caducitat (en el futur). null vol dir que la clau no caduca.

S’usa a