Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › Session Methods › CreateAuthScheme Method—Creates Authentication Scheme

CreateAuthScheme Method—Creates Authentication Scheme

The CreateAuthScheme method creates and configures an authentication scheme.

Syntax

The CreateAuthScheme method has the following format:

Netegrity::PolicyMgtSession‑>CreateAuthScheme(schemeName, schemeTemplate[, schemeDesc][, protLevel][, schemeLib][, schemeParam][, secret][, isTemplate][, isUsedByAdmin][, saveCreds][, isRadius][, ignorePwd])

Parameters

The CreateAuthScheme method accepts the following parameters:

schemeName (string)

Specifies the authentication scheme's name.

schemeTemplate (PolicyMgtAuthScheme object)

Specifies the template on which to base the authentication scheme.

Note: To view a list of templates, see the method PolicyMgtSession‑>GetAuthScheme.

schemeDesc (string)

(Optional) Specifies the authentication scheme's description.

protLevel (int)

(Optional) Specifies the authentication scheme's protection level.

Range: 1-1000

Note: The higher the protection level value, the more secure the authentication scheme.

schemeLib (string)

(Optional) Specifies the name of the custom library to use in place of the default library shipped with each type of authentication scheme.

schemeParam (string)

(Optional) Specifies a parameter string to pass to the authentication scheme.

Note: For help constructing the parameter string, navigate to the Scheme Type Setup tab on the Authentication Scheme Properties dialog in the Administrative UI. Select the authentication scheme type, type the values in the fields, and observe the result on the Advanced tab.

secret (string)

(Optional) Specifies the authentication scheme's shared secret.

isTemplate (int)

(Optional) Specifies whether the authentication scheme is a template for other authentication schemes.

Default: A zero (0) value specifies that the authentication scheme is not a template.

Note: This parameter is deprecated as of SiteMinder v6.0 SP3.

isUsedByAdmin (int)

(Optional) Specifies whether the authentication scheme can be used to authenticate administrators.

saveCreds (int)

(Optional) Specifies whether to save user credentials.

isRadius (int)

(Optional) Specifies whether the authentication scheme type is RADIUS.

ignorePwd (int)

(Optional) Specifies whether to ignore password policies.

Return Value

The CreateAuthScheme method returns one of the following values:

• PolicyMgtAuthScheme (object)
• undef if the call is unsuccessful or the authentication scheme name already exists