organisaties
De organisatiebron helpt alle andere API-bronnen die betrekking hebben op een client van de API met elkaar te verbinden (hier is een client een API-klant, geen implementatie van een API-client).
Een organisatie moet worden geconfigureerd voordat de API-sleutels kunnen worden gebruikt voor het ophalen van gegevensbewerkingen met de API. Zonder ten minste een geldige opslagconfiguratie weet de API niet hoe resultaten moeten worden gepubliceerd.
Een organisatie houdt een aantal basisrechten bij. Deze beschrijven welke bewerkingssleutels binnen de organisatie mogen optreden tegen de API.
attributen
| naam | type | Omschrijving |
|---|---|---|
id | organisatie ID | Bron-ID. |
resource | string, altijd organisation | Specificatie middelenbron. |
type | super, string | Een van: standard , super . |
name | draad | De gekozen naam voor de organisatie. |
slug | draad | De verpulverde versie van de name . |
api_version | API-versie | De API-versie waarvoor de organisatie is geconfigureerd. |
config | genest voorwerp | Configuratie-instellingen voor de hele organisatie. |
permissions | machtigingenbron | Geneste machtigingenbron . |
storage_configs | lijstobject met opslagconfiguratieresources | Geneste lijst met opslagconfiguratieobjecten die aan de organisatie zijn gekoppeld. |
storage_config_default | optioneel, opslagconfiguratie ID | De ID van de standaardopslagconfiguratie van de organisatie. |
webhook_configs | lijstobject met webhook-configuratiebronnen | Geneste lijst met webhook-configuratieobjecten die aan de organisatie zijn gekoppeld. |
webhook_config_default | optioneel, webhook config-ID | De ID van de standaard webhook-configuratie van de organisatie. |
state | draad | Eén van: niet- unconfigured , active , deactivated , blocked . |
date_created | datum Tijd | Wanneer de resource is gemaakt. |
Types
-
standard - Voor klanten van de API.
-
super - Voor interne managers van de API.
Configuratie
Configuratie op organisatieniveau kan worden ingesteld op het config -attribuut van de organisatie. Op dit moment accepteert dit alleen publish_source_files , gerelateerd aan het mechanisme voor het publiceren van bronbestanden .
Rechten
De permissions waarde bepaalt de set van de basis rechten voor de organisatie. Dit zijn de minst strikte rechten die worden verleend aan een subresource van die organisatie, dat wil zeggen dat een sleutel of een gebruiker geen toegang heeft tot meer gegevens dan de organisatie waartoe het behoort.
Staten
-
unconfigured - Elke organisatie is in deze staat gecreëerd. Als u zich in deze status bevindt, blokkeert u de toegang tot de meeste functies voor gegevensherstel.
-
active - De organisatie is geconfigureerd en kan alle delen van de API gebruiken.
-
deactivated - De organisatie is op verzoek van de eigenaar gesloten.
-
blocked - De organisatie is afgesloten door een API-beheerder.
Changelog
2020-02-20
- Belangrijk De kenmerken
storage_configsenwebhook_configsvan het organisatieobject zijn nu een genestwebhook_configs, in plaats van een eenvoudigwebhook_configs.
Haal GET /organisation
CURL gebruiken
curl https://ricloud-api.reincubate.com/organisation \ -H 'Authorization: Token <your key_token>'
Ricloud-py gebruiken
import ricloud ricloud.Organisation.retrieve()
Voorbeeldantwoord
{ "id": 1, "resource": "organisation", "name": "My org", "slug": "my-org", "api_version": "2020-02-20", "permissions": { "id": 1, "resource": "organisation_permissions", "identifier": "default", "scopes": { "source_type:icloud.*": [], "task_type:*": [], "data_type:icloud.account.info": [], }, "date_created": "2018-11-08T13:05:29.954188Z" }, "storage_configs": { "data": [ { "id": 1, "resource": "storage_config", "type": "gs", "url": "gs://my-storage-bucket", "credentials": {}, "state": "valid", "date_created": "2018-11-08T16:47:56.849618Z" } ], "has_more": false, "total_count": 1, "url": "/configs/storage" }, "storage_config_default": 1, "webhook_configs": { "data": [ { "id": 1, "resource": "webhook_config", "url": "https://www.mywebhookendpoint.com/webhooks", "secret": "Wg69dQaffJuXckXsdoHuPYkf3VSWEGMa", "state": "valid", "date_created": "2018-11-08T13:07:59.563975Z" } ], "has_more": false, "total_count": 1, "url": "/configs/webhook" }, "webhook_config_default": 1, "state": "active", "date_created": "2018-11-08T13:05:29.784270Z" }
Update POST /organisation
parameters
| naam | type | Omschrijving |
|---|---|---|
name | draad | Verander de weergavenaam van uw organisatie. |
storage_config_default | opslagconfiguratie ID | Wijzig de standaard opslagconfiguratie die door uw organisatie wordt gebruikt. |
webhook_config_default | webhook config ID | Wijzig de standaard webhook-configuratie die door uw organisatie wordt gebruikt. |
CURL gebruiken
curl 'https://ricloud-api.reincubate.com/organisation' \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "name": "My new organisation name" }'
Ricloud-py gebruiken
import ricloud ricloud.Organisation.update(name='My new org')
Voorbeeld reactie. Houd er rekening mee dat het slug kenmerk niet wordt gewijzigd, omdat het alleen wordt gegenereerd bij het maken van de eerste organisatie.
{ "id": 1, "resource": "organisation", "name": "My new org", "slug": "my-org", "permissions": {}, "storage_configs": { "data": [ { "id": 1, "resource": "storage_config", "type": "gs", "url": "gs://my-storage-bucket", "credentials": {}, "state": "valid", "date_created": "2018-11-08T16:47:56.849618Z" } ], "has_more": false, "total_count": 1, "url": "/configs/storage" }, "storage_config_default": 1, "webhook_configs": { "data": [ { "id": 1, "resource": "webhook_config", "url": "https://www.mywebhookendpoint.com/webhooks", "secret": "Wg69dQaffJuXckXsdoHuPYkf3VSWEGMa", "state": "valid", "date_created": "2018-11-08T13:07:59.563975Z" } ], "has_more": false, "total_count": 1, "url": "/configs/webhook" }, "webhook_config_default": 1, "state": "active", "date_created": "2018-11-08T13:05:29.784270Z" }
