열쇠

업데이트 됨

키는 token 속성을 통해 조직 수준의 API에 대한 액세스를 제공합니다. 조직을 대신하여 모든 API 엔드 포인트와 상호 작용할 수 있습니다.

새로 생성 된 조직마다 키가 생성됩니다.

속성

이름 유형 기술
id 키 ID 자원 식별자.
resource 문자열, 항상 key 자원 유형 지정자.
organisation 조직 ID 이 키가 속한 조직입니다.
type standard , trial 중 하나입니다.
config 중첩 개체 키별 구성 설정.
storage_config 선택적, 스토리지 구성 ID 키가 사용하는 저장소 구성입니다.
webhook_config 선택적, webhook 구성 ID 키가 사용하는 webhook 구성입니다.
token 이 키에 대한 승인 자료입니다. API에 대한 요청에서 AUTHORIZATION HTTP 헤더를 채우는 데 사용됩니다.
state 다음 중 하나가 active , deactivated , blocked , expired .
date_created 날짜 시간 리소스가 생성 된 시점.
date_expires 선택적, datetime 열쇠가 만료 될 때. 주로 trial 유형 키에 적용됩니다.

종류

standard
열쇠 형. 모든 조직에는 이들 중 적어도 하나가 있습니다.
trial
API 관리자가 조직에 추가 권한에 대한 액세스 권한을 부여 할 수 있도록 생성 한 키입니다. 일반적으로 date_expires 필드가 설정됩니다.

구성

키 수준 구성은 키의 config 속성에서 설정할 수 있습니다. 현재로서는 소스 파일 게시 메커니즘 과 관련된 publish_source_files 만 허용됩니다.

스토리지 및 웹훅 구성

주요 리소스는 스토리지 및 Webhook 구성의 조직 기본값을 무시할 수 있습니다. 이는 dev 및 production과 같은 환경간에 결과 및 이벤트 알림을 분리하는 데 유용 할 수 있습니다.

토큰

키의 token 속성 값은 소유 조직을 대신하여 API에 대해 인증하는 데 사용될 수 있습니다.

이 값은 안전하게 저장해야하며 공개적으로 노출되지 않아야합니다.

상태

active
열쇠의 표준 상태
deactivated
소유하는 조직이 키를 사용 중지했습니다.
blocked
키가 API 관리자에 의해 사용 중지되었습니다.
expired
시용 기간이 지나면 키가 비활성화됩니다.

POST /keys 만들기

매개 변수

이름 유형 설명
storage_config 스토리지 구성 ID 이 키에서 조직의 기본 저장소 구성을 재정의합니다.
webhook_config 웹훅 구성 ID 이 키에서 조직의 기본 웹후크 구성을 재정의합니다.

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

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)

가져 GET /keys/{key ID}

cURL 사용

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

ricloud-py 사용하기

import ricloud

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

GET /keys 나열

매개 변수

이름 유형 설명
type 유형별로 키를 필터링합니다.
state 상태별로 키를 필터링합니다.

cURL 사용

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

ricloud-py 사용하기

import ricloud

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

POST /keys/{key ID} 업데이트

매개 변수

이름 유형 설명
storage_config 스토리지 구성 ID 키에서 사용하는 스토리지 구성을 업데이트합니다. null 조직 기본값으로 돌아갑니다.
webhook_config 웹훅 구성 ID 키에서 사용하는 웹훅 구성을 업데이트합니다. null 조직 기본값으로 돌아갑니다.

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

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)

회전 POST /keys/{key ID}/rotate

키의 token 값을 회전합니다. 필수 사항은 아니지만 키의 token 이 손상되었다고 의심되는 경우 즉시 또는 정기적으로 수행하는 것이 좋습니다.

매개 변수

이름 유형 설명
force 부울, 기본값: False 현재 token 값을 즉시 승인 취소해야 하는 경우. 그렇지 않은 경우 현재 회전 기간은 통화 후 6시간입니다.

cURL 사용

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

ricloud-py 사용하기

import ricloud

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

# OR

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

key.rotate()

어떻게 도와 드릴까요?

지원 팀이 도와 드리겠습니다!

근무 시간은 월요일부터 금요일, 오전 9 시부 터 오후 5시 (그리니치 표준시)입니다. 시간은 현재 4:13 오전 GMT입니다.

우리는 1 일 이내에 모든 메시지에 답장하고자합니다.

우리의 멋진 지원 팀

© 2008 - 2024 Reincubate Ltd. 판권 소유. 영국과 웨일즈에 등록 #5189175, VAT GB151788978. Reincubate® 및 Camo®는 등록 상표입니다. 개인 정보 정책 & 자귀.