next

Role更新

概要

既存のRole情報を更新する

必要な権限

auth

制限事項

  • OData 制限
    • リクエストヘッダのAcceptは無視される
    • リクエストヘッダのContent-Typeは全てapplication/jsonとして扱う
    • リクエストボディはJSON形式のみ受け付ける
    • レスポンスヘッダのContent-Typeはapplication/jsonのみをサポートし、レスポンスボディはJSON形式とする
    • $formatクエリオプションは無視される

リクエスト

リクエストURL

{CellURL}__ctl/Role(Name='{RoleName}',_Box.Name='{BoxName}')

または、

{CellURL}__ctl/Role(Name='{RoleName}')

または、

{CellURL}__ctl/Role('{RoleName}')

※ _Box.Nameパラメタを省略した場合は、nullが指定されたものとする

メソッド

PUT

リクエストクエリ

クエリ名概要有効値必須備考
p_cookie_peerクッキー認証値認証時にサーバから返却されたクッキー認証値×Authorizationヘッダの指定が無い場合のみ有効
クッキーの認証情報を利用する場合に指定する

リクエストヘッダ

ヘッダ名概要有効値必須備考
X-HTTP-Method-Overrideメソッドオーバーライド機能任意×POSTメソッドでリクエスト時にこの値を指定すると、指定した値がメソッドとして使用されます。
X-Overrideヘッダオーバライド機能${上書きするヘッダ名}:${値}×通常のHTTPヘッダの値を上書きします。複数のヘッダを上書きする場合はX-Overrideヘッダを複数指定します。
X-Personium-RequestKeyイベントログに出力するRequestKeyフィールドの値半角英数、-(半角ハイフン)と_(半角アンダーバー)
最大128文字		×指定がない場合は、UUIDの独自短縮表現として${4桁}_${18桁}の形式のBase64url文字列を自動採番

ODataリクエストヘッダ

ヘッダ名概要有効値必須備考
AuthorizationOAuth2.0形式で、認証情報を指定するBearer {AccessToken}×※認証トークンは認証トークン取得APIで取得したトークン

OData登録リクエストヘッダ

ヘッダ名概要有効値必須備考
Content-Typeリクエストボディの形式を指定するapplication/json×省略時は[application/json]として扱う
Acceptレスポンスボディの形式を指定するapplication/json×省略時は[application/json]として扱う

リクエストボディ

項目名概要有効値必須備考
NameRole名桁数：1～128
文字種:半角英数字と-(半角ハイフン)と(半角アンダーバー)
ただし、先頭文字に-(半角ハイフン)と(半角アンダーバー)は指定不可		○
_Box.Name関係対象のBox名桁数：1～128
文字種：半角英数字と-(半角ハイフン)と(半角アンダーバー)
ただし、先頭文字に-(半角ハイフン)と(半角アンダーバー)は指定不可
説明：Box登録APIにて登録済みのBoxのNameを指定
特定のBoxと関連付けない場合はnullを指定		×

リクエストサンプル

{
  "Name": "role2",
  "_Box.Name": "box2"  
}

レスポンス

ステータスコード

204

レスポンスヘッダ

なし

レスポンスボディ

なし

エラーメッセージ一覧

エラーメッセージ一覧を参照

cURLサンプル

curl "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')" -X \
PUT -i -H 'If-Match: *' -H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json' \
-d '{"Name":"role2","_Box.Name":"box2"}'
← Role一覧取得Role部分更新 →