Docs Home
InfluxDB v1.5.0 published on Wednesday, Jul 2, 2025 by komminarlabs
influxdb.User
Explore with Pulumi AI
Creates and manages a user with optional organization membership. Supports adding users as members or owners of organizations.
Note: InfluxDB Cloud doesn’t let you manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update your password.
Create User Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new User(name: string, args: UserArgs, opts?: CustomResourceOptions);@overload
def User(resource_name: str,
args: UserArgs,
opts: Optional[ResourceOptions] = None)
@overload
def User(resource_name: str,
opts: Optional[ResourceOptions] = None,
password: Optional[str] = None,
name: Optional[str] = None,
org_id: Optional[str] = None,
org_role: Optional[str] = None,
status: Optional[str] = None)func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)public User(string name, UserArgs args, CustomResourceOptions? opts = null)type: influxdb:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args UserArgs
- 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 UserArgs
- 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 UserArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UserArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args UserArgs
- 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 userResource = new InfluxDB.User("userResource", new()
{
Password = "string",
Name = "string",
OrgId = "string",
OrgRole = "string",
Status = "string",
});
example, err := influxdb.NewUser(ctx, "userResource", &influxdb.UserArgs{
Password: pulumi.String("string"),
Name: pulumi.String("string"),
OrgId: pulumi.String("string"),
OrgRole: pulumi.String("string"),
Status: pulumi.String("string"),
})
var userResource = new User("userResource", UserArgs.builder()
.password("string")
.name("string")
.orgId("string")
.orgRole("string")
.status("string")
.build());
user_resource = influxdb.User("userResource",
password="string",
name="string",
org_id="string",
org_role="string",
status="string")
const userResource = new influxdb.User("userResource", {
password: "string",
name: "string",
orgId: "string",
orgRole: "string",
status: "string",
});
type: influxdb:User
properties:
name: string
orgId: string
orgRole: string
password: string
status: string
User 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 User resource accepts the following input properties:
Outputs
All input properties are implicitly available as output properties. Additionally, the User 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 User Resource
Get an existing User 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?: UserState, opts?: CustomResourceOptions): User@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = None,
org_id: Optional[str] = None,
org_role: Optional[str] = None,
password: Optional[str] = None,
status: Optional[str] = None) -> Userfunc GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)resources: _: type: influxdb:User get: id: ${id}- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
Package Details
- Repository
- influxdb komminarlabs/pulumi-influxdb
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
influxdbTerraform Provider.