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

tier: OrganizationTier

The tier of the organization - free, enterprise or core

One of the following:

"ORGANIZATION_TIER_UNSPECIFIED"

"ORGANIZATION_TIER_FREE"

"ORGANIZATION_TIER_ENTERPRISE"

"ORGANIZATION_TIER_CORE"

"ORGANIZATION_TIER_FREE_ONA"

updated_at: datetime

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

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

formatdate-time

invite_domains: Optional[InviteDomains]

domains: Optional[List[str]]

domains is the list of domains that are allowed to join the organization

class OrganizationMember: …

email: str

full_name: str

login_provider: str

login_provider is the login provider the user uses to sign in

member_since: datetime

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

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

formatdate-time

role: OrganizationRole

One of the following:

"ORGANIZATION_ROLE_UNSPECIFIED"

"ORGANIZATION_ROLE_ADMIN"

"ORGANIZATION_ROLE_MEMBER"

status: UserStatus

One of the following:

"USER_STATUS_UNSPECIFIED"

"USER_STATUS_ACTIVE"

"USER_STATUS_SUSPENDED"

"USER_STATUS_LEFT"

user_id: str

formatuuid

avatar_url: Optional[str]

class OrganizationCreateResponse: …

organization: Organization

organization is the created organization

id: str

formatuuid

created_at: datetime

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

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

formatdate-time

tier: OrganizationTier

The tier of the organization - free, enterprise or core

One of the following:

"ORGANIZATION_TIER_UNSPECIFIED"

"ORGANIZATION_TIER_FREE"

"ORGANIZATION_TIER_ENTERPRISE"

"ORGANIZATION_TIER_CORE"

"ORGANIZATION_TIER_FREE_ONA"

updated_at: datetime

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

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

formatdate-time

invite_domains: Optional[InviteDomains]

domains: Optional[List[str]]

domains is the list of domains that are allowed to join the organization

member: Optional[OrganizationMember]

member is the member that joined the org on creation. Only set if specified “join_organization” is “true” in the request.

email: str

full_name: str

login_provider: str

login_provider is the login provider the user uses to sign in

member_since: datetime

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

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

formatdate-time

role: OrganizationRole

One of the following:

"ORGANIZATION_ROLE_UNSPECIFIED"

"ORGANIZATION_ROLE_ADMIN"

"ORGANIZATION_ROLE_MEMBER"

status: UserStatus

One of the following:

"USER_STATUS_UNSPECIFIED"

"USER_STATUS_ACTIVE"

"USER_STATUS_SUSPENDED"

"USER_STATUS_LEFT"

user_id: str

formatuuid

avatar_url: Optional[str]

class OrganizationJoinResponse: …

member: OrganizationMember

member is the member that was created by joining the organization.

email: str

full_name: str

login_provider: str

login_provider is the login provider the user uses to sign in

member_since: datetime

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

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

formatdate-time

role: OrganizationRole

One of the following:

"ORGANIZATION_ROLE_UNSPECIFIED"

"ORGANIZATION_ROLE_ADMIN"

"ORGANIZATION_ROLE_MEMBER"

status: UserStatus

One of the following:

"USER_STATUS_UNSPECIFIED"

"USER_STATUS_ACTIVE"

"USER_STATUS_SUSPENDED"

"USER_STATUS_LEFT"

user_id: str

formatuuid

avatar_url: Optional[str]

class OrganizationRetrieveResponse: …

organization: Organization

organization is the requested organization

id: str

formatuuid

created_at: datetime

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

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

formatdate-time

tier: OrganizationTier

The tier of the organization - free, enterprise or core

One of the following:

"ORGANIZATION_TIER_UNSPECIFIED"

"ORGANIZATION_TIER_FREE"

"ORGANIZATION_TIER_ENTERPRISE"

"ORGANIZATION_TIER_CORE"

"ORGANIZATION_TIER_FREE_ONA"

updated_at: datetime

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

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

formatdate-time

invite_domains: Optional[InviteDomains]

domains: Optional[List[str]]

domains is the list of domains that are allowed to join the organization

class OrganizationUpdateResponse: …

organization: Organization

organization is the updated organization

id: str

formatuuid

created_at: datetime

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

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

formatdate-time

tier: OrganizationTier

The tier of the organization - free, enterprise or core

One of the following:

"ORGANIZATION_TIER_UNSPECIFIED"

"ORGANIZATION_TIER_FREE"

"ORGANIZATION_TIER_ENTERPRISE"

"ORGANIZATION_TIER_CORE"

"ORGANIZATION_TIER_FREE_ONA"

updated_at: datetime

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

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

formatdate-time

invite_domains: Optional[InviteDomains]

domains: Optional[List[str]]

domains is the list of domains that are allowed to join the organization

OrganizationsAnnouncement Banner

GetAnnouncementBanner

organizations.announcement_banner.get() -> AnnouncementBannerGetResponse

POST/gitpod.v1.OrganizationService/GetAnnouncementBanner

UpdateAnnouncementBanner

organizations.announcement_banner.update() -> AnnouncementBannerUpdateResponse

POST/gitpod.v1.OrganizationService/UpdateAnnouncementBanner

ModelsExpand Collapse

class AnnouncementBanner: …

organization_id: str

organization_id is the ID of the organization

formatuuid

