新しいクレデンシャルを作成
POST /accounts/{account_id}/core/v1/credentials
作成する Credential API リソースの希望する値を指定します。
パラメータ
| Name | を入力します | 入力 | 必須 | 説明 |
|---|---|---|---|---|
account_id |
string |
path(パス) |
True |
包含するアカウントリソースのID
|
要求の本文
作成する Credential API リソースの希望する値を指定します。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
リソースのメディアタイプ。定義された値は次のとおりです:
|
バージョン |
string |
True |
リソースのバージョン。定義された値は次のとおりです:
|
名前 |
string |
True |
ユーザーが指定した名前を含むJSON文字列。ユーザーに対してクレデンシャルが作成されると、名前はそのユーザーのUUIDに設定されます。定義されている値は次のとおりです:
|
keyType |
string |
False |
keyStoreの内容のオプションのユーザー指定データ検証タイプ記述子を含む JSON 文字列。拡張更新制約:
|
keyStore |
True |
JSON文字列を含むJSONオブジェクト。keyStore内の各文字列は、クレデンシャルの一部を表します。各文字列の名前はクレデンシャルの一部を表し、対応するキー値には、そのクレデンシャルの一部の値がbase64形式で格納されます。定義された値は次のとおりです:
|
|
有効 |
string |
False |
認証情報が有効かどうかを示すJSON文字列。省略した場合のデフォルト値は「true」です。定義された値は次のとおりです:
|
validFromTimestamp |
string |
False |
認証情報が有効になった日時を示すタイムスタンプを含むJSON文字列。これらは認証情報のローテーションに使用されます。定義された値は次のとおりです:
|
validUntilTimestamp |
string |
False |
認証情報が無効になった日時を示すタイムスタンプを含むJSON文字列。これらは資格情報のローテーションに使用されます。定義された値は次のとおりです:
|
メタデータ |
False |
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
|
リクエスト例
{
"type": "application/astra-credential",
"version": "1.1",
"name": "myCert",
"keyStore": {
"privKey": "SGkh",
"pubKey": "VGhpcyBpcyBhbiBleGFtcGxlLg=="
}
}
応答
Status: 201, Returns the newly created credential resource in the JSON response body.
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
リソースのメディアタイプ。定義された値は次のとおりです:
|
バージョン |
string |
True |
リソースのバージョン。定義された値は次のとおりです:
|
ID |
string |
True |
リソースのグローバル一意識別子。定義された値は次のとおりです:
|
名前 |
string |
True |
ユーザーが指定した名前を含むJSON文字列。ユーザーに対してクレデンシャルが作成されると、名前はそのユーザーのUUIDに設定されます。定義されている値は次のとおりです:
|
keyType |
string |
False |
keyStoreの内容のオプションのユーザー指定データ検証タイプ記述子を含む JSON 文字列。拡張更新制約:
|
有効 |
string |
True |
認証情報が有効かどうかを示すJSON文字列。省略した場合のデフォルト値は「true」です。定義された値は次のとおりです:
|
validFromTimestamp |
string |
False |
認証情報が有効になった日時を示すタイムスタンプを含むJSON文字列。これらは認証情報のローテーションに使用されます。定義された値は次のとおりです:
|
validUntilTimestamp |
string |
False |
認証情報が無効になった日時を示すタイムスタンプを含むJSON文字列。これらは資格情報のローテーションに使用されます。定義された値は次のとおりです:
|
メタデータ |
True |
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
|
回答例
{
"type": "application/astra-credential",
"version": "1.1",
"id": "58e26f6a-a631-5122-8e0e-7afe306675c0",
"name": "myCert",
"valid": "true",
"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 |
|
invalidFields |
配列["invalidFields"] |
False |
無効なリクエストボディフィールドのリスト |
回答例
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
応答
Status: 409, Conflict
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
|
invalidFields |
配列["invalidFields"] |
False |
無効なリクエストボディフィールドのリスト |
回答例
{
"type": "https://astra.netapp.io/problems/10",
"title": "JSON resource conflict",
"detail": "The request body JSON contains a field that conflicts with an idempotent value.",
"status": "409"
}
応答
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: 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"
}
用語の意味
定義を参照
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 | を入力します | 必須 | 説明 |
|---|---|---|---|
ラベル |
False |
||
作成タイムスタンプ |
string |
False |
|
modificationTimestamp |
string |
False |
|
作成者 |
string |
False |
|
modifiedBy |
string |
False |
invalidParams
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
無効なクエリパラメータの名前 |
理由 |
string |
True |
クエリパラメータが無効な理由 |
invalidFields
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
無効なリクエストボディフィールドの名前 |
理由 |
string |
True |
リクエスト本文フィールドが無効な理由 |