Sign in

v59

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-06261120479.1 KB
Users

List user authentication tokens

List active authentication tokens issued for the user. The clear-text token value is included for tokens still held in memory, which covers live ephemeral tokens (including unspent single-use ones) and persistent tokens issued since the last server restart. Persistent tokens reloaded from the database no longer carry it. A user may list their own tokens; listing another user's tokens requires MANAGE_USERS access right.

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

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. Available only while the token is held in memory, which covers the response to the create operation and any listing of still-live tokens (ephemeral, service or unspent single-use). Persistent tokens reloaded from the database after a server restart no longer carry it.