# SAMLIdentityAsserterV2MBean

Overview | Related MBeans | Attributes | Operations

## Overview

No description provided.

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.SAMLIdentityAsserterV2MBean`
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:

ActiveTypes Base64DecodingRequired Description MinimumParserPoolSize Name NameMapperClassName ProviderClassName | SupportedExportConstraints SupportedExportFormats SupportedImportConstraints SupportedImportFormats SupportedTypes Version

### ActiveTypes

The token types active for this SAML Identity Assertion V2 provider.

Privileges | Read/Write
Type | class java.lang.String[]
Default Value | SAML.Assertion SAML.Assertion64 SAML.Assertion.DOM

### Base64DecodingRequired

Base64 decoding is not required for the WebLogic SAML Identity Assertion V2 provider.

Privileges | Read/Write
Type | boolean

### Description

A short description of this SAML Identity Assertion V2 provider.

Privileges | Read only
Type | java.lang.String
Default Value | WebLogic SAML Identity Assertion Provider. Supports Security Assertion Markup Language v1.1.
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### MinimumParserPoolSize

The minimum number of parsers to maintain in the parser pool.

Privileges | Read/Write
Type | int
Default Value | 5
Minimum value | 0

### Name

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

### NameMapperClassName

The name of the Java class that maps SAML Assertion name information to local Subjects. When no mapper is supplied the default mapper implemention is used.

Privileges | Read/Write
Type | java.lang.String
Default Value |

### ProviderClassName

The name of the Java class used to load the SAML Identity Assertion V2 provider.

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

### SupportedExportConstraints

No description provided.

Privileges | Read only
Type | class java.lang.String[]
Default Value | Partners Certificates Passwords
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### SupportedExportFormats

No description provided.

Privileges | Read only
Type | class java.lang.String[]
Default Value | XML Partner Registry JKS KeyStore LDIF Template
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### SupportedImportConstraints

No description provided.

Privileges | Read only
Type | class java.lang.String[]
Default Value | Partners Certificates ImportMode
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### SupportedImportFormats

No description provided.

Privileges | Read only
Type | class java.lang.String[]
Default Value | XML Partner Registry JKS KeyStore
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### SupportedTypes

The token types supported by this SAML Identity Assertion V2 provider.

Privileges | Read only
Type | class java.lang.String[]
Default Value | SAML.Assertion SAML.Assertion64 SAML.Assertion.DOM
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### Version

The version number of this SAML Identity Assertion V2 provider.

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

## Operations

This section describes the following operations:

addAssertingParty advance assertingPartyExists certificateExists close copyToDER copyToPEM exportData getAssertingParty getCertificate getCurrentName | haveCurrent importData listAssertingParties listCertificates newAssertingParty registerCertificate removeAssertingParty unregisterCertificate updateAssertingParty wls_getDisplayName

### addAssertingParty

No description provided.

Operation Name | `"addAssertingParty"`
Parameters | `Object [] { assertingParty }` where: `assertingParty` is an object of type `weblogic.security.providers.saml.registry.SAMLAssertingParty` that specifies: - The new asserting party to add.
Signature | `String [] { "weblogic.security.providers.saml.registry.SAMLAssertingParty" }`
Returns | `void`
Exceptions | `weblogic.management.utils.InvalidParameterException` `weblogic.management.utils.CreateException`

### advance

Advances the list to the next element in the list.

Operation Name | `"advance"`
Parameters | `Object [] { cursor }` where: `cursor` is an object of type `java.lang.String` that specifies: - The cursor returned from a previous list method.
Signature | `String [] { "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.InvalidCursorException`

### assertingPartyExists

No description provided.

Operation Name | `"assertingPartyExists"`
Parameters | `Object [] { partnerId }` where: `partnerId` is an object of type `java.lang.String` that specifies: - The partnerId of the asserting party.
Signature | `String [] { "java.lang.String" }`
Returns | `boolean`
Exceptions | `weblogic.management.utils.InvalidParameterException`

### certificateExists

No description provided.

Operation Name | `"certificateExists"`
Parameters | `Object [] { alias }` where: `alias` is an object of type `java.lang.String` that specifies: - The alias the certificate is registered under. It must not be empty or null. Aliases are case-insensitive.
Signature | `String [] { "java.lang.String" }`
Returns | `boolean`
Exceptions | `weblogic.management.utils.InvalidParameterException`

### close

Indicates that the caller is finished using the list, and that the resources held on behalf of the list may be released. If the caller traverses through all the elements in the list, the caller need not call this method. In other words, it is used to let the caller close the list without reading each element that is returned.

Operation Name | `"close"`
Parameters | `Object [] { cursor }` where: `cursor` is an object of type `java.lang.String` that specifies: - The cursor returned from a previous list method.
Signature | `String [] { "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.InvalidCursorException`

### copyToDER

No description provided.

Operation Name | `"copyToDER"`
Parameters | `Object [] { alias, certificateFile }` where: `alias` is an object of type `java.lang.String` that specifies: - The alias the certificate is registered under. It must not be empty or null. Aliases are case-insensitive. `certificateFile` is an object of type `java.lang.String` that specifies: - The pathname (relative to the directory the admin server is booted from) of the file to write the certificate to.
Signature | `String [] { "java.lang.String", "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.NotFoundException` `weblogic.management.utils.InvalidParameterException`

### copyToPEM

No description provided.

Operation Name | `"copyToPEM"`
Parameters | `Object [] { alias, certificateFile }` where: `alias` is an object of type `java.lang.String` that specifies: - The alias the certificate is registered under. It must not be empty or null. Aliases are case-insensitive. `certificateFile` is an object of type `java.lang.String` that specifies: - The pathname (relative to the directory the admin server is booted from) of the file to write the certificate to.
Signature | `String [] { "java.lang.String", "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.NotFoundException` `weblogic.management.utils.InvalidParameterException`

### exportData

Exports provider specific data in a specified format. When errors occur, the MBean throws an ErrorCollectionException containing a list of `java.lang.Exceptions`, where the text of each exception describes the error.

Operation Name | `"exportData"`
Parameters | `Object [] { format, filename, constraints }` where: `format` is an object of type `java.lang.String` that specifies: - The format for exporting provider specific data. `filename` is an object of type `java.lang.String` that specifies: - The full path to the filename used to write data. `constraints` is an object of type `java.util.Properties` that specifies: - The constraints to be used when exporting data. A null value indicates that all data will be exported.
Signature | `String [] { "java.lang.String", "java.lang.String", "java.util.Properties" }`
Returns | `void`
Exceptions | `weblogic.management.utils.InvalidParameterException` `weblogic.management.utils.ErrorCollectionException`

### getAssertingParty

No description provided.

Operation Name | `"getAssertingParty"`
Parameters | `Object [] { partnerId }` where: `partnerId` is an object of type `java.lang.String` that specifies: - The partnerId of the asserting party to return.
Signature | `String [] { "java.lang.String" }`
Returns | `SAMLAssertingParty`
Exceptions | `weblogic.management.utils.NotFoundException` `weblogic.management.utils.InvalidParameterException`

### getCertificate

No description provided.

Operation Name | `"getCertificate"`
Parameters | `Object [] { alias }` where: `alias` is an object of type `java.lang.String` that specifies: - The alias the certificate is registered under. It must not be empty or null. Aliases are case-insensitive.
Signature | `String [] { "java.lang.String" }`
Returns | `X509Certificate`
Exceptions | `weblogic.management.utils.NotFoundException` `weblogic.management.utils.InvalidParameterException`

### getCurrentName

The name of the current item in the list. Returns null if there is no current item.

Operation Name | `"getCurrentName"`
Parameters | `Object [] { cursor }` where: `cursor` is an object of type `java.lang.String` that specifies: - The cursor returned from a previous list method.
Signature | `String [] { "java.lang.String" }`
Returns | `String`
Exceptions | `weblogic.management.utils.InvalidCursorException`

### haveCurrent

Returns true if there are more objects in the list, and false otherwise.

Operation Name | `"haveCurrent"`
Parameters | `Object [] { cursor }` where: `cursor` is an object of type `java.lang.String` that specifies: - The cursor returned from a previous list method.
Signature | `String [] { "java.lang.String" }`
Returns | `boolean`
Exceptions | `weblogic.management.utils.InvalidCursorException`

### importData

Imports provider specific data from a specified format. When errors occur, the MBean throws an ErrorCollectionException containing a list of `java.lang.Exceptions`, where the text of each exception describes the error.

Operation Name | `"importData"`
Parameters | `Object [] { format, filename, constraints }` where: `format` is an object of type `java.lang.String` that specifies: - The format for importing provider specific data. `filename` is an object of type `java.lang.String` that specifies: - The full path to the filename used to read data. `constraints` is an object of type `java.util.Properties` that specifies: - The constraints to be used when importing data. A null value indicates that all data will be imported.
Signature | `String [] { "java.lang.String", "java.lang.String", "java.util.Properties" }`
Returns | `void`
Exceptions | `weblogic.management.utils.InvalidParameterException` `weblogic.management.utils.ErrorCollectionException`

### listAssertingParties

No description provided.

Operation Name | `"listAssertingParties"`
Parameters | `Object [] { partnerIdWildcard, maxToReturn }` where: `partnerIdWildcard` is an object of type `java.lang.String` that specifies: - A wild card used to select partnerIds. It supports three formats: "*" matches all partnerIds. "foo*" matches all partnerIds starting with the string "foo". "foo" matches the partnerId "foo" only. The matches are case-insensitive. `maxToReturn` is an object of type `java.lang.Integer` that specifies: - The maximum number of partnerIds this method may return. If there are more matches than this maximum, then the returned results are arbitrary because this method does not sort the results. Set this parameter to zero to return all matching aliases.
Signature | `String [] { "java.lang.String", "java.lang.Integer" }`
Returns | `String`
Exceptions | `weblogic.management.utils.InvalidCursorException` `weblogic.management.utils.InvalidParameterException`

### listCertificates

No description provided.

Operation Name | `"listCertificates"`
Parameters | `Object [] { aliasWildcard, maxToReturn }` where: `aliasWildcard` is an object of type `java.lang.String` that specifies: - A wild card used to select aliases. It supports three formats: "*" matches all aliases. "foo*" matches all aliases starting with the string "foo". "foo" matches the alias "foo" only. The matches are case-insensitive. `maxToReturn` is an object of type `java.lang.Integer` that specifies: - The maximum number of aliases this method may return. If there are more matches than this maximum, then the returned results are arbitrary because this method does not sort the results. Set this parameter to zero to return all matching aliases.
Signature | `String [] { "java.lang.String", "java.lang.Integer" }`
Returns | `String`
Exceptions | `weblogic.management.utils.InvalidCursorException` `weblogic.management.utils.InvalidParameterException`

### newAssertingParty

No description provided.

Operation Name | `"newAssertingParty"`
Parameters | `null`
Signature | `null`
Returns | `SAMLAssertingParty`

### registerCertificate

No description provided.

Operation Name | `"registerCertificate"`
Parameters | `Object [] { alias, certificateFile }` where: `alias` is an object of type `java.lang.String` that specifies: - The alias to register the certificate under. It must not be empty or null. Aliases are case-insensitive. `certificateFile` is an object of type `java.lang.String` that specifies: - The pathname (relative to the directory the admin server is booted from) of a PEM or DER file containing the certificate to be registered.
Signature | `String [] { "java.lang.String", "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.AlreadyExistsException` `weblogic.management.utils.InvalidParameterException`

### removeAssertingParty

No description provided.

Operation Name | `"removeAssertingParty"`
Parameters | `Object [] { partnerId }` where: `partnerId` is an object of type `java.lang.String` that specifies: - The partnerId of the asserting party to remove.
Signature | `String [] { "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.NotFoundException` `weblogic.management.utils.InvalidParameterException`

### unregisterCertificate

No description provided.

Operation Name | `"unregisterCertificate"`
Parameters | `Object [] { alias }` where: `alias` is an object of type `java.lang.String` that specifies: - The alias the certificate is registered under. It must not be empty or null. Aliases are case-insensitive.
Signature | `String [] { "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.NotFoundException` `weblogic.management.utils.InvalidParameterException`

### updateAssertingParty

No description provided.

Operation Name | `"updateAssertingParty"`
Parameters | `Object [] { assertingParty }` where: `assertingParty` is an object of type `weblogic.security.providers.saml.registry.SAMLAssertingParty` that specifies: - The asserting party to update.
Signature | `String [] { "weblogic.security.providers.saml.registry.SAMLAssertingParty" }`
Returns | `void`
Exceptions | `weblogic.management.utils.NotFoundException` `weblogic.management.utils.InvalidParameterException`

### wls_getDisplayName

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