Objetos

ApiKeyCreate

Campos

• namestringobligatorio

  length ≥ 1, length ≤ 64

• rolestring

  Predeterminado: "editor"

• data_profilestring | null

  Perfil de datos de la clave. Sin él, la clave recibe el perfil predeterminado de la organización. Un perfil de datos no se aplica al rol admin. Una clave de administrador ve todos los datos de la organización, y un perfil distinto de full devuelve 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Momento de caducidad de la clave (ISO 8601, en el futuro). null o sin valor: la clave no caduca.

• scopesarray of ApiKeyScope | null

  Ámbitos de la clave. Si no se indican, los ámbitos dependen del rol: admin recibe read, write, admin; editor y verifier reciben read, write; viewer recibe read. El ámbito system solo lo emite el administrador de la instalación. También se aceptan ámbitos detallados resource:action (ApiKeyScope); los anteriores read, write y admin se expanden en conjuntos de ámbitos.

• collection_idsarray of integer | null

  Limita la clave a estas colecciones de la organización. Las tarjetas, la búsqueda, las respuestas y los eventos solo funcionan en ellas, además de lo que permiten el rol y el perfil de datos. Sin valor o con una lista vacía, no hay restricción. Si la propia clave que llama está limitada a colecciones, la clave nueva solo puede estar en sus colecciones. Sin este campo, la clave nueva recibe las colecciones de la clave que llama. Una lista vacía o una colección fuera de su lista devuelven 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Redes desde las que se puede usar la clave, como 10.0.0.0/8 o 2001:db8::/32. Una sola dirección es una red de una dirección. Una solicitud desde otra dirección devuelve 403 api_keys.ip_not_allowed. Sin valor, no hay restricción.

  items ≤ 50

Se usa en

• POST/v1/api-keysCrear una clave de API