Creates a new organization with the specified name and settings.

Use this method to:

• Create a new organization for team collaboration
• Set up automatic domain-based invites for team members
• Join the organization immediately upon creation

Examples

• Create a basic organization:

  Creates an organization with just a name.

  name: "Acme Corp Engineering"
  joinOrganization: true
  

• Create with domain-based invites:

  Creates an organization that automatically invites users with matching email domains.

  name: "Acme Corp"
  joinOrganization: true
  inviteAccountsWithMatchingDomain: true
  

Permanently deletes an organization.

Use this method to:

• Remove unused organizations
• Clean up test organizations
• Complete organization migration

Examples

• Delete organization:

  Permanently removes an organization and all its data.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  

Allows users to join an organization through direct ID, invite link, or domain-based auto-join.

Use this method to:

• Join an organization via direct ID or invite
• Join automatically based on email domain
• Accept organization invitations

Examples

• Join via organization ID:

  Joins an organization directly when you have the ID.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  

• Join via invite:

  Accepts an organization invitation link.

  inviteId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  

Removes a user from an organization while preserving organization data.

Use this method to:

• Remove yourself from an organization
• Clean up inactive memberships
• Transfer project ownership before leaving
• Manage team transitions

Examples

• Leave organization:

  Removes user from organization membership.

  userId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
  

Note: Ensure all projects and resources are transferred before leaving.

Lists and filters organization members with optional pagination.

Use this method to:

• View all organization members
• Monitor member activity
• Manage team membership

Examples

• List active members:

  Retrieves active members with pagination.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  pagination:
    pageSize: 20
  

• List with pagination:

  Retrieves next page of members.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  pagination:
    pageSize: 50
    token: "next-page-token-from-previous-response"
  

Gets details about a specific organization.

Use this method to:

• Retrieve organization settings and configuration
• Check organization membership status
• View domain verification settings

Examples

• Get organization details:

  Retrieves information about a specific organization.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  

Manages organization membership and roles by setting a user's role within the organization.

Use this method to:

• Promote members to admin role
• Change member permissions
• Demote admins to regular members

Examples

• Promote to admin:

  Makes a user an organization administrator.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  userId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
  role: ORGANIZATION_ROLE_ADMIN
  

• Change to member:

  Changes a user's role to regular member.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  userId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
  role: ORGANIZATION_ROLE_MEMBER
  

Updates an organization's settings including name, invite domains, and member policies.

Use this method to:

• Modify organization display name
• Configure email domain restrictions
• Update organization-wide settings
• Manage member access policies

Examples

• Update basic settings:

  Changes organization name and invite domains.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  name: "New Company Name"
  inviteDomains:
    domains:
      - "company.com"
      - "subsidiary.com"
  

• Remove domain restrictions:

  Clears all domain-based invite restrictions.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  inviteDomains:
    domains: []
  

Retrieves the announcement banner configuration for an organization.

Use this method to fetch the current announcement banner settings. All organization members can read the banner configuration.

Examples

• Get announcement banner:

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  

Updates the announcement banner configuration for an organization.

Use this method to configure the announcement banner displayed to all users. Only organization admins can update the banner. Requires Enterprise tier.

Examples

• Enable announcement banner:

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  message: "Scheduled maintenance on Saturday 10pm-2am UTC"
  enabled: true
  

• Disable announcement banner:

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  enabled: false
  

Creates a custom domain configuration for an organization.

Use this method to configure custom domains for organization workspaces

Examples

• Configure AWS custom domain:

  Sets up a custom domain with AWS provider.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  domainName: "workspaces.acme-corp.com"
  provider: CUSTOM_DOMAIN_PROVIDER_AWS
  awsAccountId: "123456789012"
  

Removes a custom domain configuration from an organization.

Use this method to:

• Disable custom domain functionality
• Remove outdated configurations
• Clean up unused domains

Examples

• Delete custom domain configuration:

  Removes a specific custom domain configuration.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  

Retrieves a specific custom domain configuration.

Use this method to view custom domain details

Examples

• Get custom domain configuration:

  Retrieves details of a specific custom domain.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  

Updates custom domain configuration settings.

Use this method to:

• Update cloud provider settings
• Change AWS account ID
• Modify domain configuration

Examples

• Update AWS account ID:

  Changes the AWS account ID for the custom domain.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  domainName: "workspaces.acme-corp.com"
  awsAccountId: "987654321098"
  

Initiates domain verification process to enable organization features.

Use this method to:

• Start domain ownership verification
• Enable automatic team joining
• Set up SSO restrictions
• Configure email-based policies

Examples

• Verify primary domain:

  Starts verification for main company domain.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  domain: "acme-corp.com"
  

• Verify subsidiary domain:

  Adds verification for additional company domain.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  domain: "acme-subsidiary.com"
  

Removes a domain verification request.

Use this method to:

• Cancel pending verifications
• Remove verified domains
• Clean up unused domain records

Examples

• Delete verification:

  Removes a domain verification request.

  domainVerificationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  

Lists and monitors domain verification status across an organization.

Use this method to:

• Track verification progress
• View all verified domains
• Monitor pending verifications
• Audit domain settings

Examples

• List all verifications:

  Shows all domain verifications regardless of status.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  pagination:
    pageSize: 20
  

• List with pagination:

  Retrieves next page of verifications.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  pagination:
    pageSize: 20
    token: "next-page-token-from-previous-response"
  

