Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › CLI ODBC Query Scheme Methods

CLI ODBC Query Scheme Methods

Description Method—Sets or Retrieves the Description of the ODBC Query Scheme

The Description method sets or retrieves the description of the ODBC query scheme.

Syntax

The Description method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>Description([schemeDesc])

Parameters

The Description method accepts the following parameter:

schemeDesc (string)

(Optional) Specifies the description of the ODBC query scheme.

Return Value

The Description method returns one of the following values:

• The new or existing ODBC query scheme description
• An empty if the call is unsuccessful

Name Method—Sets or Retrieves the ODBC Query Scheme Name

The Name method sets or retrieves the ODBC query scheme name.

Syntax

The Name method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>Name([schemeName])

Parameters

The Name method accepts the following parameter:

schemeName (string)

Specifies the ODBC query scheme name.

Return Value

The Name method returns one of the following values:

• The new or existing ODBC query scheme name
• undef if the call is unsuccessful

QueryAuthenticateUser Method—Sets or Retrieves a Query that Fetches a User's Password

The QueryAuthenticateUser method sets or retrieves a query that fetches a user's password.

Syntax

The QueryAuthenticateUser method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QueryAuthenticateUser([queryAuthUser])

Parameters

The QueryAuthenticateUser method accepts the following parameter:

queryAuthUser (string)

(Optional) Specifies the query that fetches a user's password.

Return Value

The QueryAuthenticateUser method returns one of the following values:

• The new or existing query
• undef if the call is unsuccessful

Remarks

Sample query (based on the SiteMinder sample database schema SmSampleUsers). The %s expression is a placeholder for the user's name parameter to be supplied by SiteMinder when the query is executed:

select Name from SmUser where Name = '%s' and Password = '%s'

If you are configuring a query scheme for an Oracle database and you are using Oracle's encrypted password feature, replace the entire query string with the word connect. Using the word connect for this query indicates to SiteMinder that a user's name and password should be evaluated by the Oracle encrypted password feature.

QueryEnumerate Method—Sets or Retrieves a Query that Lists the Names of User Objects

The QueryEnumerate method sets or retrieves a query that lists the names of user objects in the directory.

Syntax

The QueryEnumerate method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QueryEnumerate([queryEnumerate])

Parameters

The QueryEnumerate method accepts the following parameter:

queryEnumerate (string)

(Optional) Specifies the query that lists the names of user objects in the directory.

Return Value

The QueryEnumerate method returns one of the following values:

• The new or existing query
• undef if the call is unsuccessful

Remarks

Sample query (based on the SiteMinder sample database schema SmSampleUsers):

select Name, 'Group' as Class from SmGroup order by Class

QueryGetGroupProp Method—Sets or Retrieves a Query that Fetches the Value of a Group Property

The QueryGetGroupProp method sets or retrieves a query that fetches the value of a group property. The property must be one of the properties specified through the QueryGetGroupProps method.

Syntax

The QueryGetGroupProp method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QueryGetGroupProp([queryGetGroupProp])

Parameters

The QueryGetGroupProp method accepts the following parameter:

queryGetGroupProp (string)

(Optional) Specifies the query that fetches the group property.

Return Value

The QueryGetGroupProp method returns one of the following values:

• The new or existing query
• undef if the call is unsuccessful

Remarks

Sample query (based on the SiteMinder sample database schema SmSampleUsers). The %s expressions are placeholders for property name and group name parameters to be supplied by SiteMinder when the query is executed:

select %s from SmGroup where Name = '%s'

QueryGetGroupProps Method—Sets or Retrieves a List of Group Properties

The QueryGetGroupProps method sets or retrieves a comma-separated list of group properties. These attributes are used to search the contents of a group, or to bind policies to group attributes. The attributes are expected to reside in the same table as the group name.

Syntax

The QueryGetGroupProps method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QueryGetGroupProps([queryGetGroupProps])

Parameters

The QueryGetGroupProps method accepts the following parameters:

queryGetGroupProps (string)

(Optional) Specifies the comma-separated list of group properties.

Return Value

The QueryGetGroupProps method returns one of the following values:

• The new or existing group properties list
• undef if the call is unsuccessful

Remarks

Sample list:

Name, GroupId

QueryGetGroups Method—Sets or Retrieves a Query that Fetches the Names of the Groups that the User Is a Member of

The QueryGetGroups method sets or retrieves a query that fetches the names of the groups that the user is a member of.

Syntax

The QueryGetGroups method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QueryGetGroups([queryGetGroups])

Parameters

The QueryGetGroups method accepts the following parameters:

queryGetGroups (string)

(Optional) Specifies the query that fetches the names of the user's groups.

Return Value

