Read the signed-in Member

GET /v1/members/me

Answers the Member record of the Member session that makes the request, with the id of its Organization. Any valid Member session reads its own record, whatever its role: the access matrix (access-control-and-isolation.md section 4.2) grants every role a read of its Members row, and no members:read is needed, which only owner, admin and operator hold in Phase 0. The descriptor names organization:read, a permission every role holds, because a route names one permission; it is not what admits the caller. The route is for a Member session only: the api refuses every API key with forbidden, whatever its scopes, because a key is not a Member. It exists so that a console signed in as a developer or an agent_operator, who may start a demo Call (calls:write) but cannot list Members, reads its own role. From 1.45.0 a Member ID token whose identity is not a Member is refused with forbidden and one detail at path /headers/authorization whose code is a SignInRefusalCode: sign_in_pending (the sign-in is kept as a sign-in attempt of its verified email, waiting for an operator to approve it), member_disabled, email_unverified, email_held (the verified email belongs to a Member linked to another identity), ambiguous_membership, unknown_role or, from 1.51.0, invitation_expired (the Member of the verified email is invited and its invitation lapsed). The detail carries a code and fixed words, never the email or the identity. A sign-in with no Member while the Member pool serves no Organization, and an API key, are refused with no detail. The refusal comes before the route, so every public route answers it to such a token; this read is the one a console asks to choose between its holding page and its refused page.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the organization:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/members/me" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/members/me`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/members/me",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Responses

Fields of the 200 answer

The shape is MemberSelf.