グループの新しいユーザを作成する
POST /accounts/{account_id}/core/v1/groups/{group_id}/users
作成するユーザー API リソースの希望値を指定します。
パラメータ
| Name | を入力します | 入力 | 必須 | 説明 |
|---|---|---|---|---|
account_id |
string |
path(パス) |
True |
包含するアカウントリソースのID
|
group_id |
string |
path(パス) |
True |
包含するグループリソースのID |
要求の本文
作成するユーザー API リソースの希望値を指定します。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
リソースのメディアタイプ。定義された値は次のとおりです:
|
バージョン |
string |
True |
リソースのバージョン。定義された値は次のとおりです:
|
authID |
string |
False |
外部IDプロバイダに関連付けられた識別子を含むJSON文字列。この文字列の内容は、指定されたauthProviderによって異なります。「authProvider」が「local」のユーザの場合、「authID」は「email」の値に設定されます。「authProvider」が「ldap」のユーザの場合、「authID」はLDAPサーバからの識別名(DN)に設定されます。 |
authProvider |
string |
False |
idAuth識別子のコンテキストを示すJSON文字列。定義された値は次のとおりです:
|
firstName |
string |
False |
ユーザーが指定したフルネーム(名)を含むJSON文字列。定義された値は次のとおりです:
|
lastName |
string |
False |
ユーザーが指定した長めの姓を含むJSON文字列。定義された値は次のとおりです:
|
companyName |
string |
False |
ユーザーに関連付けられた会社名を含むJSON文字列。このキーが存在しない場合、会社名が提供されていないことを示します。定義された値は次のとおりです:
|
string |
True |
ユーザーが指定したメールアドレスを含むJSON文字列。 |
|
電話 |
string |
False |
ユーザーの電話番号を含むJSON文字列。このキーが存在しない場合、電話番号が提供されていないことを示します。 |
postalAddress |
False |
住所を指定するフィールドの集合を含むJSONオブジェクト。このキーが存在しない場合、住所が提供されていないことを示します。このキーが存在する場合、含まれる6つのフィールドすべてが存在します。ユーザーから何も入力されなかった場合、文字列は空になります。 |
|
sendWelcomeEmail |
string |
False |
検証後にウェルカムメールが送信されるかどうかを示すJSON文字列。作成時に指定しない場合、ACSの場合は値が「true」に設定され、Astra Control Centerの場合は「false」に設定されます。定義された値は次のとおりです:
|
メタデータ |
False |
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
|
リクエスト例
{
"type": "application/astra-user",
"version": "1.2",
"firstName": "John",
"lastName": "Doe",
"email": "jdoe@example.com"
}
応答
Status: 201, Returns the newly created user resource in the JSON response body.
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
リソースのメディアタイプ。定義された値は次のとおりです:
|
バージョン |
string |
True |
リソースのバージョン。定義された値は次のとおりです:
|
ID |
string |
True |
リソースのグローバル一意識別子。定義された値は次のとおりです:
|
状態 |
string |
True |
ユーザーの動作状態を示す値を含むJSON文字列。定義値は次のとおりです:
|
isEnabled |
string |
True |
ユーザーがログインを許可されているかどうかを示すJSON文字列。定義済みの値は次のとおりです:
|
authID |
string |
False |
外部IDプロバイダに関連付けられた識別子を含むJSON文字列。この文字列の内容は、指定されたauthProviderによって異なります。「authProvider」が「local」のユーザの場合、「authID」は「email」の値に設定されます。「authProvider」が「ldap」のユーザの場合、「authID」はLDAPサーバからの識別名(DN)に設定されます。 |
authProvider |
string |
False |
idAuth識別子のコンテキストを示すJSON文字列。定義された値は次のとおりです:
|
firstName |
string |
True |
ユーザーが指定したフルネーム(名)を含むJSON文字列。定義された値は次のとおりです:
|
lastName |
string |
True |
ユーザーが指定した長めの姓を含むJSON文字列。定義された値は次のとおりです:
|
companyName |
string |
False |
ユーザーに関連付けられた会社名を含むJSON文字列。このキーが存在しない場合、会社名が提供されていないことを示します。定義された値は次のとおりです:
|
string |
True |
ユーザーが指定したメールアドレスを含むJSON文字列。 |
|
電話 |
string |
False |
ユーザーの電話番号を含むJSON文字列。このキーが存在しない場合、電話番号が提供されていないことを示します。 |
postalAddress |
False |
住所を指定するフィールドの集合を含むJSONオブジェクト。このキーが存在しない場合、住所が提供されていないことを示します。このキーが存在する場合、含まれる6つのフィールドすべてが存在します。ユーザーから何も入力されなかった場合、文字列は空になります。 |
|
sendWelcomeEmail |
string |
True |
検証後にウェルカムメールが送信されるかどうかを示すJSON文字列。作成時に指定しない場合、ACSの場合は値が「true」に設定され、Astra Control Centerの場合は「false」に設定されます。定義された値は次のとおりです:
|
enableTimestamp |
string |
False |
ユーザーが最後に有効化された日時を示す、ISO-8601形式のタイムスタンプを含むJSON文字列。定義された値は次のとおりです:
|
lastActTimestamp |
string |
False |
このユーザーに代わって最後にID APIが呼び出された日時を示す、ISO-8601形式のタイムスタンプを含むJSON文字列。(注:これはコストがかかります。)定義された値は次のとおりです:
|
メタデータ |
True |
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
|
回答例
{
"type": "application/astra-user",
"version": "1.2",
"id": "5bad8e04-e2fd-5c43-98d7-300580993f49",
"state": "pending",
"isEnabled": "true",
"authID": "HteLK3hk28sdbDLKHReB",
"authProvider": "cloud-central",
"firstName": "John",
"lastName": "Doe",
"email": "jdoe@example.com",
"sendWelcomeEmail": "true",
"lastActTimestamp": "2020-08-05T14:24:54.128427Z",
"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"
}
用語の意味
定義を参照
postalAddress
住所を指定するフィールドの集合を含むJSONオブジェクト。このキーが存在しない場合、住所が提供されていないことを示します。このキーが存在する場合、含まれる6つのフィールドすべてが存在します。ユーザーから何も入力されなかった場合、文字列は空になります。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
addressCountry |
string |
True |
ISO 3166 Alpha-2で規定されている、郵便住所に関連付けられた国名または国コードを含むJSON文字列。定義された値は次のとおりです:
|
addressLocality |
string |
True |
郵便番号に関連付けられた地域(例えば、都市)を含むJSON文字列。定義された値は次のとおりです:
|
addressRegion |
string |
True |
郵便番号に関連付けられた地域(例えば、州)を含むJSON文字列。定義された値は次のとおりです:
|
postalCode |
string |
True |
郵便番号に関連付けられた郵便番号を含むJSON文字列。定義された値は次のとおりです:
|
streetAddress1を使用したチャンク アップロード署名要求がサポートされるようになりました。 |
string |
True |
郵便番号に関連付けられた番地を含むJSON文字列。定義された値は次のとおりです:
|
streetAddress2を使用したチャンク アップロード署名要求がサポートされるようになりました。 |
string |
False |
オプションの付加的な住所情報(番地、私書箱など)を含むJSON文字列。定義された値は次のとおりです:
|
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 |
リクエスト本文フィールドが無効な理由 |