NEnetxms
Users

List user authentication tokens

Changed on

List active authentication tokens issued for the user. The clear-text token value is never included - it is returned only by the response that issues the token. A user may list their own tokens; listing another user's tokens requires MANAGE_USERS access right.

get/v1/users/{user-id}/tokens

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/users/{user-id}/tokens
  • Auth
    HTTP bearer

Path parameters

user-idinteger required

User ID

Response

Tokens retrieved successfully

idinteger

Token ID. Assigned only to persistent tokens; ephemeral, service and single-use tokens are always reported with 0 and therefore cannot be revoked by ID.

userIdinteger

ID of the user the token was issued for.

persistentboolean

True if the token is persisted in the database (long-lived API token).

serviceboolean

True if this is a service token.

singleUseboolean

True if the token is single-use. Such a token is destroyed by the login that spends it, so it authenticates exactly one session. It can only be spent on an NXCP login (management console or other NXCP client) and is rejected with 401 if presented as a REST bearer credential.

descriptionstring

Human-readable token description.

issuingTimeinteger

Token issuing time (UNIX timestamp, seconds).

expirationTimeinteger

Token expiration time (UNIX timestamp, seconds).

valuestring

Clear-text token value. Returned only by the create operation, which is the single point where the server gives it out; it is absent from token listings. A lost token cannot be recovered and has to be revoked and re-issued.

Changes