enabled: Optional[bool]

enabled controls whether the banner is displayed

message: Optional[str]

message is the banner message displayed to users. Supports basic Markdown.

maxLength1000

class AnnouncementBannerGetResponse: …

message: Optional[str]

message is the banner message displayed to users. Supports basic Markdown.

maxLength1000

class AnnouncementBannerUpdateResponse: …

message: Optional[str]

message is the banner message displayed to users. Supports basic Markdown.

maxLength1000

OrganizationsCustom Domains

CreateCustomDomain

organizations.custom_domains.create() -> CustomDomainCreateResponse

POST/gitpod.v1.OrganizationService/CreateCustomDomain

DeleteCustomDomain

organizations.custom_domains.delete() -> object

POST/gitpod.v1.OrganizationService/DeleteCustomDomain

GetCustomDomain

organizations.custom_domains.retrieve() -> CustomDomainRetrieveResponse

POST/gitpod.v1.OrganizationService/GetCustomDomain

UpdateCustomDomain

organizations.custom_domains.update() -> CustomDomainUpdateResponse

POST/gitpod.v1.OrganizationService/UpdateCustomDomain

ModelsExpand Collapse

class CustomDomain: …

CustomDomain represents a custom domain configuration for an organization

id: str

id is the unique identifier of the custom domain

formatuuid

created_at: datetime

created_at is when the custom domain was created

formatdate-time

domain_name: str

domain_name is the custom domain name

maxLength253

minLength4

organization_id: str

organization_id is the ID of the organization this custom domain belongs to

formatuuid

updated_at: datetime

updated_at is when the custom domain was last updated

formatdate-time

Deprecatedaws_account_id: Optional[str]

aws_account_id is the AWS account ID (deprecated: use cloud_account_id)

cloud_account_id: Optional[str]

cloud_account_id is the unified cloud account identifier (AWS Account ID or GCP Project ID)

provider: Optional[CustomDomainProvider]

provider is the cloud provider for this custom domain

One of the following:

"CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED"

"CUSTOM_DOMAIN_PROVIDER_AWS"

"CUSTOM_DOMAIN_PROVIDER_GCP"

Literal["CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED", "CUSTOM_DOMAIN_PROVIDER_AWS", "CUSTOM_DOMAIN_PROVIDER_GCP"]

CustomDomainProvider represents the cloud provider for custom domain configuration

One of the following:

"CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED"

"CUSTOM_DOMAIN_PROVIDER_AWS"

"CUSTOM_DOMAIN_PROVIDER_GCP"

class CustomDomainCreateResponse: …

CreateCustomDomainResponse is the response message for creating a custom domain

custom_domain: CustomDomain

custom_domain is the created custom domain

id: str

id is the unique identifier of the custom domain

formatuuid

created_at: datetime

created_at is when the custom domain was created

formatdate-time

domain_name: str

domain_name is the custom domain name

maxLength253

minLength4

organization_id: str

organization_id is the ID of the organization this custom domain belongs to

formatuuid

updated_at: datetime

updated_at is when the custom domain was last updated

formatdate-time

Deprecatedaws_account_id: Optional[str]

aws_account_id is the AWS account ID (deprecated: use cloud_account_id)

cloud_account_id: Optional[str]

cloud_account_id is the unified cloud account identifier (AWS Account ID or GCP Project ID)

provider: Optional[CustomDomainProvider]

provider is the cloud provider for this custom domain

One of the following:

"CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED"

"CUSTOM_DOMAIN_PROVIDER_AWS"

"CUSTOM_DOMAIN_PROVIDER_GCP"

class CustomDomainRetrieveResponse: …

custom_domain: CustomDomain

CustomDomain represents a custom domain configuration for an organization

id: str

id is the unique identifier of the custom domain

formatuuid

created_at: datetime

created_at is when the custom domain was created

formatdate-time

domain_name: str

domain_name is the custom domain name

maxLength253

minLength4

organization_id: str

organization_id is the ID of the organization this custom domain belongs to

formatuuid

updated_at: datetime

updated_at is when the custom domain was last updated

formatdate-time

Deprecatedaws_account_id: Optional[str]

aws_account_id is the AWS account ID (deprecated: use cloud_account_id)

cloud_account_id: Optional[str]

cloud_account_id is the unified cloud account identifier (AWS Account ID or GCP Project ID)

provider: Optional[CustomDomainProvider]

provider is the cloud provider for this custom domain

One of the following:

"CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED"

"CUSTOM_DOMAIN_PROVIDER_AWS"

"CUSTOM_DOMAIN_PROVIDER_GCP"

class CustomDomainUpdateResponse: …

UpdateCustomDomainResponse is the response message for updating a custom domain

custom_domain: CustomDomain

custom_domain is the updated custom domain

id: str

id is the unique identifier of the custom domain

formatuuid

created_at: datetime

created_at is when the custom domain was created

formatdate-time

domain_name: str

domain_name is the custom domain name

maxLength253

minLength4

organization_id: str

organization_id is the ID of the organization this custom domain belongs to

formatuuid

updated_at: datetime

updated_at is when the custom domain was last updated

formatdate-time

Deprecatedaws_account_id: Optional[str]

aws_account_id is the AWS account ID (deprecated: use cloud_account_id)

cloud_account_id: Optional[str]

cloud_account_id is the unified cloud account identifier (AWS Account ID or GCP Project ID)

provider: Optional[CustomDomainProvider]

provider is the cloud provider for this custom domain

One of the following:

"CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED"

"CUSTOM_DOMAIN_PROVIDER_AWS"

"CUSTOM_DOMAIN_PROVIDER_GCP"

OrganizationsDomain Verifications

CreateDomainVerification

organizations.domain_verifications.create() -> DomainVerificationCreateResponse

POST/gitpod.v1.OrganizationService/CreateDomainVerification

DeleteDomainVerification

organizations.domain_verifications.delete() -> object

POST/gitpod.v1.OrganizationService/DeleteDomainVerification

ListDomainVerifications

organizations.domain_verifications.list() -> SyncDomainVerificationsPage[DomainVerification]

POST/gitpod.v1.OrganizationService/ListDomainVerifications

GetDomainVerification

organizations.domain_verifications.retrieve() -> DomainVerificationRetrieveResponse

POST/gitpod.v1.OrganizationService/GetDomainVerification

VerifyDomain

organizations.domain_verifications.verify() -> DomainVerificationVerifyResponse

POST/gitpod.v1.OrganizationService/VerifyDomain

ModelsExpand Collapse

class DomainVerification: …

id: str

formatuuid

domain: str

maxLength253

minLength4

organization_id: str

formatuuid

state: DomainVerificationState

One of the following:

"DOMAIN_VERIFICATION_STATE_UNSPECIFIED"

"DOMAIN_VERIFICATION_STATE_PENDING"

"DOMAIN_VERIFICATION_STATE_VERIFIED"

created_at: Optional[datetime]

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

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

formatdate-time

verification_token: Optional[str]

verified_at: Optional[datetime]

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

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

formatdate-time

Literal["DOMAIN_VERIFICATION_STATE_UNSPECIFIED", "DOMAIN_VERIFICATION_STATE_PENDING", "DOMAIN_VERIFICATION_STATE_VERIFIED"]

One of the following:

"DOMAIN_VERIFICATION_STATE_UNSPECIFIED"

"DOMAIN_VERIFICATION_STATE_PENDING"

"DOMAIN_VERIFICATION_STATE_VERIFIED"

class DomainVerificationCreateResponse: …

domain_verification: DomainVerification

id: str

formatuuid

domain: str

maxLength253

minLength4

organization_id: str

formatuuid

state: DomainVerificationState

One of the following:

"DOMAIN_VERIFICATION_STATE_UNSPECIFIED"

"DOMAIN_VERIFICATION_STATE_PENDING"

"DOMAIN_VERIFICATION_STATE_VERIFIED"

created_at: Optional[datetime]

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

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

formatdate-time

verification_token: Optional[str]

verified_at: Optional[datetime]

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

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

formatdate-time

class DomainVerificationRetrieveResponse: …

domain_verification: DomainVerification

id: str

formatuuid

domain: str

maxLength253

minLength4

organization_id: str

formatuuid

state: DomainVerificationState

One of the following:

"DOMAIN_VERIFICATION_STATE_UNSPECIFIED"

"DOMAIN_VERIFICATION_STATE_PENDING"

"DOMAIN_VERIFICATION_STATE_VERIFIED"

created_at: Optional[datetime]

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

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

formatdate-time

verification_token: Optional[str]

verified_at: Optional[datetime]

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

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

formatdate-time

class DomainVerificationVerifyResponse: …

domain_verification: DomainVerification

id: str

formatuuid

domain: str

maxLength253

minLength4

organization_id: str

formatuuid

state: DomainVerificationState

One of the following:

"DOMAIN_VERIFICATION_STATE_UNSPECIFIED"

"DOMAIN_VERIFICATION_STATE_PENDING"

"DOMAIN_VERIFICATION_STATE_VERIFIED"

created_at: Optional[datetime]

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

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

formatdate-time

verification_token: Optional[str]

verified_at: Optional[datetime]

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

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

formatdate-time

OrganizationsInvites

CreateOrganizationInvite

organizations.invites.create() -> InviteCreateResponse

POST/gitpod.v1.OrganizationService/CreateOrganizationInvite

GetOrganizationInviteSummary

organizations.invites.get_summary() -> InviteGetSummaryResponse

POST/gitpod.v1.OrganizationService/GetOrganizationInviteSummary

GetOrganizationInvite

organizations.invites.retrieve() -> InviteRetrieveResponse

POST/gitpod.v1.OrganizationService/GetOrganizationInvite

ModelsExpand Collapse

class OrganizationInvite: …

invite_id: str

invite_id is the unique identifier of the invite to join the organization. Use JoinOrganization with this ID to join the organization.

formatuuid

class InviteCreateResponse: …

invite: OrganizationInvite

invite_id: str

invite_id is the unique identifier of the invite to join the organization. Use JoinOrganization with this ID to join the organization.

formatuuid

class InviteGetSummaryResponse: …

organization_id: str

formatuuid

organization_member_count: Optional[int]

formatint32

organization_name: Optional[str]

class InviteRetrieveResponse: …

invite: OrganizationInvite

invite_id: str

invite_id is the unique identifier of the invite to join the organization. Use JoinOrganization with this ID to join the organization.

formatuuid

OrganizationsPolicies

GetOrganizationPolicies

organizations.policies.retrieve() -> PolicyRetrieveResponse

POST/gitpod.v1.OrganizationService/GetOrganizationPolicies

UpdateOrganizationPolicies

organizations.policies.update() -> object

POST/gitpod.v1.OrganizationService/UpdateOrganizationPolicies

ModelsExpand Collapse

class AgentPolicy: …

AgentPolicy contains agent-specific policy settings for an organization

command_deny_list: List[str]

command_deny_list contains a list of commands that agents are not allowed to execute

mcp_disabled: bool

mcp_disabled controls whether MCP (Model Context Protocol) is disabled for agents

scm_tools_disabled: bool

scm_tools_disabled controls whether SCM (Source Control Management) tools are disabled for agents

conversation_sharing_policy: Optional[ConversationSharingPolicy]

conversation_sharing_policy controls whether agent conversations can be shared

One of the following:

"CONVERSATION_SHARING_POLICY_UNSPECIFIED"

"CONVERSATION_SHARING_POLICY_DISABLED"

"CONVERSATION_SHARING_POLICY_ORGANIZATION"

max_subagents_per_environment: Optional[int]

max_subagents_per_environment limits the number of non-terminal sub-agents a parent can have running simultaneously in the same environment. Valid range: 0-10. Zero means use the default (5).

formatint32

maximum10

scm_tools_allowed_group_id: Optional[str]

scm_tools_allowed_group_id restricts SCM tools access to members of this group. Empty means no restriction (all users can use SCM tools if not disabled).

Literal["CONVERSATION_SHARING_POLICY_UNSPECIFIED", "CONVERSATION_SHARING_POLICY_DISABLED", "CONVERSATION_SHARING_POLICY_ORGANIZATION"]

ConversationSharingPolicy controls how agent conversations can be shared.

One of the following:

"CONVERSATION_SHARING_POLICY_UNSPECIFIED"

"CONVERSATION_SHARING_POLICY_DISABLED"

"CONVERSATION_SHARING_POLICY_ORGANIZATION"

class CrowdStrikeConfig: …

CrowdStrikeConfig configures CrowdStrike Falcon sensor deployment

additional_options: Optional[Dict[str, str]]

additional_options contains additional FALCONCTL_OPT_* options as key-value pairs. Keys should NOT include the FALCONCTL_OPT_ prefix.

cid_secret_id: Optional[str]

cid_secret_id references an organization secret containing the Customer ID (CID).

formatuuid

enabled: Optional[bool]

enabled controls whether CrowdStrike Falcon is deployed to environments

image: Optional[str]

image is the CrowdStrike Falcon sensor container image reference

tags: Optional[str]

tags are optional tags to apply to the Falcon sensor (comma-separated)

class CustomAgentEnvMapping: …

CustomAgentEnvMapping maps a script placeholder to an organization secret. The backend resolves the secret name to a UUID at runtime.

name is the environment variable name used as a placeholder in the start command.

secret_name: Optional[str]

secret_name is the name of the organization secret whose value populates this placeholder.

class CustomSecurityAgent: …

CustomSecurityAgent defines a custom security agent configured by an organization admin.

id: Optional[str]

id is a unique identifier for this custom agent within the organization. Server-generated at save time if empty.

description: Optional[str]

description is a human-readable description of what this agent does

enabled: Optional[bool]

enabled controls whether this custom agent is deployed to environments

env_mappings: Optional[List[CustomAgentEnvMapping]]

env_mappings maps script placeholders to organization secret names, resolved to secret values at runtime.

name is the environment variable name used as a placeholder in the start command.

secret_name: Optional[str]

secret_name is the name of the organization secret whose value populates this placeholder.

name is the display name for this custom agent

start_command: Optional[str]

start_command is the shell script that starts the agent

Literal["KERNEL_CONTROLS_ACTION_UNSPECIFIED", "KERNEL_CONTROLS_ACTION_BLOCK", "KERNEL_CONTROLS_ACTION_AUDIT"]

KernelControlsAction defines how a kernel-level policy violation is handled.

One of the following:

"KERNEL_CONTROLS_ACTION_UNSPECIFIED"

"KERNEL_CONTROLS_ACTION_BLOCK"

"KERNEL_CONTROLS_ACTION_AUDIT"

class OrganizationPolicies: …

agent_policy: AgentPolicy

agent_policy contains agent-specific policy settings

command_deny_list: List[str]

command_deny_list contains a list of commands that agents are not allowed to execute

mcp_disabled: bool

mcp_disabled controls whether MCP (Model Context Protocol) is disabled for agents

scm_tools_disabled: bool

scm_tools_disabled controls whether SCM (Source Control Management) tools are disabled for agents

conversation_sharing_policy: Optional[ConversationSharingPolicy]

conversation_sharing_policy controls whether agent conversations can be shared

One of the following:

"CONVERSATION_SHARING_POLICY_UNSPECIFIED"

"CONVERSATION_SHARING_POLICY_DISABLED"

"CONVERSATION_SHARING_POLICY_ORGANIZATION"

max_subagents_per_environment: Optional[int]

max_subagents_per_environment limits the number of non-terminal sub-agents a parent can have running simultaneously in the same environment. Valid range: 0-10. Zero means use the default (5).

formatint32

maximum10

scm_tools_allowed_group_id: Optional[str]

scm_tools_allowed_group_id restricts SCM tools access to members of this group. Empty means no restriction (all users can use SCM tools if not disabled).

allowed_editor_ids: List[str]

allowed_editor_ids is the list of editor IDs that are allowed to be used in the organization

allow_local_runners: bool

allow_local_runners controls whether local runners are allowed to be used in the organization

default_editor_id: str

default_editor_id is the default editor ID to be used when a user doesn’t specify one

default_environment_image: str

default_environment_image is the default container image when none is defined in repo

maximum_environments_per_user: str

maximum_environments_per_user limits total environments (running or stopped) per user

maximum_running_environments_per_user: str

maximum_running_environments_per_user limits simultaneously running environments per user

members_create_projects: bool

members_create_projects controls whether members can create projects

members_require_projects: bool

members_require_projects controls whether environments can only be created from projects by non-admin users

organization_id: str

organization_id is the ID of the organization

formatuuid

port_sharing_disabled: bool

port_sharing_disabled controls whether user-initiated port sharing is disabled in the organization. System ports (VS Code Browser, agents) are always exempt from this policy.

require_custom_domain_access: bool

require_custom_domain_access controls whether users must access via custom domain when one is configured. When true, access via app.gitpod.io is blocked.

restrict_account_creation_to_scim: bool

restrict_account_creation_to_scim controls whether account creation is restricted to SCIM-provisioned users only. When true and SCIM is configured for the organization, only users provisioned via SCIM can create accounts.

delete_archived_environments_after: Optional[str]

delete_archived_environments_after controls how long archived environments are kept before automatic deletion. 0 means no automatic deletion. Maximum duration is 4 weeks (2419200 seconds).

formatregex

editor_version_restrictions: Optional[Dict[str, EditorVersionRestrictions]]

editor_version_restrictions restricts which editor versions can be used. Maps editor ID to version policy, editor_version_restrictions not set means no restrictions. If empty or not set for an editor, we will use the latest version of the editor

allowed_versions: Optional[List[str]]

allowed_versions lists the versions that are allowed If empty, we will use the latest version of the editor

Examples for JetBrains: ["2025.2", "2025.1", "2024.3"]

maximum_environment_lifetime: Optional[str]

maximum_environment_lifetime controls for how long environments are allowed to be reused. 0 means no maximum lifetime. Maximum duration is 180 days (15552000 seconds).

formatregex

maximum_environment_timeout: Optional[str]

maximum_environment_timeout controls the maximum timeout allowed for environments in seconds. 0 means no limit (never). Minimum duration is 30 minutes (1800 seconds). value must be 0s (no limit) or at least 1800s (30 minutes):

this == duration('0s') || this >= duration('1800s')

formatregex

security_agent_policy: Optional[SecurityAgentPolicy]

security_agent_policy contains security agent configuration for the organization. When configured, security agents are automatically deployed to all environments.

crowdstrike: Optional[CrowdStrikeConfig]

crowdstrike contains CrowdStrike Falcon configuration

additional_options: Optional[Dict[str, str]]

additional_options contains additional FALCONCTL_OPT_* options as key-value pairs. Keys should NOT include the FALCONCTL_OPT_ prefix.

cid_secret_id: Optional[str]

cid_secret_id references an organization secret containing the Customer ID (CID).

formatuuid

enabled: Optional[bool]

enabled controls whether CrowdStrike Falcon is deployed to environments

image: Optional[str]

image is the CrowdStrike Falcon sensor container image reference

tags: Optional[str]

tags are optional tags to apply to the Falcon sensor (comma-separated)

veto_exec_policy: Optional[VetoExecPolicy]

veto_exec_policy contains the veto exec policy for environments.

action: Optional[KernelControlsAction]

action specifies what action kernel-level controls take on policy violations

One of the following:

"KERNEL_CONTROLS_ACTION_UNSPECIFIED"

"KERNEL_CONTROLS_ACTION_BLOCK"

"KERNEL_CONTROLS_ACTION_AUDIT"

enabled: Optional[bool]

enabled controls whether executable blocking is active

executables: Optional[List[str]]

executables is the list of executable paths or names to block

class SecurityAgentPolicy: …

SecurityAgentPolicy contains security agent configuration for an organization. When enabled, security agents are automatically deployed to all environments.

crowdstrike: Optional[CrowdStrikeConfig]

crowdstrike contains CrowdStrike Falcon configuration

additional_options: Optional[Dict[str, str]]

additional_options contains additional FALCONCTL_OPT_* options as key-value pairs. Keys should NOT include the FALCONCTL_OPT_ prefix.

cid_secret_id: Optional[str]

cid_secret_id references an organization secret containing the Customer ID (CID).

formatuuid

enabled: Optional[bool]

enabled controls whether CrowdStrike Falcon is deployed to environments

image: Optional[str]

image is the CrowdStrike Falcon sensor container image reference

tags: Optional[str]

tags are optional tags to apply to the Falcon sensor (comma-separated)

class VetoExecPolicy: …

VetoExecPolicy defines the policy for blocking or auditing executable execution in environments.

action: Optional[KernelControlsAction]

action specifies what action kernel-level controls take on policy violations

One of the following:

"KERNEL_CONTROLS_ACTION_UNSPECIFIED"

"KERNEL_CONTROLS_ACTION_BLOCK"

"KERNEL_CONTROLS_ACTION_AUDIT"

enabled: Optional[bool]

enabled controls whether executable blocking is active

executables: Optional[List[str]]

executables is the list of executable paths or names to block

class PolicyRetrieveResponse: …

policies: OrganizationPolicies

agent_policy: AgentPolicy

agent_policy contains agent-specific policy settings

command_deny_list: List[str]

command_deny_list contains a list of commands that agents are not allowed to execute

mcp_disabled: bool

mcp_disabled controls whether MCP (Model Context Protocol) is disabled for agents

scm_tools_disabled: bool

scm_tools_disabled controls whether SCM (Source Control Management) tools are disabled for agents

conversation_sharing_policy: Optional[ConversationSharingPolicy]

conversation_sharing_policy controls whether agent conversations can be shared

One of the following:

"CONVERSATION_SHARING_POLICY_UNSPECIFIED"

"CONVERSATION_SHARING_POLICY_DISABLED"

"CONVERSATION_SHARING_POLICY_ORGANIZATION"

max_subagents_per_environment: Optional[int]

max_subagents_per_environment limits the number of non-terminal sub-agents a parent can have running simultaneously in the same environment. Valid range: 0-10. Zero means use the default (5).

formatint32

maximum10

scm_tools_allowed_group_id: Optional[str]

scm_tools_allowed_group_id restricts SCM tools access to members of this group. Empty means no restriction (all users can use SCM tools if not disabled).

allowed_editor_ids: List[str]

allowed_editor_ids is the list of editor IDs that are allowed to be used in the organization

allow_local_runners: bool

allow_local_runners controls whether local runners are allowed to be used in the organization

default_editor_id: str

default_editor_id is the default editor ID to be used when a user doesn’t specify one

default_environment_image: str

default_environment_image is the default container image when none is defined in repo

maximum_environments_per_user: str

maximum_environments_per_user limits total environments (running or stopped) per user

maximum_running_environments_per_user: str

maximum_running_environments_per_user limits simultaneously running environments per user

members_create_projects: bool

members_create_projects controls whether members can create projects

members_require_projects: bool

members_require_projects controls whether environments can only be created from projects by non-admin users

organization_id: str

organization_id is the ID of the organization

formatuuid

port_sharing_disabled: bool

port_sharing_disabled controls whether user-initiated port sharing is disabled in the organization. System ports (VS Code Browser, agents) are always exempt from this policy.

require_custom_domain_access: bool

require_custom_domain_access controls whether users must access via custom domain when one is configured. When true, access via app.gitpod.io is blocked.

restrict_account_creation_to_scim: bool

delete_archived_environments_after: Optional[str]

delete_archived_environments_after controls how long archived environments are kept before automatic deletion. 0 means no automatic deletion. Maximum duration is 4 weeks (2419200 seconds).

formatregex

editor_version_restrictions: Optional[Dict[str, EditorVersionRestrictions]]

allowed_versions: Optional[List[str]]

allowed_versions lists the versions that are allowed If empty, we will use the latest version of the editor

Examples for JetBrains: ["2025.2", "2025.1", "2024.3"]

maximum_environment_lifetime: Optional[str]

maximum_environment_lifetime controls for how long environments are allowed to be reused. 0 means no maximum lifetime. Maximum duration is 180 days (15552000 seconds).

formatregex

maximum_environment_timeout: Optional[str]

this == duration('0s') || this >= duration('1800s')

formatregex

security_agent_policy: Optional[SecurityAgentPolicy]

security_agent_policy contains security agent configuration for the organization. When configured, security agents are automatically deployed to all environments.

crowdstrike: Optional[CrowdStrikeConfig]

crowdstrike contains CrowdStrike Falcon configuration

additional_options: Optional[Dict[str, str]]

additional_options contains additional FALCONCTL_OPT_* options as key-value pairs. Keys should NOT include the FALCONCTL_OPT_ prefix.

cid_secret_id: Optional[str]

cid_secret_id references an organization secret containing the Customer ID (CID).

formatuuid

enabled: Optional[bool]

enabled controls whether CrowdStrike Falcon is deployed to environments

image: Optional[str]

image is the CrowdStrike Falcon sensor container image reference

tags: Optional[str]

tags are optional tags to apply to the Falcon sensor (comma-separated)

veto_exec_policy: Optional[VetoExecPolicy]

veto_exec_policy contains the veto exec policy for environments.

action: Optional[KernelControlsAction]

action specifies what action kernel-level controls take on policy violations

One of the following:

"KERNEL_CONTROLS_ACTION_UNSPECIFIED"

"KERNEL_CONTROLS_ACTION_BLOCK"

"KERNEL_CONTROLS_ACTION_AUDIT"

enabled: Optional[bool]

enabled controls whether executable blocking is active

executables: Optional[List[str]]

executables is the list of executable paths or names to block

OrganizationsScim Configurations

CreateSCIMConfiguration

organizations.scim_configurations.create() -> ScimConfigurationCreateResponse

POST/gitpod.v1.OrganizationService/CreateSCIMConfiguration

DeleteSCIMConfiguration

organizations.scim_configurations.delete() -> object

