API Reference

Accounts

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

GetAccount

client.accounts.retrieve(AccountRetrieveParams { empty } body, RequestOptionsoptions?): AccountRetrieveResponse { account }

POST/gitpod.v1.AccountService/GetAccount

Gets information about the currently authenticated account.

Use this method to:

• Retrieve account profile information
• Check organization memberships
• View account settings
• Get joinable organizations

Examples

• Get account details:

  Retrieves information about the authenticated account.

  {}

ParametersExpand Collapse

body: AccountRetrieveParams { empty }

empty?: boolean

ReturnsExpand Collapse

AccountRetrieveResponse { account }

account: Account { id, createdAt, email, 7 more }

id: string

formatuuid

createdAt: string

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are “smeared” so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

 Timestamp timestamp;
 timestamp.set_seconds(time(NULL));
 timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

 struct timeval tv;
 gettimeofday(&tv, NULL);

 Timestamp timestamp;
 timestamp.set_seconds(tv.tv_sec);
 timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

 FILETIME ft;
 GetSystemTimeAsFileTime(&ft);
 UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

 // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
 // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
 Timestamp timestamp;
 timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
 timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

 long millis = System.currentTimeMillis();

 Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
     .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

 Instant now = Instant.now();

 Timestamp timestamp =
     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
         .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

 timestamp = Timestamp()
 timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is “{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z” where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The “Z” suffix indicates the timezone (“UTC”); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by “Z”) when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, “2017-01-15T01:30:15.01Z” encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec ‘%Y-%m-%dT%H:%M:%S.%fZ’. Likewise, in Java, one can use the Joda Time’s ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

formatdate-time

email: string

name: string

updatedAt: string

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are “smeared” so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

 Timestamp timestamp;
 timestamp.set_seconds(time(NULL));
 timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

 struct timeval tv;
 gettimeofday(&tv, NULL);

 Timestamp timestamp;
 timestamp.set_seconds(tv.tv_sec);
 timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

 FILETIME ft;
 GetSystemTimeAsFileTime(&ft);
 UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

 // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
 // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
 Timestamp timestamp;
 timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
 timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

 long millis = System.currentTimeMillis();

 Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
     .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

 Instant now = Instant.now();

 Timestamp timestamp =
     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
         .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

 timestamp = Timestamp()
 timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is “{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z” where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The “Z” suffix indicates the timezone (“UTC”); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by “Z”) when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, “2017-01-15T01:30:15.01Z” encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec ‘%Y-%m-%dT%H:%M:%S.%fZ’. Likewise, in Java, one can use the Joda Time’s ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

formatdate-time

avatarUrl?: string

Deprecatedjoinables?: Array<JoinableOrganization { organizationId, organizationName, organizationMemberCount } >

joinables is deprecated. Use ListJoinableOrganizations instead.

organizationId: string

organization_id is the id of the organization the user can join

formatuuid

organizationName: string

organization_name is the name of the organization the user can join

organizationMemberCount?: number

organization_member_count is the member count of the organization the user can join

formatint32

memberships?: Array<AccountMembership { organizationId, organizationName, userId, 3 more } >

organizationId: string

organization_id is the id of the organization the user is a member of

formatuuid

organizationName: string

organization_name is the name of the organization the user is a member of

userId: string

user_id is the ID the user has in the organization

formatuuid

userRole: OrganizationRole

user_role is the role the user has in the organization

One of the following:

"ORGANIZATION_ROLE_UNSPECIFIED"

"ORGANIZATION_ROLE_ADMIN"

"ORGANIZATION_ROLE_MEMBER"

organizationMemberCount?: number

organization_member_count is the member count of the organization the user is a member of

formatint32

organizationTier?: OrganizationTier

organization_tier is the tier of the organization (Free, Core, Enterprise)

One of the following:

"ORGANIZATION_TIER_UNSPECIFIED"

"ORGANIZATION_TIER_FREE"

"ORGANIZATION_TIER_ENTERPRISE"

"ORGANIZATION_TIER_CORE"

"ORGANIZATION_TIER_FREE_ONA"

organizationId?: string | null

organization_id is the ID of the organization the account is owned by if it’s created through custom SSO

publicEmailProvider?: boolean

public_email_provider is true if the email for the Account matches a known public email provider

GetAccount

TypeScript

HTTP

TypeScript

Python

Go

import Gitpod from '@gitpod/sdk';

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

const account = await client.accounts.retrieve();

console.log(account.account);

200 example

{
  "account": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "email": "email",
    "name": "name",
    "updatedAt": "2019-12-27T18:11:19.117Z",
    "avatarUrl": "avatarUrl",
    "joinables": [
      {
        "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "organizationName": "organizationName",
        "organizationMemberCount": 0
      }
    ],
    "memberships": [
      {
        "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "organizationName": "organizationName",
        "userId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "userRole": "ORGANIZATION_ROLE_UNSPECIFIED",
        "organizationMemberCount": 0,
        "organizationTier": "ORGANIZATION_TIER_UNSPECIFIED"
      }
    ],
    "organizationId": "organizationId",
    "publicEmailProvider": true
  }
}

Returns Examples

200 example

{
  "account": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "email": "email",
    "name": "name",
    "updatedAt": "2019-12-27T18:11:19.117Z",
    "avatarUrl": "avatarUrl",
    "joinables": [
      {
        "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "organizationName": "organizationName",
        "organizationMemberCount": 0
      }
    ],
    "memberships": [
      {
        "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "organizationName": "organizationName",
        "userId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "userRole": "ORGANIZATION_ROLE_UNSPECIFIED",
        "organizationMemberCount": 0,
        "organizationTier": "ORGANIZATION_TIER_UNSPECIFIED"
      }
    ],
    "organizationId": "organizationId",
    "publicEmailProvider": true
  }
}