1.7.21

BoxURL取得

概要

BoxのURLを取得するために用いるリソースです。スキーマ認証を行ったアプリケーションはアクセストークンをつけてこのリソースにアクセスすることでスキーマ認証されたアプリケーションのためのBoxのURLにリダイレクトします。
スキーマ認証に対応していないアプリケーションはパラメタでschema urlを与えることで、対応するBoxのURLにリダイレクトします。

必要な権限

以下どちらかを満たしている必要があります。

  • スキーマ認証済み
  • BoxルートACLのrequireSchemaAuthz属性がnone
    かつ
    利用者がBoxルートをread可能（Boxルートが全公開である場合は利用者認証不要）

※ACLのrequireSchemaAuthz属性については、アクセス制御モデル内の「スキーマ権限要求レベル」を参照。

リクエスト

リクエストURL

{CellURL}__box

メソッド

GET

リクエストクエリ

クエリ名概要有効値必須備考
p_cookie_peerクッキー認証値認証時にサーバから返却されたクッキー認証値×Authorizationヘッダの指定が無い場合のみ有効
クッキーの認証情報を利用する場合に指定する
schemaアプリCellURLURL形式×桁数：1～1024
URIの形式に従う

リクエストヘッダ

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

リクエストボディ

なし

レスポンス

ステータスコード

コードメッセージ概要
200FOUND取得成功

レスポンスヘッダ

ヘッダ名概要備考
LocationBoxメタデータ取得API用URLリクエストの指定方法により、以下の値となる
schemaクエリを指定
schemaクエリで指定されたアプリCellURLに対応するBoxのURL
schemaクエリなしで、Authorizationヘッダのみを指定
トークンに含まれるスキーマURLに対応するBoxのURL

Locationサンプル

Location:https://cell1.unit1.example/box1

レスポンスボディ

なし

エラーメッセージ一覧

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

レスポンスサンプル

Location:https://cell1.unit1.example/box1

cURLサンプル

スキーマ認証済

curl "https://cell1.unit1.example/__box" -X GET -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json'

スキーマ認証未対応

curl "https://cell1.unit1.example/__box?schema=https://app-cell1.unit1.example/" -X GET -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json'
← Boxメタデータ取得Box再帰削除 →