Sign in
Users

Retrieve request authentication details

Returns authentication details for the credentials used in the request, including the credential type (API key, Bearer token, or OAuth session) and the associated identity.

get/auth

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/auth
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Response

Returned auth information about the current auth entity

account_idstring required

The ID of the account associated with this authentication record.

auth_method'keycloak' | 'session_cookie' | 'api_key_user' | 'api_key_org' | 'oauth' required

Authentication method used for the request:

  • keycloak: Keycloak identity provider authentication.
  • session_cookie: Browser session cookie authentication.
  • api_key_user: API key scoped to a user account.
  • api_key_org: API key scoped to an organization.
  • oauth: OAuth-based authentication.
auth_datastring

Changes

No recorded changes to this operation across all 15 revisions of this API.