auth-tokens

Changed on

Lists all AuthenticationTokens in the system.

put/api/auth-tokens/{id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in cookie sessionid

Path parameters

idinteger required

A unique integer value identifying this authentication token.

Request body

auth_devicestring required

Namespace for this token.

token_valuestring required

Actual value of the token, unique within an auth_device.

nice_namestring nullable

A human-readable alias for the token, for example "Guest Key".

pinstring nullable

A secret value necessary to authenticate with this token.

userinteger nullable
enabledboolean

Whether this token is considered active.

expire_timestring date-time nullable

Date after which token is treated as disabled.

Response

idinteger required
auth_devicestring required

Namespace for this token.

token_valuestring required

Actual value of the token, unique within an auth_device.

nice_namestring nullable

A human-readable alias for the token, for example "Guest Key".

pinstring nullable

A secret value necessary to authenticate with this token.

user_idinteger nullable required

User in possession of and authenticated by this token.

enabledboolean

Whether this token is considered active.

created_timestring date-time required

Date token was first added to the system.

expire_timestring date-time nullable

Date after which token is treated as disabled.

Changes

  • 8d1d025a79e9Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1 (media type: application/json)

    • breaking

      the request property's minLength was increased from 0 to 1 (media type: application/x-www-form-urlencoded)

    • breaking

      the request property's minLength was increased from 0 to 1 (media type: multipart/form-data)

    • breaking

      the request property's minLength was increased from 0 to 1 (media type: application/json)

    • breaking

      the request property's minLength was increased from 0 to 1 (media type: application/x-www-form-urlencoded)

    • breaking

      the request property's minLength was increased from 0 to 1 (media type: multipart/form-data)

    • info

      removed the optional write-only property user from the response with the status