For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update Authentication Settings

Updates the project's membership authentication preferences.

Membership settings control how authentication and authorization behave for your project — allowed sign-in methods, registration rules, password complexity, and passkey options.

This endpoint updates the authentication settings — only the fields you send are changed.

Updates the project's membership authentication preferences.

put
Authorizations
HTTPRequired

JWT Bearer Authorization

Path parameters
versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Body

Updates the project's membership authentication preferences.

logoutUrlstring · nullableOptional

Default URL to redirect end users to after logout.

allowUsernamesbooleanOptional

Whether end users may sign in with a username in addition to email.

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

cultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstring · nullableOptional

TimeZone

correlationIdstring · nullableOptional

CorrelationId for each request

Responses
200

OK

application/json
put/{version}/membership/authentication
PUT /{version}/membership/authentication HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 228

{
  "logoutUrl": "text",
  "allowUsernames": true,
  "modes": [
    {
      "name": "text",
      "logoutUrl": "text"
    }
  ],
  "projectId": "text",
  "env": "text",
  "resolvedEnv": {
    "value": "text",
    "isProd": true
  },
  "cultureCode": "text",
  "timeZoneId": "text",
  "correlationId": "text"
}
200

OK

{
  "responseStatus": {
    "isSuccess": true
  }
}

In the dashboard

Manage this visually in Norbix Cloud — see Membership → Settings.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Update Authentication Settings in the SDK reference, with examples in every language.

Last updated