1.7.21

ExtRole部分更新

概要

ExtRoleを部分更新する

必要な権限

auth

制限事項

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

リクエスト

リクエストURL

{CellURL}__ctl/ExtRole(ExtRole='https%3A%2F%2F{CellName}.{UnitFQDN}%2F__role%2F__%2F{RoleName}',
_Relation.Name='{RelationName}',_Relation._Box.Name='{BoxName}')

または、

{CellURL}__ctl/ExtRole(ExtRole='https%3A%2F%2F{CellName}.{UnitFQDN}%2F__role%2F__%2F{RoleName}',
_Relation.Name='{RelationName}')

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

メソッド

MERGE

リクエストクエリ

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

リクエストヘッダ

ヘッダ名概要有効値必須備考
X-HTTP-Method-Overrideメソッドオーバーライド機能任意×POSTメソッドでリクエスト時にこの値を指定すると、指定した値がメソッドとして使用されます。
X-Overrideヘッダオーバライド機能${上書きするヘッダ名}:${値}×通常のHTTPヘッダの値を上書きします。複数のヘッダを上書きする場合はX-Overrideヘッダを複数指定します。
X-Personium-RequestKeyイベントログに出力するRequestKeyフィールドの値半角英数、-(半角ハイフン)と_(半角アンダーバー)
最大128文字		×指定がない場合は、UUIDの独自短縮表現として${4桁}_${18桁}の形式のBase64url文字列を自動採番
AuthorizationOAuth2.0形式で、認証情報を指定するBearer {AccessToken}×※認証トークンは認証トークン取得APIで取得したトークン
Content-Typeリクエストボディの形式を指定するapplication/json×省略時は[application/json]として扱う
Acceptレスポンスボディの形式を指定するapplication/json×省略時は[application/json]として扱う
If-Match対象ETag値を指定するETag値×省略時は[*]として扱う

リクエストボディ

項目名概要有効値必須備考
ExtRole外部ロール名(URL)桁数：1～1024
URIの形式に従う
scheme：http / https / urn
Boxに紐付いている場合:/{アプリCell名}/__role/__/{Role名}
※ただし、BoxにSchema情報が登録されていない場合、Boxに紐付いていないとみなされる
Boxに紐付いていない場合:/{Cell名]/__role/__/{Role名}		×
_Relation.Name関係対象のRelation名桁数：1～128
文字種:半角英数字と-(半角ハイフン)と(半角アンダーバー)
と+(プラス)と:(コロン)
ただし、先頭文字に(半角アンダーバー):(コロン)は指定不可
Relation登録APIにて登録済みのRelation		×
_Relation._Box.Name関係対象のRelationが紐づくBox名桁数：1～128
文字種:半角英数字と-(半角ハイフン)と_(半角アンダーバー)
Relation登録APIにて登録済みのRelationが紐づくBox名
null		×

リクエストサンプル

{
  "ExtRole": "https://cell2.unit1.example/__role/__/role1",
  "_Relation.Name": "relation2",
  "_Relation._Box.Name": "box2"  
}

レスポンス

ステータスコード

204

レスポンスボディ

なし

エラーメッセージ一覧

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

cURLサンプル

curl "https://cell1.unit1.example/__ctl/ExtRole(ExtRole='https%3A%2F%2Fcell2.unit1.example\
%2F__role%2F__%2Frole1',_Relation.Name='relation1',_Relation._Box.Name='box1')" -X MERGE -i \
-H 'If-Match: *' -H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json' \
-d '{"ExtRole": "https://cell2.unit1.example/__role/__/role2",\
"_Relation.Name":"relation2","_Relation._Box.Name": "box2"}'
← ExtRole更新ExtRole削除 →