Skip to content
Console
On this page

Sylphx Access whoami

Returns the caller: the principal and the scope of the key or token that authenticated this request.

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Returns the caller: the principal and the scope of the key or token that authenticated this request. Clients fill their org, project, and env defaults from it; every valid key may call it, whatever its scopes.

  • Path GET https://api.sylphx.com/v1/whoami
  • Scope access:whoami
  • Effect read — nothing is written.
  • Service Sylphx Access
  • Publishable key callable

Request

The call carries nothing but its path.

Response

FieldTypeWhat it is
principalstringThe authenticated principal, principal_<cell><ulid>; for a delegated token, the accountable person it acts for (RFC 8693 sub). Output only.
api_keystringThe API key that authenticated the request; empty for an OAuth token. Output only.
orgstringThe org the credential is scoped to. Output only.
projectstringThe project the credential is scoped to; empty for an org-wide credential. Output only.
envstringThe environment the credential is scoped to; empty above an environment. Output only.
scopesstring[]The credential's scopes, <service>:<action>. Output only.
api_versionstringThe API version date applied to this request; empty before the first version. Output only.
actorstringThe agent acting for principal on a delegated token (RFC 8693 act): an Agent name, orgs/{org}/projects/{project}/envs/{env}/agents/{agent}, or the delegate's own principal, orgs/{org}/principals/{principal}. Empty for every other credential. Output only.
resourcesstring[]The full resource names the credential is restricted to; empty for an unrestricted credential. A restricted credential acts only on these. Output only.

Errors

Every error arrives in the body Errors describes.

Examples

curl "https://api.sylphx.com/v1/whoami" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"