Update organization plugin configuration

PATCH /projects/{project_id}/branches/{branch_id}/auth/plugins/organization

Updates the organization plugin configuration for Neon Auth. The organization plugin enables multi-tenant organization support.

Markdown for AI context

curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/plugins/organization" \
  -X PATCH \
  -H "Authorization: Bearer $NEON_API_KEY"

Also available in

neon neon-auth config organization update

Project ID

project_id

string

The Neon project ID

Branch ID

branch_id

string

The Neon branch ID

No field is required.

Enabled

enabled

boolean

Controls whether the organization plugin is active for the organization.

Organization limit

organization_limit

integer

Maximum organizations a user can belong to (created or joined). At the limit, the user cannot create or join more.

min: 1

Membership limit

membership_limit

integer

Maximum members per organization.

min: 1

Creator role

creator_role

string

Role of the organization's creator. owner: full control, including deleting the org and transferring ownership. admin: manage members and settings only.

adminowner

Send invitation email

send_invitation_email

boolean

When true, invited users receive an email containing an accept link. Requires that the invited user has a verified email address.

200

The organization plugin configuration has been updated

"enabled": true,req

"organization_limit": 10,reqint32min: 1

"membership_limit": 100,reqint32min: 1

"creator_role": owner,reqadmin | owner

"send_invitation_email": false,req

default

General error

This endpoint can return the standard Neon API error response.

Response fields

• message Required. Human-readable error message.
• code Required. Machine-readable error code.
• request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.