CLI Registration Scheme Methods

Contents
casso127
Contents
Description Method Sets or Retrieves the Registration Scheme Description
The Description method sets or retrieves the registration scheme description.
Syntax
The Description method has the following format:
Netegrity::PolicyMgtRegScheme->Description([regDesc])
Parameters
The Description method accepts the following parameter:
  1. regDesc
    (string)
    (Optional) Specifies the description of the registration scheme.
Return Value
The Description method returns one of the following values:
  • The new or existing description of the registration scheme
  • An empty string if the call is unsuccessful
EnableLogging Method Enables or Disables Registration Scheme Logging
The EnableLogging method enables or disables registration scheme logging.
Syntax
The EnableLogging method has the following format:
Netegrity::PolicyMgtRegScheme->EnableLogging([logFlag])
Parameters
The EnableLogging method accepts the following parameter:
  1. logFlag
    (int)
    (Optional) Specifies whether registration scheme logging is enabled:
    • 1 enables logging
    • 0 disables logging
Return Value
The EnableLogging method returns one of the following values:
  • 1 if logging is enabled
  • 0 if logging is disabled
  • -1 if the call is unsuccessful
Name Method Sets or Retrieves the Registration Scheme Name
The Name method Sets or retrieves the registration scheme name.
Syntax
The Name method has the following format:
Netegrity::PolicyMgtRegScheme->Name([regName])
Parameters
The Name method accepts the following parameters:
  1. regName
    (string)
    (Optional) Specifies the registration scheme name.
Return Value
The Name method returns one of the following values:
  • The new or existing registration scheme name
  • undef
    if the call is unsuccessful
TemplatePath Method Sets or Retrieves the Path of the Registration Scheme
The TemplatePath method sets or retrieves the path of the registration scheme template.
Syntax
The TemplatePath method has the following format:
Netegrity::PolicyMgtRegScheme->TemplatePath([path])
Parameters
The TemplatePath method accepts the following parameters:
  1. path
    (string)
    (Optional) Specifies the path of the registration scheme template.
Return Value
The TemplatePath method returns one of the following values:
  • The new or existing template path
  • undef
    if the call is unsuccessful
UserDirectory Method Sets or Retrieves the User Directory for the Registration Scheme
The UserDirectory method sets or retrieves the user directory for the registration scheme.
Syntax
The UserDirectory method has the following format:
Netegrity::PolicyMgtRegScheme->UserDirectory([userDir])
Parameters
The UserDirectory method accepts the following parameters:
  1. userDir
    (PolicyMgtUserDir)
    (Optional) Specifies the user directory for the registration scheme.
Return Value
The UserDirectory method returns one of the following values:
  • A PolicyMgtUserDir object
  • undef
    if the call is unsuccessful, or if no user directory exists
WelcomePageURL Method Sets or Retrieves the Welcome Page URL for the Registration Scheme
The WelcomePageURL method sets or retrieves the welcome page URL for the registration scheme.
Syntax
The WelcomePageURL method has the following format:
Netegrity::PolicyMgtRegScheme->WelcomePageURL([URL])
Parameters
The WelcomePageURL method accepts the following parameter:
  1. URL
    (string)
    (Optional) Specifies the welcome page URL for the registration scheme. Users are redirected to this page after successfully registering.
    Format:
    http://my.acme.com/hr/welcome.htm
Return Value
The WelcomePageURL method returns one of the following values:
  • The new or existing URL
  • undef
    if the call is unsuccessful