LogoGitpod Documentation

Organizations

organizations

Methods

Create Organization -> { member, organization }
post/gitpod.v1.OrganizationService/CreateOrganization

CreateOrganization creates a new Organization.

Delete Organization -> unknown
post/gitpod.v1.OrganizationService/DeleteOrganization

DeleteOrganization deletes the specified organization.

Join Organization -> { member }
post/gitpod.v1.OrganizationService/JoinOrganization

JoinOrganization lets accounts join an Organization.

Leave Organization -> unknown
post/gitpod.v1.OrganizationService/LeaveOrganization

LeaveOrganization lets the passed user leave an Organization.

Security
Bearer Auth

Example: Authorization: Bearer My Bearer Token

Request example
200Example
List Organizations -> OrganizationsPage<{ id, createdAt, inviteDomains, 2 more... }>
post/gitpod.v1.OrganizationService/ListOrganizations

ListOrganizations lists all organization the caller has access to.

List Members -> MembersPage<{ avatarUrl, email, fullName, 5 more... }>
post/gitpod.v1.OrganizationService/ListMembers

ListMembers lists all members of the specified organization.

Get Organization -> { organization }
post/gitpod.v1.OrganizationService/GetOrganization

GetOrganization retrieves a single Organization.

Set Role -> unknown
post/gitpod.v1.OrganizationService/SetRole

SetRole

Update Organization -> { organization }
post/gitpod.v1.OrganizationService/UpdateOrganization

UpdateOrganization updates the properties of an Organization.

Organizations

Invites

organizations.invites

Methods

Create Organization Invite -> { invite }
post/gitpod.v1.OrganizationService/CreateOrganizationInvite

CreateOrganizationInvite creates an invite for the organization. Any existing OrganizationInvites are invalidated and can no longer be used.

Get Organization Invite Summary -> { organizationId, organizationMemberCount, organizationName }
post/gitpod.v1.OrganizationService/GetOrganizationInviteSummary

GetOrganizationInviteSummary retrieves a summary of the organization based on an Invite ID. Used to discover which organization an invite is for.

Get Organization Invite -> { invite }
post/gitpod.v1.OrganizationService/GetOrganizationInvite

GetOrganizationInvite retrieves invite for the organization. If no invite exists, a new one is created.

Organizations

SSO Configurations

organizations.sso_configurations

Methods

Create SSO Configuration -> { ssoConfiguration }
post/gitpod.v1.OrganizationService/CreateSSOConfiguration

CreateSSOConfiguration creates a new SSO configuration for the organization.

Delete SSO Configuration -> unknown
post/gitpod.v1.OrganizationService/DeleteSSOConfiguration

DeleteSSOConfiguration deletes an SSO configuration.

List SSO Configurations -> SSOConfigurationsPage<{ id, claims, clientId, 5 more... }>
post/gitpod.v1.OrganizationService/ListSSOConfigurations

ListSSOConfigurations lists all SSO configurations matching provided filters.

Get SSO Configuration -> { ssoConfiguration }
post/gitpod.v1.OrganizationService/GetSSOConfiguration

GetSSOConfiguration returns an SSO configuration.

Update SSO Configuration -> unknown
post/gitpod.v1.OrganizationService/UpdateSSOConfiguration

UpdateSSOConfiguration updates the SSO configuration for the organization.