users

Get all API keys for a user

Gets all API keys for a user. Only the calling user or admin can retrieve api-keys. Access policy: authenticated

get/users/{id}/tokens

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/users/{id}/tokens
  • Auth
    • API key in header X-API-KEY
    • or API key in header Authorization

Path parameters

idinteger required

User identifier

Response

Success

dateCreatedinteger

Unix timestamp (UTC) when the API key was created

descriptionstring
digeststring

Digest represents SHA256 hash of the raw API key

idinteger
lastUsedinteger

Unix timestamp (UTC) when the API key was last used

prefixstring

API key identifier (7 char prefix)

userIdinteger

Example response

[
  {
    "description": "portainer-api-key",
    "id": 1,
    "userId": 1
  }
]

Changes

No recorded changes to this operation across all 21 revisions of this API.