ltm rule command AUTH wantcredential prompt style

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

AUTH::wantcredential_prompt_style
       Returns an authorization session authidXs credential prompt style.

SYNOPSIS
       AUTH::wantcredential_prompt_style AUTH_ID

DESCRIPTION
       Returns the authorization session authidXs credential prompt style that the system last requested (when the
       system generated an AUTH_WANTCREDENTIAL event). The value of the  argument is either echo_on,
       echo_off, or unknown. This command is especially helpful in providing authentication services to interactive
       protocols (or example, telnet and ftp), where the actual text prompts and responses may be directly
       communicated with the remote user.

       AUTH::wantcredential_prompt_style 

	    * Returns the authorization session authidXs credential prompt style
	      that the system last requested (when the system generated an
	      AUTH_WANTCREDENTIAL event). The value of the  argument is
	      either echo_on, echo_off, or unknown*.

RETURN VALUE
VALID DURING
EXAMPLES
	when AUTH_WANTCREDENTIAL {
	  HTTP::respond 401 "WWW-Authenticate" "Basic realm=\"\""
	}
	when AUTH_FAILURE {
	  log local0. "Auth failed: \
	       Auth type was \"[AUTH::wantcredential_type $authid]\" \
	       Auth prompt was \"[AUTH::wantcredential_prompt $authid]\"\
	       Auth prompt style was \"[AUTH::wantcredential_prompt_style $authid]\"\
	"
	}

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

BIG-IP						      2020-06-23					     iRule(1)