JavaScript
Accounts
Get the current profile
Which identity is holding this token: a person, an API key, or the system.
GET
JavaScript
Answers “who am I?” for the token in your hand. A profile is an identity inside an account, and this returns the one the current credential belongs to.
Account-scoped, so there is no
workspaceId in the path.
The four profile types
spec.type tells you what kind of identity signed the request:
A key’s profile has a synthetic
email (apikey@cadenya.internal) and the key’s name. A person’s profile carries their real name and email. The type is how a tool decides whether it is acting for a human or a service.
The identity trio
whoami is one of three account-scoped reads that together answer “who am I and what can I touch”:
A profile moves between workspaces in an account without a fresh invite, so
whoami names the identity and List workspaces names its reach. The createdBy you see on resources across the API is a profile of one of these types.
Related
Get the account
The account this profile belongs to.
List workspaces
What this identity can reach.
API design
Profiles, accounts, workspaces, and how they nest.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
OK
A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces.