@gitpod/sdk
Version:
Public TypeScript SDK for Ona.
1,408 lines (1,407 loc) • 169 kB
TypeScript
import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
import type { CodexOpenAIModel, CodexReasoningEffort, CodexServiceTier } from "./agent_pb";
import type { CountRequest, CountResponse } from "./count_pb";
import type { AdmissionLevel, KernelControlsAction, VetoFileBlockDevicesPolicy, VetoFilePathPolicy } from "./environment_pb";
import type { LoginProviderKind } from "./login_provider_pb";
import type { PaginationRequest, PaginationResponse, SortOrder } from "./pagination_pb";
import type { UserStatus } from "./user_pb";
import type { Duration, Timestamp } from "@bufbuild/protobuf/wkt";
import type { Message } from "@bufbuild/protobuf";
/**
* Describes the file gitpod/v1/organization.proto.
*/
export declare const file_gitpod_v1_organization: GenFile;
/**
* @generated from message gitpod.v1.UpdateOrganizationRequest
*/
export type UpdateOrganizationRequest = Message<"gitpod.v1.UpdateOrganizationRequest"> & {
/**
* organization_id is the ID of the organization to update the settings for.
*
* @generated from field: string organization_id = 1;
*/
organizationId: string;
/**
* name is the new name of the organization
*
* @generated from field: optional string name = 2;
*/
name?: string;
/**
* invite_domains is the domain allowlist of the organization
*
* @generated from field: optional gitpod.v1.InviteDomains invite_domains = 3;
*/
inviteDomains?: InviteDomains;
};
/**
* Describes the message gitpod.v1.UpdateOrganizationRequest.
* Use `create(UpdateOrganizationRequestSchema)` to create a new message.
*/
export declare const UpdateOrganizationRequestSchema: GenMessage<UpdateOrganizationRequest>;
/**
* @generated from message gitpod.v1.UpdateOrganizationResponse
*/
export type UpdateOrganizationResponse = Message<"gitpod.v1.UpdateOrganizationResponse"> & {
/**
* organization is the updated organization
*
* @generated from field: gitpod.v1.Organization organization = 1;
*/
organization?: Organization;
};
/**
* Describes the message gitpod.v1.UpdateOrganizationResponse.
* Use `create(UpdateOrganizationResponseSchema)` to create a new message.
*/
export declare const UpdateOrganizationResponseSchema: GenMessage<UpdateOrganizationResponse>;
/**
* @generated from message gitpod.v1.CreateOrganizationRequest
*/
export type CreateOrganizationRequest = Message<"gitpod.v1.CreateOrganizationRequest"> & {
/**
* name is the organization name
*
* @generated from field: string name = 1;
*/
name: string;
/**
* join_organization decides whether the Identity issuing this request joins the org on creation
*
* @generated from field: bool join_organization = 2;
*/
joinOrganization: boolean;
/**
* Should other Accounts with the same domain be automatically invited to the organization?
*
* @generated from field: bool invite_accounts_with_matching_domain = 3;
*/
inviteAccountsWithMatchingDomain: boolean;
};
/**
* Describes the message gitpod.v1.CreateOrganizationRequest.
* Use `create(CreateOrganizationRequestSchema)` to create a new message.
*/
export declare const CreateOrganizationRequestSchema: GenMessage<CreateOrganizationRequest>;
/**
* @generated from message gitpod.v1.CreateOrganizationResponse
*/
export type CreateOrganizationResponse = Message<"gitpod.v1.CreateOrganizationResponse"> & {
/**
* organization is the created organization
*
* @generated from field: gitpod.v1.Organization organization = 1;
*/
organization?: Organization;
/**
* member is the member that joined the org on creation. Only set if specified "join_organization" is "true" in the request.
*
* @generated from field: gitpod.v1.OrganizationMember member = 2;
*/
member?: OrganizationMember;
};
/**
* Describes the message gitpod.v1.CreateOrganizationResponse.
* Use `create(CreateOrganizationResponseSchema)` to create a new message.
*/
export declare const CreateOrganizationResponseSchema: GenMessage<CreateOrganizationResponse>;
/**
* @generated from message gitpod.v1.JoinOrganizationRequest
*/
export type JoinOrganizationRequest = Message<"gitpod.v1.JoinOrganizationRequest"> & {
/**
* @generated from oneof gitpod.v1.JoinOrganizationRequest.join_id
*/
joinId: {
/**
* organization_id is the unique identifier of the Organization to join.
*
* @generated from field: string organization_id = 1;
*/
value: string;
case: "organizationId";
} | {
/**
* invite_id is the unique identifier of the invite to join the organization.
*
* @generated from field: string invite_id = 2;
*/
value: string;
case: "inviteId";
} | {
case: undefined;
value?: undefined;
};
};
/**
* Describes the message gitpod.v1.JoinOrganizationRequest.
* Use `create(JoinOrganizationRequestSchema)` to create a new message.
*/
export declare const JoinOrganizationRequestSchema: GenMessage<JoinOrganizationRequest>;
/**
* @generated from message gitpod.v1.JoinOrganizationResponse
*/
export type JoinOrganizationResponse = Message<"gitpod.v1.JoinOrganizationResponse"> & {
/**
* member is the member that was created by joining the organization.
*
* @generated from field: gitpod.v1.OrganizationMember member = 1;
*/
member?: OrganizationMember;
};
/**
* Describes the message gitpod.v1.JoinOrganizationResponse.
* Use `create(JoinOrganizationResponseSchema)` to create a new message.
*/
export declare const JoinOrganizationResponseSchema: GenMessage<JoinOrganizationResponse>;
/**
* @generated from message gitpod.v1.LeaveOrganizationRequest
*/
export type LeaveOrganizationRequest = Message<"gitpod.v1.LeaveOrganizationRequest"> & {
/**
* @generated from field: string user_id = 1;
*/
userId: string;
};
/**
* Describes the message gitpod.v1.LeaveOrganizationRequest.
* Use `create(LeaveOrganizationRequestSchema)` to create a new message.
*/
export declare const LeaveOrganizationRequestSchema: GenMessage<LeaveOrganizationRequest>;
/**
* @generated from message gitpod.v1.LeaveOrganizationResponse
*/
export type LeaveOrganizationResponse = Message<"gitpod.v1.LeaveOrganizationResponse"> & {};
/**
* Describes the message gitpod.v1.LeaveOrganizationResponse.
* Use `create(LeaveOrganizationResponseSchema)` to create a new message.
*/
export declare const LeaveOrganizationResponseSchema: GenMessage<LeaveOrganizationResponse>;
/**
* @generated from message gitpod.v1.GetOrganizationRequest
*/
export type GetOrganizationRequest = Message<"gitpod.v1.GetOrganizationRequest"> & {
/**
* organization_id is the unique identifier of the Organization to retreive.
*
* @generated from field: string organization_id = 1;
*/
organizationId: string;
};
/**
* Describes the message gitpod.v1.GetOrganizationRequest.
* Use `create(GetOrganizationRequestSchema)` to create a new message.
*/
export declare const GetOrganizationRequestSchema: GenMessage<GetOrganizationRequest>;
/**
* @generated from message gitpod.v1.GetOrganizationResponse
*/
export type GetOrganizationResponse = Message<"gitpod.v1.GetOrganizationResponse"> & {
/**
* organization is the requested organization
*
* @generated from field: gitpod.v1.Organization organization = 1;
*/
organization?: Organization;
};
/**
* Describes the message gitpod.v1.GetOrganizationResponse.
* Use `create(GetOrganizationResponseSchema)` to create a new message.
*/
export declare const GetOrganizationResponseSchema: GenMessage<GetOrganizationResponse>;
/**
* @generated from message gitpod.v1.DeleteOrganizationRequest
*/
export type DeleteOrganizationRequest = Message<"gitpod.v1.DeleteOrganizationRequest"> & {
/**
* organization_id is the ID of the organization to delete
*
* @generated from field: string organization_id = 1;
*/
organizationId: string;
};
/**
* Describes the message gitpod.v1.DeleteOrganizationRequest.
* Use `create(DeleteOrganizationRequestSchema)` to create a new message.
*/
export declare const DeleteOrganizationRequestSchema: GenMessage<DeleteOrganizationRequest>;
/**
* @generated from message gitpod.v1.DeleteOrganizationResponse
*/
export type DeleteOrganizationResponse = Message<"gitpod.v1.DeleteOrganizationResponse"> & {};
/**
* Describes the message gitpod.v1.DeleteOrganizationResponse.
* Use `create(DeleteOrganizationResponseSchema)` to create a new message.
*/
export declare const DeleteOrganizationResponseSchema: GenMessage<DeleteOrganizationResponse>;
/**
* @generated from message gitpod.v1.ListMembersRequest
*/
export type ListMembersRequest = Message<"gitpod.v1.ListMembersRequest"> & {
/**
* pagination contains the pagination options for listing members
*
* @generated from field: gitpod.v1.PaginationRequest pagination = 1;
*/
pagination?: PaginationRequest;
/**
* organization_id is the ID of the organization to list members for
*
* @generated from field: string organization_id = 2;
*/
organizationId: string;
/**
* @generated from field: gitpod.v1.ListMembersRequest.Filter filter = 3;
*/
filter?: ListMembersRequest_Filter;
/**
* sort specifies the order of results. When unspecified, the authenticated user is
* returned first, followed by other members sorted by name ascending. When an explicit
* sort is specified, results are sorted purely by the requested field without any
* special handling for the authenticated user.
*
* @generated from field: gitpod.v1.ListMembersRequest.Sort sort = 4;
*/
sort?: ListMembersRequest_Sort;
/**
* count controls whether the response includes a bounded total count.
*
* @generated from field: gitpod.v1.CountRequest count = 5;
*/
count?: CountRequest;
};
/**
* Describes the message gitpod.v1.ListMembersRequest.
* Use `create(ListMembersRequestSchema)` to create a new message.
*/
export declare const ListMembersRequestSchema: GenMessage<ListMembersRequest>;
/**
* @generated from message gitpod.v1.ListMembersRequest.Filter
*/
export type ListMembersRequest_Filter = Message<"gitpod.v1.ListMembersRequest.Filter"> & {
/**
* search performs case-insensitive search across member name and email
*
* @generated from field: string search = 1;
*/
search: string;
/**
* status filters members by their user status
*
* @generated from field: repeated gitpod.v1.UserStatus statuses = 2;
*/
statuses: UserStatus[];
/**
* roles filters members by their organization role
*
* @generated from field: repeated gitpod.v1.OrganizationRole roles = 3;
*/
roles: OrganizationRole[];
/**
* user_ids filters the response to only members with the specified user IDs
*
* @generated from field: repeated string user_ids = 4;
*/
userIds: string[];
/**
* exclude_group_ids excludes members who are already in any of the specified groups
*
* @generated from field: repeated string exclude_group_ids = 5;
*/
excludeGroupIds: string[];
/**
* exclude_members_in_any_team excludes members who belong to any team in the organization
*
* @generated from field: bool exclude_members_in_any_team = 6;
*/
excludeMembersInAnyTeam: boolean;
/**
* email filters members by exact email address, matched case-insensitively
*
* @generated from field: string email = 7;
*/
email: string;
/**
* login_provider filters members by the exact provider they use to sign in
*
* @generated from field: gitpod.v1.LoginProviderKind login_provider = 8;
*/
loginProvider: LoginProviderKind;
};
/**
* Describes the message gitpod.v1.ListMembersRequest.Filter.
* Use `create(ListMembersRequest_FilterSchema)` to create a new message.
*/
export declare const ListMembersRequest_FilterSchema: GenMessage<ListMembersRequest_Filter>;
/**
* @generated from message gitpod.v1.ListMembersRequest.Sort
*/
export type ListMembersRequest_Sort = Message<"gitpod.v1.ListMembersRequest.Sort"> & {
/**
* @generated from field: gitpod.v1.ListMembersRequest.SortField field = 1;
*/
field: ListMembersRequest_SortField;
/**
* @generated from field: gitpod.v1.SortOrder order = 2;
*/
order: SortOrder;
};
/**
* Describes the message gitpod.v1.ListMembersRequest.Sort.
* Use `create(ListMembersRequest_SortSchema)` to create a new message.
*/
export declare const ListMembersRequest_SortSchema: GenMessage<ListMembersRequest_Sort>;
/**
* @generated from enum gitpod.v1.ListMembersRequest.SortField
*/
export declare enum ListMembersRequest_SortField {
/**
* @generated from enum value: SORT_FIELD_UNSPECIFIED = 0;
*/
UNSPECIFIED = 0,
/**
* Sort by member's display name
*
* @generated from enum value: SORT_FIELD_NAME = 1;
*/
NAME = 1,
/**
* Sort by the date the member joined the organization
*
* @generated from enum value: SORT_FIELD_DATE_JOINED = 2;
*/
DATE_JOINED = 2
}
/**
* Describes the enum gitpod.v1.ListMembersRequest.SortField.
*/
export declare const ListMembersRequest_SortFieldSchema: GenEnum<ListMembersRequest_SortField>;
/**
* @generated from message gitpod.v1.ListMembersResponse
*/
export type ListMembersResponse = Message<"gitpod.v1.ListMembersResponse"> & {
/**
* pagination contains the pagination options for listing members
*
* @generated from field: gitpod.v1.PaginationResponse pagination = 1;
*/
pagination?: PaginationResponse;
/**
* members are the members of the organization
*
* @generated from field: repeated gitpod.v1.OrganizationMember members = 2;
*/
members: OrganizationMember[];
/**
* count is the bounded total count of matching members, present only when
* requested via CountRequest.include on the first page.
*
* @generated from field: gitpod.v1.CountResponse count = 3;
*/
count?: CountResponse;
};
/**
* Describes the message gitpod.v1.ListMembersResponse.
* Use `create(ListMembersResponseSchema)` to create a new message.
*/
export declare const ListMembersResponseSchema: GenMessage<ListMembersResponse>;
/**
* @generated from message gitpod.v1.SetRoleRequest
*/
export type SetRoleRequest = Message<"gitpod.v1.SetRoleRequest"> & {
/**
* @generated from field: string organization_id = 1;
*/
organizationId: string;
/**
* @generated from field: string user_id = 2;
*/
userId: string;
/**
* @generated from field: gitpod.v1.OrganizationRole role = 3;
*/
role: OrganizationRole;
};
/**
* Describes the message gitpod.v1.SetRoleRequest.
* Use `create(SetRoleRequestSchema)` to create a new message.
*/
export declare const SetRoleRequestSchema: GenMessage<SetRoleRequest>;
/**
* @generated from message gitpod.v1.SetRoleResponse
*/
export type SetRoleResponse = Message<"gitpod.v1.SetRoleResponse"> & {};
/**
* Describes the message gitpod.v1.SetRoleResponse.
* Use `create(SetRoleResponseSchema)` to create a new message.
*/
export declare const SetRoleResponseSchema: GenMessage<SetRoleResponse>;
/**
* @generated from message gitpod.v1.GetOrganizationInviteRequest
*/
export type GetOrganizationInviteRequest = Message<"gitpod.v1.GetOrganizationInviteRequest"> & {
/**
* @generated from field: string organization_id = 1;
*/
organizationId: string;
};
/**
* Describes the message gitpod.v1.GetOrganizationInviteRequest.
* Use `create(GetOrganizationInviteRequestSchema)` to create a new message.
*/
export declare const GetOrganizationInviteRequestSchema: GenMessage<GetOrganizationInviteRequest>;
/**
* @generated from message gitpod.v1.GetOrganizationInviteResponse
*/
export type GetOrganizationInviteResponse = Message<"gitpod.v1.GetOrganizationInviteResponse"> & {
/**
* @generated from field: gitpod.v1.OrganizationInvite invite = 1;
*/
invite?: OrganizationInvite;
};
/**
* Describes the message gitpod.v1.GetOrganizationInviteResponse.
* Use `create(GetOrganizationInviteResponseSchema)` to create a new message.
*/
export declare const GetOrganizationInviteResponseSchema: GenMessage<GetOrganizationInviteResponse>;
/**
* @generated from message gitpod.v1.OrganizationInvite
*/
export type OrganizationInvite = Message<"gitpod.v1.OrganizationInvite"> & {
/**
* invite_id is the unique identifier of the invite to join the organization.
* Use JoinOrganization with this ID to join the organization.
*
* @generated from field: string invite_id = 1;
*/
inviteId: string;
};
/**
* Describes the message gitpod.v1.OrganizationInvite.
* Use `create(OrganizationInviteSchema)` to create a new message.
*/
export declare const OrganizationInviteSchema: GenMessage<OrganizationInvite>;
/**
* @generated from message gitpod.v1.CreateOrganizationInviteRequest
*/
export type CreateOrganizationInviteRequest = Message<"gitpod.v1.CreateOrganizationInviteRequest"> & {
/**
* @generated from field: string organization_id = 1;
*/
organizationId: string;
};
/**
* Describes the message gitpod.v1.CreateOrganizationInviteRequest.
* Use `create(CreateOrganizationInviteRequestSchema)` to create a new message.
*/
export declare const CreateOrganizationInviteRequestSchema: GenMessage<CreateOrganizationInviteRequest>;
/**
* @generated from message gitpod.v1.CreateOrganizationInviteResponse
*/
export type CreateOrganizationInviteResponse = Message<"gitpod.v1.CreateOrganizationInviteResponse"> & {
/**
* @generated from field: gitpod.v1.OrganizationInvite invite = 1;
*/
invite?: OrganizationInvite;
};
/**
* Describes the message gitpod.v1.CreateOrganizationInviteResponse.
* Use `create(CreateOrganizationInviteResponseSchema)` to create a new message.
*/
export declare const CreateOrganizationInviteResponseSchema: GenMessage<CreateOrganizationInviteResponse>;
/**
* @generated from message gitpod.v1.GetOrganizationInviteSummaryRequest
*/
export type GetOrganizationInviteSummaryRequest = Message<"gitpod.v1.GetOrganizationInviteSummaryRequest"> & {
/**
* @generated from field: string invite_id = 1;
*/
inviteId: string;
};
/**
* Describes the message gitpod.v1.GetOrganizationInviteSummaryRequest.
* Use `create(GetOrganizationInviteSummaryRequestSchema)` to create a new message.
*/
export declare const GetOrganizationInviteSummaryRequestSchema: GenMessage<GetOrganizationInviteSummaryRequest>;
/**
* @generated from message gitpod.v1.GetOrganizationInviteSummaryResponse
*/
export type GetOrganizationInviteSummaryResponse = Message<"gitpod.v1.GetOrganizationInviteSummaryResponse"> & {
/**
* @generated from field: string organization_id = 1;
*/
organizationId: string;
/**
* @generated from field: string organization_name = 2;
*/
organizationName: string;
/**
* @generated from field: int32 organization_member_count = 3;
*/
organizationMemberCount: number;
};
/**
* Describes the message gitpod.v1.GetOrganizationInviteSummaryResponse.
* Use `create(GetOrganizationInviteSummaryResponseSchema)` to create a new message.
*/
export declare const GetOrganizationInviteSummaryResponseSchema: GenMessage<GetOrganizationInviteSummaryResponse>;
/**
* @generated from message gitpod.v1.Organization
*/
export type Organization = Message<"gitpod.v1.Organization"> & {
/**
* @generated from field: string id = 1;
*/
id: string;
/**
* @generated from field: string name = 2;
*/
name: string;
/**
* @generated from field: google.protobuf.Timestamp created_at = 3;
*/
createdAt?: Timestamp;
/**
* @generated from field: google.protobuf.Timestamp updated_at = 4;
*/
updatedAt?: Timestamp;
/**
* @generated from field: gitpod.v1.InviteDomains invite_domains = 5;
*/
inviteDomains?: InviteDomains;
/**
* The tier of the organization - free, enterprise or core
*
* @generated from field: gitpod.v1.OrganizationTier tier = 6;
*/
tier: OrganizationTier;
};
/**
* Describes the message gitpod.v1.Organization.
* Use `create(OrganizationSchema)` to create a new message.
*/
export declare const OrganizationSchema: GenMessage<Organization>;
/**
* @generated from message gitpod.v1.OrganizationMember
*/
export type OrganizationMember = Message<"gitpod.v1.OrganizationMember"> & {
/**
* @generated from field: string user_id = 1;
*/
userId: string;
/**
* @generated from field: gitpod.v1.OrganizationRole role = 2;
*/
role: OrganizationRole;
/**
* @generated from field: google.protobuf.Timestamp member_since = 3;
*/
memberSince?: Timestamp;
/**
* @generated from field: string avatar_url = 4;
*/
avatarUrl: string;
/**
* @generated from field: string full_name = 5;
*/
fullName: string;
/**
* @generated from field: string email = 6;
*/
email: string;
/**
* @generated from field: gitpod.v1.UserStatus status = 7;
*/
status: UserStatus;
/**
* login_provider is the login provider the user uses to sign in
*
* @generated from field: string login_provider = 8;
*/
loginProvider: string;
};
/**
* Describes the message gitpod.v1.OrganizationMember.
* Use `create(OrganizationMemberSchema)` to create a new message.
*/
export declare const OrganizationMemberSchema: GenMessage<OrganizationMember>;
/**
* @generated from message gitpod.v1.InviteDomains
*/
export type InviteDomains = Message<"gitpod.v1.InviteDomains"> & {
/**
* domains is the list of domains that are allowed to join the organization
*
* @generated from field: repeated string domains = 1;
*/
domains: string[];
};
/**
* Describes the message gitpod.v1.InviteDomains.
* Use `create(InviteDomainsSchema)` to create a new message.
*/
export declare const InviteDomainsSchema: GenMessage<InviteDomains>;
/**
* @generated from message gitpod.v1.CreateSSOConfigurationRequest
*/
export type CreateSSOConfigurationRequest = Message<"gitpod.v1.CreateSSOConfigurationRequest"> & {
/**
* @generated from field: string organization_id = 1;
*/
organizationId: string;
/**
* client_id is the client ID of the OIDC application set on the IdP
*
* @generated from field: string client_id = 2;
*/
clientId: string;
/**
* client_secret is the client secret of the OIDC application set on the IdP
*
* @generated from field: string client_secret = 3;
*/
clientSecret: string;
/**
* issuer_url is the URL of the IdP issuer
*
* @generated from field: string issuer_url = 4;
*/
issuerUrl: string;
/**
* email_domain is the domain that is allowed to sign in to the organization
*
* @generated from field: optional string email_domain = 5;
*/
emailDomain?: string;
/**
* @generated from field: repeated string email_domains = 6;
*/
emailDomains: string[];
/**
* @generated from field: string display_name = 7;
*/
displayName: string;
/**
* additional_scopes are extra OIDC scopes to request from the identity provider during sign-in.
* These are appended to the default scopes (openid, email, profile).
*
* @generated from field: repeated string additional_scopes = 8;
*/
additionalScopes: string[];
/**
* claims_expression is an optional CEL expression evaluated against OIDC token claims during login.
* When set, the expression must evaluate to true for the login to succeed.
* Example: `claims.email_verified && claims.email.endsWith("@example.com")`
*
* @generated from field: optional string claims_expression = 9;
*/
claimsExpression?: string;
};
/**
* Describes the message gitpod.v1.CreateSSOConfigurationRequest.
* Use `create(CreateSSOConfigurationRequestSchema)` to create a new message.
*/
export declare const CreateSSOConfigurationRequestSchema: GenMessage<CreateSSOConfigurationRequest>;
/**
* @generated from message gitpod.v1.CreateSSOConfigurationResponse
*/
export type CreateSSOConfigurationResponse = Message<"gitpod.v1.CreateSSOConfigurationResponse"> & {
/**
* sso_configuration is the created SSO configuration
*
* @generated from field: gitpod.v1.SSOConfiguration sso_configuration = 1;
*/
ssoConfiguration?: SSOConfiguration;
};
/**
* Describes the message gitpod.v1.CreateSSOConfigurationResponse.
* Use `create(CreateSSOConfigurationResponseSchema)` to create a new message.
*/
export declare const CreateSSOConfigurationResponseSchema: GenMessage<CreateSSOConfigurationResponse>;
/**
* @generated from message gitpod.v1.SSOConfiguration
*/
export type SSOConfiguration = Message<"gitpod.v1.SSOConfiguration"> & {
/**
* id is the unique identifier of the SSO configuration
*
* @generated from field: string id = 1;
*/
id: string;
/**
* @generated from field: string organization_id = 2;
*/
organizationId: string;
/**
* client_id is the client ID of the OIDC application set on the IdP
*
* @generated from field: string client_id = 3;
*/
clientId: string;
/**
* issuer_url is the URL of the IdP issuer
*
* @generated from field: string issuer_url = 4;
*/
issuerUrl: string;
/**
* state is the state of the SSO configuration
*
* @generated from field: gitpod.v1.SSOConfigurationState state = 5;
*/
state: SSOConfigurationState;
/**
* claims are key/value pairs that defines a mapping of claims issued by the IdP.
*
* @generated from field: map<string, string> claims = 6;
*/
claims: {
[key: string]: string;
};
/**
* @generated from field: string email_domain = 7;
*/
emailDomain: string;
/**
* provider_type defines the type of the SSO configuration
*
* @generated from field: gitpod.v1.SSOConfiguration.ProviderType provider_type = 8;
*/
providerType: SSOConfiguration_ProviderType;
/**
* @generated from field: repeated string email_domains = 9;
*/
emailDomains: string[];
/**
* @generated from field: string display_name = 10;
*/
displayName: string;
/**
* additional_scopes are extra OIDC scopes requested from the identity provider during sign-in.
*
* @generated from field: repeated string additional_scopes = 11;
*/
additionalScopes: string[];
/**
* 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")`
*
* @generated from field: string claims_expression = 12;
*/
claimsExpression: string;
};
/**
* Describes the message gitpod.v1.SSOConfiguration.
* Use `create(SSOConfigurationSchema)` to create a new message.
*/
export declare const SSOConfigurationSchema: GenMessage<SSOConfiguration>;
/**
* @generated from enum gitpod.v1.SSOConfiguration.ProviderType
*/
export declare enum SSOConfiguration_ProviderType {
/**
* @generated from enum value: PROVIDER_TYPE_UNSPECIFIED = 0;
*/
UNSPECIFIED = 0,
/**
* @generated from enum value: PROVIDER_TYPE_BUILTIN = 1;
*/
BUILTIN = 1,
/**
* @generated from enum value: PROVIDER_TYPE_CUSTOM = 2;
*/
CUSTOM = 2
}
/**
* Describes the enum gitpod.v1.SSOConfiguration.ProviderType.
*/
export declare const SSOConfiguration_ProviderTypeSchema: GenEnum<SSOConfiguration_ProviderType>;
/**
* @generated from message gitpod.v1.GetSSOConfigurationRequest
*/
export type GetSSOConfigurationRequest = Message<"gitpod.v1.GetSSOConfigurationRequest"> & {
/**
* sso_configuration_id is the ID of the SSO configuration to get
*
* @generated from field: string sso_configuration_id = 1;
*/
ssoConfigurationId: string;
};
/**
* Describes the message gitpod.v1.GetSSOConfigurationRequest.
* Use `create(GetSSOConfigurationRequestSchema)` to create a new message.
*/
export declare const GetSSOConfigurationRequestSchema: GenMessage<GetSSOConfigurationRequest>;
/**
* @generated from message gitpod.v1.GetSSOConfigurationResponse
*/
export type GetSSOConfigurationResponse = Message<"gitpod.v1.GetSSOConfigurationResponse"> & {
/**
* sso_configuration is the SSO configuration identified by the ID
*
* @generated from field: gitpod.v1.SSOConfiguration sso_configuration = 1;
*/
ssoConfiguration?: SSOConfiguration;
};
/**
* Describes the message gitpod.v1.GetSSOConfigurationResponse.
* Use `create(GetSSOConfigurationResponseSchema)` to create a new message.
*/
export declare const GetSSOConfigurationResponseSchema: GenMessage<GetSSOConfigurationResponse>;
/**
* @generated from message gitpod.v1.ListSSOConfigurationsRequest
*/
export type ListSSOConfigurationsRequest = Message<"gitpod.v1.ListSSOConfigurationsRequest"> & {
/**
* @generated from field: gitpod.v1.PaginationRequest pagination = 1;
*/
pagination?: PaginationRequest;
/**
* organization_id is the ID of the organization to list SSO configurations for.
*
* @generated from field: string organization_id = 2;
*/
organizationId: string;
};
/**
* Describes the message gitpod.v1.ListSSOConfigurationsRequest.
* Use `create(ListSSOConfigurationsRequestSchema)` to create a new message.
*/
export declare const ListSSOConfigurationsRequestSchema: GenMessage<ListSSOConfigurationsRequest>;
/**
* @generated from message gitpod.v1.ListSSOConfigurationsResponse
*/
export type ListSSOConfigurationsResponse = Message<"gitpod.v1.ListSSOConfigurationsResponse"> & {
/**
* @generated from field: gitpod.v1.PaginationResponse pagination = 1;
*/
pagination?: PaginationResponse;
/**
* sso_configurations are the SSO configurations for the organization
*
* @generated from field: repeated gitpod.v1.SSOConfiguration sso_configurations = 2;
*/
ssoConfigurations: SSOConfiguration[];
};
/**
* Describes the message gitpod.v1.ListSSOConfigurationsResponse.
* Use `create(ListSSOConfigurationsResponseSchema)` to create a new message.
*/
export declare const ListSSOConfigurationsResponseSchema: GenMessage<ListSSOConfigurationsResponse>;
/**
* @generated from message gitpod.v1.UpdateSSOConfigurationRequest
*/
export type UpdateSSOConfigurationRequest = Message<"gitpod.v1.UpdateSSOConfigurationRequest"> & {
/**
* sso_configuration_id is the ID of the SSO configuration to update
*
* @generated from field: string sso_configuration_id = 1;
*/
ssoConfigurationId: string;
/**
* client_id is the client ID of the SSO provider
*
* @generated from field: optional string client_id = 2;
*/
clientId?: string;
/**
* client_secret is the client secret of the SSO provider
*
* @generated from field: optional string client_secret = 3;
*/
clientSecret?: string;
/**
* issuer_url is the URL of the IdP issuer
*
* @generated from field: optional string issuer_url = 4;
*/
issuerUrl?: string;
/**
* state is the state of the SSO configuration
*
* @generated from field: optional gitpod.v1.SSOConfigurationState state = 5;
*/
state?: SSOConfigurationState;
/**
* claims are key/value pairs that defines a mapping of claims issued by the IdP.
*
* @generated from field: map<string, string> claims = 6;
*/
claims: {
[key: string]: string;
};
/**
* @generated from field: optional string email_domain = 7;
*/
emailDomain?: string;
/**
* @generated from field: repeated string email_domains = 9;
*/
emailDomains: string[];
/**
* @generated from field: optional string display_name = 10;
*/
displayName?: string;
/**
* additional_scopes replaces the configured OIDC scopes when present.
* When absent (nil), scopes are left unchanged.
* When present with an empty scopes list, all additional scopes are cleared.
*
* @generated from field: optional gitpod.v1.AdditionalScopesUpdate additional_scopes = 11;
*/
additionalScopes?: AdditionalScopesUpdate;
/**
* claims_expression is a CEL expression evaluated against OIDC token claims during login.
* When set, the expression must evaluate to true for the login to succeed.
* When present with an empty string, the expression is cleared.
*
* @generated from field: optional string claims_expression = 12;
*/
claimsExpression?: string;
};
/**
* Describes the message gitpod.v1.UpdateSSOConfigurationRequest.
* Use `create(UpdateSSOConfigurationRequestSchema)` to create a new message.
*/
export declare const UpdateSSOConfigurationRequestSchema: GenMessage<UpdateSSOConfigurationRequest>;
/**
* 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).
*
* @generated from message gitpod.v1.AdditionalScopesUpdate
*/
export type AdditionalScopesUpdate = Message<"gitpod.v1.AdditionalScopesUpdate"> & {
/**
* @generated from field: repeated string scopes = 1;
*/
scopes: string[];
};
/**
* Describes the message gitpod.v1.AdditionalScopesUpdate.
* Use `create(AdditionalScopesUpdateSchema)` to create a new message.
*/
export declare const AdditionalScopesUpdateSchema: GenMessage<AdditionalScopesUpdate>;
/**
* @generated from message gitpod.v1.UpdateSSOConfigurationResponse
*/
export type UpdateSSOConfigurationResponse = Message<"gitpod.v1.UpdateSSOConfigurationResponse"> & {};
/**
* Describes the message gitpod.v1.UpdateSSOConfigurationResponse.
* Use `create(UpdateSSOConfigurationResponseSchema)` to create a new message.
*/
export declare const UpdateSSOConfigurationResponseSchema: GenMessage<UpdateSSOConfigurationResponse>;
/**
* @generated from message gitpod.v1.DeleteSSOConfigurationRequest
*/
export type DeleteSSOConfigurationRequest = Message<"gitpod.v1.DeleteSSOConfigurationRequest"> & {
/**
* @generated from field: string sso_configuration_id = 1;
*/
ssoConfigurationId: string;
};
/**
* Describes the message gitpod.v1.DeleteSSOConfigurationRequest.
* Use `create(DeleteSSOConfigurationRequestSchema)` to create a new message.
*/
export declare const DeleteSSOConfigurationRequestSchema: GenMessage<DeleteSSOConfigurationRequest>;
/**
* @generated from message gitpod.v1.DeleteSSOConfigurationResponse
*/
export type DeleteSSOConfigurationResponse = Message<"gitpod.v1.DeleteSSOConfigurationResponse"> & {};
/**
* Describes the message gitpod.v1.DeleteSSOConfigurationResponse.
* Use `create(DeleteSSOConfigurationResponseSchema)` to create a new message.
*/
export declare const DeleteSSOConfigurationResponseSchema: GenMessage<DeleteSSOConfigurationResponse>;
/**
* SCIMConfiguration represents a SCIM 2.0 provisioning configuration
*
* @generated from message gitpod.v1.SCIMConfiguration
*/
export type SCIMConfiguration = Message<"gitpod.v1.SCIMConfiguration"> & {
/**
* id is the unique identifier of the SCIM configuration
*
* @generated from field: string id = 1;
*/
id: string;
/**
* organization_id is the ID of the organization this SCIM configuration belongs to
*
* @generated from field: string organization_id = 2;
*/
organizationId: string;
/**
* name is a human-readable name for the SCIM configuration
*
* @generated from field: string name = 3;
*/
name: string;
/**
* enabled indicates if SCIM provisioning is active
*
* @generated from field: bool enabled = 4;
*/
enabled: boolean;
/**
* sso_configuration_id is the linked SSO configuration (optional)
*
* @generated from field: string sso_configuration_id = 5;
*/
ssoConfigurationId: string;
/**
* created_at is when the SCIM configuration was created
*
* @generated from field: google.protobuf.Timestamp created_at = 6;
*/
createdAt?: Timestamp;
/**
* updated_at is when the SCIM configuration was last updated
*
* @generated from field: google.protobuf.Timestamp updated_at = 7;
*/
updatedAt?: Timestamp;
/**
* token_expires_at is when the current SCIM token expires
*
* @generated from field: google.protobuf.Timestamp token_expires_at = 8;
*/
tokenExpiresAt?: Timestamp;
/**
* allow_unverified_email_account_linking allows SCIM to link provisioned users to existing accounts when the identity provider does not mark the email address as verified
*
* @generated from field: bool allow_unverified_email_account_linking = 9;
*/
allowUnverifiedEmailAccountLinking: boolean;
};
/**
* Describes the message gitpod.v1.SCIMConfiguration.
* Use `create(SCIMConfigurationSchema)` to create a new message.
*/
export declare const SCIMConfigurationSchema: GenMessage<SCIMConfiguration>;
/**
* @generated from message gitpod.v1.CreateSCIMConfigurationRequest
*/
export type CreateSCIMConfigurationRequest = Message<"gitpod.v1.CreateSCIMConfigurationRequest"> & {
/**
* organization_id is the ID of the organization to create the SCIM configuration for
*
* @generated from field: string organization_id = 1;
*/
organizationId: string;
/**
* name is a human-readable name for the SCIM configuration
*
* @generated from field: optional string name = 2;
*/
name?: string;
/**
* sso_configuration_id is the SSO configuration to link (required for user provisioning)
*
* @generated from field: string sso_configuration_id = 3;
*/
ssoConfigurationId: string;
/**
* token_expires_in is the duration until the token expires.
* Defaults to 1 year. Minimum 1 day, maximum 2 years.
*
* @generated from field: optional google.protobuf.Duration token_expires_in = 4;
*/
tokenExpiresIn?: Duration;
/**
* allow_unverified_email_account_linking allows SCIM to link provisioned users to existing accounts when the identity provider does not mark the email address as verified
*
* @generated from field: optional bool allow_unverified_email_account_linking = 5;
*/
allowUnverifiedEmailAccountLinking?: boolean;
};
/**
* Describes the message gitpod.v1.CreateSCIMConfigurationRequest.
* Use `create(CreateSCIMConfigurationRequestSchema)` to create a new message.
*/
export declare const CreateSCIMConfigurationRequestSchema: GenMessage<CreateSCIMConfigurationRequest>;
/**
* @generated from message gitpod.v1.CreateSCIMConfigurationResponse
*/
export type CreateSCIMConfigurationResponse = Message<"gitpod.v1.CreateSCIMConfigurationResponse"> & {
/**
* scim_configuration is the created SCIM configuration
*
* @generated from field: gitpod.v1.SCIMConfiguration scim_configuration = 1;
*/
scimConfiguration?: SCIMConfiguration;
/**
* token is the bearer token for SCIM API authentication.
* This is only returned once during creation - store it securely.
*
* @generated from field: string token = 2;
*/
token: string;
/**
* token_expires_at is when the token will expire
*
* @generated from field: google.protobuf.Timestamp token_expires_at = 3;
*/
tokenExpiresAt?: Timestamp;
};
/**
* Describes the message gitpod.v1.CreateSCIMConfigurationResponse.
* Use `create(CreateSCIMConfigurationResponseSchema)` to create a new message.
*/
export declare const CreateSCIMConfigurationResponseSchema: GenMessage<CreateSCIMConfigurationResponse>;
/**
* @generated from message gitpod.v1.GetSCIMConfigurationRequest
*/
export type GetSCIMConfigurationRequest = Message<"gitpod.v1.GetSCIMConfigurationRequest"> & {
/**
* scim_configuration_id is the ID of the SCIM configuration to get
*
* @generated from field: string scim_configuration_id = 1;
*/
scimConfigurationId: string;
};
/**
* Describes the message gitpod.v1.GetSCIMConfigurationRequest.
* Use `create(GetSCIMConfigurationRequestSchema)` to create a new message.
*/
export declare const GetSCIMConfigurationRequestSchema: GenMessage<GetSCIMConfigurationRequest>;
/**
* @generated from message gitpod.v1.GetSCIMConfigurationResponse
*/
export type GetSCIMConfigurationResponse = Message<"gitpod.v1.GetSCIMConfigurationResponse"> & {
/**
* scim_configuration is the SCIM configuration identified by the ID
*
* @generated from field: gitpod.v1.SCIMConfiguration scim_configuration = 1;
*/
scimConfiguration?: SCIMConfiguration;
};
/**
* Describes the message gitpod.v1.GetSCIMConfigurationResponse.
* Use `create(GetSCIMConfigurationResponseSchema)` to create a new message.
*/
export declare const GetSCIMConfigurationResponseSchema: GenMessage<GetSCIMConfigurationResponse>;
/**
* @generated from message gitpod.v1.ListSCIMConfigurationsRequest
*/
export type ListSCIMConfigurationsRequest = Message<"gitpod.v1.ListSCIMConfigurationsRequest"> & {
/**
* @generated from field: gitpod.v1.PaginationRequest pagination = 1;
*/
pagination?: PaginationRequest;
};
/**
* Describes the message gitpod.v1.ListSCIMConfigurationsRequest.
* Use `create(ListSCIMConfigurationsRequestSchema)` to create a new message.
*/
export declare const ListSCIMConfigurationsRequestSchema: GenMessage<ListSCIMConfigurationsRequest>;
/**
* @generated from message gitpod.v1.ListSCIMConfigurationsResponse
*/
export type ListSCIMConfigurationsResponse = Message<"gitpod.v1.ListSCIMConfigurationsResponse"> & {
/**
* @generated from field: gitpod.v1.PaginationResponse pagination = 1;
*/
pagination?: PaginationResponse;
/**
* scim_configurations are the SCIM configurations for the organization
*
* @generated from field: repeated gitpod.v1.SCIMConfiguration scim_configurations = 2;
*/
scimConfigurations: SCIMConfiguration[];
};
/**
* Describes the message gitpod.v1.ListSCIMConfigurationsResponse.
* Use `create(ListSCIMConfigurationsResponseSchema)` to create a new message.
*/
export declare const ListSCIMConfigurationsResponseSchema: GenMessage<ListSCIMConfigurationsResponse>;
/**
* @generated from message gitpod.v1.UpdateSCIMConfigurationRequest
*/
export type UpdateSCIMConfigurationRequest = Message<"gitpod.v1.UpdateSCIMConfigurationRequest"> & {
/**
* scim_configuration_id is the ID of the SCIM configuration to update
*
* @generated from field: string scim_configuration_id = 1;
*/
scimConfigurationId: string;
/**
* name is a human-readable name for the SCIM configuration
*
* @generated from field: optional string name = 2;
*/
name?: string;
/**
* enabled controls whether SCIM provisioning is active
*
* @generated from field: optional bool enabled = 3;
*/
enabled?: boolean;
/**
* sso_configuration_id is the SSO configuration to link
*
* @generated from field: optional string sso_configuration_id = 4;
*/
ssoConfigurationId?: string;
/**
* allow_unverified_email_account_linking allows SCIM to link provisioned users to existing accounts when the identity provider does not mark the email address as verified
*
* @generated from field: optional bool allow_unverified_email_account_linking = 5;
*/
allowUnverifiedEmailAccountLinking?: boolean;
};
/**
* Describes the message gitpod.v1.UpdateSCIMConfigurationRequest.
* Use `create(UpdateSCIMConfigurationRequestSchema)` to create a new message.
*/
export declare const UpdateSCIMConfigurationRequestSchema: GenMessage<UpdateSCIMConfigurationRequest>;
/**
* @generated from message gitpod.v1.UpdateSCIMConfigurationResponse
*/
export type UpdateSCIMConfigurationResponse = Message<"gitpod.v1.UpdateSCIMConfigurationResponse"> & {
/**
* scim_configuration is the updated SCIM configuration
*
* @generated from field: gitpod.v1.SCIMConfiguration scim_configuration = 1;
*/
scimConfiguration?: SCIMConfiguration;
};
/**
* Describes the message gitpod.v1.UpdateSCIMConfigurationResponse.
* Use `create(UpdateSCIMConfigurationResponseSchema)` to create a new message.
*/
export declare const UpdateSCIMConfigurationResponseSchema: GenMessage<UpdateSCIMConfigurationResponse>;
/**
* @generated from message gitpod.v1.DeleteSCIMConfigurationRequest
*/
export type DeleteSCIMConfigurationRequest = Message<"gitpod.v1.DeleteSCIMConfigurationRequest"> & {
/**
* scim_configuration_id is the ID of the SCIM configuration to delete
*
* @generated from field: string scim_configuration_id = 1;
*/
scimConfigurationId: string;
};
/**
* Describes the message gitpod.v1.DeleteSCIMConfigurationRequest.
* Use `create(DeleteSCIMConfigurationRequestSchema)` to create a new message.
*/
export declare const DeleteSCIMConfigurationRequestSchema: GenMessage<DeleteSCIMConfigurationRequest>;
/**
* @generated from message gitpod.v1.DeleteSCIMConfigurationResponse
*/
export type DeleteSCIMConfigurationResponse = Message<"gitpod.v1.DeleteSCIMConfigurationResponse"> & {};
/**
* Describes the message gitpod.v1.DeleteSCIMConfigurationResponse.
* Use `create(DeleteSCIMConfigurationResponseSchema)` to create a new message.
*/
export declare const DeleteSCIMConfigurationResponseSchema: GenMessage<DeleteSCIMConfigurationResponse>;
/**
* @generated from message gitpod.v1.RegenerateSCIMTokenRequest
*/
export type RegenerateSCIMTokenRequest = Message<"gitpod.v1.RegenerateSCIMTokenRequest"> & {
/**
* scim_configuration_id is the ID of the SCIM configuration to regenerate token for
*
* @generated from field: string scim_configuration_id = 1;
*/
scimConfigurationId: string;
/**
* token_expires_in is the duration until the new token expires.
* If not specified, uses the same duration as the previous token.
*
* @generated from field: optional google.protobuf.Duration token_expires_in = 2;
*/
tokenExpiresIn?: Duration;
};
/**
* Describes the message gitpod.v1.RegenerateSCIMTokenRequest.
* Use `create(RegenerateSCIMTokenRequestSchema)` to create a new message.
*/
export declare const RegenerateSCIMTokenRequestSchema: GenMessage<RegenerateSCIMTokenRequest>;
/**
* @generated from message gitpod.v1.RegenerateSCIMTokenResponse
*/
export type RegenerateSCIMTokenResponse = Message<"gitpod.v1.RegenerateSCIMTokenResponse"> & {
/**
* token is the new bearer token for SCIM API authentication.
* This invalidates the previous token - store it securely.
*
* @generated from field: string token = 1;
*/
token: string;
/**
* token_expires_at is when the new token will expire
*
* @generated from field: google.protobuf.Timestamp token_expires_at = 2;
*/
tokenExpiresAt?: Timestamp;
};
/**
* Describes the message gitpod.v1.RegenerateSCIMTokenResponse.
* Use `create(RegenerateSCIMTokenResponseSchema)` to create a new message.
*/
export declare const RegenerateSCIMTokenResponseSchema: GenMessage<RegenerateSCIMTokenResponse>;
/**
* @generated from message gitpod.v1.DomainVerification
*/
export type DomainVerification = Message<"gitpod.v1.DomainVerification"> & {
/**
* @generated from field: string id = 1;
*/
id: string;
/**
* @generated from field: string organization_id = 2;
*/
organizationId: string;
/**
* @generated from field: string domain = 3;
*/
domain: string;
/**
* @generated from field: gitpod.v1.DomainVerificationState state = 4;
*/
state: DomainVerificationState;
/**
* @generated from field: google.protobuf.Timestamp verified_at = 5;
*/
verifiedAt?: Timestamp;
/**
* @generated from field: string verification_token = 6;
*/
verificationToken: string;
/**
* @generated from field: google.protobuf.Timestamp created_at = 7;
*/
createdAt?: Timestamp;
};
/**
* Describes the message gitpod.v1.DomainVerification.
* Use `create(DomainVerificationSchema)` to create a new message.
*/
export declare const DomainVerificationSchema: GenMessage<DomainVerification>;
/**
* @generated from message gitpod.v1.CreateDomainVerificationRequest
*/
export type CreateDomainVerificationRequest = Message<"gitpod.v1.CreateDomainVerificationRequest"> & {
/**
* @generated from field: string organization_id = 1;
*/
organizationId: string;
/**
* @generated from field: string domain = 2;
*/
domain: string;
};
/**
* Describes the message gitpod.v1.CreateDomainVerificationRequest.
* Use `create(CreateDomainVerificationRequestSchema)` to create a new message.
*/
export declare const CreateDomainVerificationRequestSchema: GenMessage<CreateDomainVerificationRequest>;
/**
* @generated from message gitpod.v1.CreateDomainVerificationResponse
*/
export type CreateDomainVerificationResponse = Message<"gitpod.v1.CreateDomainVerificationResponse"> & {