<ul> - * <li> + * For more information, read Applications in Auth0 and Single Sign-On. + *
client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scope:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scope:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * <ul> - * <li> + * For more information, read Applications in Auth0 and Single Sign-On. + *
client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scope:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scope:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scope:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scope:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * <ul> - * <li> + * For more information, read Applications in Auth0 and Single Sign-On. + *
client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scope:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scope:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * <ul> - * <li> + * For more information, read Applications in Auth0 and Single Sign-On. + *
client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scopes:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scopes:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * <ul> - * <li> + * For more information, read Applications in Auth0 and Single Sign-On. + *
client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scopes:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scopes:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scopes:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scopes:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * <ul> - * <li> + * For more information, read Applications in Auth0 and Single Sign-On. + *
client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scopes:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scopes:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * Notes:
*client_secret and signing_key attributes can only be updated with the update:client_keys scope.client_authentication_methods and token_endpoint_auth_method properties are mutually exclusive. Use client_authentication_methods to configure the client with Private Key JWT authentication method. Otherwise, use token_endpoint_auth_method to configure the client with client secret (basic or post) or with no authentication method (none).client_authentication_methods to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.client_authentication_methods, the update:client_credentials scope is required.client_authentication_methods, the property jwt_configuration.alg must be set to RS256.is_first_party property to false, the organization_usage and organization_require_behavior properties must be unset.Notes:
+ *client_secret and signing_key attributes can only be updated with the update:client_keys scope.client_authentication_methods and token_endpoint_auth_method properties are mutually exclusive. Use client_authentication_methods to configure the client with Private Key JWT authentication method. Otherwise, use token_endpoint_auth_method to configure the client with client secret (basic or post) or with no authentication method (none).client_authentication_methods to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.client_authentication_methods, the update:client_credentials scope is required.client_authentication_methods, the property jwt_configuration.alg must be set to RS256.is_first_party property to false, the organization_usage and organization_require_behavior properties must be unset.Notes:
*client_secret and signing_key attributes can only be updated with the update:client_keys scope.client_authentication_methods and token_endpoint_auth_method properties are mutually exclusive. Use client_authentication_methods to configure the client with Private Key JWT authentication method. Otherwise, use token_endpoint_auth_method to configure the client with client secret (basic or post) or with no authentication method (none).client_authentication_methods to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.client_authentication_methods, the update:client_credentials scope is required.client_authentication_methods, the property jwt_configuration.alg must be set to RS256.is_first_party property to false, the organization_usage and organization_require_behavior properties must be unset.Notes:
*client_secret and signing_key attributes can only be updated with the update:client_keys scope.client_authentication_methods and token_endpoint_auth_method properties are mutually exclusive. Use client_authentication_methods to configure the client with Private Key JWT authentication method. Otherwise, use token_endpoint_auth_method to configure the client with client secret (basic or post) or with no authentication method (none).client_authentication_methods to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.client_authentication_methods, the update:client_credentials scope is required.client_authentication_methods, the property jwt_configuration.alg must be set to RS256.is_first_party property to false, the organization_usage and organization_require_behavior properties must be unset.This endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt). The generated secret is NOT base64 encoded.
- *For more information, read <a href="https://www.auth0.com/docs/get-started/applications/rotate-client-secret">Rotate Client Secrets</a>.
+ *For more information, read Rotate Client Secrets.
*/ public CompletableFutureThis endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt). The generated secret is NOT base64 encoded.
- *For more information, read <a href="https://www.auth0.com/docs/get-started/applications/rotate-client-secret">Rotate Client Secrets</a>.
+ *For more information, read Rotate Client Secrets.
*/ public CompletableFutureThis endpoint supports two types of pagination:
- *<ul> - * <li>Offset pagination</li> - * <li>Checkpoint pagination</li> - * </ul>
+ *Checkpoint pagination must be used if you need to retrieve more than 1000 connections.
- *<h2>Checkpoint Pagination</h2>
+ *To search by checkpoint, use the following parameters:
- *<ul> - * <li><code>from</code>: Optional id from which to start selection.</li> - * <li><code>take</code>: The total amount of entries to retrieve when using the from parameter. Defaults to 50.</li> - * </ul>
- *<b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.
+ *from: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
This endpoint supports two types of pagination:
- *<ul> - * <li>Offset pagination</li> - * <li>Checkpoint pagination</li> - * </ul>
+ *Checkpoint pagination must be used if you need to retrieve more than 1000 connections.
- *<h2>Checkpoint Pagination</h2>
+ *To search by checkpoint, use the following parameters:
- *<ul> - * <li><code>from</code>: Optional id from which to start selection.</li> - * <li><code>take</code>: The total amount of entries to retrieve when using the from parameter. Defaults to 50.</li> - * </ul>
- *<b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.
+ *from: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
This endpoint supports two types of pagination:
+ *Checkpoint pagination must be used if you need to retrieve more than 1000 connections.
+ *To search by checkpoint, use the following parameters:
+ *from: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
This endpoint supports two types of pagination:
- *<ul> - * <li>Offset pagination</li> - * <li>Checkpoint pagination</li> - * </ul>
+ *Checkpoint pagination must be used if you need to retrieve more than 1000 connections.
- *<h2>Checkpoint Pagination</h2>
+ *To search by checkpoint, use the following parameters:
- *<ul> - * <li><code>from</code>: Optional id from which to start selection.</li> - * <li><code>take</code>: The total amount of entries to retrieve when using the from parameter. Defaults to 50.</li> - * </ul>
- *<b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.
+ *from: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
<b>Note:</b> If a connection with the same name was recently deleted and had a large number of associated users, the deletion may still be processing. Creating a new connection with that name before the deletion completes may fail or produce unexpected results.
+ * Creates a new connection according to the JSON object received inbody.
+ * Note: If a connection with the same name was recently deleted and had a large number of associated users, the deletion may still be processing. Creating a new connection with that name before the deletion completes may fail or produce unexpected results.
*/ public CompletableFuture<b>Note:</b> If a connection with the same name was recently deleted and had a large number of associated users, the deletion may still be processing. Creating a new connection with that name before the deletion completes may fail or produce unexpected results.
+ * Creates a new connection according to the JSON object received inbody.
+ * Note: If a connection with the same name was recently deleted and had a large number of associated users, the deletion may still be processing. Creating a new connection with that name before the deletion completes may fail or produce unexpected results.
*/ public CompletableFuture<b>Note:</b> If your connection has a large amount of users associated with it, please be aware that this operation can be long running after the response is returned and may impact concurrent <a href="https://auth0.com/docs/api/management/v2/connections/post-connections">create connection</a> requests, if they use an identical connection name.
+ * Removes a specific connection from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate. + *Note: If your connection has a large amount of users associated with it, please be aware that this operation can be long running after the response is returned and may impact concurrent create connection requests, if they use an identical connection name.
*/ public CompletableFuture<b>Note:</b> If your connection has a large amount of users associated with it, please be aware that this operation can be long running after the response is returned and may impact concurrent <a href="https://auth0.com/docs/api/management/v2/connections/post-connections">create connection</a> requests, if they use an identical connection name.
+ * Removes a specific connection from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate. + *Note: If your connection has a large amount of users associated with it, please be aware that this operation can be long running after the response is returned and may impact concurrent create connection requests, if they use an identical connection name.
*/ public CompletableFuture<b>Note</b>: If you use the <code>options</code> parameter, the entire <code>options</code> object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
+ * Update details for a specific connection, including option properties for identity provider configuration. + *Note: If you use the options parameter, the entire options object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
<b>Note</b>: If you use the <code>options</code> parameter, the entire <code>options</code> object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
+ * Update details for a specific connection, including option properties for identity provider configuration. + *Note: If you use the options parameter, the entire options object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
Note: If you use the options parameter, the entire options object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
<b>Note</b>: If you use the <code>options</code> parameter, the entire <code>options</code> object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
+ * Update details for a specific connection, including option properties for identity provider configuration. + *Note: If you use the options parameter, the entire options object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
ID. 200 OK http status code response is returned when the connection is online, otherwise a 404 status code is returned along with an error message
*/
public CompletableFutureID. 200 OK http status code response is returned when the connection is online, otherwise a 404 status code is returned along with an error message
*/
public CompletableFuture<h5>Updating CUSTOM_CLIENT_IP_HEADER for a custom domain</h5>To update the <code>custom_client_ip_header</code> for a domain, the body to + *
custom_client_ip_header for a domain, the body to
* send should be:
- * <pre><code>{ "custom_client_ip_header": "cf-connecting-ip" }</code></pre>
- * <h5>Updating TLS_POLICY for a custom domain</h5>To update the <code>tls_policy</code> for a domain, the body to send should be: - * <pre><code>{ "tls_policy": "recommended" }</code></pre>
+ *{ "custom_client_ip_header": "cf-connecting-ip" }tls_policy for a domain, the body to send should be:
+ * { "tls_policy": "recommended" }TLS Policies:
*Some considerations:
*compatible TLS policy is no longer supported.<h5>Updating CUSTOM_CLIENT_IP_HEADER for a custom domain</h5>To update the <code>custom_client_ip_header</code> for a domain, the body to + *
custom_client_ip_header for a domain, the body to
+ * send should be:
+ * { "custom_client_ip_header": "cf-connecting-ip" }tls_policy for a domain, the body to send should be:
+ * { "tls_policy": "recommended" }TLS Policies:
+ *Some considerations:
+ *compatible TLS policy is no longer supported.These are the attributes that can be updated:
+ *custom_client_ip_header for a domain, the body to
* send should be:
- * <pre><code>{ "custom_client_ip_header": "cf-connecting-ip" }</code></pre>
- * <h5>Updating TLS_POLICY for a custom domain</h5>To update the <code>tls_policy</code> for a domain, the body to send should be: - * <pre><code>{ "tls_policy": "recommended" }</code></pre>
+ *{ "custom_client_ip_header": "cf-connecting-ip" }tls_policy for a domain, the body to send should be:
+ * { "tls_policy": "recommended" }TLS Policies:
*Some considerations:
*compatible TLS policy is no longer supported.<h5>Updating CUSTOM_CLIENT_IP_HEADER for a custom domain</h5>To update the <code>custom_client_ip_header</code> for a domain, the body to + *
custom_client_ip_header for a domain, the body to
* send should be:
- * <pre><code>{ "custom_client_ip_header": "cf-connecting-ip" }</code></pre>
- * <h5>Updating TLS_POLICY for a custom domain</h5>To update the <code>tls_policy</code> for a domain, the body to send should be: - * <pre><code>{ "tls_policy": "recommended" }</code></pre>
+ *{ "custom_client_ip_header": "cf-connecting-ip" }tls_policy for a domain, the body to send should be:
+ * { "tls_policy": "recommended" }TLS Policies:
*Some considerations:
*compatible TLS policy is no longer supported.Note: Check the <code>status</code> field to see its verification status. Once verification is complete, it may take up to 10 minutes before the custom domain can start accepting requests.
- *For <code>self_managed_certs</code>, when the custom domain is verified for the first time, the response will also include the <code>cname_api_key</code> which you will need to configure your proxy. This key must be kept secret, and is used to validate the proxy requests.
- *<a href="https://auth0.com/docs/custom-domains#step-2-verify-ownership">Learn more</a> about verifying custom domains that use Auth0 Managed certificates. - * <a href="https://auth0.com/docs/custom-domains/self-managed-certificates#step-2-verify-ownership">Learn more</a> about verifying custom domains that use Self Managed certificates.
+ *Note: Check the status field to see its verification status. Once verification is complete, it may take up to 10 minutes before the custom domain can start accepting requests.
For self_managed_certs, when the custom domain is verified for the first time, the response will also include the cname_api_key which you will need to configure your proxy. This key must be kept secret, and is used to validate the proxy requests.
Learn more about verifying custom domains that use Auth0 Managed certificates. + * Learn more about verifying custom domains that use Self Managed certificates.
*/ public CompletableFutureNote: Check the <code>status</code> field to see its verification status. Once verification is complete, it may take up to 10 minutes before the custom domain can start accepting requests.
- *For <code>self_managed_certs</code>, when the custom domain is verified for the first time, the response will also include the <code>cname_api_key</code> which you will need to configure your proxy. This key must be kept secret, and is used to validate the proxy requests.
- *<a href="https://auth0.com/docs/custom-domains#step-2-verify-ownership">Learn more</a> about verifying custom domains that use Auth0 Managed certificates. - * <a href="https://auth0.com/docs/custom-domains/self-managed-certificates#step-2-verify-ownership">Learn more</a> about verifying custom domains that use Self Managed certificates.
+ *Note: Check the status field to see its verification status. Once verification is complete, it may take up to 10 minutes before the custom domain can start accepting requests.
For self_managed_certs, when the custom domain is verified for the first time, the response will also include the cname_api_key which you will need to configure your proxy. This key must be kept secret, and is used to validate the proxy requests.
Learn more about verifying custom domains that use Auth0 Managed certificates. + * Learn more about verifying custom domains that use Self Managed certificates.
*/ public CompletableFuturepublic_key, refresh_token, or rotating_refresh_token) associated with a specific user.
*/
public CompletableFuturepublic_key, refresh_token, or rotating_refresh_token) associated with a specific user.
+ */
+ public CompletableFuturepublic_key, refresh_token, or rotating_refresh_token) associated with a specific user.
*/
public CompletableFuturepublic_key, refresh_token, or rotating_refresh_token) associated with a specific user.
*/
public CompletableFutureWhen refresh token rotation is enabled, the endpoint becomes consistent. For more information, read <a href="https://auth0.com/docs/get-started/tenant-settings/signing-keys"> Signing Keys</a>.
+ * Create a device credential public key to manage refresh token rotation for a givenuser_id. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.
+ * When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read Signing Keys.
*/ public CompletableFutureWhen refresh token rotation is enabled, the endpoint becomes consistent. For more information, read <a href="https://auth0.com/docs/get-started/tenant-settings/signing-keys"> Signing Keys</a>.
+ * Create a device credential public key to manage refresh token rotation for a givenuser_id. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.
+ * When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read Signing Keys.
*/ public CompletableFuture<h5>Sample Response</h5><pre><code>[{ + * Retrieve details on log streams. + *
[{
* "id": "string",
* "name": "string",
* "type": "eventbridge",
@@ -97,15 +97,15 @@ public AsyncRawLogStreamsClient withRawResponse() {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }]</code></pre>
+ * }]<h5>Sample Response</h5><pre><code>[{ + * Retrieve details on log streams. + *
[{
* "id": "string",
* "name": "string",
* "type": "eventbridge",
@@ -169,7 +169,7 @@ public CompletableFuture> list() {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }]</code></pre>
+ * }] <h5>Log Stream Types</h5> The <code>type</code> of log stream being created determines the properties required in the <code>sink</code> payload. - * <h5>HTTP Stream</h5> For an <code>http</code> Stream, the <code>sink</code> properties are listed in the payload below - * Request: <pre><code>{ + *
type of log stream being created determines the properties required in the sink payload.
+ * http Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "http",
* "sink": {
@@ -188,8 +188,8 @@ public CompletableFuture> list(RequestOptions requ
* "httpContentFormat": "JSONLINES|JSONARRAY",
* "httpAuthorization": "string"
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * } {
* "id": "string",
* "name": "string",
* "type": "http",
@@ -200,17 +200,17 @@ public CompletableFuture> list(RequestOptions requ
* "httpContentFormat": "JSONLINES|JSONARRAY",
* "httpAuthorization": "string"
* }
- * }</code></pre>
- * <h5>Amazon EventBridge Stream</h5> For an <code>eventbridge</code> Stream, the <code>sink</code> properties are listed in the payload below
- * Request: <pre><code>{
+ * } eventbridge Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "eventbridge",
* "sink": {
* "awsRegion": "string",
* "awsAccountId": "string"
* }
- * }</code></pre>
- * The response will include an additional field <code>awsPartnerEventSource</code> in the <code>sink</code>: <pre><code>{
+ * }awsPartnerEventSource in the sink: {
* "id": "string",
* "name": "string",
* "type": "eventbridge",
@@ -220,9 +220,9 @@ public CompletableFuture> list(RequestOptions requ
* "awsRegion": "string",
* "awsPartnerEventSource": "string"
* }
- * }</code></pre>
- * <h5>Azure Event Grid Stream</h5> For an <code>Azure Event Grid</code> Stream, the <code>sink</code> properties are listed in the payload below
- * Request: <pre><code>{
+ * } Azure Event Grid Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "eventgrid",
* "sink": {
@@ -230,8 +230,8 @@ public CompletableFuture> list(RequestOptions requ
* "azureResourceGroup": "string",
* "azureRegion": "string"
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * } {
* "id": "string",
* "name": "string",
* "type": "http",
@@ -242,17 +242,17 @@ public CompletableFuture> list(RequestOptions requ
* "azureRegion": "string",
* "azurePartnerTopic": "string"
* }
- * }</code></pre>
- * <h5>Datadog Stream</h5> For a <code>Datadog</code> Stream, the <code>sink</code> properties are listed in the payload below
- * Request: <pre><code>{
+ * } Datadog Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "datadog",
* "sink": {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * }{
* "id": "string",
* "name": "string",
* "type": "datadog",
@@ -261,9 +261,9 @@ public CompletableFuture> list(RequestOptions requ
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre>
- * <h5>Splunk Stream</h5> For a <code>Splunk</code> Stream, the <code>sink</code> properties are listed in the payload below
- * Request: <pre><code>{
+ * } Splunk Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "splunk",
* "sink": {
@@ -272,8 +272,8 @@ public CompletableFuture> list(RequestOptions requ
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * } {
* "id": "string",
* "name": "string",
* "type": "splunk",
@@ -284,16 +284,16 @@ public CompletableFuture> list(RequestOptions requ
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre>
- * <h5>Sumo Logic Stream</h5> For a <code>Sumo Logic</code> Stream, the <code>sink</code> properties are listed in the payload below
- * Request: <pre><code>{
+ * } Sumo Logic Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "sumo",
* "sink": {
* "sumoSourceAddress": "string",
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * }{
* "id": "string",
* "name": "string",
* "type": "sumo",
@@ -301,7 +301,7 @@ public CompletableFuture> list(RequestOptions requ
* "sink": {
* "sumoSourceAddress": "string",
* }
- * }</code></pre>
+ * } <h5>Log Stream Types</h5> The <code>type</code> of log stream being created determines the properties required in the <code>sink</code> payload. - * <h5>HTTP Stream</h5> For an <code>http</code> Stream, the <code>sink</code> properties are listed in the payload below - * Request: <pre><code>{ + *
type of log stream being created determines the properties required in the sink payload.
+ * http Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "http",
* "sink": {
@@ -320,8 +320,8 @@ public CompletableFuture create(CreateLogStreamR
* "httpContentFormat": "JSONLINES|JSONARRAY",
* "httpAuthorization": "string"
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * } {
* "id": "string",
* "name": "string",
* "type": "http",
@@ -332,17 +332,17 @@ public CompletableFuture create(CreateLogStreamR
* "httpContentFormat": "JSONLINES|JSONARRAY",
* "httpAuthorization": "string"
* }
- * }</code></pre>
- * <h5>Amazon EventBridge Stream</h5> For an <code>eventbridge</code> Stream, the <code>sink</code> properties are listed in the payload below
- * Request: <pre><code>{
+ * } eventbridge Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "eventbridge",
* "sink": {
* "awsRegion": "string",
* "awsAccountId": "string"
* }
- * }</code></pre>
- * The response will include an additional field <code>awsPartnerEventSource</code> in the <code>sink</code>: <pre><code>{
+ * }awsPartnerEventSource in the sink: {
* "id": "string",
* "name": "string",
* "type": "eventbridge",
@@ -352,9 +352,9 @@ public CompletableFuture create(CreateLogStreamR
* "awsRegion": "string",
* "awsPartnerEventSource": "string"
* }
- * }</code></pre>
- * <h5>Azure Event Grid Stream</h5> For an <code>Azure Event Grid</code> Stream, the <code>sink</code> properties are listed in the payload below
- * Request: <pre><code>{
+ * } Azure Event Grid Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "eventgrid",
* "sink": {
@@ -362,8 +362,8 @@ public CompletableFuture create(CreateLogStreamR
* "azureResourceGroup": "string",
* "azureRegion": "string"
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * } {
* "id": "string",
* "name": "string",
* "type": "http",
@@ -374,17 +374,17 @@ public CompletableFuture create(CreateLogStreamR
* "azureRegion": "string",
* "azurePartnerTopic": "string"
* }
- * }</code></pre>
- * <h5>Datadog Stream</h5> For a <code>Datadog</code> Stream, the <code>sink</code> properties are listed in the payload below
- * Request: <pre><code>{
+ * } Datadog Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "datadog",
* "sink": {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * }{
* "id": "string",
* "name": "string",
* "type": "datadog",
@@ -393,9 +393,9 @@ public CompletableFuture create(CreateLogStreamR
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre>
- * <h5>Splunk Stream</h5> For a <code>Splunk</code> Stream, the <code>sink</code> properties are listed in the payload below
- * Request: <pre><code>{
+ * } Splunk Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "splunk",
* "sink": {
@@ -404,8 +404,8 @@ public CompletableFuture create(CreateLogStreamR
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * } {
* "id": "string",
* "name": "string",
* "type": "splunk",
@@ -416,16 +416,16 @@ public CompletableFuture create(CreateLogStreamR
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre>
- * <h5>Sumo Logic Stream</h5> For a <code>Sumo Logic</code> Stream, the <code>sink</code> properties are listed in the payload below
- * Request: <pre><code>{
+ * } Sumo Logic Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "sumo",
* "sink": {
* "sumoSourceAddress": "string",
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * }{
* "id": "string",
* "name": "string",
* "type": "sumo",
@@ -433,7 +433,7 @@ public CompletableFuture create(CreateLogStreamR
* "sink": {
* "sumoSourceAddress": "string",
* }
- * }</code></pre>
+ * } <h5>Sample responses</h5><h5>Amazon EventBridge Log Stream</h5><pre><code>{ + *
{
* "id": "string",
* "name": "string",
* "type": "eventbridge",
@@ -452,7 +452,7 @@ public CompletableFuture create(
* "awsRegion": "string",
* "awsPartnerEventSource": "string"
* }
- * }</code></pre> <h5>HTTP Log Stream</h5><pre><code>{
+ * } {
* "id": "string",
* "name": "string",
* "type": "http",
@@ -463,7 +463,7 @@ public CompletableFuture create(
* "httpEndpoint": "string",
* "httpAuthorization": "string"
* }
- * }</code></pre> <h5>Datadog Log Stream</h5><pre><code>{
+ * } {
* "id": "string",
* "name": "string",
* "type": "datadog",
@@ -472,8 +472,8 @@ public CompletableFuture create(
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre><h5>Mixpanel</h5>
- * Request: <pre><code>{
+ * }
Mixpanel
+ * Request: {
* "name": "string",
* "type": "mixpanel",
* "sink": {
@@ -482,10 +482,10 @@ public CompletableFuture create(
* "mixpanelServiceAccountUsername": "string",
* "mixpanelServiceAccountPassword": "string"
* }
- * } </code></pre>
+ * }
*
*
- * Response: <pre><code>{
+ * Response: {
* "id": "string",
* "name": "string",
* "type": "mixpanel",
@@ -496,19 +496,19 @@ public CompletableFuture create(
* "mixpanelServiceAccountUsername": "string",
* "mixpanelServiceAccountPassword": "string" // the following is redacted on return
* }
- * } </code></pre>
+ * }
*
- * <h5>Segment</h5>
+ * Segment
*
- * Request: <pre><code> {
+ * Request: {
* "name": "string",
* "type": "segment",
* "sink": {
* "segmentWriteKey": "string"
* }
- * }</code></pre>
+ * }
*
- * Response: <pre><code>{
+ * Response: {
* "id": "string",
* "name": "string",
* "type": "segment",
@@ -516,9 +516,9 @@ public CompletableFuture create(
* "sink": {
* "segmentWriteKey": "string"
* }
- * } </code></pre>
+ * }
*
- * <h5>Splunk Log Stream</h5><pre><code>{
+ *
Splunk Log Stream
{
* "id": "string",
* "name": "string",
* "type": "splunk",
@@ -529,7 +529,7 @@ public CompletableFuture create(
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre> <h5>Sumo Logic Log Stream</h5><pre><code>{
+ * }
Sumo Logic Log Stream
{
* "id": "string",
* "name": "string",
* "type": "sumo",
@@ -537,10 +537,10 @@ public CompletableFuture create(
* "sink": {
* "sumoSourceAddress": "string",
* }
- * }</code></pre> <h5>Status</h5> The <code>status</code> of a log stream maybe any of the following:
- * 1. <code>active</code> - Stream is currently enabled.
- * 2. <code>paused</code> - Stream is currently user disabled and will not attempt log delivery.
- * 3. <code>suspended</code> - Stream is currently disabled because of errors and will not attempt log delivery.
+ * }
Status
The status of a log stream maybe any of the following:
+ * 1. active - Stream is currently enabled.
+ * 2. paused - Stream is currently user disabled and will not attempt log delivery.
+ * 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.
*/
public CompletableFuture get(String id) {
return this.rawClient.get(id).thenApply(response -> response.body());
@@ -548,7 +548,7 @@ public CompletableFuture get(String id) {
/**
* Retrieve a log stream configuration and status.
- * <h5>Sample responses</h5><h5>Amazon EventBridge Log Stream</h5><pre><code>{
+ *
Sample responses
Amazon EventBridge Log Stream
{
* "id": "string",
* "name": "string",
* "type": "eventbridge",
@@ -558,7 +558,7 @@ public CompletableFuture get(String id) {
* "awsRegion": "string",
* "awsPartnerEventSource": "string"
* }
- * }</code></pre> <h5>HTTP Log Stream</h5><pre><code>{
+ * }
HTTP Log Stream
{
* "id": "string",
* "name": "string",
* "type": "http",
@@ -569,7 +569,7 @@ public CompletableFuture get(String id) {
* "httpEndpoint": "string",
* "httpAuthorization": "string"
* }
- * }</code></pre> <h5>Datadog Log Stream</h5><pre><code>{
+ * }
Datadog Log Stream
{
* "id": "string",
* "name": "string",
* "type": "datadog",
@@ -578,8 +578,8 @@ public CompletableFuture get(String id) {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre><h5>Mixpanel</h5>
- * Request: <pre><code>{
+ * }
Mixpanel
+ * Request: {
* "name": "string",
* "type": "mixpanel",
* "sink": {
@@ -588,10 +588,10 @@ public CompletableFuture get(String id) {
* "mixpanelServiceAccountUsername": "string",
* "mixpanelServiceAccountPassword": "string"
* }
- * } </code></pre>
+ * }
*
*
- * Response: <pre><code>{
+ * Response: {
* "id": "string",
* "name": "string",
* "type": "mixpanel",
@@ -602,19 +602,19 @@ public CompletableFuture get(String id) {
* "mixpanelServiceAccountUsername": "string",
* "mixpanelServiceAccountPassword": "string" // the following is redacted on return
* }
- * } </code></pre>
+ * }
*
- * <h5>Segment</h5>
+ * Segment
*
- * Request: <pre><code> {
+ * Request: {
* "name": "string",
* "type": "segment",
* "sink": {
* "segmentWriteKey": "string"
* }
- * }</code></pre>
+ * }
*
- * Response: <pre><code>{
+ * Response: {
* "id": "string",
* "name": "string",
* "type": "segment",
@@ -622,9 +622,9 @@ public CompletableFuture get(String id) {
* "sink": {
* "segmentWriteKey": "string"
* }
- * } </code></pre>
+ * }
*
- * <h5>Splunk Log Stream</h5><pre><code>{
+ *
Splunk Log Stream
{
* "id": "string",
* "name": "string",
* "type": "splunk",
@@ -635,7 +635,7 @@ public CompletableFuture get(String id) {
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre> <h5>Sumo Logic Log Stream</h5><pre><code>{
+ * }
Sumo Logic Log Stream
{
* "id": "string",
* "name": "string",
* "type": "sumo",
@@ -643,10 +643,10 @@ public CompletableFuture get(String id) {
* "sink": {
* "sumoSourceAddress": "string",
* }
- * }</code></pre> <h5>Status</h5> The <code>status</code> of a log stream maybe any of the following:
- * 1. <code>active</code> - Stream is currently enabled.
- * 2. <code>paused</code> - Stream is currently user disabled and will not attempt log delivery.
- * 3. <code>suspended</code> - Stream is currently disabled because of errors and will not attempt log delivery.
+ * }
Status
The status of a log stream maybe any of the following:
+ * 1. active - Stream is currently enabled.
+ * 2. paused - Stream is currently user disabled and will not attempt log delivery.
+ * 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.
*/
public CompletableFuture get(String id, RequestOptions requestOptions) {
return this.rawClient.get(id, requestOptions).thenApply(response -> response.body());
@@ -668,40 +668,40 @@ public CompletableFuture delete(String id, RequestOptions requestOptions)
/**
* Update a log stream.
- * <h4>Examples of how to use the PATCH endpoint.</h4> The following fields may be updated in a PATCH operation: <ul><li>name</li><li>status</li><li>sink</li></ul> Note: For log streams of type <code>eventbridge</code> and <code>eventgrid</code>, updating the <code>sink</code> is not permitted.
- * <h5>Update the status of a log stream</h5><pre><code>{
+ *
Examples of how to use the PATCH endpoint.
The following fields may be updated in a PATCH operation: - name
- status
- sink
Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
{
* "status": "active|paused"
- * }</code></pre>
- * <h5>Update the name of a log stream</h5><pre><code>{
+ * }
+ * Update the name of a log stream
{
* "name": "string"
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>http</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type http
{
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>datadog</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type datadog
{
* "sink": {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>splunk</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type splunk
{
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>sumo</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type sumo
{
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }</code></pre>
+ * }
*/
public CompletableFuture update(String id) {
return this.rawClient.update(id).thenApply(response -> response.body());
@@ -709,40 +709,81 @@ public CompletableFuture update(String id) {
/**
* Update a log stream.
- * <h4>Examples of how to use the PATCH endpoint.</h4> The following fields may be updated in a PATCH operation: <ul><li>name</li><li>status</li><li>sink</li></ul> Note: For log streams of type <code>eventbridge</code> and <code>eventgrid</code>, updating the <code>sink</code> is not permitted.
- * <h5>Update the status of a log stream</h5><pre><code>{
+ *
Examples of how to use the PATCH endpoint.
The following fields may be updated in a PATCH operation: - name
- status
- sink
Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
{
* "status": "active|paused"
- * }</code></pre>
- * <h5>Update the name of a log stream</h5><pre><code>{
+ * }
+ * Update the name of a log stream
{
* "name": "string"
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>http</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type http
{
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>datadog</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type datadog
{
* "sink": {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>splunk</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type splunk
{
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>sumo</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type sumo
{
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }</code></pre>
+ * }
+ */
+ public CompletableFuture update(String id, RequestOptions requestOptions) {
+ return this.rawClient.update(id, requestOptions).thenApply(response -> response.body());
+ }
+
+ /**
+ * Update a log stream.
+ * Examples of how to use the PATCH endpoint.
The following fields may be updated in a PATCH operation: - name
- status
- sink
Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
{
+ * "status": "active|paused"
+ * }
+ * Update the name of a log stream
{
+ * "name": "string"
+ * }
+ * Update the sink properties of a stream of type http
{
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONARRAY|JSONLINES",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ * Update the sink properties of a stream of type datadog
{
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ * Update the sink properties of a stream of type splunk
{
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ * Update the sink properties of a stream of type sumo
{
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
*/
public CompletableFuture update(String id, UpdateLogStreamRequestContent request) {
return this.rawClient.update(id, request).thenApply(response -> response.body());
@@ -750,40 +791,40 @@ public CompletableFuture update(String id, Updat
/**
* Update a log stream.
- * <h4>Examples of how to use the PATCH endpoint.</h4> The following fields may be updated in a PATCH operation: <ul><li>name</li><li>status</li><li>sink</li></ul> Note: For log streams of type <code>eventbridge</code> and <code>eventgrid</code>, updating the <code>sink</code> is not permitted.
- * <h5>Update the status of a log stream</h5><pre><code>{
+ *
Examples of how to use the PATCH endpoint.
The following fields may be updated in a PATCH operation: - name
- status
- sink
Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
{
* "status": "active|paused"
- * }</code></pre>
- * <h5>Update the name of a log stream</h5><pre><code>{
+ * }
+ * Update the name of a log stream
{
* "name": "string"
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>http</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type http
{
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>datadog</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type datadog
{
* "sink": {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>splunk</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type splunk
{
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>sumo</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type sumo
{
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }</code></pre>
+ * }
*/
public CompletableFuture update(
String id, UpdateLogStreamRequestContent request, RequestOptions requestOptions) {
diff --git a/src/main/java/com/auth0/client/mgmt/AsyncLogsClient.java b/src/main/java/com/auth0/client/mgmt/AsyncLogsClient.java
index ba75398c..ba700065 100644
--- a/src/main/java/com/auth0/client/mgmt/AsyncLogsClient.java
+++ b/src/main/java/com/auth0/client/mgmt/AsyncLogsClient.java
@@ -30,26 +30,26 @@ public AsyncRawLogsClient withRawResponse() {
/**
* Retrieve log entries that match the specified search criteria (or all log entries if no criteria specified).
- * Set custom search criteria using the <code>q</code> parameter, or search from a specific log ID (<i>"search from checkpoint"</i>).
- * For more information on all possible event types, their respective acronyms, and descriptions, see <a href="https://auth0.com/docs/logs/log-event-type-codes">Log Event Type Codes</a>.
- * <h5>To set custom search criteria, use the following parameters:</h5>
- * <ul>
- * <li><b>q:</b> Search Criteria using <a href="https://auth0.com/docs/logs/log-search-query-syntax">Query String Syntax</a></li>
- * <li><b>page:</b> Page index of the results to return. First page is 0.</li>
- * <li><b>per_page:</b> Number of results per page.</li>
- * <li><b>sort:</b> Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`</li>
- * <li><b>fields:</b> Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.</li>
- * <li><b>include_fields:</b> Whether specified fields are to be included (true) or excluded (false).</li>
- * <li><b>include_totals:</b> Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). <b>Deprecated:</b> this field is deprecated and should be removed from use. See <a href="https://auth0.com/docs/product-lifecycle/deprecations-and-migrations/migrate-to-tenant-log-search-v3#pagination">Search Engine V3 Breaking Changes</a></li>
- * </ul>
- * For more information on the list of fields that can be used in <code>fields</code> and <code>sort</code>, see <a href="https://auth0.com/docs/logs/log-search-query-syntax#searchable-fields">Searchable Fields</a>.
- * Auth0 <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#limitations">limits the number of logs</a> you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#retrieve-logs-by-checkpoint">get logs by checkpoint method</a>.
- * <h5>To search from a checkpoint log ID, use the following parameters:</h5>
- * <ul>
- * <li><b>from:</b> Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the <code>take</code> parameter. If you use <code>from</code> at the same time as <code>q</code>, <code>from</code> takes precedence and <code>q</code> is ignored.</li>
- * <li><b>take:</b> Number of entries to retrieve when using the <code>from</code> parameter.</li>
- * </ul>
- * <strong>Important:</strong> When fetching logs from a checkpoint log ID, any parameter other than <code>from</code> and <code>take</code> will be ignored, and date ordering is not guaranteed.
+ * Set custom search criteria using the q parameter, or search from a specific log ID ("search from checkpoint").
+ * For more information on all possible event types, their respective acronyms, and descriptions, see Log Event Type Codes.
+ * To set custom search criteria, use the following parameters:
+ *
+ * - q: Search Criteria using Query String Syntax
+ * - page: Page index of the results to return. First page is 0.
+ * - per_page: Number of results per page.
+ * - sort: Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`
+ * - fields: Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.
+ * - include_fields: Whether specified fields are to be included (true) or excluded (false).
+ * - include_totals: Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). Deprecated: this field is deprecated and should be removed from use. See Search Engine V3 Breaking Changes
+ *
+ * For more information on the list of fields that can be used in fields and sort, see Searchable Fields.
+ * Auth0 limits the number of logs you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the get logs by checkpoint method.
+ * To search from a checkpoint log ID, use the following parameters:
+ *
+ * - from: Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the
take parameter. If you use from at the same time as q, from takes precedence and q is ignored.
+ * - take: Number of entries to retrieve when using the
from parameter.
+ *
+ * Important: When fetching logs from a checkpoint log ID, any parameter other than from and take will be ignored, and date ordering is not guaranteed.
*/
public CompletableFuture> list() {
return this.rawClient.list().thenApply(response -> response.body());
@@ -57,26 +57,53 @@ public CompletableFuture> list() {
/**
* Retrieve log entries that match the specified search criteria (or all log entries if no criteria specified).
- * Set custom search criteria using the <code>q</code> parameter, or search from a specific log ID (<i>"search from checkpoint"</i>).
- * For more information on all possible event types, their respective acronyms, and descriptions, see <a href="https://auth0.com/docs/logs/log-event-type-codes">Log Event Type Codes</a>.
- * <h5>To set custom search criteria, use the following parameters:</h5>
- * <ul>
- * <li><b>q:</b> Search Criteria using <a href="https://auth0.com/docs/logs/log-search-query-syntax">Query String Syntax</a></li>
- * <li><b>page:</b> Page index of the results to return. First page is 0.</li>
- * <li><b>per_page:</b> Number of results per page.</li>
- * <li><b>sort:</b> Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`</li>
- * <li><b>fields:</b> Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.</li>
- * <li><b>include_fields:</b> Whether specified fields are to be included (true) or excluded (false).</li>
- * <li><b>include_totals:</b> Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). <b>Deprecated:</b> this field is deprecated and should be removed from use. See <a href="https://auth0.com/docs/product-lifecycle/deprecations-and-migrations/migrate-to-tenant-log-search-v3#pagination">Search Engine V3 Breaking Changes</a></li>
- * </ul>
- * For more information on the list of fields that can be used in <code>fields</code> and <code>sort</code>, see <a href="https://auth0.com/docs/logs/log-search-query-syntax#searchable-fields">Searchable Fields</a>.
- * Auth0 <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#limitations">limits the number of logs</a> you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#retrieve-logs-by-checkpoint">get logs by checkpoint method</a>.
- * <h5>To search from a checkpoint log ID, use the following parameters:</h5>
- * <ul>
- * <li><b>from:</b> Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the <code>take</code> parameter. If you use <code>from</code> at the same time as <code>q</code>, <code>from</code> takes precedence and <code>q</code> is ignored.</li>
- * <li><b>take:</b> Number of entries to retrieve when using the <code>from</code> parameter.</li>
- * </ul>
- * <strong>Important:</strong> When fetching logs from a checkpoint log ID, any parameter other than <code>from</code> and <code>take</code> will be ignored, and date ordering is not guaranteed.
+ * Set custom search criteria using the q parameter, or search from a specific log ID ("search from checkpoint").
+ * For more information on all possible event types, their respective acronyms, and descriptions, see Log Event Type Codes.
+ * To set custom search criteria, use the following parameters:
+ *
+ * - q: Search Criteria using Query String Syntax
+ * - page: Page index of the results to return. First page is 0.
+ * - per_page: Number of results per page.
+ * - sort: Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`
+ * - fields: Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.
+ * - include_fields: Whether specified fields are to be included (true) or excluded (false).
+ * - include_totals: Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). Deprecated: this field is deprecated and should be removed from use. See Search Engine V3 Breaking Changes
+ *
+ * For more information on the list of fields that can be used in fields and sort, see Searchable Fields.
+ * Auth0 limits the number of logs you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the get logs by checkpoint method.
+ * To search from a checkpoint log ID, use the following parameters:
+ *
+ * - from: Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the
take parameter. If you use from at the same time as q, from takes precedence and q is ignored.
+ * - take: Number of entries to retrieve when using the
from parameter.
+ *
+ * Important: When fetching logs from a checkpoint log ID, any parameter other than from and take will be ignored, and date ordering is not guaranteed.
+ */
+ public CompletableFuture> list(RequestOptions requestOptions) {
+ return this.rawClient.list(requestOptions).thenApply(response -> response.body());
+ }
+
+ /**
+ * Retrieve log entries that match the specified search criteria (or all log entries if no criteria specified).
+ * Set custom search criteria using the q parameter, or search from a specific log ID ("search from checkpoint").
+ * For more information on all possible event types, their respective acronyms, and descriptions, see Log Event Type Codes.
+ * To set custom search criteria, use the following parameters:
+ *
+ * - q: Search Criteria using Query String Syntax
+ * - page: Page index of the results to return. First page is 0.
+ * - per_page: Number of results per page.
+ * - sort: Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`
+ * - fields: Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.
+ * - include_fields: Whether specified fields are to be included (true) or excluded (false).
+ * - include_totals: Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). Deprecated: this field is deprecated and should be removed from use. See Search Engine V3 Breaking Changes
+ *
+ * For more information on the list of fields that can be used in fields and sort, see Searchable Fields.
+ * Auth0 limits the number of logs you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the get logs by checkpoint method.
+ * To search from a checkpoint log ID, use the following parameters:
+ *
+ * - from: Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the
take parameter. If you use from at the same time as q, from takes precedence and q is ignored.
+ * - take: Number of entries to retrieve when using the
from parameter.
+ *
+ * Important: When fetching logs from a checkpoint log ID, any parameter other than from and take will be ignored, and date ordering is not guaranteed.
*/
public CompletableFuture> list(ListLogsRequestParameters request) {
return this.rawClient.list(request).thenApply(response -> response.body());
@@ -84,26 +111,26 @@ public CompletableFuture> list(ListLogsRequestParameters
/**
* Retrieve log entries that match the specified search criteria (or all log entries if no criteria specified).
- * Set custom search criteria using the <code>q</code> parameter, or search from a specific log ID (<i>"search from checkpoint"</i>).
- * For more information on all possible event types, their respective acronyms, and descriptions, see <a href="https://auth0.com/docs/logs/log-event-type-codes">Log Event Type Codes</a>.
- * <h5>To set custom search criteria, use the following parameters:</h5>
- * <ul>
- * <li><b>q:</b> Search Criteria using <a href="https://auth0.com/docs/logs/log-search-query-syntax">Query String Syntax</a></li>
- * <li><b>page:</b> Page index of the results to return. First page is 0.</li>
- * <li><b>per_page:</b> Number of results per page.</li>
- * <li><b>sort:</b> Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`</li>
- * <li><b>fields:</b> Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.</li>
- * <li><b>include_fields:</b> Whether specified fields are to be included (true) or excluded (false).</li>
- * <li><b>include_totals:</b> Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). <b>Deprecated:</b> this field is deprecated and should be removed from use. See <a href="https://auth0.com/docs/product-lifecycle/deprecations-and-migrations/migrate-to-tenant-log-search-v3#pagination">Search Engine V3 Breaking Changes</a></li>
- * </ul>
- * For more information on the list of fields that can be used in <code>fields</code> and <code>sort</code>, see <a href="https://auth0.com/docs/logs/log-search-query-syntax#searchable-fields">Searchable Fields</a>.
- * Auth0 <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#limitations">limits the number of logs</a> you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#retrieve-logs-by-checkpoint">get logs by checkpoint method</a>.
- * <h5>To search from a checkpoint log ID, use the following parameters:</h5>
- * <ul>
- * <li><b>from:</b> Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the <code>take</code> parameter. If you use <code>from</code> at the same time as <code>q</code>, <code>from</code> takes precedence and <code>q</code> is ignored.</li>
- * <li><b>take:</b> Number of entries to retrieve when using the <code>from</code> parameter.</li>
- * </ul>
- * <strong>Important:</strong> When fetching logs from a checkpoint log ID, any parameter other than <code>from</code> and <code>take</code> will be ignored, and date ordering is not guaranteed.
+ * Set custom search criteria using the q parameter, or search from a specific log ID ("search from checkpoint").
+ * For more information on all possible event types, their respective acronyms, and descriptions, see Log Event Type Codes.
+ * To set custom search criteria, use the following parameters:
+ *
+ * - q: Search Criteria using Query String Syntax
+ * - page: Page index of the results to return. First page is 0.
+ * - per_page: Number of results per page.
+ * - sort: Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`
+ * - fields: Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.
+ * - include_fields: Whether specified fields are to be included (true) or excluded (false).
+ * - include_totals: Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). Deprecated: this field is deprecated and should be removed from use. See Search Engine V3 Breaking Changes
+ *
+ * For more information on the list of fields that can be used in fields and sort, see Searchable Fields.
+ * Auth0 limits the number of logs you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the get logs by checkpoint method.
+ * To search from a checkpoint log ID, use the following parameters:
+ *
+ * - from: Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the
take parameter. If you use from at the same time as q, from takes precedence and q is ignored.
+ * - take: Number of entries to retrieve when using the
from parameter.
+ *
+ * Important: When fetching logs from a checkpoint log ID, any parameter other than from and take will be ignored, and date ordering is not guaranteed.
*/
public CompletableFuture> list(
ListLogsRequestParameters request, RequestOptions requestOptions) {
diff --git a/src/main/java/com/auth0/client/mgmt/AsyncManagementApiBuilder.java b/src/main/java/com/auth0/client/mgmt/AsyncManagementApiBuilder.java
index d6af5f88..84e1bedd 100644
--- a/src/main/java/com/auth0/client/mgmt/AsyncManagementApiBuilder.java
+++ b/src/main/java/com/auth0/client/mgmt/AsyncManagementApiBuilder.java
@@ -23,6 +23,8 @@ public class AsyncManagementApiBuilder {
private OkHttpClient httpClient;
+ private String tenantDomain;
+
/**
* Sets token
*/
@@ -78,6 +80,11 @@ public AsyncManagementApiBuilder addHeader(String name, String value) {
return this;
}
+ public AsyncManagementApiBuilder tenantDomain(String tenantDomain) {
+ this.tenantDomain = tenantDomain;
+ return this;
+ }
+
protected ClientOptions buildClientOptions() {
ClientOptions.Builder builder = ClientOptions.builder();
setEnvironment(builder);
@@ -99,6 +106,11 @@ protected ClientOptions buildClientOptions() {
* @param builder The ClientOptions.Builder to configure
*/
protected void setEnvironment(ClientOptions.Builder builder) {
+ if (this.tenantDomain != null) {
+ String _tenantDomain = this.tenantDomain != null ? this.tenantDomain : "{TENANT}.auth0.com";
+ this.environment =
+ Environment.custom("https://{tenantDomain}/api/v2".replace("{tenantDomain}", _tenantDomain));
+ }
builder.environment(this.environment);
}
diff --git a/src/main/java/com/auth0/client/mgmt/AsyncNetworkAclsClient.java b/src/main/java/com/auth0/client/mgmt/AsyncNetworkAclsClient.java
index ce4023d3..cd5be5d0 100644
--- a/src/main/java/com/auth0/client/mgmt/AsyncNetworkAclsClient.java
+++ b/src/main/java/com/auth0/client/mgmt/AsyncNetworkAclsClient.java
@@ -40,6 +40,13 @@ public CompletableFuture> list()
return this.rawClient.list().thenApply(response -> response.body());
}
+ /**
+ * Get all access control list entries for your client.
+ */
+ public CompletableFuture> list(RequestOptions requestOptions) {
+ return this.rawClient.list(requestOptions).thenApply(response -> response.body());
+ }
+
/**
* Get all access control list entries for your client.
*/
@@ -120,6 +127,13 @@ public CompletableFuture update(String id) {
return this.rawClient.update(id).thenApply(response -> response.body());
}
+ /**
+ * Update existing access control list for your client.
+ */
+ public CompletableFuture update(String id, RequestOptions requestOptions) {
+ return this.rawClient.update(id, requestOptions).thenApply(response -> response.body());
+ }
+
/**
* Update existing access control list for your client.
*/
diff --git a/src/main/java/com/auth0/client/mgmt/AsyncOrganizationsClient.java b/src/main/java/com/auth0/client/mgmt/AsyncOrganizationsClient.java
index 0fcc037a..5489a380 100644
--- a/src/main/java/com/auth0/client/mgmt/AsyncOrganizationsClient.java
+++ b/src/main/java/com/auth0/client/mgmt/AsyncOrganizationsClient.java
@@ -58,18 +58,18 @@ public AsyncRawOrganizationsClient withRawResponse() {
/**
* Retrieve detailed list of all Organizations available in your tenant. For more information, see Auth0 Organizations.
* This endpoint supports two types of pagination:
- * <ul>
- * <li>Offset pagination</li>
- * <li>Checkpoint pagination</li>
- * </ul>
+ *
+ * - Offset pagination
+ * - Checkpoint pagination
+ *
* Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.
- * <h2>Checkpoint Pagination</h2>
+ * Checkpoint Pagination
* To search by checkpoint, use the following parameters:
- * <ul>
- * <li><code>from</code>: Optional id from which to start selection.</li>
- * <li><code>take</code>: The total number of entries to retrieve when using the <code>from</code> parameter. Defaults to 50.</li>
- * </ul>
- * <b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.
+ *
+ * from: Optional id from which to start selection.take: The total number of entries to retrieve when using the from parameter. Defaults to 50.
+ * Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
*/
public CompletableFuture> list() {
return this.rawClient.list().thenApply(response -> response.body());
@@ -78,18 +78,38 @@ public CompletableFuture> list() {
/**
* Retrieve detailed list of all Organizations available in your tenant. For more information, see Auth0 Organizations.
* This endpoint supports two types of pagination:
- * <ul>
- * <li>Offset pagination</li>
- * <li>Checkpoint pagination</li>
- * </ul>
+ *
+ * - Offset pagination
+ * - Checkpoint pagination
+ *
* Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.
- * <h2>Checkpoint Pagination</h2>
+ * Checkpoint Pagination
* To search by checkpoint, use the following parameters:
- * <ul>
- * <li><code>from</code>: Optional id from which to start selection.</li>
- * <li><code>take</code>: The total number of entries to retrieve when using the <code>from</code> parameter. Defaults to 50.</li>
- * </ul>
- * <b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.
+ *
+ * from: Optional id from which to start selection.take: The total number of entries to retrieve when using the from parameter. Defaults to 50.
+ * Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
+ */
+ public CompletableFuture> list(RequestOptions requestOptions) {
+ return this.rawClient.list(requestOptions).thenApply(response -> response.body());
+ }
+
+ /**
+ * Retrieve detailed list of all Organizations available in your tenant. For more information, see Auth0 Organizations.
+ * This endpoint supports two types of pagination:
+ *
+ * - Offset pagination
+ * - Checkpoint pagination
+ *
+ * Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.
+ * Checkpoint Pagination
+ * To search by checkpoint, use the following parameters:
+ *
+ * from: Optional id from which to start selection.take: The total number of entries to retrieve when using the from parameter. Defaults to 50.
+ * Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
*/
public CompletableFuture> list(ListOrganizationsRequestParameters request) {
return this.rawClient.list(request).thenApply(response -> response.body());
@@ -98,18 +118,18 @@ public CompletableFuture> list(ListOrganization
/**
* Retrieve detailed list of all Organizations available in your tenant. For more information, see Auth0 Organizations.
* This endpoint supports two types of pagination:
- * <ul>
- * <li>Offset pagination</li>
- * <li>Checkpoint pagination</li>
- * </ul>
+ *
+ * - Offset pagination
+ * - Checkpoint pagination
+ *
* Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.
- * <h2>Checkpoint Pagination</h2>
+ * Checkpoint Pagination
* To search by checkpoint, use the following parameters:
- * <ul>
- * <li><code>from</code>: Optional id from which to start selection.</li>
- * <li><code>take</code>: The total number of entries to retrieve when using the <code>from</code> parameter. Defaults to 50.</li>
- * </ul>
- * <b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.
+ *
+ * from: Optional id from which to start selection.take: The total number of entries to retrieve when using the from parameter. Defaults to 50.
+ * Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
*/
public CompletableFuture> list(
ListOrganizationsRequestParameters request, RequestOptions requestOptions) {
@@ -117,14 +137,14 @@ public CompletableFuture> list(
}
/**
- * Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review <a href="https://auth0.com/docs/manage-users/organizations/create-first-organization">Create Your First Organization</a>.
+ * Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review Create Your First Organization.
*/
public CompletableFuture create(CreateOrganizationRequestContent request) {
return this.rawClient.create(request).thenApply(response -> response.body());
}
/**
- * Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review <a href="https://auth0.com/docs/manage-users/organizations/create-first-organization">Create Your First Organization</a>.
+ * Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review Create Your First Organization.
*/
public CompletableFuture create(
CreateOrganizationRequestContent request, RequestOptions requestOptions) {
@@ -162,7 +182,7 @@ public CompletableFuture get(String id, RequestO
/**
* Remove an Organization from your tenant. This action cannot be undone.
- * <b>Note</b>: Members are automatically disassociated from an Organization when it is deleted. However, this action does <b>not</b> delete these users from your tenant.
+ * Note: Members are automatically disassociated from an Organization when it is deleted. However, this action does not delete these users from your tenant.
*/
public CompletableFuture delete(String id) {
return this.rawClient.delete(id).thenApply(response -> response.body());
@@ -170,21 +190,28 @@ public CompletableFuture delete(String id) {
/**
* Remove an Organization from your tenant. This action cannot be undone.
- * <b>Note</b>: Members are automatically disassociated from an Organization when it is deleted. However, this action does <b>not</b> delete these users from your tenant.
+ * Note: Members are automatically disassociated from an Organization when it is deleted. However, this action does not delete these users from your tenant.
*/
public CompletableFuture delete(String id, RequestOptions requestOptions) {
return this.rawClient.delete(id, requestOptions).thenApply(response -> response.body());
}
/**
- * Update the details of a specific <a href="https://auth0.com/docs/manage-users/organizations/configure-organizations/create-organizations">Organization</a>, such as name and display name, branding options, and metadata.
+ * Update the details of a specific Organization, such as name and display name, branding options, and metadata.
*/
public CompletableFuture update(String id) {
return this.rawClient.update(id).thenApply(response -> response.body());
}
/**
- * Update the details of a specific <a href="https://auth0.com/docs/manage-users/organizations/configure-organizations/create-organizations">Organization</a>, such as name and display name, branding options, and metadata.
+ * Update the details of a specific Organization, such as name and display name, branding options, and metadata.
+ */
+ public CompletableFuture update(String id, RequestOptions requestOptions) {
+ return this.rawClient.update(id, requestOptions).thenApply(response -> response.body());
+ }
+
+ /**
+ * Update the details of a specific Organization, such as name and display name, branding options, and metadata.
*/
public CompletableFuture update(
String id, UpdateOrganizationRequestContent request) {
@@ -192,7 +219,7 @@ public CompletableFuture update(
}
/**
- * Update the details of a specific <a href="https://auth0.com/docs/manage-users/organizations/configure-organizations/create-organizations">Organization</a>, such as name and display name, branding options, and metadata.
+ * Update the details of a specific Organization, such as name and display name, branding options, and metadata.
*/
public CompletableFuture update(
String id, UpdateOrganizationRequestContent request, RequestOptions requestOptions) {
diff --git a/src/main/java/com/auth0/client/mgmt/AsyncPromptsClient.java b/src/main/java/com/auth0/client/mgmt/AsyncPromptsClient.java
index fc6d9bdf..ea03ef71 100644
--- a/src/main/java/com/auth0/client/mgmt/AsyncPromptsClient.java
+++ b/src/main/java/com/auth0/client/mgmt/AsyncPromptsClient.java
@@ -42,35 +42,42 @@ public AsyncRawPromptsClient withRawResponse() {
}
/**
- * Retrieve details of the Universal Login configuration of your tenant. This includes the <a href="https://auth0.com/docs/authenticate/login/auth0-universal-login/identifier-first">Identifier First Authentication</a> and <a href="https://auth0.com/docs/secure/multi-factor-authentication/fido-authentication-with-webauthn/configure-webauthn-device-biometrics-for-mfa">WebAuthn with Device Biometrics for MFA</a> features.
+ * Retrieve details of the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.
*/
public CompletableFuture getSettings() {
return this.rawClient.getSettings().thenApply(response -> response.body());
}
/**
- * Retrieve details of the Universal Login configuration of your tenant. This includes the <a href="https://auth0.com/docs/authenticate/login/auth0-universal-login/identifier-first">Identifier First Authentication</a> and <a href="https://auth0.com/docs/secure/multi-factor-authentication/fido-authentication-with-webauthn/configure-webauthn-device-biometrics-for-mfa">WebAuthn with Device Biometrics for MFA</a> features.
+ * Retrieve details of the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.
*/
public CompletableFuture getSettings(RequestOptions requestOptions) {
return this.rawClient.getSettings(requestOptions).thenApply(response -> response.body());
}
/**
- * Update the Universal Login configuration of your tenant. This includes the <a href="https://auth0.com/docs/authenticate/login/auth0-universal-login/identifier-first">Identifier First Authentication</a> and <a href="https://auth0.com/docs/secure/multi-factor-authentication/fido-authentication-with-webauthn/configure-webauthn-device-biometrics-for-mfa">WebAuthn with Device Biometrics for MFA</a> features.
+ * Update the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.
*/
public CompletableFuture updateSettings() {
return this.rawClient.updateSettings().thenApply(response -> response.body());
}
/**
- * Update the Universal Login configuration of your tenant. This includes the <a href="https://auth0.com/docs/authenticate/login/auth0-universal-login/identifier-first">Identifier First Authentication</a> and <a href="https://auth0.com/docs/secure/multi-factor-authentication/fido-authentication-with-webauthn/configure-webauthn-device-biometrics-for-mfa">WebAuthn with Device Biometrics for MFA</a> features.
+ * Update the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.
+ */
+ public CompletableFuture updateSettings(RequestOptions requestOptions) {
+ return this.rawClient.updateSettings(requestOptions).thenApply(response -> response.body());
+ }
+
+ /**
+ * Update the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.
*/
public CompletableFuture updateSettings(UpdateSettingsRequestContent request) {
return this.rawClient.updateSettings(request).thenApply(response -> response.body());
}
/**
- * Update the Universal Login configuration of your tenant. This includes the <a href="https://auth0.com/docs/authenticate/login/auth0-universal-login/identifier-first">Identifier First Authentication</a> and <a href="https://auth0.com/docs/secure/multi-factor-authentication/fido-authentication-with-webauthn/configure-webauthn-device-biometrics-for-mfa">WebAuthn with Device Biometrics for MFA</a> features.
+ * Update the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.
*/
public CompletableFuture updateSettings(
UpdateSettingsRequestContent request, RequestOptions requestOptions) {
diff --git a/src/main/java/com/auth0/client/mgmt/AsyncRawActionsClient.java b/src/main/java/com/auth0/client/mgmt/AsyncRawActionsClient.java
index 0e97f91a..a327a57e 100644
--- a/src/main/java/com/auth0/client/mgmt/AsyncRawActionsClient.java
+++ b/src/main/java/com/auth0/client/mgmt/AsyncRawActionsClient.java
@@ -60,6 +60,14 @@ public CompletableFuture>>
return list(ListActionsRequestParameters.builder().build());
}
+ /**
+ * Retrieve all actions.
+ */
+ public CompletableFuture>> list(
+ RequestOptions requestOptions) {
+ return list(ListActionsRequestParameters.builder().build(), requestOptions);
+ }
+
/**
* Retrieve all actions.
*/
@@ -95,6 +103,11 @@ public CompletableFuture>>
QueryStringMapper.addQueryParameter(
httpUrl, "installed", request.getInstalled().orElse(null), false);
}
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request.Builder _requestBuilder = new Request.Builder()
.url(httpUrl.build())
.method("GET", null)
@@ -191,10 +204,14 @@ public CompletableFuture>
*/
public CompletableFuture> create(
CreateActionRequestContent request, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
- .addPathSegments("actions/actions")
- .build();
+ .addPathSegments("actions/actions");
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
RequestBody body;
try {
body = RequestBody.create(
@@ -203,7 +220,7 @@ public CompletableFuture>
throw new ManagementException("Failed to serialize request", e);
}
Request okhttpRequest = new Request.Builder()
- .url(httpUrl)
+ .url(httpUrl.build())
.method("POST", body)
.headers(Headers.of(clientOptions.headers(requestOptions)))
.addHeader("Content-Type", "application/json")
@@ -281,13 +298,17 @@ public CompletableFuture> ge
*/
public CompletableFuture> get(
String id, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("actions/actions")
- .addPathSegment(id)
- .build();
+ .addPathSegment(id);
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request okhttpRequest = new Request.Builder()
- .url(httpUrl)
+ .url(httpUrl.build())
.method("GET", null)
.headers(Headers.of(clientOptions.headers(requestOptions)))
.addHeader("Accept", "application/json")
@@ -363,6 +384,13 @@ public CompletableFuture> delete(String id) {
return delete(id, DeleteActionRequestParameters.builder().build());
}
+ /**
+ * Deletes an action and all of its associated versions. An action must be unbound from all triggers before it can be deleted.
+ */
+ public CompletableFuture> delete(String id, RequestOptions requestOptions) {
+ return delete(id, DeleteActionRequestParameters.builder().build(), requestOptions);
+ }
+
/**
* Deletes an action and all of its associated versions. An action must be unbound from all triggers before it can be deleted.
*/
@@ -383,6 +411,11 @@ public CompletableFuture> delete(
QueryStringMapper.addQueryParameter(
httpUrl, "force", request.getForce().orElse(null), false);
}
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request.Builder _requestBuilder = new Request.Builder()
.url(httpUrl.build())
.method("DELETE", null)
@@ -452,14 +485,22 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
}
/**
- * Update an existing action. If this action is currently bound to a trigger, updating it will <strong>not</strong> affect any user flows until the action is deployed.
+ * Update an existing action. If this action is currently bound to a trigger, updating it will not affect any user flows until the action is deployed.
*/
public CompletableFuture> update(String id) {
return update(id, UpdateActionRequestContent.builder().build());
}
/**
- * Update an existing action. If this action is currently bound to a trigger, updating it will <strong>not</strong> affect any user flows until the action is deployed.
+ * Update an existing action. If this action is currently bound to a trigger, updating it will not affect any user flows until the action is deployed.
+ */
+ public CompletableFuture> update(
+ String id, RequestOptions requestOptions) {
+ return update(id, UpdateActionRequestContent.builder().build(), requestOptions);
+ }
+
+ /**
+ * Update an existing action. If this action is currently bound to a trigger, updating it will not affect any user flows until the action is deployed.
*/
public CompletableFuture> update(
String id, UpdateActionRequestContent request) {
@@ -467,15 +508,19 @@ public CompletableFuture>
}
/**
- * Update an existing action. If this action is currently bound to a trigger, updating it will <strong>not</strong> affect any user flows until the action is deployed.
+ * Update an existing action. If this action is currently bound to a trigger, updating it will not affect any user flows until the action is deployed.
*/
public CompletableFuture> update(
String id, UpdateActionRequestContent request, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("actions/actions")
- .addPathSegment(id)
- .build();
+ .addPathSegment(id);
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
RequestBody body;
try {
body = RequestBody.create(
@@ -484,7 +529,7 @@ public CompletableFuture>
throw new ManagementException("Failed to serialize request", e);
}
Request okhttpRequest = new Request.Builder()
- .url(httpUrl)
+ .url(httpUrl.build())
.method("PATCH", body)
.headers(Headers.of(clientOptions.headers(requestOptions)))
.addHeader("Content-Type", "application/json")
@@ -567,14 +612,18 @@ public CompletableFuture>
*/
public CompletableFuture> deploy(
String id, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("actions/actions")
.addPathSegment(id)
- .addPathSegments("deploy")
- .build();
+ .addPathSegments("deploy");
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request okhttpRequest = new Request.Builder()
- .url(httpUrl)
+ .url(httpUrl.build())
.method("POST", RequestBody.create("", null))
.headers(Headers.of(clientOptions.headers(requestOptions)))
.addHeader("Accept", "application/json")
@@ -652,12 +701,16 @@ public CompletableFuture> t
*/
public CompletableFuture> test(
String id, TestActionRequestContent request, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("actions/actions")
.addPathSegment(id)
- .addPathSegments("test")
- .build();
+ .addPathSegments("test");
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
RequestBody body;
try {
body = RequestBody.create(
@@ -666,7 +719,7 @@ public CompletableFuture> t
throw new ManagementException("Failed to serialize request", e);
}
Request okhttpRequest = new Request.Builder()
- .url(httpUrl)
+ .url(httpUrl.build())
.method("POST", body)
.headers(Headers.of(clientOptions.headers(requestOptions)))
.addHeader("Content-Type", "application/json")
diff --git a/src/main/java/com/auth0/client/mgmt/AsyncRawBrandingClient.java b/src/main/java/com/auth0/client/mgmt/AsyncRawBrandingClient.java
index 09c82ac5..8ad46d30 100644
--- a/src/main/java/com/auth0/client/mgmt/AsyncRawBrandingClient.java
+++ b/src/main/java/com/auth0/client/mgmt/AsyncRawBrandingClient.java
@@ -49,12 +49,16 @@ public CompletableFuture>
* Retrieve branding settings.
*/
public CompletableFuture> get(RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
- .addPathSegments("branding")
- .build();
+ .addPathSegments("branding");
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request okhttpRequest = new Request.Builder()
- .url(httpUrl)
+ .url(httpUrl.build())
.method("GET", null)
.headers(Headers.of(clientOptions.headers(requestOptions)))
.addHeader("Accept", "application/json")
@@ -121,6 +125,14 @@ public CompletableFuture> update(
+ RequestOptions requestOptions) {
+ return update(UpdateBrandingRequestContent.builder().build(), requestOptions);
+ }
+
/**
* Update branding settings.
*/
@@ -134,10 +146,14 @@ public CompletableFuture> update(
UpdateBrandingRequestContent request, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
- .addPathSegments("branding")
- .build();
+ .addPathSegments("branding");
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
RequestBody body;
try {
body = RequestBody.create(
@@ -146,7 +162,7 @@ public CompletableFutureclient grants
client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scope:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scope:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * <ul> - * <li> + * For more information, read Applications in Auth0 and Single Sign-On. + *
client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scope:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scope:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scope:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scope:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * <ul> - * <li> + * For more information, read Applications in Auth0 and Single Sign-On. + *
client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scope:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scope:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * <ul> - * <li> + * For more information, read Applications in Auth0 and Single Sign-On. + *
client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scopes:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scopes:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * <ul> - * <li> + * For more information, read Applications in Auth0 and Single Sign-On. + *
client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scopes:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scopes:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scopes:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scopes:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * <ul> - * <li> + * For more information, read Applications in Auth0 and Single Sign-On. + *
client_id, app_type, name, and description.
+ * read:clients or
+ * read:client_keys scopes:
+ * callbacks, oidc_logout, allowed_origins,
+ * web_origins, tenant, global, config_route,
+ * callback_url_template, jwt_configuration,
+ * jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded,
+ * jwt_configuration.scopes, jwt_configuration.alg, api_type,
+ * logo_uri, allowed_clients, owners, custom_login_page,
+ * custom_login_page_off, sso, addons, form_template,
+ * custom_login_page_codeview, resource_servers, client_metadata,
+ * mobile, mobile.android, mobile.ios, allowed_logout_urls,
+ * token_endpoint_auth_method, is_first_party, oidc_conformant,
+ * is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types,
+ * refresh_token, refresh_token.rotation_type, refresh_token.expiration_type,
+ * refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage,
+ * organization_require_behavior.
+ * read:client_keys or read:client_credentials scopes:
+ * encryption_key, encryption_key.pub, encryption_key.cert,
+ * client_secret, client_authentication_methods and signing_key.
+ * Notes:
*client_secret and signing_key attributes can only be updated with the update:client_keys scope.client_authentication_methods and token_endpoint_auth_method properties are mutually exclusive. Use client_authentication_methods to configure the client with Private Key JWT authentication method. Otherwise, use token_endpoint_auth_method to configure the client with client secret (basic or post) or with no authentication method (none).client_authentication_methods to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.client_authentication_methods, the update:client_credentials scope is required.client_authentication_methods, the property jwt_configuration.alg must be set to RS256.is_first_party property to false, the organization_usage and organization_require_behavior properties must be unset.Notes:
*client_secret and signing_key attributes can only be updated with the update:client_keys scope.client_authentication_methods and token_endpoint_auth_method properties are mutually exclusive. Use client_authentication_methods to configure the client with Private Key JWT authentication method. Otherwise, use token_endpoint_auth_method to configure the client with client secret (basic or post) or with no authentication method (none).client_authentication_methods to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.client_authentication_methods, the update:client_credentials scope is required.client_authentication_methods, the property jwt_configuration.alg must be set to RS256.is_first_party property to false, the organization_usage and organization_require_behavior properties must be unset.Notes:
+ *client_secret and signing_key attributes can only be updated with the update:client_keys scope.client_authentication_methods and token_endpoint_auth_method properties are mutually exclusive. Use client_authentication_methods to configure the client with Private Key JWT authentication method. Otherwise, use token_endpoint_auth_method to configure the client with client secret (basic or post) or with no authentication method (none).client_authentication_methods to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.client_authentication_methods, the update:client_credentials scope is required.client_authentication_methods, the property jwt_configuration.alg must be set to RS256.is_first_party property to false, the organization_usage and organization_require_behavior properties must be unset.Notes:
*client_secret and signing_key attributes can only be updated with the update:client_keys scope.client_authentication_methods and token_endpoint_auth_method properties are mutually exclusive. Use client_authentication_methods to configure the client with Private Key JWT authentication method. Otherwise, use token_endpoint_auth_method to configure the client with client secret (basic or post) or with no authentication method (none).client_authentication_methods to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.client_authentication_methods, the update:client_credentials scope is required.client_authentication_methods, the property jwt_configuration.alg must be set to RS256.is_first_party property to false, the organization_usage and organization_require_behavior properties must be unset.This endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt). The generated secret is NOT base64 encoded.
- *For more information, read <a href="https://www.auth0.com/docs/get-started/applications/rotate-client-secret">Rotate Client Secrets</a>.
+ *For more information, read Rotate Client Secrets.
*/ public CompletableFutureFor more information, read <a href="https://www.auth0.com/docs/get-started/applications/rotate-client-secret">Rotate Client Secrets</a>.
+ *For more information, read Rotate Client Secrets.
*/ public CompletableFutureThis endpoint supports two types of pagination:
- *<ul> - * <li>Offset pagination</li> - * <li>Checkpoint pagination</li> - * </ul>
+ *Checkpoint pagination must be used if you need to retrieve more than 1000 connections.
- *<h2>Checkpoint Pagination</h2>
+ *To search by checkpoint, use the following parameters:
- *<ul> - * <li><code>from</code>: Optional id from which to start selection.</li> - * <li><code>take</code>: The total amount of entries to retrieve when using the from parameter. Defaults to 50.</li> - * </ul>
- *<b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.
+ *from: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
This endpoint supports two types of pagination:
- *<ul> - * <li>Offset pagination</li> - * <li>Checkpoint pagination</li> - * </ul>
+ *Checkpoint pagination must be used if you need to retrieve more than 1000 connections.
- *<h2>Checkpoint Pagination</h2>
+ *To search by checkpoint, use the following parameters:
- *<ul> - * <li><code>from</code>: Optional id from which to start selection.</li> - * <li><code>take</code>: The total amount of entries to retrieve when using the from parameter. Defaults to 50.</li> - * </ul>
- *<b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.
+ *from: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
This endpoint supports two types of pagination:
+ *Checkpoint pagination must be used if you need to retrieve more than 1000 connections.
+ *To search by checkpoint, use the following parameters:
+ *from: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
This endpoint supports two types of pagination:
- *<ul> - * <li>Offset pagination</li> - * <li>Checkpoint pagination</li> - * </ul>
+ *Checkpoint pagination must be used if you need to retrieve more than 1000 connections.
- *<h2>Checkpoint Pagination</h2>
+ *To search by checkpoint, use the following parameters:
- *<ul> - * <li><code>from</code>: Optional id from which to start selection.</li> - * <li><code>take</code>: The total amount of entries to retrieve when using the from parameter. Defaults to 50.</li> - * </ul>
- *<b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.
+ *from: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
<b>Note:</b> If a connection with the same name was recently deleted and had a large number of associated users, the deletion may still be processing. Creating a new connection with that name before the deletion completes may fail or produce unexpected results.
+ * Creates a new connection according to the JSON object received inbody.
+ * Note: If a connection with the same name was recently deleted and had a large number of associated users, the deletion may still be processing. Creating a new connection with that name before the deletion completes may fail or produce unexpected results.
*/ public CompletableFuturebody.
+ * Note: If a connection with the same name was recently deleted and had a large number of associated users, the deletion may still be processing. Creating a new connection with that name before the deletion completes may fail or produce unexpected results.
*/ public CompletableFuture<b>Note:</b> If your connection has a large amount of users associated with it, please be aware that this operation can be long running after the response is returned and may impact concurrent <a href="https://auth0.com/docs/api/management/v2/connections/post-connections">create connection</a> requests, if they use an identical connection name.
+ * Removes a specific connection from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate. + *Note: If your connection has a large amount of users associated with it, please be aware that this operation can be long running after the response is returned and may impact concurrent create connection requests, if they use an identical connection name.
*/ public CompletableFuture<b>Note:</b> If your connection has a large amount of users associated with it, please be aware that this operation can be long running after the response is returned and may impact concurrent <a href="https://auth0.com/docs/api/management/v2/connections/post-connections">create connection</a> requests, if they use an identical connection name.
+ * Removes a specific connection from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate. + *Note: If your connection has a large amount of users associated with it, please be aware that this operation can be long running after the response is returned and may impact concurrent create connection requests, if they use an identical connection name.
*/ public CompletableFuture<b>Note</b>: If you use the <code>options</code> parameter, the entire <code>options</code> object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
+ * Update details for a specific connection, including option properties for identity provider configuration. + *Note: If you use the options parameter, the entire options object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
<b>Note</b>: If you use the <code>options</code> parameter, the entire <code>options</code> object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
+ * Update details for a specific connection, including option properties for identity provider configuration. + *Note: If you use the options parameter, the entire options object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
Note: If you use the options parameter, the entire options object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
Note: If you use the options parameter, the entire options object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
200 OK http status code response is returned when the connection is online, otherwise a 404 status code is returned along with an error message
*/
public CompletableFutureID. 200 OK http status code response is returned when the connection is online, otherwise a 404 status code is returned along with an error message
*/
public CompletableFuture<h5>Updating CUSTOM_CLIENT_IP_HEADER for a custom domain</h5>To update the <code>custom_client_ip_header</code> for a domain, the body to + *
custom_client_ip_header for a domain, the body to
* send should be:
- * <pre><code>{ "custom_client_ip_header": "cf-connecting-ip" }</code></pre>
- * <h5>Updating TLS_POLICY for a custom domain</h5>To update the <code>tls_policy</code> for a domain, the body to send should be: - * <pre><code>{ "tls_policy": "recommended" }</code></pre>
+ *{ "custom_client_ip_header": "cf-connecting-ip" }tls_policy for a domain, the body to send should be:
+ * { "tls_policy": "recommended" }TLS Policies:
*Some considerations:
*compatible TLS policy is no longer supported.<h5>Updating CUSTOM_CLIENT_IP_HEADER for a custom domain</h5>To update the <code>custom_client_ip_header</code> for a domain, the body to + *
custom_client_ip_header for a domain, the body to
* send should be:
- * <pre><code>{ "custom_client_ip_header": "cf-connecting-ip" }</code></pre>
- * <h5>Updating TLS_POLICY for a custom domain</h5>To update the <code>tls_policy</code> for a domain, the body to send should be: - * <pre><code>{ "tls_policy": "recommended" }</code></pre>
+ *{ "custom_client_ip_header": "cf-connecting-ip" }tls_policy for a domain, the body to send should be:
+ * { "tls_policy": "recommended" }TLS Policies:
*compatible TLS policy is no longer supported.These are the attributes that can be updated:
+ *custom_client_ip_header for a domain, the body to
+ * send should be:
+ * { "custom_client_ip_header": "cf-connecting-ip" }tls_policy for a domain, the body to send should be:
+ * { "tls_policy": "recommended" }TLS Policies:
+ *Some considerations:
+ *compatible TLS policy is no longer supported.<h5>Updating CUSTOM_CLIENT_IP_HEADER for a custom domain</h5>To update the <code>custom_client_ip_header</code> for a domain, the body to + *
custom_client_ip_header for a domain, the body to
* send should be:
- * <pre><code>{ "custom_client_ip_header": "cf-connecting-ip" }</code></pre>
- * <h5>Updating TLS_POLICY for a custom domain</h5>To update the <code>tls_policy</code> for a domain, the body to send should be: - * <pre><code>{ "tls_policy": "recommended" }</code></pre>
+ *{ "custom_client_ip_header": "cf-connecting-ip" }tls_policy for a domain, the body to send should be:
+ * { "tls_policy": "recommended" }TLS Policies:
*compatible TLS policy is no longer supported.Note: Check the <code>status</code> field to see its verification status. Once verification is complete, it may take up to 10 minutes before the custom domain can start accepting requests.
- *For <code>self_managed_certs</code>, when the custom domain is verified for the first time, the response will also include the <code>cname_api_key</code> which you will need to configure your proxy. This key must be kept secret, and is used to validate the proxy requests.
- *<a href="https://auth0.com/docs/custom-domains#step-2-verify-ownership">Learn more</a> about verifying custom domains that use Auth0 Managed certificates. - * <a href="https://auth0.com/docs/custom-domains/self-managed-certificates#step-2-verify-ownership">Learn more</a> about verifying custom domains that use Self Managed certificates.
+ *Note: Check the status field to see its verification status. Once verification is complete, it may take up to 10 minutes before the custom domain can start accepting requests.
For self_managed_certs, when the custom domain is verified for the first time, the response will also include the cname_api_key which you will need to configure your proxy. This key must be kept secret, and is used to validate the proxy requests.
Learn more about verifying custom domains that use Auth0 Managed certificates. + * Learn more about verifying custom domains that use Self Managed certificates.
*/ public CompletableFutureFor <code>self_managed_certs</code>, when the custom domain is verified for the first time, the response will also include the <code>cname_api_key</code> which you will need to configure your proxy. This key must be kept secret, and is used to validate the proxy requests.
- *<a href="https://auth0.com/docs/custom-domains#step-2-verify-ownership">Learn more</a> about verifying custom domains that use Auth0 Managed certificates. - * <a href="https://auth0.com/docs/custom-domains/self-managed-certificates#step-2-verify-ownership">Learn more</a> about verifying custom domains that use Self Managed certificates.
+ *Note: Check the status field to see its verification status. Once verification is complete, it may take up to 10 minutes before the custom domain can start accepting requests.
For self_managed_certs, when the custom domain is verified for the first time, the response will also include the cname_api_key which you will need to configure your proxy. This key must be kept secret, and is used to validate the proxy requests.
Learn more about verifying custom domains that use Auth0 Managed certificates. + * Learn more about verifying custom domains that use Self Managed certificates.
*/ public CompletableFuturepublic_key, refresh_token, or rotating_refresh_token) associated with a specific user.
*/
public CompletableFuturepublic_key, refresh_token, or rotating_refresh_token) associated with a specific user.
+ */
+ public CompletableFuturepublic_key, refresh_token, or rotating_refresh_token) associated with a specific user.
*/
public CompletableFuturerefresh_token, or rotating_refresh_token) associated with a specific user.
*/
public CompletableFutureWhen refresh token rotation is enabled, the endpoint becomes consistent. For more information, read <a href="https://auth0.com/docs/get-started/tenant-settings/signing-keys"> Signing Keys</a>.
+ * Create a device credential public key to manage refresh token rotation for a givenuser_id. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.
+ * When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read Signing Keys.
*/ public CompletableFutureuser_id. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.
+ * When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read Signing Keys.
*/ public CompletableFuture<h5>Sample Response</h5><pre><code>[{ + * Retrieve details on log streams. + *
[{
* "id": "string",
* "name": "string",
* "type": "eventbridge",
@@ -111,15 +111,15 @@ public AsyncRawLogStreamsClient(ClientOptions clientOptions) {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }]</code></pre>
+ * }]<h5>Sample Response</h5><pre><code>[{ + * Retrieve details on log streams. + *
[{
* "id": "string",
* "name": "string",
* "type": "eventbridge",
@@ -183,16 +183,20 @@ public CompletableFuture
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }]</code></pre>
+ * }] <h5>Log Stream Types</h5> The <code>type</code> of log stream being created determines the properties required in the <code>sink</code> payload. - * <h5>HTTP Stream</h5> For an <code>http</code> Stream, the <code>sink</code> properties are listed in the payload below - * Request: <pre><code>{ + *
type of log stream being created determines the properties required in the sink payload.
+ * http Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "http",
* "sink": {
@@ -270,8 +274,8 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "httpContentFormat": "JSONLINES|JSONARRAY",
* "httpAuthorization": "string"
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * }{
* "id": "string",
* "name": "string",
* "type": "http",
@@ -282,17 +286,17 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "httpContentFormat": "JSONLINES|JSONARRAY",
* "httpAuthorization": "string"
* }
- * }</code></pre>
- * <h5>Amazon EventBridge Stream</h5> For an <code>eventbridge</code> Stream, the <code>sink</code> properties are listed in the payload below
- * Request: <pre><code>{
+ * }eventbridge Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "eventbridge",
* "sink": {
* "awsRegion": "string",
* "awsAccountId": "string"
* }
- * }</code></pre>
- * The response will include an additional field <code>awsPartnerEventSource</code> in the <code>sink</code>: <pre><code>{
+ * }awsPartnerEventSource in the sink: {
* "id": "string",
* "name": "string",
* "type": "eventbridge",
@@ -302,9 +306,9 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "awsRegion": "string",
* "awsPartnerEventSource": "string"
* }
- * }</code></pre>
- * <h5>Azure Event Grid Stream</h5> For an <code>Azure Event Grid</code> Stream, the <code>sink</code> properties are listed in the payload below
- * Request: <pre><code>{
+ * }Azure Event Grid Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "eventgrid",
* "sink": {
@@ -312,8 +316,8 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "azureResourceGroup": "string",
* "azureRegion": "string"
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * }{
* "id": "string",
* "name": "string",
* "type": "http",
@@ -324,17 +328,17 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "azureRegion": "string",
* "azurePartnerTopic": "string"
* }
- * }</code></pre>
- * <h5>Datadog Stream</h5> For a <code>Datadog</code> Stream, the <code>sink</code> properties are listed in the payload below
- * Request: <pre><code>{
+ * }Datadog Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "datadog",
* "sink": {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * }{
* "id": "string",
* "name": "string",
* "type": "datadog",
@@ -343,9 +347,9 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre>
- * <h5>Splunk Stream</h5> For a <code>Splunk</code> Stream, the <code>sink</code> properties are listed in the payload below
- * Request: <pre><code>{
+ * }Splunk Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "splunk",
* "sink": {
@@ -354,8 +358,8 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * }{
* "id": "string",
* "name": "string",
* "type": "splunk",
@@ -366,16 +370,16 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre>
- * <h5>Sumo Logic Stream</h5> For a <code>Sumo Logic</code> Stream, the <code>sink</code> properties are listed in the payload below
- * Request: <pre><code>{
+ * }Sumo Logic Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "sumo",
* "sink": {
* "sumoSourceAddress": "string",
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * }{
* "id": "string",
* "name": "string",
* "type": "sumo",
@@ -383,7 +387,7 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "sink": {
* "sumoSourceAddress": "string",
* }
- * }</code></pre>
+ * }type of log stream being created determines the properties required in the sink payload.
+ * http Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "http",
* "sink": {
@@ -403,8 +407,8 @@ public CompletableFuture{
* "id": "string",
* "name": "string",
* "type": "http",
@@ -415,17 +419,17 @@ public CompletableFutureeventbridge Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "eventbridge",
* "sink": {
* "awsRegion": "string",
* "awsAccountId": "string"
* }
- * }</code></pre>
- * The response will include an additional field <code>awsPartnerEventSource</code> in the <code>sink</code>: <pre><code>{
+ * }awsPartnerEventSource in the sink: {
* "id": "string",
* "name": "string",
* "type": "eventbridge",
@@ -435,9 +439,9 @@ public CompletableFutureAzure Event Grid Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "eventgrid",
* "sink": {
@@ -445,8 +449,8 @@ public CompletableFuture{
* "id": "string",
* "name": "string",
* "type": "http",
@@ -457,17 +461,17 @@ public CompletableFutureDatadog Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "datadog",
* "sink": {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * }{
* "id": "string",
* "name": "string",
* "type": "datadog",
@@ -476,9 +480,9 @@ public CompletableFutureSplunk Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "splunk",
* "sink": {
@@ -487,8 +491,8 @@ public CompletableFuture{
* "id": "string",
* "name": "string",
* "type": "splunk",
@@ -499,16 +503,16 @@ public CompletableFutureSumo Logic Stream, the sink properties are listed in the payload below
+ * Request: {
* "name": "string",
* "type": "sumo",
* "sink": {
* "sumoSourceAddress": "string",
* }
- * }</code></pre>
- * Response: <pre><code>{
+ * }{
* "id": "string",
* "name": "string",
* "type": "sumo",
@@ -516,14 +520,18 @@ public CompletableFuture
+ * } {
* "id": "string",
* "name": "string",
* "type": "eventbridge",
@@ -615,7 +623,7 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "awsRegion": "string",
* "awsPartnerEventSource": "string"
* }
- * }</code></pre> <h5>HTTP Log Stream</h5><pre><code>{
+ * }{
* "id": "string",
* "name": "string",
* "type": "http",
@@ -626,7 +634,7 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "httpEndpoint": "string",
* "httpAuthorization": "string"
* }
- * }</code></pre> <h5>Datadog Log Stream</h5><pre><code>{
+ * }{
* "id": "string",
* "name": "string",
* "type": "datadog",
@@ -635,8 +643,8 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre><h5>Mixpanel</h5>
- * Request: <pre><code>{
+ * }
Mixpanel
+ * Request: {
* "name": "string",
* "type": "mixpanel",
* "sink": {
@@ -645,10 +653,10 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "mixpanelServiceAccountUsername": "string",
* "mixpanelServiceAccountPassword": "string"
* }
- * } </code></pre>
+ * }
*
*
- * Response: <pre><code>{
+ * Response: {
* "id": "string",
* "name": "string",
* "type": "mixpanel",
@@ -659,19 +667,19 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "mixpanelServiceAccountUsername": "string",
* "mixpanelServiceAccountPassword": "string" // the following is redacted on return
* }
- * } </code></pre>
+ * }
*
- * <h5>Segment</h5>
+ * Segment
*
- * Request: <pre><code> {
+ * Request: {
* "name": "string",
* "type": "segment",
* "sink": {
* "segmentWriteKey": "string"
* }
- * }</code></pre>
+ * }
*
- * Response: <pre><code>{
+ * Response: {
* "id": "string",
* "name": "string",
* "type": "segment",
@@ -679,9 +687,9 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "sink": {
* "segmentWriteKey": "string"
* }
- * } </code></pre>
+ * }
*
- * <h5>Splunk Log Stream</h5><pre><code>{
+ *
Splunk Log Stream
{
* "id": "string",
* "name": "string",
* "type": "splunk",
@@ -692,7 +700,7 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre> <h5>Sumo Logic Log Stream</h5><pre><code>{
+ * }
Sumo Logic Log Stream
{
* "id": "string",
* "name": "string",
* "type": "sumo",
@@ -700,10 +708,10 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
* "sink": {
* "sumoSourceAddress": "string",
* }
- * }</code></pre> <h5>Status</h5> The <code>status</code> of a log stream maybe any of the following:
- * 1. <code>active</code> - Stream is currently enabled.
- * 2. <code>paused</code> - Stream is currently user disabled and will not attempt log delivery.
- * 3. <code>suspended</code> - Stream is currently disabled because of errors and will not attempt log delivery.
+ * }
Status
The status of a log stream maybe any of the following:
+ * 1. active - Stream is currently enabled.
+ * 2. paused - Stream is currently user disabled and will not attempt log delivery.
+ * 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.
*/
public CompletableFuture> get(String id) {
return get(id, null);
@@ -711,7 +719,7 @@ public CompletableFuture>
/**
* Retrieve a log stream configuration and status.
- * <h5>Sample responses</h5><h5>Amazon EventBridge Log Stream</h5><pre><code>{
+ *
Sample responses
Amazon EventBridge Log Stream
{
* "id": "string",
* "name": "string",
* "type": "eventbridge",
@@ -721,7 +729,7 @@ public CompletableFuture>
* "awsRegion": "string",
* "awsPartnerEventSource": "string"
* }
- * }</code></pre> <h5>HTTP Log Stream</h5><pre><code>{
+ * }
HTTP Log Stream
{
* "id": "string",
* "name": "string",
* "type": "http",
@@ -732,7 +740,7 @@ public CompletableFuture>
* "httpEndpoint": "string",
* "httpAuthorization": "string"
* }
- * }</code></pre> <h5>Datadog Log Stream</h5><pre><code>{
+ * }
Datadog Log Stream
{
* "id": "string",
* "name": "string",
* "type": "datadog",
@@ -741,8 +749,8 @@ public CompletableFuture>
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre><h5>Mixpanel</h5>
- * Request: <pre><code>{
+ * }
Mixpanel
+ * Request: {
* "name": "string",
* "type": "mixpanel",
* "sink": {
@@ -751,10 +759,10 @@ public CompletableFuture>
* "mixpanelServiceAccountUsername": "string",
* "mixpanelServiceAccountPassword": "string"
* }
- * } </code></pre>
+ * }
*
*
- * Response: <pre><code>{
+ * Response: {
* "id": "string",
* "name": "string",
* "type": "mixpanel",
@@ -765,19 +773,19 @@ public CompletableFuture>
* "mixpanelServiceAccountUsername": "string",
* "mixpanelServiceAccountPassword": "string" // the following is redacted on return
* }
- * } </code></pre>
+ * }
*
- * <h5>Segment</h5>
+ * Segment
*
- * Request: <pre><code> {
+ * Request: {
* "name": "string",
* "type": "segment",
* "sink": {
* "segmentWriteKey": "string"
* }
- * }</code></pre>
+ * }
*
- * Response: <pre><code>{
+ * Response: {
* "id": "string",
* "name": "string",
* "type": "segment",
@@ -785,9 +793,9 @@ public CompletableFuture>
* "sink": {
* "segmentWriteKey": "string"
* }
- * } </code></pre>
+ * }
*
- * <h5>Splunk Log Stream</h5><pre><code>{
+ *
Splunk Log Stream
{
* "id": "string",
* "name": "string",
* "type": "splunk",
@@ -798,7 +806,7 @@ public CompletableFuture>
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre> <h5>Sumo Logic Log Stream</h5><pre><code>{
+ * }
Sumo Logic Log Stream
{
* "id": "string",
* "name": "string",
* "type": "sumo",
@@ -806,20 +814,24 @@ public CompletableFuture>
* "sink": {
* "sumoSourceAddress": "string",
* }
- * }</code></pre> <h5>Status</h5> The <code>status</code> of a log stream maybe any of the following:
- * 1. <code>active</code> - Stream is currently enabled.
- * 2. <code>paused</code> - Stream is currently user disabled and will not attempt log delivery.
- * 3. <code>suspended</code> - Stream is currently disabled because of errors and will not attempt log delivery.
+ * }
Status
The status of a log stream maybe any of the following:
+ * 1. active - Stream is currently enabled.
+ * 2. paused - Stream is currently user disabled and will not attempt log delivery.
+ * 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.
*/
public CompletableFuture> get(
String id, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("log-streams")
- .addPathSegment(id)
- .build();
+ .addPathSegment(id);
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request okhttpRequest = new Request.Builder()
- .url(httpUrl)
+ .url(httpUrl.build())
.method("GET", null)
.headers(Headers.of(clientOptions.headers(requestOptions)))
.addHeader("Accept", "application/json")
@@ -895,13 +907,17 @@ public CompletableFuture> delete(String id) {
* Delete a log stream.
*/
public CompletableFuture> delete(String id, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("log-streams")
- .addPathSegment(id)
- .build();
+ .addPathSegment(id);
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request okhttpRequest = new Request.Builder()
- .url(httpUrl)
+ .url(httpUrl.build())
.method("DELETE", null)
.headers(Headers.of(clientOptions.headers(requestOptions)))
.addHeader("Accept", "application/json")
@@ -970,40 +986,40 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
/**
* Update a log stream.
- * <h4>Examples of how to use the PATCH endpoint.</h4> The following fields may be updated in a PATCH operation: <ul><li>name</li><li>status</li><li>sink</li></ul> Note: For log streams of type <code>eventbridge</code> and <code>eventgrid</code>, updating the <code>sink</code> is not permitted.
- * <h5>Update the status of a log stream</h5><pre><code>{
+ *
Examples of how to use the PATCH endpoint.
The following fields may be updated in a PATCH operation: - name
- status
- sink
Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
{
* "status": "active|paused"
- * }</code></pre>
- * <h5>Update the name of a log stream</h5><pre><code>{
+ * }
+ * Update the name of a log stream
{
* "name": "string"
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>http</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type http
{
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>datadog</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type datadog
{
* "sink": {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>splunk</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type splunk
{
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>sumo</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type sumo
{
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }</code></pre>
+ * }
*/
public CompletableFuture> update(String id) {
return update(id, UpdateLogStreamRequestContent.builder().build());
@@ -1011,40 +1027,82 @@ public CompletableFuture<h4>Examples of how to use the PATCH endpoint.</h4> The following fields may be updated in a PATCH operation: <ul><li>name</li><li>status</li><li>sink</li></ul> Note: For log streams of type <code>eventbridge</code> and <code>eventgrid</code>, updating the <code>sink</code> is not permitted.
- * <h5>Update the status of a log stream</h5><pre><code>{
+ * Examples of how to use the PATCH endpoint.
The following fields may be updated in a PATCH operation: - name
- status
- sink
Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
{
+ * "status": "active|paused"
+ * }
+ * Update the name of a log stream
{
+ * "name": "string"
+ * }
+ * Update the sink properties of a stream of type http
{
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONARRAY|JSONLINES",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ * Update the sink properties of a stream of type datadog
{
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ * Update the sink properties of a stream of type splunk
{
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ * Update the sink properties of a stream of type sumo
{
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ */
+ public CompletableFuture> update(
+ String id, RequestOptions requestOptions) {
+ return update(id, UpdateLogStreamRequestContent.builder().build(), requestOptions);
+ }
+
+ /**
+ * Update a log stream.
+ * Examples of how to use the PATCH endpoint.
The following fields may be updated in a PATCH operation: - name
- status
- sink
Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
{
* "status": "active|paused"
- * }</code></pre>
- * <h5>Update the name of a log stream</h5><pre><code>{
+ * }
+ * Update the name of a log stream
{
* "name": "string"
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>http</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type http
{
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>datadog</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type datadog
{
* "sink": {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>splunk</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type splunk
{
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>sumo</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type sumo
{
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }</code></pre>
+ * }
*/
public CompletableFuture> update(
String id, UpdateLogStreamRequestContent request) {
@@ -1053,48 +1111,52 @@ public CompletableFuture<h4>Examples of how to use the PATCH endpoint.</h4> The following fields may be updated in a PATCH operation: <ul><li>name</li><li>status</li><li>sink</li></ul> Note: For log streams of type <code>eventbridge</code> and <code>eventgrid</code>, updating the <code>sink</code> is not permitted.
- * <h5>Update the status of a log stream</h5><pre><code>{
+ * Examples of how to use the PATCH endpoint.
The following fields may be updated in a PATCH operation: - name
- status
- sink
Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
{
* "status": "active|paused"
- * }</code></pre>
- * <h5>Update the name of a log stream</h5><pre><code>{
+ * }
+ * Update the name of a log stream
{
* "name": "string"
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>http</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type http
{
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>datadog</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type datadog
{
* "sink": {
* "datadogRegion": "string",
* "datadogApiKey": "string"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>splunk</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type splunk
{
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }</code></pre>
- * <h5>Update the sink properties of a stream of type <code>sumo</code></h5><pre><code>{
+ * }
+ * Update the sink properties of a stream of type sumo
{
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }</code></pre>
+ * }
*/
public CompletableFuture> update(
String id, UpdateLogStreamRequestContent request, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("log-streams")
- .addPathSegment(id)
- .build();
+ .addPathSegment(id);
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
RequestBody body;
try {
body = RequestBody.create(
@@ -1103,7 +1165,7 @@ public CompletableFutureSet custom search criteria using the <code>q</code> parameter, or search from a specific log ID (<i>"search from checkpoint"</i>).
- * For more information on all possible event types, their respective acronyms, and descriptions, see <a href="https://auth0.com/docs/logs/log-event-type-codes">Log Event Type Codes</a>.
- * <h5>To set custom search criteria, use the following parameters:</h5>
- * <ul>
- * <li><b>q:</b> Search Criteria using <a href="https://auth0.com/docs/logs/log-search-query-syntax">Query String Syntax</a></li>
- * <li><b>page:</b> Page index of the results to return. First page is 0.</li>
- * <li><b>per_page:</b> Number of results per page.</li>
- * <li><b>sort:</b> Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`</li>
- * <li><b>fields:</b> Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.</li>
- * <li><b>include_fields:</b> Whether specified fields are to be included (true) or excluded (false).</li>
- * <li><b>include_totals:</b> Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). <b>Deprecated:</b> this field is deprecated and should be removed from use. See <a href="https://auth0.com/docs/product-lifecycle/deprecations-and-migrations/migrate-to-tenant-log-search-v3#pagination">Search Engine V3 Breaking Changes</a></li>
- * </ul>
- * For more information on the list of fields that can be used in <code>fields</code> and <code>sort</code>, see <a href="https://auth0.com/docs/logs/log-search-query-syntax#searchable-fields">Searchable Fields</a>.
- * Auth0 <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#limitations">limits the number of logs</a> you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#retrieve-logs-by-checkpoint">get logs by checkpoint method</a>.
- * <h5>To search from a checkpoint log ID, use the following parameters:</h5>
- * <ul>
- * <li><b>from:</b> Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the <code>take</code> parameter. If you use <code>from</code> at the same time as <code>q</code>, <code>from</code> takes precedence and <code>q</code> is ignored.</li>
- * <li><b>take:</b> Number of entries to retrieve when using the <code>from</code> parameter.</li>
- * </ul>
- * <strong>Important:</strong> When fetching logs from a checkpoint log ID, any parameter other than <code>from</code> and <code>take</code> will be ignored, and date ordering is not guaranteed.
+ * Set custom search criteria using the q parameter, or search from a specific log ID ("search from checkpoint").
+ * For more information on all possible event types, their respective acronyms, and descriptions, see Log Event Type Codes.
+ * To set custom search criteria, use the following parameters:
+ *
+ * - q: Search Criteria using Query String Syntax
+ * - page: Page index of the results to return. First page is 0.
+ * - per_page: Number of results per page.
+ * - sort: Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`
+ * - fields: Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.
+ * - include_fields: Whether specified fields are to be included (true) or excluded (false).
+ * - include_totals: Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). Deprecated: this field is deprecated and should be removed from use. See Search Engine V3 Breaking Changes
+ *
+ * For more information on the list of fields that can be used in fields and sort, see Searchable Fields.
+ * Auth0 limits the number of logs you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the get logs by checkpoint method.
+ * To search from a checkpoint log ID, use the following parameters:
+ *
+ * - from: Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the
take parameter. If you use from at the same time as q, from takes precedence and q is ignored.
+ * - take: Number of entries to retrieve when using the
from parameter.
+ *
+ * Important: When fetching logs from a checkpoint log ID, any parameter other than from and take will be ignored, and date ordering is not guaranteed.
*/
public CompletableFuture>> list() {
return list(ListLogsRequestParameters.builder().build());
@@ -72,26 +72,53 @@ public CompletableFuture>> lis
/**
* Retrieve log entries that match the specified search criteria (or all log entries if no criteria specified).
- * Set custom search criteria using the <code>q</code> parameter, or search from a specific log ID (<i>"search from checkpoint"</i>).
- * For more information on all possible event types, their respective acronyms, and descriptions, see <a href="https://auth0.com/docs/logs/log-event-type-codes">Log Event Type Codes</a>.
- * <h5>To set custom search criteria, use the following parameters:</h5>
- * <ul>
- * <li><b>q:</b> Search Criteria using <a href="https://auth0.com/docs/logs/log-search-query-syntax">Query String Syntax</a></li>
- * <li><b>page:</b> Page index of the results to return. First page is 0.</li>
- * <li><b>per_page:</b> Number of results per page.</li>
- * <li><b>sort:</b> Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`</li>
- * <li><b>fields:</b> Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.</li>
- * <li><b>include_fields:</b> Whether specified fields are to be included (true) or excluded (false).</li>
- * <li><b>include_totals:</b> Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). <b>Deprecated:</b> this field is deprecated and should be removed from use. See <a href="https://auth0.com/docs/product-lifecycle/deprecations-and-migrations/migrate-to-tenant-log-search-v3#pagination">Search Engine V3 Breaking Changes</a></li>
- * </ul>
- * For more information on the list of fields that can be used in <code>fields</code> and <code>sort</code>, see <a href="https://auth0.com/docs/logs/log-search-query-syntax#searchable-fields">Searchable Fields</a>.
- * Auth0 <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#limitations">limits the number of logs</a> you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#retrieve-logs-by-checkpoint">get logs by checkpoint method</a>.
- * <h5>To search from a checkpoint log ID, use the following parameters:</h5>
- * <ul>
- * <li><b>from:</b> Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the <code>take</code> parameter. If you use <code>from</code> at the same time as <code>q</code>, <code>from</code> takes precedence and <code>q</code> is ignored.</li>
- * <li><b>take:</b> Number of entries to retrieve when using the <code>from</code> parameter.</li>
- * </ul>
- * <strong>Important:</strong> When fetching logs from a checkpoint log ID, any parameter other than <code>from</code> and <code>take</code> will be ignored, and date ordering is not guaranteed.
+ * Set custom search criteria using the q parameter, or search from a specific log ID ("search from checkpoint").
+ * For more information on all possible event types, their respective acronyms, and descriptions, see Log Event Type Codes.
+ * To set custom search criteria, use the following parameters:
+ *
+ * - q: Search Criteria using Query String Syntax
+ * - page: Page index of the results to return. First page is 0.
+ * - per_page: Number of results per page.
+ * - sort: Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`
+ * - fields: Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.
+ * - include_fields: Whether specified fields are to be included (true) or excluded (false).
+ * - include_totals: Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). Deprecated: this field is deprecated and should be removed from use. See Search Engine V3 Breaking Changes
+ *
+ * For more information on the list of fields that can be used in fields and sort, see Searchable Fields.
+ * Auth0 limits the number of logs you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the get logs by checkpoint method.
+ * To search from a checkpoint log ID, use the following parameters:
+ *
+ * - from: Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the
take parameter. If you use from at the same time as q, from takes precedence and q is ignored.
+ * - take: Number of entries to retrieve when using the
from parameter.
+ *
+ * Important: When fetching logs from a checkpoint log ID, any parameter other than from and take will be ignored, and date ordering is not guaranteed.
+ */
+ public CompletableFuture>> list(RequestOptions requestOptions) {
+ return list(ListLogsRequestParameters.builder().build(), requestOptions);
+ }
+
+ /**
+ * Retrieve log entries that match the specified search criteria (or all log entries if no criteria specified).
+ * Set custom search criteria using the q parameter, or search from a specific log ID ("search from checkpoint").
+ * For more information on all possible event types, their respective acronyms, and descriptions, see Log Event Type Codes.
+ * To set custom search criteria, use the following parameters:
+ *
+ * - q: Search Criteria using Query String Syntax
+ * - page: Page index of the results to return. First page is 0.
+ * - per_page: Number of results per page.
+ * - sort: Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`
+ * - fields: Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.
+ * - include_fields: Whether specified fields are to be included (true) or excluded (false).
+ * - include_totals: Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). Deprecated: this field is deprecated and should be removed from use. See Search Engine V3 Breaking Changes
+ *
+ * For more information on the list of fields that can be used in fields and sort, see Searchable Fields.
+ * Auth0 limits the number of logs you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the get logs by checkpoint method.
+ * To search from a checkpoint log ID, use the following parameters:
+ *
+ * - from: Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the
take parameter. If you use from at the same time as q, from takes precedence and q is ignored.
+ * - take: Number of entries to retrieve when using the
from parameter.
+ *
+ * Important: When fetching logs from a checkpoint log ID, any parameter other than from and take will be ignored, and date ordering is not guaranteed.
*/
public CompletableFuture>> list(
ListLogsRequestParameters request) {
@@ -100,26 +127,26 @@ public CompletableFuture>> lis
/**
* Retrieve log entries that match the specified search criteria (or all log entries if no criteria specified).
- * Set custom search criteria using the <code>q</code> parameter, or search from a specific log ID (<i>"search from checkpoint"</i>).
- * For more information on all possible event types, their respective acronyms, and descriptions, see <a href="https://auth0.com/docs/logs/log-event-type-codes">Log Event Type Codes</a>.
- * <h5>To set custom search criteria, use the following parameters:</h5>
- * <ul>
- * <li><b>q:</b> Search Criteria using <a href="https://auth0.com/docs/logs/log-search-query-syntax">Query String Syntax</a></li>
- * <li><b>page:</b> Page index of the results to return. First page is 0.</li>
- * <li><b>per_page:</b> Number of results per page.</li>
- * <li><b>sort:</b> Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`</li>
- * <li><b>fields:</b> Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.</li>
- * <li><b>include_fields:</b> Whether specified fields are to be included (true) or excluded (false).</li>
- * <li><b>include_totals:</b> Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). <b>Deprecated:</b> this field is deprecated and should be removed from use. See <a href="https://auth0.com/docs/product-lifecycle/deprecations-and-migrations/migrate-to-tenant-log-search-v3#pagination">Search Engine V3 Breaking Changes</a></li>
- * </ul>
- * For more information on the list of fields that can be used in <code>fields</code> and <code>sort</code>, see <a href="https://auth0.com/docs/logs/log-search-query-syntax#searchable-fields">Searchable Fields</a>.
- * Auth0 <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#limitations">limits the number of logs</a> you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#retrieve-logs-by-checkpoint">get logs by checkpoint method</a>.
- * <h5>To search from a checkpoint log ID, use the following parameters:</h5>
- * <ul>
- * <li><b>from:</b> Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the <code>take</code> parameter. If you use <code>from</code> at the same time as <code>q</code>, <code>from</code> takes precedence and <code>q</code> is ignored.</li>
- * <li><b>take:</b> Number of entries to retrieve when using the <code>from</code> parameter.</li>
- * </ul>
- * <strong>Important:</strong> When fetching logs from a checkpoint log ID, any parameter other than <code>from</code> and <code>take</code> will be ignored, and date ordering is not guaranteed.
+ * Set custom search criteria using the q parameter, or search from a specific log ID ("search from checkpoint").
+ * For more information on all possible event types, their respective acronyms, and descriptions, see Log Event Type Codes.
+ * To set custom search criteria, use the following parameters:
+ *
+ * - q: Search Criteria using Query String Syntax
+ * - page: Page index of the results to return. First page is 0.
+ * - per_page: Number of results per page.
+ * - sort: Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`
+ * - fields: Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.
+ * - include_fields: Whether specified fields are to be included (true) or excluded (false).
+ * - include_totals: Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). Deprecated: this field is deprecated and should be removed from use. See Search Engine V3 Breaking Changes
+ *
+ * For more information on the list of fields that can be used in fields and sort, see Searchable Fields.
+ * Auth0 limits the number of logs you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the get logs by checkpoint method.
+ * To search from a checkpoint log ID, use the following parameters:
+ *
+ * - from: Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the
take parameter. If you use from at the same time as q, from takes precedence and q is ignored.
+ * - take: Number of entries to retrieve when using the
from parameter.
+ *
+ * Important: When fetching logs from a checkpoint log ID, any parameter other than from and take will be ignored, and date ordering is not guaranteed.
*/
public CompletableFuture>> list(
ListLogsRequestParameters request, RequestOptions requestOptions) {
@@ -147,6 +174,11 @@ public CompletableFuture>> lis
QueryStringMapper.addQueryParameter(
httpUrl, "search", request.getSearch().orElse(null), false);
}
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request.Builder _requestBuilder = new Request.Builder()
.url(httpUrl.build())
.method("GET", null)
@@ -242,13 +274,17 @@ public CompletableFuture> get(S
*/
public CompletableFuture> get(
String id, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("logs")
- .addPathSegment(id)
- .build();
+ .addPathSegment(id);
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request okhttpRequest = new Request.Builder()
- .url(httpUrl)
+ .url(httpUrl.build())
.method("GET", null)
.headers(Headers.of(clientOptions.headers(requestOptions)))
.addHeader("Accept", "application/json")
diff --git a/src/main/java/com/auth0/client/mgmt/AsyncRawNetworkAclsClient.java b/src/main/java/com/auth0/client/mgmt/AsyncRawNetworkAclsClient.java
index f5d815ae..2accd174 100644
--- a/src/main/java/com/auth0/client/mgmt/AsyncRawNetworkAclsClient.java
+++ b/src/main/java/com/auth0/client/mgmt/AsyncRawNetworkAclsClient.java
@@ -59,6 +59,14 @@ public CompletableFuture>> list(
+ RequestOptions requestOptions) {
+ return list(ListNetworkAclsRequestParameters.builder().build(), requestOptions);
+ }
+
/**
* Get all access control list entries for your client.
*/
@@ -80,6 +88,11 @@ public CompletableFuture {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request.Builder _requestBuilder = new Request.Builder()
.url(httpUrl.build())
.method("GET", null)
@@ -178,10 +191,14 @@ public CompletableFuture> create(CreateNetworkAc
*/
public CompletableFuture> create(
CreateNetworkAclRequestContent request, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
- .addPathSegments("network-acls")
- .build();
+ .addPathSegments("network-acls");
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
RequestBody body;
try {
body = RequestBody.create(
@@ -190,7 +207,7 @@ public CompletableFuture> create(
throw new ManagementException("Failed to serialize request", e);
}
Request okhttpRequest = new Request.Builder()
- .url(httpUrl)
+ .url(httpUrl.build())
.method("POST", body)
.headers(Headers.of(clientOptions.headers(requestOptions)))
.addHeader("Content-Type", "application/json")
@@ -275,13 +292,17 @@ public CompletableFuture> get(
String id, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("network-acls")
- .addPathSegment(id)
- .build();
+ .addPathSegment(id);
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request okhttpRequest = new Request.Builder()
- .url(httpUrl)
+ .url(httpUrl.build())
.method("GET", null)
.headers(Headers.of(clientOptions.headers(requestOptions)))
.addHeader("Accept", "application/json")
@@ -359,11 +380,15 @@ public CompletableFuture> set(
String id, SetNetworkAclRequestContent request, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("network-acls")
- .addPathSegment(id)
- .build();
+ .addPathSegment(id);
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
RequestBody body;
try {
body = RequestBody.create(
@@ -372,7 +397,7 @@ public CompletableFuture> delete(String id) {
* Delete existing access control list for your client.
*/
public CompletableFuture> delete(String id, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("network-acls")
- .addPathSegment(id)
- .build();
+ .addPathSegment(id);
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request okhttpRequest = new Request.Builder()
- .url(httpUrl)
+ .url(httpUrl.build())
.method("DELETE", null)
.headers(Headers.of(clientOptions.headers(requestOptions)))
.addHeader("Accept", "application/json")
@@ -534,6 +563,14 @@ public CompletableFuture> update(
+ String id, RequestOptions requestOptions) {
+ return update(id, UpdateNetworkAclRequestContent.builder().build(), requestOptions);
+ }
+
/**
* Update existing access control list for your client.
*/
@@ -547,11 +584,15 @@ public CompletableFuture> update(
String id, UpdateNetworkAclRequestContent request, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("network-acls")
- .addPathSegment(id)
- .build();
+ .addPathSegment(id);
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
RequestBody body;
try {
body = RequestBody.create(
@@ -560,7 +601,7 @@ public CompletableFutureThis endpoint supports two types of pagination:
- * <ul>
- * <li>Offset pagination</li>
- * <li>Checkpoint pagination</li>
- * </ul>
+ *
+ * - Offset pagination
+ * - Checkpoint pagination
+ *
* Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.
- * <h2>Checkpoint Pagination</h2>
+ * Checkpoint Pagination
* To search by checkpoint, use the following parameters:
- * <ul>
- * <li><code>from</code>: Optional id from which to start selection.</li>
- * <li><code>take</code>: The total number of entries to retrieve when using the <code>from</code> parameter. Defaults to 50.</li>
- * </ul>
- * <b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.
+ *
+ * from: Optional id from which to start selection.take: The total number of entries to retrieve when using the from parameter. Defaults to 50.
+ * Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
*/
public CompletableFuture>> list() {
return list(ListOrganizationsRequestParameters.builder().build());
@@ -75,18 +75,39 @@ public CompletableFutureThis endpoint supports two types of pagination:
- * <ul>
- * <li>Offset pagination</li>
- * <li>Checkpoint pagination</li>
- * </ul>
+ *
+ * - Offset pagination
+ * - Checkpoint pagination
+ *
* Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.
- * <h2>Checkpoint Pagination</h2>
+ * Checkpoint Pagination
* To search by checkpoint, use the following parameters:
- * <ul>
- * <li><code>from</code>: Optional id from which to start selection.</li>
- * <li><code>take</code>: The total number of entries to retrieve when using the <code>from</code> parameter. Defaults to 50.</li>
- * </ul>
- * <b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.
+ *
+ * from: Optional id from which to start selection.take: The total number of entries to retrieve when using the from parameter. Defaults to 50.
+ * Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
+ */
+ public CompletableFuture>> list(
+ RequestOptions requestOptions) {
+ return list(ListOrganizationsRequestParameters.builder().build(), requestOptions);
+ }
+
+ /**
+ * Retrieve detailed list of all Organizations available in your tenant. For more information, see Auth0 Organizations.
+ * This endpoint supports two types of pagination:
+ *
+ * - Offset pagination
+ * - Checkpoint pagination
+ *
+ * Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.
+ * Checkpoint Pagination
+ * To search by checkpoint, use the following parameters:
+ *
+ * from: Optional id from which to start selection.take: The total number of entries to retrieve when using the from parameter. Defaults to 50.
+ * Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
*/
public CompletableFuture>> list(
ListOrganizationsRequestParameters request) {
@@ -96,18 +117,18 @@ public CompletableFutureThis endpoint supports two types of pagination:
- * <ul>
- * <li>Offset pagination</li>
- * <li>Checkpoint pagination</li>
- * </ul>
+ *
+ * - Offset pagination
+ * - Checkpoint pagination
+ *
* Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.
- * <h2>Checkpoint Pagination</h2>
+ * Checkpoint Pagination
* To search by checkpoint, use the following parameters:
- * <ul>
- * <li><code>from</code>: Optional id from which to start selection.</li>
- * <li><code>take</code>: The total number of entries to retrieve when using the <code>from</code> parameter. Defaults to 50.</li>
- * </ul>
- * <b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.
+ *
+ * from: Optional id from which to start selection.take: The total number of entries to retrieve when using the from parameter. Defaults to 50.
+ * Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
*/
public CompletableFuture>> list(
ListOrganizationsRequestParameters request, RequestOptions requestOptions) {
@@ -123,6 +144,11 @@ public CompletableFuture {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request.Builder _requestBuilder = new Request.Builder()
.url(httpUrl.build())
.method("GET", null)
@@ -208,7 +234,7 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
}
/**
- * Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review <a href="https://auth0.com/docs/manage-users/organizations/create-first-organization">Create Your First Organization</a>.
+ * Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review Create Your First Organization.
*/
public CompletableFuture> create(
CreateOrganizationRequestContent request) {
@@ -216,14 +242,18 @@ public CompletableFutureCreate Your First Organization.
*/
public CompletableFuture> create(
CreateOrganizationRequestContent request, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
- .addPathSegments("organizations")
- .build();
+ .addPathSegments("organizations");
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
RequestBody body;
try {
body = RequestBody.create(
@@ -232,7 +262,7 @@ public CompletableFuture> getByName(
String name, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("organizations/name")
- .addPathSegment(name)
- .build();
+ .addPathSegment(name);
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request okhttpRequest = new Request.Builder()
- .url(httpUrl)
+ .url(httpUrl.build())
.method("GET", null)
.headers(Headers.of(clientOptions.headers(requestOptions)))
.addHeader("Accept", "application/json")
@@ -400,13 +434,17 @@ public CompletableFuture> get(
String id, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("organizations")
- .addPathSegment(id)
- .build();
+ .addPathSegment(id);
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request okhttpRequest = new Request.Builder()
- .url(httpUrl)
+ .url(httpUrl.build())
.method("GET", null)
.headers(Headers.of(clientOptions.headers(requestOptions)))
.addHeader("Accept", "application/json")
@@ -473,7 +511,7 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
/**
* Remove an Organization from your tenant. This action cannot be undone.
- * <b>Note</b>: Members are automatically disassociated from an Organization when it is deleted. However, this action does <b>not</b> delete these users from your tenant.
+ * Note: Members are automatically disassociated from an Organization when it is deleted. However, this action does not delete these users from your tenant.
*/
public CompletableFuture> delete(String id) {
return delete(id, null);
@@ -481,16 +519,20 @@ public CompletableFuture> delete(String id) {
/**
* Remove an Organization from your tenant. This action cannot be undone.
- * <b>Note</b>: Members are automatically disassociated from an Organization when it is deleted. However, this action does <b>not</b> delete these users from your tenant.
+ * Note: Members are automatically disassociated from an Organization when it is deleted. However, this action does not delete these users from your tenant.
*/
public CompletableFuture> delete(String id, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("organizations")
- .addPathSegment(id)
- .build();
+ .addPathSegment(id);
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
Request okhttpRequest = new Request.Builder()
- .url(httpUrl)
+ .url(httpUrl.build())
.method("DELETE", null)
.headers(Headers.of(clientOptions.headers(requestOptions)))
.addHeader("Accept", "application/json")
@@ -558,14 +600,22 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) {
}
/**
- * Update the details of a specific <a href="https://auth0.com/docs/manage-users/organizations/configure-organizations/create-organizations">Organization</a>, such as name and display name, branding options, and metadata.
+ * Update the details of a specific Organization, such as name and display name, branding options, and metadata.
*/
public CompletableFuture> update(String id) {
return update(id, UpdateOrganizationRequestContent.builder().build());
}
/**
- * Update the details of a specific <a href="https://auth0.com/docs/manage-users/organizations/configure-organizations/create-organizations">Organization</a>, such as name and display name, branding options, and metadata.
+ * Update the details of a specific Organization, such as name and display name, branding options, and metadata.
+ */
+ public CompletableFuture> update(
+ String id, RequestOptions requestOptions) {
+ return update(id, UpdateOrganizationRequestContent.builder().build(), requestOptions);
+ }
+
+ /**
+ * Update the details of a specific Organization, such as name and display name, branding options, and metadata.
*/
public CompletableFuture> update(
String id, UpdateOrganizationRequestContent request) {
@@ -573,15 +623,19 @@ public CompletableFutureOrganization, such as name and display name, branding options, and metadata.
*/
public CompletableFuture> update(
String id, UpdateOrganizationRequestContent request, RequestOptions requestOptions) {
- HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
+ HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
.newBuilder()
.addPathSegments("organizations")
- .addPathSegment(id)
- .build();
+ .addPathSegment(id);
+ if (requestOptions != null) {
+ requestOptions.getQueryParameters().forEach((_key, _value) -> {
+ httpUrl.addQueryParameter(_key, _value);
+ });
+ }
RequestBody body;
try {
body = RequestBody.create(
@@ -590,7 +644,7 @@ public CompletableFutureIdentifier First Authentication and