GetAuthenticatedIdentity

client.identity.getAuthenticatedIdentity(, ?): IdentityGetAuthenticatedIdentityResponse { organizationId, organizationTier, subject }

POST/gitpod.v1.IdentityService/GetAuthenticatedIdentity

Retrieves information about the currently authenticated identity.

Use this method to:

Get current user information
Check authentication status
Retrieve organization context
Validate authentication principal

Examples

Get current identity:

Retrieves details about the authenticated user.
```
{}
```

ParametersExpand Collapse

body: IdentityGetAuthenticatedIdentityParams { empty }

empty?: boolean

ReturnsExpand Collapse

IdentityGetAuthenticatedIdentityResponse { organizationId, organizationTier, subject }

organizationId?: string

organizationTier?: string

subject?: Subject { id, principal }

subject is the identity of the current user

id?: string

id is the UUID of the subject

formatuuid

principal?: Principal

Principal is the principal of the subject

One of the following:

"PRINCIPAL_UNSPECIFIED"

"PRINCIPAL_ACCOUNT"

"PRINCIPAL_USER"

"PRINCIPAL_RUNNER"

"PRINCIPAL_ENVIRONMENT"

"PRINCIPAL_SERVICE_ACCOUNT"

"PRINCIPAL_RUNNER_MANAGER"

GetAuthenticatedIdentity

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const response = await client.identity.getAuthenticatedIdentity();

console.log(response.organizationId);

{
  "organizationId": "organizationId",
  "organizationTier": "organizationTier",
  "subject": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "principal": "PRINCIPAL_UNSPECIFIED"
  }
}

Returns Examples

{
  "organizationId": "organizationId",
  "organizationTier": "organizationTier",
  "subject": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "principal": "PRINCIPAL_UNSPECIFIED"
  }
}