Identity

Who am I?

Read the identity the API resolved for your credential.

get/whoami

Request

  • Base URL: https://api.xcures.com/v3
  • URL: https://api.xcures.com/v3/whoami
  • Auth: HTTP bearer

Response

The identity the API resolved for the credential.

clientIdstring required

The credential's subject; a person's user id or an API key's id.

clientType'user' | 'api-key' required

The class of credential, user for a signed-in person or api-key for an exchanged key.

organizationIdstring required

The one organization the credential acts for.

projectIdsstring[] required

The projects the credential spans.

permissionsstring[] required

The permissions the credential's issuer granted, relayed as the token carried them; empty when it carried none.

audiencestring required

The audience the credential was accepted for; the permissions are that audience's grants.

requestedProjectIdstring nullable required

The project this request named with the ProjectId header; null when it named none.

Changes

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