com.auth0.authentication

Class ProfileRequest

java.lang.Object

com.auth0.authentication.ProfileRequest

All Implemented Interfaces:

Request<Authentication>

public class ProfileRequest
extends java.lang.Object
implements Request<Authentication>

Request to fetch a profile after a successful authentication with Auth0 Authentication API

Method Summary

Methods

Modifier and Type	Method and Description
ProfileRequest	addParameters(java.util.Map<java.lang.String,java.lang.Object> parameters) Adds additional parameters for the login request
Authentication	execute() Logs in the user with Auth0 and fetches it's profile.
ProfileRequest	setConnection(java.lang.String connection) Set the connection used to authenticate
ProfileRequest	setScope(java.lang.String scope) Set the scope used to authenticate the user
void	start(BaseCallback<Authentication> callback) Starts the log in request and then fetches the user's profile

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addParameters

public ProfileRequest addParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)

Adds additional parameters for the login request

Parameters:

parameters - as a non-null dictionary

Returns:

itself

setScope

public ProfileRequest setScope(java.lang.String scope)

Set the scope used to authenticate the user

Parameters:

scope - value

Returns:

itself

setConnection

public ProfileRequest setConnection(java.lang.String connection)

Set the connection used to authenticate

Parameters:

connection - name

Returns:

itself

start

public void start(BaseCallback<Authentication> callback)

Starts the log in request and then fetches the user's profile

Specified by:

start in interface Request<Authentication>

Parameters:

callback - called on either success or failure

execute

public Authentication execute()
                       throws Auth0Exception

Logs in the user with Auth0 and fetches it's profile.

Specified by:

execute in interface Request<Authentication>

Returns:

authentication object containing the user's tokens and profile

Throws:

Auth0Exception - when either authentication or profile fetch fails