安全ドメインの作成または更新
put
/api/20210901/system/safeDomains/{urlBase64DomainId}
分析インスタンスの安全ドメインを作成または更新します。
リクエスト
パス・パラメータ
- urlBase64DomainId(必須): string
Base64URLエンコーディングを使用した安全ドメイン値。 たとえば、安全ドメインmy.safe-domain.comを作成または更新する場合は、Base64URLでエンコードされた値'bXkuc2FmZS1kb21haW4uY29t'を入力します。
サポートされているメディア・タイプ
- application/json
ルート・スキーマ: schema
Type:
object安全ドメインのプロパティを表すオブジェクト。
ソースを表示
-
connect-src(必須): boolean
スクリプト・インタフェースを使用してロードできるURLを制限します。
-
font-src(必須): boolean
@font-faceを使用してロードされたフォントの有効なソースを指定します。
-
form-action(必須): boolean
特定のコンテキストからのフォーム送信のターゲットとして使用できるURLを制限します。
-
frame-ancestors(必須): boolean
<frame>、<iframe>、<object>または<embed>を使用してページを埋め込むことができる有効な親を指定します。
-
frame-src(必須): boolean
<frame>や<iframe>などの要素を使用してロードするネストされたブラウジング・コンテキストの有効なソースを指定します。
-
img-src(必須): boolean
イメージおよびファビコンの有効なソースを指定します。
-
media-src(必須): boolean
<audio>、<video>、<track>要素を使用して、メディアをロードする有効なソースを指定します。
-
script-src(必須): boolean
JavaScriptおよびWebAssemblyリソースの有効なソースを指定します。
-
style-src(必須): boolean
スタイルシートの有効なソースを指定します。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
既存の安全ドメインを更新しました。
201レスポンス
安全ドメインを作成しました。
400レスポンス
不正なリクエスト(検証に失敗しました)。
ルート・スキーマ: 400BadRequest
不正なリクエスト(無効な問合せパラメータ、不正なヘッダーなど)。
403レスポンス
安全ドメインを作成または更新する権限がありません。
ルート・スキーマ: 403Forbidden
禁止(操作の権限がない、不明な理由によりリクエストが拒否されたなど)。
例
この例では、安全ドメインmy.safe-domain.comをアナリティクス・インスタンスに登録します。 my.safe-domain.comのBase64URLエンコード値は次のとおりです: bXkuc2FmZS1kb21haW4uY29t
認可されたユーザーがドメイン(img-src = trueおよびscript-src = true)からイメージおよびスクリプトにアクセスし、このドメインから<frames>および<iframes> (frame-src = true)にコンテンツをロードできるようにする、ドメインのコンテンツ・セキュリティ・ポリシー(CSP)を指定します。
cURLの例:
curl -i \
--header 'Authorization: Bearer <token>' \
--request PUT 'https://<hostname>/api/20210901/system/safeDomains/bXkuc2FmZS1kb21haW4uY29t' \
--data '{ \
"img-src": true, \
"frame-src": true, \
"script-src": true, \
"font-src": false, \
"style-src": false, \
"media-src": false, \
"connect-src": false, \
"frame-ancestors": false, \
"form-action": false \
}'
リクエスト本文の例
{
"img-src": Boolean,
"frame-src": Boolean,
"script-src": Boolean,
"font-src": Boolean,
"style-src": Boolean,
"media-src": Boolean,
"connect-src": Boolean,
"frame-ancestors": Boolean,
"form-action": Boolean
}
たとえば:
{
"img-src": true,
"frame-src": true,
"script-src": true,
"font-src": false,
"style-src": false,
"media-src": false,
"connect-src": true,
"frame-ancestors": true,
"form-action": false
}
リクエスト・ヘッダーの例
Not applicable.
レスポンス本文の例
既存の安全ドメインが正常に更新されると、レスポンス本文は200レスポンス・コードを返します。 たとえば:
Status 200
新しい安全ドメインが正常に作成されると、レスポンス本文は201レスポンス・コードを返します。 たとえば:
Status 201