キー

更新しました
Cover image for: キー

キーは、そのtoken属性を介して組織レベルでAPIへのアクセスを提供します。組織に代わってすべてのAPIエンドポイントと対話することが許可されています。

新しく作成された組織ごとにキーが生成されます。

属性

タイプ説明
id キーID リソース識別子
resource 文字列、常にkey リソースタイプ指定子
organisation 組織ID このキーが属する組織。
type ひも standardtrial
configネストされたオブジェクトキー固有の構成設定。
storage_config オプション、ストレージ構成ID キーによって使用されるストレージ構成。
webhook_config オプション、ウェブフック設定ID キーによって使用されるWebhook設定。
token ひもこのキーの認証資料。 APIに対するリクエストにAUTHORIZATION HTTPヘッダーをAUTHORIZATIONするために使用されます。
state ひも activedeactivatedblockedexpiredです。
date_created 日付時刻リソースが作成されたとき
date_expires オプション、日時キーが期限切れになるとき。おtrialタイプのキーに主に適用されます。

タイプ

standard
鍵タイプどの組織にも、これらのうち少なくとも1つがあります。
trial
組織に試験的なアクセスを追加の権限に付与するためにAPI管理者によって生成されたキーこれらは通常date_expiresフィールドを設定します。

構成

キーレベルの構成は、キーのconfig属性で設定できます。現時点では、これはソース ファイル公開メカニズムに関連するpublish_source_filesのみを受け入れます。

ストレージと Webhook の構成

重要なリソースは、storageおよびwebhook configの組織のデフォルト値を上書きできます。これは、開発環境と本番環境のような環境間で結果とイベント通知を分割するのに役立ちます。

トークン

キーのtoken属性の値は、所有組織に代わってAPIに対して認証するために使用できます。

これらの値は安全に保管し、一般に公開しないでください。

状態

active
キーの標準状態
deactivated
所有組織が鍵を無効にしました。
blocked
キーはAPI管理者によって無効にされています。
expired
試用期間が過ぎると、キーは無効になります。

POST /keys作成

パラメーター

名前タイプ説明
storage_configストレージ構成 IDこのキーで組織のデフォルトのストレージ構成をオーバーライドします。
webhook_config Webhook 構成 IDこのキーで組織のデフォルトの Webhook 構成をオーバーライドします。

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}取得し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 Webhook 構成 IDキーで使用される Webhook 構成を更新します。 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 。必須ではありませんが、かなり定期的に、または鍵の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時(GMT)です。 時間は現在 8:25 AM GMTです。

1営業日以内に、お返事を差し上げます。メールアドレスはこちら。

私たちの素晴らしいサポートチーム

© 2008 - 2023 Reincubate Ltd. 無断複写・転載を禁じます。 イングランドとウェールズに登録 #5189175, VAT GB151788978. Reincubate®およびCamo®は登録商標です。 個人情報保護方針 & 条項. ロンドンで愛と建てられた。