Verify User Logged In
This page uses Nexus's generated request and response schema. Requests still require the correct account, workspace, and resource permissions.
/mecurl --request GET 'https://school.narb.cc/api/me' \
--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.
Parameters#
| Name | Location | Required | Type |
|---|---|---|---|
tenant_id | query | No | string or null |
The tenant_id parameter is part of the engine schema. It does not authorize a caller to another school. Use the workspace and permissions assigned to your account.
Responses#
200#
Successful Response
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"email": {
"type": "string",
"title": "Email"
},
"is_active": {
"type": "boolean",
"title": "Is Active"
},
"is_superuser": {
"type": "boolean",
"title": "Is Superuser"
},
"is_verified": {
"type": "boolean",
"title": "Is Verified"
},
"account_type": {
"$ref": "#/components/schemas/AccountType",
"default": "STANDARD"
},
"preferences": {
"$ref": "#/components/schemas/UserPreferences"
},
"personalization": {
"$ref": "#/components/schemas/UserPersonalization"
},
"token_expires_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Token Expires At"
},
"is_cloud_superuser": {
"type": "boolean",
"title": "Is Cloud Superuser",
"default": false
},
"team_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Team Name"
},
"is_anonymous_user": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Anonymous User"
},
"password_configured": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Password Configured"
},
"tenant_info": {
"anyOf": [
{
"$ref": "#/components/schemas/TenantInfo"
},
{
"type": "null"
}
]
},
"effective_permissions": {
"items": {
"type": "string"
},
"type": "array",
"title": "Effective Permissions"
},
"is_group_manager": {
"type": "boolean",
"title": "Is Group Manager",
"default": false
},
"admin_capabilities": {
"items": {
"type": "string"
},
"type": "array",
"title": "Admin Capabilities"
}
},
"type": "object",
"required": [
"id",
"email",
"is_active",
"is_superuser",
"is_verified",
"preferences"
],
"title": "UserInfo"
}422#
Validation Error
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}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.