Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.security.user

Class SystemUser

java.lang.Object

org.elasticsearch.xpack.core.security.user.User

org.elasticsearch.xpack.core.security.user.InternalUser

org.elasticsearch.xpack.core.security.user.SystemUser

All Implemented Interfaces:

ToXContent, ToXContentObject

public class SystemUser
extends InternalUser

Internal user that is applied to all requests made elasticsearch itself

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.core.security.user.User

User.Fields

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final String	ROLE_NAME	Deprecated.

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
static CrossClusterAccessSubjectInfo	crossClusterAccessSubjectInfo(TransportVersion transportVersion, String nodeName)	The role descriptor intersection in the returned subject info is always empty.
Optional<RoleDescriptor>	getLocalClusterRoleDescriptor()	The local-cluster role descriptor assigned to this internal user, or Optional.empty() if this user does not have a role.
static boolean	is(User user)	Deprecated.
static boolean	isAuthorized(String action)

Methods inherited from class org.elasticsearch.xpack.core.security.user.InternalUser

equals, getRemoteAccessRoleDescriptor, hashCode

Methods inherited from class org.elasticsearch.xpack.core.security.user.User

email, enabled, fullName, innerToXContent, metadata, principal, roles, toString, toXContent, writeUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

ROLE_NAME

@Deprecated
public static final String ROLE_NAME

Deprecated.

See Also:

• Constant Field Values

Method Details

getLocalClusterRoleDescriptor

public Optional<RoleDescriptor> getLocalClusterRoleDescriptor()

Description copied from class: InternalUser

The local-cluster role descriptor assigned to this internal user, or Optional.empty() if this user does not have a role. This RoleDescriptor defines the privileges that the internal-user has for requests that originate from a node within the local cluster.

Overrides:

getLocalClusterRoleDescriptor in class InternalUser

Returns:

Optional.empty() because the _system user does not use role based security

See Also:

• isAuthorized(String)

is

@Deprecated
public static boolean is(User user)

Deprecated.

isAuthorized

public static boolean isAuthorized(String action)

crossClusterAccessSubjectInfo

public static CrossClusterAccessSubjectInfo crossClusterAccessSubjectInfo(TransportVersion transportVersion,
 String nodeName)

The role descriptor intersection in the returned subject info is always empty. Because the privileges of the cross cluster access internal user are static, we set them during role reference resolution instead of needlessly deserializing the role descriptor intersection (see flow starting at Subject.getRoleReferenceIntersection(AnonymousUser))