POST/gitpod.v1.OrganizationService/DeleteSCIMConfiguration

ListSCIMConfigurations

organizations.scim_configurations.list() -> SyncScimConfigurationsPage[ScimConfiguration]

POST/gitpod.v1.OrganizationService/ListSCIMConfigurations

RegenerateSCIMToken

organizations.scim_configurations.regenerate_token() -> ScimConfigurationRegenerateTokenResponse

POST/gitpod.v1.OrganizationService/RegenerateSCIMToken

GetSCIMConfiguration

organizations.scim_configurations.retrieve() -> ScimConfigurationRetrieveResponse

POST/gitpod.v1.OrganizationService/GetSCIMConfiguration

UpdateSCIMConfiguration

organizations.scim_configurations.update() -> ScimConfigurationUpdateResponse

POST/gitpod.v1.OrganizationService/UpdateSCIMConfiguration

ModelsExpand Collapse

class ScimConfiguration: …

SCIMConfiguration represents a SCIM 2.0 provisioning configuration

id: str

id is the unique identifier of the SCIM configuration

formatuuid

created_at: datetime

created_at is when the SCIM configuration was created

formatdate-time

organization_id: str

organization_id is the ID of the organization this SCIM configuration belongs to

formatuuid

token_expires_at: datetime

token_expires_at is when the current SCIM token expires

formatdate-time

updated_at: datetime

updated_at is when the SCIM configuration was last updated

formatdate-time

enabled: Optional[bool]

enabled indicates if SCIM provisioning is active

name is a human-readable name for the SCIM configuration

maxLength128

sso_configuration_id: Optional[str]

sso_configuration_id is the linked SSO configuration (optional)

formatuuid

class ScimConfigurationCreateResponse: …

token: str

token is the bearer token for SCIM API authentication. This is only returned once during creation - store it securely.

scim_configuration: ScimConfiguration

scim_configuration is the created SCIM configuration

id: str

id is the unique identifier of the SCIM configuration

formatuuid

created_at: datetime

created_at is when the SCIM configuration was created

formatdate-time

organization_id: str

organization_id is the ID of the organization this SCIM configuration belongs to

formatuuid

token_expires_at: datetime

token_expires_at is when the current SCIM token expires

formatdate-time

updated_at: datetime

updated_at is when the SCIM configuration was last updated

formatdate-time

enabled: Optional[bool]

enabled indicates if SCIM provisioning is active

name is a human-readable name for the SCIM configuration

maxLength128

sso_configuration_id: Optional[str]

sso_configuration_id is the linked SSO configuration (optional)

formatuuid

token_expires_at: datetime

token_expires_at is when the token will expire

formatdate-time

class ScimConfigurationRegenerateTokenResponse: …

token: str

token is the new bearer token for SCIM API authentication. This invalidates the previous token - store it securely.

token_expires_at: datetime

token_expires_at is when the new token will expire

formatdate-time

class ScimConfigurationRetrieveResponse: …

scim_configuration: ScimConfiguration

scim_configuration is the SCIM configuration identified by the ID

id: str

id is the unique identifier of the SCIM configuration

formatuuid

created_at: datetime

created_at is when the SCIM configuration was created

formatdate-time

organization_id: str

organization_id is the ID of the organization this SCIM configuration belongs to

formatuuid

token_expires_at: datetime

token_expires_at is when the current SCIM token expires

formatdate-time

updated_at: datetime

updated_at is when the SCIM configuration was last updated

formatdate-time

enabled: Optional[bool]

enabled indicates if SCIM provisioning is active

name is a human-readable name for the SCIM configuration

maxLength128

sso_configuration_id: Optional[str]

sso_configuration_id is the linked SSO configuration (optional)

formatuuid

class ScimConfigurationUpdateResponse: …

scim_configuration: ScimConfiguration

scim_configuration is the updated SCIM configuration

id: str

id is the unique identifier of the SCIM configuration

formatuuid

created_at: datetime

created_at is when the SCIM configuration was created

formatdate-time

organization_id: str

organization_id is the ID of the organization this SCIM configuration belongs to

formatuuid

token_expires_at: datetime

token_expires_at is when the current SCIM token expires

formatdate-time

updated_at: datetime

updated_at is when the SCIM configuration was last updated

formatdate-time

enabled: Optional[bool]

enabled indicates if SCIM provisioning is active

name is a human-readable name for the SCIM configuration

maxLength128

sso_configuration_id: Optional[str]

sso_configuration_id is the linked SSO configuration (optional)

formatuuid

OrganizationsSSO Configurations

CreateSSOConfiguration

organizations.sso_configurations.create() -> SSOConfigurationCreateResponse

POST/gitpod.v1.OrganizationService/CreateSSOConfiguration

DeleteSSOConfiguration

organizations.sso_configurations.delete() -> object

POST/gitpod.v1.OrganizationService/DeleteSSOConfiguration

ListSSOConfigurations

organizations.sso_configurations.list() -> SyncSSOConfigurationsPage[SSOConfiguration]

POST/gitpod.v1.OrganizationService/ListSSOConfigurations

GetSSOConfiguration

organizations.sso_configurations.retrieve() -> SSOConfigurationRetrieveResponse

POST/gitpod.v1.OrganizationService/GetSSOConfiguration

