chiavi

Una chiave consente l'accesso all'API a livello di organizzazione tramite l'attributo token . È consentito interagire con tutti gli endpoint API per conto della sua organizzazione.

Viene generata una chiave per ciascuna organizzazione appena creata.

attributi

tipi

standard

il tipo di chiave. Ogni organizzazione ha almeno uno di questi.

trial

una chiave generata da un amministratore API per consentire all'organizzazione di accedere a autorizzazioni aggiuntive. Questi in genere hanno il campo date_expires impostato.

Configurazione

La configurazione a livello di chiave può essere impostata sull'attributo config della chiave. Per il momento, questo accetta solo publish_source_files , relativo al meccanismo di pubblicazione del file sorgente .

Configurazioni di storage e webhook

Una risorsa chiave può sostituire i valori predefiniti dell'organizzazione per la memorizzazione e la configurazione di webhook. Questo può essere utile per dividere i risultati e la notifica degli eventi tra ambienti come dev e produzione.

Gettone

Il valore dell'attributo token di una chiave può essere utilizzato per l'autenticazione con l'API per conto dell'organizzazione proprietaria.

Questi valori dovrebbero essere archiviati in modo sicuro e non essere mai esposti pubblicamente.

Stato

active

lo stato standard della chiave.

deactivated

l'organizzazione proprietaria ha disattivato la chiave.

blocked

la chiave è stata disabilitata da un amministratore API.

expired

la chiave è disabilitata al termine del periodo di prova.

Crea POST /keys

parametri

Utilizzando cURL

curl 'https://ricloud-api.reincubate.com/keys' \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "storage_config": 2,
}'

Usando ricloud-py

import ricloud

key = ricloud.Key.create(storage_config=2)

# OR

storage_config = ricloud.StorageConfig.retrieve(2)

key = ricloud.Key.create(storage_config=storage_config)

Recupera GET /keys/{key ID}

Utilizzando cURL

curl 'https://ricloud-api.reincubate.com/keys/<key ID>' \
  -H 'Authorization: Token <your key_token>'

Usando ricloud-py

import ricloud

key = ricloud.Key.retrieve(<key ID>)

Elenca GET /keys

parametri

Utilizzando cURL

curl 'https://ricloud-api.reincubate.com/keys?limit=2' \
  -H 'Authorization: Token <your key_token>'

Usando ricloud-py

import ricloud

keys = ricloud.Key.list(limit=2)

Aggiorna POST /keys/{key ID}

parametri

Utilizzando cURL

curl 'https://ricloud-api.reincubate.com/keys/<key ID>' \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook_config": 2
}'

Usando ricloud-py

import ricloud

key = ricloud.Key.update_with_id(<key ID>, webhook_config=2)

# OR

key = ricloud.Key.retrieve(<key ID>)

key.update(webhook_config=2)

Ruota POST /keys/{key ID}/rotate

Ruota il valore del token di una chiave. Sebbene non sia richiesto, si consiglia di farlo su base abbastanza regolare o immediatamente se si sospetta che il token della chiave sia stato compromesso.

parametri

Utilizzando cURL

curl 'https://ricloud-api.reincubate.com/keys/<key ID>/rotate' \
  -X POST \
  -H 'Authorization: Token <your key_token>'

Usando ricloud-py

import ricloud

key = ricloud.Key.rotate_with_id(<key ID>)

# OR

key = ricloud.Key.retrieve(<key ID>)

key.rotate()