com.auth0.authentication

Class SignUpRequest

java.lang.Object

com.auth0.authentication.SignUpRequest

All Implemented Interfaces:

AuthenticationRequest, Request<Credentials>

public class SignUpRequest
extends java.lang.Object
implements Request<Credentials>, AuthenticationRequest

Represent a request that creates a user in a Auth0 Database connection and then logs in.

Method Summary

Methods

Modifier and Type	Method and Description
SignUpRequest	addAuthenticationParameters(java.util.Map<java.lang.String,java.lang.Object> parameters) Add additional parameters sent when logging the user in
SignUpRequest	addSignUpParameters(java.util.Map<java.lang.String,java.lang.Object> parameters) Add additional parameters sent when creating a using.
Credentials	execute() Execute the create user request and then logs the user in.
AuthenticationRequest	setAccessToken(java.lang.String accessToken) Sets the 'access_token' parameter
SignUpRequest	setConnection(java.lang.String connection) Set the connection used to authenticate
AuthenticationRequest	setDevice(java.lang.String device) Sets the 'device' parameter
AuthenticationRequest	setGrantType(java.lang.String grantType) Sets the 'grant_type' parameter
SignUpRequest	setScope(java.lang.String scope) Set the scope used to login the user
void	start(BaseCallback<Credentials> callback) Starts to execute create user request and then logs the user in.

Methods inherited from class java.lang.Object

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

Method Detail

addSignUpParameters

public SignUpRequest addSignUpParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)

Add additional parameters sent when creating a using.

Parameters:

parameters - sent with the request and must be non-null

Returns:

itself

addAuthenticationParameters

public SignUpRequest addAuthenticationParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)

Add additional parameters sent when logging the user in

Specified by:

addAuthenticationParameters in interface AuthenticationRequest

Parameters:

parameters - sent with the request and must be non-null

Returns:

itself

See Also:

ParameterBuilder

setScope

public SignUpRequest setScope(java.lang.String scope)

Set the scope used to login the user

Specified by:

setScope in interface AuthenticationRequest

Parameters:

scope - value

Returns:

itself

setDevice

public AuthenticationRequest setDevice(java.lang.String device)

Description copied from interface: AuthenticationRequest

Sets the 'device' parameter

Specified by:

setDevice in interface AuthenticationRequest

Parameters:

device - a device name

Returns:

itself

setAccessToken

public AuthenticationRequest setAccessToken(java.lang.String accessToken)

Description copied from interface: AuthenticationRequest

Sets the 'access_token' parameter

Specified by:

setAccessToken in interface AuthenticationRequest

Parameters:

accessToken - a access token

Returns:

itself

setGrantType

public AuthenticationRequest setGrantType(java.lang.String grantType)

Description copied from interface: AuthenticationRequest

Sets the 'grant_type' parameter

Specified by:

setGrantType in interface AuthenticationRequest

Parameters:

grantType - grant type

Returns:

itself

setConnection

public SignUpRequest setConnection(java.lang.String connection)

Set the connection used to authenticate

Specified by:

setConnection in interface AuthenticationRequest

Parameters:

connection - name

Returns:

itself

start

public void start(BaseCallback<Credentials> callback)

Starts to execute create user request and then logs the user in.

Specified by:

start in interface Request<Credentials>

Parameters:

callback - called on either success or failure.

execute

public Credentials execute()
                    throws Auth0Exception

Execute the create user request and then logs the user in.

Specified by:

execute in interface Request<Credentials>

Returns:

authentication object on success

Throws:

Auth0Exception - on failure