com.splunk

Class UserCollection

java.lang.Object

com.splunk.Resource

com.splunk.ResourceCollection<T>

com.splunk.EntityCollection<User>

com.splunk.UserCollection

All Implemented Interfaces:

Map<String,User>

public class UserCollection
extends EntityCollection<User>

The UserCollection class represents a collection of Splunk users who are registered on the current Splunk server.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.splunk.ResourceCollection

itemClass, items

Fields inherited from class com.splunk.Resource

actions, path, refreshArgs, service, title, updated

Method Summary

Modifier and Type	Method and Description
User	create(String name, String password, String role) Creates a new Splunk user from a username, password, and role.
User	create(String name, String password, String[] roles) Creates a new Splunk user from a username, password, and array of roles.
User	create(String name, String password, String[] roles, Map args) Creates a new Splunk user from a username, password, array of roles, and additional arguments.
User	create(String name, String password, String role, Map args) Creates a new Splunk user from a username, password, role, and additional arguments.

Methods inherited from class com.splunk.EntityCollection

create, create, remove, remove

Methods inherited from class com.splunk.ResourceCollection

clear, containsKey, containsKey, containsValue, createItem, createItem, entrySet, equals, get, get, hashCode, isEmpty, itemKey, itemPath, keySet, list, put, putAll, refresh, remove, size, validate, values, valueSize

Methods inherited from class com.splunk.Resource

getName, getPath, getService, getTitle, getUpdated, invalidate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Detail

create

public User create(String name,
                   String password,
                   String role)

Creates a new Splunk user from a username, password, and role. Usernames must be unique on the system, and are used by the user to log in to Splunk.

Parameters:

name - The username for the new user.

password - The password for the new user.

role - The role to assign to the new user.

Returns:

The new user.

create

public User create(String name,
                   String password,
                   String[] roles)

Creates a new Splunk user from a username, password, and array of roles. Usernames must be unique on the system, and are used by the user to log in to Splunk.

Parameters:

name - The username for the new user.

password - The password for the new user.

roles - Array of roles to assign to the new user.

Returns:

The new user.

create

public User create(String name,
                   String password,
                   String role,
                   Map args)

Creates a new Splunk user from a username, password, role, and additional arguments. Usernames must be unique on the system, and are used by the user to log in to Splunk.

Parameters:

name - The username for the new user.

password - The password for the new user.

role - The role to assign to the new user.

args - A map of additional arguments. For a list of available parameters, see User authentication parameters on dev.splunk.com.

Returns:

The new user.

create

public User create(String name,
                   String password,
                   String[] roles,
                   Map args)

Creates a new Splunk user from a username, password, array of roles, and additional arguments. Usernames must be unique on the system, and are used by the user to log in to Splunk.

Parameters:

name - The username for the new user.

password - The password for the new user.

roles - Array of roles to assign to the new user.

args - A map of additional arguments. For a list of available parameters, see User authentication parameters on dev.splunk.com .

Returns:

The new user.