Programming Guides › Programming Guide for Perl › CLI Agent API Methods › User Methods › Validate Method—Validates a Session Specification

Validate Method—Validates a Session Specification

The Validate method validates a session specification, checking that a user session has neither expired nor been terminated or revoked. This check can occur at any time during the life of a session.

Syntax

The Validate method has the following format:

Netegrity::AgentUser‑>Validate(resource[, clientIP][, transID])

Parameters

The Validate method accepts the following parameters:

resource (AgentResource object)

Specifies the resource to log in to.

clientIP (string)

(Optional) Specifies the client's IP address.

transID (string)

(Optional) Specifies a user-defined transaction ID.

Return Value

The Validate method returns one of the following values:

• SM_AGENTAPI_YES (value = 1)

  Specifies that the operation was successful.

• SM_AGENTAPI_NO (value = 2)

  Specifies that the user was not logged in.

• SM_AGENTAPI_FAILURE (value = -1)

  Specifies that the operation failed.

• SM_AGENTAPI_TIMEOUT (value = -2)

  Specifies that the method timed out.

• SM_AGENTAPI_NOCONNECTION (value = -3)

  Specifies that the object was not connected.

Remarks

The Policy Server validates a session specification or session ID, as follows:

• If the session ID is specified without a session specification, the Policy Server uses the session ID for validation.
• If the session ID is specified with a session specification, the Policy Server validates the session ID against the session specification.
• If the client's IP address is specified with a session specification, the Policy Server validates the IP address against the session specification.