ltm rule command AUTH wantcredential prompt

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

AUTH::wantcredential_prompt
       Returns a string for an authorization session authidXs credential prompt.

SYNOPSIS
       AUTH::wantcredential_prompt AUTH_ID

DESCRIPTION
       Returns the authorization session authidXs credential prompt string that the system last requested (when the
       system generated an AUTH_WANTCREDENTIAL event). An example of a promopt string is Username:. The
       AUTH::wantcredential_prompt command is especially helpful in providing authentication services to interactive
       protocols (for example, telnet and ftp), where the actual text prompts and responses may be directly
       communicated with the remote user.

       AUTH::wantcredential_prompt 

	    * Returns the specified authorization session authidXs credential
	      prompt string that the system last requested (when the system
	      generated an AUTH_WANTCREDENTIAL event). An example of a prompt
	      string is Username:*.

RETURN VALUE
VALID DURING
       HTTP_REQUEST, HTTP_REQUEST_DATA

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)