Package com.oracle.bmc.opensearch.model

Class SecuritySamlConfig

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.opensearch.model.SecuritySamlConfig

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180828")
public final class SecuritySamlConfig
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

SAML policy is optionally used for Opensearch cluster to config SAML authentication
Note: Objects should always be created or deserialized using the SecuritySamlConfig.Builder.

This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SecuritySamlConfig.Builder, which maintain a set of all explicitly set fields called SecuritySamlConfig.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SecuritySamlConfig.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
SecuritySamlConfig(Boolean isEnabled, String idpMetadataContent, String idpEntityId, String opendashboardUrl, String adminBackendRole, String subjectKey, String rolesKey)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static SecuritySamlConfig.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAdminBackendRole()	The backend role of admins who have all permissions like local master user
String	getIdpEntityId()	The unique name for a identity provider entity
String	getIdpMetadataContent()	The content of identity provider metadata
Boolean	getIsEnabled()	A flag determine whether SAML is enabled
String	getOpendashboardUrl()	The endpoint of opendashboard
String	getRolesKey()	The roles key is sued to get backend roles from SAML assertion
String	getSubjectKey()	The subject key is used to get username from SAML assertion.
int	hashCode()
SecuritySamlConfig.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

SecuritySamlConfig

@Deprecated
@ConstructorProperties({"isEnabled","idpMetadataContent","idpEntityId","opendashboardUrl","adminBackendRole","subjectKey","rolesKey"})
public SecuritySamlConfig(Boolean isEnabled,
                          String idpMetadataContent,
                          String idpEntityId,
                          String opendashboardUrl,
                          String adminBackendRole,
                          String subjectKey,
                          String rolesKey)

Deprecated.

Method Detail

builder

public static SecuritySamlConfig.Builder builder()

Create a new builder.

toBuilder

public SecuritySamlConfig.Builder toBuilder()

getIsEnabled

public Boolean getIsEnabled()

A flag determine whether SAML is enabled

Returns:

the value

getIdpMetadataContent

public String getIdpMetadataContent()

The content of identity provider metadata

Returns:

the value

getIdpEntityId

public String getIdpEntityId()

The unique name for a identity provider entity

Returns:

the value

getOpendashboardUrl

public String getOpendashboardUrl()

The endpoint of opendashboard

Returns:

the value

getAdminBackendRole

public String getAdminBackendRole()

The backend role of admins who have all permissions like local master user

Returns:

the value

getSubjectKey

public String getSubjectKey()

The subject key is used to get username from SAML assertion.

By default, it is NameID

Returns:

the value

getRolesKey

public String getRolesKey()

The roles key is sued to get backend roles from SAML assertion

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel