/projects/{project_id}/branches/{branch_id}/auth/plugins/organizationUpdate organization plugin configuration
Updates the organization plugin configuration for Neon Auth. The organization plugin enables multi-tenant organization support.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/plugins/organization" \
-X PATCH \
-H "Authorization: Bearer $NEON_API_KEY"neon neon-auth config organization updateParameters
project_idThe Neon project ID
branch_idThe Neon branch ID
Request body
No field is required.
enabledControls whether the organization plugin is active for the organization.
organization_limitMaximum organizations a user can belong to (created or joined). At the limit, the user cannot create or join more.
min: 1
membership_limitMaximum members per organization.
min: 1
creator_roleRole of the organization's creator. owner: full control, including deleting the org and transferring ownership. admin: manage members and settings only.
send_invitation_emailWhen true, invited users receive an email containing an accept link. Requires that the invited user has a verified email address.
Response
200The organization plugin configuration has been updated
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
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.