class Auth0AuthApi in Auth0 Single Sign On 8.2

This class provides access to Auth0 Platform auth API.

@codeCoverageIgnore - Deprecated

Hierarchy

• class \Auth0\SDK\API\Authentication
  • class \Auth0\SDK\Auth0AuthApi

Deprecated

4.0.0, provided for bring backwards-compat and will be soon removed; use Auth0\SDK\API\Authentication instead

File

vendor/auth0/auth0-php/src/Auth0AuthApi.php, line 11

Namespace

Auth0\SDK

class Auth0AuthApi extends \Auth0\SDK\API\Authentication {

}

Members

Name	Modifiers	Type	Description	Overrides
Authentication::$apiClient	private	property	ApiClient instance.
Authentication::$audience	private	property	API audience identifier for the access token.
Authentication::$client_id	private	property	Client ID for the Auth0 Application.
Authentication::$client_secret	private	property	Client Secret for the Auth0 Application.
Authentication::$domain	private	property	Domain for the Auth0 Tenant.
Authentication::$guzzleOptions	private	property	Options for the Guzzle HTTP client.
Authentication::$scope	private	property	Scopes to request during login.
Authentication::authorize_with_accesstoken Deprecated	public	function	Authorize using an access token
Authentication::authorize_with_ro Deprecated	public	function	DEPRECATED - This endpoint is part of the legacy authentication pipeline and has been replaced in favor of the Password Grant. For more information on the latest authentication pipeline refer to Introducing OIDC Conformant Authentication.
Authentication::client_credentials	public	function	Makes a call to the `oauth/token` endpoint with `client_credentials` grant type.
Authentication::code_exchange	public	function	Makes a call to the `oauth/token` endpoint with `authorization_code` grant type
Authentication::dbconnections_change_password	public	function	Send a change password email. This endpoint only works for database connections.
Authentication::dbconnections_signup	public	function	Create a new user using active authentication. This endpoint only works for database connections.
Authentication::email_code_passwordless_verify Deprecated	public	function	Verify email code
Authentication::email_passwordless_start	public	function	Start passwordless login process for email
Authentication::get_authorize_link	public	function	Builds and returns the authorization URL.
Authentication::get_logout_link	public	function	Builds and returns a logout URL to terminate an SSO session.
Authentication::get_samlp_link	public	function	Build and return a SAMLP link.
Authentication::get_samlp_metadata_link	public	function	Build and return a SAMLP metadata link.
Authentication::get_wsfed_link	public	function	Build and return a WS-Federation link
Authentication::get_wsfed_metadata_link	public	function	Build and return a WS-Federation metadata link
Authentication::impersonate Deprecated	public	function	Obtain an impersonation URL to login as another user. Impersonation functionality may be disabled by default for your tenant.
Authentication::login	public	function	Makes a call to the `oauth/token` endpoint with `password-realm` grant type.
Authentication::login_with_default_directory	public	function	Makes a call to the `oauth/token` endpoint with `password` grant type
Authentication::oauth_token	public	function	Makes a call to the `oauth/token` endpoint.
Authentication::refresh_token	public	function	Use a refresh token grant to get new tokens.
Authentication::setApiClient Deprecated	protected	function	Set an ApiClient for use in this object
Authentication::sms_code_passwordless_verify Deprecated	public	function	Verify SMS code
Authentication::sms_passwordless_start	public	function	Start passwordless login process for SMS.
Authentication::userinfo	public	function	Make an authenticated request to the /userinfo endpoint.
Authentication::__construct	public	function	Authentication constructor.