Skip to main content
23.10
本製品の最新リリースがご利用いただけます。
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

認証情報を変更する

PDF

PUT /accounts/{account_id}/core/v1/credentials/{credential_id}

保存されているリソース全体を、指定されたJSONリクエストボディに置き換えますが、ユーザーが変更できないキー値は保持します。

パラメータ

Name を入力します 入力 必須 説明

account_id

string

path（パス）

True

包含するアカウントリソースのID

  • 例：{{.Account}}

credential_id

string

path（パス）

True

リストする認証情報コレクションのID

要求の本文

保存されているリソース全体を、指定されたJSONリクエストボディに置き換えますが、ユーザーが変更できないキー値は保持します。

Name を入力します 必須 説明

を入力します

string

True

リソースのメディアタイプ。定義された値は次のとおりです：

  • "application/astra-credential"

バージョン

string

True

リソースのバージョン。定義された値は次のとおりです：

  • "1.0"

  • "1.1"

ID

string

False

リソースのグローバル一意識別子。定義された値は次のとおりです：

  • UUIDv4スキーマに準拠

名前

string

True

ユーザーが指定した名前を含むJSON文字列。ユーザーに対してクレデンシャルが作成されると、名前はそのユーザーのUUIDに設定されます。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：127

keyType

string

False

keyStoreの内容のオプションのユーザー指定データ検証タイプ記述子を含む JSON 文字列。拡張更新制約：

  • keyTypeがリソースに存在せず、更新でも指定されていない場合、keyTypeは更新されたリソースに存在し続けてはなりません。

  • keyTypeがリソースに存在せず、更新で指定されている場合、keyTypeをリソースに追加し、検証を実行する必要があります。検証に失敗した場合、更新は失敗します。

  • もしkeyTypeがリソース内に存在し、更新で指定されていない場合、keyTypeを保存しなければならない。

  • keyTypeがリソース内に存在し、更新で指定され、指定されたkeyTypeが既存のkeyTypeと一致する場合、keyTypeを保持する必要があります。

  • keyTypeがリソース内に存在し、更新で指定され、指定されたkeyTypeが既存のkeyTypeと異なる場合、更新は失敗します。定義された値は次のとおりです：

  • 「generic」 - 認証情報は汎用的なデータの集合です。これは、keyTypeを含めないことと同等です。

  • 拡張検証は以下のように実施されます：

  • 1つ以上の文字列がkeyStoreに存在する必要があります。

  • keyStore内のすべての文字列は、base64でエンコードされた値を持つ必要があります。

  • 「passwordHash」- 認証情報はパスワードハッシュです。

  • 拡張検証は以下のように実施されます：

  • 認証情報の名前は一意である必要があります。

  • 認証情報の名前は、有効なユーザーリソースIDと一致している必要があります。

  • クレデンシャルの名前は変更しないでください。

  • 対応するユーザーリソースには「authProvider」が「local」である必要があります。

  • 「平文」文字列が keyStore 内に存在する必要があります。値には base64 エンコードされた平文パスワードが含まれます：

  • パスワードの平文は、アカウントのパスワードポリシーに準拠する必要があります。

  • パスワードはハッシュ値として保存されます。

  • 「変更」文字列は、keyStore内に存在する必要があり、値にはbase64エンコードされた文字列「true」または「false」が含まれます。

  • passwordHashタイプのクレデンシャルは、名前で示されるユーザーIDが存在しない場合にのみ削除できます。

  • 「apikey」 - クレデンシャルはAPIキーです。

  • 拡張検証は以下のように実施されます：

  • 「apikey」文字列は、keyStore内に存在する必要があり、その値にはbase64エンコードされた任意の文字列が含まれます。

  • 「kubeconfig」 - クレデンシャルはkubeconfigです。

  • 拡張検証は以下のように実施されます：

  • 「base64」文字列は、keyStore内に存在する必要があり、その値にはbase64エンコードされたJSON kubeconfigファイルが含まれている必要があります。

  • kubeconfig ファイルには、単一のクラスターのみを記述する必要があります。

  • keyStore内に他のフィールドは存在できません。

  • 「certificate」 - 認証情報はPEMエンコードされた証明書です

  • 拡張検証は以下のように実施されます：

  • 「証明書」文字列は、keyStore内に存在する必要があり、値にはbase64エンコードされたPEM証明書が含まれます。

  • 「privkey」 - クレデンシャルはPEMエンコードされた秘密鍵です。

  • 拡張検証は以下のように実施されます：

  • 「privkey」文字列は、keyStore内に存在する必要があり、その値にはbase64エンコードされたPEM秘密鍵が含まれます。

  • 「s3」 - 認証情報が Simple Storage Service（S3）アクセス用であることを示します。

  • 拡張検証は以下のように実施されます：

  • 「accessKey」文字列は、Base64エンコードされたS3アクセスキーを含む値を持つkeyStore内に存在する必要があります。

  • 「accessSecret」文字列は、Base64エンコードされたS3アクセスシークレットを含む値を持つkeyStore内に存在する必要があります。

