Hopp til innholdet
Sursa Developers

Objekter

ApiKeyCreate

Felt

  • namestringobligatorisk

    length ≥ 1, length ≤ 64

  • rolestring

    Standard: "editor"

  • data_profilestring | null

    Nøkkelens dataprofil. Uten dette feltet får nøkkelen organisasjonens standardprofil. En dataprofil gjelder ikke for rollen admin. En nøkkel med denne rollen ser alle data i organisasjonen, og en annen profil enn full returnerer 400 api_keys.data_profile_not_applicable.

  • expires_atstring (date-time) | null

    Nøkkelens utløpstidspunkt (ISO 8601, i framtiden). null eller ingen verdi betyr at nøkkelen ikke utløper.

  • scopesarray of ApiKeyScope | null

    Nøkkelens scopes. Mangler feltet, følger scopene rollen: admin får read, write, admin; editor og verifier får read, write; viewer får read. Scopet system utstedes bare av installasjonens administrator. Finkornede scopes av typen resource:action (ApiKeyScope) godtas også; de tidligere read, write og admin utvides til sett med scopes.

  • collection_idsarray of integer | null

    Begrenser nøkkelen til disse samlingene i organisasjonen. Kort, søk, svar og hendelser virker bare i dem, i tillegg til rollen og dataprofilen. Ingen verdi eller en tom liste betyr ingen begrensning. Hvis nøkkelen som kaller, selv er begrenset til samlinger, kan den nye nøkkelen bare ligge i samlingene til denne nøkkelen. Uten dette feltet får den nye nøkkelen samlingene til nøkkelen som kaller. En tom liste eller en samling utenfor listen til nøkkelen som kaller, returnerer 400 api_keys.invalid_collections.

    items ≤ 100

  • allowed_cidrsarray of string | null

    Nettverk nøkkelen kan brukes fra, for eksempel 10.0.0.0/8 eller 2001:db8::/32. En enkelt adresse er et nettverk med én adresse. En forespørsel fra en annen adresse returnerer 403 api_keys.ip_not_allowed. Ingen verdi betyr ingen begrensning.

    items ≤ 50

Brukes av