---
title: "Retrieve Neon Auth plugin configurations"
method: GET
path: "/projects/{project_id}/branches/{branch_id}/auth/plugins"
tags: ["Auth"]
---

# Retrieve Neon Auth plugin configurations

`GET /projects/{project_id}/branches/{branch_id}/auth/plugins`

Returns all plugin configurations for Neon Auth in a single response.
This endpoint aggregates organization, email provider, email and password,
OAuth providers, and localhost settings.

## Response `200`

Returns all plugin configurations

- NeonAuthPluginConfigs — Aggregated plugin configurations for Neon Auth
  - `organization` NeonAuthOrganizationConfig
    - `enabled` boolean, required — Whether the organization plugin is enabled
    - `organization_limit` integer, required — Maximum number of organizations a user can create
    - `membership_limit` integer, required — Maximum number of members per organization
    - `creator_role` 'admin' | 'owner', required — The role assigned to the user who creates an organization
    - `send_invitation_email` boolean, required — Whether to send invitation emails when inviting members to an organization
  - `magic_link` NeonAuthMagicLinkConfig
    - `enabled` boolean, required — Whether the magic link plugin is enabled
    - `expires_in` integer, required — Time in minutes before the magic link expires
    - `disable_sign_up` boolean, required — Whether to disable sign-up via magic link
  - `phone_number` NeonAuthPhoneNumberConfig
    - `enabled` boolean, required — Whether the phone number plugin is enabled
    - `otp_expires_in` integer — Time in seconds before the OTP expires
  - `email_provider` union
    - object
      - `host` string, required
      - `port` integer, required
      - `username` string, required
      - `password` string, required
      - `sender_email` string, required
      - `sender_name` string, required
    - object
      - `sender_email` string
      - `sender_name` string
  - `email_and_password` NeonAuthEmailAndPasswordConfig
    - `enabled` boolean, required — Whether email and password authentication is enabled
    - `email_verification_method` 'link' | 'otp', required — The email verification method to use. - `link`: Sends a verification link via email - `otp`: Sends a one-time password (OTP) via email
    - `require_email_verification` boolean, required — Whether email verification is required before users can sign in
    - `auto_sign_in_after_verification` boolean, required — Whether users are automatically signed in after verifying their email
    - `send_verification_email_on_sign_up` boolean, required — Whether to send a verification email when users sign up
    - `send_verification_email_on_sign_in` boolean, required — Whether to send a verification email when users sign in
    - `disable_sign_up` boolean, required — Whether to disable new user sign ups
  - `oauth_providers` NeonAuthOauthProvider[]
    - `id` 'google' | 'github' | 'microsoft' | 'vercel', required
    - `type` 'standard' | 'shared', required
    - `client_id` string
    - `client_secret` string
  - `allow_localhost` boolean

## Other responses

- `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.

---

[API](https://skmtc.dev/neon/apis/neon-api.md) · [All operations](https://skmtc.dev/neon/apis/neon-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/neon/neon-api/revisions/cfde79a5c713/schema)