Versions Compared

Key

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

...

Sv translation
languageja

/api/users/:id

IDで指定したユーザーを変更します。

リソース情報

リソースURL

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

HTTPメソッド

POST

リクエストパラメーター

パラメータ
詳細
id更新するユーザーのID123
data

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

説明
usernameユーザー名
emailユーザーのメールアドレス
lastName
firstName
ユーザーの姓
ユーザーの名前
username
middleName
ユーザ名
ユーザーのミドルネーム
firstName
lastName
ユーザ名前
ユーザーの姓
timeZone
info
(任意)ユーザのタイムゾーン
ユーザー情報
info
timeZone
(任意)ユーザーの詳細情報
(任意)ユーザーのタイムゾーン
locale(任意)ユーザーロケール - サポートされる言語のコード
groups

(任意)配列はユーザーが所得する全てのユーザーグループを含みます。各グループの構造は次のとおりです。

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


roles

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

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

既存のユーザーロールは置き換えられます(ユーザーは API 経由で送信されたロールのみを持つことになります)。

すべてのユーザーロールを削除するには、空の 'roles' 配列を送信してください。



{
  
{
  
"username":
 
 "myusername",
  

  "email":
 
 "
myusername@example
myusername@example.com",
  

  "firstName":
 
 "John",
  

  "middleName": "Middle", 
  "lastName":
 
 "Doe",
  

  "info":
 
 "I'm pretty cool",
  

  "timeZone":
 
 "Europe/Prague",
  

  "locale":
 
 "cs",
  

  "roles":
[
    {
      
 [
    {
      "role":
 
 "
DATASET
DATA_ADMIN"
    

    },
    {
      

    {
      "role":
 
 "
REPORT
SCHEMA_ADMIN"
    }
  ],
  

    }
  ],
  "groups":
[
    {
      
 [
    {
      "id":
 
 "56",
      

      "name":
 
 "My User Group nr.1"
    }
  ]

    }
  ]
}


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

curlを使用:


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


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