1. Packages
  2. Packages
  3. Pulumi Cloud (Pulumi Service provider)
  4. API Docs
  5. api
  6. DefaultOrganization

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
pulumiservice logo

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi

    UpdateDefaultOrganization sets the default organization for the current user.

    Create DefaultOrganization Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DefaultOrganization(name: string, args: DefaultOrganizationArgs, opts?: CustomResourceOptions);
    @overload
    def DefaultOrganization(resource_name: str,
                            args: DefaultOrganizationArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def DefaultOrganization(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            org_name: Optional[str] = None)
    func NewDefaultOrganization(ctx *Context, name string, args DefaultOrganizationArgs, opts ...ResourceOption) (*DefaultOrganization, error)
    public DefaultOrganization(string name, DefaultOrganizationArgs args, CustomResourceOptions? opts = null)
    public DefaultOrganization(String name, DefaultOrganizationArgs args)
    public DefaultOrganization(String name, DefaultOrganizationArgs args, CustomResourceOptions options)
    
    type: pulumiservice:api:DefaultOrganization
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "pulumiservice_api_defaultorganization" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args DefaultOrganizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DefaultOrganizationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DefaultOrganizationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DefaultOrganizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DefaultOrganizationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var defaultOrganizationResource = new PulumiService.Api.DefaultOrganization("defaultOrganizationResource", new()
    {
        OrgName = "string",
    });
    
    example, err := api.NewDefaultOrganization(ctx, "defaultOrganizationResource", &api.DefaultOrganizationArgs{
    	OrgName: pulumi.String("string"),
    })
    
    resource "pulumiservice_api_defaultorganization" "defaultOrganizationResource" {
      org_name = "string"
    }
    
    var defaultOrganizationResource = new DefaultOrganization("defaultOrganizationResource", DefaultOrganizationArgs.builder()
        .orgName("string")
        .build());
    
    default_organization_resource = pulumiservice.api.DefaultOrganization("defaultOrganizationResource", org_name="string")
    
    const defaultOrganizationResource = new pulumiservice.api.DefaultOrganization("defaultOrganizationResource", {orgName: "string"});
    
    type: pulumiservice:api:DefaultOrganization
    properties:
        orgName: string
    

    DefaultOrganization Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DefaultOrganization resource accepts the following input properties:

    OrgName string
    The organization name
    OrgName string
    The organization name
    org_name string
    The organization name
    orgName String
    The organization name
    orgName string
    The organization name
    org_name str
    The organization name
    orgName String
    The organization name

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DefaultOrganization resource produces the following output properties:

    GitHubLogin string
    Returns the organization name. Can be an empty string, if the user is a member of no organizations
    Id string
    The provider-assigned unique ID for this managed resource.
    Messages List<object>
    Messages is a list of messages that should be displayed to the user that contextualize the default org; for example: warning new users if their default org as returned by the service is on an expiring trial and not free tier, with possible recommendations on how to configure their default org locally. Can be possibly empty.
    GitHubLogin string
    Returns the organization name. Can be an empty string, if the user is a member of no organizations
    Id string
    The provider-assigned unique ID for this managed resource.
    Messages []interface{}
    Messages is a list of messages that should be displayed to the user that contextualize the default org; for example: warning new users if their default org as returned by the service is on an expiring trial and not free tier, with possible recommendations on how to configure their default org locally. Can be possibly empty.
    git_hub_login string
    Returns the organization name. Can be an empty string, if the user is a member of no organizations
    id string
    The provider-assigned unique ID for this managed resource.
    messages list(any)
    Messages is a list of messages that should be displayed to the user that contextualize the default org; for example: warning new users if their default org as returned by the service is on an expiring trial and not free tier, with possible recommendations on how to configure their default org locally. Can be possibly empty.
    GitHubLogin String
    Returns the organization name. Can be an empty string, if the user is a member of no organizations
    Messages List<Object>
    Messages is a list of messages that should be displayed to the user that contextualize the default org; for example: warning new users if their default org as returned by the service is on an expiring trial and not free tier, with possible recommendations on how to configure their default org locally. Can be possibly empty.
    id String
    The provider-assigned unique ID for this managed resource.
    GitHubLogin string
    Returns the organization name. Can be an empty string, if the user is a member of no organizations
    Messages any[]
    Messages is a list of messages that should be displayed to the user that contextualize the default org; for example: warning new users if their default org as returned by the service is on an expiring trial and not free tier, with possible recommendations on how to configure their default org locally. Can be possibly empty.
    id string
    The provider-assigned unique ID for this managed resource.
    git_hub_login str
    Returns the organization name. Can be an empty string, if the user is a member of no organizations
    id str
    The provider-assigned unique ID for this managed resource.
    messages Sequence[Any]
    Messages is a list of messages that should be displayed to the user that contextualize the default org; for example: warning new users if their default org as returned by the service is on an expiring trial and not free tier, with possible recommendations on how to configure their default org locally. Can be possibly empty.
    GitHubLogin String
    Returns the organization name. Can be an empty string, if the user is a member of no organizations
    Messages List<Any>
    Messages is a list of messages that should be displayed to the user that contextualize the default org; for example: warning new users if their default org as returned by the service is on an expiring trial and not free tier, with possible recommendations on how to configure their default org locally. Can be possibly empty.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo

    This provider is currently in preview.

    Viewing docs for Pulumi Cloud v1.1.0
    published on Thursday, May 21, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial