Keys

Een sleutel geeft toegang tot de API op organisatieniveau via zijn token . Het is toegestaan om te communiceren met alle API-eindpunten namens de organisatie.

Voor elke nieuw gecreëerde organisatie wordt een sleutel gegenereerd.

attributen

Types

standard

het type sleutel. Elke organisatie heeft er minstens één.

trial

een sleutel gegenereerd door een API-beheerder om de organisatie proeftoegang tot aanvullende rechten te geven. Deze hebben meestal het veld date_expires .

Configuratie

Configuratie op sleutelniveau kan worden ingesteld op het config van de sleutel. Op dit moment accepteert dit alleen publish_source_files , gerelateerd aan het mechanisme voor het publiceren van bronbestanden .

Opslag- en webhookconfiguraties

Een belangrijke bron kan de standaardwaarden van de organisatie voor opslag en webhook-configuratie overschrijven. Dit kan handig zijn om resultaten en gebeurtenismeldingen te splitsen tussen omgevingen als ontwikkelaar en productie.

Token

De waarde van het token van een sleutel kan worden gebruikt voor verificatie ten opzichte van de API namens de eigenaarorganisatie.

Deze waarden moeten veilig worden opgeslagen en mogen nooit openbaar worden getoond.

Staat

active

de standaardstatus van de sleutel.

deactivated

de eigenaar heeft de sleutel uitgeschakeld.

blocked

de sleutel is uitgeschakeld door een API-beheerder.

expired

de sleutel is uitgeschakeld als de proefperiode voorbij is.

Maak POST /keys

parameters

CURL gebruiken

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

Ricloud-py gebruiken

import ricloud

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

# OR

storage_config = ricloud.StorageConfig.retrieve(2)

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

Ophalen GET /keys/{key ID}

CURL gebruiken

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

Ricloud-py gebruiken

import ricloud

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

Lijst GET /keys

parameters

CURL gebruiken

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

Ricloud-py gebruiken

import ricloud

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

Update POST /keys/{key ID}

parameters

CURL gebruiken

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
}'

Ricloud-py gebruiken

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)

Roteer POST /keys/{key ID}/rotate

Roteer de waarde van het token van een sleutel. Hoewel dit niet verplicht is, wordt het aangeraden dit op een vrij regelmatige basis of onmiddellijk te doen als wordt vermoed dat het token de sleutel is aangetast.

parameters

CURL gebruiken

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

Ricloud-py gebruiken

import ricloud

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

# OR

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

key.rotate()