Objektit

ApiKeyCreate

Kentät

• namestringpakollinen

  length ≥ 1, length ≤ 64

• rolestring

  Oletus: "editor"

• data_profilestring | null

  Avaimen dataprofiili. Ilman tätä kenttää avain saa organisaation oletusprofiilin. Dataprofiili ei koske admin-roolia. Avain, jolla on tämä rooli, näkee kaikki organisaation tiedot, ja muu profiili kuin full palauttaa 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Avaimen vanhenemisaika (ISO 8601, tulevaisuudessa). null tai puuttuva arvo tarkoittaa, että avain ei vanhene.

• scopesarray of ApiKeyScope | null

  Avaimen käyttöalueet. Jos kenttää ei ole, käyttöalueet määräytyvät roolin mukaan: admin saa käyttöalueet read, write, admin; editor ja verifier saavat read, write; viewer saa read. Käyttöalueen system myöntää vain asennuksen ylläpitäjä. Myös hienojakoiset resource:action-käyttöalueet (ApiKeyScope) hyväksytään; aiemmat read, write ja admin laajenevat käyttöalueiden joukoiksi.

• collection_idsarray of integer | null

  Rajaa avaimen näihin organisaation kokoelmiin. Kortit, haku, vastaukset ja tapahtumat toimivat vain niissä; rajaus tulee roolin ja dataprofiilin lisäksi. Puuttuva arvo tai tyhjä luettelo tarkoittaa, ettei rajausta ole. Jos kutsuva avain on itse rajattu kokoelmiin, uusi avain voi olla vain sen kokoelmissa. Ilman tätä kenttää uusi avain saa kutsuvan avaimen kokoelmat. Tyhjä luettelo tai kokoelma sen luettelon ulkopuolelta palauttaa 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Verkot, joista avainta voi käyttää, kuten 10.0.0.0/8 tai 2001:db8::/32. Yksittäinen osoite on yhden osoitteen verkko. Pyyntö muusta osoitteesta palauttaa 403 api_keys.ip_not_allowed. Puuttuva arvo tarkoittaa, ettei rajausta ole.

  items ≤ 50

Käytössä

• POST/v1/api-keysLuo API-avain