Пређите на садржај
Sursa Developers

Објекти

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

Користи се у