Gitpod Documentation | Organizations

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.

List Organizations -> OrganizationsPage<{ id, createdAt, inviteDomains, 2 more... }>

post/gitpod.v1.OrganizationService/ListOrganizations

ListOrganizations lists all organization the caller has access to.

Security

Bearer Auth

Example: Authorization: Bearer My Bearer Token

Parameters

token: string

Optional

pageSize: number

Optional

(maximum: 100, minimum: 0)

Response fields

organizations: Array<{ id, createdAt, inviteDomains, 2 more... }>

Optional

organizations are the organizations that matched the query

pagination: { nextToken }

Optional

pagination contains the pagination options for listing organizations

Request example

curl https://app.gitpod.io/api/gitpod.v1.OrganizationService/ListOrganizations \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{}'

200Example

{
  "organizations": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "createdAt": "2019-12-27T18:11:19.117Z",
      "inviteDomains": {
        "domains": [
          "sfN2.l.iJR-BU.u9JV9.a.m.o2D-4b-Jd.0Z-kX.L.n.S.f.UKbxB"
        ]
      },
      "name": "name",
      "updatedAt": "2019-12-27T18:11:19.117Z"
    }
  ],
  "pagination": {
    "nextToken": "nextToken"
  }
}

List Members -> MembersPage<{ avatarUrl, email, fullName, 5 more... }>

post/gitpod.v1.OrganizationService/ListMembers

ListMembers lists all members of the specified organization.

Security

Bearer Auth

Example: Authorization: Bearer My Bearer Token

Parameters

token: string

Optional

pageSize: number

Optional

(maximum: 100, minimum: 0)

Response fields

members: Array<{ avatarUrl, email, fullName, 5 more... }>

Optional

members are the members of the organization

pagination: { nextToken }

Optional

pagination contains the pagination options for listing members

Request example

curl https://app.gitpod.io/api/gitpod.v1.OrganizationService/ListMembers \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{}'

200Example

{
  "members": [
    {
      "avatarUrl": "avatarUrl",
      "email": "email",
      "fullName": "fullName",
      "loginProvider": "loginProvider",
      "memberSince": "2019-12-27T18:11:19.117Z",
      "role": "ORGANIZATION_ROLE_UNSPECIFIED",
      "status": "USER_STATUS_UNSPECIFIED",
      "userId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    }
  ],
  "pagination": {
    "nextToken": "nextToken"
  }
}

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.