SYNCERのロゴ
アイキャッチ画像

XMLHttpRequest.withCredentials - 認証情報

withCredentialsは、XMLHttpRequestのプロパティです。クロスオリジンのajax通信で、リクエストにcookieなどの認証情報を含めるか否かを設定できます。デフォルトでは含まれません。

概要

名前
withCredentials
所属
XMLHttpRequest
IDL
attribute boolean withCredentials;
仕様書
https://xhr.spec.whatwg.org/#dom-xmlhttprequest-withcredentials

説明

trueの場合はリクエストに認証情報を含めます。falseの場合は含めません。

クロスオリジンのajax通信で認証情報の送信を許可するには、サーバー側でAccess-Control-Allow-Origin: https://syncer.jpAccess-Control-Allow-Credentials: trueというようにヘッダーを返す必要があります。認証情報を含む場合、オリジンの指定にワイルドカード(*)を利用することはできません。

デモ

ボタンをクリックすると、あるテキストファイルにアクセスします。このテキストファイルは動的に、受け取ったcookieの内容をそのまま出力します。cookieを送信できているか否かを確認して下さい。なお、初回のリクエストではcookieは設定されていません。なので一度、ファイルにアクセスしてからデモを試して下さい。

<!-- このコードは編集できます。 -->

<!DOCTYPE html>
<html>
<head>
<style>
body { word-break: break-all ; tab-size: 2 ; }
div#result { white-space: pre-wrap ; }
textarea#hoge { box-sizing: border-box ; width: 100% ; font-size: 16px ; }
</style>
</head>
<body>
<p>先に<a href="https://syncer.ch/cookie" target="_blank">テキストファイル</a>にアクセスしてcookie(有効期限5分)を設定します。</p>
<hr>
<p><button id="send1">認証情報ありの通信 [send()]</button></p>
<p><button id="send2">認証情報なしの通信 [send()]</button></p>
<p><button id="clear">ログを削除</button></p>
<hr>
<textarea rows="15" id="hoge"></textarea>
<hr>
<div id="result"></div>
<script>
var xhr = new XMLHttpRequest() ;

xhr.onloadstart = function ( event ) {
	appendText( "[loadstart] ダウンロードを開始しました!!" + "\n" ) ;
}

xhr.onprogress = function ( event ) {
	appendText( "[progress] ダウンロード中…" + "\n" ) ;
}

xhr.onload = function ( event ) {
	appendText( "[load] ダウンロードが正常に完了しました!!" + "\n" ) ;
}

xhr.onloadend = function ( event ) {
	appendText( "[loadend] ダウンロードを終了しました!!" + "\n" ) ;
}

xhr.addEventListener( "load", function ( event ) {
	document.getElementById( "hoge" ).value = xhr.response ;
} ) ;

document.getElementById( "send1" ).onclick = function () {
	xhr.open( "GET", "https://syncer.ch/cookie" ) ;
	xhr.withCredentials = true ;
	xhr.send() ;
}

document.getElementById( "send2" ).onclick = function () {
	xhr.open( "GET", "https://syncer.ch/cookie" ) ;
	xhr.withCredentials = false ;
	xhr.send() ;
}

document.getElementById( "clear" ).onclick = function () {
	document.getElementById( "result" ).textContent = "" ;
}

function appendText ( text ) {
	document.getElementById( "result" ).appendChild( document.createTextNode( text ) ) ;
}
</script>
</body>
</html>

サポート状況

ChromeFirefoxSafariEdgeIEOperaiOS SafariAndroid
  • Twitterでシェア
  • Facebookでシェア
  • Google+でシェア
  • はてなブックマークでシェア
  • pocketに保存
  • LINEでシェア
更新履歴
2017年10月23日 (月)
コンテンツを公開しました。