Authentication commands
Authentication (AUTH) commands contain functions related to authentication and login:
-
AUTH:get_baked_cookie() — Allows you to retrieve the baked cookie.
-
AUTH:set_baked_cookie(cookie) — Allows you to customize the cookie attribute of the baked cookie.
-
AUTH:on_off() — Returns whether authentication is required or not.
-
AUTH:success() — Returns whether authentication is successful or not.
-
AUTH:form_based() — Returns whether the authentication is HTTP form based or not.
-
AUTH:user() — Returns the user name in the authentication.
-
AUTH:pass() — Returns the password in the authentication.
-
AUTH:usergroup() — Returns the usergroup which the user belong to.
-
AUTH:realm() — Returns the realm in the authentication.
-
AUTH:host() — Returns the host in the authentication.
-
AUTH:set_usergroup() — Sets a new user group that is configured in the current authentication policy.
-
AUTH:auth_flags() — Gets authentication flags at the transaction level. This command returns the flags as an integer.
-
AUTH:author_type() — Gets the authentication behavior type. This command returns the type as an integer.
-
AUTH:clt_meth() — Gets the authentication client method. This command returns the method as an integer.
-
AUTH:domain_prefix() — Gets the authentication domain prefix. This command returns a string if successful, otherwise returns Boolean false.
-
AUTH:flags() — Gets authentication flags at the transaction level. This command returns the flags as an integer.
-
AUTH:logoff() — Gets the authentication log-off URI. This command returns a string if successful, otherwise returns Boolean false.
-
AUTH:method() — Gets the authentication method. This command returns the method as an integer.
-
AUTH:relay_type() — Gets the authentication relay type. This command returns the type as an integer.
-
AUTH:result() — Gets the authentication result. This command returns the result as an integer.
-
AUTH:sso_domain — Gets the authentication SSO domain. This command returns a string if successful, otherwise returns Boolean false.
-
AUTH:sso_group() — Gets authentication the SSO group type. This command returns the result as an integer. It can be zero or one.
-
AUTH:uri() — Gets the authentication URI. This command returns a string if successful, otherwise returns Boolean false.