1. Packages
  2. Grafana Cloud
  3. API Docs
  4. cloud
  5. OrgMember
Grafana v0.16.3 published on Monday, Apr 7, 2025 by pulumiverse

grafana.cloud.OrgMember

Explore with Pulumi AI

Manages the membership of a user in an organization.

Create OrgMember Resource

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

Constructor syntax

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

@overload
def OrgMember(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              org: Optional[str] = None,
              role: Optional[str] = None,
              user: Optional[str] = None,
              receive_billing_emails: Optional[bool] = None)
func NewOrgMember(ctx *Context, name string, args OrgMemberArgs, opts ...ResourceOption) (*OrgMember, error)
public OrgMember(string name, OrgMemberArgs args, CustomResourceOptions? opts = null)
public OrgMember(String name, OrgMemberArgs args)
public OrgMember(String name, OrgMemberArgs args, CustomResourceOptions options)
type: grafana:cloud:OrgMember
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. OrgMemberArgs
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. OrgMemberArgs
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. OrgMemberArgs
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. OrgMemberArgs
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. OrgMemberArgs
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 orgMemberResource = new Grafana.Cloud.OrgMember("orgMemberResource", new()
{
    Org = "string",
    Role = "string",
    User = "string",
    ReceiveBillingEmails = false,
});
Copy
example, err := cloud.NewOrgMember(ctx, "orgMemberResource", &cloud.OrgMemberArgs{
	Org:                  pulumi.String("string"),
	Role:                 pulumi.String("string"),
	User:                 pulumi.String("string"),
	ReceiveBillingEmails: pulumi.Bool(false),
})
Copy
var orgMemberResource = new OrgMember("orgMemberResource", OrgMemberArgs.builder()
    .org("string")
    .role("string")
    .user("string")
    .receiveBillingEmails(false)
    .build());
Copy
org_member_resource = grafana.cloud.OrgMember("orgMemberResource",
    org="string",
    role="string",
    user="string",
    receive_billing_emails=False)
Copy
const orgMemberResource = new grafana.cloud.OrgMember("orgMemberResource", {
    org: "string",
    role: "string",
    user: "string",
    receiveBillingEmails: false,
});
Copy
type: grafana:cloud:OrgMember
properties:
    org: string
    receiveBillingEmails: false
    role: string
    user: string
Copy

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

Org This property is required. string
The slug or ID of the organization.
Role This property is required. string
The role to assign to the user in the organization.
User This property is required. string
Username or ID of the user to add to the org's members.
ReceiveBillingEmails bool
Whether the user should receive billing emails.
Org This property is required. string
The slug or ID of the organization.
Role This property is required. string
The role to assign to the user in the organization.
User This property is required. string
Username or ID of the user to add to the org's members.
ReceiveBillingEmails bool
Whether the user should receive billing emails.
org This property is required. String
The slug or ID of the organization.
role This property is required. String
The role to assign to the user in the organization.
user This property is required. String
Username or ID of the user to add to the org's members.
receiveBillingEmails Boolean
Whether the user should receive billing emails.
org This property is required. string
The slug or ID of the organization.
role This property is required. string
The role to assign to the user in the organization.
user This property is required. string
Username or ID of the user to add to the org's members.
receiveBillingEmails boolean
Whether the user should receive billing emails.
org This property is required. str
The slug or ID of the organization.
role This property is required. str
The role to assign to the user in the organization.
user This property is required. str
Username or ID of the user to add to the org's members.
receive_billing_emails bool
Whether the user should receive billing emails.
org This property is required. String
The slug or ID of the organization.
role This property is required. String
The role to assign to the user in the organization.
user This property is required. String
Username or ID of the user to add to the org's members.
receiveBillingEmails Boolean
Whether the user should receive billing emails.

Outputs

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

Get an existing OrgMember 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?: OrgMemberState, opts?: CustomResourceOptions): OrgMember
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        org: Optional[str] = None,
        receive_billing_emails: Optional[bool] = None,
        role: Optional[str] = None,
        user: Optional[str] = None) -> OrgMember
func GetOrgMember(ctx *Context, name string, id IDInput, state *OrgMemberState, opts ...ResourceOption) (*OrgMember, error)
public static OrgMember Get(string name, Input<string> id, OrgMemberState? state, CustomResourceOptions? opts = null)
public static OrgMember get(String name, Output<String> id, OrgMemberState state, CustomResourceOptions options)
resources:  _:    type: grafana:cloud:OrgMember    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:
Org string
The slug or ID of the organization.
ReceiveBillingEmails bool
Whether the user should receive billing emails.
Role string
The role to assign to the user in the organization.
User string
Username or ID of the user to add to the org's members.
Org string
The slug or ID of the organization.
ReceiveBillingEmails bool
Whether the user should receive billing emails.
Role string
The role to assign to the user in the organization.
User string
Username or ID of the user to add to the org's members.
org String
The slug or ID of the organization.
receiveBillingEmails Boolean
Whether the user should receive billing emails.
role String
The role to assign to the user in the organization.
user String
Username or ID of the user to add to the org's members.
org string
The slug or ID of the organization.
receiveBillingEmails boolean
Whether the user should receive billing emails.
role string
The role to assign to the user in the organization.
user string
Username or ID of the user to add to the org's members.
org str
The slug or ID of the organization.
receive_billing_emails bool
Whether the user should receive billing emails.
role str
The role to assign to the user in the organization.
user str
Username or ID of the user to add to the org's members.
org String
The slug or ID of the organization.
receiveBillingEmails Boolean
Whether the user should receive billing emails.
role String
The role to assign to the user in the organization.
user String
Username or ID of the user to add to the org's members.

Import

$ pulumi import grafana:cloud/orgMember:OrgMember name "{{ orgSlugOrID }}:{{ usernameOrID }}"
Copy

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

Package Details

Repository
grafana pulumiverse/pulumi-grafana
License
Apache-2.0
Notes
This Pulumi package is based on the grafana Terraform Provider.