GEgenpage
Authentication

Test authentication and identify the key's owner.

Changed on

Returns the account the API key belongs to, and the workspace the key is bound to (null for keys created before keys were workspace-bound, which may act on every workspace the account can reach).

get/api/external/v1/hello-world-user

Request

Response

messagestring
workspace_idinteger

Example response

{
  "message": "Hello World",
  "user": {
    "id": 123,
    "name": "John Doe",
    "email": "john@example.com"
  },
  "workspace_id": 55
}

Changes

  • dd3f47f72f7aRevision changes
    • info

      api operation id getApiExternalV1HelloWorldUser removed and replaced with testAuthenticationAndIdentifyTheKeysOwner

    • info

      api tag Authentication added

    • info

      api tag Endpoints removed

    • info

      added the non-success response with the status

    • info

      added the success response with the status