CreateExtendedSecurityParameter

The CreateExtendedSecurityParameter method allows you to create a new security parameter in the system. This method differs from the CreateSecurityParameter method in that it includes the following parameters:

  • Uppercase Characters Required
  • Lowercase Characters Required
  • Special Characters Required

On this page

Usage

Privileges. This method requires Create privileges.

Parameters.

The parameters for the CreateExtendedSecurityParameter method are described in the following table.

Parameter

Data Type

Value

sessionToken

String

Valid sessionToken returned by the general.CreateUserSession method.

name

String

Name of the security parameter.

description

String

Description of the security parameter.

minPasswordLength

Integer

Minimum number of characters required for user passwords.

minPasswordCharacters

Integer

Minimum number of alpha characters required for user passwords.

passwordLifetime

Integer

Number of days before a user is required to change his or her password.

graceLogins

Integer

Maximum number of grace logons allowed after a password has expired.

maxRetries

Integer

Maximum number of times a user can unsuccessfully attempt to log on to the system before the account is put into a locked state.

lockDuration

Integer

Duration that a user account remains in a locked state after surpassing the maximum number of logon attempts. The unit of measure is set in the lockIntervalType parameter.

lockIntervalType

Integer

Type of lock duration (1=Hours, 2=Minutes, and 3=Days).

sessionTimeout

Integer

Idle time-out period for a user session. The unit of measure is set in the timeoutIntervalType parameter.

passwordHistoryCheckDepth

Integer

Number of previous passwords to track. Users are not permitted to reuse these tracked passwords.

expirationNotice

Integer

Number of days before a password's expiration that a warning is displayed.

accountTimeout

Integer

Number of days after which an account's status automatically is changed to inactive if the user has not logged on (0 = none or never automatically deactivates).

timeoutIntervalType

Integer

Unit of measure for sessionTimeout (1=Hours, 2=Minutes, and 3=Days).

minUppercaseCharacters

Integer

Number of uppercase characters that must be contained in a user password.

minLowercaseCharacters

Integer

Number of lowercase characters that must be contained in a user password.

minSpecialCharacters

Integer

Number of special characters that must be contained in a user's password. Special characters can include:

` ~ ! @ # $ % ^ & * ( ) _ + - = { } | : " < > ? [ ] \ ; ’ , . /

pinTimeout

Integer

Maximum length of time a PIN remains active before the PIN expires.

pinTimeoutType

Integer

Type of PIN timeout (1=Hours, 2=Minutes, and 3=Days).

pinMaxResendAttempts

Integer

Number of times users can request a PIN before the system prevents them from requesting additional PINs.

pinResendLockTimeout

Integer

Lockout period before users can request a PIN after they exceed their maximum PIN request limit.

pinResendLockTimeoutType

Integer

Type of Resend PIN Lock Timeout (1=Hours, 2=Minutes, and 3=Days).

Output. This method returns an integer. If the method is successful, the value is the ID of the newly created security parameter. If there is a failure, the API issues an exception.

Samples

Sample C# Call

iSecParmID = accesscontrol.CreateExtendedSecurityParameter(sSessionToken, “secparmname”, “description”, 6, 2, 2, 10, 13, 7, 1, 1, 51, 11, 3, 41, 1, 1, 2, 3);

Sample Request

The following is a sample SOAP 1.1 request and response. The placeholders shown would be replaced with actual values. SOAP 1.2 also is supported.

POST /archer/ws/accesscontrol.asmx HTTP/1.1

Host: staging

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://archer-tech.com/webservices/CreateExtendedSecurity Parameter"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

    <soap:Body>

      <CreateExtendedSecurityParameter xmlns="http://archer-tech.com/webservices/">

        <sessionToken>string</sessionToken>

        <name>string</name>

        <description>string</description>

        <minPasswordLength>int</minPasswordLength>

        <minPasswordCharacters>int</minPasswordCharacters>

        <minPasswordNumerals>int</minPasswordNumerals>

        <passwordLifetime>int</passwordLifetime>

        <graceLogins>int</graceLogins>

        <maxRetries>int</maxRetries>

        <lockDuration>int</lockDuration>

        <lockIntervalType>int</lockIntervalType>

        <sessionTimeout>int</sessionTimeout>

        <passwordHistoryCheckDepth>int</passwordHistoryCheckDepth>

        <expirationNotice>int</expirationNotice>

        <accountTimeout>int</accountTimeout>

        <timeoutIntervalType>int</timeoutIntervalType>

        <minUppercaseCharacters>int</minUppercaseCharacters>

        <minLowercaseCharacters>int</minLowercaseCharacters>

        <minSpecialCharacters>int</minSpecialCharacters>

        <pinTimeout>int</pinTimeout>

        <pinTimeoutType>int</pinTimeoutType>

        <pinMaxResendAttempts>int</pinMaxResendAttempts>

        <pinResendLockTimeout>int</pinResendLockTimeout>

        <pinResendLockTimeoutType>int</pinResendLockTimeoutType>

      </CreateExtendedSecurityParameter>

    </soap:Body>

</soap:Envelope>

Sample Response

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

    <soap:Body>

      <CreateExtendedSecurityParameterResponse xmlns="http://archer-tech.com/webservices/">

        <CreateExtendedSecurityParameterResult>int</CreateExtendedSecurityParameterResult>

      </CreateExtendedSecurityParameterResponse>

    </soap:Body>

</soap:Envelope>