Versions Compared

Old Version 17

changes.mady.by.user marek kalvas

Saved on

compared with

New Version 18

changes.mady.by.user Ayumi Yasuda

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sv translation
languageja

/api/users/create

新規ユーザを作成します。

Note

このリソースは、グローバル管理者またはドメイン管理者のために利用可能です。

リソース情報

リソースURL

https://service.belladati.com/api/users/create

HTTPメソッド

POST

リクエストパラメーター

パラメーター詳細例
data

JSON形式で送信するフォームコンテンツ

名説明
domain_idドメイン識別子
usernameユーザ名
emailユーザーのメールアドレス
firstNameユーザ名
lastNameユーザーの姓
info（任意）ユーザの詳細情報
timeZone（任意）ユーザーのタイムゾーン
locale（任意）ユーザーのロケール - サポートされる言語のコード
roles

（任意）配列はユーザーが所属するすべてのユーザーグループを含みます。各グループの構造は次のとおりです。

名説明
role役割名- サポートされる値のリストをご参照してください。


groups

（任意）配列はユーザが所属するすべてのユーザーグループを含みますです。各グループの構造は次のとおりです。

名説明
idユーザー・グループ識別子
nameユーザグループ名


parameters(任意) すべてのユーザーパラメータを含む配列
addRequestIdToResponsePASSWORD_SET "のユーザーリクエストIDとUSER_ID;REQUEST_IDのフォーマットでユーザーIDを返す
sendNotification値: true/false. SMTPサーバーが設定されている場合、登録メールを送信します。
requestPin値: true/false. リクエストコードの代わりに4桁のピンが生成されます。



Code Block
languagejs
{
  "domain_id": 123,
  "username": "myusername",
  "email": "myusername@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "info": "I'm pretty cool",
  "timeZone": "Europe/Prague",
  "locale": "cs",
  "roles": [
    {
      "role": "DATASET_ADMIN"
    },
    {
      "role": "REPORT_ADMIN"
    }
  ],
  "groups": [
    {
      "id": "56",
      "name": "My User Group nr.1"
    }
  ]
　"parameters": [
    {
      "key" : "nameofparam",
      "value" : "valueofparam"
    }
  ]
 }


サンプルリクエスト/レスポンス

curl使用:

Code Block
curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\""  -d "data={\"domain_id\":123,\"username\":\"myusername\",\"email\":\"myusername@example.com\",\"firstName\":\"John\",\"lastName\":\"Doe\"}" https://service.belladati.com/api/users/create

フォームが正常に送信された場合、サーバはHTTPステータスコード200と新しいユーザのIDを含む本体で応答します。