Retrieves the status of a domain verification request.

Use this method to:

• Check verification progress
• View verification requirements
• Monitor domain status

Examples

• Get verification status:

  Checks the current state of a domain verification.

  domainVerificationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  

Verifies domain ownership for an organization.

Use this method to:

• Complete domain verification process
• Enable domain-based features
• Validate DNS configuration

Examples

• Verify domain ownership:

  Verifies ownership after DNS records are configured.

  domainVerificationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  

Creates an invite link for joining an organization. Any existing OrganizationInvites are invalidated and can no longer be used.

Use this method to:

• Generate shareable invite links
• Manage team growth
• Control organization access

Examples

• Create organization invite:

  Generates a new invite link for the organization.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  

Retrieves organization details and membership info based on an invite link.

Use this method to:

• Preview organization details before joining
• Validate invite link authenticity
• Check organization size and activity
• View team information before accepting

Examples

• Get invite summary:

  Retrieves organization information from an invite.

  inviteId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  

GetOrganizationInvite

Gets organization policy settings by organization ID.

Use this method to:

• Retrieve current policy settings for an organization
• View resource limits and restrictions
• Check allowed editors and other configurations

Examples

• Get organization policies:

  Retrieves policy settings for a specific organization.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  

Updates organization policy settings.

Use this method to:

• Configure editor restrictions
• Set environment resource limits
• Define project creation permissions
• Customize default configurations

Examples

• Update editor policies:

  Restricts available editors and sets a default.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  allowedEditorIds:
    - "vscode"
    - "jetbrains"
  defaultEditorId: "vscode"
  

• Set environment limits:

  Configures limits for environment usage.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  maximumEnvironmentTimeout: "3600s"
  maximumRunningEnvironmentsPerUser: "5"
  maximumEnvironmentsPerUser: "20"
  

Creates a new SCIM configuration for automated user provisioning.

Use this method to:

• Set up SCIM 2.0 provisioning from an identity provider
• Generate a bearer token for SCIM API authentication
• Link SCIM provisioning to an existing SSO configuration

Examples

• Create basic SCIM configuration:

  Creates a SCIM configuration linked to an SSO provider with default 1 year token expiration.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  ssoConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  

• Create SCIM configuration with custom token expiration:

  Creates a SCIM configuration with a 90-day token expiration.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  ssoConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  tokenExpiresIn: "7776000s"
  

Removes a SCIM configuration from an organization.

Use this method to:

• Disable SCIM provisioning completely
• Remove unused configurations
• Clean up after migration

Examples

• Delete SCIM configuration:

  Removes a specific SCIM configuration.

  scimConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  

Lists SCIM configurations for an organization.

Use this method to:

• View all SCIM configurations
• Monitor provisioning status
• Audit SCIM settings

Examples

• List SCIM configurations:

  Shows all SCIM configurations for an organization.

  pagination:
    pageSize: 20
  

Regenerates the bearer token for a SCIM configuration.

Use this method to:

• Rotate SCIM credentials
• Recover from token compromise
• Update IdP configuration

Examples

• Regenerate token:

  Creates a new bearer token with the same expiration duration as the previous token.

  scimConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  

• Regenerate token with new expiration:

  Creates a new bearer token with a custom 180-day expiration.

  scimConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  tokenExpiresIn: "15552000s"
  

Retrieves a specific SCIM configuration.

Use this method to:

• View SCIM configuration details
• Check if SCIM is enabled
• Verify SSO linkage

Examples

• Get SCIM configuration:

  Retrieves details of a specific SCIM configuration.

  scimConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  

Updates a SCIM configuration.

Use this method to:

• Enable or disable SCIM provisioning
• Link or unlink SSO configuration
• Update configuration name

Examples

• Disable SCIM:

  Disables SCIM provisioning.

  scimConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  enabled: false
  

• Link to SSO:

  Links SCIM configuration to an SSO provider.

  scimConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  ssoConfigurationId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
  

Removes an SSO configuration from an organization.

Use this method to:

• Disable SSO authentication
• Remove outdated providers
• Clean up unused configurations

Examples

• Delete SSO configuration:

  Removes a specific SSO configuration.

  ssoConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  

Lists and filters SSO configurations for an organization.

Use this method to:

• View all SSO providers
• Monitor authentication status
• Audit security settings
• Manage provider configurations

Examples

• List active configurations:

  Shows all active SSO providers.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  pagination:
    pageSize: 20
  

• List by provider type:

  Shows custom SSO configurations.

  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  pagination:
    pageSize: 20
    token: "next-page-token-from-previous-response"
  

Retrieves a specific SSO configuration.

Use this method to:

• View SSO provider details
• Check configuration status
• Verify SSO settings

Examples

• Get SSO configuration:

  Retrieves details of a specific SSO configuration.

  ssoConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  

Updates SSO provider settings and authentication rules.

Use this method to:

• Rotate client credentials
• Update provider endpoints
• Modify claim mappings
• Change authentication policies
• Toggle SSO enforcement

Examples

• Update credentials:

  Rotates client ID and secret.

  ssoConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  clientId: "new-client-id"
  clientSecret: "new-client-secret"
  

• Update provider status:

  Activates or deactivates SSO provider.

  ssoConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  state: SSO_CONFIGURATION_STATE_ACTIVE