キーを作成

新しいAPI keyを作成します。

POST /v1/organizations/{organizationId}/keys

キーを作成

cURL

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expireAt": "2023-11-07T05:31:56Z",
  "hashData": {
    "keyIdHash": "<string>",
    "keyIdSuffix": "<string>",
    "keySecretHash": "<string>"
  },
  "ipAccessList": [
    {
      "description": "<string>",
      "source": "<string>"
    }
  ],
  "name": "<string>",
  "roles": []
}
'

200

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "key": {
      "createdAt": "2023-11-07T05:31:56Z",
      "expireAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ipAccessList": [
        {
          "description": "<string>",
          "source": "<string>"
        }
      ],
      "keySuffix": "<string>",
      "name": "<string>",
      "roles": [],
      "usedAt": "2023-11-07T05:31:56Z"
    },
    "keyId": "<string>",
    "keySecret": "<string>"
  },
  "status": 200
}

承認

Authorization · string · header · 必須

ClickHouse Cloud コンソールで取得した key ID と key secret を使用してください: https://clickhouse.com/docs/cloud/manage/openapi

パスパラメータ

organizationId · string<uuid> · 必須

keyを所有する組織のID。

ボディ

application/json

expireAt · string<date-time> | null

キーの有効期限の timestamp。指定されていない場合、null の場合、または空の場合、このキーは無期限です。ISO-8601。

hashData · object

Show child attributes

ipAccessList · object[]

このキーを使用して API にアクセスできる IP アドレスの一覧

Show child attributes

name · string

キーの名前。

roles · enum<string>[]

キーに割り当てられたロールの一覧。少なくとも 1 つの要素を含みます。

利用可能なオプション: admin, developer, query_endpoints

state · enum<string>

キーの初期状態: 'enabled'、'disabled'。指定しない場合、新しいキーは 'enabled' になります。

利用可能なオプション: enabled, disabled

レスポンス

200

application/json

成功時のレスポンス

requestId · string<uuid>

各リクエストに割り当てられる一意のID。UUIDv4

result · object

Show child attributes

status · number

HTTPステータスコード。

例:

200