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

すべての認証情報を一覧表示します

GET /accounts/{account_id}/core/v1/credentials

コレクション内の一致するすべてのリソースのJSON配列を返します。リクエストで個別のフィールドが指定されている場合、アイテムのJSON配列には、一致する各リソースに対して要求されたフィールドが、指定された順序で含まれます。

パラメータ

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

account_id

string

path(パス)

True

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

  • 例:{{.Account}}

続行

query

False

リストの表示を再開するトークンを示します。

URLの例:"continue="

OpenAPIの例:""</continue>

フィルタ

string

query

False

コレクションを一覧表示する際に、リソースを返すためにどのフィールドを一致させる必要があるかを示します。

サポートされているオペレータは次のとおりです:

  • eq - 等号

  • lt/gt - より小さい/より大きい

  • lte/gte - 以下/以上

URLの例:"filter=field%20eq%20%27value%27"

OpenAPI の例:「field eq 'value'」

含める

string

query

False

コレクションを一覧表示する際に、どのフィールドを返すかを指定します。

URLの例:"include=id"、"include=id,name"

OpenAPI の例:"id"

  • 例:id、name

制限( Limit )

string

query

False

コレクションを一覧表示する際に返されるリソースの最大数を示します。

URLの例:"limit=2"

OpenAPI の例:"2"

OrderBy

string

query

False

コレクションを一覧表示する際の、リソースの並び順を示します。

URLの例:"orderBy=name"、"orderBy=name%20desc"

OpenAPI の例:"name desc"

応答

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
Name を入力します 必須 説明

項目

配列[いずれか:"credential_1.1_get_response_body"、配列[]]

True

メタデータ

"type_astra_metadata_list"

True

回答例
{
  "type": "application/astra-credentials",
  "version": "1.1",
  "items": [
    [
      "f97f3441-075e-4f9b-9d1e-47f9f62a3fc4",
      "myCert"
    ],
    [
      "5e365b4d-034f-4f13-95ef-d3a7fbc0df3d",
      "kubeconfig"
    ],
    [
      "11ceb350-1999-4b79-80a6-46a980a27856",
      "password"
    ]
  ],
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

応答

Status: 401, Unauthorized
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

回答例
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

応答

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/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

エラー

Status: 404, Not found
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

エラー応答の例
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

用語の意味

定義を参照

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

credential_1.1_get_response_body

Name を入力します 必須 説明

を入力します

string

True

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

  • "application/astra-credential"

バージョン

string

True

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

  • "1.0"

  • "1.1"

ID

string

True

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

  • 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内に存在する必要があります。

有効

string

True

認証情報が有効かどうかを示す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"

True

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

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

type_astra_metadata_list

Name を入力します 必須 説明

続行

string

False

カウント

番号

False

ラベル

配列["type_astra_label"]

False

作成タイムスタンプ

string

False

modificationTimestamp

string

False

作成者

string

False

modifiedBy

string

False

invalidParams

Name を入力します 必須 説明

名前

string

True

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

理由

string

True

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