Ir al contenido
Sursa Developers

Objetos

ApiKeyUpdate

Cambios de la clave. Los campos que no se envían no cambian, y data_profile es opcional. Una lista scopes vacía significa ámbitos según el rol; collection_ids y allowed_cidrs vacíos significan que no hay restricción, y expires_at con null significa que la clave no caduca. Una clave que está limitada a colecciones no puede quitar ni ampliar una restricción a colecciones (collection_ids).

Campos

  • data_profilestring

    Perfil de datos nuevo de la clave. Un perfil de datos no se aplica al rol admin, por lo que, en una clave de administrador, un perfil distinto de full devuelve 400 api_keys.data_profile_not_applicable.

  • scopesarray of ApiKeyScope

    Ámbitos de la clave. El ámbito system no se emite a través de la API.

  • collection_idsarray of integer

    Limita la clave a estas colecciones. Una lista vacía significa que no hay restricción. Una clave que llama y que está limitada a colecciones solo ve y cambia las claves de sus colecciones (las demás claves devuelven 404 api_keys.not_found) y solo puede indicar una lista no vacía de sus propias colecciones. Una lista vacía o una colección fuera de su lista devuelven 400 api_keys.invalid_collections. Sin este campo, las colecciones de la clave no cambian.

    items ≤ 100

  • allowed_cidrsarray of string

    Redes desde las que se puede usar la clave.

    items ≤ 50

  • expires_atstring (date-time) | null

    Momento de caducidad (en el futuro). null significa que la clave no caduca.

Se usa en