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

Get Authorization Settings

Gets the project's membership authorization (role-assignment) settings.

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

This endpoint returns the authorization settings defined in your project.

Gets the project's membership authorization (role-assignment) settings.

get
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

Header parameters
norbix-project-idstring · nullableRequired

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

norbix-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

Success

application/json

GetAuthorizationSettingsResponse

get/{version}/membership/authorization
GET /{version}/membership/authorization HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
norbix-project-id: text
Accept: */*
200

Success

{
  "result": {
    "allowedProviderRegisterRoles": [],
    "allowedRegisterRoles": [],
    "deactivationExpiration": 10,
    "defaultSubscribeToNews": true,
    "emailVerificationExpiration": 10,
    "guestRegistersAsRole": "text",
    "invitationExpiration": 10,
    "resetPasswordTokenExpiration": 10,
    "userRegistersAsRole": "text"
  },
  "responseStatus": {
    "isSuccess": true
  }
}

In Cloud

Manage this visually in Cloud — see Membership → Settings.

Use it from code

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

Last updated

Was this helpful?