Neon is expanding into a backend: Object Storage, Functions, and AI Gateway now in beta
/APIs & SDKs/Authentication/Update organization plugin configuration
PATCH/projects/{project_id}/branches/{branch_id}/auth/plugins/organization

Update organization plugin configuration

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

Markdown for AI context

Quick start

REST API - curl
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

Parameters

Project ID
project_id
string

The Neon project ID

Branch ID
branch_id
string

The Neon branch ID

Request body

No field is required.

Enabled
enabled
boolean

Whether the organization plugin is enabled

Organization limit
organization_limit
integer

Maximum number of organizations a user can create

min: 1

Membership limit
membership_limit
integer

Maximum number of members per organization

min: 1

Creator role
creator_role
string

The role assigned to the user who creates an organization

adminowner
Send invitation email
send_invitation_email
boolean

Whether to send invitation emails when inviting members to an organization

Response

200

The organization plugin configuration has been updated

Depth
"enabled": true,req
"organization_limit": 10,reqint32min: 1
"membership_limit": 100,reqint32min: 1
"creator_role": owner,reqadmin | owner
"send_invitation_email": false,req

Errors

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.

Was this page helpful?

On this page

Copy neon init command