API reference

Get Auth Type

Before you begin

This page uses Nexus's generated request and response schema. Requests still require the correct account, workspace, and resource permissions.

GET/auth/type

Workspace

curl --request GET 'https://school.narb.cc/api/auth/type' \
  --header 'Authorization: Bearer YOUR_TOKEN'

This builds a request example. Fill in required query values, then replace path placeholders and YOUR_TOKEN in your own environment. Use a token for a user with access to this workspace. Responses and permissions depend on your account and deployment. Never paste a private token into documentation.

Download the Nexus OpenAPI schema ↗
Import the schema into your API client. It describes the backend source; enabled routes depend on your workspace.

Authentication and scope#

Send requests to the workspace that owns the resource. Authentication does not by itself grant a school membership, class assignment, or administrator permission. School endpoints apply their role and class checks on the server.

Use a credential issued for that workspace with only the permissions your integration needs. Keep it on your server. Do not place credentials in a public website or a shared skill.

Responses#

200#

Successful Response

{
  "properties": {
    "nexusPersonalMode": {
      "type": "boolean",
      "title": "Nexuspersonalmode",
      "default": false
    },
    "nexusSchoolMode": {
      "type": "boolean",
      "title": "Nexusschoolmode",
      "default": false
    },
    "multi_tenant": {
      "type": "boolean",
      "title": "Multi Tenant"
    },
    "requires_verification": {
      "type": "boolean",
      "title": "Requires Verification"
    },
    "anonymous_user_enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Anonymous User Enabled"
    },
    "password_min_length": {
      "type": "integer",
      "title": "Password Min Length"
    },
    "password_max_length": {
      "type": "integer",
      "title": "Password Max Length"
    },
    "password_require_uppercase": {
      "type": "boolean",
      "title": "Password Require Uppercase",
      "default": false
    },
    "password_require_lowercase": {
      "type": "boolean",
      "title": "Password Require Lowercase",
      "default": false
    },
    "password_require_digit": {
      "type": "boolean",
      "title": "Password Require Digit",
      "default": false
    },
    "password_require_special_char": {
      "type": "boolean",
      "title": "Password Require Special Char",
      "default": false
    },
    "has_users": {
      "type": "boolean",
      "title": "Has Users",
      "default": true
    },
    "oauth_enabled": {
      "type": "boolean",
      "title": "Oauth Enabled",
      "default": false
    },
    "password_auth_enabled": {
      "type": "boolean",
      "title": "Password Auth Enabled",
      "default": true
    },
    "sso_providers": {
      "items": {
        "$ref": "#/components/schemas/SSOProviderOption"
      },
      "type": "array",
      "title": "Sso Providers",
      "default": []
    }
  },
  "type": "object",
  "required": [
    "multi_tenant",
    "requires_verification",
    "password_min_length",
    "password_max_length"
  ],
  "title": "AuthConfigResponse"
}

Access and error handling#

A signed-out or expired session needs authentication. A denied request can mean the account lacks permission, class membership, an approved model, or an available allowance. Do not retry a write blindly after a network failure; first check whether it was recorded.

Treat validation errors as a request problem. Use the returned field details to correct the request. Resource identifiers do not confer access.

Schema version#

Generated from Nexus backend source fe1c3a07c793029d3d87191a68f89e481afd6bc8. Check your deployed version before integrating. Schema coverage is not a live acceptance test.