サーバー構築不要!スマートフォンアプリ向けの新クラウド

トップ >ドキュメント >REST API リファレンス:ロール更新

共通ドキュメント

ロール更新

ロール更新APIについて

指定したロールに所属している子ロールや会員、ACLの更新を行います。

基本仕様

  • APIパス:/roles/オブジェクトID
  • メソッド:PUT

リクエストヘッダー

シグネチャやAPIキーなどの詳細は「共通フォーマット」を参照してください。

フィールド名 内容
Content-Type application/json

リクエストコンテント

追加フィールドは、対象となるクラス/フィールドに依存しており、複数存在する場合もあります。
※フィールド名に「_id」は指定不可とします。
ACL未指定時の初期値はシステム側であらかじめ設定されているデフォルト値になります。

パラメータ名 説明 データ型 必須 バリデーション
belongRole 所属するロール オブジェクト
belongUser 所属する会員 オブジェクト
acl ACL オブジェクト
- 追加フィールド - フィールド名のフォーマットチェック
(半角英数+「_」のみ)

ロール名はアプリごとに一意になっている必要があります。

子ロールの追加・削除

belongRoleには既存のロールが子ロールとして追加されます。
既存ロールのobjectIdをリレーションで登録することで、複数指定可能です。
(リレーション先のクラスは必ずroleを指定してください。)
未指定時の初期値は「(空文字)」です。

リレーションを削除する場合は、AddRelationの代わりにRemoveRelationを指定します。

"belongRole": {
  "__op": "AddRelation",
  "objects": [
    {
      "__type": "Pointer",
      "className": "role",
      "objectId": "TPhjGyOXin"
    },
    {
      "__type": "Pointer",
      "className": "role",
      "objectId": "NhkAxHRSRH"
    },
    {
      "__type": "Pointer",
      "className": "role",
      "objectId": "TZCGzVkyc9"
    }
  ]
}

ロールに会員を所属させる

belongUserにはロールに所属する会員が追加されます。
既存会員のobjectIdをリレーションで登録することで、複数指定可能です。
(リレーション先のクラスは「user」固定とします。)
未指定時の初期値は「(空文字)」です。

リレーションを削除する場合は、AddRelationの代わりにRemoveRelationを指定します。

"belongUser": {
  "__op": "AddRelation",
  "objects": [
    {
      "__type": "Pointer",
      "className": "user",
      "objectId": "cC7VYlTqfC"
    },
    {
      "__type": "Pointer",
      "className": "user",
      "objectId": "J8UR8TWtUf"
    },
    {
      "__type": "Pointer",
      "className": "user",
      "objectId": "34eHS0y7y4"
    }
  ]
}

HTTPステータス

ステータスコード 説明
200 更新完了

レスポンスヘッダー

フィールド名
Content-Type application/json

レスポンスコンテント

パラメータ名 説明 データ型 備考
updateDate 更新日時 日時

リクエストサンプル

curl -v -X PUT \
 -H "X-NCMB-Apps-Session-Token:Lbl1oCK8gLpyOawBOnbIFdpOx" \
 -H "X-NCMB-Application-Key: 578ebb84b9036498858ce0aad14ed0b5a662a102ccca34f0033ff20a1f200786" \
 -H "X-NCMB-Timestamp: 2013-08-14T15:46:25.543" \
 -H "X-NCMB-Signature: GMeJ0ZtRyI6Z8ED5770iMwI5lIvq6UUiwoZjbEMa4uA=" \
 -H "Content-Type: application/json" \
 -d '{"belongUser":{"__op":"AddRelation","objects":[{"__type":"Pointer","className":"user","objectId":"4HySKj2kLHmNcZA7"}]}} ' \
 https://mbaas.api.nifcloud.com/2013-09-01/roles/qHcDdjIlTusGBS0l

レスポンスサンプル

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{"updateDate":"2013-08-30T06:14:26.370Z"}

お探しの内容が見つからなかった場合はユーザーコミュニティ もご活用ください。(回答保証はいたしかねます)
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。

推奨画面サイズ1024×768px以上

ページの先頭へ