ltm rule command AUTH authenticate

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



AUTH::authenticate
       Performs a new authentication operation.

SYNOPSIS
       AUTH::authenticate AUTH_ID

DESCRIPTION
       Performs a new authentication operation. This command returns an error
       if attempted for a standby system or while an authentication operation
       is already in progress for this authentication session.

       AUTH::authenticate 

	    * Performs a new authentication operation. This command returns an
	      error if attempted for a standby system or while an authentication
	      operation is already in progress for this authentication session.

RETURN VALUE
VALID DURING
       HTTP_REQUEST, HTTP_REQUEST_DATA

EXAMPLES
	when HTTP_REQUEST {
	  AUTH::username_credential $auth_id [HTTP::username]
	  AUTH::password_credential $auth_id [HTTP::password]
	  AUTH::authenticate $auth_id
	  HTTP::collect
	}


	when CLIENTSSL_CLIENTCERT {
	  AUTH::cert_credential $tmm_auth_ssl_ocsp_sid [SSL::cert 0]
	  AUTH::cert_issuer_credential $tmm_auth_ssl_ocsp_sid [SSL::cert issuer 0]
	  AUTH::authenticate $tmm_auth_ssl_ocsp_sid
	  SSL::handshake hold
	  set id [SSL::sessionid]
	}

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



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