Organizações
O recurso de organização ajuda a vincular todos os outros recursos de API relacionados a um cliente da API (aqui, um cliente é um cliente de API, não uma implementação de cliente de API).
Uma organização deve ser configurada antes que suas chaves de API possam ser usadas para executar operações de recuperação de dados na API. Sem pelo menos uma configuração de armazenamento válida, a API não saberá como publicar os resultados.
Uma organização controla um conjunto de permissões de base. Eles descrevem o que as chaves de operações dentro da organização podem executar na API.
Atributos
| nome | tipo | descrição |
|---|---|---|
id | ID da organização | Identificador de recursos. |
resource | string, sempre organisation | Especificador de tipo de recurso. |
type | super, string | Um dos: standard , super . |
name | corda | O nome escolhido para a organização. |
slug | corda | A versão slugified do name . |
api_version | Versão da API | A versão da API que a organização está configurada para usar. |
config | objeto aninhado | Definições de configuração em toda a organização. |
permissions | recurso de permissões | Recurso de permissões aninhadas. |
storage_configs | objeto de lista que contém recursos de configuração de armazenamento | Lista aninhada de objetos de configuração de armazenamento associados à organização. |
storage_config_default | ID de configuração de armazenamento opcional | O ID da configuração de armazenamento padrão da organização. |
webhook_configs | objeto de lista que contém recursos de configuração do webhook | Lista aninhada de objetos de configuração do webhook associados à organização. |
webhook_config_default | opcional, ID de configuração do webhook | O ID da configuração padrão da webhook da organização. |
state | corda | Um de: unconfigured , active , deactivated , blocked . |
date_created | data hora | Quando o recurso foi criado. |
Tipos
-
standard - Para clientes da API.
-
super - Para gerentes internos da API.
Configuração
A configuração no nível da organização pode ser definida no atributo config da organização. No momento, isso aceita apenas publish_source_files , relacionado ao mecanismo de publicação de arquivos de origem .
Permissões
O valor de permissions especifica o conjunto de permissões básicas para a organização. Essas são as permissões menos rígidas concedidas a qualquer sub-recurso dessa organização, ou seja, uma chave ou um usuário não pode ter acesso a mais dados do que a organização à qual pertence.
Estados
-
unconfigured - Toda organização é criada nesse estado. Estar nesse estado bloqueia o acesso à maioria das funcionalidades de recuperação de dados.
-
active - A organização foi configurada e pode usar todas as partes da API.
-
deactivated - A organização foi desativada a pedido do proprietário.
-
blocked - A organização foi encerrada por um administrador da API.
Changelog
2020-02-20
- Principal Os atributos
storage_configsewebhook_configsdo objeto da organização agora são um objeto de lista aninhada, em vez de um simples atributo de lista.
Recuperar GET /organisation
Usando cURL
curl https://ricloud-api.reincubate.com/organisation \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud ricloud.Organisation.retrieve()
Resposta da amostra
{ "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" }
Atualizar POST /organisation
Parâmetros
| nome | tipo | descrição |
|---|---|---|
name | corda | Altere o nome de exibição da sua organização. |
storage_config_default | ID de configuração de armazenamento | Altere a configuração de armazenamento padrão usada por sua organização. |
webhook_config_default | ID de configuração da webhook | Altere a configuração padrão do webhook usada por sua organização. |
Usando cURL
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" }'
Usando ricloud-py
import ricloud ricloud.Organisation.update(name='My new org')
Resposta da amostra. Observe que o atributo slug não é alterado, pois é gerado apenas na criação inicial da organização.
{ "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" }