keyStore

"keyStore"

True

JSON文字列を含むJSONオブジェクト。keyStore内の各文字列は、クレデンシャルの一部を表します。各文字列の名前はクレデンシャルの一部を表し、対応するキー値には、そのクレデンシャルの一部の値がbase64形式で格納されます。定義された値は次のとおりです：

  • base64 Encoded Data Schemaに準拠しています。文字列の長さに制限はありません。

有効

string

False

認証情報が有効かどうかを示すJSON文字列。省略した場合のデフォルト値は「true」です。定義された値は次のとおりです：

  • 「true」 - この認証情報は使用可能です。

  • 「false」 - この認証情報は使用してはなりません。

validFromTimestamp

string

False

認証情報が有効になった日時を示すタイムスタンプを含むJSON文字列。これらは資格情報のローテーションに使用されます。定義された値は次のとおりです：

  • ISO-8601 Date Time Schemaに準拠

validUntilTimestamp

string

False

認証情報が無効になった日時を示すタイムスタンプを含むJSON文字列。これらは資格情報のローテーションに使用されます。定義された値は次のとおりです：

  • ISO-8601 Date Time Schemaに準拠

メタデータ

"type_astra_metadata_update"

False

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

  • Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。
リクエスト例 
{
  "type": "application/astra-credential",
  "version": "1.1",
  "name": "oldCert",
  "keyStore": {
    "privKey": "SGkh",
    "pubKey": "VGhpcyBpcyBhbiBleGFtcGxlLg=="
  }
}

応答

Status: 204, Indicates if the credential resource was updated.

応答

Status: 403, Forbidden
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
回答例 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

応答

Status: 406, Not acceptable
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
回答例 
{
  "type": "https://astra.netapp.io/problems/32",
  "title": "Unsupported content type",
  "detail": "The response can't be returned in the requested format.",
  "status": "406"
}

応答

Status: 500, Internal server error
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
回答例 
{
  "type": "https://astra.netapp.io/problems/34",
  "title": "Internal server error",
  "detail": "The server was unable to process this request.",
  "status": "500"
}

応答

Status: 412, Precondition failed
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
回答例 
{
  "type": "https://astra.netapp.io/problems/38",
  "title": "Precondition not met",
  "detail": "The conditional headers aren't satisfied.",
  "status": "412"
}

応答

Status: 409, Conflict
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
回答例 
{
  "type": "https://astra.netapp.io/problems/39",
  "title": "Credential exists",
  "detail": "A credential of this type already exists.",
  "status": "409"
}

応答

Status: 502, Bad gateway
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
回答例 
{
  "type": "https://astra.netapp.io/problems/40",
  "title": "Communication failed",
  "detail": "Communication wasn't made with downstream services.",
  "status": "502"
}

応答

Status: 503, Service unavailable
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
回答例 
{
  "type": "https://astra.netapp.io/problems/41",
  "title": "Service not ready",
  "detail": "Currently, the service can't respond to this request.",
  "status": "503"
}

エラー

Status: 400, Bad request
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

invalidParams

配列["invalidParams"]

False

無効なクエリパラメータのリスト
エラー応答の例 
{
  "type": "https://astra.netapp.io/problems/7",
  "title": "Invalid JSON payload",
  "detail": "The request body is not valid JSON.",
  "status": "400"
}

用語の意味

定義を参照

keyStore

JSON文字列を含むJSONオブジェクト。keyStore内の各文字列は、クレデンシャルの一部を表します。各文字列の名前はクレデンシャルの一部を表し、対応するキー値には、そのクレデンシャルの一部の値がbase64形式で格納されます。定義された値は次のとおりです：

  • base64 Encoded Data Schemaに準拠しています。文字列の長さに制限はありません。

文字列から文字列へのハッシュマッピング

type_astra_label

Name を入力します 必須 説明

名前

string

True

Value

string

True

type_astra_metadata_update

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

  • Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。

Name を入力します 必須 説明

ラベル

配列["type_astra_label"]

False

作成タイムスタンプ

string

False

modificationTimestamp

string

False

作成者

string

False

modifiedBy

string

False

invalidFields

Name を入力します 必須 説明

名前

string

True

無効なリクエストボディフィールドの名前

理由

string

True

リクエスト本文フィールドが無効な理由

invalidParams

Name を入力します 必須 説明

名前

string

True

無効なクエリパラメータの名前

理由

string

True

クエリパラメータが無効な理由