Splunk v1.2.1, May 22 23

splunk.AuthenticationUsers

Explore with Pulumi AI

# Resource: splunk.AuthenticationUsers

Create and update user information or delete the user.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Splunk = Pulumi.Splunk;

return await Deployment.RunAsync(() => 
{
    var user01 = new Splunk.AuthenticationUsers("user01", new()
    {
        Email = "user01@example.com",
        ForceChangePass = false,
        Password = "password01",
        Roles = new[]
        {
            "terraform-user01-role",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-splunk/sdk/go/splunk"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := splunk.NewAuthenticationUsers(ctx, "user01", &splunk.AuthenticationUsersArgs{
			Email:           pulumi.String("user01@example.com"),
			ForceChangePass: pulumi.Bool(false),
			Password:        pulumi.String("password01"),
			Roles: pulumi.StringArray{
				pulumi.String("terraform-user01-role"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.splunk.AuthenticationUsers;
import com.pulumi.splunk.AuthenticationUsersArgs;
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 user01 = new AuthenticationUsers("user01", AuthenticationUsersArgs.builder()        
            .email("user01@example.com")
            .forceChangePass(false)
            .password("password01")
            .roles("terraform-user01-role")
            .build());

    }
}

import pulumi
import pulumi_splunk as splunk

user01 = splunk.AuthenticationUsers("user01",
    email="user01@example.com",
    force_change_pass=False,
    password="password01",
    roles=["terraform-user01-role"])

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

const user01 = new splunk.AuthenticationUsers("user01", {
    email: "user01@example.com",
    forceChangePass: false,
    password: "password01",
    roles: ["terraform-user01-role"],
});

resources:
  user01:
    type: splunk:AuthenticationUsers
    properties:
      email: user01@example.com
      forceChangePass: false
      password: password01
      roles:
        - terraform-user01-role

Create AuthenticationUsers Resource

new AuthenticationUsers(name: string, args?: AuthenticationUsersArgs, opts?: CustomResourceOptions);

@overload
def AuthenticationUsers(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        default_app: Optional[str] = None,
                        email: Optional[str] = None,
                        force_change_pass: Optional[bool] = None,
                        name: Optional[str] = None,
                        password: Optional[str] = None,
                        realname: Optional[str] = None,
                        restart_background_jobs: Optional[bool] = None,
                        roles: Optional[Sequence[str]] = None,
                        tz: Optional[str] = None)
@overload
def AuthenticationUsers(resource_name: str,
                        args: Optional[AuthenticationUsersArgs] = None,
                        opts: Optional[ResourceOptions] = None)

func NewAuthenticationUsers(ctx *Context, name string, args *AuthenticationUsersArgs, opts ...ResourceOption) (*AuthenticationUsers, error)

public AuthenticationUsers(string name, AuthenticationUsersArgs? args = null, CustomResourceOptions? opts = null)

public AuthenticationUsers(String name, AuthenticationUsersArgs args)
public AuthenticationUsers(String name, AuthenticationUsersArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args AuthenticationUsersArgs: 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 AuthenticationUsersArgs: 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 AuthenticationUsersArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AuthenticationUsersArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AuthenticationUsersArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

AuthenticationUsers Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The AuthenticationUsers resource accepts the following input properties:

DefaultApp string: User default app. Overrides the default app inherited from the user roles.
Email string: User email address.
ForceChangePass bool: Force user to change password indication
Name string: Unique user login name.
Password string: User login password.
Realname string: Full user name.
RestartBackgroundJobs bool: Restart background search job that has not completed when Splunk restarts indication.
Roles List<string>: Role to assign to this user. At least one existing role is required.
Tz string: User timezone.

DefaultApp string: User default app. Overrides the default app inherited from the user roles.
Email string: User email address.
ForceChangePass bool: Force user to change password indication
Name string: Unique user login name.
Password string: User login password.
Realname string: Full user name.
RestartBackgroundJobs bool: Restart background search job that has not completed when Splunk restarts indication.
Roles []string: Role to assign to this user. At least one existing role is required.
Tz string: User timezone.

defaultApp String: User default app. Overrides the default app inherited from the user roles.
email String: User email address.
forceChangePass Boolean: Force user to change password indication
name String: Unique user login name.
password String: User login password.
realname String: Full user name.
restartBackgroundJobs Boolean: Restart background search job that has not completed when Splunk restarts indication.
roles List<String>: Role to assign to this user. At least one existing role is required.
tz String: User timezone.

defaultApp string: User default app. Overrides the default app inherited from the user roles.
email string: User email address.
forceChangePass boolean: Force user to change password indication
name string: Unique user login name.
password string: User login password.
realname string: Full user name.
restartBackgroundJobs boolean: Restart background search job that has not completed when Splunk restarts indication.
roles string[]: Role to assign to this user. At least one existing role is required.
tz string: User timezone.

default_app str: User default app. Overrides the default app inherited from the user roles.
email str: User email address.
force_change_pass bool: Force user to change password indication
name str: Unique user login name.
password str: User login password.
realname str: Full user name.
restart_background_jobs bool: Restart background search job that has not completed when Splunk restarts indication.
roles Sequence[str]: Role to assign to this user. At least one existing role is required.
tz str: User timezone.

defaultApp String: User default app. Overrides the default app inherited from the user roles.
email String: User email address.
forceChangePass Boolean: Force user to change password indication
name String: Unique user login name.
password String: User login password.
realname String: Full user name.
restartBackgroundJobs Boolean: Restart background search job that has not completed when Splunk restarts indication.
roles List<String>: Role to assign to this user. At least one existing role is required.
tz String: User timezone.

Outputs

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

Get an existing AuthenticationUsers 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?: AuthenticationUsersState, opts?: CustomResourceOptions): AuthenticationUsers

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        default_app: Optional[str] = None,
        email: Optional[str] = None,
        force_change_pass: Optional[bool] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        realname: Optional[str] = None,
        restart_background_jobs: Optional[bool] = None,
        roles: Optional[Sequence[str]] = None,
        tz: Optional[str] = None) -> AuthenticationUsers

func GetAuthenticationUsers(ctx *Context, name string, id IDInput, state *AuthenticationUsersState, opts ...ResourceOption) (*AuthenticationUsers, error)

public static AuthenticationUsers Get(string name, Input<string> id, AuthenticationUsersState? state, CustomResourceOptions? opts = null)

public static AuthenticationUsers get(String name, Output<String> id, AuthenticationUsersState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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:

DefaultApp string: User default app. Overrides the default app inherited from the user roles.
Email string: User email address.
ForceChangePass bool: Force user to change password indication
Name string: Unique user login name.
Password string: User login password.
Realname string: Full user name.
RestartBackgroundJobs bool: Restart background search job that has not completed when Splunk restarts indication.
Roles List<string>: Role to assign to this user. At least one existing role is required.
Tz string: User timezone.

DefaultApp string: User default app. Overrides the default app inherited from the user roles.
Email string: User email address.
ForceChangePass bool: Force user to change password indication
Name string: Unique user login name.
Password string: User login password.
Realname string: Full user name.
RestartBackgroundJobs bool: Restart background search job that has not completed when Splunk restarts indication.
Roles []string: Role to assign to this user. At least one existing role is required.
Tz string: User timezone.

defaultApp String: User default app. Overrides the default app inherited from the user roles.
email String: User email address.
forceChangePass Boolean: Force user to change password indication
name String: Unique user login name.
password String: User login password.
realname String: Full user name.
restartBackgroundJobs Boolean: Restart background search job that has not completed when Splunk restarts indication.
roles List<String>: Role to assign to this user. At least one existing role is required.
tz String: User timezone.

defaultApp string: User default app. Overrides the default app inherited from the user roles.
email string: User email address.
forceChangePass boolean: Force user to change password indication
name string: Unique user login name.
password string: User login password.
realname string: Full user name.
restartBackgroundJobs boolean: Restart background search job that has not completed when Splunk restarts indication.
roles string[]: Role to assign to this user. At least one existing role is required.
tz string: User timezone.

default_app str: User default app. Overrides the default app inherited from the user roles.
email str: User email address.
force_change_pass bool: Force user to change password indication
name str: Unique user login name.
password str: User login password.
realname str: Full user name.
restart_background_jobs bool: Restart background search job that has not completed when Splunk restarts indication.
roles Sequence[str]: Role to assign to this user. At least one existing role is required.
tz str: User timezone.

defaultApp String: User default app. Overrides the default app inherited from the user roles.
email String: User email address.
forceChangePass Boolean: Force user to change password indication
name String: Unique user login name.
password String: User login password.
realname String: Full user name.
restartBackgroundJobs Boolean: Restart background search job that has not completed when Splunk restarts indication.
roles List<String>: Role to assign to this user. At least one existing role is required.
tz String: User timezone.

Package Details

Repository: Splunk pulumi/pulumi-splunk
License: Apache-2.0
Notes: This Pulumi package is based on the splunk Terraform Provider.