本文へスキップ
Sursa Developers

オブジェクト

ApiKeyUpdate

キーの変更。渡さなかったフィールドは変わらず、data_profileは省略できます。空のscopesリストはロールに応じたスコープ、空のcollection_idsとallowed_cidrsは制限なし、nullに設定したexpires_atはキーが期限切れにならないことを意味します。コレクションに限定されたキー自体は、コレクションへの限定(collection_ids)を外すことも広げることもできません。

フィールド

  • data_profilestring

    キーの新しいデータプロファイル。データプロファイルはadminロールには適用されないため、管理者のキーにfull以外のプロファイルを指定すると400 api_keys.data_profile_not_applicableが返ります。

  • scopesarray of ApiKeyScope

    キーのスコープ。systemスコープはAPIでは発行されません。

  • collection_idsarray of integer

    キーの対象をこれらのコレクションに限定します。空のリストは制限なしを意味します。呼び出し元のキー自体がコレクションに限定されている場合、そのキーで参照・変更できるのは、そのコレクションの中のキーだけで(それ以外のキーは404 api_keys.not_foundを返します)、設定できるのは、自身のコレクションからなる空でないリストだけです。空のリスト、またはそのリストにないコレクションは400 api_keys.invalid_collectionsを返します。このフィールドがない場合、キーのコレクションは変わりません。

    items ≤ 100

  • allowed_cidrsarray of string

    キーを使用できるネットワーク。

    items ≤ 50

  • expires_atstring (date-time) | null

    有効期限(未来の時刻)。nullは、キーが期限切れにならないことを意味します。

使用箇所