solarOS Organization API

Organization API

Inspect the presented organization API key context

Returns the tenant, key prefix/name, granted scopes, rate-limit policy, IP allowlist state, rotation grace state, attribution metadata, and default owners for the API key used on the request. This endpoint requires a valid organization API key but no additional scope.

/api/v1/whoami

Returns the tenant, key prefix/name, granted scopes, rate-limit policy, IP allowlist state, rotation grace state, attribution metadata, and default owners for the API key used on the request. This endpoint requires a valid organization API key but no additional scope.

Call this first when debugging credentials or confirming which organization, scopes, and defaults an agent is using. Never ask the user to paste an existing plaintext key into a browser client.

Required scopes

Any valid organization API key

Parameters

No path or query parameters.

Request body

This endpoint does not accept a JSON request body.

Responses

200

API key context envelope

#/components/schemas/OrgApiResourceEnvelope

401

Missing or invalid organization API key

#/components/schemas/OrgApiError

402

Organization billing access or an endpoint-specific business quota denied the request

#/components/schemas/OrgApiError

429

Rate limit exceeded

#/components/schemas/OrgApiError

Errors

401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request429 Rate limit exceeded

Static examples

curl -X GET "$SOLAROS_BASE_URL/api/v1/whoami" \
  -H "Authorization: Bearer $SOLAROS_API_KEY"