The QueryGetGroups method returns one of the following values:

• The new or existing query
• undef if the call is unsuccessful

Remarks

Sample query (based on the SiteMinder sample database schema SmSampleUsers). The %s expression is a placeholder for a user name parameter to be supplied by SiteMinder when the query is executed:

select SmGroup.Name from SmGroup, SmUser, SmUserGroup where SmUser.Name = '%s' and SmUser.UserId = SmUserGroup.UserId and SmGroup.GroupId = SmUserGroup.GroupId

QueryGetObjInfo Method—Sets or Retrieves a Query that Fetches the Class of the Object

The QueryGetObjInfo method sets or retrieves a query that fetches the class of the object.

Syntax

The QueryGetObjInfo method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QueryGetObjInfo([queryGetObjInfo])

Parameters

The QueryGetObjInfo method accepts the following parameter:

queryGetObjInfo (string)

(Optional) Specifies the query that fetches the class of the object.

Return Value

The QueryGetObjInfo method returns one of the following values:

• The new or existing query
• undef if the call is unsuccessful

Remarks

Sample query (based on the SiteMinder sample database schema SmSampleUsers). The %s expression is a placeholder for a user or group object name to be supplied by SiteMinder when the query is executed:

select Name, 'User' from SmUser where Name = '%s' Union select Name, 'Group' from SmGroup where Name = '%s'

QueryGetUserProp Method—Sets or Retrieves a Query that Fetches the Value of a User Property

The QueryGetUserProp method sets or retrieves a query that fetches the value of a user property. The property must be one of the properties specified through the PolicyMgtODBCQueryScheme‑>QueryGetUserProps method.

Syntax

The QueryGetUserProp method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QueryGetUserProp([queryGetUserProp])

Parameters

The QueryGetUserProp method accepts the following parameter:

queryGetUserProp (string)

(Optional) Specifies the query that fetches the user property.

Return Value

The QueryGetUserProp method returns one of the following values:

• The new or existing query
• undef if the call is unsuccessful

Remarks

Sample query (based on the SiteMinder sample database schema SmSampleUsers). The %s expressions are placeholders for property name and user name parameters to be supplied by SiteMinder when the query is executed:

select %s from SmUser where Name = '%s'

QueryGetUserProps Method—Sets or Retrieves a List of User Properties

The QueryGetUserProps method sets or retrieves a comma-separated list of user properties. The properties reside in the same table as the user name.

Syntax

The QueryGetUserProps method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QueryGetUserProps([queryGetUserProps])

Parameters

The QueryGetUserProps method accepts the following parameter:

queryGetUserProps (string)

(Optional) Specifies the comma-separated list of user properties.

Return Value

The QueryGetUserProps method returns one of the following values:

• The new or existing user properties list
• undef if the call is unsuccessful

Remarks

Sample list:

Name, UserId, FirstName, LastName, TelephoneNumber, EmailAddress, PIN, Mileage, Disabled

QueryInitUser Method—Sets or Retrieves a Query that Determines whether a User Exists in the Database

The QueryInitUser method sets or retrieves a query that determines whether a particular user exists in the database.

Syntax

The QueryInitUser method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QueryInitUser([queryGetInitUser])

Parameters

The QueryInitUser method accepts the following parameter:

queryGetInitUser (string)

(Optional) Specifies the query that determines whether the user exists in the database.

Return Value

The QueryInitUser method returns one of the following values:

• The new or existing query
• undef if the call is unsuccessful

Remarks

Sample query (based on the SiteMinder sample database schema SmSampleUsers). The %s expression is a placeholder for the user name parameter to be supplied by SiteMinder when the query is executed:

select Name from SmUser where Name = '%s'

QueryIsGroupMember Method—Sets or Retrieves a Query that Lists the Group Membership for a Particular User

The QueryIsGroupMember method sets or retrieves a query that lists the group membership for a particular user.

Syntax

The QueryIsGroupMember method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QueryIsGroupMember([queryIsGroupMember])

Parameters

The QueryIsGroupMember method accepts the following parameters:

queryIsGroupMember (string)

(Optional) Specifies the query that determines a user's group membership.

Return Value

The QueryIsGroupMember method returns one of the following values:

• The new or existing query
• undef if the call is unsuccessful

Remarks

Sample query (based on the SiteMinder sample database schema SmSampleUsers). The %s expressions are placeholders for user name and group name parameters to be supplied by SiteMinder when the query is executed:

select Id from SmUserGroup where UserId = (select UserId from SmUser where Name = '%s') and GroupId = (select GroupId from SmGroup where Name = '%s')

QueryLookup Method—Sets or Retrieves a Query that Fetches Objects

The QueryLookup method sets or retrieves a query that fetches objects based on a property specified in a group table.

