단체
업데이트 됨
조직 리소스는 API의 클라이언트와 관련된 다른 모든 API 리소스를 연결하는 데 도움을줍니다 (여기에서 클라이언트는 API 클라이언트 구현이 아니라 API 고객입니다).
API 키를 사용하여 API에 대한 데이터 검색 작업을 수행하기 전에 조직을 구성해야합니다. 적어도 유효한 스토리지 구성이 없으면 API는 결과를 게시하는 방법을 알 수 없습니다.
조직은 기본 사용 권한 집합을 추적합니다. 여기에는 조직 내에서 API에 대해 수행 할 수있는 조작 키가 설명되어 있습니다.
속성
| 이름 | 유형 | 기술 |
|---|---|---|
id | 조직 ID | 자원 식별자. |
resource | 문자열, 항상 organisation | 자원 유형 지정자. |
type | 수퍼 스트링 | 다음 중 하나 : standard , super . |
name | 끈 | 조직의 선택한 이름입니다. |
slug | 끈 | name 의 슬러시 버전. |
api_version | API 버전 | 조직이 사용하도록 구성된 API 버전입니다. |
config | 중첩 개체 | 조직 전체 구성 설정. |
permissions | 사용 권한 리소스 | 중첩 된 사용 권한 리소스 |
storage_configs | 스토리지 구성 자원을 포함하는 목록 오브젝트 | 조직과 관련된 스토리지 구성 개체의 중첩 된 목록입니다. |
storage_config_default | 선택적, 스토리지 구성 ID | 조직의 기본 저장소 구성 ID입니다. |
webhook_configs | webhook 구성 자원을 포함하는 목록 객체 | 조직과 관련된 웹 후크 구성 객체의 중첩 된 목록. |
webhook_config_default | 선택적, webhook 구성 ID | 조직의 기본 Webhook 구성 ID입니다. |
state | 끈 | 다음 중 하나 : unconfigured blocked , active , deactivated , blocked . |
date_created | 날짜 시간 | 리소스가 생성 된 시점. |
종류
-
standard - API 클라이언트.
-
super - API의 내부 관리자 용.
구성
조직 수준 구성은 조직의 config 속성에서 설정할 수 있습니다. 현재로서는 소스 파일 게시 메커니즘 과 관련된 publish_source_files 만 허용됩니다.
권한
permissions 값은 조직에 대한 기본 사용 권한 집합을 지정합니다. 이는 해당 조직의 하위 리소스에 부여되는 가장 엄격한 권한이 아닙니다. 즉 키 또는 사용자는 자신이 소속 된 조직보다 많은 데이터에 액세스 할 수 없습니다.
상태
-
unconfigured - 모든 조직이이 상태로 생성됩니다. 이 상태에 있으면 대부분의 데이터 검색 기능에 대한 액세스가 차단됩니다.
-
active - 조직이 구성되었으며 API의 모든 부분을 사용할 수 있습니다.
-
deactivated - 조직은 소유자의 요청에 따라 종료되었습니다.
-
blocked - 조직은 API 관리자에 의해 종료되었습니다.
변경 로그
2020-02-20
- 주요 사항 조직 객체의
storage_configs및webhook_configs속성은 이제 단순한 목록 속성이 아닌 중첩 된 목록 객체입니다.
GET /organisation 검색
cURL 사용
curl https://ricloud-api.reincubate.com/organisation \ -H 'Authorization: Token <your key_token>'
ricloud-py 사용하기
import ricloud ricloud.Organisation.retrieve()
샘플 응답
{ "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" }
POST /organisation 업데이트
매개 변수
| 이름 | 유형 | 기술 |
|---|---|---|
name | 끈 | 조직의 표시 이름을 변경합니다. |
storage_config_default | 스토리지 구성 ID | 조직에서 사용하는 기본 저장소 구성을 변경하십시오. |
webhook_config_default | webhook 구성 ID | 조직에서 사용하는 기본 webhook 구성을 변경합니다. |
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" }'
ricloud-py 사용하기
import ricloud ricloud.Organisation.update(name='My new org')
샘플 응답. slug 속성은 초기 조직 생성시에만 생성되므로 변경되지 않습니다.
{ "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" }
