# SAMLAuthenticatorMBean

Overview | Related MBeans | Attributes | Operations

## Overview

This MBean represents configuration information for the SAML Authentication provider.Deprecation of MBeanHome and Type-Safe InterfacesThis is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX" on http://edocs.bea.com.

Fully Qualified Interface Name | If you use the `getMBeanInfo` operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name: `weblogic.security.providers.saml.SAMLAuthenticatorMBean`
Factory Methods | No factory methods. Instances of this MBean are created automatically.
Access Points Inherited from AuthenticationProviderMBean | Because this MBean extends or implements AuthenticationProviderMBean, you can also access this MBean by retrieving AuthenticationProviderMBeans. The following attributes contain AuthenticationProviderMBeans and its subtypes:
RealmMBean.AuthenticationProviders |

## Related MBeans

This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.

Realm |

### Realm

Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.

Privileges | Read only
Type | RealmMBean
Relationship type: | Reference.

## Attributes

This section describes the following attributes:

ControlFlag Description Name | ProviderClassName Version

### ControlFlag

Returns how the login sequence uses the Authentication provider.

A `REQUIRED` value specifies this LoginModule must succeed. Even if it fails, authentication proceeds down the list of LoginModules for the configured Authentication providers. This setting is the default.

A `REQUISITE` value specifies this LoginModule must succeed. If other Authentication providers are configured and this LoginModule succeeds, authentication proceeds down the list of LoginModules. Otherwise, control is return to the application.

A `SUFFICIENT` value specifies this LoginModule need not succeed. If it does succeed, return control to the application. If it fails and other Authentication providers are configured, authentication proceeds down the LoginModule list.

An `OPTIONAL` value specifies this LoginModule need not succeed. Whether it succeeds or fails, authentication proceeds down the LoginModule list.

Privileges | Read/Write
Type | java.lang.String
Default Value | REQUIRED
Legal Values | REQUIRED REQUISITE SUFFICIENT OPTIONAL

### Description

A short description of the SAML Authentication provider.

Privileges | Read only
Type | java.lang.String
Default Value | WebLogic SAML Authentication Provider.
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### Name

Privileges | Read only
Type | java.lang.String
Default Value | SAMLAuthenticator
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### ProviderClassName

The name of the Java class used to load the SAML Authentication provider.

Privileges | Read only
Type | java.lang.String
Default Value | weblogic.security.providers.saml.SAMLAuthenticationProviderImpl
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### Version

The version number of the SAML Authentication provider.

Privileges | Read only
Type | java.lang.String
Default Value | 1.0
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

## Operations

This section describes the following operations:

wls_getDisplayName |

### wls_getDisplayName

Operation Name | `"wls_getDisplayName"`
Parameters | `null`
Signature | `null`
Returns | `String`