Syntax

The QueryLookup method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QueryLookup([queryLookup])

Parameters

The QueryLookup method accepts the following parameter:

queryLookup (string)

(Optional) Specifies the query that fetches the objects.

Return Value

The QueryLookup method returns one of the following values:

• The new or existing query
• undef if the call is unsuccessful

Remarks

Sample query (based on the SiteMinder sample database schema SmSampleUsers). The %s expression is a placeholder for a parameter to be supplied by SiteMinder when the query is executed:

select Name, 'User' as Class from SmUser where Name %s Union select Name, 'Group' as Class from SmGroup where Name %s order by Class

QueryLookupGroup Method—Sets or Retrieves a Query that Fetches a Group Name

The QueryLookupGroup method sets or retrieves a query that fetches a group name based on a property specified in a group table.

Syntax

The QueryLookupGroup method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QueryLookupGroup([queryLookupGrp])

Parameters

The QueryLookupGroup method accepts the following parameter:

queryLookupGrp (string)

(Optional) Specifies the query that fetches the group name.

Return Value

The QueryLookupGroup method returns one of the following values:

• A new or existing query
• undef if the call is unsuccessful

Remarks

Sample query (based on the SiteMinder sample database schema SmSampleUsers). The %s expression is a placeholder for a parameter to be supplied by SiteMinder when the query is executed:

select Name, 'Group' as Class from SmGroup where %s

QueryLookupUser Method—Sets or Retrieves a Query that Fetches a User Name

The QueryLookupUser method sets or retrieves a query that fetches a user name based on a property specified in the user table.

Syntax

The QueryLookupUser method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QueryLookupUser([queryLookupUsr])

Parameters

The QueryLookupUser method accepts the following parameter:

queryLookupUsr (string)

(Optional) Specifies the query that fetches the user name.

Return Value

The QueryLookupUser method returns one of the following values:

• The new or existing query
• undef if the call is unsuccessful

Remarks

Sample query (based on the SiteMinder sample database schema SmSampleUsers). The %s expression is a placeholder for a parameter to be supplied by SiteMinder when the query is executed:

select Name, 'User' as Class from SmUser where %s

QuerySetGroupProp Method—Sets or Retrieves a Query that Sets the Value of a Group Property

The QuerySetGroupProp method sets or retrieves a query that sets the value of a group property. The property must be one of the properties specified through the QueryGetGroupProps method.

Syntax

The QuerySetGroupProp method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QuerySetGroupProp([querySetGroupProp])

Parameters

The QuerySetGroupProp method accepts the following parameter:

querySetGroupProp (string)

(Optional) Specifies the query that sets the property value for the group.

Return Value

The QuerySetGroupProp method returns one of the following values:

• The new or existing query
• undef if the call is unsuccessful

Remarks

Sample query (based on the SiteMinder sample database schema SmSampleUsers). The %s expressions are placeholders for property name, property value, and group name parameters to be supplied by SiteMinder when the query is executed:

update SmGroup set %s = %s where Name = '%s'

QuerySetPassword Method—Sets or Retrieves a Query that Changes a User Password

The QuerySetPassword method sets or retrieves a query that changes a user password.

Syntax

The QuerySetPassword method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QuerySetPassword([querySetPassword])

Parameters

The QuerySetPassword method accepts the following parameter:

querySetPassword (string)

(Optional) Specifies the query that changes a user password.

Return Value

The QuerySetPassword method returns one of the following values:

• The new or existing query
• undef if the call is unsuccessful

Remarks

Sample query (based on the SiteMinder sample database schema SmSampleUsers). The %s expressions are placeholders for user password and user name parameters to be supplied by SiteMinder when the query is executed:

update SmUser set Password = '%s' where Name = '%s'

QuerySetUserProp Method—Sets or Retrieves a Query that Sets the Value of a User Property

The QuerySetUserProp method sets or retrieves a query that sets the value of a user property. The property must be one of the properties specified through the PolicyMgtODBCQueryScheme‑>QueryGetUserProps method.

Syntax

The QuerySetUserProp method has the following format:

Netegrity::PolicyMgtODBCQueryScheme‑>QuerySetUserProp([querySetUserProp])

Parameters

The QuerySetUserProp method accepts the following parameters:

querySetUserProp (string)

(Optional) Specifies the query that sets the property value for the group.

Return Value

The QuerySetUserProp method returns one of the following values:

• The new or existing query
• undef if the call is unsuccessful

Remarks

Sample query (based on the SiteMinder sample database schema SmSampleUsers). The %s expressions are placeholders for property name, property value, and user name parameters to be supplied by SiteMinder when the query is executed:

update SmUser set %s = %s where Name = '%s'