ESC

    Token

    The token endpoint allows to manage the tokens not related to a user.

    POST

    The token endpoint allows to create a new token.

    POST /_/token
    

    Headers

    NameTypeDescriptionRequired
    AuthorizationstringThe bearer token to connect to the server.true

    Body

    NameTypeDescriptionDefaultRequired
    namestringThe name of the token.-true
    expiration_datenumberThe expiration date in milliseconds.updated_atfalse
    activebooleanIf the token is activetruefalse
    writebooleanIf the token has write permissions.truefalse

    Example:

    {
      "name": "example",
      "expiration_date": 1632960000000,
      "active": true,
      "write": true
    }
    

    GET

    The token endpoint allows to get a list of all the tokens.

    GET /_/token
    

    Headers

    NameTypeDescriptionRequired
    AuthorizationstringThe bearer token to connect to the server.true

    PUT

    The token endpoint allows to update a token.

    PUT /_/token
    

    Headers

    NameTypeDescriptionRequired
    AuthorizationstringThe bearer token to connect to the server.true

    Body

    NameTypeDescriptionDefaultRequired
    namestringThe name of the token.-true
    expiration_datenumberThe expiration date in milliseconds.updated_atfalse
    activebooleanIf the token is activetruefalse
    writebooleanIf the token has write permissions.truefalse

    Example:

    {
      "name": "example",
      "expiration_date": 1632960000000,
      "active": true,
      "write": true
    }
    

    DELETE

    The token endpoint allows to delete a token.

    DELETE /_/token
    

    Headers

    NameTypeDescriptionRequired
    AuthorizationstringThe bearer token to connect to the server.true

    Body

    NameTypeDescriptionRequired
    namestringThe name of the token.true

    GET Value

    The token endpoint allows to get the value of a token.

    GET /_/token/value?name=<NAME>
    

    Headers

    NameTypeDescriptionRequired
    AuthorizationstringThe bearer token to connect to the server.true

    Query String

    NameTypeDescriptionRequired
    namestringThe name of the token.true

    Example:

    GET /_/token/value?name=example