Retrieve request authentication details

API Reference / 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.

• account_id (string, optional) The ID of the account associated with this authentication record.

• auth_method (string, optional) 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.

  Possible values: keycloak, session_cookie, api_key_user, api_key_org, oauth

• auth_data (string, optional)

curl "https://console.neon.tech/api/v2/auth" \
  -H "Authorization: Bearer $NEON_API_KEY"

import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.getAuthDetails({
  client: neon.client
});

default General Error.

The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received.

• If no response is returned from the API, a network error or timeout likely occurred.
• In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.

The following HTTP methods are considered non-idempotent: POST, PATCH, DELETE, and PUT. Retrying these methods is generally not safe. The following methods are considered idempotent: GET, HEAD, and OPTIONS. Retrying these methods is safe in the event of a network error or timeout.

Any request that returns a 503 Service Unavailable response is always safe to retry.

Any request that returns a 423 Locked response is safe to retry. 423 Locked indicates that the resource is temporarily locked, for example, due to another operation in progress.

• request_id (string, optional) Unique identifier for the request, useful for debugging. You can set this value manually by including an X-Request-ID header in the request. If not provided, the value will be generated automatically.

• code (string, required) Machine-readable code classifying the error type. See message for a human-readable explanation. Default: ``

• message (string, required) Error message