認証トークンの API エンドポイント¶

後続のリクエストに使用する認証トークンを取得するには、username および password フィールドを使ってリソースに POST リクエストを実行します。

GET /api/v1/authtoken/

HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: POST, OPTIONS
X-API-Time: 0.001s

{
    "detail": "Method 'GET' not allowed."
}

JSON から POST への例 (コンテンツタイプは application/json):

{"username": "user", "password": "my pass"}

data から post への例 (コンテンツタイプは application/x-www-form-urlencoded):

username=user&password=my%20pass

提供されたユーザー名とパスワードが有効であれば、token フィールドには使用する認証トークンが、expires フィールドにはトークンの有効期限となるタイムスタンプが返されます。

{
    "token": "8f17825cf08a7efea124f2638f3896f6637f8745",
    "expires": "2013-09-05T21:46:35.729Z"
}

これ以外の場合は、エラーが発生したことになり、4xx のステータスコードが返されます。

後続のリクエストでは、HTTP Authorization リクエストヘッダーでこのトークンを渡します。

Authorization: Token 8f17825cf08a7efea124f2638f3896f6637f8745

認証トークンは、これを取得したリモートアドレスおよびユーザーエージェントと使用した場合にのみ、有効になります。

認証にトークンを使用するリクエストでは毎回、有効期限のタイムスタンプが更新され、期限切れにならないようにします。トークンは、設定されたタイムアウトの期間 (デフォルトでは 1800 秒) 使用されなかった場合にのみ、期限切れになります。