Programming Guides › Programming Guide for Perl › CLI Agent API Methods › Response Attribute Methods

Response Attribute Methods

GetFlags Method—Retrieves Response Attribute's Flags

The GetFlags method retrieves the response attribute's flags.

Syntax

The GetFlags method has the following format:

Netegrity::AgentResponseAttr‑>GetFlags()

Parameters

The GetFlags method accepts no parameters.

Return Value

The GetFlags method returns the following value:

• existing_response_attribute_flags

GetID Method—Retrieves Response Attribute's ID or Agent Command's ID

The GetID method retrieves a response attribute ID or an agent command ID.

Syntax

The GetID method has the following format:

Netegrity::AgentResponseAttr‑>GetID()

Parameters

The GetID method accepts no parameters.

Return Value

The GetID method returns a response attribute ID after AgentResponse‑>GetAttributes is called or an agent command ID after AgentAPI‑>DoManagement is called. In either case, the return value's type is long.

• AgentResponse‑>GetAttributes retrieves a list of response attributes and returns them in an array. When GetID is called after AgentResponse‑>GetAttributes is called, GetID returns one of the following response attribute IDs (long):
  • SM_AGENTAPI_ATTR_AUTH_DIR_OID (value = 151)

    Specifies the internal SiteMinder object ID for the user directory where the user was authenticated.

  • SM_AGENTAPI_ATTR_USERUNIVERSALID (value = 152)

    Specifies the user's universal ID.

  • SM_AGENTAPI_ATTR_IDENTITYSPEC (value = 156)

    Specifies the user's identity ticket.

    Note: This value is returned if user tracking is enabled.

  • SM_AGENTAPI_ATTR_SESSIONDRIFT (value = 167)

    Specifies the maximum time in minutes, during which actual session data is validated against session data stored in a cookie.

  • SM_AGENTAPI_ATTR_AUTH_DIR_NAME (value = 213)

    Specifies the directory name as it appears in the Name field of the SiteMinder User Directory dialog.

  • SM_AGENTAPI_ATTR_AUTH_DIR_SERVER (value = 214)

    Specifies the server specification as it appears in the Server field of the SiteMinder User Directory dialog.

  • SM_AGENTAPI_ATTR_AUTH_DIR_NAMESPACE (value = 215)

    Specifies the user directory's namespace: LDAP, AD, WinNT, or ODBC.

  • SM_AGENTAPI_ATTR_USERMSG (value = 216)

    Specifies the text presented to the user following an authentication attempt.

    Note: This text could be an authentication challenge or a reason why authentication failed.

  • SM_AGENTAPI_ATTR_USERDN (value = 218)

    Specifies the user's distinguished name.

• AgentAPI‑>DoManagement retrieves a list of agent commands pending from the Policy Server and returns them in an array. When GetID is called after AgentAPI‑>DoManagement is called, GetID returns one of the following agent command IDs (long):
  • SM_AGENTAPI_AFFILIATE_KEY_UPDATE (value = 189)

    Instructs the agent to update the name of the affiliate agent.

  • SM_AGENTAPI_AGENT_KEY_UPDATE_NEXT (value = 190)

    Instructs the agent to update its "next" agent key.

    Note: The encrypted value contains 24 bytes of binary data.

  • SM_AGENTAPI_AGENT_KEY_UPDATE_LAST (value = 191)

    Instructs the agent to update its "last" agent key.

    Note: The encrypted value contains 24 bytes of binary data.

  • SM_AGENTAPI_AGENT_KEY_UPDATE_CURRENT (value = 192)

    Instructs the agent to update its "current" agent key.

    Note: The encrypted value contains 24 bytes of binary data.

  • SM_AGENTAPI_AGENT_KEY_UPDATE_PERSISTENT (value = 193)

    Instructs the agent to update its static (persistent) agent key.

    Note: The encrypted value contains 24 bytes of binary data.

  • SM_AGENTAPI_CACHE_FLUSH_ALL (value = 194)

    Instructs the agent to flush all information in its caches.

  • SM_AGENTAPI_CACHE_FLUSH_ALL_USERS (value = 195)

    Instructs the agent to flush all user information stored in its caches.

  • SM_AGENTAPI_CACHE_FLUSH_THIS_USER (value = 196)

    Instructs the agent to flush all cache information for a given user.

  • SM_AGENTAPI_CACHE_FLUSH_ALL_REALMS (value = 197)

    Instructs the agent to flush all resource information stored in its caches.

  • SM_AGENTAPI_CACHE_FLUSH_THIS_REALM (value = 198)

    Instructs the agent to flush all resource information for a given realm.

GetName Method—Retrieves Response Attribute's Name

The GetName method retrieves the name of the response attribute.

Syntax

The GetName method has the following format:

Netegrity::AgentResponseAttr‑>GetName()

Parameters

The GetName method accepts no parameters.

Return Value

The GetName method returns the following value:

• response_attribute_name (string)

GetTTL Method—Retrieves Response Attribute's TTL Value

The GetTTL method retrieves the response attribute's Time To Live (TTL) value.

Syntax

The GetTTL method has the following format:

Netegrity::AgentResponseAttr‑>GetTTL()

Parameters

The GetTTL method accepts no parameters.

Return Value

The GetTTL method returns the following value:

• Time_To_Live_value (long)

GetValue Method—Retrieves Response Attribute's Value

The GetValue method retrieves the response attribute's value.

Syntax

The GetValue method has the following format:

Netegrity::AgentResponseAttr‑>GetValue()

Parameters

The GetValue method accepts no parameters.

Return Value

The GetValue method returns the following value:

• response_attribute_value (string)