1. Packages
  2. Planetscale Provider
  3. API Docs
  4. getOrganizations
planetscale 0.4.1 published on Tuesday, Mar 11, 2025 by planetscale

planetscale.getOrganizations

Explore with Pulumi AI

planetscale logo
planetscale 0.4.1 published on Tuesday, Mar 11, 2025 by planetscale

    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;
    
    import pulumi
    import pulumi_planetscale as planetscale
    
    example = planetscale.get_organizations()
    pulumi.export("orgs", example)
    
    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
    	})
    }
    
    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,
        };
    });
    
    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));
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: planetscale:getOrganizations
          arguments: {}
    outputs:
      orgs: ${example}
    

    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>
    def get_organizations(opts: Optional[InvokeOptions] = None) -> GetOrganizationsResult
    def get_organizations_output(opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationsResult]
    func GetOrganizations(ctx *Context, opts ...InvokeOption) (*GetOrganizationsResult, error)
    func GetOrganizationsOutput(ctx *Context, opts ...InvokeOption) GetOrganizationsResultOutput

    > 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)
    }
    public static CompletableFuture<GetOrganizationsResult> getOrganizations(InvokeOptions options)
    public static Output<GetOrganizationsResult> getOrganizations(InvokeOptions options)
    
    fn::invoke:
      function: planetscale:index/getOrganizations:getOrganizations
      arguments:
        # arguments dictionary

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

    GetOrganizationsOrganizationFeatures

    insights Boolean
    singleTenancy Boolean
    sso Boolean
    insights boolean
    singleTenancy boolean
    sso boolean
    insights Boolean
    singleTenancy Boolean
    sso Boolean

    GetOrganizationsOrganizationFlags

    Package Details

    Repository
    planetscale planetscale/terraform-provider-planetscale
    License
    Notes
    This Pulumi package is based on the planetscale Terraform Provider.
    planetscale logo
    planetscale 0.4.1 published on Tuesday, Mar 11, 2025 by planetscale