Package com.auth0.client.mgmt
Class GuardianEntity
java.lang.Object
com.auth0.client.mgmt.GuardianEntity
Class that provides an implementation of the Guardian methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Guardian
This class is not thread-safe.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected final okhttp3.HttpUrl
protected final Auth0HttpClient
protected final TokenProvider
-
Method Summary
Modifier and TypeMethodDescriptioncreateEnrollmentTicket
(EnrollmentTicket enrollmentTicket) Create a Guardian Enrollment Ticket.deleteEnrollment
(String enrollmentId) Delete an existing Guardian Enrollment.Get Guardian's MFA authentication policies.Request Guardian's SNS push-notification Factor Provider.Request the Guardian SMS enrollment and verification templates.Request Guardian's Twilio SMS Factor Provider settings.Request all the Guardian Factors.protected <T> Request<T>
request
(HttpMethod method, com.fasterxml.jackson.core.type.TypeReference<T> target, Consumer<com.auth0.client.mgmt.RequestBuilder<T>> customizer) Reset Guardian's SNS push-notification Factor Provider to the defaults.Reset Guardian's Twilio SMS Factor Provider to the defaults.updateAuthenticationPolicies
(List<String> policies) Updates Guardian's MFA authentication policies.updateFactor
(String name, Boolean enabled) Update an existing Guardian Factor.updateSNSFactorProvider
(SNSFactorProvider provider) Update Guardian's SNS push-notification Factor Provider.updateTemplates
(GuardianTemplates guardianTemplates) Updates the existing Guardian SMS enrollment and verification templates.Update Guardian's Twilio SMS Factor Provider.voidRequest
(HttpMethod method, Consumer<com.auth0.client.mgmt.RequestBuilder<Void>> customizer)
-
Field Details
-
client
-
baseUrl
protected final okhttp3.HttpUrl baseUrl -
tokenProvider
-
-
Method Details
-
createEnrollmentTicket
Create a Guardian Enrollment Ticket. A token with scope create:guardian_enrollment_tickets is needed.- Parameters:
enrollmentTicket
- the enrollment ticket data to set.- Returns:
- a Request to execute.
- See Also:
-
deleteEnrollment
Delete an existing Guardian Enrollment. A token with scope delete:guardian_enrollments is needed.- Parameters:
enrollmentId
- the id of the enrollment to retrieve.- Returns:
- a Request to execute.
- See Also:
-
getTemplates
Request the Guardian SMS enrollment and verification templates. A token with scope read:guardian_factors is needed.- Returns:
- a Request to execute.
- See Also:
-
updateTemplates
Updates the existing Guardian SMS enrollment and verification templates. A token with scope update:guardian_factors is needed.- Parameters:
guardianTemplates
- the templates data to set.- Returns:
- a Request to execute.
- See Also:
-
listFactors
Request all the Guardian Factors. A token with scope read:guardian_factors is needed.- Returns:
- a Request to execute.
- See Also:
-
updateFactor
Update an existing Guardian Factor. A token with scope update:guardian_factors is needed.- Parameters:
name
- the name of the Factor to update.enabled
- whether to enable or disable the Factor.- Returns:
- a Request to execute.
- See Also:
-
getTwilioFactorProvider
Request Guardian's Twilio SMS Factor Provider settings. A token with scope read:guardian_factors is needed.- Returns:
- a Request to execute.
- See Also:
-
updateTwilioFactorProvider
Update Guardian's Twilio SMS Factor Provider. A token with scope update:guardian_factors is needed.- Parameters:
provider
- the provider data to set.- Returns:
- a Request to execute.
- See Also:
-
resetTwilioFactorProvider
Reset Guardian's Twilio SMS Factor Provider to the defaults. A token with scope update:guardian_factors is needed.- Returns:
- a Request to execute.
- See Also:
-
getSNSFactorProvider
Request Guardian's SNS push-notification Factor Provider. A token with scope read:guardian_factors is needed.- Returns:
- a Request to execute.
- See Also:
-
updateSNSFactorProvider
Update Guardian's SNS push-notification Factor Provider. A token with scope update:guardian_factors is needed.- Parameters:
provider
- the provider data to set.- Returns:
- a Request to execute.
- See Also:
-
resetSNSFactorProvider
Reset Guardian's SNS push-notification Factor Provider to the defaults. A token with scope update:guardian_factors is needed.- Returns:
- a Request to execute.
- See Also:
-
getAuthenticationPolicies
Get Guardian's MFA authentication policies. A token with scope read:mfa_policies is needed.- Returns:
- a Request to execute
- See Also:
-
updateAuthenticationPolicies
Updates Guardian's MFA authentication policies. A token with scope update:mfa_policies is needed.- Parameters:
policies
- the list of MFA policies to enable- Returns:
- a Request to execute
- See Also:
-
voidRequest
protected Request<Void> voidRequest(HttpMethod method, Consumer<com.auth0.client.mgmt.RequestBuilder<Void>> customizer) -
request
protected <T> Request<T> request(HttpMethod method, com.fasterxml.jackson.core.type.TypeReference<T> target, Consumer<com.auth0.client.mgmt.RequestBuilder<T>> customizer)
-