1. Packages
  2. Planetscale Provider
  3. API Docs
  4. getOrganizations
planetscale 0.5.0 published on Saturday, Apr 5, 2025 by planetscale

planetscale.getOrganizations

Explore with Pulumi AI

A list of PlanetScale organizations.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as planetscale from "@pulumi/planetscale";

const example = planetscale.getOrganizations({});
export const orgs = example;
Copy
import pulumi
import pulumi_planetscale as planetscale

example = planetscale.get_organizations()
pulumi.export("orgs", example)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/planetscale/planetscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.GetOrganizations(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		ctx.Export("orgs", example)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Planetscale = Pulumi.Planetscale;

return await Deployment.RunAsync(() => 
{
    var example = Planetscale.GetOrganizations.Invoke();

    return new Dictionary<string, object?>
    {
        ["orgs"] = example,
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.planetscale.PlanetscaleFunctions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = PlanetscaleFunctions.getOrganizations();

        ctx.export("orgs", example.applyValue(getOrganizationsResult -> getOrganizationsResult));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: planetscale:getOrganizations
      arguments: {}
outputs:
  orgs: ${example}
Copy

Using getOrganizations

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getOrganizations(opts?: InvokeOptions): Promise<GetOrganizationsResult>
function getOrganizationsOutput(opts?: InvokeOptions): Output<GetOrganizationsResult>
Copy
def get_organizations(opts: Optional[InvokeOptions] = None) -> GetOrganizationsResult
def get_organizations_output(opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationsResult]
Copy
func GetOrganizations(ctx *Context, opts ...InvokeOption) (*GetOrganizationsResult, error)
func GetOrganizationsOutput(ctx *Context, opts ...InvokeOption) GetOrganizationsResultOutput
Copy

> Note: This function is named GetOrganizations in the Go SDK.

public static class GetOrganizations 
{
    public static Task<GetOrganizationsResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetOrganizationsResult> Invoke(InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOrganizationsResult> getOrganizations(InvokeOptions options)
public static Output<GetOrganizationsResult> getOrganizations(InvokeOptions options)
Copy
fn::invoke:
  function: planetscale:index/getOrganizations:getOrganizations
  arguments:
    # arguments dictionary
Copy

getOrganizations Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Organizations List<GetOrganizationsOrganization>
Id string
The provider-assigned unique ID for this managed resource.
Organizations []GetOrganizationsOrganization
id String
The provider-assigned unique ID for this managed resource.
organizations List<GetOrganizationsOrganization>
id string
The provider-assigned unique ID for this managed resource.
organizations GetOrganizationsOrganization[]
id str
The provider-assigned unique ID for this managed resource.
organizations Sequence[GetOrganizationsOrganization]
id String
The provider-assigned unique ID for this managed resource.
organizations List<Property Map>

Supporting Types

GetOrganizationsOrganization

BillingEmail This property is required. string
The billing email of the organization.
CreatedAt This property is required. string
When the organization was created.
DatabaseCount This property is required. double
The number of databases in the organization.
Features This property is required. GetOrganizationsOrganizationFeatures
Features that are enabled on the organization.
Flags This property is required. GetOrganizationsOrganizationFlags
.
HasPastDueInvoices This property is required. bool
Whether or not the organization has past due billing invoices.
Id This property is required. string
The ID for the organization.
IdpManagedRoles This property is required. bool
Whether or not the IdP provider is be responsible for managing roles in PlanetScale.
Name This property is required. string
The name of the organization.
Plan This property is required. string
The billing plan of the organization.
SingleTenancy This property is required. bool
Whether or not the organization has single tenancy enabled.
Sso This property is required. bool
Whether or not SSO is enabled on the organization.
SsoDirectory This property is required. bool
Whether or not the organization uses a WorkOS directory.
SsoPortalUrl This property is required. string
The URL of the organization's SSO portal.
UpdatedAt This property is required. string
When the organization was last updated.
ValidBillingInfo This property is required. bool
Whether or not the organization's billing information is valid.
BillingEmail This property is required. string
The billing email of the organization.
CreatedAt This property is required. string
When the organization was created.
DatabaseCount This property is required. float64
The number of databases in the organization.
Features This property is required. GetOrganizationsOrganizationFeatures
Features that are enabled on the organization.
Flags This property is required. GetOrganizationsOrganizationFlags
.
HasPastDueInvoices This property is required. bool
Whether or not the organization has past due billing invoices.
Id This property is required. string
The ID for the organization.
IdpManagedRoles This property is required. bool
Whether or not the IdP provider is be responsible for managing roles in PlanetScale.
Name This property is required. string
The name of the organization.
Plan This property is required. string
The billing plan of the organization.
SingleTenancy This property is required. bool
Whether or not the organization has single tenancy enabled.
Sso This property is required. bool
Whether or not SSO is enabled on the organization.
SsoDirectory This property is required. bool
Whether or not the organization uses a WorkOS directory.
SsoPortalUrl This property is required. string
The URL of the organization's SSO portal.
UpdatedAt This property is required. string
When the organization was last updated.
ValidBillingInfo This property is required. bool
Whether or not the organization's billing information is valid.
billingEmail This property is required. String
The billing email of the organization.
createdAt This property is required. String
When the organization was created.
databaseCount This property is required. Double
The number of databases in the organization.
features This property is required. GetOrganizationsOrganizationFeatures
Features that are enabled on the organization.
flags This property is required. GetOrganizationsOrganizationFlags
.
hasPastDueInvoices This property is required. Boolean
Whether or not the organization has past due billing invoices.
id This property is required. String
The ID for the organization.
idpManagedRoles This property is required. Boolean
Whether or not the IdP provider is be responsible for managing roles in PlanetScale.
name This property is required. String
The name of the organization.
plan This property is required. String
The billing plan of the organization.
singleTenancy This property is required. Boolean
Whether or not the organization has single tenancy enabled.
sso This property is required. Boolean
Whether or not SSO is enabled on the organization.
ssoDirectory This property is required. Boolean
Whether or not the organization uses a WorkOS directory.
ssoPortalUrl This property is required. String
The URL of the organization's SSO portal.
updatedAt This property is required. String
When the organization was last updated.
validBillingInfo This property is required. Boolean
Whether or not the organization's billing information is valid.
billingEmail This property is required. string
The billing email of the organization.
createdAt This property is required. string
When the organization was created.
databaseCount This property is required. number
The number of databases in the organization.
features This property is required. GetOrganizationsOrganizationFeatures
Features that are enabled on the organization.
flags This property is required. GetOrganizationsOrganizationFlags
.
hasPastDueInvoices This property is required. boolean
Whether or not the organization has past due billing invoices.
id This property is required. string
The ID for the organization.
idpManagedRoles This property is required. boolean
Whether or not the IdP provider is be responsible for managing roles in PlanetScale.
name This property is required. string
The name of the organization.
plan This property is required. string
The billing plan of the organization.
singleTenancy This property is required. boolean
Whether or not the organization has single tenancy enabled.
sso This property is required. boolean
Whether or not SSO is enabled on the organization.
ssoDirectory This property is required. boolean
Whether or not the organization uses a WorkOS directory.
ssoPortalUrl This property is required. string
The URL of the organization's SSO portal.
updatedAt This property is required. string
When the organization was last updated.
validBillingInfo This property is required. boolean
Whether or not the organization's billing information is valid.
billing_email This property is required. str
The billing email of the organization.
created_at This property is required. str
When the organization was created.
database_count This property is required. float
The number of databases in the organization.
features This property is required. GetOrganizationsOrganizationFeatures
Features that are enabled on the organization.
flags This property is required. GetOrganizationsOrganizationFlags
.
has_past_due_invoices This property is required. bool
Whether or not the organization has past due billing invoices.
id This property is required. str
The ID for the organization.
idp_managed_roles This property is required. bool
Whether or not the IdP provider is be responsible for managing roles in PlanetScale.
name This property is required. str
The name of the organization.
plan This property is required. str
The billing plan of the organization.
single_tenancy This property is required. bool
Whether or not the organization has single tenancy enabled.
sso This property is required. bool
Whether or not SSO is enabled on the organization.
sso_directory This property is required. bool
Whether or not the organization uses a WorkOS directory.
sso_portal_url This property is required. str
The URL of the organization's SSO portal.
updated_at This property is required. str
When the organization was last updated.
valid_billing_info This property is required. bool
Whether or not the organization's billing information is valid.
billingEmail This property is required. String
The billing email of the organization.
createdAt This property is required. String
When the organization was created.
databaseCount This property is required. Number
The number of databases in the organization.
features This property is required. Property Map
Features that are enabled on the organization.
flags This property is required. Property Map
.
hasPastDueInvoices This property is required. Boolean
Whether or not the organization has past due billing invoices.
id This property is required. String
The ID for the organization.
idpManagedRoles This property is required. Boolean
Whether or not the IdP provider is be responsible for managing roles in PlanetScale.
name This property is required. String
The name of the organization.
plan This property is required. String
The billing plan of the organization.
singleTenancy This property is required. Boolean
Whether or not the organization has single tenancy enabled.
sso This property is required. Boolean
Whether or not SSO is enabled on the organization.
ssoDirectory This property is required. Boolean
Whether or not the organization uses a WorkOS directory.
ssoPortalUrl This property is required. String
The URL of the organization's SSO portal.
updatedAt This property is required. String
When the organization was last updated.
validBillingInfo This property is required. Boolean
Whether or not the organization's billing information is valid.

GetOrganizationsOrganizationFeatures

Insights This property is required. bool
SingleTenancy This property is required. bool
Sso This property is required. bool
Insights This property is required. bool
SingleTenancy This property is required. bool
Sso This property is required. bool
insights This property is required. Boolean
singleTenancy This property is required. Boolean
sso This property is required. Boolean
insights This property is required. boolean
singleTenancy This property is required. boolean
sso This property is required. boolean
insights This property is required. bool
single_tenancy This property is required. bool
sso This property is required. bool
insights This property is required. Boolean
singleTenancy This property is required. Boolean
sso This property is required. Boolean

GetOrganizationsOrganizationFlags

ExampleFlag This property is required. string
ExampleFlag This property is required. string
exampleFlag This property is required. String
exampleFlag This property is required. string
example_flag This property is required. str
exampleFlag This property is required. String

Package Details

Repository
planetscale planetscale/terraform-provider-planetscale
License
Notes
This Pulumi package is based on the planetscale Terraform Provider.