Summarize what the caller can access

GET

/api/auth/me/access

curl --request GET \
  --url https://gateway.example.com/api/auth/me/access \
  --header 'Authorization: Bearer <token>'

• Your Gateway instance

Groups the calling principal’s effective access by product area: whether it is broad, which folders (with path), nodes, accounts and specific resources are granted with which actions, and where the caller may create. API tokens and OAuth grants are reported as bounded by their owner’s current access; the owner’s identity (id, name, email, group) is returned only to browser sessions. Folder-, node- and resource-limited access is normal: work inside the listed grants and pass folderId (and nodeId) when creating.

Authorizations

• bearerAuth

Responses

200

Access summary

Media typeapplication/json

object

data

required

object

principal

object

credential

required

string

Allowed values: session api-token oauth-token mcp assistant

boundedByOwner

required

boolean

userId

Browser sessions only.

string

name

Browser sessions only.

string | null

email

Browser sessions only.

string

group

Browser sessions only.

string

limited

required

boolean

summary

required

string

areas

required

Array<object>

object

area

required

string

title

required

string

access

required

string

Allowed values: broad limited

broadActions

required

Array<string>

folders

required

Array<object>

object

id

required

string

name

required

string | null

actions

required

Array<string>

path

required

string | null

includesSubfolders

required

boolean

nodes

required

Array<object>

object

id

required

string

name

required

string | null

actions

required

Array<string>

resources

required

Array<object>

object

id

required

string

name

required

string | null

actions

required

Array<string>

nodeId

string

nodeName

string | null

accounts

required

Array<object>

object

id

required

string

name

required

string | null

actions

required

Array<string>

create

object

scope

required

string

atRoot

required

boolean

folders

required

Array<object>

object

id

required

string

name

required

string | null

path

required

string | null

nodes

required

Array<object>

object

id

required

string

name

required

string | null

accounts

required

Array<object>

object

id

required

string

name

required

string | null

howTo

required

string

folderListing

object

tool

required

string

Allowed values: list_resource_folders

arguments

required

object

key

additional properties

string

omitted

object

key

additional properties

number

rules

required

Array<string>

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "[email protected]",
    "name": "Admin User",
    "groupName": "Administrators",
    "scopes": [
      "nodes:details",
      "proxy:view"
    ]
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}