External

External - Who am I

Auth: Authenticated - any signed-in user.

Worked example of a scope-gated external endpoint. Returns the calling client's identity, granted permissions and allowed endpoints. Requires a bearer token from the external token endpoint, and the client must have been granted access to this path (enforced by ExternalApiAccessPreProcessor).

get/external/v1/whoami

Request

  • Base URL: https://api.tonbridge.school
  • URL: https://api.tonbridge.school/external/v1/whoami
  • Auth: one of:
    • HTTP bearer
    • ServiceAccount (OAuth2) (defined in the document in a form this page cannot read)

Response

Success

clientIdstring nullable
displayNamestring nullable
permissionsstring[]
allowedApisstring[]

Changes

No recorded changes to this operation across all 45 revisions of this API.