com.auth0.client.mgmt

Class GuardianEntity

java.lang.Object

com.auth0.client.mgmt.GuardianEntity

public class GuardianEntity
extends java.lang.Object

Class that provides an implementation of the Guardian methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Guardian

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	apiToken
protected java.lang.String	baseUrl
protected okhttp3.OkHttpClient	client

Method Summary

Modifier and Type	Method and Description
Request<EnrollmentTicket>	createEnrollmentTicket(EnrollmentTicket enrollmentTicket) Create a new Guardian Enrollment Ticket.
Request	deleteEnrollment(java.lang.String enrollmentId) Delete an existing Guardian Enrollment.
Request<SNSFactorProvider>	getSNSFactorProvider() Request the Guardian's Sns Factor Provider.
Request<GuardianTemplates>	getTemplates() Request the Guardian enrollment and verification Templates.
Request<TwilioFactorProvider>	getTwilioFactorProvider() Request the Guardian's Twilio Factor Provider.
Request<java.util.List<Factor>>	listFactors() Request all the Guardian Factors.
Request<Factor>	updateFactor(java.lang.String name, java.lang.Boolean enabled) Update an existing Guardian Factor.
Request<SNSFactorProvider>	updateSNSFactorProvider(SNSFactorProvider provider) Update the existing Guardian's Sns Factor Provider.
Request<GuardianTemplates>	updateTemplates(GuardianTemplates guardianTemplates) Updates the existing Guardian enrollment and verification Templates.
Request<TwilioFactorProvider>	updateTwilioFactorProvider(TwilioFactorProvider provider) Update the existing Guardian's Twilio Factor Provider.

Methods inherited from class java.lang.Object

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

Field Detail

client

protected final okhttp3.OkHttpClient client

baseUrl

protected final java.lang.String baseUrl

apiToken

protected final java.lang.String apiToken

Method Detail

createEnrollmentTicket

public Request<EnrollmentTicket> createEnrollmentTicket(EnrollmentTicket enrollmentTicket)

Create a new Guardian Enrollment Ticket. A token with scope create:guardian_enrollment_tickets is needed. See https://auth0.com/docs/api/management/v2#!/Guardian/post_ticket

Parameters:

enrollmentTicket - the enrollment ticket data to set.

Returns:

a Request to execute.

deleteEnrollment

public Request deleteEnrollment(java.lang.String enrollmentId)

Delete an existing Guardian Enrollment. A token with scope delete:guardian_enrollments is needed. See https://auth0.com/docs/api/management/v2#!/Guardian/delete_enrollments_by_id

Parameters:

enrollmentId - the id of the enrollment to retrieve.

Returns:

a Request to execute.

getTemplates

public Request<GuardianTemplates> getTemplates()

Request the Guardian enrollment and verification Templates. A token with scope read:guardian_factors is needed. See https://auth0.com/docs/api/management/v2#!/Guardian/get_templates

Returns:

a Request to execute.

updateTemplates

public Request<GuardianTemplates> updateTemplates(GuardianTemplates guardianTemplates)

Updates the existing Guardian enrollment and verification Templates. A token with scope update:guardian_factors is needed. See https://auth0.com/docs/api/management/v2#!/Guardian/put_templates

Parameters:

guardianTemplates - the templates data to set.

Returns:

a Request to execute.

listFactors

public Request<java.util.List<Factor>> listFactors()

Request all the Guardian Factors. A token with scope read:guardian_factors is needed. See https://auth0.com/docs/api/management/v2#!/Guardian/get_factors

Returns:

a Request to execute.

updateFactor

public Request<Factor> updateFactor(java.lang.String name,
                                    java.lang.Boolean enabled)

Update an existing Guardian Factor. A token with scope update:guardian_factors is needed. See https://auth0.com/docs/api/management/v2#!/Guardian/put_factors_by_name

Parameters:

name - the name of the Factor to update.

enabled - whether to enable or disable the Factor.

Returns:

a Request to execute.

getTwilioFactorProvider

public Request<TwilioFactorProvider> getTwilioFactorProvider()

Request the Guardian's Twilio Factor Provider. A token with scope read:guardian_factors is needed. See https://auth0.com/docs/api/management/v2#!/Guardian/get_twilio

Returns:

a Request to execute.

updateTwilioFactorProvider

public Request<TwilioFactorProvider> updateTwilioFactorProvider(TwilioFactorProvider provider)

Update the existing Guardian's Twilio Factor Provider. A token with scope update:guardian_factors is needed. See https://auth0.com/docs/api/management/v2#!/Guardian/put_twilio

Parameters:

provider - the provider data to set.

Returns:

a Request to execute.

getSNSFactorProvider

public Request<SNSFactorProvider> getSNSFactorProvider()

Request the Guardian's Sns Factor Provider. A token with scope read:guardian_factors is needed. See https://auth0.com/docs/api/management/v2#!/Guardian/get_sns

Returns:

a Request to execute.

updateSNSFactorProvider

public Request<SNSFactorProvider> updateSNSFactorProvider(SNSFactorProvider provider)

Update the existing Guardian's Sns Factor Provider. A token with scope update:guardian_factors is needed. See https://auth0.com/docs/api/management/v2#!/Guardian/put_sns

Parameters:

provider - the provider data to set.

Returns:

a Request to execute.