作成後のAPIキーの管理

APIキーの作成後、いつでもプロパティを変更できます。

秘密鍵をリセットする

APIKeysApi オブジェクトを使用して、既存のAPIキーの新しい秘密鍵を生成します。たとえば、APIキーを定期的にローテーションするときに秘密鍵をリセットします。一度置き換えられると、以前の秘密鍵は Workload Securityによって認証されなくなります。

秘密鍵をリセットすると、返されたAPIキーに secret_key (Python)または secretKey (JavaScript)プロパティの新しい秘密鍵が含まれます。Javaの場合、返される ApiKey オブジェクトの getSecretKey メソッドを使用できます。

APIKeysApiクラスは、APIキーのIDをパラメータとして使用する replace_api_secret_key 関数(JavaScriptおよびJavaのreplaceApiSecretKey )を提供します。次の例では、既存のAPIキーの新しい秘密鍵が作成されます。

ソースを表示

# Reset the key
api_keys_api = api.APIKeysApi(api.ApiClient(configuration))
return api_keys_api.replace_api_secret_key(key_id, api_version)

APIレファレンス/参照情報の API秘密鍵の生成 も参照してください。

作成後のAPIキーへのアクセスの制御

APIキーを作成した後も、Workload SecurityへのAPIキーのアクセスは制御できます。

  • アクセス権の変更: APIキーに関連付けられている役割を変更するか、APIキーを別の役割に関連付けます。( ロールのを使用したアクセスの制御を参照してください。)
  • アクセスの取り消し: 一時的にアクセスを取り消すにはキーをロックするか、APIキーを削除してアクセスを完全に取り消します。

APIキーを変更するには、 ApiKey オブジェクトを作成し、変更するプロパティの値を設定します。次に、 APIKeysApi クラスを使用して、 Workload SecurityでAPIキーを変更します。

次のコード例は、APIキーに関連付けられている役割を変更します。

ソースを表示

# Create a key and set the role ID
key = api.ApiKey()
key.role_id = role_id

# Modify the key on Workload Security
api_keys_api = api.APIKeysApi(api.ApiClient(configuration))
api_keys_api.modify_api_key(key_id, key, api_version)
return key.role_id

APIリファレンスの APIキーの変更, 削除およびAPIキー、および の管理者ロールの変更 操作もレファレンス/参照情報。

Workload Security を使用してAPIキーを変更するには、 [管理]→[ユーザ管理]→[APIキー]→[]の順に選択し、APIキーを選択して[ プロパティ] []の順にクリックします。