Authentication

Authenticate a user

Changed on

This endpoint is used to authenticate a user by providing their API Key. It verifies the provided API Key and returns the user's details upon successful authentication.

post/authentication

Request

Response

User authenticated successfully

statusstring

Status indicating the success of the authentication.

userEmailstring

The email address of the authenticated user.

userDisplayNamestring

The display name of the authenticated user.

orgNamestring

The organization name associated with the authenticated user.

processing_timeinteger

The time taken to process the request, in milliseconds.

processing_idstring

A universally unique identifier for the request. This can be used to track the request in the logs.

Changes

    • info

      the endpoint scheme security bearerAuth was added to the API

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id authenticateUsers removed and replaced with authenticateUser

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status