Programming Guides › Programming Guide for Perl › CLI Agent API Methods › User Methods › IsAuthorized Method—Determines Whether User Is Authorized

IsAuthorized Method—Determines Whether User Is Authorized

The IsAuthorized method determines whether the user is authorized to perform the specified action on the specified resource. This method calls AgentUser‑>Login, if AgentUser‑>Login has not been called. After calling this method, call AgentUser‑>GetResponse.

Syntax

The IsAuthorized method has the following format:

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

Parameters

The IsAuthorized method accepts the following parameters:

resource (AgentResource object)

Specifies the resource to check.

clientIP (string)

(Optional) Specifies the client's IP address.

transID (string)

(Optional) Specifies the user-defined transaction ID that the agent uses to associate application activity with security activity.

Return Value

The IsAuthorized method returns one of the following values:

• SM_AGENTAPI_YES (value = 1)

  Specifies that the user is authorized.

• SM_AGENTAPI_NO (value = 2)

  Specifies that the user is not authorized.

• SM_AGENTAPI_FAILURE (value = -1)

  Specifies that the Policy Server could not be reached.

• SM_AGENTAPI_TIMEOUT (value = -2)

  Specifies that the method timed out.

• SM_AGENTAPI_NOCONNECTION (value = -3)

  Specifies that initialization was not done.