ltm rule command AUTH status

iRule(1)		      BIG-IP TMSH Manual		      iRule(1)



AUTH::status
       Returns authentication status.

SYNOPSIS
       AUTH::status (AUTH_ID)?

DESCRIPTION
       Returns authentication status. The returned status is a value of 0, 1,
       -1, or 2, corresponding to success, failure, error, or not-authed,
       based on the result of the most recent authorization that the system
       performed for the specified authorization session .  In the case of a
       not-authed result, the authentication process desires a credential not
       yet provided. Specifics of the requested credential can be determined
       using the AUTH::wantcredential_ commands. The authentication process
       could be continued using AUTH::authenticate_continue*.

       AUTH::status 

	    * Returns authentication status. The returned status is a value of 0,
	      1, -1, or 2, corresponding to success, failure, error, or
	      not-authed, based on the result of the most recent authorization
	      that the system performed for the specified authorization session
	      .

RETURN VALUE
VALID DURING
EXAMPLES
	when HTTP_RESPONSE {
	  set authStatus [AUTH::status $authSessionId]
	}

HINTS
SEE ALSO
CHANGE LOG
       @BIGIP-9.0.0 --First introduced the command.



BIG-IP				  2017-01-31			      iRule(1)