Introspection

Get the authenticated principal

Returns the workspace and user for the current credential. A 200 confirms the credential is valid; 401 means it's expired, revoked, or malformed.

  • For OAuth callers, userId is the end user who authorized the token (JWT sub).
  • For API-key callers, userId is the Nooks user who generated the key on the API Keys page in Developer Settings.
  • userId is always populated. email and name are null if that user no longer has a seat in the workspace.
  • clientId and scopes are null for API-key callers (API keys have full workspace access).

Response is intentionally flat as an introspection endpoint and doesn't follow the nested ReferenceObject shape the resource endpoints use.

Available to any authenticated caller regardless of granted scopes.

get/me

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/me
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://oauth.nooks.in/oauth/authorize, token URL https://oauth.nooks.in/oauth/token)

Response

Successful response

workspaceIdstring required

Workspace the credential is scoped to.

userIdstring required

Acting user's ID. For OAuth this is the end user who authorized the token (JWT sub); for API keys it's the user who created the key. Always populated.

emailstring email nullable required

Email of the acting user; null if no longer a seat holder.

namestring nullable required

Full name of the acting user; null if no longer a seat holder.

authType'oauth' | 'apiKey' required

Authentication scheme used for the request.

clientIdstring nullable required

For OAuth: the partner-facing client identifier (the same client_id used in OAuth requests). For API keys: null.

scopesstring[] nullable required

For OAuth: the granted scope list from the access token. For API keys: null (keys grant blanket access).

Changes

No recorded changes to this operation across all 1 revision of this API.