Skip to content
Northwestern Laravel Starter

Get authenticated user details

GET
/api/v1/me

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Authenticated user profile.

object
data
required
object
id
required
integer format: int64
Example
1024
username
required
string
Example
abc123
auth_type
required

How the user authenticates to the application.

string
Allowed values: sso local api
Example
api
first_name
required
string
Example
NUIT
last_name
required
string
Example
API
full_name
required
string
Example
NUIT API
email
required
string format: email
Example
nuit.api@example.edu
primary_affiliation

Primary Northwestern affiliation for the user.

string
nullable
Allowed values: student faculty staff affiliate not-matched
Example
not-matched
departments
Array<string>
Example
[
  "IT Services",
  "Information Security"
]
job_titles
Array<string>
Example
[
  "Systems Administrator"
]
created_at
string format: date-time
nullable
Example
2023-11-06T15:20:00Z
updated_at
string format: date-time
nullable
Example
2024-04-09T18:45:10Z
roles
Array<object>
nullable
object
id
required
integer format: int64
Example
4
name
required
string
Example
Content Manager
role_type
One of:
object
slug
required
string
Allowed values: system-managed application-admin application-role api-integration
Example
api-integration
label
required
string
Example
API Integration
created_at
string format: date-time
nullable
Example
2025-01-15T18:00:00Z
updated_at
string format: date-time
nullable
Example
2025-04-21T12:05:23Z
permissions

Included when permissions are eager loaded.

Array<object>
nullable
object
id
required
integer format: int64
Example
17
name
required

Machine-friendly permission name.

string
Example
manage-users
label
required

Human readable permission label.

string
Example
Manage Users
description
string
nullable
Example
Allows creating, editing, and disabling user accounts.
scope
required

Whether this permission applies system-wide or only to the authenticated user’s context.

string
Allowed values: system-wide personal
Example
system-wide
system_managed
required
boolean
api_relevant
required

Whether this permission impacts API access patterns.

boolean
Example
true
created_at
string format: date-time
nullable
Example
2024-02-10T16:22:00Z
updated_at
string format: date-time
nullable
Example
2024-04-02T19:43:12Z
users_count

Included when a user count aggregate is loaded.

integer
nullable
Example
18
Example
{
  "data": {
    "id": 1,
    "username": "waw1234",
    "auth_type": "api",
    "first_name": "NUIT",
    "last_name": "API",
    "full_name": "NUIT API",
    "email": null,
    "primary_affiliation": "not-matched",
    "departments": [],
    "job_titles": [],
    "created_at": "2025-11-06T15:20:00+00:00",
    "updated_at": "2025-04-09T18:45:10+00:00",
    "roles": [
      {
        "id": 1,
        "name": "API Role",
        "role_type": {
          "slug": "api-integration",
          "label": "API Integration"
        },
        "created_at": "2025-11-06T15:20:00+00:00",
        "updated_at": "2025-11-06T15:20:00+00:00",
        "permissions": [
          {
            "id": 1,
            "name": "view-users",
            "label": "View Users",
            "description": "Allows viewing all user profiles and their details.",
            "scope": "system-wide",
            "system_managed": false,
            "api_relevant": true,
            "created_at": "2025-11-06T15:20:00+00:00",
            "updated_at": "2025-11-06T15:20:00+00:00"
          }
        ]
      }
    ]
  }
}

401

Section titled “401 ”

Missing or invalid bearer token.

Standard RFC 9457 problem details envelope.

object
type
required

RFC 9457 compliant problem details response builder.

string format: uri
Example
about:blank
title
required
string
Example
Unauthorized
status
required
integer
Example
401
detail
string
nullable
Example
Authentication failed
instance
required
string format: uri-reference
Example
/api/v1/me
trace_id

Unique identifier for the API request (if available).

string
nullable
Example
b4f5aa7a-1470-4d92-8d3c-98e7c7de9f5f