Who am I

Description

Returns the service account the request authenticated as, and the organization it belongs to. It takes no parameters and changes nothing.

This is the endpoint to point a new integration at first. A 200 here proves three things at once: the credentials are well formed, they are still active, and they resolve to the organization you expected. That last one is the useful part - it catches a pipeline wired up with the wrong environment's API key before it creates a release in somebody else's workspace, which is otherwise a mistake you find out about afterwards.

Every other endpoint in this reference authenticates exactly the same way, so if this call fails none of them will work either. That makes it the right thing to run first when something that used to work has stopped: it separates "the credentials are wrong" from "the request is wrong". See Authentication for how the header is built, and Errors and validation for what a failure looks like.

What the fields fall back to

serviceAccountId and organizationId come straight from the authenticated credentials and are always present. They are the two values worth asserting on in a pipeline.

The two names are looked up rather than carried, and each one has a fallback:

• serviceAccountName is the service account's display name, falling back to the serviceAccountId when no user record resolves. A response in which the name and the id are identical therefore means the lookup found nothing - not that somebody named the account after its own id.
• organizationName falls back to the organization name recorded on the service account, and is null when neither resolves.

message is a greeting assembled from serviceAccountName. It exists to make a manual curl readable and carries nothing the other fields do not. Do not parse it - it is the one field here whose wording is free to change.

What it does not tell you

A 200 means the API answered and your credentials are good. It is not a service health check: it says nothing about whether agents are connected, whether a deployment slot is free, or whether anything can currently be deployed. Nor does it describe what the service account is allowed to do - roles are enforced per endpoint, so a call that succeeds here can still come back 401 from Create a release for want of a permission.

Response

Errors