本文へスキップ
Sursa Developers

オブジェクト

ApiKeyCreate

フィールド

  • namestring必須

    length ≥ 1, length ≤ 64

  • rolestring

    デフォルト:"editor"

  • data_profilestring | null

    キーのデータプロファイル。省略した場合、キーには組織のデフォルトのプロファイルが割り当てられます。データプロファイルはadminロールには適用されません。管理者のキーは組織のすべてのデータにアクセスでき、full以外のプロファイルを指定すると400 api_keys.data_profile_not_applicableが返ります。

  • expires_atstring (date-time) | null

    キーの有効期限(ISO 8601、未来の時刻)。nullまたは値なしの場合、キーは期限切れになりません。

  • scopesarray of ApiKeyScope | null

    キーのスコープ。省略した場合、スコープはロールに従います:adminにはread、write、admin、editorとverifierにはread、write、viewerにはreadが付与されます。systemスコープはインストール環境の管理者だけが発行します。細かいresource:actionスコープ(ApiKeyScope)も指定できます。以前のread、write、adminは、スコープのセットに展開されます。

  • collection_idsarray of integer | null

    キーの対象を組織のこれらのコレクションに限定します。カード、検索、回答、イベントは、ロールとデータプロファイルに加えて、これらのコレクションの中だけで機能します。値なしまたは空のリストは、制限なしを意味します。呼び出し元のキー自体がコレクションに限定されている場合、新しいキーはそのコレクションの中にしか置けません。このフィールドがない場合、新しいキーには呼び出し元のキーのコレクションが設定されます。空のリスト、または呼び出し元のキーのリストにないコレクションは400 api_keys.invalid_collectionsを返します。

    items ≤ 100

  • allowed_cidrsarray of string | null

    キーを使用できるネットワーク(10.0.0.0/8、2001:db8::/32など)。単一のアドレスは、そのアドレスだけからなるネットワークとして扱われます。ほかのアドレスからのリクエストには403 api_keys.ip_not_allowedが返ります。値なしは制限なしを意味します。

    items ≤ 50

使用箇所