Sign in
Authentication

Test authentication and identify the key's owner.

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

Response

messagestring
workspace_idinteger

Example response

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

Changes

Changed in 1 of the 3 revisions of this API.5

  • dd3f47f72f7a5See the full diff
    • ○

      api operation id getApiExternalV1HelloWorldUser removed and replaced with testAuthenticationAndIdentifyTheKeysOwner

      api-operation-id-removed

    • ○

      api tag Authentication added

      api-tag-added

    • ○

      api tag Endpoints removed

      api-tag-removed

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the success response with the status 200

      response-success-status-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog