Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Temporalcloud Provider
  3. API Docs
  4. User
temporalcloud 0.6.1 published on Friday, Mar 7, 2025 by temporalio
temporalio/terraform-provider-temporalcloud

temporalcloud.User

Explore with Pulumi AI

temporalcloud logo
temporalcloud 0.6.1 published on Friday, Mar 7, 2025 by temporalio
temporalio/terraform-provider-temporalcloud

    Provisions a Temporal Cloud user.

    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,
         account_access: Optional[str] = None,
         email: Optional[str] = None,
         namespace_accesses: Optional[Sequence[UserNamespaceAccessArgs]] = None,
         timeouts: Optional[UserTimeoutsArgs] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: temporalcloud: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 Temporalcloud.User("userResource", new()
{
    AccountAccess = "string",
    Email = "string",
    NamespaceAccesses = new[]
    {
        new Temporalcloud.Inputs.UserNamespaceAccessArgs
        {
            NamespaceId = "string",
            Permission = "string",
        },
    },
    Timeouts = new Temporalcloud.Inputs.UserTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});

    example, err := temporalcloud.NewUser(ctx, "userResource", &temporalcloud.UserArgs{
AccountAccess: pulumi.String("string"),
Email: pulumi.String("string"),
NamespaceAccesses: .UserNamespaceAccessArray{
&.UserNamespaceAccessArgs{
NamespaceId: pulumi.String("string"),
Permission: pulumi.String("string"),
},
},
Timeouts: &.UserTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
},
})

    var userResource = new User("userResource", UserArgs.builder()
    .accountAccess("string")
    .email("string")
    .namespaceAccesses(UserNamespaceAccessArgs.builder()
        .namespaceId("string")
        .permission("string")
        .build())
    .timeouts(UserTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());

    user_resource = temporalcloud.User("userResource",
    account_access="string",
    email="string",
    namespace_accesses=[{
        "namespace_id": "string",
        "permission": "string",
    }],
    timeouts={
        "create": "string",
        "delete": "string",
    })

    const userResource = new temporalcloud.User("userResource", {
    accountAccess: "string",
    email: "string",
    namespaceAccesses: [{
        namespaceId: "string",
        permission: "string",
    }],
    timeouts: {
        create: "string",
        "delete": "string",
    },
});

    type: temporalcloud:User
properties:
    accountAccess: string
    email: string
    namespaceAccesses:
        - namespaceId: string
          permission: string
    timeouts:
        create: string
        delete: 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:

    AccountAccess string
    The role on the account. Must be one of owner, admin, developer, or read (case-insensitive). owner is only valid for import and cannot be created, updated or deleted without Temporal support.
    Email string
    The email address for the user.
    NamespaceAccesses List<UserNamespaceAccess>
    The set of namespace accesses. Empty sets are not allowed, omit the attribute instead. Users with account*access roles of owner or admin cannot be assigned explicit permissions to namespaces. They implicitly receive access to all Namespaces.
    Timeouts UserTimeouts
    AccountAccess string
    The role on the account. Must be one of owner, admin, developer, or read (case-insensitive). owner is only valid for import and cannot be created, updated or deleted without Temporal support.
    Email string
    The email address for the user.
    NamespaceAccesses []UserNamespaceAccessArgs
    The set of namespace accesses. Empty sets are not allowed, omit the attribute instead. Users with account*access roles of owner or admin cannot be assigned explicit permissions to namespaces. They implicitly receive access to all Namespaces.
    Timeouts UserTimeoutsArgs
    accountAccess String
    The role on the account. Must be one of owner, admin, developer, or read (case-insensitive). owner is only valid for import and cannot be created, updated or deleted without Temporal support.
    email String
    The email address for the user.
    namespaceAccesses List<UserNamespaceAccess>
    The set of namespace accesses. Empty sets are not allowed, omit the attribute instead. Users with account*access roles of owner or admin cannot be assigned explicit permissions to namespaces. They implicitly receive access to all Namespaces.
    timeouts UserTimeouts
    accountAccess string
    The role on the account. Must be one of owner, admin, developer, or read (case-insensitive). owner is only valid for import and cannot be created, updated or deleted without Temporal support.
    email string
    The email address for the user.
    namespaceAccesses UserNamespaceAccess[]
    The set of namespace accesses. Empty sets are not allowed, omit the attribute instead. Users with account*access roles of owner or admin cannot be assigned explicit permissions to namespaces. They implicitly receive access to all Namespaces.
    timeouts UserTimeouts
    account_access str
    The role on the account. Must be one of owner, admin, developer, or read (case-insensitive). owner is only valid for import and cannot be created, updated or deleted without Temporal support.
    email str
    The email address for the user.
    namespace_accesses Sequence[UserNamespaceAccessArgs]
    The set of namespace accesses. Empty sets are not allowed, omit the attribute instead. Users with account*access roles of owner or admin cannot be assigned explicit permissions to namespaces. They implicitly receive access to all Namespaces.
    timeouts UserTimeoutsArgs
    accountAccess String
    The role on the account. Must be one of owner, admin, developer, or read (case-insensitive). owner is only valid for import and cannot be created, updated or deleted without Temporal support.
    email String
    The email address for the user.
    namespaceAccesses List<Property Map>
    The set of namespace accesses. Empty sets are not allowed, omit the attribute instead. Users with account*access roles of owner or admin cannot be assigned explicit permissions to namespaces. They implicitly receive access to all Namespaces.
    timeouts Property Map

    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.
    State string
    The current state of the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the user.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the user.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current state of the user.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current state of the user.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the user.

    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,
        account_access: Optional[str] = None,
        email: Optional[str] = None,
        namespace_accesses: Optional[Sequence[UserNamespaceAccessArgs]] = None,
        state: Optional[str] = None,
        timeouts: Optional[UserTimeoutsArgs] = None) -> User
    func 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: temporalcloud: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.
    The following state arguments are supported:
    AccountAccess string
    The role on the account. Must be one of owner, admin, developer, or read (case-insensitive). owner is only valid for import and cannot be created, updated or deleted without Temporal support.
    Email string
    The email address for the user.
    NamespaceAccesses List<UserNamespaceAccess>
    The set of namespace accesses. Empty sets are not allowed, omit the attribute instead. Users with account*access roles of owner or admin cannot be assigned explicit permissions to namespaces. They implicitly receive access to all Namespaces.
    State string
    The current state of the user.
    Timeouts UserTimeouts
    AccountAccess string
    The role on the account. Must be one of owner, admin, developer, or read (case-insensitive). owner is only valid for import and cannot be created, updated or deleted without Temporal support.
    Email string
    The email address for the user.
    NamespaceAccesses []UserNamespaceAccessArgs
    The set of namespace accesses. Empty sets are not allowed, omit the attribute instead. Users with account*access roles of owner or admin cannot be assigned explicit permissions to namespaces. They implicitly receive access to all Namespaces.
    State string
    The current state of the user.
    Timeouts UserTimeoutsArgs
    accountAccess String
    The role on the account. Must be one of owner, admin, developer, or read (case-insensitive). owner is only valid for import and cannot be created, updated or deleted without Temporal support.
    email String
    The email address for the user.
    namespaceAccesses List<UserNamespaceAccess>
    The set of namespace accesses. Empty sets are not allowed, omit the attribute instead. Users with account*access roles of owner or admin cannot be assigned explicit permissions to namespaces. They implicitly receive access to all Namespaces.
    state String
    The current state of the user.
    timeouts UserTimeouts
    accountAccess string
    The role on the account. Must be one of owner, admin, developer, or read (case-insensitive). owner is only valid for import and cannot be created, updated or deleted without Temporal support.
    email string
    The email address for the user.
    namespaceAccesses UserNamespaceAccess[]
    The set of namespace accesses. Empty sets are not allowed, omit the attribute instead. Users with account*access roles of owner or admin cannot be assigned explicit permissions to namespaces. They implicitly receive access to all Namespaces.
    state string
    The current state of the user.
    timeouts UserTimeouts
    account_access str
    The role on the account. Must be one of owner, admin, developer, or read (case-insensitive). owner is only valid for import and cannot be created, updated or deleted without Temporal support.
    email str
    The email address for the user.
    namespace_accesses Sequence[UserNamespaceAccessArgs]
    The set of namespace accesses. Empty sets are not allowed, omit the attribute instead. Users with account*access roles of owner or admin cannot be assigned explicit permissions to namespaces. They implicitly receive access to all Namespaces.
    state str
    The current state of the user.
    timeouts UserTimeoutsArgs
    accountAccess String
    The role on the account. Must be one of owner, admin, developer, or read (case-insensitive). owner is only valid for import and cannot be created, updated or deleted without Temporal support.
    email String
    The email address for the user.
    namespaceAccesses List<Property Map>
    The set of namespace accesses. Empty sets are not allowed, omit the attribute instead. Users with account*access roles of owner or admin cannot be assigned explicit permissions to namespaces. They implicitly receive access to all Namespaces.
    state String
    The current state of the user.
    timeouts Property Map

    Supporting Types

    UserNamespaceAccess, UserNamespaceAccessArgs

    NamespaceId string
    The namespace to assign permissions to.
    Permission string
    The permission to assign. Must be one of admin, write, or read (case-insensitive)
    NamespaceId string
    The namespace to assign permissions to.
    Permission string
    The permission to assign. Must be one of admin, write, or read (case-insensitive)
    namespaceId String
    The namespace to assign permissions to.
    permission String
    The permission to assign. Must be one of admin, write, or read (case-insensitive)
    namespaceId string
    The namespace to assign permissions to.
    permission string
    The permission to assign. Must be one of admin, write, or read (case-insensitive)
    namespace_id str
    The namespace to assign permissions to.
    permission str
    The permission to assign. Must be one of admin, write, or read (case-insensitive)
    namespaceId String
    The namespace to assign permissions to.
    permission String
    The permission to assign. Must be one of admin, write, or read (case-insensitive)

    UserTimeouts, UserTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

    Import

    Users can be imported to incorporate existing Users into your Terraform pipeline.

    To import a User, you need

    • a resource configuration in your Terraform configuration file/module to accept the imported User. In the example below, the placeholder is “temporalcloud_user” “user”

    • the User’s ID, which is found using the Temporal Cloud CLI tcld u l. In the example below, this is 72360058153949edb2f1d47019c1e85f

    $ pulumi import temporalcloud:index/user:User user 72360058153949edb2f1d47019c1e85f

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

    Package Details

    Repository
    temporalcloud temporalio/terraform-provider-temporalcloud
    License
    Notes
    This Pulumi package is based on the temporalcloud Terraform Provider.
    temporalcloud logo
    temporalcloud 0.6.1 published on Friday, Mar 7, 2025 by temporalio
    temporalio/terraform-provider-temporalcloud