Loading ...

REST API: Get Bearer Token for User | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Users » REST API: Get Bearer Token for User
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 25

REST API: Get Bearer Token for User

0 
 /5
0 (0votes)
Open API Guide
GET/api/users/token

Generate a JWT bearer token (a signed token that proves who is calling) for a user, so you can impersonate that user in API requests. The call returns a JWT when the site emulates legacy API keys, which is the default. When emulation is off, it returns the legacy REST API key instead, provided legacy keys, REST access, and the caller's API rights are all enabled. Each call creates a new token, and earlier tokens for that user stay valid until they are revoked.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens

Required Parameters

ParameterTypeRequiredLocationDescription
UserIDIntegerYESQueryUnique identifier for a particular user

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/users/token?UserID=1559

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.PAYLOAD.SIGNATURE"
}

Error Response

{
  "Message": "The request is invalid."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestUserID is missing or not an integer (The request is invalid.).Send UserID as a number.
401 UnauthorizedMissing or invalid Bearer tokenCheck token validity. Learn how to create Bearer tokens →
403 ForbiddenNot returned: a caller without the Impersonate permission on users receives 200 with IsError true (see below).No action needed.
404 Not FoundNo user has that ID (User with ID 'x' not found.).Verify the UserID.
500 Server ErrorInternal failureRetry later.
200 with IsErrorThe caller asked for another user's token without the Impersonate permission on users (No Permission).Ask for your own token, or call with a token that can impersonate users.
410 GoneThe site has disabled both legacy API keys and their emulation, so the endpoint is deprecated there.Use Issue Auth Token instead.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages