1. Packages
  2. Ibm Provider
  3. API Docs
  4. Org
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.Org

Explore with Pulumi AI

Create Org Resource

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

Constructor syntax

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

@overload
def Org(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        auditors: Optional[Sequence[str]] = None,
        billing_managers: Optional[Sequence[str]] = None,
        managers: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        org_quota_definition_guid: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        users: Optional[Sequence[str]] = None)
func NewOrg(ctx *Context, name string, args *OrgArgs, opts ...ResourceOption) (*Org, error)
public Org(string name, OrgArgs? args = null, CustomResourceOptions? opts = null)
public Org(String name, OrgArgs args)
public Org(String name, OrgArgs args, CustomResourceOptions options)
type: ibm:Org
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 OrgArgs
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 OrgArgs
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 OrgArgs
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 OrgArgs
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. OrgArgs
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 orgResource = new Ibm.Org("orgResource", new()
{
    Auditors = new[]
    {
        "string",
    },
    BillingManagers = new[]
    {
        "string",
    },
    Managers = new[]
    {
        "string",
    },
    Name = "string",
    OrgId = "string",
    OrgQuotaDefinitionGuid = "string",
    Tags = new[]
    {
        "string",
    },
    Users = new[]
    {
        "string",
    },
});
Copy
example, err := ibm.NewOrg(ctx, "orgResource", &ibm.OrgArgs{
Auditors: pulumi.StringArray{
pulumi.String("string"),
},
BillingManagers: pulumi.StringArray{
pulumi.String("string"),
},
Managers: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
OrgId: pulumi.String("string"),
OrgQuotaDefinitionGuid: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Users: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var orgResource = new Org("orgResource", OrgArgs.builder()
    .auditors("string")
    .billingManagers("string")
    .managers("string")
    .name("string")
    .orgId("string")
    .orgQuotaDefinitionGuid("string")
    .tags("string")
    .users("string")
    .build());
Copy
org_resource = ibm.Org("orgResource",
    auditors=["string"],
    billing_managers=["string"],
    managers=["string"],
    name="string",
    org_id="string",
    org_quota_definition_guid="string",
    tags=["string"],
    users=["string"])
Copy
const orgResource = new ibm.Org("orgResource", {
    auditors: ["string"],
    billingManagers: ["string"],
    managers: ["string"],
    name: "string",
    orgId: "string",
    orgQuotaDefinitionGuid: "string",
    tags: ["string"],
    users: ["string"],
});
Copy
type: ibm:Org
properties:
    auditors:
        - string
    billingManagers:
        - string
    managers:
        - string
    name: string
    orgId: string
    orgQuotaDefinitionGuid: string
    tags:
        - string
    users:
        - string
Copy

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

Auditors List<string>
The IBMID of the users who will have auditor role in this org, ex - user@example.com
BillingManagers List<string>
The IBMID of the users who will have billing manager role in this org, ex - user@example.com
Managers List<string>
The IBMID of the users who will have manager role in this org, ex - user@example.com
Name string
Org name, for example myorg@domain
OrgId string
OrgQuotaDefinitionGuid string
Org quota guid
Tags List<string>
Users List<string>
The IBMID of the users who will have user role in this org, ex - user@example.com
Auditors []string
The IBMID of the users who will have auditor role in this org, ex - user@example.com
BillingManagers []string
The IBMID of the users who will have billing manager role in this org, ex - user@example.com
Managers []string
The IBMID of the users who will have manager role in this org, ex - user@example.com
Name string
Org name, for example myorg@domain
OrgId string
OrgQuotaDefinitionGuid string
Org quota guid
Tags []string
Users []string
The IBMID of the users who will have user role in this org, ex - user@example.com
auditors List<String>
The IBMID of the users who will have auditor role in this org, ex - user@example.com
billingManagers List<String>
The IBMID of the users who will have billing manager role in this org, ex - user@example.com
managers List<String>
The IBMID of the users who will have manager role in this org, ex - user@example.com
name String
Org name, for example myorg@domain
orgId String
orgQuotaDefinitionGuid String
Org quota guid
tags List<String>
users List<String>
The IBMID of the users who will have user role in this org, ex - user@example.com
auditors string[]
The IBMID of the users who will have auditor role in this org, ex - user@example.com
billingManagers string[]
The IBMID of the users who will have billing manager role in this org, ex - user@example.com
managers string[]
The IBMID of the users who will have manager role in this org, ex - user@example.com
name string
Org name, for example myorg@domain
orgId string
orgQuotaDefinitionGuid string
Org quota guid
tags string[]
users string[]
The IBMID of the users who will have user role in this org, ex - user@example.com
auditors Sequence[str]
The IBMID of the users who will have auditor role in this org, ex - user@example.com
billing_managers Sequence[str]
The IBMID of the users who will have billing manager role in this org, ex - user@example.com
managers Sequence[str]
The IBMID of the users who will have manager role in this org, ex - user@example.com
name str
Org name, for example myorg@domain
org_id str
org_quota_definition_guid str
Org quota guid
tags Sequence[str]
users Sequence[str]
The IBMID of the users who will have user role in this org, ex - user@example.com
auditors List<String>
The IBMID of the users who will have auditor role in this org, ex - user@example.com
billingManagers List<String>
The IBMID of the users who will have billing manager role in this org, ex - user@example.com
managers List<String>
The IBMID of the users who will have manager role in this org, ex - user@example.com
name String
Org name, for example myorg@domain
orgId String
orgQuotaDefinitionGuid String
Org quota guid
tags List<String>
users List<String>
The IBMID of the users who will have user role in this org, ex - user@example.com

Outputs

All input properties are implicitly available as output properties. Additionally, the Org 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 Org Resource

Get an existing Org 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?: OrgState, opts?: CustomResourceOptions): Org
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auditors: Optional[Sequence[str]] = None,
        billing_managers: Optional[Sequence[str]] = None,
        managers: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        org_quota_definition_guid: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        users: Optional[Sequence[str]] = None) -> Org
func GetOrg(ctx *Context, name string, id IDInput, state *OrgState, opts ...ResourceOption) (*Org, error)
public static Org Get(string name, Input<string> id, OrgState? state, CustomResourceOptions? opts = null)
public static Org get(String name, Output<String> id, OrgState state, CustomResourceOptions options)
resources:  _:    type: ibm:Org    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>
The IBMID of the users who will have auditor role in this org, ex - user@example.com
BillingManagers List<string>
The IBMID of the users who will have billing manager role in this org, ex - user@example.com
Managers List<string>
The IBMID of the users who will have manager role in this org, ex - user@example.com
Name string
Org name, for example myorg@domain
OrgId string
OrgQuotaDefinitionGuid string
Org quota guid
Tags List<string>
Users List<string>
The IBMID of the users who will have user role in this org, ex - user@example.com
Auditors []string
The IBMID of the users who will have auditor role in this org, ex - user@example.com
BillingManagers []string
The IBMID of the users who will have billing manager role in this org, ex - user@example.com
Managers []string
The IBMID of the users who will have manager role in this org, ex - user@example.com
Name string
Org name, for example myorg@domain
OrgId string
OrgQuotaDefinitionGuid string
Org quota guid
Tags []string
Users []string
The IBMID of the users who will have user role in this org, ex - user@example.com
auditors List<String>
The IBMID of the users who will have auditor role in this org, ex - user@example.com
billingManagers List<String>
The IBMID of the users who will have billing manager role in this org, ex - user@example.com
managers List<String>
The IBMID of the users who will have manager role in this org, ex - user@example.com
name String
Org name, for example myorg@domain
orgId String
orgQuotaDefinitionGuid String
Org quota guid
tags List<String>
users List<String>
The IBMID of the users who will have user role in this org, ex - user@example.com
auditors string[]
The IBMID of the users who will have auditor role in this org, ex - user@example.com
billingManagers string[]
The IBMID of the users who will have billing manager role in this org, ex - user@example.com
managers string[]
The IBMID of the users who will have manager role in this org, ex - user@example.com
name string
Org name, for example myorg@domain
orgId string
orgQuotaDefinitionGuid string
Org quota guid
tags string[]
users string[]
The IBMID of the users who will have user role in this org, ex - user@example.com
auditors Sequence[str]
The IBMID of the users who will have auditor role in this org, ex - user@example.com
billing_managers Sequence[str]
The IBMID of the users who will have billing manager role in this org, ex - user@example.com
managers Sequence[str]
The IBMID of the users who will have manager role in this org, ex - user@example.com
name str
Org name, for example myorg@domain
org_id str
org_quota_definition_guid str
Org quota guid
tags Sequence[str]
users Sequence[str]
The IBMID of the users who will have user role in this org, ex - user@example.com
auditors List<String>
The IBMID of the users who will have auditor role in this org, ex - user@example.com
billingManagers List<String>
The IBMID of the users who will have billing manager role in this org, ex - user@example.com
managers List<String>
The IBMID of the users who will have manager role in this org, ex - user@example.com
name String
Org name, for example myorg@domain
orgId String
orgQuotaDefinitionGuid String
Org quota guid
tags List<String>
users List<String>
The IBMID of the users who will have user role in this org, ex - user@example.com

Package Details

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