Αντικείμενα

ApiKeyCreate

Πεδία

• namestringυποχρεωτικό

  length ≥ 1, length ≤ 64

• rolestring

  Προεπιλογή: "editor"

• data_profilestring | null

  Προφίλ δεδομένων του κλειδιού. Χωρίς αυτό, το κλειδί παίρνει το προεπιλεγμένο προφίλ του οργανισμού. Το προφίλ δεδομένων δεν εφαρμόζεται στον ρόλο admin. Ένα κλειδί διαχειριστή βλέπει όλα τα δεδομένα του οργανισμού, και ένα προφίλ διαφορετικό από full επιστρέφει 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Χρόνος λήξης του κλειδιού (ISO 8601, στο μέλλον). null ή η απουσία τιμής σημαίνει ότι το κλειδί δεν λήγει.

• scopesarray of ApiKeyScope | null

  Εμβέλειες του κλειδιού. Αν λείπουν, οι εμβέλειες ακολουθούν τον ρόλο: ο admin παίρνει read, write, admin· οι editor και verifier παίρνουν read, write· ο viewer παίρνει read. Την εμβέλεια system την εκδίδει μόνο ο διαχειριστής της εγκατάστασης. Γίνονται δεκτές και λεπτομερείς εμβέλειες resource:action (ApiKeyScope)· οι παλαιότερες read, write και admin αναπτύσσονται σε σύνολα εμβελειών.

• collection_idsarray of integer | null

  Περιορίζει το κλειδί σε αυτές τις συλλογές του οργανισμού. Οι κάρτες, η αναζήτηση, οι απαντήσεις και τα συμβάντα λειτουργούν μόνο σε αυτές, επιπλέον του ρόλου και του προφίλ δεδομένων. Η απουσία τιμής ή μια κενή λίστα σημαίνει χωρίς περιορισμό. Αν το κλειδί που κάνει την κλήση είναι το ίδιο περιορισμένο σε συλλογές, το νέο κλειδί μπορεί να βρίσκεται μόνο στις δικές του συλλογές. Χωρίς αυτό το πεδίο, το νέο κλειδί παίρνει τις συλλογές του κλειδιού που κάνει την κλήση. Μια κενή λίστα ή μια συλλογή εκτός της λίστας του επιστρέφει 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Δίκτυα από τα οποία επιτρέπεται να χρησιμοποιείται το κλειδί, π.χ. 10.0.0.0/8 ή 2001:db8::/32. Μια μεμονωμένη διεύθυνση είναι δίκτυο μίας διεύθυνσης. Ένα αίτημα από άλλη διεύθυνση επιστρέφει 403 api_keys.ip_not_allowed. Η απουσία τιμής σημαίνει χωρίς περιορισμό.

  items ≤ 50

Χρησιμοποιείται από

• POST/v1/api-keysΔημιουργία κλειδιού API