ユーザーを作成します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /v2/user/create HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| domain_id |
string |
必須 |
||
| body |
object |
任意 |
リクエストボディのパラメーター。 |
|
| user_id |
string |
必須 |
ユーザーの ID。ID は最大 64 文字で、番号記号 (#) を含めることはできません。 |
pdsuserid1 |
| nick_name |
string |
任意 |
ユーザーのニックネーム。ニックネームは最大 128 文字です。 |
pdsuer |
| status |
string |
任意 |
ユーザーのステータス。デフォルト値: enabled。有効な値:
|
enabled |
| role |
string |
任意 |
ユーザーのロール。デフォルト値: user。有効な値:
列挙値:
|
user |
| avatar |
string |
任意 |
アバターの URL。 URL が HTTP フォーマットの場合、http:// または https:// で始まる必要があり、パラメーターの長さは最大 4 KB です。 URL がデータ形式の場合、data:// で始まり、Base64 エンコーディングを使用する必要があり、パラメーターの長さは最大 300 KB です。 |
http://a.b.c/pds.jpg |
| phone |
string |
任意 |
ユーザーの電話番号。 |
13900001111 |
|
string |
任意 |
ユーザーのメールアドレス。 |
123@pds.com |
|
| user_data |
object |
任意 |
ユーザーのカスタムデータ。データは最大 1,024 文字です。 |
md |
|
any |
任意 |
ユーザーのカスタムデータ内の単一のキーに対応する値。 |
value1 |
|
| group_info_list |
array<object> |
任意 |
グループ情報のフォーマット。 |
|
|
object |
任意 |
|||
| group_id |
string |
任意 |
グループの ID。 |
g123 |
| user_name |
string |
任意 |
ユーザー名。ユーザー名は最大 128 文字です。 |
pdsusername |
| description |
string |
任意 |
ユーザーの説明。説明は最大 1,024 文字です。 |
VIP user |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答情報のフォーマット。 |
||
| domain_id |
string |
ドメインの ID。 |
bj1 |
| user_id |
string |
ユーザーの ID。 |
dingding_abc001 |
| avatar |
string |
アバターの URL。 |
http://aa.com/1.jpg |
| created_at |
integer |
ユーザーが作成された時間。値は、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数を表す UNIX タイムスタンプです。 |
1639762579768 |
| updated_at |
integer |
ユーザーが更新された時間。値は、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数を表す UNIX タイムスタンプです。 |
1639762579768 |
| nick_name |
string |
ユーザーのニックネーム。 |
001 |
| user_name |
string |
ユーザー名。 |
pds |
| phone |
string |
ユーザーの電話番号。 |
13900001111 |
|
string |
ユーザーのメールアドレス。 |
a@a.com |
|
| role |
string |
ユーザーのロール。有効な値:
列挙値:
|
admin |
| status |
string |
ユーザーのステータス。有効な値:
列挙値:
|
enabled |
| description |
string |
ユーザーの説明。 |
vipuser |
| default_drive_id |
string |
デフォルトドライブの ID。 |
1 |
| user_data |
object |
ユーザーのカスタムデータ。 |
|
|
any |
カスタム項目。 |
dog |
|
| creator |
string |
ユーザーの作成者。 |
user1 |
例
成功レスポンス
JSONJSON
{
"domain_id": "bj1",
"user_id": "dingding_abc001",
"avatar": "http://aa.com/1.jpg",
"created_at": 1639762579768,
"updated_at": 1639762579768,
"nick_name": "001",
"user_name": "pds",
"phone": "13900001111",
"email": "a@a.com",
"role": "admin",
"status": "enabled",
"description": "vipuser",
"default_drive_id": "1",
"user_data": {
"key": "dog"
},
"creator": "user1"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。