API リファレンス

Auth

Management API: GET /whoami

このページは英語のみです。API リファレンス、Webhook イベント、変更履歴は、コード内のフィールド名やエラーコードと揃えるため英語で提供しています。

Base URL https://app.kanorio.com/api/v1Errors Pagination

Auth whoami

GET/whoami

betadefault (120/minute per token)

Inspect the current token's granted scopes, website restrictions, and any capabilities hidden from tools/list (with the exact reason: missing_scope or feature_disabled). Call this before telling the user a feature is unsupported. Pass websiteId to also get your team role on that website and the effective permissions there (token scopes intersected with the role's permissions), plus capabilities your token has the scope for but your role does not allow on that website. Errors: UNAUTHORIZED, FORBIDDEN (websiteId given but you are not a member of that website).

Parameters

websiteIdstring · query
Optional: also report your role and effective permissions on this website.

Response 200

userIdstringrequired
Authenticated user id.
tokenIdstringrequired
Current token id.
channelstringrequired
Request channel (mcp or api).
scopesstring[]required
Permission scopes granted to this token.
websiteScope"all" | "restricted"required
Whether the token can access all of the user's websites or only specific websiteIds.
websiteIdsstring[] | nullrequired
Allowed websiteIds when websiteScope is 'restricted'; null when 'all'.
hiddenCapabilitiesobject[]required
hiddenCapabilities[].namestringrequired
Capability name.
hiddenCapabilities[].reason"missing_scope" | "feature_disabled"required
Why the capability is hidden from tools/list.
hiddenCapabilities[].requiredScopestring | nullrequired
Scope needed to unlock this capability.
siteobject
Present when websiteId is passed.
site.websiteIdstringrequired
site.role"owner" | "admin" | "custom"required
Your team role kind on this website.
site.roleNamestring | nullrequired
Custom role name set by the site owner; null for owner and admin.
site.memberPermissionsstring[]required
Permissions your team role grants on this website.
site.effectivePermissionsstring[]required
What calls on this website can actually do: token scopes intersected with memberPermissions.
site.blockedByRoleobject[]required
Capabilities your token has the scope for but your role does not allow here; ask the site owner or an admin to change your role.
site.blockedByRole[].namestringrequired
site.blockedByRole[].requiredPermissionstringrequired

Errors

UNAUTHORIZED 401
FORBIDDEN 403 · websiteId given but you are not a member of that website

MCP tool auth_whoami

curl -X GET "https://app.kanorio.com/api/v1/whoami" \
  -H "Authorization: Bearer $KANORIO_TOKEN"

Response

{
  "userId": "usr_example01",
  "tokenId": "tok_example01",
  "channel": "mcp",
  "scopes": [
    "console:view",
    "editor:enter",
    "content:edit"
  ],
  "websiteScope": "all",
  "websiteIds": null,
  "hiddenCapabilities": [
    {
      "name": "site.publish",
      "reason": "missing_scope",
      "requiredScope": "site:lifecycle"
    }
  ]
}