com.solidfire.element.api

Class AddIdpClusterAdminRequest

java.lang.Object

com.solidfire.element.api.AddIdpClusterAdminRequest

All Implemented Interfaces:

java.io.Serializable

public class AddIdpClusterAdminRequest
extends java.lang.Object
implements java.io.Serializable

AddIdpClusterAdminRequest Adds a cluster administrator user authenticated by a third party Identity Provider (IdP). IdP cluster admin accounts are configured based on SAML attribute-value information provided within the IdP's SAML assertion associated with the user. If a user successfully authenticates with the IdP and has SAML attribute statements within the SAML assertion matching multiple IdP cluster admin accounts, the user will have the combined access level of those matching IdP cluster admin accounts.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AddIdpClusterAdminRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AddIdpClusterAdminRequest()
AddIdpClusterAdminRequest(java.lang.String username, java.lang.String[] access, java.lang.Boolean acceptEula, Optional<Attributes> attributes)

Method Summary

Modifier and Type	Method and Description
AddIdpClusterAdminRequest.Builder	asBuilder()
static AddIdpClusterAdminRequest.Builder	builder()
boolean	equals(java.lang.Object o)
java.lang.Boolean	getAcceptEula() Accept the End User License Agreement.
java.lang.String[]	getAccess() Controls which methods this IdP Cluster Admin can use.
Optional<Attributes>	getAttributes() List of name-value pairs in JSON object format.
java.lang.String	getUsername() A SAML attribute-value mapping to a IdP cluster admin (e.g.
int	hashCode()
void	setAcceptEula(java.lang.Boolean acceptEula)
void	setAccess(java.lang.String[] access)
void	setAttributes(Optional<Attributes> attributes)
void	setUsername(java.lang.String username)
java.util.Map<java.lang.String,java.lang.Object>	toMap()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

AddIdpClusterAdminRequest

@Since(value="7.0")
public AddIdpClusterAdminRequest()

AddIdpClusterAdminRequest

@Since(value="7.0")
public AddIdpClusterAdminRequest(java.lang.String username,
                                                     java.lang.String[] access,
                                                     java.lang.Boolean acceptEula,
                                                     Optional<Attributes> attributes)

Method Detail

getUsername

public java.lang.String getUsername()

A SAML attribute-value mapping to a IdP cluster admin (e.g. email=test@example.com). This could be defined using a specific SAML subject using NameID, or an entry in the SAML attribute statement such as eduPersonAffiliation.

setUsername

public void setUsername(java.lang.String username)

getAccess

public java.lang.String[] getAccess()

Controls which methods this IdP Cluster Admin can use. For more details on the levels of access, see the Access Control appendix in the SolidFire API Reference.

setAccess

public void setAccess(java.lang.String[] access)

getAcceptEula

public java.lang.Boolean getAcceptEula()

Accept the End User License Agreement. Set to true to add a cluster administrator account to the system. If omitted or set to false, the method call fails.

setAcceptEula

public void setAcceptEula(java.lang.Boolean acceptEula)

getAttributes

public Optional<Attributes> getAttributes()

List of name-value pairs in JSON object format.

setAttributes

public void setAttributes(Optional<Attributes> attributes)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static AddIdpClusterAdminRequest.Builder builder()

asBuilder

public final AddIdpClusterAdminRequest.Builder asBuilder()