Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudfoundry Provider
  3. API Docs
  4. OrgUsers
cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community
cloudfoundry-community/terraform-provider-cloudfoundry

cloudfoundry.OrgUsers

Explore with Pulumi AI

cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community
cloudfoundry-community/terraform-provider-cloudfoundry

Provides a Cloud Foundry resource for managing Cloud Foundry organizations members.

NOTE: This resource requires the provider to be authenticated with an account granted admin permissions. NOTE: Only modify users managed in the resource, and ignore any existing other users provisioned elsewhere if not using force attribute.

Example Usage

The following example creates an org with a specific org-wide quota.

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

const ou1 = new cloudfoundry.OrgUsers("ou1", {
    auditors: [
        "user-guid",
        "username",
    ],
    billingManagers: [
        "user-guid",
        "username",
    ],
    managers: [
        "user-guid",
        "username",
    ],
    org: "organization-id",
});
Copy
import pulumi
import pulumi_cloudfoundry as cloudfoundry

ou1 = cloudfoundry.OrgUsers("ou1",
    auditors=[
        "user-guid",
        "username",
    ],
    billing_managers=[
        "user-guid",
        "username",
    ],
    managers=[
        "user-guid",
        "username",
    ],
    org="organization-id")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudfoundry.NewOrgUsers(ctx, "ou1", &cloudfoundry.OrgUsersArgs{
			Auditors: pulumi.StringArray{
				pulumi.String("user-guid"),
				pulumi.String("username"),
			},
			BillingManagers: pulumi.StringArray{
				pulumi.String("user-guid"),
				pulumi.String("username"),
			},
			Managers: pulumi.StringArray{
				pulumi.String("user-guid"),
				pulumi.String("username"),
			},
			Org: pulumi.String("organization-id"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudfoundry = Pulumi.Cloudfoundry;

return await Deployment.RunAsync(() => 
{
    var ou1 = new Cloudfoundry.OrgUsers("ou1", new()
    {
        Auditors = new[]
        {
            "user-guid",
            "username",
        },
        BillingManagers = new[]
        {
            "user-guid",
            "username",
        },
        Managers = new[]
        {
            "user-guid",
            "username",
        },
        Org = "organization-id",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudfoundry.OrgUsers;
import com.pulumi.cloudfoundry.OrgUsersArgs;
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) {
        var ou1 = new OrgUsers("ou1", OrgUsersArgs.builder()
            .auditors(            
                "user-guid",
                "username")
            .billingManagers(            
                "user-guid",
                "username")
            .managers(            
                "user-guid",
                "username")
            .org("organization-id")
            .build());

    }
}
Copy
resources:
  ou1:
    type: cloudfoundry:OrgUsers
    properties:
      auditors:
        - user-guid
        - username
      billingManagers:
        - user-guid
        - username
      managers:
        - user-guid
        - username
      org: organization-id
Copy

Create OrgUsers Resource

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

Constructor syntax

new OrgUsers(name: string, args: OrgUsersArgs, opts?: CustomResourceOptions);
@overload
def OrgUsers(resource_name: str,
             args: OrgUsersArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def OrgUsers(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             org: Optional[str] = None,
             auditors: Optional[Sequence[str]] = None,
             billing_managers: Optional[Sequence[str]] = None,
             force: Optional[bool] = None,
             managers: Optional[Sequence[str]] = None,
             org_users_id: Optional[str] = None)
func NewOrgUsers(ctx *Context, name string, args OrgUsersArgs, opts ...ResourceOption) (*OrgUsers, error)
public OrgUsers(string name, OrgUsersArgs args, CustomResourceOptions? opts = null)
public OrgUsers(String name, OrgUsersArgs args)
public OrgUsers(String name, OrgUsersArgs args, CustomResourceOptions options)

type: cloudfoundry:OrgUsers
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. OrgUsersArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. OrgUsersArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. OrgUsersArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OrgUsersArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OrgUsersArgs
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 orgUsersResource = new Cloudfoundry.OrgUsers("orgUsersResource", new()
{
    Org = "string",
    Auditors = new[]
    {
        "string",
    },
    BillingManagers = new[]
    {
        "string",
    },
    Force = false,
    Managers = new[]
    {
        "string",
    },
    OrgUsersId = "string",
});
Copy
example, err := cloudfoundry.NewOrgUsers(ctx, "orgUsersResource", &cloudfoundry.OrgUsersArgs{
Org: pulumi.String("string"),
Auditors: pulumi.StringArray{
pulumi.String("string"),
},
BillingManagers: pulumi.StringArray{
pulumi.String("string"),
},
Force: pulumi.Bool(false),
Managers: pulumi.StringArray{
pulumi.String("string"),
},
OrgUsersId: pulumi.String("string"),
})
Copy
var orgUsersResource = new OrgUsers("orgUsersResource", OrgUsersArgs.builder()
    .org("string")
    .auditors("string")
    .billingManagers("string")
    .force(false)
    .managers("string")
    .orgUsersId("string")
    .build());
Copy
org_users_resource = cloudfoundry.OrgUsers("orgUsersResource",
    org="string",
    auditors=["string"],
    billing_managers=["string"],
    force=False,
    managers=["string"],
    org_users_id="string")
Copy
const orgUsersResource = new cloudfoundry.OrgUsers("orgUsersResource", {
    org: "string",
    auditors: ["string"],
    billingManagers: ["string"],
    force: false,
    managers: ["string"],
    orgUsersId: "string",
});
Copy
type: cloudfoundry:OrgUsers
properties:
    auditors:
        - string
    billingManagers:
        - string
    force: false
    managers:
        - string
    org: string
    orgUsersId: string
Copy

OrgUsers 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 OrgUsers resource accepts the following input properties:

Org This property is required. string
Organization associated guid.
Auditors List<string>
List of ID of users to assign OrgAuditor role to. By default, no auditors are assigned.
BillingManagers List<string>
List of ID of users to assign BillingManager role to. By default, no billing managers are assigned.
Force bool

Set to true to enforce that users defined here will be only theses users defined (remove users roles from external modification).

NOTE: User can be either an uua guid or a username as cloud foundry treat them both as valid identifier

Managers List<string>
List of users to assign OrgManager role to. By default, no managers are assigned.
OrgUsersId string
Org This property is required. string
Organization associated guid.
Auditors []string
List of ID of users to assign OrgAuditor role to. By default, no auditors are assigned.
BillingManagers []string
List of ID of users to assign BillingManager role to. By default, no billing managers are assigned.
Force bool

Set to true to enforce that users defined here will be only theses users defined (remove users roles from external modification).

NOTE: User can be either an uua guid or a username as cloud foundry treat them both as valid identifier

Managers []string
List of users to assign OrgManager role to. By default, no managers are assigned.
OrgUsersId string
org This property is required. String
Organization associated guid.
auditors List<String>
List of ID of users to assign OrgAuditor role to. By default, no auditors are assigned.
billingManagers List<String>
List of ID of users to assign BillingManager role to. By default, no billing managers are assigned.
force Boolean

Set to true to enforce that users defined here will be only theses users defined (remove users roles from external modification).

NOTE: User can be either an uua guid or a username as cloud foundry treat them both as valid identifier

managers List<String>
List of users to assign OrgManager role to. By default, no managers are assigned.
orgUsersId String
org This property is required. string
Organization associated guid.
auditors string[]
List of ID of users to assign OrgAuditor role to. By default, no auditors are assigned.
billingManagers string[]
List of ID of users to assign BillingManager role to. By default, no billing managers are assigned.
force boolean

Set to true to enforce that users defined here will be only theses users defined (remove users roles from external modification).

NOTE: User can be either an uua guid or a username as cloud foundry treat them both as valid identifier

managers string[]
List of users to assign OrgManager role to. By default, no managers are assigned.
orgUsersId string
org This property is required. str
Organization associated guid.
auditors Sequence[str]
List of ID of users to assign OrgAuditor role to. By default, no auditors are assigned.
billing_managers Sequence[str]
List of ID of users to assign BillingManager role to. By default, no billing managers are assigned.
force bool

Set to true to enforce that users defined here will be only theses users defined (remove users roles from external modification).

NOTE: User can be either an uua guid or a username as cloud foundry treat them both as valid identifier

managers Sequence[str]
List of users to assign OrgManager role to. By default, no managers are assigned.
org_users_id str
org This property is required. String
Organization associated guid.
auditors List<String>
List of ID of users to assign OrgAuditor role to. By default, no auditors are assigned.
billingManagers List<String>
List of ID of users to assign BillingManager role to. By default, no billing managers are assigned.
force Boolean

Set to true to enforce that users defined here will be only theses users defined (remove users roles from external modification).

NOTE: User can be either an uua guid or a username as cloud foundry treat them both as valid identifier

managers List<String>
List of users to assign OrgManager role to. By default, no managers are assigned.
orgUsersId String

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing OrgUsers Resource

Get an existing OrgUsers resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OrgUsersState, opts?: CustomResourceOptions): OrgUsers
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auditors: Optional[Sequence[str]] = None,
        billing_managers: Optional[Sequence[str]] = None,
        force: Optional[bool] = None,
        managers: Optional[Sequence[str]] = None,
        org: Optional[str] = None,
        org_users_id: Optional[str] = None) -> OrgUsers
func GetOrgUsers(ctx *Context, name string, id IDInput, state *OrgUsersState, opts ...ResourceOption) (*OrgUsers, error)
public static OrgUsers Get(string name, Input<string> id, OrgUsersState? state, CustomResourceOptions? opts = null)
public static OrgUsers get(String name, Output<String> id, OrgUsersState state, CustomResourceOptions options)
resources:  _:    type: cloudfoundry:OrgUsers    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Auditors List<string>
List of ID of users to assign OrgAuditor role to. By default, no auditors are assigned.
BillingManagers List<string>
List of ID of users to assign BillingManager role to. By default, no billing managers are assigned.
Force bool

Set to true to enforce that users defined here will be only theses users defined (remove users roles from external modification).

NOTE: User can be either an uua guid or a username as cloud foundry treat them both as valid identifier

Managers List<string>
List of users to assign OrgManager role to. By default, no managers are assigned.
Org string
Organization associated guid.
OrgUsersId string
Auditors []string
List of ID of users to assign OrgAuditor role to. By default, no auditors are assigned.
BillingManagers []string
List of ID of users to assign BillingManager role to. By default, no billing managers are assigned.
Force bool

Set to true to enforce that users defined here will be only theses users defined (remove users roles from external modification).

NOTE: User can be either an uua guid or a username as cloud foundry treat them both as valid identifier

Managers []string
List of users to assign OrgManager role to. By default, no managers are assigned.
Org string
Organization associated guid.
OrgUsersId string
auditors List<String>
List of ID of users to assign OrgAuditor role to. By default, no auditors are assigned.
billingManagers List<String>
List of ID of users to assign BillingManager role to. By default, no billing managers are assigned.
force Boolean

Set to true to enforce that users defined here will be only theses users defined (remove users roles from external modification).

NOTE: User can be either an uua guid or a username as cloud foundry treat them both as valid identifier

managers List<String>
List of users to assign OrgManager role to. By default, no managers are assigned.
org String
Organization associated guid.
orgUsersId String
auditors string[]
List of ID of users to assign OrgAuditor role to. By default, no auditors are assigned.
billingManagers string[]
List of ID of users to assign BillingManager role to. By default, no billing managers are assigned.
force boolean

Set to true to enforce that users defined here will be only theses users defined (remove users roles from external modification).

NOTE: User can be either an uua guid or a username as cloud foundry treat them both as valid identifier

managers string[]
List of users to assign OrgManager role to. By default, no managers are assigned.
org string
Organization associated guid.
orgUsersId string
auditors Sequence[str]
List of ID of users to assign OrgAuditor role to. By default, no auditors are assigned.
billing_managers Sequence[str]
List of ID of users to assign BillingManager role to. By default, no billing managers are assigned.
force bool

Set to true to enforce that users defined here will be only theses users defined (remove users roles from external modification).

NOTE: User can be either an uua guid or a username as cloud foundry treat them both as valid identifier

managers Sequence[str]
List of users to assign OrgManager role to. By default, no managers are assigned.
org str
Organization associated guid.
org_users_id str
auditors List<String>
List of ID of users to assign OrgAuditor role to. By default, no auditors are assigned.
billingManagers List<String>
List of ID of users to assign BillingManager role to. By default, no billing managers are assigned.
force Boolean

Set to true to enforce that users defined here will be only theses users defined (remove users roles from external modification).

NOTE: User can be either an uua guid or a username as cloud foundry treat them both as valid identifier

managers List<String>
List of users to assign OrgManager role to. By default, no managers are assigned.
org String
Organization associated guid.
orgUsersId String

Import

An existing Users list can be imported using its organization guid, e.g.

bash

$ pulumi import cloudfoundry:index/orgUsers:OrgUsers ou1 org-guid
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
cloudfoundry cloudfoundry-community/terraform-provider-cloudfoundry
License
Notes
This Pulumi package is based on the cloudfoundry Terraform Provider.
cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community
cloudfoundry-community/terraform-provider-cloudfoundry