me

Describe the calling credential

Returns who is calling and what they are allowed to do: whether the caller is a signed-in person, an API key, or Brix support; the location an API key is pinned to, if any; the workspace; and the caller's full set of permissions.

Who is calling (API key, user, or Brix support), which workspace the call resolves to, and the permissions held. Call it first when a request is refused: actor.nodeId shows a key pinned to one location.

get/v1/me

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/me
  • Auth: HTTP bearer

Response

Success.

Changes

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