FIfieldguide
api

Get metadata about the current authentication token

Changed on

auth_method distinguishes the response shape: api_token for API Tokens, oauth for OAuth access tokens, and web for Fieldguide web sessions. OAuth access tokens and web sessions share type: jwt.

get/v1/token

Request

  • Base URL
    https://api.fieldguide.io
  • URL
    https://api.fieldguide.io/v1/token
  • Auth
    HTTP bearer

Response

Metadata about the current authentication token

Example response

{
  "data": {
    "user_uuid": "821e8d9e-d2a8-480f-9187-5a685d3d0d71",
    "created_at": "2023-01-01T12:30:00.000Z",
    "expires_at": "2023-01-01T12:30:00.000Z",
    "type": "api",
    "auth_method": "api_token",
    "uuid": "821e8d9e-d2a8-480f-9187-5a685d3d0d71",
    "name": "Acme ABC Token",
    "scopes": [
      "engagements:read",
      "engagements.files:read",
      "engagements.files:write"
    ]
  }
}

Changes

  • cc98c164ea81Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • info

      added api_token oauth web discriminator mapping keys to the response property for the response status

    • info

      removed api jwt discriminator mapping keys from the response property for the response status

    • info

      response discriminator property name changed for response property from type to auth_method for the response status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status

  • f41600b5d156Revision changes
    • info

      added the non-success response with the status