AUTH¶
Description¶
The AUTH namespace deals with all things relating to authorization of
users via multiple authentication methods.
Command List¶
- AUTH::abort - Cancels any outstanding auth operations in this authentication session.
- AUTH::authenticate - Performs a new authentication operation.
- AUTH::authenticate_continue - Continues an authentication operation.
- AUTH::cert_credential - Sets the peer certificate credential to the value of a peer certificate for a future AUTH::authenticate call.
- AUTH::cert_issuer_credential - Sets the peer certificate issuer credential to the value of for a future AUTH::authenticate call.
- AUTH::last_event_session_id - Returns the session ID of the last auth event
- AUTH::password_credential - Sets the password credential to the specified string for a future AUTH::authenticate call.
- AUTH::response_data - Returns pairwise auth query results
- AUTH::ssl_cc_ldap_status - Returns the status from the last successful client certificate-based LDAP query.
- AUTH::ssl_cc_ldap_username - Returns a user name that the system retrieved from the LDAP database.
- AUTH::start - Initializes an authentication session.
- AUTH::status - Returns authentication status.
- AUTH::subscribe - Registers interest in auth query results.
- AUTH::unsubscribe - Cancels interest in auth query results.
- AUTH::username_credential - Sets the username credential to a string. for a future AUTH::authenticate call.
- AUTH::wantcredential_prompt - Returns a string for an authorization session authid’s credential prompt.
- AUTH::wantcredential_prompt_style - Returns an authorization session authid’s credential prompt style.
- AUTH::wantcredential_type - Returns an authorization session authid’s credential type
Associated Events¶
- AUTH_ERROR - Triggered when an error occurs during authorization (deprecated in 9.4).
- AUTH_FAILURE - Triggered when an unsuccessful authorization operation is completed (deprecated in 9.4).
- AUTH_RESULT - Replaces AUTH_SUCCESS. AUTH_FAILURE. AUTH_ERROR. and AUTH_WANTCREDENTIAL events.
- AUTH_SUCCESS - Triggered when a successful authorization has completed all required authentication services (deprecated in 9.4).
- AUTH_WANTCREDENTIAL - Triggered when an authorization operation needs an additional credential (deprecated in 9.4).
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.