Gitpod gitpod.v1.OrganizationService API
The gitpod.v1.OrganizationService API from Gitpod — 39 operation(s) for gitpod.v1.organizationservice.
OpenAPI Specification
openapi: 3.0.0
info:
title: gitpod.v1 gitpod.v1.AccountService gitpod.v1.OrganizationService API
version: v1.0.0
servers:
- url: https://api.gitpod.io
description: Gitpod API
tags:
- name: gitpod.v1.OrganizationService
x-displayName: gitpod.v1.OrganizationService
paths:
/gitpod.v1.OrganizationService/CreateCustomDomain:
servers: []
post:
description: "Creates a custom domain configuration for an organization.\n\n Use this method to configure custom domains for organization workspaces\n\n ### Examples\n\n - Configure AWS custom domain:\n\n Sets up a custom domain with AWS provider.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n domainName: \"workspaces.acme-corp.com\"\n provider: CUSTOM_DOMAIN_PROVIDER_AWS\n awsAccountId: \"123456789012\"\n ```"
operationId: gitpod.v1.OrganizationService.CreateCustomDomain
parameters: []
requestBody:
content:
application/json:
examples:
configure_aws_custom_domain:
description: Sets up a custom domain with AWS provider.
value:
awsAccountId: '123456789012'
domainName: workspaces.acme-corp.com
organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
provider: CUSTOM_DOMAIN_PROVIDER_AWS
schema:
$ref: '#/components/schemas/gitpod.v1.CreateCustomDomainRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateCustomDomainResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CreateCustomDomain
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/CreateDomainVerification:
servers: []
post:
description: "Initiates domain verification process to enable organization features.\n\n Use this method to:\n - Start domain ownership verification\n - Enable automatic team joining\n - Set up SSO restrictions\n - Configure email-based policies\n\n ### Examples\n\n - Verify primary domain:\n\n Starts verification for main company domain.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n domain: \"acme-corp.com\"\n ```\n\n - Verify subsidiary domain:\n\n Adds verification for additional company domain.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n domain: \"acme-subsidiary.com\"\n ```"
operationId: gitpod.v1.OrganizationService.CreateDomainVerification
parameters: []
requestBody:
content:
application/json:
examples:
verify_primary_domain:
description: Starts verification for main company domain.
value:
domain: acme-corp.com
organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
verify_subsidiary_domain:
description: Adds verification for additional company domain.
value:
domain: acme-subsidiary.com
organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.CreateDomainVerificationRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateDomainVerificationResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CreateDomainVerification
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/CreateOrganization:
servers: []
post:
description: "Creates a new organization with the specified name and settings.\n\n Use this method to:\n - Create a new organization for team collaboration\n - Set up automatic domain-based invites for team members\n - Join the organization immediately upon creation\n\n ### Examples\n\n - Create a basic organization:\n\n Creates an organization with just a name.\n\n ```yaml\n name: \"Acme Corp Engineering\"\n joinOrganization: true\n ```\n\n - Create with domain-based invites:\n\n Creates an organization that automatically invites users with matching email domains.\n\n ```yaml\n name: \"Acme Corp\"\n joinOrganization: true\n inviteAccountsWithMatchingDomain: true\n ```"
operationId: gitpod.v1.OrganizationService.CreateOrganization
parameters: []
requestBody:
content:
application/json:
examples:
create_a_basic_organization:
description: Creates an organization with just a name.
value:
joinOrganization: true
name: Acme Corp Engineering
create_with_domain_based_invites:
description: Creates an organization that automatically invites users with matching email domains.
value:
inviteAccountsWithMatchingDomain: true
joinOrganization: true
name: Acme Corp
schema:
$ref: '#/components/schemas/gitpod.v1.CreateOrganizationRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateOrganizationResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CreateOrganization
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/CreateOrganizationInvite:
servers: []
post:
description: "Creates an invite link for joining an organization.\n Any existing OrganizationInvites are invalidated and can no longer be used.\n\n Use this method to:\n - Generate shareable invite links\n - Manage team growth\n - Control organization access\n\n ### Examples\n\n - Create organization invite:\n\n Generates a new invite link for the organization.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```"
operationId: gitpod.v1.OrganizationService.CreateOrganizationInvite
parameters: []
requestBody:
content:
application/json:
examples:
create_organization_invite:
description: Generates a new invite link for the organization.
value:
organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.CreateOrganizationInviteRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateOrganizationInviteResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CreateOrganizationInvite
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/CreateSCIMConfiguration:
servers: []
post:
description: "Creates a new SCIM configuration for automated user provisioning.\n\n Use this method to:\n - Set up SCIM 2.0 provisioning from an identity provider\n - Generate a bearer token for SCIM API authentication\n - Link SCIM provisioning to an existing SSO configuration\n\n ### Examples\n\n - Create basic SCIM configuration:\n\n Creates a SCIM configuration linked to an SSO provider with default 1 year token expiration.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ssoConfigurationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```\n\n - Create SCIM configuration with custom token expiration:\n\n Creates a SCIM configuration with a 90-day token expiration.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ssoConfigurationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n tokenExpiresIn: \"7776000s\"\n ```"
operationId: gitpod.v1.OrganizationService.CreateSCIMConfiguration
parameters: []
requestBody:
content:
application/json:
examples:
create_basic_scim_configuration:
description: Creates a SCIM configuration linked to an SSO provider with default 1 year token expiration.
value:
organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
ssoConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68
create_scim_configuration_with_custom_token_expiration:
description: Creates a SCIM configuration with a 90-day token expiration.
value:
organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
ssoConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68
tokenExpiresIn: 7776000s
schema:
$ref: '#/components/schemas/gitpod.v1.CreateSCIMConfigurationRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateSCIMConfigurationResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CreateSCIMConfiguration
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/CreateSSOConfiguration:
servers: []
post:
description: "Creates or updates SSO configuration for organizational authentication.\n\n Use this method to:\n - Configure OIDC-based SSO providers\n - Set up built-in providers (Google, GitHub, etc.)\n - Define custom identity providers\n - Manage authentication policies\n\n ### Examples\n\n - Configure built-in Google SSO:\n\n Sets up SSO using Google Workspace.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n clientId: \"012345678-abcdefghijklmnopqrstuvwxyz.apps.googleusercontent.com\"\n clientSecret: \"GOCSPX-abcdefghijklmnopqrstuvwxyz123456\"\n issuerUrl: \"https://accounts.google.com\"\n emailDomain: \"acme-corp.com\"\n ```\n\n - Configure custom OIDC provider:\n\n Sets up SSO with a custom identity provider.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n clientId: \"acme-corp-gitpod\"\n clientSecret: \"secret-token-value\"\n issuerUrl: \"https://sso.acme-corp.com\"\n emailDomain: \"acme-corp.com\"\n ```"
operationId: gitpod.v1.OrganizationService.CreateSSOConfiguration
parameters: []
requestBody:
content:
application/json:
examples:
configure_built_in_google_sso:
description: Sets up SSO using Google Workspace.
value:
clientId: 012345678-abcdefghijklmnopqrstuvwxyz.apps.googleusercontent.com
clientSecret: GOCSPX-abcdefghijklmnopqrstuvwxyz123456
emailDomain: acme-corp.com
issuerUrl: https://accounts.google.com
organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
configure_custom_oidc_provider:
description: Sets up SSO with a custom identity provider.
value:
clientId: acme-corp-gitpod
clientSecret: secret-token-value
emailDomain: acme-corp.com
issuerUrl: https://sso.acme-corp.com
organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.CreateSSOConfigurationRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateSSOConfigurationResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CreateSSOConfiguration
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/DeleteCustomDomain:
servers: []
post:
description: "Removes a custom domain configuration from an organization.\n\n Use this method to:\n - Disable custom domain functionality\n - Remove outdated configurations\n - Clean up unused domains\n\n ### Examples\n\n - Delete custom domain configuration:\n\n Removes a specific custom domain configuration.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```"
operationId: gitpod.v1.OrganizationService.DeleteCustomDomain
parameters: []
requestBody:
content:
application/json:
examples:
delete_custom_domain_configuration:
description: Removes a specific custom domain configuration.
value:
organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteCustomDomainRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteCustomDomainResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: DeleteCustomDomain
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/DeleteDomainVerification:
servers: []
post:
description: "Removes a domain verification request.\n\n Use this method to:\n - Cancel pending verifications\n - Remove verified domains\n - Clean up unused domain records\n\n ### Examples\n\n - Delete verification:\n\n Removes a domain verification request.\n\n ```yaml\n domainVerificationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.OrganizationService.DeleteDomainVerification
parameters: []
requestBody:
content:
application/json:
examples:
delete_verification:
description: Removes a domain verification request.
value:
domainVerificationId: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteDomainVerificationRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteDomainVerificationResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: DeleteDomainVerification
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/DeleteOrganization:
servers: []
post:
description: "Permanently deletes an organization.\n\n Use this method to:\n - Remove unused organizations\n - Clean up test organizations\n - Complete organization migration\n\n ### Examples\n\n - Delete organization:\n\n Permanently removes an organization and all its data.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```"
operationId: gitpod.v1.OrganizationService.DeleteOrganization
parameters: []
requestBody:
content:
application/json:
examples:
delete_organization:
description: Permanently removes an organization and all its data.
value:
organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteOrganizationRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteOrganizationResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: DeleteOrganization
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/DeleteSCIMConfiguration:
servers: []
post:
description: "Removes a SCIM configuration from an organization.\n\n Use this method to:\n - Disable SCIM provisioning completely\n - Remove unused configurations\n - Clean up after migration\n\n ### Examples\n\n - Delete SCIM configuration:\n\n Removes a specific SCIM configuration.\n\n ```yaml\n scimConfigurationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.OrganizationService.DeleteSCIMConfiguration
parameters: []
requestBody:
content:
application/json:
examples:
delete_scim_configuration:
description: Removes a specific SCIM configuration.
value:
scimConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteSCIMConfigurationRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteSCIMConfigurationResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: DeleteSCIMConfiguration
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/DeleteSSOConfiguration:
servers: []
post:
description: "Removes an SSO configuration from an organization.\n\n Use this method to:\n - Disable SSO authentication\n - Remove outdated providers\n - Clean up unused configurations\n\n ### Examples\n\n - Delete SSO configuration:\n\n Removes a specific SSO configuration.\n\n ```yaml\n ssoConfigurationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.OrganizationService.DeleteSSOConfiguration
parameters: []
requestBody:
content:
application/json:
examples:
delete_sso_configuration:
description: Removes a specific SSO configuration.
value:
ssoConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteSSOConfigurationRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteSSOConfigurationResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: DeleteSSOConfiguration
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/GetAnnouncementBanner:
servers: []
post:
description: "Retrieves the announcement banner configuration for an organization.\n\n Use this method to fetch the current announcement banner settings.\n All organization members can read the banner configuration.\n\n ### Examples\n\n - Get announcement banner:\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```"
operationId: gitpod.v1.OrganizationService.GetAnnouncementBanner
parameters: []
requestBody:
content:
application/json:
examples:
get_announcement_banner:
description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
'
value:
organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.GetAnnouncementBannerRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetAnnouncementBannerResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetAnnouncementBanner
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/GetCustomDomain:
servers: []
post:
description: "Retrieves a specific custom domain configuration.\n\n Use this method to view custom domain details\n\n ### Examples\n\n - Get custom domain configuration:\n\n Retrieves details of a specific custom domain.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```"
operationId: gitpod.v1.OrganizationService.GetCustomDomain
parameters: []
requestBody:
content:
application/json:
examples:
get_custom_domain_configuration:
description: Retrieves details of a specific custom domain.
value:
organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.GetCustomDomainRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetCustomDomainResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetCustomDomain
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/GetDomainVerification:
servers: []
post:
description: "Retrieves the status of a domain verification request.\n\n Use this method to:\n - Check verification progress\n - View verification requirements\n - Monitor domain status\n\n ### Examples\n\n - Get verification status:\n\n Checks the current state of a domain verification.\n\n ```yaml\n domainVerificationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.OrganizationService.GetDomainVerification
parameters: []
requestBody:
content:
application/json:
examples:
get_verification_status:
description: Checks the current state of a domain verification.
value:
domainVerificationId: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.GetDomainVerificationRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetDomainVerificationResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetDomainVerification
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/GetOIDCConfig:
servers: []
post:
description: "Retrieves the OIDC token configuration for an organization.\n\n Use this method to:\n - Check which OIDC token version is active (V2 or V3)\n - View extra sub claim fields (V3 only)\n\n ### Examples\n\n - Get OIDC config:\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```"
operationId: gitpod.v1.OrganizationService.GetOIDCConfig
parameters: []
requestBody:
content:
application/json:
examples:
get_oidc_config:
description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
'
value:
organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.GetOIDCConfigRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetOIDCConfigResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetOIDCConfig
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/GetOrganization:
servers: []
post:
description: "Gets details about a specific organization.\n\n Use this method to:\n - Retrieve organization settings and configuration\n - Check organization membership status\n - View domain verification settings\n\n ### Examples\n\n - Get organization details:\n\n Retrieves information about a specific organization.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```"
operationId: gitpod.v1.OrganizationService.GetOrganization
parameters: []
requestBody:
content:
application/json:
examples:
get_organization_details:
description: Retrieves information about a specific organization.
value:
organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.GetOrganizationRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetOrganizationResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetOrganization
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/GetOrganizationInvite:
servers: []
post:
operationId: gitpod.v1.OrganizationService.GetOrganizationInvite
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetOrganizationInviteRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetOrganizationInviteResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetOrganizationInvite
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/GetOrganizationInviteSummary:
servers: []
post:
description: "Retrieves organization details and membership info based on an invite link.\n\n Use this method to:\n - Preview organization details before joining\n - Validate invite link authenticity\n - Check organization size and activity\n - View team information before accepting\n\n ### Examples\n\n - Get invite summary:\n\n Retrieves organization information from an invite.\n\n ```yaml\n inviteId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.OrganizationService.GetOrganizationInviteSummary
parameters: []
requestBody:
content:
application/json:
examples:
get_invite_summary:
description: Retrieves organization information from an invite.
value:
inviteId: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.GetOrganizationInviteSummaryRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetOrganizationInviteSummaryResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetOrganizationInviteSummary
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/GetOrganizationPolicies:
servers: []
post:
description: "Gets organization policy settings by organization ID.\n\n Use this method to:\n - Retrieve current policy settings for an organization\n - View resource limits and restrictions\n - Check allowed editors and other configurations\n\n ### Examples\n\n - Get organization policies:\n\n Retrieves policy settings for a specific organization.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```"
operationId: gitpod.v1.OrganizationService.GetOrganizationPolicies
parameters: []
requestBody:
content:
application/json:
examples:
get_organization_policies:
description: Retrieves policy settings for a specific organization.
value:
organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.GetOrganizationPoliciesRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetOrganizationPoliciesResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetOrganizationPolicies
tags:
- gitpod.v1.OrganizationService
/gitpod.v1.OrganizationService/GetSCIMConfiguration:
servers: []
post:
description: "Retrieves a specific SCIM configuration.\n\n Use this method to:\n - View SCIM configuration details\n - Check if SCIM is enabled\n - Verify SSO linkage\n\n ### Examples\n\n - Get SCIM configuration:\n\n Retrieves details of a specific SCIM configuration.\n\n ```yaml\n scimConfigurationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.OrganizationService.GetSCIMConfiguration
parameters: []
requestBody:
content:
application/json:
examples:
get_scim_configuration:
description: Retrieves details of a specific SCIM config
# --- truncated at 32 KB (159 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gitpod/refs/heads/main/openapi/gitpod-gitpod-v1-organizationservice-api-openapi.yml