Scheme type

setType(TypeSAMLArtifact)

The scheme type SAML Artifact.

Description

setDescription(description)

The description of the authentication scheme.

Protection level

setLevel(value)

A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 5.

Library

setLibrary("smauthsaml")

The default library for this scheme type.

Parameter

setParameter(param)

The following required parameters:

• Name. The name of the affiliate.
• RedirectMode. The way in which the SAML Credentials Collector redirects to the target resource. One of the following numeric values:

0. Meaning: 302 No Data.

1. Meaning: 302 Cookie Data.

2. Meaning: Server Redirect.

• SRCID. The 20-byte source ID for the site that produces the SAML assertion. The ID is located at the SAML producer’s site in the properties file AMAssertionGenerator.properties.
• AssertionRetrievalURL. The URL for obtaining the assertion from the SAML assertion producer’s site.
• Audience. The URI of the document that describes the agreement between the portal and the affiliate. This value is compared with the audience value specified in the SAML assertion.
• Issuer. The SAML issuer specified in the assertion.
• AttributeXPath. A standard XPath query run against the SAML assertion. The query obtains the data that is substituted in a search specification that looks up a user.
• attribute. The search string for looking up a user in a user directory of the specified type. Use a percent sign ( % ) to indicate where the value returned from the XPath query should be inserted. For example, if you specify attribute LDAP:uid=%s, and user1 is returned from the query, the search string used for LDAP directories is uid=user1. At least one attribute must be specified.

Format of the parameter string is as follows. Separate name/value pairs with semi-colons ( ; ). The format example includes LDAP and ODBC attributes:

Name=name;RedirectMode=0|1|2;SRCID=srcid;
AssertionRetrievalURL=url;Audience=audience;
Issuer=issuer;AttributeXpath=XPathQuery;
attribute=LDAP:srchSpc;attribute=ODBC:srchSpc

Shared secret

setSecret(secret)

The password for the affiliate site.

Is template?

setIsTemplate(templateFlag)

Set to false (0) to indicate that the scheme is not a template.

Is used by administrator?

setIsUsedByAdmin(0)

Set to false (0)—scheme is not used to authenticate administrators.

Save credentials?

setAllowSaveCreds(0)

Set to false (0) to indicate that user credentials won’t be saved.

Is RADIUS?

setIsRadius(0)

Set to false (0)—scheme is not used with RADIUS agents.

Ignore password check?

setIgnorePwCheck(1)

Set to true (1)—ignore password checking.