指定された EIAM インスタンスに EIAM アカウントを作成します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
インスタンス ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| Username |
string |
必須 |
ユーザー名。ユーザー名には、英字、数字、アンダースコア (_)、ピリオド (.)、アット署名 (@)、ハイフン (-) を使用できます。ユーザー名は最大 256 文字です。 |
user_001 |
| DisplayName |
string |
任意 |
アカウントの表示名。表示名は最大 128 文字です。 |
name_001 |
| Password |
string |
任意 |
パスワード。パスワードはパスワードポリシーの要件を満たす必要があります。 |
123456 |
| PhoneRegion |
string |
任意 |
電話リージョンコード。値は 1~6 桁の数字で、プラス署名 (+) は含みません。 |
86 |
| PhoneNumber |
string |
任意 |
電話番号。値は 6~15 桁の数字です。 |
12345678901 |
| PhoneNumberVerified |
boolean |
任意 |
電話番号が信頼できる電話番号として検証済みかどうかを指定します。PhoneNumber を指定する場合、このパラメーターは必須です。特別なビジネス要件がない場合は、このパラメーターを true に設定してください。 |
true |
|
string |
任意 |
メールアドレス。メールプレフィックスには、大文字、小文字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。メールアドレスは最大 128 文字です。 |
example@example.com |
|
| EmailVerified |
boolean |
任意 |
メールアドレスが信頼できるメールアドレスとして検証済みかどうかを指定します。Email を指定する場合、このパラメーターは必須です。特別なビジネス要件がない場合は、このパラメーターを true に設定してください。 |
true |
| UserExternalId |
string |
任意 |
アカウントの外部 ID。このパラメーターは、アカウントを外部システムに関連付けるために使用されます。値は最大 128 文字です。このパラメーターを指定しない場合、デフォルトでアカウント ID が使用されます。 |
user_d6sbsuumeta4h66ec3il7yxxxx |
| PrimaryOrganizationalUnitId |
string |
必須 |
プライマリ組織単位の ID。 |
ou_wovwffm62xifdziem7an7xxxxx |
| OrganizationalUnitIds |
array |
任意 |
アカウントが属する組織単位 ID のリスト。アカウントは複数の組織単位に属することができます。 |
|
|
string |
任意 |
組織単位 ID。 |
ou_adz2vmgiwpo4tu6jtss3mynjji |
|
| Description |
string |
任意 |
説明。説明は最大 256 文字です。 |
description text |
| CustomFields |
array<object> |
任意 |
カスタムフィールドのリスト。 |
description |
|
object |
任意 |
カスタムフィールドオブジェクト。 |
||
| FieldName |
string |
任意 |
カスタムフィールドの識別子。事前にカスタムフィールドを作成してください。詳細については、コンソールのカスタムフィールドモジュールを参照してください。 |
age |
| FieldValue |
string |
任意 |
カスタムフィールドの値。値は、対応するカスタムフィールドの属性制約に準拠する必要があります。 |
10 |
| PasswordInitializationConfig |
object |
任意 |
パスワード初期化構成。 |
|
| PasswordInitializationPolicyPriority |
string |
任意 |
パスワード初期化ポリシーの優先度。デフォルトでは、このパラメーターは有効になりません。有効な値:
|
global |
| PasswordForcedUpdateStatus |
string |
任意 |
強制パスワード変更ステータス。デフォルトでは、この特徴は有効になっていません。有効な値:
|
enabled |
| UserNotificationChannels |
array |
任意 |
パスワード通知チャネルのリスト。 |
sms |
|
string |
任意 |
パスワード通知チャネル。有効な値:
|
sms |
|
| PasswordInitializationType |
string |
任意 |
パスワード初期化メソッド。有効な値:
|
random |
| ClientToken |
string |
任意 |
リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してパラメーター値を生成できますが、異なるリクエスト間で値が一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、64 文字を超えることはできません。詳細については、「リファレンス: べき等性を確保する方法」を参照してください。 |
client-token-example |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。 |
0441BD79-92F3-53AA-8657-F8CE4A2B912A |
| UserId |
string |
アカウント ID。 |
user_d6sbsuumeta4h66ec3il7yxxxx |
例
成功レスポンス
JSONJSON
{
"RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
"UserId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 403 | ResourceDuplicated.Username | The specified resource: Username already exist. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。