UpdateSSOConfiguration

organizations.sso_configurations.update() -> object

POST/gitpod.v1.OrganizationService/UpdateSSOConfiguration

ModelsExpand Collapse

class AdditionalScopesUpdate: …

AdditionalScopesUpdate wraps a list of OIDC scopes so that the update request can distinguish “not changing scopes” (field absent) from “clearing all scopes” (field present, empty list).

scopes: Optional[List[str]]

Literal["PROVIDER_TYPE_UNSPECIFIED", "PROVIDER_TYPE_BUILTIN", "PROVIDER_TYPE_CUSTOM"]

One of the following:

"PROVIDER_TYPE_UNSPECIFIED"

"PROVIDER_TYPE_BUILTIN"

"PROVIDER_TYPE_CUSTOM"

class SSOConfiguration: …

id: str

id is the unique identifier of the SSO configuration

formatuuid

issuer_url: str

issuer_url is the URL of the IdP issuer

organization_id: str

formatuuid

provider_type: ProviderType

provider_type defines the type of the SSO configuration

One of the following:

"PROVIDER_TYPE_UNSPECIFIED"

"PROVIDER_TYPE_BUILTIN"

"PROVIDER_TYPE_CUSTOM"

state: SSOConfigurationState

state is the state of the SSO configuration

One of the following:

"SSO_CONFIGURATION_STATE_UNSPECIFIED"

"SSO_CONFIGURATION_STATE_INACTIVE"

"SSO_CONFIGURATION_STATE_ACTIVE"

additional_scopes: Optional[List[str]]

additional_scopes are extra OIDC scopes requested from the identity provider during sign-in.

claims: Optional[Dict[str, str]]

claims are key/value pairs that defines a mapping of claims issued by the IdP.

claims_expression: Optional[str]

claims_expression is a CEL (Common Expression Language) expression evaluated against the OIDC token claims during login. When set, the expression must evaluate to true for the login to succeed. The expression has access to a claims variable containing all token claims as a map. Example: claims.email_verified && claims.email.endsWith("@example.com")

maxLength4096

client_id: Optional[str]

client_id is the client ID of the OIDC application set on the IdP

display_name: Optional[str]

maxLength128

email_domain: Optional[str]

email_domains: Optional[List[str]]

Literal["SSO_CONFIGURATION_STATE_UNSPECIFIED", "SSO_CONFIGURATION_STATE_INACTIVE", "SSO_CONFIGURATION_STATE_ACTIVE"]

One of the following:

"SSO_CONFIGURATION_STATE_UNSPECIFIED"

"SSO_CONFIGURATION_STATE_INACTIVE"

"SSO_CONFIGURATION_STATE_ACTIVE"

class SSOConfigurationCreateResponse: …

sso_configuration: SSOConfiguration

sso_configuration is the created SSO configuration

id: str

id is the unique identifier of the SSO configuration

formatuuid

issuer_url: str

issuer_url is the URL of the IdP issuer

organization_id: str

formatuuid

provider_type: ProviderType

provider_type defines the type of the SSO configuration

One of the following:

"PROVIDER_TYPE_UNSPECIFIED"

"PROVIDER_TYPE_BUILTIN"

"PROVIDER_TYPE_CUSTOM"

state: SSOConfigurationState

state is the state of the SSO configuration

One of the following:

"SSO_CONFIGURATION_STATE_UNSPECIFIED"

"SSO_CONFIGURATION_STATE_INACTIVE"

"SSO_CONFIGURATION_STATE_ACTIVE"

additional_scopes: Optional[List[str]]

additional_scopes are extra OIDC scopes requested from the identity provider during sign-in.

claims: Optional[Dict[str, str]]

claims are key/value pairs that defines a mapping of claims issued by the IdP.

claims_expression: Optional[str]

maxLength4096

client_id: Optional[str]

client_id is the client ID of the OIDC application set on the IdP

display_name: Optional[str]

maxLength128

email_domain: Optional[str]

email_domains: Optional[List[str]]

class SSOConfigurationRetrieveResponse: …

sso_configuration: SSOConfiguration

sso_configuration is the SSO configuration identified by the ID

id: str

id is the unique identifier of the SSO configuration

formatuuid

issuer_url: str

issuer_url is the URL of the IdP issuer

organization_id: str

formatuuid

provider_type: ProviderType

provider_type defines the type of the SSO configuration

One of the following:

"PROVIDER_TYPE_UNSPECIFIED"

"PROVIDER_TYPE_BUILTIN"

"PROVIDER_TYPE_CUSTOM"

state: SSOConfigurationState

state is the state of the SSO configuration

One of the following:

"SSO_CONFIGURATION_STATE_UNSPECIFIED"

"SSO_CONFIGURATION_STATE_INACTIVE"

"SSO_CONFIGURATION_STATE_ACTIVE"

additional_scopes: Optional[List[str]]

additional_scopes are extra OIDC scopes requested from the identity provider during sign-in.

claims: Optional[Dict[str, str]]

claims are key/value pairs that defines a mapping of claims issued by the IdP.

claims_expression: Optional[str]

maxLength4096

client_id: Optional[str]

client_id is the client ID of the OIDC application set on the IdP

display_name: Optional[str]

maxLength128

email_domain: Optional[str]

email_domains: Optional[List[str]]