next

Box Level アクセス制御設定

概要

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

必要な権限

write-acl

制限事項

  • ACL設定を行うと、既存のACL設定を上書きされる形で更新されます
  • ACL設定を打ち消す機能（deny）
  • ACLで設定出来るprivilegeの一覧取得

リクエスト

リクエストURL

{CellURL}{BoxName}

または、

{CellURL}{BoxName}/{ResourcePath}

メソッド

ACL

リクエストクエリ

なし

リクエストヘッダ

ヘッダ名概要有効値必須備考
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（アクセス制御モデル）を参照。

ノード名名前空間ノードタイプ概要備考
aclD:要素ACL（アクセス制御リスト）のルートを表し、1つ以上複数のaceが子となる
basexml:属性hrefタグ内に記述するURLの基底を表し、任意の値を属性値とする。この属性は任意。
aceD:要素ACE（アクセス制御エレメント）を表し、principalとgrantが一対で子となる「invert」「deny」「protected」「inherited」はV1.1系未対応
principalD:要素権限設定対象を表し、hrefまたはallが子となる
grantD:要素権限付与設定を表し、1つ以上複数のprivilegeが子となる
hrefD:要素権限設定対象ロールを表し、ロールリソースURLを入力するテキストノード権限設定対象ロールのリソースURLを指定する acl要素内のxml:base属性の設定によって、URLを短縮する事が出来る
allD:要素全アクセス主体権限設定
privilegeD:要素権限設定を表し、以下の要素のいづれか一つが子となる
readD:要素参照権限
writeD:要素編集権限
read-propertiesD:要素プロパティ参照権限
write-propertiesD:要素プロパティ編集権限
read-aclD:要素ACL設定参照権限
write-aclD:要素ACL設定編集権限
bindD:要素メンバーURL追加権限未対応
unbindD:要素メンバーURL削除権限未対応
execp:要素サービス実行権限
stream-sendp:要素ストリームへの送信権限
stream-receivep:要素ストリームの受信権限

DTD表記

名前空間 D:

<!ELEMENT acl (ace*) >
<!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 (all or read or write or read-properties or write-properties or read-acl 
or write-acl or exec or send or receive or bind or unbind)>
<!ELEMENT read EMPTY>
<!ELEMENT write EMPTY>
<!ELEMENT read-properties EMPTY>
<!ELEMENT write-properties EMPTY>
<!ELEMENT read-acl EMPTY>
<!ELEMENT write-acl EMPTY>
<!ELEMENT bind EMPTY>
<!ELEMENT unbind EMPTY>

名前空間 p:

<!ATTLIST acl requireSchemaAuthz (none or public or confidential) #IMPLIED>
<!ELEMENT exec EMPTY>   
<!ELEMENT stream-send EMPTY>   
<!ELEMENT stream-receive EMPTY>

名前空間 xml:

<!ATTLIST acl base CDATA #IMPLIED>

リクエストサンプル

<?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/"
       p:requireSchemaAuthz="public">
  <D:ace>
    <D:principal>
      <D:all/>
    </D:principal>
    <D:grant>
      <D:privilege><D:read/></D:privilege>
    </D:grant>
  </D:ace>
  <D:ace>
    <D:principal>
      <D:href>role1</D:href>
    </D:principal>
    <D:grant>
      <D:privilege><D:read/></D:privilege>
      <D:privilege><D:write/></D:privilege>
      <D:privilege><p:exec/></D:privilege>
    </D:grant>
  </D:ace>
</D:acl>

レスポンス

ステータスコード

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

レスポンスヘッダ

ヘッダ名概要備考
Content-Type返却されるデータの形式更新・作成時に失敗した場合のみ返却する

レスポンスボディ

なし

エラーメッセージ一覧

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

cURLサンプル

curl "https://cell1.unit1.example/box1/collection1" -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:" \
xml:base="https://cell1.unit1.example/__role/box1/" xmlns:p="urn:x-personium:xmlns" \
p:requireSchemaAuthz="none"><D:ace><D:principal><D:href>role1</D:href></D:principal><D:grant>\
<D:privilege><D:read/></D:privilege><D:privilege><D:write/></D:privilege></D:grant></D:ace></D:acl>'
← ファイル削除サービスドキュメント取得 →