API Token

See https://guides.dataverse.org/en/6.0/api/auth.html.

---
title: Handle Dataverse API token
---
classDiagram
  DataverseClient *-- TokenHandler
  click DataverseClient href "../index.html" "Open the page"

  class TokenHandler {
    %% Find a Token’s Expiration Date.
    %% See https://guides.dataverse.org/en/6.0/api/native-api.html#find-a-token-s-expiration-date.
    %% /api/users/token
    %% @return expiration date of token
    +Result~LocalDateTime, String~ getExpiration()

    %% Get User Information in JSON Format.
    %% https://guides.dataverse.org/en/6.0/api/native-api.html#get-user-information-in-json-format
    %% GET /api/users/:me
    +Result~UserInfo, String~ getUserInfo()

    %% Recreate a Token in order to obtain a new token to use.
    %% https://guides.dataverse.org/en/6.0/api/native-api.html#recreate-a-token
    %% @return expiration date of token
    %% /api/users/token/recreate?returnExpiration=true
    +Result~LocalDateTime, String~ recreate()
  }