Programming Guides › Programming Guide for Perl › CLI Agent API Methods › Session Methods › GetReason Method—Retrieves the Session's Reason ID

GetReason Method—Retrieves the Session's Reason ID

The GetReason method retrieves the session's reason ID. The reason ID specifies a reason for a failed authentication or authorization.

Syntax

The GetReason method has the following format:

Netegrity::AgentSession‑>GetReason()

Parameters

The GetReason method accepts no parameters.

Return Value

The GetReason method returns one of the following values (long):

• Sm_Api_Reason_None (value = 0)
• Sm_Api_Reason_PwMustChange (value = 1)
• Sm_Api_Reason_InvalidSession (value = 2)
• Sm_Api_Reason_RevokedSession (value = 3)
• Sm_Api_Reason_ExpiredSession (value = 4)
• Sm_Api_Reason_AuthLevelTooLow (value = 5)
• Sm_Api_Reason_UnknownUser (value = 6)
• Sm_Api_Reason_UserDisabled (value = 7)
• Sm_Api_Reason_InvalidSessionId (value = 8)
• Sm_Api_Reason_InvalidSessionIp (value = 9)
• Sm_Api_Reason_CertificateRevoked (value = 10)
• Sm_Api_Reason_CRLOutOfDate (value = 11)
• Sm_Api_Reason_CertRevokedKeyCompromised (value = 12)
• Sm_Api_Reason_CertRevokedAffiliationChange (value = 13)
• Sm_Api_Reason_CertOnHold (value = 14)
• Sm_Api_Reason_TokenCardChallenge (value = 15)
• Sm_Api_Reason_ImpersonatedUserNotInDir (value = 16)
• Sm_Api_Reason_Anonymous (value = 17)
• Sm_Api_Reason_PwWillExpire (value = 18)
• Sm_Api_Reason_PwExpired (value = 19)
• Sm_Api_Reason_ImmedPWChangeRequired (value = 20)
• Sm_Api_Reason_PWChangeFailed (value = 21)
• Sm_Api_Reason_BadPWChange (value = 22)
• Sm_Api_Reason_PWChangeAccepted (value = 23)
• Sm_Api_Reason_ExcessiveFailedLoginAttempts (value = 24)
• Sm_Api_Reason_AccountInactivity (value = 25)
• Sm_Api_Reason_NoRedirectConfigured (value = 26)
• Sm_Api_Reason_ErrorMessageIsRedirect (value = 27)
• Sm_Api_Reason_Next_Tokencode (value = 28)
• Sm_Api_Reason_New_PIN_Select (value = 29)
• Sm_Api_Reason_New_PIN_Sys_Tokencode (value = 30)
• Sm_Api_Reason_New_User_PIN_Tokencode (value = 31)
• Sm_Api_Reason_New_PIN_Accepted (value = 32)
• Sm_Api_Reason_Guest (value = 33)
• Sm_Api_Reason_PWSelfChange (value = 34)
• Sm_Api_Reason_ServerException (value = 35)
• Sm_Api_Reason_UnknownScheme (value = 36)
• Sm_Api_Reason_UnsupportedScheme (value = 37)
• Sm_Api_Reason_Misconfigured (value = 38)
• Sm_Api_Reason_BufferOverflow (value = 39)
• Sm_Api_Reason_SetPersistentSessionFailed (value = 40)