AuthService

GetAuth

Return the tenant the current API key belongs to. This endpoint requires a valid API key but no additional scope, so it is a convenient way to verify that a key is working.

get/v1/auth

Request

  • Base URL: https://cloud-api.usw2.elembio.io
  • URL: https://cloud-api.usw2.elembio.io/v1/auth
  • Auth: API key in header x-api-key

Response

Success

tenantIdstring

Identifier of the tenant the API key belongs to.

scopesstring[]

Scopes granted to the API key making the request, e.g. "runs:read" or "storage:download:stc_abc123/data/". A resource-scoped key reports its resource-qualified scopes; an unrestricted key reports its family-level scopes. An empty list means the key has no resource scopes (only the auth-level access needed to reach this endpoint).

Changes

No recorded changes to this operation across all 1 revision of this API.