Package com.auth0.client.mgmt

Class RulesConfigsEntity

java.lang.Object

com.auth0.client.mgmt.RulesConfigsEntity

public class RulesConfigsEntity
extends Object

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

This class is not thread-safe.

See Also:

• ManagementAPI

Field Summary

Fields

Modifier and Type	Field	Description
protected final okhttp3.HttpUrl	baseUrl
protected final Auth0HttpClient	client
protected final TokenProvider	tokenProvider

Method Summary

Modifier and Type	Method	Description
Request<Void>	delete(String rulesConfigKey)	Delete an existing Rules Config.
Request<List<RulesConfig>>	list()	Request all the Rules Configs.
protected <T> Request<T>	request(HttpMethod method, com.fasterxml.jackson.core.type.TypeReference<T> target, Consumer<com.auth0.client.mgmt.RequestBuilder<T>> customizer)
Request<RulesConfig>	update(String rulesConfigKey, RulesConfig rulesConfig)	Update an existing Rules Config.
protected Request<Void>	voidRequest(HttpMethod method, Consumer<com.auth0.client.mgmt.RequestBuilder<Void>> customizer)

Methods inherited from class java.lang.Object

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

Field Details

client

protected final Auth0HttpClient client

baseUrl

protected final okhttp3.HttpUrl baseUrl

tokenProvider

protected final TokenProvider tokenProvider

Method Details

list

public Request<List<RulesConfig>> list()

Request all the Rules Configs. A token with scope read:rules_configs is needed. See https://auth0.com/docs/api/management/v2#!/Rules_Configs/get_rules_configs

Note: For security, config variable values cannot be retrieved outside rule execution.

Returns:

a Request to execute.

delete

public Request<Void> delete(String rulesConfigKey)

Delete an existing Rules Config. A token with scope delete:rules_configs is needed. See https://auth0.com/docs/api/management/v2#!/Rules_Configs/delete_rules_configs_by_key

Parameters:

rulesConfigKey - the rules config key

Returns:

a Request to execute.

update

public Request<RulesConfig> update(String rulesConfigKey,
 RulesConfig rulesConfig)

Update an existing Rules Config. A token with scope update:rules_configs is needed. See https://auth0.com/docs/api/management/v2#!/Rules_Configs/put_rules_configs_by_key

Parameters:

rulesConfigKey - the rules config key

rulesConfig - the rules config data to set. It can't include key.

Returns:

a Request to execute.

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)