1.7.21

Cell Level アクセス制御設定

概要

Cell Level のアクセス制御機能を提供する。

必要な権限

acl

制限事項

ACL設定を行うと、既存のACL設定を上書きされる形で更新されます。

  • V1.0版での制限
    • ACL設定を打ち消す機能（deny）
    • ACLで設定出来るprivilegeの一覧取得

リクエスト

リクエストURL

{CellURL}

メソッド

ACL

リクエストクエリ

共通リクエストクエリ

クエリ名概要有効値必須備考
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で取得したトークン

リクエストボディ

名前空間

URI概要備考 (prefix)
DAV:WebDAVの名前空間D:
urn:x-personium:xmlnsPersoniumの名前空間p:

※ 参考prefixは以下表の可読性を高めるためのもので、このprefix文字列の使用を保証するものでも要求するものでもありません。

XMLの構造

ボディはXMLで、以下のスキーマに従っています。
privilegeタグ配下の権限設定の内容については、acl_model（アクセス制御モデル）を参照。

ノード名Namespaceノードタイプ概要備考
aclD:要素ACL（アクセス制御リスト）のルートを表し、1つ以上複数のaceが子となる
baseD:要素hrefタグ内に記述するURLの基底を表し、任意の値を属性値とする。
aceD:要素ACE（アクセス制御エレメント）を表し、principalとgrantが一対で子となる
※プロパティ取得時、継承したACEの子にinheritedが追加される		「invert」「deny」「protected」は未対応
principalD:要素権限設定対象を表し、hrefまたはallが子となる
grantD:要素権限付与設定を表し、1つ以上複数のprivilegeが子となる
hrefD:要素権限設定対象ロール表し、ロールリソースURLを入力するテキストノード権限設定対象ロールのリソースURLを指定する
acl要素内のxml:base属性の設定によって、URLを短縮する事が出来る
allD:要素全アクセス主体権限設定全てのロールや認証されていないアクセス主体（Authorizationヘッダなし）に対しての設定となる
inheritedD:要素権限継承元を表し、href（権限継承元コレクションのURL）が子となる※設定不可（プロパティ取得時にのみ付与される要素で、ACL設定時には無視される）
privilegeD:要素権限設定を表し、以下の要素のいづれか一つが子となる
rootp:要素全権限
authp:要素認証系管理API編集・参照権限
auth-readp:要素認証系管理API参照権限
messagep:要素メッセージ系管理API編集・参照権限
message-readp:要素メッセージ系管理API参照権限
eventp:要素イベント系管理API編集・参照権限
event-readp:要素イベント系管理API参照権限
logp:要素イベントバスのログAPI編集・参照権限
log-readp:要素イベントバスのログAPI参照権限
socialp:要素関係系管理API編集・参照権限
social-readp:要素関係系管理API参照権限
boxp:要素Box管理API編集・参照権限
box-readp:要素Box管理API参照権限
box-installp:要素Boxインストール実行権限 ※V1.2.3対応
box-exportp:要素Boxエクスポート実行権限未対応(設定不可)
aclp:要素ACL管理API編集・参照権限
acl-readp:要素ACL管理API参照権限
propfindp:要素プロパティ取得API参照権限
rulep:要素イベント処理ルール管理API編集・参照権限
rule-readp:要素イベント処理ルール管理API参照権限

DTD表記

名前空間：D:

<!ELEMENT acl (ace*) >
<!ATTLIST acl base CDATA #IMPLIED>
<!ELEMENT ace ((principal or invert), (grant or deny), protected?,inherited?)>
<!ELEMENT principal (href or all)>
<!ELEMENT principal (privilege+)>
<!ELEMENT href (#PCDATA)>
<!ELEMENT all EMPTY>
<!ELEMENT privilege (root or auth or auth-read or message or message-read or event or 
event-read or social or social-read or box or box-read or acl or acl-read or propfind or
rule or rule-read)>

名前空間:xml:

<!ATTLIST acl base CDATA #IMPLIED>

名前空間：p:

<!ELEMENT root EMPTY>
<!ELEMENT auth EMPTY>
<!ELEMENT auth-read EMPTY>
<!ELEMENT message EMPTY>
<!ELEMENT message-read EMPTY>
<!ELEMENT event EMPTY>
<!ELEMENT event-read EMPTY>
<!ELEMENT log EMPTY>
<!ELEMENT log-read EMPTY>
<!ELEMENT social EMPTY>
<!ELEMENT social-read EMPTY>
<!ELEMENT box EMPTY>
<!ELEMENT box-read EMPTY>
<!ELEMENT box-install EMPTY>
<!ELEMENT box-export EMPTY>
<!ELEMENT acl EMPTY>
<!ELEMENT acl-read EMPTY>
<!ELEMENT propfind EMPTY>
<!ELEMENT rule EMPTY>
<!ELEMENT rule-read EMPTY>

リクエストサンプル

<?xml version="1.0" encoding="utf-8" ?>
<D:acl xmlns:D="DAV:" xmlns:p="urn:x-personium:xmlns" 
xml:base="https://cell1.unit1.example/__role/box1/">
  <D:ace>
    <D:principal>
      <D:all/>
    </D:principal>
    <D:grant>
      <D:privilege><p:auth/></D:privilege>
      <D:privilege><p:box/></D:privilege>
    </D:grant>
  </D:ace>
  <D:ace>
    <D:principal>
      <D:href>role</D:href>
    </D:principal>
    <D:grant>
      <D:privilege><p:root/></D:privilege>
    </D:grant>
  </D:ace>
</D:acl>

レスポンス

ステータスコード

コードメッセージ概要
200OK成功

レスポンスヘッダ

項目名概要備考
Content-Type返却されるデータの形式

レスポンスボディ

なし

エラーメッセージ一覧

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

cURLサンプル

curl "https://cell1.unit1.example/" -X ACL -i -H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' \
-H 'Accept: application/json' -d '<?xml version="1.0" encoding="utf-8" ?><D:acl xmlns:D="DAV:" \
xmlns:p="urn:x-personium:xmlns" xml:base="https://cell1.unit1.example/__role/box1/">  \
<D:ace><D:principal><D:href>role1</D:href></D:principal><D:grant><D:privilege><p:box-read/>\
</D:privilege><D:privilege><p:auth/></D:privilege></D:grant></D:ace></D:acl>'
← AccountのNavigation Property経由での他オブジェクト一覧取得プロパティ取得 →