Regenerate Auth Token

Regenerate an existing auth token.

HTTP Request

POST/api/users/auth_tokens/:id/regenerate

Authorization

Authorization

• Required: Yes
• Permission: Staff or Admin
• Authentication: Token-based (Authorization: Token <your_api_key>)

Path Parameters

Parameter	Type	Required	Description
id	Integer	Yes	Unique ID of the auth token to regenerate

Example Requests

🐍 Python

1import requests
2
3api = requests.Session()
4api.headers.update({'Authorization': 'Token f4e75eab6e0f663a972d145478d6fc4b81762070'})
5response = api.post('http://www.example.com/api/users/auth_tokens/15/regenerate/')
6print(response.json())

🌐 Curl

1curl "http://www.example.com/api/users/auth_tokens/15/regenerate/" -X POST -H "Authorization: Token XXXXXXXXXXXXXXXXXXXXXX"

Status Codes

Code	Description
200	Auth token regenerated successfully
400	Bad request — invalid input
401	Unauthorized — authentication required
403	Forbidden — insufficient permissions
404	Not found — auth token does not exist
500	Internal server error

Response Fields

Field	Type	Description
id	Integer	Unique ID of the auth token
user_data	Object	Information about the user associated with the token
key	String	The regenerated authentication token key
created_at	DateTime	Timestamp when the token was created
updated_at	DateTime	Timestamp when the token was last updated (regenerated)

Example Response

{
  "id": 15,
  "user_data": {
    "id": 42,
    "username": "johndoe",
    "email": "johndoe@example.com"
  },
  "key": "newlygeneratedtokenkey1234567890abcdef",
  "created_at": "2023-10-01T12:34:56Z",
  "updated_at": "2024-06-15T09:21:00Z"
}

Notes

• The old token key becomes invalid immediately.
• The updated_at timestamp reflects when the token was regenerated.
• The token ID remains the same, only the key changes.