diff --git a/.fern/replay.lock b/.fern/replay.lock index 0593e246..895bd2df 100644 --- a/.fern/replay.lock +++ b/.fern/replay.lock @@ -24,390 +24,11 @@ generations: cli_version: unknown generator_versions: fernapi/fern-java-sdk: 4.11.1 -current_generation: 6123049f4ae684b09b5bfb8da5ed607adc6f871d -patches: - - id: patch-ec28244b - content_hash: sha256:138547c31047858fa903f656bd52246c357d3c34bd650b5648c0ed7f0f37ee0f - original_commit: ec28244b9fc3bce518088b96a5402cbb8ad1dcc6 - original_message: "feat: add MIGRATION_GUIDE (#900)" - original_author: Tanya Sinha - base_generation: 6123049f4ae684b09b5bfb8da5ed607adc6f871d - files: - - v3_MIGRATION_GUIDE.md - patch_content: | - diff --git a/MIGRATION_GUIDE.md b/MIGRATION_GUIDE.md - deleted file mode 100644 - index 9d98602c..00000000 - --- a/MIGRATION_GUIDE.md - +++ /dev/null - @@ -1,369 +0,0 @@ - -# V3 Migration Guide - - - -A guide to migrating the Auth0 Java SDK from `v2` to `v3`. - - - -- [Overall changes](#overall-changes) - - - [Java versions](#java-versions) - - - [Authentication API](#authentication-api) - - - [Management API](#management-api) - -- [Specific changes to the Management API](#specific-changes-to-the-management-api) - - - [Client initialization](#client-initialization) - - - [Sub-client organization](#sub-client-organization) - - - [Request and response patterns](#request-and-response-patterns) - - - [Pagination](#pagination) - - - [Exception handling](#exception-handling) - - - [Accessing raw HTTP responses](#accessing-raw-http-responses) - - - [Request-level configuration](#request-level-configuration) - - - [Type changes](#type-changes) - - - -## Overall changes - - - -### Java versions - - - -Both v2 and v3 require Java 8 or above. - - - -### Authentication API - - - -This major version change does not affect the Authentication API. The `AuthAPI` class has been ported directly from v2 to v3. Any code written for the Authentication API in the v2 version should work in the v3 version. - - - -```java - -// Works in both v2 and v3 - -AuthAPI auth = AuthAPI.newBuilder("{YOUR_DOMAIN}", "{YOUR_CLIENT_ID}", "{YOUR_CLIENT_SECRET}").build(); - -``` - - - -### Management API - - - -V3 introduces significant improvements to the Management API SDK by migrating to [Fern](https://github.com/fern-api/fern) as the code generation tool. This provides: - - - -- Better resource grouping with sub-client organization - -- Type-safe request and response objects using builder patterns - -- Automatic pagination with `SyncPagingIterable` - -- Simplified access to HTTP response metadata via `withRawResponse()` - -- Consistent method naming (`list`, `create`, `get`, `update`, `delete`) - - - -## Specific changes to the Management API - - - -### Client initialization - - - -The Management API client initialization has changed from `ManagementAPI` to `ManagementApi`, and uses a different builder pattern. - - - -**v2:** - -```java - -import com.auth0.client.mgmt.ManagementAPI; - - - -// Using domain and token - -ManagementAPI mgmt = ManagementAPI.newBuilder("{YOUR_DOMAIN}", "{YOUR_API_TOKEN}").build(); - - - -// Using TokenProvider - -TokenProvider tokenProvider = SimpleTokenProvider.create("{YOUR_API_TOKEN}"); - -ManagementAPI mgmt = ManagementAPI.newBuilder("{YOUR_DOMAIN}", tokenProvider).build(); - -``` - - - -**v3:** - -1st Approach : Standard Token-Based - -```java - -import com.auth0.client.mgmt.ManagementApi; - - - -ManagementApi client = ManagementApi - - .builder() - - .url("https://{YOUR_DOMAIN}/api/v2") - - .token("{YOUR_API_TOKEN}") - - .build(); - -``` - - - -or - - - -2nd Approach : OAuth client credentials flow - - - -```java - -OAuthTokenSupplier tokenSupplier = new OAuthTokenSupplier( - -"{CLIENT_ID}", - -"{CLIENT_SECRET}", - -"https://{YOUR_DOMAIN}", - -"{YOUR_AUDIENCE}" - -); - - - -ClientOptions clientOptions = ClientOptions.builder() - -.environment(Environment.custom("https://{YOUR_AUDIENCE}")) - -.addHeader("Authorization", () -> "Bearer " + tokenSupplier.get()) - -.build(); - - - -ManagementApi client = new ManagementApi(clientOptions); - - - -``` - - - -#### Builder options comparison - - - -| Option | v2 | v3 | - -|--------|----|----| - -| Domain/URL | `newBuilder(domain, token)` | `.url("https://domain/api/v2")` | - -| Token | Constructor parameter | `.token(token)` | - -| Timeout | Via `HttpOptions` | `.timeout(seconds)` | - -| Max retries | Via `HttpOptions` | `.maxRetries(count)` | - -| Custom HTTP client | `.withHttpClient(Auth0HttpClient)` | `.httpClient(OkHttpClient)` | - -| Custom headers | Not directly supported | `.addHeader(name, value)` | - - - -### Sub-client organization - - - -V3 introduces a hierarchical sub-client structure. Operations on related resources are now accessed through nested clients instead of methods on a flat entity class. - - - -**v2:** - -```java - -// All user operations on UsersEntity - -Request userRequest = mgmt.users().get("user_id", new UserFilter()); - -Request> permissionsRequest = mgmt.users().getPermissions("user_id", new PermissionsFilter()); - -Request> rolesRequest = mgmt.users().getRoles("user_id", new RolesFilter()); - -Request logsRequest = mgmt.users().getLogEvents("user_id", new LogEventFilter()); - -``` - - - -**v3:** - -```java - -// Operations organized into sub-clients - -GetUserResponseContent user = client.users().get("user_id"); - -SyncPagingIterable permissions = client.users().permissions().list("user_id"); - -SyncPagingIterable roles = client.users().roles().list("user_id"); - -SyncPagingIterable logs = client.users().logs().list("user_id"); - -``` - - - -#### Common sub-client mappings - - - -| v2 Method | v3 Sub-client | - -|-----------|---------------| - -| `mgmt.users().getPermissions()` | `client.users().permissions().list()` | - -| `mgmt.users().getRoles()` | `client.users().roles().list()` | - -| `mgmt.users().getLogEvents()` | `client.users().logs().list()` | - -| `mgmt.users().getOrganizations()` | `client.users().organizations().list()` | - -| `mgmt.users().link()` | `client.users().identities().link()` | - -| `mgmt.users().unlink()` | `client.users().identities().delete()` | - -| `mgmt.users().deleteMultifactorProvider()` | `client.users().multifactor().deleteProvider()` | - -| `mgmt.organizations().getMembers()` | `client.organizations().members().list()` | - -| `mgmt.organizations().getInvitations()` | `client.organizations().invitations().list()` | - -| `mgmt.organizations().getEnabledConnections()` | `client.organizations().enabledConnections().list()` | - -| `mgmt.actions().getVersions()` | `client.actions().versions().list()` | - -| `mgmt.actions().getTriggerBindings()` | `client.actions().triggers().bindings().list()` | - -| `mgmt.guardian().getFactors()` | `client.guardian().factors().list()` | - -| `mgmt.branding().getUniversalLoginTemplate()` | `client.branding().templates().getUniversalLogin()` | - -| `mgmt.connections().getScimConfiguration()` | `client.connections().scimConfiguration().get()` | - - - -### Request and response patterns - - - -V3 uses type-safe request content objects with builders instead of domain objects or filter parameters. - - - -**v2:** - -```java - -import com.auth0.json.mgmt.users.User; - -import com.auth0.net.Request; - - - -// Creating a user - -User user = new User("Username-Password-Authentication"); - -user.setEmail("test@example.com"); - -user.setPassword("password123".toCharArray()); - - - -Request request = mgmt.users().create(user); - -User createdUser = request.execute().getBody(); - -``` - - - -**v3:** - -```java - -import com.auth0.client.mgmt.types.CreateUserRequestContent; - -import com.auth0.client.mgmt.types.CreateUserResponseContent; - - - -// Creating a user - -CreateUserResponseContent user = client.users().create( - - CreateUserRequestContent - - .builder() - - .connection("Username-Password-Authentication") - - .email("test@example.com") - - .password("password123") - - .build() - -); - -``` - - - -#### Key differences - - - -| Aspect | v2 | v3 | - -|--------|----|----| - -| Request building | Domain objects with setters | Builder pattern with `*RequestContent` types | - -| Response type | `Request` requiring `.execute().getBody()` | Direct return of response object | - -| Filtering | Filter classes (e.g., `UserFilter`) | `*RequestParameters` builder classes | - -| Execution | Explicit `.execute()` call | Implicit execution on method call | - - - -### Pagination - - - -V3 introduces `SyncPagingIterable` for automatic pagination, replacing the manual `Request` pattern. - - - -**v2:** - -```java - -import com.auth0.json.mgmt.users.UsersPage; - -import com.auth0.client.mgmt.filter.UserFilter; - - - -Request request = mgmt.users().list(new UserFilter().withPage(0, 50)); - -UsersPage page = request.execute().getBody(); - - - -for (User user : page.getItems()) { - - System.out.println(user.getEmail()); - -} - - - -// Manual pagination - -while (page.getNext() != null) { - - request = mgmt.users().list(new UserFilter().withPage(page.getNext(), 50)); - - page = request.execute().getBody(); - - for (User user : page.getItems()) { - - System.out.println(user.getEmail()); - - } - -} - -``` - - - -**v3:** - -```java - -import com.auth0.client.mgmt.core.SyncPagingIterable; - -import com.auth0.client.mgmt.types.UserResponseSchema; - -import com.auth0.client.mgmt.types.ListUsersRequestParameters; - - - -// Automatic iteration through all pages - -SyncPagingIterable users = client.users().list( - - ListUsersRequestParameters - - .builder() - - .perPage(50) - - .build() - -); - - - -for (UserResponseSchema user : users) { - - System.out.println(user.getEmail()); - -} - - - -// Or manual page control - -List pageItems = users.getItems(); - -while (users.hasNext()) { - - pageItems = users.nextPage().getItems(); - - // process page - -} - -``` - - - -### Exception handling - - - -V3 uses a unified `ManagementApiException` class instead of the v2 exception hierarchy. - - - -**v2:** - -```java - -import com.auth0.exception.Auth0Exception; - -import com.auth0.exception.APIException; - -import com.auth0.exception.RateLimitException; - - - -try { - - User user = mgmt.users().get("user_id", null).execute().getBody(); - -} catch (RateLimitException e) { - - // Rate limited - - long retryAfter = e.getLimit(); - -} catch (APIException e) { - - int statusCode = e.getStatusCode(); - - String error = e.getError(); - - String description = e.getDescription(); - -} catch (Auth0Exception e) { - - // Network or other errors - -} - -``` - - - -**v3:** - -```java - -import com.auth0.client.mgmt.core.ManagementApiException; - - - -try { - - GetUserResponseContent user = client.users().get("user_id"); - -} catch (ManagementApiException e) { - - int statusCode = e.statusCode(); - - Object body = e.body(); - - Map> headers = e.headers(); - - String message = e.getMessage(); - -} - -``` - - - -### Accessing raw HTTP responses - - - -V3 provides access to full HTTP response metadata via `withRawResponse()`. - - - -**v2:** - -```java - -// Response wrapper provided status code - -Response response = mgmt.users().get("user_id", null).execute(); - -int statusCode = response.getStatusCode(); - -User user = response.getBody(); - -``` - - - -**v3:** - -```java - -import com.auth0.client.mgmt.core.ManagementApiHttpResponse; - - - -// Use withRawResponse() to access headers and metadata - -ManagementApiHttpResponse response = client.users() - - .withRawResponse() - - .get("user_id"); - - - -GetUserResponseContent user = response.body(); - -Map> headers = response.headers(); - -``` - - - -### Request-level configuration - - - -V3 allows per-request configuration through `RequestOptions`. - - - -**v2:** - -```java - -// Most configuration was at client level only - -// Request-level headers required creating a new request manually - -Request request = mgmt.users().get("user_id", null); - -request.addHeader("X-Custom-Header", "value"); - -User user = request.execute().getBody(); - -``` - - - -**v3:** - -```java - -import com.auth0.client.mgmt.core.RequestOptions; - - - -GetUserResponseContent user = client.users().get( - - "user_id", - - GetUserRequestParameters.builder().build(), - - RequestOptions.builder() - - .timeout(10) - - .maxRetries(1) - - .addHeader("X-Custom-Header", "value") - - .build() - -); - -``` - - - -### Type changes - - - -V3 uses generated type classes located in `com.auth0.client.mgmt.types` instead of the hand-written POJOs in `com.auth0.json.mgmt`. - - - -**v2:** - -```java - -import com.auth0.json.mgmt.users.User; - -import com.auth0.json.mgmt.roles.Role; - -import com.auth0.json.mgmt.organizations.Organization; - -``` - - - -**v3:** - -```java - -import com.auth0.client.mgmt.types.UserResponseSchema; - -import com.auth0.client.mgmt.types.CreateUserRequestContent; - -import com.auth0.client.mgmt.types.CreateUserResponseContent; - -import com.auth0.client.mgmt.types.Role; - -import com.auth0.client.mgmt.types.Organization; - -``` - - - -Type naming conventions in v3: - -- Request body types: `*RequestContent` (e.g., `CreateUserRequestContent`) - -- Response types: `*ResponseContent` or `*ResponseSchema` (e.g., `GetUserResponseContent`, `UserResponseSchema`) - -- Query parameters: `*RequestParameters` (e.g., `ListUsersRequestParameters`) - - - -All types use immutable builders: - - - -```java - -// v3 type construction - -CreateUserRequestContent request = CreateUserRequestContent - - .builder() - - .connection("Username-Password-Authentication") - - .email("test@example.com") - - .password("secure-password") - - .build(); - -``` - user_owned: true + - commit_sha: 97f94ce5dd517846f1fd30ae84791654a7da96bd + tree_hash: 85ae2235f756976f1a0eee80d27fcf579579bdfc + timestamp: 2026-08-04T06:33:07.487Z + cli_version: unknown + generator_versions: + fernapi/fern-java-sdk: 4.11.1 +current_generation: 97f94ce5dd517846f1fd30ae84791654a7da96bd +patches: [] diff --git a/reference.md b/reference.md index 647fa3fc..e9bb0d75 100644 --- a/reference.md +++ b/reference.md @@ -590,8 +590,8 @@ client.actions().test( -## Branding -
client.branding.get() -> GetBrandingResponseContent +## Agents +
client.agents.list() -> SyncPagingIterable<AgentResponseContent>
@@ -603,7 +603,7 @@ client.actions().test(
-Retrieve branding settings. +Get agents
@@ -618,19 +618,48 @@ Retrieve branding settings.
```java -client.branding().get(); +client.agents().list( + ListAgentsRequestParameters + .builder() + .from("from") + .take(1) + .build() +); ```
+#### ⚙️ Parameters + +
+
+ +
+
+ +**from:** `Optional` — Optional Id from which to start selection. + +
+
+ +
+
+ +**take:** `Optional` — Number of results per page. Defaults to 50. + +
+
+
+
+
-
client.branding.update(request) -> UpdateBrandingResponseContent +
client.agents.create(request) -> AgentResponseContent
@@ -642,7 +671,7 @@ client.branding().get();
-Update branding settings. +Create an agent
@@ -657,9 +686,10 @@ Update branding settings.
```java -client.branding().update( - UpdateBrandingRequestContent +client.agents().create( + CreateAgentRequestContent .builder() + .name("name") .build() ); ``` @@ -676,7 +706,7 @@ client.branding().update(
-**colors:** `Optional` +**name:** `String` — The agent name. Cannot contain <, >, or null bytes.
@@ -684,7 +714,7 @@ client.branding().update(
-**faviconUrl:** `Optional` — URL for the favicon. Must use HTTPS. +**clientId:** `Optional` — Optional client ID to associate with the agent
@@ -692,7 +722,7 @@ client.branding().update(
-**logoUrl:** `Optional` — URL for the logo. Must use HTTPS. +**externalAgentId:** `Optional` — Optional external identifier for the agent. Immutable after creation. Must be unique within the tenant.
@@ -700,7 +730,7 @@ client.branding().update(
-**font:** `Optional` +**metadata:** `Optional>`
@@ -712,8 +742,7 @@ client.branding().update(
-## ClientGrants -
client.clientGrants.list() -> SyncPagingIterable&lt;ClientGrantResponseContent&gt; +
client.agents.read(id) -> AgentResponseContent
@@ -725,7 +754,7 @@ client.branding().update(
-Retrieve a list of [client grants](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the scopes associated with the application/API pair. +Get an agent
@@ -740,18 +769,7 @@ Retrieve a list of [client grants](https://auth0.com/docs/get-started/applicatio
```java -client.clientGrants().list( - ListClientGrantsRequestParameters - .builder() - .from("from") - .take(1) - .audience("audience") - .clientId("client_id") - .allowAnyOrganization(true) - .subjectType(ClientGrantSubjectTypeEnum.CLIENT) - .defaultFor(ClientGrantDefaultForEnum.THIRD_PARTY_CLIENTS) - .build() -); +client.agents().read("id"); ```
@@ -766,55 +784,61 @@ client.clientGrants().list(
-**from:** `Optional` — Optional Id from which to start selection. +**id:** `String` — The agent ID
+ + -
-
-**take:** `Optional` — Number of results per page. Defaults to 50. -
+
+
client.agents.delete(id)
-**audience:** `Optional` — Optional filter on audience. - -
-
+#### 📝 Description
-**clientId:** `Optional` — Optional filter on client_id. - -
-
-
-**allowAnyOrganization:** `Optional` — Optional filter on allow_any_organization. - +Delete an agent
+ + + +#### 🔌 Usage
-**subjectType:** `Optional` — The type of application access the client grant allows. - +
+
+ +```java +client.agents().delete("id"); +``` +
+
+#### ⚙️ Parameters +
-**defaultFor:** `Optional` — Applies this client grant as the default for all clients in the specified group. The only accepted value is `third_party_clients`, which applies the grant to all third-party clients. Per-client grants for the same audience take precedence. Mutually exclusive with `client_id`. +
+
+ +**id:** `String` — The agent ID
@@ -826,7 +850,7 @@ client.clientGrants().list(
-
client.clientGrants.create(request) -> CreateClientGrantResponseContent +
client.agents.update(id, request) -> AgentResponseContent
@@ -838,7 +862,7 @@ client.clientGrants().list(
-Create a client grant for a machine-to-machine login flow. To learn more, read [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow). +Update an agent
@@ -853,10 +877,10 @@ Create a client grant for a machine-to-machine login flow. To learn more, read [
```java -client.clientGrants().create( - CreateClientGrantRequestContent +client.agents().update( + "id", + PatchAgentRequestParameters .builder() - .audience("audience") .build() ); ``` @@ -873,7 +897,7 @@ client.clientGrants().create(
-**clientId:** `Optional` — ID of the client. +**id:** `String` — The agent ID
@@ -881,7 +905,7 @@ client.clientGrants().create(
-**audience:** `String` — The audience (API identifier) of this client grant +**name:** `Optional` — The agent name. Cannot contain <, >, or null bytes.
@@ -889,56 +913,48 @@ client.clientGrants().create(
-**defaultFor:** `Optional` +**metadata:** `Optional>` — Arbitrary key-value metadata for the agent. Pass null to clear all metadata.
+
+
-
-
-**organizationUsage:** `Optional` -
+
+## Branding +
client.branding.get() -> GetBrandingResponseContent
-**allowAnyOrganization:** `Optional` — If enabled, any organization can be used with this grant. If disabled (default), the grant must be explicitly assigned to the desired organizations. - -
-
+#### 📝 Description
-**scope:** `Optional>` — Scopes allowed for this client grant. - -
-
-
-**subjectType:** `Optional` - +Retrieve branding settings. +
+
+#### 🔌 Usage +
-**authorizationDetailsTypes:** `Optional>` — Types of authorization_details allowed for this client grant. - -
-
-
-**allowAllScopes:** `Optional` — If enabled, all scopes configured on the resource server are allowed for this grant. - +```java +client.branding().get(); +```
@@ -949,7 +965,7 @@ client.clientGrants().create(
-
client.clientGrants.get(id) -> GetClientGrantResponseContent +
client.branding.update(request) -> UpdateBrandingResponseContent
@@ -961,8 +977,7 @@ client.clientGrants().create(
-Retrieve a single [client grant](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the -scopes associated with the application/API pair. +Update branding settings.
@@ -977,7 +992,11 @@ scopes associated with the application/API pair.
```java -client.clientGrants().get("id"); +client.branding().update( + UpdateBrandingRequestContent + .builder() + .build() +); ```
@@ -992,61 +1011,31 @@ client.clientGrants().get("id");
-**id:** `String` — The ID of the client grant to retrieve. +**colors:** `Optional`
- - - - - - -
- -
client.clientGrants.delete(id) -
-
- -#### 📝 Description - -
-
-Delete the [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) from your machine-to-machine application. -
-
+**faviconUrl:** `Optional` — URL for the favicon. Must use HTTPS. +
-#### 🔌 Usage -
-
-
- -```java -client.clientGrants().delete("id"); -``` -
-
+**logoUrl:** `Optional` — URL for the logo. Must use HTTPS. +
-#### ⚙️ Parameters -
-
-
- -**id:** `String` — ID of the client grant to delete. +**font:** `Optional`
@@ -1058,7 +1047,8 @@ client.clientGrants().delete("id");
-
client.clientGrants.update(id, request) -> UpdateClientGrantResponseContent +## ClientGrants +
client.clientGrants.list() -> SyncPagingIterable&lt;ClientGrantResponseContent&gt;
@@ -1070,7 +1060,7 @@ client.clientGrants().delete("id");
-Update a client grant. +Retrieve a list of [client grants](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the scopes associated with the application/API pair.
@@ -1085,10 +1075,17 @@ Update a client grant.
```java -client.clientGrants().update( - "id", - UpdateClientGrantRequestContent +client.clientGrants().list( + ListClientGrantsRequestParameters .builder() + .includeTotals(true) + .from("from") + .take(1) + .audience("audience") + .clientId("client_id") + .allowAnyOrganization(true) + .subjectType(ClientGrantSubjectTypeEnum.CLIENT) + .defaultFor(ClientGrantDefaultForEnum.THIRD_PARTY_CLIENTS) .build() ); ``` @@ -1105,7 +1102,7 @@ client.clientGrants().update(
-**id:** `String` — ID of the client grant to update. +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
@@ -1113,7 +1110,7 @@ client.clientGrants().update(
-**scope:** `Optional>` — Scopes allowed for this client grant. +**from:** `Optional` — Optional Id from which to start selection.
@@ -1121,7 +1118,7 @@ client.clientGrants().update(
-**organizationUsage:** `Optional` +**take:** `Optional` — Number of results per page. Defaults to 50.
@@ -1129,7 +1126,7 @@ client.clientGrants().update(
-**allowAnyOrganization:** `Optional` — Controls allowing any organization to be used with this grant +**audience:** `Optional` — Optional filter on audience.
@@ -1137,7 +1134,7 @@ client.clientGrants().update(
-**authorizationDetailsTypes:** `Optional>` — Types of authorization_details allowed for this client grant. +**clientId:** `Optional` — Optional filter on client_id.
@@ -1145,7 +1142,23 @@ client.clientGrants().update(
-**allowAllScopes:** `Optional` — If enabled, all scopes configured on the resource server are allowed for this grant. +**allowAnyOrganization:** `Optional` — Optional filter on allow_any_organization. + +
+
+ +
+
+ +**subjectType:** `Optional` — The type of application access the client grant allows. + +
+
+ +
+
+ +**defaultFor:** `Optional` — Applies this client grant as the default for all clients in the specified group. The only accepted value is `third_party_clients`, which applies the grant to all third-party clients. Per-client grants for the same audience take precedence. Mutually exclusive with `client_id`.
@@ -1157,8 +1170,7 @@ client.clientGrants().update(
-## Clients -
client.clients.list() -> SyncPagingIterable&lt;Client&gt; +
client.clientGrants.create(request) -> CreateClientGrantResponseContent
@@ -1170,35 +1182,11 @@ client.clientGrants().update(
-Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified. -For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on). - -- The following can be retrieved with any scope: - `client_id`, `app_type`, `name`, and `description`. -- The following properties can only be retrieved with the `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`. -- The following properties can only be retrieved with the - `read:client_keys` or `read:client_credentials` scope: - `encryption_key`, `encryption_key.pub`, `encryption_key.cert`, - `client_secret`, `client_authentication_methods` and `signing_key`. -
-
-
-
+Create a client grant for a machine-to-machine login flow. To learn more, read [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow). + + + + #### 🔌 Usage @@ -1209,19 +1197,10 @@ For more information, read [Applications in Auth0](https://www.auth0.com/docs/ge
```java -client.clients().list( - ListClientsRequestParameters +client.clientGrants().create( + CreateClientGrantRequestContent .builder() - .fields("fields") - .includeFields(true) - .page(1) - .perPage(1) - .includeTotals(true) - .isGlobal(true) - .isFirstParty(true) - .appType("app_type") - .externalClientId("external_client_id") - .q("q") + .audience("audience") .build() ); ``` @@ -1238,15 +1217,7 @@ client.clients().list(
-**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. - -
-
- -
-
- -**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). +**clientId:** `Optional` — ID of the client.
@@ -1254,7 +1225,7 @@ client.clients().list(
-**page:** `Optional` — Page index of the results to return. First page is 0. +**audience:** `String` — The audience (API identifier) of this client grant
@@ -1262,7 +1233,7 @@ client.clients().list(
-**perPage:** `Optional` — Number of results per page. Default value is 50, maximum value is 100 +**defaultFor:** `Optional`
@@ -1270,7 +1241,7 @@ client.clients().list(
-**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). +**organizationUsage:** `Optional`
@@ -1278,7 +1249,7 @@ client.clients().list(
-**isGlobal:** `Optional` — Optional filter on the global client parameter. +**allowAnyOrganization:** `Optional` — If enabled, any organization can be used with this grant. If disabled (default), the grant must be explicitly assigned to the desired organizations.
@@ -1286,7 +1257,7 @@ client.clients().list(
-**isFirstParty:** `Optional` — Optional filter on whether or not a client is a first-party client. +**scope:** `Optional>` — Scopes allowed for this client grant.
@@ -1294,7 +1265,7 @@ client.clients().list(
-**appType:** `Optional` — Optional filter by a comma-separated list of application types. +**subjectType:** `Optional`
@@ -1302,7 +1273,7 @@ client.clients().list(
-**externalClientId:** `Optional` — Optional filter by the Client ID Metadata Document URI for CIMD-registered clients. +**authorizationDetailsTypes:** `Optional>` — Types of authorization_details allowed for this client grant.
@@ -1310,7 +1281,7 @@ client.clients().list(
-**q:** `Optional` — Advanced Query in Lucene syntax.
Permitted Queries:
  • client_grant.organization_id:{organization_id}
  • client_grant.allow_any_organization:true
Additional Restrictions:
  • Cannot be used in combination with other filters
  • Requires use of the from and take paging parameters (checkpoint paginatinon)
  • Reduced rate limits apply. See Rate Limit Configurations
Note: Recent updates may not be immediately reflected in query results +**allowAllScopes:** `Optional` — If enabled, all scopes configured on the resource server are allowed for this grant.
@@ -1322,7 +1293,7 @@ client.clients().list(
-
client.clients.create(request) -> CreateClientResponseContent +
client.clientGrants.get(id) -> GetClientGrantResponseContent
@@ -1334,20 +1305,8 @@ client.clients().list(
-Create a new client (application or SSO integration). For more information, read [Create Applications](https://www.auth0.com/docs/get-started/auth0-overview/create-applications) -[API Endpoints for Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on/api-endpoints-for-single-sign-on). - -Notes: -- We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret. -- The `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). -- When using `client_authentication_methods` to configure the client with Private Key JWT authentication method, specify fully defined credentials. -These credentials will be automatically enabled for Private Key JWT authentication on the client. -- To configure `client_authentication_methods`, the `create:client_credentials` scope is required. -- To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256. - -SSO Integrations created via this endpoint will accept login requests and share user profile information. +Retrieve a single [client grant](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the +scopes associated with the application/API pair.
@@ -1362,12 +1321,7 @@ SSO Integrations created via this endpoint will accept login requests and share
```java -client.clients().create( - CreateClientRequestContent - .builder() - .name("name") - .build() -); +client.clientGrants().get("id"); ```
@@ -1382,199 +1336,120 @@ client.clients().create(
-**name:** `String` — Name of this client (min length: 1 character, does not allow `<` or `>`). +**id:** `String` — The ID of the client grant to retrieve.
- -
-
- -**description:** `Optional` — Free text description of this client (max length: 140 characters). -
-
-
-**logoUri:** `Optional` — URL of the logo to display for this client. Recommended size is 150x150 pixels. -
+
+
client.clientGrants.delete(id)
-**callbacks:** `Optional>` — Comma-separated list of URLs whitelisted for Auth0 to use as a callback to the client after authentication. - -
-
+#### 📝 Description
-**oidcLogout:** `Optional` - -
-
-
-**oidcBackchannelLogout:** `Optional` — Configuration for OIDC backchannel logout (deprecated, in favor of oidc_logout) - +Delete the [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) from your machine-to-machine application.
- -
-
- -**sessionTransfer:** `Optional` -
-
-
- -**allowedOrigins:** `Optional>` — Comma-separated list of URLs allowed to make requests from JavaScript to Auth0 API (typically used with CORS). By default, all your callback URLs will be allowed. This field allows you to enter other origins if necessary. You can also use wildcards at the subdomain level (e.g., https://*.contoso.com). Query strings and hash information are not taken into account when validating these URLs. - -
-
+#### 🔌 Usage
-**webOrigins:** `Optional>` — Comma-separated list of allowed origins for use with Cross-Origin Authentication, Device Flow, and web message response mode. - -
-
-
-**clientAliases:** `Optional>` — List of audiences/realms for SAML protocol. Used by the wsfed addon. - +```java +client.clientGrants().delete("id"); +```
- -
-
- -**allowedClients:** `Optional>` — List of allow clients and API ids that are allowed to make delegation requests. Empty means all all your clients are allowed. -
-
-
- -**allowedLogoutUrls:** `Optional>` — Comma-separated list of URLs that are valid to redirect to after logout from Auth0. Wildcards are allowed for subdomains. - -
-
+#### ⚙️ Parameters
-**grantTypes:** `Optional>` — List of grant types supported for this application. Can include `authorization_code`, `implicit`, `refresh_token`, `client_credentials`, `password`, `http://auth0.com/oauth/grant-type/password-realm`, `http://auth0.com/oauth/grant-type/mfa-oob`, `http://auth0.com/oauth/grant-type/mfa-otp`, `http://auth0.com/oauth/grant-type/mfa-recovery-code`, `urn:openid:params:grant-type:ciba`, `urn:ietf:params:oauth:grant-type:device_code`, and `urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token`. - -
-
-
-**tokenEndpointAuthMethod:** `Optional` +**id:** `String` — ID of the client grant to delete.
- -
-
- -**isTokenEndpointIpHeaderTrusted:** `Optional` — If true, trust that the IP specified in the `auth0-forwarded-for` header is the end-user's IP for brute-force-protection on token endpoint. -
-
-
-**appType:** `Optional` -
+
+
client.clientGrants.update(id, request) -> UpdateClientGrantResponseContent
-**isFirstParty:** `Optional` — Whether this client a first party client or not - -
-
+#### 📝 Description
-**oidcConformant:** `Optional` — Whether this client conforms to strict OIDC specifications (true) or uses legacy features (false). - -
-
-
-**jwtConfiguration:** `Optional` - +Update a client grant.
- -
-
- -**encryptionKey:** `Optional` -
+#### 🔌 Usage +
-**sso:** `Optional` — Applies only to SSO clients and determines whether Auth0 will handle Single Sign On (true) or whether the Identity Provider will (false). - -
-
-
-**crossOriginAuthentication:** `Optional` — Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false). - +```java +client.clientGrants().update( + "id", + UpdateClientGrantRequestContent + .builder() + .build() +); +```
- -
-
- -**crossOriginLoc:** `Optional` — URL of the location in your site where the cross origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page. -
+#### ⚙️ Parameters +
-**ssoDisabled:** `Optional` — true to disable Single Sign On, false otherwise (default: false) - -
-
-
-**customLoginPageOn:** `Optional` — true if the custom login page is to be used, false otherwise. Defaults to true +**id:** `String` — ID of the client grant to update.
@@ -1582,7 +1457,7 @@ client.clients().create(
-**customLoginPage:** `Optional` — The content (HTML, CSS, JS) of the custom login page. +**scope:** `Optional>` — Scopes allowed for this client grant.
@@ -1590,7 +1465,7 @@ client.clients().create(
-**customLoginPagePreview:** `Optional` — The content (HTML, CSS, JS) of the custom login page. (Used on Previews) +**organizationUsage:** `Optional`
@@ -1598,7 +1473,7 @@ client.clients().create(
-**formTemplate:** `Optional` — HTML form template to be used for WS-Federation. +**allowAnyOrganization:** `Optional` — Controls allowing any organization to be used with this grant
@@ -1606,7 +1481,7 @@ client.clients().create(
-**addons:** `Optional` +**authorizationDetailsTypes:** `Optional>` — Types of authorization_details allowed for this client grant.
@@ -1614,63 +1489,100 @@ client.clients().create(
-**clientMetadata:** `Optional>` +**allowAllScopes:** `Optional` — If enabled, all scopes configured on the resource server are allowed for this grant.
- -
-
- -**mobile:** `Optional` -
-
-
-**initiateLoginUri:** `Optional` — Initiate login uri, must be https -
+
+## Clients +
client.clients.list() -> SyncPagingIterable&lt;Client&gt;
-**nativeSocialLogin:** `Optional` - -
-
+#### 📝 Description
-**fedcmLogin:** `Optional` - -
-
-
-**refreshToken:** `Optional` - +Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified. +For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on). + +- The following can be retrieved with any scope: + `client_id`, `app_type`, `name`, and `description`. +- The following properties can only be retrieved with the `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`. +- The following properties can only be retrieved with the + `read:client_keys` or `read:client_credentials` scope: + `encryption_key`, `encryption_key.pub`, `encryption_key.cert`, + `client_secret`, `client_authentication_methods` and `signing_key`. +
+
+#### 🔌 Usage +
-**defaultOrganization:** `Optional` - +
+
+ +```java +client.clients().list( + ListClientsRequestParameters + .builder() + .fields("fields") + .includeFields(true) + .page(1) + .perPage(1) + .includeTotals(true) + .isGlobal(true) + .isFirstParty(true) + .appType("app_type") + .externalClientId("external_client_id") + .q("q") + .build() +); +``` +
+
+#### ⚙️ Parameters +
-**organizationUsage:** `Optional` +
+
+ +**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.
@@ -1678,7 +1590,7 @@ client.clients().create(
-**organizationRequireBehavior:** `Optional` +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false).
@@ -1686,7 +1598,7 @@ client.clients().create(
-**organizationDiscoveryMethods:** `Optional>` — Defines the available methods for organization discovery during the `pre_login_prompt`. Users can discover their organization either by `email`, `organization_name` or both. +**page:** `Optional` — Page index of the results to return. First page is 0.
@@ -1694,7 +1606,7 @@ client.clients().create(
-**clientAuthenticationMethods:** `Optional` +**perPage:** `Optional` — Number of results per page. Default value is 50, maximum value is 100
@@ -1702,7 +1614,7 @@ client.clients().create(
-**requirePushedAuthorizationRequests:** `Optional` — Makes the use of Pushed Authorization Requests mandatory for this client +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
@@ -1710,7 +1622,7 @@ client.clients().create(
-**requireProofOfPossession:** `Optional` — Makes the use of Proof-of-Possession mandatory for this client +**isGlobal:** `Optional` — Optional filter on the global client parameter.
@@ -1718,7 +1630,7 @@ client.clients().create(
-**signedRequestObject:** `Optional` +**isFirstParty:** `Optional` — Optional filter on whether or not a client is a first-party client.
@@ -1726,7 +1638,7 @@ client.clients().create(
-**tokenVaultPrivilegedAccess:** `Optional` +**appType:** `Optional` — Optional filter by a comma-separated list of application types.
@@ -1734,7 +1646,7 @@ client.clients().create(
-**complianceLevel:** `Optional` +**externalClientId:** `Optional` — Optional filter by the Client ID Metadata Document URI for CIMD-registered clients.
@@ -1742,35 +1654,79 @@ client.clients().create(
-**skipNonVerifiableCallbackUriConfirmationPrompt:** `Optional` - -Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as `myapp://`, or `localhost`). -If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps. -See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information. +**q:** `Optional` — Advanced Query in Lucene syntax.
Permitted Queries:
  • client_grant.organization_id:{organization_id}
  • client_grant.allow_any_organization:true
Additional Restrictions:
  • Cannot be used in combination with other filters
  • Requires use of the from and take paging parameters (checkpoint paginatinon)
  • Reduced rate limits apply. See Rate Limit Configurations
Note: Recent updates may not be immediately reflected in query results
+
+
+ + + + +
+
client.clients.create(request) -> CreateClientResponseContent
-**tokenExchange:** `Optional` - +#### 📝 Description + +
+
+ +
+
+ +Create a new client (application or SSO integration). For more information, read [Create Applications](https://www.auth0.com/docs/get-started/auth0-overview/create-applications) +[API Endpoints for Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on/api-endpoints-for-single-sign-on). + +Notes: +- We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret. +- The `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). +- When using `client_authentication_methods` to configure the client with Private Key JWT authentication method, specify fully defined credentials. +These credentials will be automatically enabled for Private Key JWT authentication on the client. +- To configure `client_authentication_methods`, the `create:client_credentials` scope is required. +- To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256. + +SSO Integrations created via this endpoint will accept login requests and share user profile information. +
+
+#### 🔌 Usage +
-**parRequestExpiry:** `Optional` — Specifies how long, in seconds, a Pushed Authorization Request URI remains valid - +
+
+ +```java +client.clients().create( + CreateClientRequestContent + .builder() + .name("name") + .build() +); +``` +
+
+#### ⚙️ Parameters +
-**tokenQuota:** `Optional` +
+
+ +**name:** `String` — Name of this client (min length: 1 character, does not allow `<` or `>`).
@@ -1778,7 +1734,7 @@ See https://auth0.com/docs/secure/security-guidance/measures-against-app-imperso
-**resourceServerIdentifier:** `Optional` — The identifier of the resource server that this client is linked to. +**description:** `Optional` — Free text description of this client (max length: 140 characters).
@@ -1786,7 +1742,7 @@ See https://auth0.com/docs/secure/security-guidance/measures-against-app-imperso
-**identityAssertionAuthorizationGrant:** `Optional` +**logoUri:** `Optional` — URL of the logo to display for this client. Recommended size is 150x150 pixels.
@@ -1794,7 +1750,7 @@ See https://auth0.com/docs/secure/security-guidance/measures-against-app-imperso
-**thirdPartySecurityMode:** `Optional` +**callbacks:** `Optional>` — Comma-separated list of URLs whitelisted for Auth0 to use as a callback to the client after authentication.
@@ -1802,7 +1758,7 @@ See https://auth0.com/docs/secure/security-guidance/measures-against-app-imperso
-**redirectionPolicy:** `Optional` +**oidcLogout:** `Optional`
@@ -1810,7 +1766,7 @@ See https://auth0.com/docs/secure/security-guidance/measures-against-app-imperso
-**expressConfiguration:** `Optional` +**oidcBackchannelLogout:** `Optional` — Configuration for OIDC backchannel logout (deprecated, in favor of oidc_logout)
@@ -1818,7 +1774,7 @@ See https://auth0.com/docs/secure/security-guidance/measures-against-app-imperso
-**myOrganizationConfiguration:** `Optional` +**sessionTransfer:** `Optional`
@@ -1826,223 +1782,167 @@ See https://auth0.com/docs/secure/security-guidance/measures-against-app-imperso
-**asyncApprovalNotificationChannels:** `Optional>` +**allowedOrigins:** `Optional>` — Comma-separated list of URLs allowed to make requests from JavaScript to Auth0 API (typically used with CORS). By default, all your callback URLs will be allowed. This field allows you to enter other origins if necessary. You can also use wildcards at the subdomain level (e.g., https://*.contoso.com). Query strings and hash information are not taken into account when validating these URLs.
-
-
+
+
+**webOrigins:** `Optional>` — Comma-separated list of allowed origins for use with Cross-Origin Authentication, Device Flow, and web message response mode. +
-
-
client.clients.previewCimdMetadata(request) -> PreviewCimdMetadataResponseContent
-#### 📝 Description +**clientAliases:** `Optional>` — List of audiences/realms for SAML protocol. Used by the wsfed addon. + +
+
+**allowedClients:** `Optional>` — List of allow clients and API ids that are allowed to make delegation requests. Empty means all all your clients are allowed. + +
+
+
- - Fetches and validates a Client ID Metadata Document without creating a client. - Returns the raw metadata and how it would be mapped to Auth0 client fields. - This endpoint is useful for testing metadata URIs before creating CIMD clients. +**allowedLogoutUrls:** `Optional>` — Comma-separated list of URLs that are valid to redirect to after logout from Auth0. Wildcards are allowed for subdomains.
- - - -#### 🔌 Usage
+**grantTypes:** `Optional>` — List of grant types supported for this application. Can include `authorization_code`, `implicit`, `refresh_token`, `client_credentials`, `password`, `http://auth0.com/oauth/grant-type/password-realm`, `http://auth0.com/oauth/grant-type/mfa-oob`, `http://auth0.com/oauth/grant-type/mfa-otp`, `http://auth0.com/oauth/grant-type/mfa-recovery-code`, `urn:openid:params:grant-type:ciba`, `urn:ietf:params:oauth:grant-type:device_code`, and `urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token`. + +
+
+
-```java -client.clients().previewCimdMetadata( - PreviewCimdMetadataRequestContent - .builder() - .externalClientId("external_client_id") - .build() -); -``` -
-
+**tokenEndpointAuthMethod:** `Optional` + -#### ⚙️ Parameters -
+**isTokenEndpointIpHeaderTrusted:** `Optional` — If true, trust that the IP specified in the `auth0-forwarded-for` header is the end-user's IP for brute-force-protection on token endpoint. + +
+
+
-**externalClientId:** `String` — URL to the Client ID Metadata Document +**appType:** `Optional`
- - +
+
+**isFirstParty:** `Optional` — Whether this client a first party client or not +
-
-
client.clients.registerCimdClient(request) -> RegisterCimdClientResponseContent
-#### 📝 Description +**oidcConformant:** `Optional` — Whether this client conforms to strict OIDC specifications (true) or uses legacy features (false). + +
+
+**jwtConfiguration:** `Optional` + +
+
+
-Idempotent registration for Client ID Metadata Document (CIMD) clients. -Uses external_client_id as the unique identifier for upsert operations. +**encryptionKey:** `Optional` + +
+
-**Create:** Returns 201 when a new client is created (requires `create:clients` scope). -**Update:** Returns 200 when an existing client is updated (requires `update:clients` scope). +
+
-This endpoint automatically: -- Fetches and validates the metadata document -- Maps CIMD fields to Auth0 client configuration -- Creates/rotates credentials from the JWKS -- Enforces CIMD security policies (HTTPS-only, no shared secrets) +**sso:** `Optional` — Applies only to SSO clients and determines whether Auth0 will handle Single Sign On (true) or whether the Identity Provider will (false). +
+ +
+
+ +**crossOriginAuthentication:** `Optional` — Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false). +
-#### 🔌 Usage -
+**crossOriginLoc:** `Optional` — URL of the location in your site where the cross origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page. + +
+
+
-```java -client.clients().registerCimdClient( - RegisterCimdClientRequestContent - .builder() - .externalClientId("external_client_id") - .build() -); -``` -
-
+**ssoDisabled:** `Optional` — true to disable Single Sign On, false otherwise (default: false) + -#### ⚙️ Parameters - -
-
-
-**externalClientId:** `String` — URL to the Client ID Metadata Document. Acts as the unique identifier for upsert operations. +**customLoginPageOn:** `Optional` — true if the custom login page is to be used, false otherwise. Defaults to true
-
-
- - - - -
- -
client.clients.get(id) -> GetClientResponseContent -
-
- -#### 📝 Description - -
-
-Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list of fields to include or exclude may also be specified. -For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on). - -- The following properties can be retrieved with any of the scopes: - `client_id`, `app_type`, `name`, and `description`. -- The following properties can only be retrieved with the `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`. -- The following properties can only be retrieved with the `read:client_keys` or `read:client_credentials` scopes: - `encryption_key`, `encryption_key.pub`, `encryption_key.cert`, - `client_secret`, `client_authentication_methods` and `signing_key`. -
-
+**customLoginPage:** `Optional` — The content (HTML, CSS, JS) of the custom login page. +
-#### 🔌 Usage -
-
-
- -```java -client.clients().get( - "id", - GetClientRequestParameters - .builder() - .fields("fields") - .includeFields(true) - .build() -); -``` -
-
+**customLoginPagePreview:** `Optional` — The content (HTML, CSS, JS) of the custom login page. (Used on Previews) +
-#### ⚙️ Parameters - -
-
-
-**id:** `String` — ID of the client to retrieve. +**formTemplate:** `Optional` — HTML form template to be used for WS-Federation.
@@ -2050,7 +1950,7 @@ client.clients().get(
-**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. +**addons:** `Optional`
@@ -2058,128 +1958,55 @@ client.clients().get(
-**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). +**clientMetadata:** `Optional>`
-
-
- - -
-
-
- -
client.clients.delete(id) -
-
- -#### 📝 Description - -
-
-Delete a client and related configuration (rules, connections, etc). -
-
+**mobile:** `Optional` +
-#### 🔌 Usage - -
-
-
-```java -client.clients().delete("id"); -``` -
-
+**initiateLoginUri:** `Optional` — Initiate login uri, must be https +
-#### ⚙️ Parameters - -
-
-
-**id:** `String` — ID of the client to delete. +**nativeSocialLogin:** `Optional`
-
-
- - -
-
-
- -
client.clients.update(id, request) -> UpdateClientResponseContent -
-
- -#### 📝 Description - -
-
-Updates a client's settings. For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on). - -Notes: -- The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope. -- The `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). -- When using `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. -- To configure `client_authentication_methods`, the `update:client_credentials` scope is required. -- To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256. -- To change a client's `is_first_party` property to `false`, the `organization_usage` and `organization_require_behavior` properties must be unset. -
-
+**fedcmLogin:** `Optional` +
-#### 🔌 Usage - -
-
-
-```java -client.clients().update( - "id", - UpdateClientRequestContent - .builder() - .build() -); -``` -
-
+**refreshToken:** `Optional` +
-#### ⚙️ Parameters -
-
-
- -**id:** `String` — ID of the client to update. +**defaultOrganization:** `Optional`
@@ -2187,7 +2014,7 @@ client.clients().update(
-**name:** `Optional` — The name of the client. Must contain at least one character. Does not allow '<' or '>'. +**organizationUsage:** `Optional`
@@ -2195,7 +2022,7 @@ client.clients().update(
-**description:** `Optional` — Free text description of the purpose of the Client. (Max character length: 140) +**organizationRequireBehavior:** `Optional`
@@ -2203,7 +2030,7 @@ client.clients().update(
-**clientSecret:** `Optional` — The secret used to sign tokens for the client +**organizationDiscoveryMethods:** `Optional>` — Defines the available methods for organization discovery during the `pre_login_prompt`. Users can discover their organization either by `email`, `organization_name` or both.
@@ -2211,7 +2038,7 @@ client.clients().update(
-**logoUri:** `Optional` — The URL of the client logo (recommended size: 150x150) +**clientAuthenticationMethods:** `Optional`
@@ -2219,7 +2046,7 @@ client.clients().update(
-**callbacks:** `Optional>` — A set of URLs that are valid to call back from Auth0 when authenticating users +**requirePushedAuthorizationRequests:** `Optional` — Makes the use of Pushed Authorization Requests mandatory for this client
@@ -2227,7 +2054,7 @@ client.clients().update(
-**oidcLogout:** `Optional` +**requireProofOfPossession:** `Optional` — Makes the use of Proof-of-Possession mandatory for this client
@@ -2235,7 +2062,7 @@ client.clients().update(
-**oidcBackchannelLogout:** `Optional` — Configuration for OIDC backchannel logout (deprecated, in favor of oidc_logout) +**signedRequestObject:** `Optional`
@@ -2243,7 +2070,7 @@ client.clients().update(
-**sessionTransfer:** `Optional` +**tokenVaultPrivilegedAccess:** `Optional`
@@ -2251,7 +2078,7 @@ client.clients().update(
-**allowedOrigins:** `Optional>` — A set of URLs that represents valid origins for CORS +**complianceLevel:** `Optional`
@@ -2259,7 +2086,11 @@ client.clients().update(
-**webOrigins:** `Optional>` — A set of URLs that represents valid web origins for use with web message response mode +**skipNonVerifiableCallbackUriConfirmationPrompt:** `Optional` + +Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as `myapp://`, or `localhost`). +If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps. +See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information.
@@ -2267,7 +2098,7 @@ client.clients().update(
-**grantTypes:** `Optional>` — A set of grant types that the client is authorized to use. Can include `authorization_code`, `implicit`, `refresh_token`, `client_credentials`, `password`, `http://auth0.com/oauth/grant-type/password-realm`, `http://auth0.com/oauth/grant-type/mfa-oob`, `http://auth0.com/oauth/grant-type/mfa-otp`, `http://auth0.com/oauth/grant-type/mfa-recovery-code`, `urn:openid:params:grant-type:ciba`, `urn:ietf:params:oauth:grant-type:device_code`, and `urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token`. +**tokenExchange:** `Optional`
@@ -2275,7 +2106,7 @@ client.clients().update(
-**clientAliases:** `Optional>` — List of audiences for SAML protocol +**parRequestExpiry:** `Optional` — Specifies how long, in seconds, a Pushed Authorization Request URI remains valid
@@ -2283,7 +2114,7 @@ client.clients().update(
-**allowedClients:** `Optional>` — Ids of clients that will be allowed to perform delegation requests. Clients that will be allowed to make delegation request. By default, all your clients will be allowed. This field allows you to specify specific clients +**tokenQuota:** `Optional`
@@ -2291,7 +2122,7 @@ client.clients().update(
-**allowedLogoutUrls:** `Optional>` — URLs that are valid to redirect to after logout from Auth0 +**resourceServerIdentifier:** `Optional` — The identifier of the resource server that this client is linked to.
@@ -2299,7 +2130,7 @@ client.clients().update(
-**jwtConfiguration:** `Optional` — An object that holds settings related to how JWTs are created +**identityAssertionAuthorizationGrant:** `Optional`
@@ -2307,7 +2138,7 @@ client.clients().update(
-**encryptionKey:** `Optional` — The client's encryption key +**thirdPartySecurityMode:** `Optional`
@@ -2315,7 +2146,7 @@ client.clients().update(
-**sso:** `Optional` — true to use Auth0 instead of the IdP to do Single Sign On, false otherwise (default: false) +**redirectionPolicy:** `Optional`
@@ -2323,7 +2154,7 @@ client.clients().update(
-**crossOriginAuthentication:** `Optional` — true if this client can be used to make cross-origin authentication requests, false otherwise if cross origin is disabled +**expressConfiguration:** `Optional`
@@ -2331,7 +2162,7 @@ client.clients().update(
-**crossOriginLoc:** `Optional` — URL for the location in your site where the cross origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page. +**myOrganizationConfiguration:** `Optional`
@@ -2339,283 +2170,223 @@ client.clients().update(
-**ssoDisabled:** `Optional` — true to disable Single Sign On, false otherwise (default: false) +**asyncApprovalNotificationChannels:** `Optional>`
+
+
-
-
-**customLoginPageOn:** `Optional` — true if the custom login page is to be used, false otherwise. -
+
+
client.clients.previewCimdMetadata(request) -> PreviewCimdMetadataResponseContent
-**tokenEndpointAuthMethod:** `Optional` - -
-
+#### 📝 Description
-**isTokenEndpointIpHeaderTrusted:** `Optional` — If true, trust that the IP specified in the `auth0-forwarded-for` header is the end-user's IP for brute-force-protection on token endpoint. - -
-
-
-**appType:** `Optional` + + Fetches and validates a Client ID Metadata Document without creating a client. + Returns the raw metadata and how it would be mapped to Auth0 client fields. + This endpoint is useful for testing metadata URIs before creating CIMD clients.
+ + + +#### 🔌 Usage
-**isFirstParty:** `Optional` — Whether this client a first party client or not - -
-
-
-**oidcConformant:** `Optional` — Whether this client will conform to strict OIDC specifications - +```java +client.clients().previewCimdMetadata( + PreviewCimdMetadataRequestContent + .builder() + .externalClientId("external_client_id") + .build() +); +```
- -
-
- -**customLoginPage:** `Optional` — The content (HTML, CSS, JS) of the custom login page -
-
-
- -**customLoginPagePreview:** `Optional` - -
-
+#### ⚙️ Parameters
-**tokenQuota:** `Optional` - -
-
-
-**identityAssertionAuthorizationGrant:** `Optional` +**externalClientId:** `String` — URL to the Client ID Metadata Document
- -
-
- -**formTemplate:** `Optional` — Form template for WS-Federation protocol -
-
-
-**addons:** `Optional` -
+
+
client.clients.registerCimdClient(request) -> RegisterCimdClientResponseContent
-**clientMetadata:** `Optional>` - -
-
+#### 📝 Description
-**mobile:** `Optional` — Configuration related to native mobile apps - -
-
-
-**initiateLoginUri:** `Optional` — Initiate login uri, must be https - -
-
+Idempotent registration for Client ID Metadata Document (CIMD) clients. +Uses external_client_id as the unique identifier for upsert operations. -
-
+**Create:** Returns 201 when a new client is created (requires `create:clients` scope). +**Update:** Returns 200 when an existing client is updated (requires `update:clients` scope). -**nativeSocialLogin:** `Optional` - +This endpoint automatically: +- Fetches and validates the metadata document +- Maps CIMD fields to Auth0 client configuration +- Creates/rotates credentials from the JWKS +- Enforces CIMD security policies (HTTPS-only, no shared secrets)
- -
-
- -**fedcmLogin:** `Optional` -
-
-
- -**refreshToken:** `Optional` - -
-
+#### 🔌 Usage
-**defaultOrganization:** `Optional` - -
-
-
-**organizationUsage:** `Optional` - +```java +client.clients().registerCimdClient( + RegisterCimdClientRequestContent + .builder() + .externalClientId("external_client_id") + .build() +); +```
- -
-
- -**organizationRequireBehavior:** `Optional` -
-
-
- -**organizationDiscoveryMethods:** `Optional>` — Defines the available methods for organization discovery during the `pre_login_prompt`. Users can discover their organization either by `email`, `organization_name` or both. - -
-
+#### ⚙️ Parameters
-**clientAuthenticationMethods:** `Optional` - -
-
-
-**requirePushedAuthorizationRequests:** `Optional` — Makes the use of Pushed Authorization Requests mandatory for this client +**externalClientId:** `String` — URL to the Client ID Metadata Document. Acts as the unique identifier for upsert operations.
- -
-
- -**requireProofOfPossession:** `Optional` — Makes the use of Proof-of-Possession mandatory for this client -
-
-
-**signedRequestObject:** `Optional` -
+
+
client.clients.get(id) -> GetClientResponseContent
-**tokenVaultPrivilegedAccess:** `Optional` - -
-
+#### 📝 Description
-**complianceLevel:** `Optional` - -
-
-
-**skipNonVerifiableCallbackUriConfirmationPrompt:** `Optional` +Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list of fields to include or exclude may also be specified. +For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on). -Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as `myapp://`, or `localhost`). -If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps. -See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information. - +- The following properties can be retrieved with any of the scopes: + `client_id`, `app_type`, `name`, and `description`. +- The following properties can only be retrieved with the `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`. +- The following properties can only be retrieved with the `read:client_keys` or `read:client_credentials` scopes: + `encryption_key`, `encryption_key.pub`, `encryption_key.cert`, + `client_secret`, `client_authentication_methods` and `signing_key`.
- -
-
- -**tokenExchange:** `Optional` -
+#### 🔌 Usage +
-**parRequestExpiry:** `Optional` — Specifies how long, in seconds, a Pushed Authorization Request URI remains valid - -
-
-
-**expressConfiguration:** `Optional` - +```java +client.clients().get( + "id", + GetClientRequestParameters + .builder() + .fields("fields") + .includeFields(true) + .build() +); +```
+ + + +#### ⚙️ Parameters
-**myOrganizationConfiguration:** `Optional` - -
-
-
-**asyncApprovalNotificationChannels:** `Optional>` +**id:** `String` — ID of the client to retrieve.
@@ -2623,7 +2394,7 @@ See https://auth0.com/docs/secure/security-guidance/measures-against-app-imperso
-**thirdPartySecurityMode:** `Optional` +**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.
@@ -2631,7 +2402,7 @@ See https://auth0.com/docs/secure/security-guidance/measures-against-app-imperso
-**redirectionPolicy:** `Optional` +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false).
@@ -2643,7 +2414,7 @@ See https://auth0.com/docs/secure/security-guidance/measures-against-app-imperso
-
client.clients.rotateSecret(id) -> RotateClientSecretResponseContent +
client.clients.delete(id)
@@ -2655,11 +2426,7 @@ See https://auth0.com/docs/secure/security-guidance/measures-against-app-imperso
-Rotate a client secret. - -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 [Rotate Client Secrets](https://www.auth0.com/docs/get-started/applications/rotate-client-secret). +Delete a client and related configuration (rules, connections, etc).
@@ -2674,7 +2441,7 @@ For more information, read [Rotate Client Secrets](https://www.auth0.com/docs/ge
```java -client.clients().rotateSecret("id"); +client.clients().delete("id"); ```
@@ -2689,7 +2456,7 @@ client.clients().rotateSecret("id");
-**id:** `String` — ID of the client that will rotate secrets. +**id:** `String` — ID of the client to delete.
@@ -2701,8 +2468,7 @@ client.clients().rotateSecret("id");
-## ConnectionProfiles -
client.connectionProfiles.list() -> SyncPagingIterable&lt;ConnectionProfile&gt; +
client.clients.update(id, request) -> UpdateClientResponseContent
@@ -2714,7 +2480,15 @@ client.clients().rotateSecret("id");
-Retrieve a list of Connection Profiles. This endpoint supports Checkpoint pagination. +Updates a client's settings. For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on). + +Notes: +- The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope. +- The `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). +- When using `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. +- To configure `client_authentication_methods`, the `update:client_credentials` scope is required. +- To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256. +- To change a client's `is_first_party` property to `false`, the `organization_usage` and `organization_require_behavior` properties must be unset.
@@ -2729,11 +2503,10 @@ Retrieve a list of Connection Profiles. This endpoint supports Checkpoint pagina
```java -client.connectionProfiles().list( - ListConnectionProfileRequestParameters +client.clients().update( + "id", + UpdateClientRequestContent .builder() - .from("from") - .take(1) .build() ); ``` @@ -2750,7 +2523,7 @@ client.connectionProfiles().list(
-**from:** `Optional` — Optional Id from which to start selection. +**id:** `String` — ID of the client to update.
@@ -2758,66 +2531,71 @@ client.connectionProfiles().list(
-**take:** `Optional` — Number of results per page. Defaults to 5. +**name:** `Optional` — The name of the client. Must contain at least one character. Does not allow '<' or '>'.
-
-
+
+
-
+**description:** `Optional` — Free text description of the purpose of the Client. (Max character length: 140) + +
-
-
client.connectionProfiles.create(request) -> CreateConnectionProfileResponseContent
-#### 📝 Description +**clientSecret:** `Optional` — The secret used to sign tokens for the client + +
+
+**logoUri:** `Optional` — The URL of the client logo (recommended size: 150x150) + +
+
+
-Create a Connection Profile. -
-
+**callbacks:** `Optional>` — A set of URLs that are valid to call back from Auth0 when authenticating users + -#### 🔌 Usage -
+**oidcLogout:** `Optional` + +
+
+
-```java -client.connectionProfiles().create( - CreateConnectionProfileRequestContent - .builder() - .name("name") - .build() -); -``` -
-
+**oidcBackchannelLogout:** `Optional` — Configuration for OIDC backchannel logout (deprecated, in favor of oidc_logout) + -#### ⚙️ Parameters -
+**sessionTransfer:** `Optional` + +
+
+
-**name:** `String` +**allowedOrigins:** `Optional>` — A set of URLs that represents valid origins for CORS
@@ -2825,7 +2603,7 @@ client.connectionProfiles().create(
-**organization:** `Optional` +**webOrigins:** `Optional>` — A set of URLs that represents valid web origins for use with web message response mode
@@ -2833,7 +2611,7 @@ client.connectionProfiles().create(
-**connectionNamePrefixTemplate:** `Optional` +**grantTypes:** `Optional>` — A set of grant types that the client is authorized to use. Can include `authorization_code`, `implicit`, `refresh_token`, `client_credentials`, `password`, `http://auth0.com/oauth/grant-type/password-realm`, `http://auth0.com/oauth/grant-type/mfa-oob`, `http://auth0.com/oauth/grant-type/mfa-otp`, `http://auth0.com/oauth/grant-type/mfa-recovery-code`, `urn:openid:params:grant-type:ciba`, `urn:ietf:params:oauth:grant-type:device_code`, and `urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token`.
@@ -2841,7 +2619,7 @@ client.connectionProfiles().create(
-**enabledFeatures:** `Optional>` +**clientAliases:** `Optional>` — List of audiences for SAML protocol
@@ -2849,7 +2627,7 @@ client.connectionProfiles().create(
-**connectionConfig:** `Optional` +**allowedClients:** `Optional>` — Ids of clients that will be allowed to perform delegation requests. Clients that will be allowed to make delegation request. By default, all your clients will be allowed. This field allows you to specify specific clients
@@ -2857,267 +2635,299 @@ client.connectionProfiles().create(
-**strategyOverrides:** `Optional` +**allowedLogoutUrls:** `Optional>` — URLs that are valid to redirect to after logout from Auth0
- - +
+
+**jwtConfiguration:** `Optional` — An object that holds settings related to how JWTs are created +
-
-
client.connectionProfiles.listTemplates() -> ListConnectionProfileTemplateResponseContent
-#### 📝 Description +**encryptionKey:** `Optional` — The client's encryption key + +
+
+**sso:** `Optional` — true to use Auth0 instead of the IdP to do Single Sign On, false otherwise (default: false) + +
+
+
-Retrieve a list of Connection Profile Templates. -
-
+**crossOriginAuthentication:** `Optional` — true if this client can be used to make cross-origin authentication requests, false otherwise if cross origin is disabled + -#### 🔌 Usage -
+**crossOriginLoc:** `Optional` — URL for the location in your site where the cross origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page. + +
+
+
-```java -client.connectionProfiles().listTemplates(); -``` -
-
+**ssoDisabled:** `Optional` — true to disable Single Sign On, false otherwise (default: false) + +
+
+**customLoginPageOn:** `Optional` — true if the custom login page is to be used, false otherwise. +
-
-
client.connectionProfiles.getTemplate(id) -> GetConnectionProfileTemplateResponseContent
-#### 📝 Description +**tokenEndpointAuthMethod:** `Optional` + +
+
+**isTokenEndpointIpHeaderTrusted:** `Optional` — If true, trust that the IP specified in the `auth0-forwarded-for` header is the end-user's IP for brute-force-protection on token endpoint. + +
+
+
-Retrieve a Connection Profile Template. -
-
+**appType:** `Optional` + -#### 🔌 Usage -
+**isFirstParty:** `Optional` — Whether this client a first party client or not + +
+
+
-```java -client.connectionProfiles().getTemplate("id"); -``` -
-
+**oidcConformant:** `Optional` — Whether this client will conform to strict OIDC specifications + -#### ⚙️ Parameters -
+**customLoginPage:** `Optional` — The content (HTML, CSS, JS) of the custom login page + +
+
+
-**id:** `String` — ID of the connection-profile-template to retrieve. +**customLoginPagePreview:** `Optional`
- - +
+
+**tokenQuota:** `Optional` +
-
-
client.connectionProfiles.get(id) -> GetConnectionProfileResponseContent
-#### 📝 Description +**identityAssertionAuthorizationGrant:** `Optional` + +
+
+**formTemplate:** `Optional` — Form template for WS-Federation protocol + +
+
+
-Retrieve details about a single Connection Profile specified by ID. -
-
+**addons:** `Optional` + -#### 🔌 Usage -
+**clientMetadata:** `Optional>` + +
+
+
-```java -client.connectionProfiles().get("id"); -``` -
-
+**mobile:** `Optional` — Configuration related to native mobile apps + -#### ⚙️ Parameters -
+**initiateLoginUri:** `Optional` — Initiate login uri, must be https + +
+
+
-**id:** `String` — ID of the connection-profile to retrieve. +**nativeSocialLogin:** `Optional`
- - +
+
+**fedcmLogin:** `Optional` +
-
-
client.connectionProfiles.delete(id)
-#### 📝 Description +**refreshToken:** `Optional` + +
+
+**defaultOrganization:** `Optional` + +
+
+
-Delete a single Connection Profile specified by ID. -
-
+**organizationUsage:** `Optional` + -#### 🔌 Usage -
+**organizationRequireBehavior:** `Optional` + +
+
+
-```java -client.connectionProfiles().delete("id"); -``` -
-
+**organizationDiscoveryMethods:** `Optional>` — Defines the available methods for organization discovery during the `pre_login_prompt`. Users can discover their organization either by `email`, `organization_name` or both. + -#### ⚙️ Parameters -
+**clientAuthenticationMethods:** `Optional` + +
+
+
-**id:** `String` — ID of the connection-profile to delete. +**requirePushedAuthorizationRequests:** `Optional` — Makes the use of Pushed Authorization Requests mandatory for this client
- - +
+
+**requireProofOfPossession:** `Optional` — Makes the use of Proof-of-Possession mandatory for this client +
-
-
client.connectionProfiles.update(id, request) -> UpdateConnectionProfileResponseContent
-#### 📝 Description +**signedRequestObject:** `Optional` + +
+
+**tokenVaultPrivilegedAccess:** `Optional` + +
+
+
-Update the details of a specific Connection Profile. -
-
+**complianceLevel:** `Optional` + -#### 🔌 Usage -
-
-
+**skipNonVerifiableCallbackUriConfirmationPrompt:** `Optional` -```java -client.connectionProfiles().update( - "id", - UpdateConnectionProfileRequestContent - .builder() - .build() -); -``` -
-
+Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as `myapp://`, or `localhost`). +If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps. +See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information. +
-#### ⚙️ Parameters - -
-
-
-**id:** `String` — ID of the connection profile to update. +**tokenExchange:** `Optional`
@@ -3125,7 +2935,7 @@ client.connectionProfiles().update(
-**name:** `Optional` +**parRequestExpiry:** `Optional` — Specifies how long, in seconds, a Pushed Authorization Request URI remains valid
@@ -3133,7 +2943,7 @@ client.connectionProfiles().update(
-**organization:** `Optional` +**expressConfiguration:** `Optional`
@@ -3141,7 +2951,7 @@ client.connectionProfiles().update(
-**connectionNamePrefixTemplate:** `Optional` +**myOrganizationConfiguration:** `Optional`
@@ -3149,7 +2959,7 @@ client.connectionProfiles().update(
-**enabledFeatures:** `Optional>` +**asyncApprovalNotificationChannels:** `Optional>`
@@ -3157,7 +2967,7 @@ client.connectionProfiles().update(
-**connectionConfig:** `Optional` +**thirdPartySecurityMode:** `Optional`
@@ -3165,7 +2975,7 @@ client.connectionProfiles().update(
-**strategyOverrides:** `Optional` +**redirectionPolicy:** `Optional`
@@ -3177,8 +2987,7 @@ client.connectionProfiles().update(
-## Connections -
client.connections.list() -> SyncPagingIterable&lt;ConnectionForList&gt; +
client.clients.rotateSecret(id) -> RotateClientSecretResponseContent
@@ -3190,23 +2999,11 @@ client.connectionProfiles().update(
-Retrieves detailed list of all [connections](https://auth0.com/docs/authenticate/identity-providers) that match the specified strategy. If no strategy is provided, all connections within your tenant are retrieved. This action can accept a list of fields to include or exclude from the resulting list of connections. - -This endpoint supports two types of pagination: - -- Offset pagination -- Checkpoint pagination - -Checkpoint pagination must be used if you need to retrieve more than 1000 connections. - -**Checkpoint Pagination** - -To search by checkpoint, use the following parameters: +Rotate a client secret. -- `from`: Optional id from which to start selection. -- `take`: The total amount of entries to retrieve when using the from parameter. Defaults to 50. +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. -**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. +For more information, read [Rotate Client Secrets](https://www.auth0.com/docs/get-started/applications/rotate-client-secret).
@@ -3221,19 +3018,7 @@ To search by checkpoint, use the following parameters:
```java -client.connections().list( - ListConnectionsQueryParameters - .builder() - .from("from") - .take(1) - .name("name") - .fields("fields") - .includeFields(true) - .strategy( - Arrays.asList(ConnectionStrategyEnum.AD) - ) - .build() -); +client.clients().rotateSecret("id"); ```
@@ -3248,39 +3033,68 @@ client.connections().list(
-**from:** `Optional` — Optional Id from which to start selection. +**id:** `String` — ID of the client that will rotate secrets.
+ + -
-
-**take:** `Optional` — Number of results per page. Defaults to 50. -
+
+## ConnectionProfiles +
client.connectionProfiles.list() -> SyncPagingIterable&lt;ConnectionProfile&gt;
-**strategy:** `Optional` — Provide strategies to only retrieve connections with such strategies - +#### 📝 Description + +
+
+ +
+
+ +Retrieve a list of Connection Profiles. This endpoint supports Checkpoint pagination. +
+
+#### 🔌 Usage +
-**name:** `Optional` — Provide the name of the connection to retrieve - +
+
+ +```java +client.connectionProfiles().list( + ListConnectionProfileRequestParameters + .builder() + .from("from") + .take(1) + .build() +); +``` +
+
+#### ⚙️ Parameters +
-**fields:** `Optional` — A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields +
+
+ +**from:** `Optional` — Optional Id from which to start selection.
@@ -3288,7 +3102,7 @@ client.connections().list(
-**includeFields:** `Optional` — true if the fields specified are to be included in the result, false otherwise (defaults to true) +**take:** `Optional` — Number of results per page. Defaults to 5.
@@ -3300,7 +3114,7 @@ client.connections().list(
-
client.connections.create(request) -> CreateConnectionResponseContent +
client.connectionProfiles.create(request) -> CreateConnectionProfileResponseContent
@@ -3312,9 +3126,7 @@ client.connections().list(
-Creates a new connection according to the JSON object received in `body`. - -**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. +Create a Connection Profile.
@@ -3329,11 +3141,10 @@ Creates a new connection according to the JSON object received in `body`.
```java -client.connections().create( - CreateConnectionRequestContent +client.connectionProfiles().create( + CreateConnectionProfileRequestContent .builder() .name("name") - .strategy(ConnectionIdentityProviderEnum.AD) .build() ); ``` @@ -3350,7 +3161,7 @@ client.connections().create(
-**name:** `String` — The name of the connection. Must start and end with an alphanumeric character and can only contain alphanumeric characters and '-'. Max length 128 +**name:** `String`
@@ -3358,7 +3169,7 @@ client.connections().create(
-**displayName:** `Optional` — Connection name used in the new universal login experience +**organization:** `Optional`
@@ -3366,7 +3177,7 @@ client.connections().create(
-**strategy:** `ConnectionIdentityProviderEnum` +**connectionNamePrefixTemplate:** `Optional`
@@ -3374,7 +3185,7 @@ client.connections().create(
-**options:** `Optional` +**enabledFeatures:** `Optional>`
@@ -3382,7 +3193,7 @@ client.connections().create(
-**enabledClients:** `Optional>` — Use of this property is NOT RECOMMENDED. Use the PATCH /v2/connections/{id}/clients endpoint to enable the connection for a set of clients. +**connectionConfig:** `Optional`
@@ -3390,64 +3201,47 @@ client.connections().create(
-**isDomainConnection:** `Optional` — true promotes to a domain-level connection so that third-party applications can use it. false does not promote the connection, so only first-party applications with the connection enabled can use it. (Defaults to false.) +**strategyOverrides:** `Optional`
- -
-
- -**showAsButton:** `Optional` — Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. (Defaults to false.) -
-
-
-**realms:** `Optional>` — Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm. -
+
+
client.connectionProfiles.listTemplates() -> ListConnectionProfileTemplateResponseContent
-**metadata:** `Optional>>` - -
-
+#### 📝 Description
-**authentication:** `Optional` - -
-
-
-**connectedAccounts:** `Optional` - +Retrieve a list of Connection Profile Templates. +
+
+#### 🔌 Usage +
-**crossAppAccessRequestingApp:** `Optional` - -
-
-
-**crossAppAccessResourceApp:** `Optional` - +```java +client.connectionProfiles().listTemplates(); +```
@@ -3458,7 +3252,7 @@ client.connections().create(
-
client.connections.get(id) -> GetConnectionResponseContent +
client.connectionProfiles.getTemplate(id) -> GetConnectionProfileTemplateResponseContent
@@ -3470,7 +3264,7 @@ client.connections().create(
-Retrieve details for a specified [connection](https://auth0.com/docs/authenticate/identity-providers) along with options that can be used for identity provider configuration. +Retrieve a Connection Profile Template.
@@ -3485,14 +3279,7 @@ Retrieve details for a specified [connection](https://auth0.com/docs/authenticat
```java -client.connections().get( - "id", - GetConnectionRequestParameters - .builder() - .fields("fields") - .includeFields(true) - .build() -); +client.connectionProfiles().getTemplate("id"); ```
@@ -3507,23 +3294,7 @@ client.connections().get(
-**id:** `String` — The id of the connection to retrieve - -
-
- -
-
- -**fields:** `Optional` — A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields - -
-
- -
-
- -**includeFields:** `Optional` — true if the fields specified are to be included in the result, false otherwise (defaults to true) +**id:** `String` — ID of the connection-profile-template to retrieve.
@@ -3535,7 +3306,7 @@ client.connections().get(
-
client.connections.delete(id) +
client.connectionProfiles.get(id) -> GetConnectionProfileResponseContent
@@ -3547,9 +3318,7 @@ client.connections().get(
-Removes a specific [connection](https://auth0.com/docs/authenticate/identity-providers) 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](https://auth0.com/docs/api/management/v2/connections/post-connections) requests, if they use an identical connection name. +Retrieve details about a single Connection Profile specified by ID.
@@ -3564,7 +3333,7 @@ Removes a specific [connection](https://auth0.com/docs/authenticate/identity-pro
```java -client.connections().delete("id"); +client.connectionProfiles().get("id"); ```
@@ -3579,7 +3348,7 @@ client.connections().delete("id");
-**id:** `String` — The id of the connection to delete +**id:** `String` — ID of the connection-profile to retrieve.
@@ -3591,7 +3360,7 @@ client.connections().delete("id");
-
client.connections.update(id, request) -> UpdateConnectionResponseContent +
client.connectionProfiles.delete(id)
@@ -3603,9 +3372,7 @@ client.connections().delete("id");
-Update details for a specific [connection](https://auth0.com/docs/authenticate/identity-providers), including option properties for identity provider configuration. - -**Note**: If you use the `options` parameter, the entire `options` object is overridden. To avoid partial data or other issues, ensure all parameters are present when using this option. +Delete a single Connection Profile specified by ID.
@@ -3620,12 +3387,7 @@ Update details for a specific [connection](https://auth0.com/docs/authenticate/i
```java -client.connections().update( - "id", - UpdateConnectionRequestContent - .builder() - .build() -); +client.connectionProfiles().delete("id"); ```
@@ -3640,47 +3402,66 @@ client.connections().update(
-**id:** `String` — The id of the connection to update +**id:** `String` — ID of the connection-profile to delete.
+ + -
-
-**displayName:** `Optional` — The connection name used in the new universal login experience. If display_name is not included in the request, the field will be overwritten with the name value. -
+
+
client.connectionProfiles.update(id, request) -> UpdateConnectionProfileResponseContent
-**options:** `Optional` - -
-
+#### 📝 Description
-**enabledClients:** `Optional>` — DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable or disable the connection for any clients. - -
+
+
+ +Update the details of a specific Connection Profile. +
+
+
+#### 🔌 Usage +
-**isDomainConnection:** `Optional` — true promotes to a domain-level connection so that third-party applications can use it. false does not promote the connection, so only first-party applications with the connection enabled can use it. (Defaults to false.) - +
+
+ +```java +client.connectionProfiles().update( + "id", + UpdateConnectionProfileRequestContent + .builder() + .build() +); +``` +
+
+#### ⚙️ Parameters +
-**showAsButton:** `Optional` — Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. (Defaults to false.) +
+
+ +**id:** `String` — ID of the connection profile to update.
@@ -3688,7 +3469,7 @@ client.connections().update(
-**realms:** `Optional>` — Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm. +**name:** `Optional`
@@ -3696,7 +3477,7 @@ client.connections().update(
-**metadata:** `Optional>>` +**organization:** `Optional`
@@ -3704,7 +3485,7 @@ client.connections().update(
-**authentication:** `Optional` +**connectionNamePrefixTemplate:** `Optional`
@@ -3712,7 +3493,7 @@ client.connections().update(
-**connectedAccounts:** `Optional` +**enabledFeatures:** `Optional>`
@@ -3720,7 +3501,7 @@ client.connections().update(
-**crossAppAccessRequestingApp:** `Optional` +**connectionConfig:** `Optional`
@@ -3728,7 +3509,7 @@ client.connections().update(
-**crossAppAccessResourceApp:** `Optional` +**strategyOverrides:** `Optional`
@@ -3740,7 +3521,8 @@ client.connections().update(
-
client.connections.checkStatus(id) +## Connections +
client.connections.list() -> SyncPagingIterable&lt;ConnectionForList&gt;
@@ -3752,7 +3534,23 @@ client.connections().update(
-Retrieves the status of an ad/ldap connection referenced by its `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 +Retrieves detailed list of all [connections](https://auth0.com/docs/authenticate/identity-providers) that match the specified strategy. If no strategy is provided, all connections within your tenant are retrieved. This action can accept a list of fields to include or exclude from the resulting list of connections. + +This endpoint supports two types of pagination: + +- Offset pagination +- Checkpoint pagination + +Checkpoint pagination must be used if you need to retrieve more than 1000 connections. + +**Checkpoint Pagination** + +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.
@@ -3767,7 +3565,20 @@ Retrieves the status of an ad/ldap connection referenced by its `ID`. `200 OK` h
```java -client.connections().checkStatus("id"); +client.connections().list( + ListConnectionsQueryParameters + .builder() + .includeTotals(true) + .from("from") + .take(1) + .name("name") + .fields("fields") + .includeFields(true) + .strategy( + Arrays.asList(ConnectionStrategyEnum.AD) + ) + .build() +); ```
@@ -3782,70 +3593,31 @@ client.connections().checkStatus("id");
-**id:** `String` — ID of the connection to check +**includeTotals:** `Optional` — true if a query summary must be included in the result, false otherwise. Not returned when using checkpoint pagination. Default false.
- - - - - - -
- -## CustomDomains -
client.customDomains.list() -> List&lt;CustomDomain&gt; -
-
- -#### 📝 Description - -
-
-Retrieve details on [custom domains](https://auth0.com/docs/custom-domains). -
-
+**from:** `Optional` — Optional Id from which to start selection. +
-#### 🔌 Usage -
-
-
- -```java -client.customDomains().list( - ListCustomDomainsRequestParameters - .builder() - .q("q") - .fields("fields") - .includeFields(true) - .sort("sort") - .build() -); -``` -
-
+**take:** `Optional` — Number of results per page. Defaults to 50. +
-#### ⚙️ Parameters -
-
-
- -**q:** `Optional` — Query in Lucene query string syntax. +**strategy:** `Optional` — Provide strategies to only retrieve connections with such strategies
@@ -3853,7 +3625,7 @@ client.customDomains().list(
-**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. +**name:** `Optional` — Provide the name of the connection to retrieve
@@ -3861,7 +3633,7 @@ client.customDomains().list(
-**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). +**fields:** `Optional` — A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields
@@ -3869,7 +3641,7 @@ client.customDomains().list(
-**sort:** `Optional` — Field to sort by. Only domain:1 (ascending order by domain) is supported at this time. +**includeFields:** `Optional` — true if the fields specified are to be included in the result, false otherwise (defaults to true)
@@ -3881,7 +3653,7 @@ client.customDomains().list(
-
client.customDomains.create(request) -> CreateCustomDomainResponseContent +
client.connections.create(request) -> CreateConnectionResponseContent
@@ -3893,19 +3665,9 @@ client.customDomains().list(
-Create a new custom domain. - -Note: The custom domain will need to be verified before it will accept -requests. - -Optional attributes that can be updated: - -- custom_client_ip_header -- tls_policy - -TLS Policies: +Creates a new connection according to the JSON object received in `body`. -- recommended - for modern usage this includes TLS 1.2 only +**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.
@@ -3920,11 +3682,11 @@ TLS Policies:
```java -client.customDomains().create( - CreateCustomDomainRequestContent +client.connections().create( + CreateConnectionRequestContent .builder() - .domain("domain") - .type(CustomDomainProvisioningTypeEnum.AUTH0MANAGED_CERTS) + .name("name") + .strategy(ConnectionIdentityProviderEnum.AD) .build() ); ``` @@ -3941,7 +3703,7 @@ client.customDomains().create(
-**domain:** `String` — Domain name. +**name:** `String` — The name of the connection. Must start and end with an alphanumeric character and can only contain alphanumeric characters and '-'. Max length 128
@@ -3949,7 +3711,7 @@ client.customDomains().create(
-**type:** `CustomDomainProvisioningTypeEnum` +**displayName:** `Optional` — Connection name used in the new universal login experience
@@ -3957,7 +3719,7 @@ client.customDomains().create(
-**verificationMethod:** `Optional` +**strategy:** `ConnectionIdentityProviderEnum`
@@ -3965,7 +3727,7 @@ client.customDomains().create(
-**tlsPolicy:** `Optional` +**options:** `Optional`
@@ -3973,7 +3735,7 @@ client.customDomains().create(
-**customClientIpHeader:** `Optional` +**enabledClients:** `Optional>` — Use of this property is NOT RECOMMENDED. Use the PATCH /v2/connections/{id}/clients endpoint to enable the connection for a set of clients.
@@ -3981,7 +3743,7 @@ client.customDomains().create(
-**domainMetadata:** `Optional>>` +**isDomainConnection:** `Optional` — true promotes to a domain-level connection so that third-party applications can use it. false does not promote the connection, so only first-party applications with the connection enabled can use it. (Defaults to false.)
@@ -3989,47 +3751,56 @@ client.customDomains().create(
-**relyingPartyIdentifier:** `Optional` — Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not provided, the full domain will be used. +**showAsButton:** `Optional` — Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. (Defaults to false.)
-
-
+
+
+**realms:** `Optional>` — Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm. +
-
-
client.customDomains.getDefault() -> GetDefaultDomainResponseContent
-#### 📝 Description +**metadata:** `Optional>>` + +
+
+**authentication:** `Optional` + +
+
+
-Retrieve the tenant's default domain. -
-
+**connectedAccounts:** `Optional` + -#### 🔌 Usage -
+**crossAppAccessRequestingApp:** `Optional` + +
+
+
-```java -client.customDomains().getDefault(); -``` +**crossAppAccessResourceApp:** `Optional` +
@@ -4040,7 +3811,7 @@ client.customDomains().getDefault();
-
client.customDomains.setDefault(request) -> UpdateDefaultDomainResponseContent +
client.connections.get(id) -> GetConnectionResponseContent
@@ -4052,7 +3823,7 @@ client.customDomains().getDefault();
-Set the default custom domain for the tenant. +Retrieve details for a specified [connection](https://auth0.com/docs/authenticate/identity-providers) along with options that can be used for identity provider configuration.
@@ -4067,10 +3838,12 @@ Set the default custom domain for the tenant.
```java -client.customDomains().setDefault( - SetDefaultCustomDomainRequestContent +client.connections().get( + "id", + GetConnectionRequestParameters .builder() - .domain("domain") + .fields("fields") + .includeFields(true) .build() ); ``` @@ -4087,7 +3860,23 @@ client.customDomains().setDefault(
-**domain:** `String` — The domain to set as the default custom domain. Must be a verified custom domain or the canonical domain. +**id:** `String` — The id of the connection to retrieve + +
+
+ +
+
+ +**fields:** `Optional` — A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields + +
+
+ +
+
+ +**includeFields:** `Optional` — true if the fields specified are to be included in the result, false otherwise (defaults to true)
@@ -4099,7 +3888,7 @@ client.customDomains().setDefault(
-
client.customDomains.get(id) -> GetCustomDomainResponseContent +
client.connections.delete(id)
@@ -4111,7 +3900,9 @@ client.customDomains().setDefault(
-Retrieve a custom domain configuration and status. +Removes a specific [connection](https://auth0.com/docs/authenticate/identity-providers) 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](https://auth0.com/docs/api/management/v2/connections/post-connections) requests, if they use an identical connection name.
@@ -4126,7 +3917,7 @@ Retrieve a custom domain configuration and status.
```java -client.customDomains().get("id"); +client.connections().delete("id"); ```
@@ -4141,7 +3932,7 @@ client.customDomains().get("id");
-**id:** `String` — ID of the custom domain to retrieve. +**id:** `String` — The id of the connection to delete
@@ -4153,7 +3944,7 @@ client.customDomains().get("id");
-
client.customDomains.delete(id) +
client.connections.update(id, request) -> UpdateConnectionResponseContent
@@ -4165,7 +3956,9 @@ client.customDomains().get("id");
-Delete a custom domain and stop serving requests for it. +Update details for a specific [connection](https://auth0.com/docs/authenticate/identity-providers), including option properties for identity provider configuration. + +**Note**: If you use the `options` parameter, the entire `options` object is overridden. To avoid partial data or other issues, ensure all parameters are present when using this option.
@@ -4180,8 +3973,13 @@ Delete a custom domain and stop serving requests for it.
```java -client.customDomains().delete("id"); -``` +client.connections().update( + "id", + UpdateConnectionRequestContent + .builder() + .build() +); +```
@@ -4195,97 +3993,63 @@ client.customDomains().delete("id");
-**id:** `String` — ID of the custom domain to delete. +**id:** `String` — The id of the connection to update
- - +
+
+**displayName:** `Optional` — The connection name used in the new universal login experience. If display_name is not included in the request, the field will be overwritten with the name value. +
-
-
client.customDomains.update(id, request) -> UpdateCustomDomainResponseContent
-#### 📝 Description - -
-
+**options:** `Optional` + +
+
-Update a custom domain. - -These are the attributes that can be updated: - -- custom_client_ip_header -- tls_policy - -**Updating CUSTOM_CLIENT_IP_HEADER for a custom domain** - -To update the `custom_client_ip_header` for a domain, the body to -send should be: - -```json -{ "custom_client_ip_header": "cf-connecting-ip" } -``` - -**Updating TLS_POLICY for a custom domain** - -To update the `tls_policy` for a domain, the body to send should be: - -```json -{ "tls_policy": "recommended" } -``` - -TLS Policies: - -- recommended - for modern usage this includes TLS 1.2 only - -Some considerations: - -- The TLS ciphers and protocols available in each TLS policy follow industry recommendations, and may be updated occasionally. -- The `compatible` TLS policy is no longer supported. -
-
+**enabledClients:** `Optional>` — DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable or disable the connection for any clients. +
-#### 🔌 Usage -
+**isDomainConnection:** `Optional` — true promotes to a domain-level connection so that third-party applications can use it. false does not promote the connection, so only first-party applications with the connection enabled can use it. (Defaults to false.) + +
+
+
-```java -client.customDomains().update( - "id", - UpdateCustomDomainRequestContent - .builder() - .build() -); -``` -
-
+**showAsButton:** `Optional` — Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. (Defaults to false.) + -#### ⚙️ Parameters -
+**realms:** `Optional>` — Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm. + +
+
+
-**id:** `String` — The id of the custom domain to update +**metadata:** `Optional>>`
@@ -4293,7 +4057,7 @@ client.customDomains().update(
-**tlsPolicy:** `Optional` — recommended includes TLS 1.2 +**authentication:** `Optional`
@@ -4301,7 +4065,7 @@ client.customDomains().update(
-**customClientIpHeader:** `Optional` +**connectedAccounts:** `Optional`
@@ -4309,7 +4073,7 @@ client.customDomains().update(
-**domainMetadata:** `Optional>>` +**crossAppAccessRequestingApp:** `Optional`
@@ -4317,7 +4081,7 @@ client.customDomains().update(
-**relyingPartyIdentifier:** `Optional` — Relying Party ID (rpId) to be used for Passkeys on this custom domain. Set to null to remove the rpId and fall back to using the full domain. +**crossAppAccessResourceApp:** `Optional`
@@ -4329,7 +4093,7 @@ client.customDomains().update(
-
client.customDomains.test(id) -> TestCustomDomainResponseContent +
client.connections.checkStatus(id)
@@ -4341,7 +4105,7 @@ client.customDomains().update(
-Run the test process on a custom domain. +Retrieves the status of an ad/ldap connection referenced by its `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
@@ -4356,7 +4120,7 @@ Run the test process on a custom domain.
```java -client.customDomains().test("id"); +client.connections().checkStatus("id"); ```
@@ -4371,7 +4135,7 @@ client.customDomains().test("id");
-**id:** `String` — ID of the custom domain to test. +**id:** `String` — ID of the connection to check
@@ -4383,7 +4147,8 @@ client.customDomains().test("id");
-
client.customDomains.verify(id) -> VerifyCustomDomainResponseContent +## CustomDomains +
client.customDomains.list() -> List&lt;CustomDomain&gt;
@@ -4395,14 +4160,7 @@ client.customDomains().test("id");
-Run the verification process on a custom domain. - -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](https://auth0.com/docs/custom-domains#step-2-verify-ownership) about verifying custom domains that use Auth0 Managed certificates. -[Learn more](https://auth0.com/docs/custom-domains/self-managed-certificates#step-2-verify-ownership) about verifying custom domains that use Self Managed certificates. +Retrieve details on [custom domains](https://auth0.com/docs/custom-domains).
@@ -4417,7 +4175,15 @@ For `self_managed_certs`, when the custom domain is verified for the first time,
```java -client.customDomains().verify("id"); +client.customDomains().list( + ListCustomDomainsRequestParameters + .builder() + .q("q") + .fields("fields") + .includeFields(true) + .sort("sort") + .build() +); ```
@@ -4432,7 +4198,31 @@ client.customDomains().verify("id");
-**id:** `String` — ID of the custom domain to verify. +**q:** `Optional` — Query in Lucene query string syntax. + +
+
+ +
+
+ +**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. + +
+
+ +
+
+ +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). + +
+
+ +
+
+ +**sort:** `Optional` — Field to sort by. Only domain:1 (ascending order by domain) is supported at this time.
@@ -4444,8 +4234,7 @@ client.customDomains().verify("id");
-## DeviceCredentials -
client.deviceCredentials.list() -> SyncPagingIterable&lt;DeviceCredential&gt; +
client.customDomains.create(request) -> CreateCustomDomainResponseContent
@@ -4457,7 +4246,19 @@ client.customDomains().verify("id");
-Retrieve device credential information (`public_key`, `refresh_token`, or `rotating_refresh_token`) associated with a specific user. +Create a new custom domain. + +Note: The custom domain will need to be verified before it will accept +requests. + +Optional attributes that can be updated: + +- custom_client_ip_header +- tls_policy + +TLS Policies: + +- recommended - for modern usage this includes TLS 1.2 only
@@ -4472,17 +4273,11 @@ Retrieve device credential information (`public_key`, `refresh_token`, or `rotat
```java -client.deviceCredentials().list( - ListDeviceCredentialsRequestParameters +client.customDomains().create( + CreateCustomDomainRequestContent .builder() - .page(1) - .perPage(1) - .includeTotals(true) - .fields("fields") - .includeFields(true) - .userId("user_id") - .clientId("client_id") - .type(DeviceCredentialTypeEnum.PUBLIC_KEY) + .domain("domain") + .type(CustomDomainProvisioningTypeEnum.AUTH0MANAGED_CERTS) .build() ); ``` @@ -4499,7 +4294,7 @@ client.deviceCredentials().list(
-**page:** `Optional` — Page index of the results to return. First page is 0. +**domain:** `String` — Domain name.
@@ -4507,7 +4302,7 @@ client.deviceCredentials().list(
-**perPage:** `Optional` — Number of results per page. There is a maximum of 1000 results allowed from this endpoint. +**type:** `CustomDomainProvisioningTypeEnum`
@@ -4515,7 +4310,7 @@ client.deviceCredentials().list(
-**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). +**verificationMethod:** `Optional`
@@ -4523,7 +4318,7 @@ client.deviceCredentials().list(
-**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. +**tlsPolicy:** `Optional`
@@ -4531,7 +4326,7 @@ client.deviceCredentials().list(
-**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). +**customClientIpHeader:** `Optional`
@@ -4539,7 +4334,7 @@ client.deviceCredentials().list(
-**userId:** `Optional` — user_id of the devices to retrieve. +**domainMetadata:** `Optional>>`
@@ -4547,16 +4342,47 @@ client.deviceCredentials().list(
-**clientId:** `Optional` — client_id of the devices to retrieve. +**relyingPartyIdentifier:** `Optional` — Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not provided, the full domain will be used.
+
+
+ + + +
+ +
client.customDomains.getDefault() -> GetDefaultDomainResponseContent
-**type:** `Optional` — Type of credentials to retrieve. Must be `public_key`, `refresh_token` or `rotating_refresh_token`. The property will default to `refresh_token` when paging is requested - +#### 📝 Description + +
+
+ +
+
+ +Retrieve the tenant's default domain. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customDomains().getDefault(); +```
@@ -4567,7 +4393,7 @@ client.deviceCredentials().list(
-
client.deviceCredentials.createPublicKey(request) -> CreatePublicKeyDeviceCredentialResponseContent +
client.customDomains.setDefault(request) -> UpdateDefaultDomainResponseContent
@@ -4579,9 +4405,7 @@ client.deviceCredentials().list(
-Create a device credential public key to manage refresh token rotation for a given `user_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](https://auth0.com/docs/get-started/tenant-settings/signing-keys). +Set the default custom domain for the tenant.
@@ -4596,13 +4420,10 @@ When refresh token rotation is enabled, the endpoint becomes consistent. For mor
```java -client.deviceCredentials().createPublicKey( - CreatePublicKeyDeviceCredentialRequestContent +client.customDomains().setDefault( + SetDefaultCustomDomainRequestContent .builder() - .deviceName("device_name") - .type(DeviceCredentialPublicKeyTypeEnum.PUBLIC_KEY) - .value("value") - .deviceId("device_id") + .domain("domain") .build() ); ``` @@ -4619,39 +4440,61 @@ client.deviceCredentials().createPublicKey(
-**deviceName:** `String` — Name for this device easily recognized by owner. +**domain:** `String` — The domain to set as the default custom domain. Must be a verified custom domain or the canonical domain.
+
+
-
-
-**type:** `DeviceCredentialPublicKeyTypeEnum` -
+
+
client.customDomains.get(id) -> GetCustomDomainResponseContent
-**value:** `String` — Base64 encoded string containing the credential. - +#### 📝 Description + +
+
+ +
+
+ +Retrieve a custom domain configuration and status. +
+
+#### 🔌 Usage +
-**deviceId:** `String` — Unique identifier for the device. Recommend using Android_ID on Android and identifierForVendor. - +
+
+ +```java +client.customDomains().get("id"); +``` +
+
+#### ⚙️ Parameters +
-**clientId:** `Optional` — client_id of the client (application) this credential is for. +
+
+ +**id:** `String` — ID of the custom domain to retrieve.
@@ -4663,7 +4506,7 @@ client.deviceCredentials().createPublicKey(
-
client.deviceCredentials.delete(id) +
client.customDomains.delete(id)
@@ -4675,7 +4518,7 @@ client.deviceCredentials().createPublicKey(
-Permanently delete a device credential (such as a refresh token or public key) with the given ID. +Delete a custom domain and stop serving requests for it.
@@ -4690,7 +4533,7 @@ Permanently delete a device credential (such as a refresh token or public key) w
```java -client.deviceCredentials().delete("id"); +client.customDomains().delete("id"); ```
@@ -4705,7 +4548,7 @@ client.deviceCredentials().delete("id");
-**id:** `String` — ID of the credential to delete. +**id:** `String` — ID of the custom domain to delete.
@@ -4717,8 +4560,7 @@ client.deviceCredentials().delete("id");
-## EmailTemplates -
client.emailTemplates.create(request) -> CreateEmailTemplateResponseContent +
client.customDomains.update(id, request) -> UpdateCustomDomainResponseContent
@@ -4730,7 +4572,38 @@ client.deviceCredentials().delete("id");
-Create an email template. +Update a custom domain. + +These are the attributes that can be updated: + +- custom_client_ip_header +- tls_policy + +**Updating CUSTOM_CLIENT_IP_HEADER for a custom domain** + +To update the `custom_client_ip_header` for a domain, the body to +send should be: + +```json +{ "custom_client_ip_header": "cf-connecting-ip" } +``` + +**Updating TLS_POLICY for a custom domain** + +To update the `tls_policy` for a domain, the body to send should be: + +```json +{ "tls_policy": "recommended" } +``` + +TLS Policies: + +- recommended - for modern usage this includes TLS 1.2 only + +Some considerations: + +- The TLS ciphers and protocols available in each TLS policy follow industry recommendations, and may be updated occasionally. +- The `compatible` TLS policy is no longer supported.
@@ -4745,10 +4618,10 @@ Create an email template.
```java -client.emailTemplates().create( - CreateEmailTemplateRequestContent +client.customDomains().update( + "id", + UpdateCustomDomainRequestContent .builder() - .template(EmailTemplateNameEnum.VERIFY_EMAIL) .build() ); ``` @@ -4765,7 +4638,7 @@ client.emailTemplates().create(
-**template:** `EmailTemplateNameEnum` +**id:** `String` — The id of the custom domain to update
@@ -4773,7 +4646,7 @@ client.emailTemplates().create(
-**body:** `Optional` — Body of the email template. +**tlsPolicy:** `Optional` — recommended includes TLS 1.2
@@ -4781,7 +4654,7 @@ client.emailTemplates().create(
-**from:** `Optional` — Senders `from` email address. +**customClientIpHeader:** `Optional`
@@ -4789,7 +4662,7 @@ client.emailTemplates().create(
-**resultUrl:** `Optional` — URL to redirect the user to after a successful action. +**domainMetadata:** `Optional>>`
@@ -4797,39 +4670,61 @@ client.emailTemplates().create(
-**subject:** `Optional` — Subject line of the email. +**relyingPartyIdentifier:** `Optional` — Relying Party ID (rpId) to be used for Passkeys on this custom domain. Set to null to remove the rpId and fall back to using the full domain.
+
+
-
-
-**syntax:** `Optional` — Syntax of the template body. -
+
+
client.customDomains.test(id) -> TestCustomDomainResponseContent
-**urlLifetimeInSeconds:** `Optional` — Lifetime in seconds that the link within the email will be valid for. - +#### 📝 Description + +
+
+ +
+
+ +Run the test process on a custom domain. +
+
+#### 🔌 Usage +
-**includeEmailInRedirect:** `Optional` — Whether the `reset_email` and `verify_email` templates should include the user's email address as the `email` parameter in the returnUrl (true) or whether no email address should be included in the redirect (false). Defaults to true. - +
+
+ +```java +client.customDomains().test("id"); +``` +
+
+#### ⚙️ Parameters +
-**enabled:** `Optional` — Whether the template is enabled (true) or disabled (false). +
+
+ +**id:** `String` — ID of the custom domain to test.
@@ -4841,7 +4736,7 @@ client.emailTemplates().create(
-
client.emailTemplates.get(templateName) -> GetEmailTemplateResponseContent +
client.customDomains.verify(id) -> VerifyCustomDomainResponseContent
@@ -4853,7 +4748,14 @@ client.emailTemplates().create(
-Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `auth_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, and `async_approval`. The names `change_password`, and `password_reset` are also supported for legacy scenarios. +Run the verification process on a custom domain. + +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](https://auth0.com/docs/custom-domains#step-2-verify-ownership) about verifying custom domains that use Auth0 Managed certificates. +[Learn more](https://auth0.com/docs/custom-domains/self-managed-certificates#step-2-verify-ownership) about verifying custom domains that use Self Managed certificates.
@@ -4868,7 +4770,7 @@ Retrieve an email template by pre-defined name. These names are `verify_email`,
```java -client.emailTemplates().get(EmailTemplateNameEnum.VERIFY_EMAIL); +client.customDomains().verify("id"); ```
@@ -4883,7 +4785,7 @@ client.emailTemplates().get(EmailTemplateNameEnum.VERIFY_EMAIL);
-**templateName:** `EmailTemplateNameEnum` — Template name. Can be `verify_email`, `verify_email_by_code`, `auth_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy). +**id:** `String` — ID of the custom domain to verify.
@@ -4895,7 +4797,8 @@ client.emailTemplates().get(EmailTemplateNameEnum.VERIFY_EMAIL);
-
client.emailTemplates.set(templateName, request) -> SetEmailTemplateResponseContent +## DeviceCredentials +
client.deviceCredentials.list() -> SyncPagingIterable&lt;DeviceCredential&gt;
@@ -4907,7 +4810,7 @@ client.emailTemplates().get(EmailTemplateNameEnum.VERIFY_EMAIL);
-Update an email template. +Retrieve device credential information (`public_key`, `refresh_token`, or `rotating_refresh_token`) associated with a specific user.
@@ -4922,11 +4825,17 @@ Update an email template.
```java -client.emailTemplates().set( - EmailTemplateNameEnum.VERIFY_EMAIL, - SetEmailTemplateRequestContent +client.deviceCredentials().list( + ListDeviceCredentialsRequestParameters .builder() - .template(EmailTemplateNameEnum.VERIFY_EMAIL) + .page(1) + .perPage(1) + .includeTotals(true) + .fields("fields") + .includeFields(true) + .userId("user_id") + .clientId("client_id") + .type(DeviceCredentialTypeEnum.PUBLIC_KEY) .build() ); ``` @@ -4943,23 +4852,7 @@ client.emailTemplates().set(
-**templateName:** `EmailTemplateNameEnum` — Template name. Can be `verify_email`, `verify_email_by_code`, `auth_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy). - -
-
- -
-
- -**template:** `EmailTemplateNameEnum` - -
-
- -
-
- -**body:** `Optional` — Body of the email template. +**page:** `Optional` — Page index of the results to return. First page is 0.
@@ -4967,7 +4860,7 @@ client.emailTemplates().set(
-**from:** `Optional` — Senders `from` email address. +**perPage:** `Optional` — Number of results per page. There is a maximum of 1000 results allowed from this endpoint.
@@ -4975,7 +4868,7 @@ client.emailTemplates().set(
-**resultUrl:** `Optional` — URL to redirect the user to after a successful action. +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
@@ -4983,7 +4876,7 @@ client.emailTemplates().set(
-**subject:** `Optional` — Subject line of the email. +**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.
@@ -4991,7 +4884,7 @@ client.emailTemplates().set(
-**syntax:** `Optional` — Syntax of the template body. +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false).
@@ -4999,7 +4892,7 @@ client.emailTemplates().set(
-**urlLifetimeInSeconds:** `Optional` — Lifetime in seconds that the link within the email will be valid for. +**userId:** `Optional` — user_id of the devices to retrieve.
@@ -5007,7 +4900,7 @@ client.emailTemplates().set(
-**includeEmailInRedirect:** `Optional` — Whether the `reset_email` and `verify_email` templates should include the user's email address as the `email` parameter in the returnUrl (true) or whether no email address should be included in the redirect (false). Defaults to true. +**clientId:** `Optional` — client_id of the devices to retrieve.
@@ -5015,7 +4908,7 @@ client.emailTemplates().set(
-**enabled:** `Optional` — Whether the template is enabled (true) or disabled (false). +**type:** `Optional` — Type of credentials to retrieve. Must be `public_key`, `refresh_token` or `rotating_refresh_token`. The property will default to `refresh_token` when paging is requested
@@ -5027,7 +4920,7 @@ client.emailTemplates().set(
-
client.emailTemplates.update(templateName, request) -> UpdateEmailTemplateResponseContent +
client.deviceCredentials.createPublicKey(request) -> CreatePublicKeyDeviceCredentialResponseContent
@@ -5039,7 +4932,9 @@ client.emailTemplates().set(
-Modify an email template. +Create a device credential public key to manage refresh token rotation for a given `user_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](https://auth0.com/docs/get-started/tenant-settings/signing-keys).
@@ -5054,10 +4949,13 @@ Modify an email template.
```java -client.emailTemplates().update( - EmailTemplateNameEnum.VERIFY_EMAIL, - UpdateEmailTemplateRequestContent +client.deviceCredentials().createPublicKey( + CreatePublicKeyDeviceCredentialRequestContent .builder() + .deviceName("device_name") + .type(DeviceCredentialPublicKeyTypeEnum.PUBLIC_KEY) + .value("value") + .deviceId("device_id") .build() ); ``` @@ -5074,7 +4972,7 @@ client.emailTemplates().update(
-**templateName:** `EmailTemplateNameEnum` — Template name. Can be `verify_email`, `verify_email_by_code`, `auth_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy). +**deviceName:** `String` — Name for this device easily recognized by owner.
@@ -5082,7 +4980,7 @@ client.emailTemplates().update(
-**template:** `Optional` +**type:** `DeviceCredentialPublicKeyTypeEnum`
@@ -5090,7 +4988,7 @@ client.emailTemplates().update(
-**body:** `Optional` — Body of the email template. +**value:** `String` — Base64 encoded string containing the credential.
@@ -5098,7 +4996,7 @@ client.emailTemplates().update(
-**from:** `Optional` — Senders `from` email address. +**deviceId:** `String` — Unique identifier for the device. Recommend using Android_ID on Android and identifierForVendor.
@@ -5106,79 +5004,46 @@ client.emailTemplates().update(
-**resultUrl:** `Optional` — URL to redirect the user to after a successful action. +**clientId:** `Optional` — client_id of the client (application) this credential is for.
- -
-
- -**subject:** `Optional` — Subject line of the email. -
-
-
-**syntax:** `Optional` — Syntax of the template body. -
+
+
client.deviceCredentials.delete(id)
-**urlLifetimeInSeconds:** `Optional` — Lifetime in seconds that the link within the email will be valid for. - -
-
+#### 📝 Description
-**includeEmailInRedirect:** `Optional` — Whether the `reset_email` and `verify_email` templates should include the user's email address as the `email` parameter in the returnUrl (true) or whether no email address should be included in the redirect (false). Defaults to true. - -
-
-
-**enabled:** `Optional` — Whether the template is enabled (true) or disabled (false). - +Permanently delete a device credential (such as a refresh token or public key) with the given ID.
+#### 🔌 Usage - - -
- -## EventStreams -
client.eventStreams.list() -> SyncPagingIterable&lt;EventStreamResponseContent&gt; -
-
- -#### 🔌 Usage - -
-
+
+
```java -client.eventStreams().list( - ListEventStreamsRequestParameters - .builder() - .from("from") - .take(1) - .build() -); +client.deviceCredentials().delete("id"); ```
@@ -5193,15 +5058,7 @@ client.eventStreams().list(
-**from:** `Optional` — Optional Id from which to start selection. - -
-
- -
-
- -**take:** `Optional` — Number of results per page. Defaults to 50. +**id:** `String` — ID of the credential to delete.
@@ -5213,10 +5070,25 @@ client.eventStreams().list(
-
client.eventStreams.create(request) -> CreateEventStreamResponseContent +## EmailTemplates +
client.emailTemplates.create(request) -> CreateEmailTemplateResponseContent +
+
+ +#### 📝 Description +
+
+
+ +Create an email template. +
+
+
+
+ #### 🔌 Usage
@@ -5226,33 +5098,11 @@ client.eventStreams().list(
```java -client.eventStreams().create( - EventStreamsCreateRequest.of( - CreateEventStreamWebHookRequestContent - .builder() - .destination( - EventStreamWebhookDestination - .builder() - .type(EventStreamWebhookDestinationTypeEnum.WEBHOOK) - .configuration( - EventStreamWebhookConfiguration - .builder() - .webhookEndpoint("webhook_endpoint") - .webhookAuthorization( - EventStreamWebhookAuthorizationResponse.of( - EventStreamWebhookBasicAuth - .builder() - .method(EventStreamWebhookBasicAuthMethodEnum.BASIC) - .username("username") - .build() - ) - ) - .build() - ) - .build() - ) - .build() - ) +client.emailTemplates().create( + CreateEmailTemplateRequestContent + .builder() + .template(EmailTemplateNameEnum.VERIFY_EMAIL) + .build() ); ```
@@ -5268,47 +5118,71 @@ client.eventStreams().create(
-**request:** `EventStreamsCreateRequest` +**template:** `EmailTemplateNameEnum`
+ +
+
+ +**body:** `Optional` — Body of the email template. +
+
+
+**from:** `Optional` — Senders `from` email address. +
-
-
client.eventStreams.get(id) -> GetEventStreamResponseContent
-#### 🔌 Usage +**resultUrl:** `Optional` — URL to redirect the user to after a successful action. + +
+
+**subject:** `Optional` — Subject line of the email. + +
+
+
-```java -client.eventStreams().get("id"); -``` +**syntax:** `Optional` — Syntax of the template body. +
+ +
+
+ +**urlLifetimeInSeconds:** `Optional` — Lifetime in seconds that the link within the email will be valid for. +
-#### ⚙️ Parameters -
+**includeEmailInRedirect:** `Optional` — Whether the `reset_email` and `verify_email` templates should include the user's email address as the `email` parameter in the returnUrl (true) or whether no email address should be included in the redirect (false). Defaults to true. + +
+
+
-**id:** `String` — Unique identifier for the event stream. +**enabled:** `Optional` — Whether the template is enabled (true) or disabled (false).
@@ -5320,10 +5194,24 @@ client.eventStreams().get("id");
-
client.eventStreams.delete(id) +
client.emailTemplates.get(templateName) -> GetEmailTemplateResponseContent +
+
+ +#### 📝 Description +
+
+
+ +Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `auth_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, and `async_approval`. The names `change_password`, and `password_reset` are also supported for legacy scenarios. +
+
+
+
+ #### 🔌 Usage
@@ -5333,7 +5221,7 @@ client.eventStreams().get("id");
```java -client.eventStreams().delete("id"); +client.emailTemplates().get(EmailTemplateNameEnum.VERIFY_EMAIL); ```
@@ -5348,7 +5236,7 @@ client.eventStreams().delete("id");
-**id:** `String` — Unique identifier for the event stream. +**templateName:** `EmailTemplateNameEnum` — Template name. Can be `verify_email`, `verify_email_by_code`, `auth_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy).
@@ -5360,10 +5248,24 @@ client.eventStreams().delete("id");
-
client.eventStreams.update(id, request) -> UpdateEventStreamResponseContent +
client.emailTemplates.set(templateName, request) -> SetEmailTemplateResponseContent +
+
+ +#### 📝 Description +
+
+
+ +Update an email template. +
+
+
+
+ #### 🔌 Usage
@@ -5373,10 +5275,11 @@ client.eventStreams().delete("id");
```java -client.eventStreams().update( - "id", - UpdateEventStreamRequestContent +client.emailTemplates().set( + EmailTemplateNameEnum.VERIFY_EMAIL, + SetEmailTemplateRequestContent .builder() + .template(EmailTemplateNameEnum.VERIFY_EMAIL) .build() ); ``` @@ -5393,7 +5296,7 @@ client.eventStreams().update(
-**id:** `String` — Unique identifier for the event stream. +**templateName:** `EmailTemplateNameEnum` — Template name. Can be `verify_email`, `verify_email_by_code`, `auth_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy).
@@ -5401,7 +5304,7 @@ client.eventStreams().update(
-**name:** `Optional` — Name of the event stream. +**template:** `EmailTemplateNameEnum`
@@ -5409,7 +5312,7 @@ client.eventStreams().update(
-**subscriptions:** `Optional>` — List of event types subscribed to in this stream. +**body:** `Optional` — Body of the email template.
@@ -5417,7 +5320,7 @@ client.eventStreams().update(
-**destination:** `Optional` +**from:** `Optional` — Senders `from` email address.
@@ -5425,53 +5328,31 @@ client.eventStreams().update(
-**status:** `Optional` +**resultUrl:** `Optional` — URL to redirect the user to after a successful action.
-
-
- -
-
-
- -
client.eventStreams.test(id, request) -> CreateEventStreamTestEventResponseContent
-#### 🔌 Usage - -
-
+**subject:** `Optional` — Subject line of the email. + +
+
-```java -client.eventStreams().test( - "id", - CreateEventStreamTestEventRequestContent - .builder() - .eventType(EventStreamTestEventTypeEnum.CONNECTION_CREATED) - .build() -); -``` -
-
+**syntax:** `Optional` — Syntax of the template body. +
-#### ⚙️ Parameters - -
-
-
-**id:** `String` — Unique identifier for the event stream. +**urlLifetimeInSeconds:** `Optional` — Lifetime in seconds that the link within the email will be valid for.
@@ -5479,7 +5360,7 @@ client.eventStreams().test(
-**eventType:** `EventStreamTestEventTypeEnum` +**includeEmailInRedirect:** `Optional` — Whether the `reset_email` and `verify_email` templates should include the user's email address as the `email` parameter in the returnUrl (true) or whether no email address should be included in the redirect (false). Defaults to true.
@@ -5487,7 +5368,7 @@ client.eventStreams().test(
-**data:** `Optional>` +**enabled:** `Optional` — Whether the template is enabled (true) or disabled (false).
@@ -5499,8 +5380,7 @@ client.eventStreams().test(
-## Events -
client.events.subscribe() -> Iterable&lt;EventStreamSubscribeEventsResponseContent&gt; +
client.emailTemplates.update(templateName, request) -> UpdateEmailTemplateResponseContent
@@ -5512,7 +5392,7 @@ client.eventStreams().test(
-Subscribe to events via Server-Sent Events (SSE) +Modify an email template.
@@ -5527,14 +5407,10 @@ Subscribe to events via Server-Sent Events (SSE)
```java -client.events().subscribe( - SubscribeEventsRequestParameters +client.emailTemplates().update( + EmailTemplateNameEnum.VERIFY_EMAIL, + UpdateEmailTemplateRequestContent .builder() - .from("from") - .fromTimestamp("from_timestamp") - .eventType( - Arrays.asList(EventStreamSubscribeEventsEventTypeEnum.CONNECTION_CREATED) - ) .build() ); ``` @@ -5551,7 +5427,7 @@ client.events().subscribe(
-**from:** `Optional` — Opaque token representing position in the stream. If not provided, stream will start from the latest events. +**templateName:** `EmailTemplateNameEnum` — Template name. Can be `verify_email`, `verify_email_by_code`, `auth_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy).
@@ -5559,7 +5435,7 @@ client.events().subscribe(
-**fromTimestamp:** `Optional` — RFC-3339 timestamp indicating where to start streaming events from. This should only be used on the initial query when a cursor may not be available. Subsequent requests should use the cursor (from) as it will be more accurate. +**template:** `Optional`
@@ -5567,67 +5443,39 @@ client.events().subscribe(
-**eventType:** `Optional` — Event type(s) to listen for. Specify multiple times for multiple types (e.g., ?event_type=user.created&event_type=user.updated). If not provided, all event types will be streamed. +**body:** `Optional` — Body of the email template.
-
-
+
+
+**from:** `Optional` — Senders `from` email address. +
-
-## Flows -
client.flows.list() -> SyncPagingIterable&lt;FlowSummary&gt;
-#### 🔌 Usage +**resultUrl:** `Optional` — URL to redirect the user to after a successful action. + +
+
+**subject:** `Optional` — Subject line of the email. + +
+
+
-```java -client.flows().list( - ListFlowsRequestParameters - .builder() - .page(1) - .perPage(1) - .includeTotals(true) - .synchronous(true) - .hydrate( - Arrays.asList(ListFlowsRequestParametersHydrateEnum.FORM_COUNT) - ) - .build() -); -``` -
-
- - - -#### ⚙️ Parameters - -
-
- -
-
- -**page:** `Optional` — Page index of the results to return. First page is 0. - -
-
- -
-
- -**perPage:** `Optional` — Number of results per page. Defaults to 50. +**syntax:** `Optional` — Syntax of the template body.
@@ -5635,7 +5483,7 @@ client.flows().list(
-**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). +**urlLifetimeInSeconds:** `Optional` — Lifetime in seconds that the link within the email will be valid for.
@@ -5643,7 +5491,7 @@ client.flows().list(
-**hydrate:** `Optional` — hydration param +**includeEmailInRedirect:** `Optional` — Whether the `reset_email` and `verify_email` templates should include the user's email address as the `email` parameter in the returnUrl (true) or whether no email address should be included in the redirect (false). Defaults to true.
@@ -5651,7 +5499,7 @@ client.flows().list(
-**synchronous:** `Optional` — flag to filter by sync/async flows +**enabled:** `Optional` — Whether the template is enabled (true) or disabled (false).
@@ -5663,7 +5511,8 @@ client.flows().list(
-
client.flows.create(request) -> CreateFlowResponseContent +## EventStreams +
client.eventStreams.list() -> SyncPagingIterable&lt;EventStreamResponseContent&gt;
@@ -5676,10 +5525,11 @@ client.flows().list(
```java -client.flows().create( - CreateFlowRequestContent +client.eventStreams().list( + ListEventStreamsRequestParameters .builder() - .name("name") + .from("from") + .take(1) .build() ); ``` @@ -5696,7 +5546,7 @@ client.flows().create(
-**name:** `String` +**from:** `Optional` — Optional Id from which to start selection.
@@ -5704,7 +5554,7 @@ client.flows().create(
-**actions:** `Optional>` +**take:** `Optional` — Number of results per page. Defaults to 50.
@@ -5716,7 +5566,7 @@ client.flows().create(
-
client.flows.get(id) -> GetFlowResponseContent +
client.eventStreams.create(request) -> CreateEventStreamResponseContent
@@ -5729,14 +5579,33 @@ client.flows().create(
```java -client.flows().get( - "id", - GetFlowRequestParameters - .builder() - .hydrate( - Arrays.asList(GetFlowRequestParametersHydrateEnum.FORM_COUNT) - ) - .build() +client.eventStreams().create( + EventStreamsCreateRequest.of( + CreateEventStreamWebHookRequestContent + .builder() + .destination( + EventStreamWebhookDestination + .builder() + .type(EventStreamWebhookDestinationTypeEnum.WEBHOOK) + .configuration( + EventStreamWebhookConfiguration + .builder() + .webhookEndpoint("webhook_endpoint") + .webhookAuthorization( + EventStreamWebhookAuthorizationResponse.of( + EventStreamWebhookBasicAuth + .builder() + .method(EventStreamWebhookBasicAuthMethodEnum.BASIC) + .username("username") + .build() + ) + ) + .build() + ) + .build() + ) + .build() + ) ); ```
@@ -5752,15 +5621,7 @@ client.flows().get(
-**id:** `String` — Flow identifier - -
-
- -
-
- -**hydrate:** `Optional` — hydration param +**request:** `EventStreamsCreateRequest`
@@ -5772,7 +5633,7 @@ client.flows().get(
-
client.flows.delete(id) +
client.eventStreams.get(id) -> GetEventStreamResponseContent
@@ -5785,7 +5646,7 @@ client.flows().get(
```java -client.flows().delete("id"); +client.eventStreams().get("id"); ```
@@ -5800,7 +5661,7 @@ client.flows().delete("id");
-**id:** `String` — Flow id +**id:** `String` — Unique identifier for the event stream.
@@ -5812,7 +5673,7 @@ client.flows().delete("id");
-
client.flows.update(id, request) -> UpdateFlowResponseContent +
client.eventStreams.delete(id)
@@ -5825,12 +5686,7 @@ client.flows().delete("id");
```java -client.flows().update( - "id", - UpdateFlowRequestContent - .builder() - .build() -); +client.eventStreams().delete("id"); ```
@@ -5845,23 +5701,7 @@ client.flows().update(
-**id:** `String` — Flow identifier - -
-
- -
-
- -**name:** `Optional` - -
-
- -
-
- -**actions:** `Optional>` +**id:** `String` — Unique identifier for the event stream.
@@ -5873,8 +5713,7 @@ client.flows().update(
-## Forms -
client.forms.list() -> SyncPagingIterable&lt;FormSummary&gt; +
client.eventStreams.update(id, request) -> UpdateEventStreamResponseContent
@@ -5887,15 +5726,10 @@ client.flows().update(
```java -client.forms().list( - ListFormsRequestParameters +client.eventStreams().update( + "id", + UpdateEventStreamRequestContent .builder() - .page(1) - .perPage(1) - .includeTotals(true) - .hydrate( - Arrays.asList(FormsRequestParametersHydrateEnum.FLOW_COUNT) - ) .build() ); ``` @@ -5912,7 +5746,7 @@ client.forms().list(
-**page:** `Optional` — Page index of the results to return. First page is 0. +**id:** `String` — Unique identifier for the event stream.
@@ -5920,7 +5754,7 @@ client.forms().list(
-**perPage:** `Optional` — Number of results per page. Defaults to 50. +**name:** `Optional` — Name of the event stream.
@@ -5928,7 +5762,7 @@ client.forms().list(
-**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). +**subscriptions:** `Optional>` — List of event types subscribed to in this stream.
@@ -5936,7 +5770,15 @@ client.forms().list(
-**hydrate:** `Optional` — Query parameter to hydrate the response with additional data +**destination:** `Optional` + +
+
+ +
+
+ +**status:** `Optional`
@@ -5948,7 +5790,7 @@ client.forms().list(
-
client.forms.create(request) -> CreateFormResponseContent +
client.eventStreams.test(id, request) -> CreateEventStreamTestEventResponseContent
@@ -5961,10 +5803,11 @@ client.forms().list(
```java -client.forms().create( - CreateFormRequestContent +client.eventStreams().test( + "id", + CreateEventStreamTestEventRequestContent .builder() - .name("name") + .eventType(EventStreamTestEventTypeEnum.CONNECTION_CREATED) .build() ); ``` @@ -5981,7 +5824,7 @@ client.forms().create(
-**name:** `String` +**id:** `String` — Unique identifier for the event stream.
@@ -5989,7 +5832,7 @@ client.forms().create(
-**messages:** `Optional` +**eventType:** `EventStreamTestEventTypeEnum`
@@ -5997,61 +5840,36 @@ client.forms().create(
-**languages:** `Optional` +**data:** `Optional>`
- -
-
- -**translations:** `Optional>>` -
-
-
-**nodes:** `Optional>` -
+
+## Events +
client.events.subscribe() -> Iterable&lt;EventStreamSubscribeEventsResponseContent&gt;
-**start:** `Optional` - -
-
+#### 📝 Description
-**ending:** `Optional` - -
-
-
-**style:** `Optional` - -
-
+Subscribe to events via Server-Sent Events (SSE) - - -
- -
client.forms.get(id) -> GetFormResponseContent -
-
#### 🔌 Usage @@ -6062,12 +5880,13 @@ client.forms().create(
```java -client.forms().get( - "id", - GetFormRequestParameters +client.events().subscribe( + SubscribeEventsRequestParameters .builder() - .hydrate( - Arrays.asList(FormsRequestParametersHydrateEnum.FLOW_COUNT) + .from("from") + .fromTimestamp("from_timestamp") + .eventType( + Arrays.asList(EventStreamSubscribeEventsEventTypeEnum.CONNECTION_CREATED) ) .build() ); @@ -6085,7 +5904,7 @@ client.forms().get(
-**id:** `String` — The ID of the form to retrieve. +**from:** `Optional` — Opaque token representing position in the stream. If not provided, stream will start from the latest events.
@@ -6093,7 +5912,15 @@ client.forms().get(
-**hydrate:** `Optional` — Query parameter to hydrate the response with additional data +**fromTimestamp:** `Optional` — RFC-3339 timestamp indicating where to start streaming events from. This should only be used on the initial query when a cursor may not be available. Subsequent requests should use the cursor (from) as it will be more accurate. + +
+
+ +
+
+ +**eventType:** `Optional` — Event type(s) to listen for. Specify multiple times for multiple types (e.g., ?event_type=user.created&event_type=user.updated). If not provided, all event types will be streamed.
@@ -6105,7 +5932,8 @@ client.forms().get(
-
client.forms.delete(id) +## Flows +
client.flows.list() -> SyncPagingIterable&lt;FlowSummary&gt;
@@ -6118,7 +5946,18 @@ client.forms().get(
```java -client.forms().delete("id"); +client.flows().list( + ListFlowsRequestParameters + .builder() + .page(1) + .perPage(1) + .includeTotals(true) + .synchronous(true) + .hydrate( + Arrays.asList(ListFlowsRequestParametersHydrateEnum.FORM_COUNT) + ) + .build() +); ```
@@ -6133,52 +5972,23 @@ client.forms().delete("id");
-**id:** `String` — The ID of the form to delete. +**page:** `Optional` — Page index of the results to return. First page is 0.
- - - - - - -
- -
client.forms.update(id, request) -> UpdateFormResponseContent -
-
- -#### 🔌 Usage - -
-
-```java -client.forms().update( - "id", - UpdateFormRequestContent - .builder() - .build() -); -``` -
-
+**perPage:** `Optional` — Number of results per page. Defaults to 50. +
-#### ⚙️ Parameters - -
-
-
-**id:** `String` — The ID of the form to update. +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
@@ -6186,7 +5996,7 @@ client.forms().update(
-**name:** `Optional` +**hydrate:** `Optional` — hydration param
@@ -6194,47 +6004,52 @@ client.forms().update(
-**messages:** `Optional` +**synchronous:** `Optional` — flag to filter by sync/async flows
+
+
-
-
-**languages:** `Optional` -
+
+
client.flows.create(request) -> CreateFlowResponseContent
-**translations:** `Optional>>` - -
-
+#### 🔌 Usage
-**nodes:** `Optional>` - -
-
-
-**start:** `Optional` - +```java +client.flows().create( + CreateFlowRequestContent + .builder() + .name("name") + .build() +); +``` +
+
+#### ⚙️ Parameters +
-**ending:** `Optional` +
+
+ +**name:** `String`
@@ -6242,7 +6057,7 @@ client.forms().update(
-**style:** `Optional` +**actions:** `Optional>`
@@ -6254,25 +6069,10 @@ client.forms().update(
-## UserGrants -
client.userGrants.list() -> SyncPagingIterable&lt;UserGrant&gt; -
-
- -#### 📝 Description - -
-
- +
client.flows.get(id) -> GetFlowResponseContent
-Retrieve the [grants](https://auth0.com/docs/api-auth/which-oauth-flow-to-use) associated with your account. -
-
-
-
- #### 🔌 Usage
@@ -6282,15 +6082,13 @@ Retrieve the [grants](https://auth0.com/docs/api-auth/which-oauth-flow-to-use) a
```java -client.userGrants().list( - ListUserGrantsRequestParameters +client.flows().get( + "id", + GetFlowRequestParameters .builder() - .perPage(1) - .page(1) - .includeTotals(true) - .userId("user_id") - .clientId("client_id") - .audience("audience") + .hydrate( + Arrays.asList(GetFlowRequestParametersHydrateEnum.FORM_COUNT) + ) .build() ); ``` @@ -6307,7 +6105,7 @@ client.userGrants().list(
-**perPage:** `Optional` — Number of results per page. +**id:** `String` — Flow identifier
@@ -6315,39 +6113,47 @@ client.userGrants().list(
-**page:** `Optional` — Page index of the results to return. First page is 0. +**hydrate:** `Optional` — hydration param
+
+
-
-
-**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). -
+
+
client.flows.delete(id)
-**userId:** `Optional` — user_id of the grants to retrieve. - -
-
+#### 🔌 Usage
-**clientId:** `Optional` — client_id of the grants to retrieve. - +
+
+ +```java +client.flows().delete("id"); +``` +
+
+#### ⚙️ Parameters +
-**audience:** `Optional` — audience of the grants to retrieve. +
+
+ +**id:** `String` — Flow id
@@ -6359,11 +6165,11 @@ client.userGrants().list(
-
client.userGrants.deleteByUserId() +
client.flows.update(id, request) -> UpdateFlowResponseContent
-#### 📝 Description +#### 🔌 Usage
@@ -6371,13 +6177,20 @@ client.userGrants().list(
-Delete a grant associated with your account. +```java +client.flows().update( + "id", + UpdateFlowRequestContent + .builder() + .build() +); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -6385,28 +6198,23 @@ Delete a grant associated with your account.
-```java -client.userGrants().deleteByUserId( - DeleteUserGrantByUserIdRequestParameters - .builder() - .userId("user_id") - .build() -); -``` -
-
+**id:** `String` — Flow identifier +
-#### ⚙️ Parameters -
+**name:** `Optional` + +
+
+
-**userId:** `String` — user_id of the grant to delete. +**actions:** `Optional>`
@@ -6418,11 +6226,12 @@ client.userGrants().deleteByUserId(
-
client.userGrants.delete(id) +## Forms +
client.forms.list() -> SyncPagingIterable&lt;FormSummary&gt;
-#### 📝 Description +#### 🔌 Usage
@@ -6430,13 +6239,25 @@ client.userGrants().deleteByUserId(
-Delete a grant associated with your account. +```java +client.forms().list( + ListFormsRequestParameters + .builder() + .page(1) + .perPage(1) + .includeTotals(true) + .hydrate( + Arrays.asList(FormsRequestParametersHydrateEnum.FLOW_COUNT) + ) + .build() +); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -6444,23 +6265,31 @@ Delete a grant associated with your account.
-```java -client.userGrants().delete("id"); -``` +**page:** `Optional` — Page index of the results to return. First page is 0. +
+ +
+
+ +**perPage:** `Optional` — Number of results per page. Defaults to 50. +
-#### ⚙️ Parameters -
+**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). + +
+
+
-**id:** `String` — ID of the grant to delete. +**hydrate:** `Optional` — Query parameter to hydrate the response with additional data
@@ -6472,25 +6301,10 @@ client.userGrants().delete("id");
-## Groups -
client.groups.list() -> SyncPagingIterable&lt;Group&gt; -
-
- -#### 📝 Description - -
-
- +
client.forms.create(request) -> CreateFormResponseContent
-List all groups in your tenant. -
-
-
-
- #### 🔌 Usage
@@ -6500,17 +6314,10 @@ List all groups in your tenant.
```java -client.groups().list( - ListGroupsRequestParameters +client.forms().create( + CreateFormRequestContent .builder() - .connectionId("connection_id") .name("name") - .externalId("external_id") - .search("search") - .fields("fields") - .includeFields(true) - .from("from") - .take(1) .build() ); ``` @@ -6527,7 +6334,7 @@ client.groups().list(
-**connectionId:** `Optional` — Filter groups by connection ID. +**name:** `String`
@@ -6535,7 +6342,7 @@ client.groups().list(
-**name:** `Optional` — Filter groups by name. +**messages:** `Optional`
@@ -6543,7 +6350,7 @@ client.groups().list(
-**externalId:** `Optional` — Filter groups by external ID. +**languages:** `Optional`
@@ -6551,7 +6358,7 @@ client.groups().list(
-**search:** `Optional` — Search for groups by name or external ID. +**translations:** `Optional>>`
@@ -6559,7 +6366,7 @@ client.groups().list(
-**fields:** `Optional` — A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields +**nodes:** `Optional>`
@@ -6567,7 +6374,7 @@ client.groups().list(
-**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). +**start:** `Optional`
@@ -6575,7 +6382,7 @@ client.groups().list(
-**from:** `Optional` — Optional Id from which to start selection. +**ending:** `Optional`
@@ -6583,7 +6390,7 @@ client.groups().list(
-**take:** `Optional` — Number of results per page. Defaults to 50. +**style:** `Optional`
@@ -6595,11 +6402,11 @@ client.groups().list(
-
client.groups.get(id) -> GetGroupResponseContent +
client.forms.get(id) -> GetFormResponseContent
-#### 📝 Description +#### 🔌 Usage
@@ -6607,13 +6414,23 @@ client.groups().list(
-Retrieve a group by its ID. +```java +client.forms().get( + "id", + GetFormRequestParameters + .builder() + .hydrate( + Arrays.asList(FormsRequestParametersHydrateEnum.FLOW_COUNT) + ) + .build() +); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -6621,23 +6438,15 @@ Retrieve a group by its ID.
-```java -client.groups().get("id"); -``` -
-
+**id:** `String` — The ID of the form to retrieve. +
-#### ⚙️ Parameters - -
-
-
-**id:** `String` — Unique identifier for the group (service-generated). +**hydrate:** `Optional` — Query parameter to hydrate the response with additional data
@@ -6649,24 +6458,10 @@ client.groups().get("id");
-
client.groups.delete(id) -
-
- -#### 📝 Description - -
-
- +
client.forms.delete(id)
-Delete a group by its ID. -
-
-
-
- #### 🔌 Usage
@@ -6676,7 +6471,7 @@ Delete a group by its ID.
```java -client.groups().delete("id"); +client.forms().delete("id"); ```
@@ -6691,7 +6486,7 @@ client.groups().delete("id");
-**id:** `String` — Unique identifier for the group (service-generated). +**id:** `String` — The ID of the form to delete.
@@ -6703,12 +6498,11 @@ client.groups().delete("id");
-## Hooks -
client.hooks.list() -> SyncPagingIterable&lt;Hook&gt; +
client.forms.update(id, request) -> UpdateFormResponseContent
-#### 📝 Description +#### 🔌 Usage
@@ -6716,13 +6510,20 @@ client.groups().delete("id");
-Retrieve all [hooks](https://auth0.com/docs/hooks). Accepts a list of fields to include or exclude in the result. +```java +client.forms().update( + "id", + UpdateFormRequestContent + .builder() + .build() +); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -6730,33 +6531,31 @@ Retrieve all [hooks](https://auth0.com/docs/hooks). Accepts a list of fields to
-```java -client.hooks().list( - ListHooksRequestParameters - .builder() - .page(1) - .perPage(1) - .includeTotals(true) - .enabled(true) - .fields("fields") - .triggerId(HookTriggerIdEnum.CREDENTIALS_EXCHANGE) - .build() -); -``` +**id:** `String` — The ID of the form to update. +
+ +
+
+ +**name:** `Optional` +
-#### ⚙️ Parameters -
+**messages:** `Optional` + +
+
+
-**page:** `Optional` — Page index of the results to return. First page is 0. +**languages:** `Optional`
@@ -6764,7 +6563,7 @@ client.hooks().list(
-**perPage:** `Optional` — Number of results per page. +**translations:** `Optional>>`
@@ -6772,7 +6571,7 @@ client.hooks().list(
-**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). +**nodes:** `Optional>`
@@ -6780,7 +6579,7 @@ client.hooks().list(
-**enabled:** `Optional` — Optional filter on whether a hook is enabled (true) or disabled (false). +**start:** `Optional`
@@ -6788,7 +6587,7 @@ client.hooks().list(
-**fields:** `Optional` — Comma-separated list of fields to include in the result. Leave empty to retrieve all fields. +**ending:** `Optional`
@@ -6796,7 +6595,7 @@ client.hooks().list(
-**triggerId:** `Optional` — Retrieves hooks that match the trigger +**style:** `Optional`
@@ -6808,7 +6607,8 @@ client.hooks().list(
-
client.hooks.create(request) -> CreateHookResponseContent +## UserGrants +
client.userGrants.list() -> SyncPagingIterable&lt;UserGrant&gt;
@@ -6820,7 +6620,7 @@ client.hooks().list(
-Create a new hook. +Retrieve the [grants](https://auth0.com/docs/api-auth/which-oauth-flow-to-use) associated with your account.
@@ -6835,12 +6635,15 @@ Create a new hook.
```java -client.hooks().create( - CreateHookRequestContent +client.userGrants().list( + ListUserGrantsRequestParameters .builder() - .name("name") - .script("script") - .triggerId(HookTriggerIdEnum.CREDENTIALS_EXCHANGE) + .perPage(1) + .page(1) + .includeTotals(true) + .userId("user_id") + .clientId("client_id") + .audience("audience") .build() ); ``` @@ -6857,7 +6660,7 @@ client.hooks().create(
-**name:** `String` — Name of this hook. +**perPage:** `Optional` — Number of results per page.
@@ -6865,7 +6668,7 @@ client.hooks().create(
-**script:** `String` — Code to be executed when this hook runs. +**page:** `Optional` — Page index of the results to return. First page is 0.
@@ -6873,7 +6676,7 @@ client.hooks().create(
-**enabled:** `Optional` — Whether this hook will be executed (true) or ignored (false). +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
@@ -6881,7 +6684,7 @@ client.hooks().create(
-**dependencies:** `Optional>` +**userId:** `Optional` — user_id of the grants to retrieve.
@@ -6889,7 +6692,15 @@ client.hooks().create(
-**triggerId:** `HookTriggerIdEnum` — Execution stage of this rule. Can be `credentials-exchange`, `pre-user-registration`, `post-user-registration`, `post-change-password`, or `send-phone-message`. +**clientId:** `Optional` — client_id of the grants to retrieve. + +
+
+ +
+
+ +**audience:** `Optional` — audience of the grants to retrieve.
@@ -6901,7 +6712,7 @@ client.hooks().create(
-
client.hooks.get(id) -> GetHookResponseContent +
client.userGrants.deleteByUserId()
@@ -6913,7 +6724,7 @@ client.hooks().create(
-Retrieve [a hook](https://auth0.com/docs/hooks) by its ID. Accepts a list of fields to include in the result. +Delete a grant associated with your account.
@@ -6928,11 +6739,10 @@ Retrieve [a hook](https://auth0.com/docs/hooks) by its ID. Accepts a list of fie
```java -client.hooks().get( - "id", - GetHookRequestParameters +client.userGrants().deleteByUserId( + DeleteUserGrantByUserIdRequestParameters .builder() - .fields("fields") + .userId("user_id") .build() ); ``` @@ -6949,15 +6759,7 @@ client.hooks().get(
-**id:** `String` — ID of the hook to retrieve. - -
-
- -
-
- -**fields:** `Optional` — Comma-separated list of fields to include in the result. Leave empty to retrieve all fields. +**userId:** `String` — user_id of the grant to delete.
@@ -6969,7 +6771,7 @@ client.hooks().get(
-
client.hooks.delete(id) +
client.userGrants.delete(id)
@@ -6981,7 +6783,7 @@ client.hooks().get(
-Delete a hook. +Delete a grant associated with your account.
@@ -6996,7 +6798,7 @@ Delete a hook.
```java -client.hooks().delete("id"); +client.userGrants().delete("id"); ```
@@ -7011,7 +6813,7 @@ client.hooks().delete("id");
-**id:** `String` — ID of the hook to delete. +**id:** `String` — ID of the grant to delete.
@@ -7023,7 +6825,8 @@ client.hooks().delete("id");
-
client.hooks.update(id, request) -> UpdateHookResponseContent +## Groups +
client.groups.list() -> SyncPagingIterable&lt;Group&gt;
@@ -7035,7 +6838,7 @@ client.hooks().delete("id");
-Update an existing hook. +List all groups in your tenant.
@@ -7050,10 +6853,18 @@ Update an existing hook.
```java -client.hooks().update( - "id", - UpdateHookRequestContent +client.groups().list( + ListGroupsRequestParameters .builder() + .connectionId("connection_id") + .name("name") + .externalId("external_id") + .search("search") + .fields("fields") + .includeFields(true) + .includeTotals(true) + .from("from") + .take(1) .build() ); ``` @@ -7070,7 +6881,7 @@ client.hooks().update(
-**id:** `String` — ID of the hook to update. +**connectionId:** `Optional` — Filter groups by connection ID.
@@ -7078,7 +6889,7 @@ client.hooks().update(
-**name:** `Optional` — Name of this hook. +**name:** `Optional` — Filter groups by name.
@@ -7086,7 +6897,7 @@ client.hooks().update(
-**script:** `Optional` — Code to be executed when this hook runs. +**externalId:** `Optional` — Filter groups by external ID.
@@ -7094,7 +6905,7 @@ client.hooks().update(
-**enabled:** `Optional` — Whether this hook will be executed (true) or ignored (false). +**search:** `Optional` — Search for groups by name or external ID.
@@ -7102,7 +6913,39 @@ client.hooks().update(
-**dependencies:** `Optional>` +**fields:** `Optional` — A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields + +
+
+ +
+
+ +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). + +
+
+ +
+
+ +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). + +
+
+ +
+
+ +**from:** `Optional` — Optional Id from which to start selection. + +
+
+ +
+
+ +**take:** `Optional` — Number of results per page. Defaults to 50.
@@ -7114,8 +6957,7 @@ client.hooks().update(
-## Jobs -
client.jobs.get(id) -> GetJobResponseContent +
client.groups.get(id) -> GetGroupResponseContent
@@ -7127,7 +6969,7 @@ client.hooks().update(
-Retrieves a job. Useful to check its status. +Retrieve a group by its ID.
@@ -7142,7 +6984,7 @@ Retrieves a job. Useful to check its status.
```java -client.jobs().get("id"); +client.groups().get("id"); ```
@@ -7157,7 +6999,7 @@ client.jobs().get("id");
-**id:** `String` — ID of the job. +**id:** `String` — Unique identifier for the group (service-generated).
@@ -7169,8 +7011,7 @@ client.jobs().get("id");
-## LogStreams -
client.logStreams.list() -> List&lt;LogStreamResponseSchema&gt; +
client.groups.delete(id)
@@ -7182,77 +7023,7 @@ client.jobs().get("id");
-Retrieve details on [log streams](https://auth0.com/docs/logs/streams). - -**Sample Response** - -```json -[{ - "id": "string", - "name": "string", - "type": "eventbridge", - "status": "active|paused|suspended", - "sink": { - "awsAccountId": "string", - "awsRegion": "string", - "awsPartnerEventSource": "string" - } -}, { - "id": "string", - "name": "string", - "type": "http", - "status": "active|paused|suspended", - "sink": { - "httpContentFormat": "JSONLINES|JSONARRAY", - "httpContentType": "string", - "httpEndpoint": "string", - "httpAuthorization": "string" - } -}, -{ - "id": "string", - "name": "string", - "type": "eventgrid", - "status": "active|paused|suspended", - "sink": { - "azureSubscriptionId": "string", - "azureResourceGroup": "string", - "azureRegion": "string", - "azurePartnerTopic": "string" - } -}, -{ - "id": "string", - "name": "string", - "type": "splunk", - "status": "active|paused|suspended", - "sink": { - "splunkDomain": "string", - "splunkToken": "string", - "splunkPort": "string", - "splunkSecure": "boolean" - } -}, -{ - "id": "string", - "name": "string", - "type": "sumo", - "status": "active|paused|suspended", - "sink": { - "sumoSourceAddress": "string" - } -}, -{ - "id": "string", - "name": "string", - "type": "datadog", - "status": "active|paused|suspended", - "sink": { - "datadogRegion": "string", - "datadogApiKey": "string" - } -}] -``` +Delete a group by its ID.
@@ -7267,19 +7038,35 @@ Retrieve details on [log streams](https://auth0.com/docs/logs/streams).
```java -client.logStreams().list(); +client.groups().delete("id"); ```
+#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — Unique identifier for the group (service-generated). + +
+
+
+
+
-
client.logStreams.create(request) -> CreateLogStreamResponseContent +## Hooks +
client.hooks.list() -> SyncPagingIterable&lt;Hook&gt;
@@ -7291,135 +7078,1148 @@ client.logStreams().list();
-Create a log stream. - -**Log Stream Types** +Retrieve all [hooks](https://auth0.com/docs/hooks). Accepts a list of fields to include or exclude in the result. +
+
+
+
-The `type` of log stream being created determines the properties required in the `sink` payload. +#### 🔌 Usage -**HTTP Stream** +
+
-For an `http` Stream, the `sink` properties are listed in the payload below. +
+
-**Request:** -```json -{ - "name": "string", - "type": "http", - "sink": { - "httpEndpoint": "string", - "httpContentType": "string", - "httpContentFormat": "JSONLINES|JSONARRAY", - "httpAuthorization": "string" - } -} +```java +client.hooks().list( + ListHooksRequestParameters + .builder() + .page(1) + .perPage(1) + .includeTotals(true) + .enabled(true) + .fields("fields") + .triggerId(HookTriggerIdEnum.CREDENTIALS_EXCHANGE) + .build() +); ``` +
+
+
+
-**Response:** -```json -{ - "id": "string", - "name": "string", - "type": "http", - "status": "active", - "sink": { - "httpEndpoint": "string", - "httpContentType": "string", - "httpContentFormat": "JSONLINES|JSONARRAY", - "httpAuthorization": "string" - } -} -``` +#### ⚙️ Parameters -**Amazon EventBridge Stream** +
+
-For an `eventbridge` Stream, the `sink` properties are listed in the payload below. +
+
-**Request:** -```json -{ - "name": "string", - "type": "eventbridge", - "sink": { - "awsRegion": "string", - "awsAccountId": "string" - } -} -``` +**page:** `Optional` — Page index of the results to return. First page is 0. + +
+
-The response will include an additional field `awsPartnerEventSource` in the `sink`: +
+
-**Response:** -```json -{ - "id": "string", - "name": "string", - "type": "eventbridge", - "status": "active", - "sink": { - "awsAccountId": "string", - "awsRegion": "string", - "awsPartnerEventSource": "string" - } -} -``` +**perPage:** `Optional` — Number of results per page. + +
+
-**Azure Event Grid Stream** +
+
-For an `Azure Event Grid` Stream, the `sink` properties are listed in the payload below. +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). + +
+
-**Request:** -```json -{ - "name": "string", - "type": "eventgrid", - "sink": { - "azureSubscriptionId": "string", - "azureResourceGroup": "string", - "azureRegion": "string" - } -} -``` +
+
-**Response:** -```json -{ - "id": "string", - "name": "string", - "type": "http", - "status": "active", - "sink": { - "azureSubscriptionId": "string", - "azureResourceGroup": "string", - "azureRegion": "string", - "azurePartnerTopic": "string" - } -} -``` +**enabled:** `Optional` — Optional filter on whether a hook is enabled (true) or disabled (false). + +
+
-**Datadog Stream** +
+
-For a `Datadog` Stream, the `sink` properties are listed in the payload below. +**fields:** `Optional` — Comma-separated list of fields to include in the result. Leave empty to retrieve all fields. + +
+
-**Request:** -```json -{ - "name": "string", - "type": "datadog", - "sink": { - "datadogRegion": "string", - "datadogApiKey": "string" - } -} -``` +
+
-**Response:** -```json +**triggerId:** `Optional` — Retrieves hooks that match the trigger + +
+
+
+
+ + + + +
+ +
client.hooks.create(request) -> CreateHookResponseContent +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create a new hook. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.hooks().create( + CreateHookRequestContent + .builder() + .name("name") + .script("script") + .triggerId(HookTriggerIdEnum.CREDENTIALS_EXCHANGE) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**name:** `String` — Name of this hook. + +
+
+ +
+
+ +**script:** `String` — Code to be executed when this hook runs. + +
+
+ +
+
+ +**enabled:** `Optional` — Whether this hook will be executed (true) or ignored (false). + +
+
+ +
+
+ +**dependencies:** `Optional>` + +
+
+ +
+
+ +**triggerId:** `HookTriggerIdEnum` — Execution stage of this rule. Can be `credentials-exchange`, `pre-user-registration`, `post-user-registration`, `post-change-password`, or `send-phone-message`. + +
+
+
+
+ + +
+
+
+ +
client.hooks.get(id) -> GetHookResponseContent +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve [a hook](https://auth0.com/docs/hooks) by its ID. Accepts a list of fields to include in the result. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.hooks().get( + "id", + GetHookRequestParameters + .builder() + .fields("fields") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — ID of the hook to retrieve. + +
+
+ +
+
+ +**fields:** `Optional` — Comma-separated list of fields to include in the result. Leave empty to retrieve all fields. + +
+
+
+
+ + +
+
+
+ +
client.hooks.delete(id) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Delete a hook. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.hooks().delete("id"); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — ID of the hook to delete. + +
+
+
+
+ + +
+
+
+ +
client.hooks.update(id, request) -> UpdateHookResponseContent +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Update an existing hook. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.hooks().update( + "id", + UpdateHookRequestContent + .builder() + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — ID of the hook to update. + +
+
+ +
+
+ +**name:** `Optional` — Name of this hook. + +
+
+ +
+
+ +**script:** `Optional` — Code to be executed when this hook runs. + +
+
+ +
+
+ +**enabled:** `Optional` — Whether this hook will be executed (true) or ignored (false). + +
+
+ +
+
+ +**dependencies:** `Optional>` + +
+
+
+
+ + +
+
+
+ +## Jobs +
client.jobs.get(id) -> GetJobResponseContent +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves a job. Useful to check its status. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.jobs().get("id"); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — ID of the job. + +
+
+
+
+ + +
+
+
+ +## LogStreams +
client.logStreams.list() -> List&lt;LogStreamResponseSchema&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve details on [log streams](https://auth0.com/docs/logs/streams). + +**Sample Response** + +```json +[{ + "id": "string", + "name": "string", + "type": "eventbridge", + "status": "active|paused|suspended", + "sink": { + "awsAccountId": "string", + "awsRegion": "string", + "awsPartnerEventSource": "string" + } +}, { + "id": "string", + "name": "string", + "type": "http", + "status": "active|paused|suspended", + "sink": { + "httpContentFormat": "JSONLINES|JSONARRAY", + "httpContentType": "string", + "httpEndpoint": "string", + "httpAuthorization": "string" + } +}, +{ + "id": "string", + "name": "string", + "type": "eventgrid", + "status": "active|paused|suspended", + "sink": { + "azureSubscriptionId": "string", + "azureResourceGroup": "string", + "azureRegion": "string", + "azurePartnerTopic": "string" + } +}, +{ + "id": "string", + "name": "string", + "type": "splunk", + "status": "active|paused|suspended", + "sink": { + "splunkDomain": "string", + "splunkToken": "string", + "splunkPort": "string", + "splunkSecure": "boolean" + } +}, +{ + "id": "string", + "name": "string", + "type": "sumo", + "status": "active|paused|suspended", + "sink": { + "sumoSourceAddress": "string" + } +}, +{ + "id": "string", + "name": "string", + "type": "datadog", + "status": "active|paused|suspended", + "sink": { + "datadogRegion": "string", + "datadogApiKey": "string" + } +}] +``` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.logStreams().list(); +``` +
+
+
+
+ + +
+
+
+ +
client.logStreams.create(request) -> CreateLogStreamResponseContent +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create a log stream. + +**Log Stream Types** + +The `type` of log stream being created determines the properties required in the `sink` payload. + +**HTTP Stream** + +For an `http` Stream, the `sink` properties are listed in the payload below. + +**Request:** +```json +{ + "name": "string", + "type": "http", + "sink": { + "httpEndpoint": "string", + "httpContentType": "string", + "httpContentFormat": "JSONLINES|JSONARRAY", + "httpAuthorization": "string" + } +} +``` + +**Response:** +```json +{ + "id": "string", + "name": "string", + "type": "http", + "status": "active", + "sink": { + "httpEndpoint": "string", + "httpContentType": "string", + "httpContentFormat": "JSONLINES|JSONARRAY", + "httpAuthorization": "string" + } +} +``` + +**Amazon EventBridge Stream** + +For an `eventbridge` Stream, the `sink` properties are listed in the payload below. + +**Request:** +```json +{ + "name": "string", + "type": "eventbridge", + "sink": { + "awsRegion": "string", + "awsAccountId": "string" + } +} +``` + +The response will include an additional field `awsPartnerEventSource` in the `sink`: + +**Response:** +```json +{ + "id": "string", + "name": "string", + "type": "eventbridge", + "status": "active", + "sink": { + "awsAccountId": "string", + "awsRegion": "string", + "awsPartnerEventSource": "string" + } +} +``` + +**Azure Event Grid Stream** + +For an `Azure Event Grid` Stream, the `sink` properties are listed in the payload below. + +**Request:** +```json +{ + "name": "string", + "type": "eventgrid", + "sink": { + "azureSubscriptionId": "string", + "azureResourceGroup": "string", + "azureRegion": "string" + } +} +``` + +**Response:** +```json +{ + "id": "string", + "name": "string", + "type": "http", + "status": "active", + "sink": { + "azureSubscriptionId": "string", + "azureResourceGroup": "string", + "azureRegion": "string", + "azurePartnerTopic": "string" + } +} +``` + +**Datadog Stream** + +For a `Datadog` Stream, the `sink` properties are listed in the payload below. + +**Request:** +```json +{ + "name": "string", + "type": "datadog", + "sink": { + "datadogRegion": "string", + "datadogApiKey": "string" + } +} +``` + +**Response:** +```json +{ + "id": "string", + "name": "string", + "type": "datadog", + "status": "active", + "sink": { + "datadogRegion": "string", + "datadogApiKey": "string" + } +} +``` + +**Splunk Stream** + +For a `Splunk` Stream, the `sink` properties are listed in the payload below. + +**Request:** +```json +{ + "name": "string", + "type": "splunk", + "sink": { + "splunkDomain": "string", + "splunkToken": "string", + "splunkPort": "string", + "splunkSecure": "boolean" + } +} +``` + +**Response:** +```json +{ + "id": "string", + "name": "string", + "type": "splunk", + "status": "active", + "sink": { + "splunkDomain": "string", + "splunkToken": "string", + "splunkPort": "string", + "splunkSecure": "boolean" + } +} +``` + +**Sumo Logic Stream** + +For a `Sumo Logic` Stream, the `sink` properties are listed in the payload below. + +**Request:** +```json +{ + "name": "string", + "type": "sumo", + "sink": { + "sumoSourceAddress": "string" + } +} +``` + +**Response:** +```json +{ + "id": "string", + "name": "string", + "type": "sumo", + "status": "active", + "sink": { + "sumoSourceAddress": "string" + } +} +``` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.logStreams().create( + CreateLogStreamRequestContent.of( + CreateLogStreamHttpRequestBody + .builder() + .type(LogStreamHttpEnum.HTTP) + .sink( + LogStreamHttpSink + .builder() + .httpEndpoint("httpEndpoint") + .build() + ) + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `CreateLogStreamRequestContent` + +
+
+
+
+ + +
+
+
+ +
client.logStreams.get(id) -> GetLogStreamResponseContent +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve a log stream configuration and status. + +**Sample responses** + +**Amazon EventBridge Log Stream** + +```json +{ + "id": "string", + "name": "string", + "type": "eventbridge", + "status": "active|paused|suspended", + "sink": { + "awsAccountId": "string", + "awsRegion": "string", + "awsPartnerEventSource": "string" + } +} +``` + +**HTTP Log Stream** + +```json +{ + "id": "string", + "name": "string", + "type": "http", + "status": "active|paused|suspended", + "sink": { + "httpContentFormat": "JSONLINES|JSONARRAY", + "httpContentType": "string", + "httpEndpoint": "string", + "httpAuthorization": "string" + } +} +``` + +**Datadog Log Stream** + +```json +{ + "id": "string", + "name": "string", + "type": "datadog", + "status": "active|paused|suspended", + "sink": { + "datadogRegion": "string", + "datadogApiKey": "string" + } +} +``` + +**Mixpanel** + +**Request:** + +```json +{ + "name": "string", + "type": "mixpanel", + "sink": { + "mixpanelRegion": "string", + "mixpanelProjectId": "string", + "mixpanelServiceAccountUsername": "string", + "mixpanelServiceAccountPassword": "string" + } +} +``` + +**Response:** + +```json +{ + "id": "string", + "name": "string", + "type": "mixpanel", + "status": "active", + "sink": { + "mixpanelRegion": "string", + "mixpanelProjectId": "string", + "mixpanelServiceAccountUsername": "string", + "mixpanelServiceAccountPassword": "string" + } +} +``` + +**Segment** + +**Request:** + +```json +{ + "name": "string", + "type": "segment", + "sink": { + "segmentWriteKey": "string" + } +} +``` + +**Response:** + +```json +{ + "id": "string", + "name": "string", + "type": "segment", + "status": "active", + "sink": { + "segmentWriteKey": "string" + } +} +``` + +**Splunk Log Stream** + +```json +{ + "id": "string", + "name": "string", + "type": "splunk", + "status": "active|paused|suspended", + "sink": { + "splunkDomain": "string", + "splunkToken": "string", + "splunkPort": "string", + "splunkSecure": "boolean" + } +} +``` + +**Sumo Logic Log Stream** + +```json +{ + "id": "string", + "name": "string", + "type": "sumo", + "status": "active|paused|suspended", + "sink": { + "sumoSourceAddress": "string" + } +} +``` + +**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. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.logStreams().get("id"); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The id of the log stream to get + +
+
+
+
+ + +
+
+
+ +
client.logStreams.delete(id) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Delete a log stream. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.logStreams().delete("id"); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The id of the log stream to delete + +
+
+
+
+ + +
+
+
+ +
client.logStreams.update(id, request) -> UpdateLogStreamResponseContent +
+
+ +#### 📝 Description + +
+
+ +
+
+ +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** + +```json +{ + "status": "active|paused" +} +``` + +**Update the name of a log stream** + +```json +{ + "name": "string" +} +``` + +**Update the sink properties of a stream of type `http`** + +```json +{ + "sink": { + "httpEndpoint": "string", + "httpContentType": "string", + "httpContentFormat": "JSONARRAY|JSONLINES", + "httpAuthorization": "string" + } +} +``` + +**Update the sink properties of a stream of type `datadog`** + +```json { - "id": "string", - "name": "string", - "type": "datadog", - "status": "active", "sink": { "datadogRegion": "string", "datadogApiKey": "string" @@ -7427,72 +8227,564 @@ For a `Datadog` Stream, the `sink` properties are listed in the payload below. } ``` -**Splunk Stream** +**Update the sink properties of a stream of type `splunk`** + +```json +{ + "sink": { + "splunkDomain": "string", + "splunkToken": "string", + "splunkPort": "string", + "splunkSecure": "boolean" + } +} +``` + +**Update the sink properties of a stream of type `sumo`** + +```json +{ + "sink": { + "sumoSourceAddress": "string" + } +} +``` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.logStreams().update( + "id", + UpdateLogStreamRequestContent + .builder() + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The id of the log stream to get + +
+
+ +
+
+ +**name:** `Optional` — log stream name + +
+
+ +
+
+ +**status:** `Optional` + +
+
+ +
+
+ +**isPriority:** `Optional` — True for priority log streams, false for non-priority + +
+
+ +
+
+ +**filters:** `Optional>` — Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. + +
+
+ +
+
+ +**piiConfig:** `Optional` + +
+
+ +
+
+ +**sink:** `Optional` + +
+
+
+
+ + +
+
+
+ +## Logs +
client.logs.list() -> SyncPagingIterable&lt;Log&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +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](https://auth0.com/docs/logs/log-event-type-codes). + +**To set custom search criteria, use the following parameters:** + +- **q:** Search Criteria using [Query String Syntax](https://auth0.com/docs/logs/log-search-query-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](https://auth0.com/docs/product-lifecycle/deprecations-and-migrations/migrate-to-tenant-log-search-v3#pagination) + +For more information on the list of fields that can be used in `fields` and `sort`, see [Searchable Fields](https://auth0.com/docs/logs/log-search-query-syntax#searchable-fields). + +Auth0 [limits the number of logs](https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#limitations) 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](https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#retrieve-logs-by-checkpoint). + +**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. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.logs().list( + ListLogsRequestParameters + .builder() + .page(1) + .perPage(1) + .sort("sort") + .fields("fields") + .includeFields(true) + .includeTotals(true) + .search("search") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Optional` — Page index of the results to return. First page is 0. + +
+
+ +
+
+ +**perPage:** `Optional` — Number of results per page. Paging is disabled if parameter not sent. Default: 50. Max value: 100 + +
+
+ +
+
+ +**sort:** `Optional` — Field to use for sorting appended with :1 for ascending and :-1 for descending. e.g. date:-1 + +
+
+ +
+
+ +**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. + +
+
+ +
+
+ +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false) + +
+
+ +
+
+ +**includeTotals:** `Optional` — Return results as an array when false (default). Return results inside an object that also contains a total result count when true. + +
+
+ +
+
+ +**search:** `Optional` + +Retrieves logs that match the specified search criteria. This parameter can be combined with all the others in the /api/logs endpoint but is specified separately for clarity. +If no fields are provided a case insensitive 'starts with' search is performed on all of the following fields: client_name, connection, user_name. Otherwise, you can specify multiple fields and specify the search using the %field%:%search%, for example: application:node user:"John@contoso.com". +Values specified without quotes are matched using a case insensitive 'starts with' search. If quotes are used a case insensitve exact search is used. If multiple fields are used, the AND operator is used to join the clauses. + +
+
+
+
+ + +
+
+
+ +
client.logs.get(id) -> GetLogResponseContent +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve an individual log event. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.logs().get("id"); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — log_id of the log to retrieve. + +
+
+
+
+ + +
+
+
+ +## NetworkAcls +
client.networkAcls.list() -> SyncPagingIterable&lt;NetworkAclsResponseContent&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get all access control list entries for your client. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.networkAcls().list( + ListNetworkAclsRequestParameters + .builder() + .page(1) + .perPage(1) + .includeTotals(true) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Optional` — Use this field to request a specific page of the list results. + +
+
+ +
+
+ +**perPage:** `Optional` — The amount of results per page. + +
+
+ +
+
+ +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). + +
+
+
+
+ + +
+
+
+ +
client.networkAcls.create(request) +
+
+ +#### 📝 Description -For a `Splunk` Stream, the `sink` properties are listed in the payload below. +
+
-**Request:** -```json -{ - "name": "string", - "type": "splunk", - "sink": { - "splunkDomain": "string", - "splunkToken": "string", - "splunkPort": "string", - "splunkSecure": "boolean" - } -} -``` +
+
-**Response:** -```json -{ - "id": "string", - "name": "string", - "type": "splunk", - "status": "active", - "sink": { - "splunkDomain": "string", - "splunkToken": "string", - "splunkPort": "string", - "splunkSecure": "boolean" - } -} -``` +Create a new access control list for your client. +
+
+
+
-**Sumo Logic Stream** +#### 🔌 Usage -For a `Sumo Logic` Stream, the `sink` properties are listed in the payload below. +
+
-**Request:** -```json -{ - "name": "string", - "type": "sumo", - "sink": { - "sumoSourceAddress": "string" - } -} +
+
+ +```java +client.networkAcls().create( + CreateNetworkAclRequestContent + .builder() + .description("description") + .active(true) + .rule( + NetworkAclRule + .builder() + .action( + NetworkAclAction + .builder() + .build() + ) + .scope(NetworkAclRuleScopeEnum.MANAGEMENT) + .build() + ) + .build() +); ``` +
+
+
+
-**Response:** -```json -{ - "id": "string", - "name": "string", - "type": "sumo", - "status": "active", - "sink": { - "sumoSourceAddress": "string" - } -} +#### ⚙️ Parameters + +
+
+ +
+
+ +**description:** `String` + +
+
+ +
+
+ +**active:** `Boolean` — Indicates whether or not this access control list is actively being used + +
+
+ +
+
+ +**priority:** `Optional` — Indicates the order in which the ACL will be evaluated relative to other ACL rules. + +
+
+ +
+
+ +**rule:** `NetworkAclRule` + +
+
+
+
+ + +
+
+
+ +
client.networkAcls.get(id) -> GetNetworkAclsResponseContent +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get a specific access control list entry for your client. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.networkAcls().get("id"); ```
+#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The id of the access control list to retrieve. + +
+
+
+
+ + +
+
+
+ +
client.networkAcls.set(id, request) -> SetNetworkAclsResponseContent +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Update existing access control list for your client. +
+
+
+
+ #### 🔌 Usage
@@ -7502,19 +8794,24 @@ For a `Sumo Logic` Stream, the `sink` properties are listed in the payload below
```java -client.logStreams().create( - CreateLogStreamRequestContent.of( - CreateLogStreamHttpRequestBody - .builder() - .type(LogStreamHttpEnum.HTTP) - .sink( - LogStreamHttpSink - .builder() - .httpEndpoint("httpEndpoint") - .build() - ) - .build() - ) +client.networkAcls().set( + "id", + SetNetworkAclRequestContent + .builder() + .description("description") + .active(true) + .rule( + NetworkAclRule + .builder() + .action( + NetworkAclAction + .builder() + .build() + ) + .scope(NetworkAclRuleScopeEnum.MANAGEMENT) + .build() + ) + .build() ); ```
@@ -7522,15 +8819,47 @@ client.logStreams().create(
-#### ⚙️ Parameters - +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The id of the ACL to update. + +
+
+ +
+
+ +**description:** `String` + +
+
+ +
+
+ +**active:** `Boolean` — Indicates whether or not this access control list is actively being used + +
+
+
+**priority:** `Optional` — Indicates the order in which the ACL will be evaluated relative to other ACL rules. + +
+
+
-**request:** `CreateLogStreamRequestContent` +**rule:** `NetworkAclRule`
@@ -7542,7 +8871,7 @@ client.logStreams().create(
-
client.logStreams.get(id) -> GetLogStreamResponseContent +
client.networkAcls.delete(id)
@@ -7554,158 +8883,7 @@ client.logStreams().create(
-Retrieve a log stream configuration and status. - -**Sample responses** - -**Amazon EventBridge Log Stream** - -```json -{ - "id": "string", - "name": "string", - "type": "eventbridge", - "status": "active|paused|suspended", - "sink": { - "awsAccountId": "string", - "awsRegion": "string", - "awsPartnerEventSource": "string" - } -} -``` - -**HTTP Log Stream** - -```json -{ - "id": "string", - "name": "string", - "type": "http", - "status": "active|paused|suspended", - "sink": { - "httpContentFormat": "JSONLINES|JSONARRAY", - "httpContentType": "string", - "httpEndpoint": "string", - "httpAuthorization": "string" - } -} -``` - -**Datadog Log Stream** - -```json -{ - "id": "string", - "name": "string", - "type": "datadog", - "status": "active|paused|suspended", - "sink": { - "datadogRegion": "string", - "datadogApiKey": "string" - } -} -``` - -**Mixpanel** - -**Request:** - -```json -{ - "name": "string", - "type": "mixpanel", - "sink": { - "mixpanelRegion": "string", - "mixpanelProjectId": "string", - "mixpanelServiceAccountUsername": "string", - "mixpanelServiceAccountPassword": "string" - } -} -``` - -**Response:** - -```json -{ - "id": "string", - "name": "string", - "type": "mixpanel", - "status": "active", - "sink": { - "mixpanelRegion": "string", - "mixpanelProjectId": "string", - "mixpanelServiceAccountUsername": "string", - "mixpanelServiceAccountPassword": "string" - } -} -``` - -**Segment** - -**Request:** - -```json -{ - "name": "string", - "type": "segment", - "sink": { - "segmentWriteKey": "string" - } -} -``` - -**Response:** - -```json -{ - "id": "string", - "name": "string", - "type": "segment", - "status": "active", - "sink": { - "segmentWriteKey": "string" - } -} -``` - -**Splunk Log Stream** - -```json -{ - "id": "string", - "name": "string", - "type": "splunk", - "status": "active|paused|suspended", - "sink": { - "splunkDomain": "string", - "splunkToken": "string", - "splunkPort": "string", - "splunkSecure": "boolean" - } -} -``` - -**Sumo Logic Log Stream** - -```json -{ - "id": "string", - "name": "string", - "type": "sumo", - "status": "active|paused|suspended", - "sink": { - "sumoSourceAddress": "string" - } -} -``` - -**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. +Delete existing access control list for your client.
@@ -7720,7 +8898,7 @@ The `status` of a log stream maybe any of the following:
```java -client.logStreams().get("id"); +client.networkAcls().delete("id"); ```
@@ -7735,7 +8913,7 @@ client.logStreams().get("id");
-**id:** `String` — The id of the log stream to get +**id:** `String` — The id of the ACL to delete
@@ -7747,7 +8925,7 @@ client.logStreams().get("id");
-
client.logStreams.delete(id) +
client.networkAcls.update(id, request) -> UpdateNetworkAclResponseContent
@@ -7759,7 +8937,7 @@ client.logStreams().get("id");
-Delete a log stream. +Update existing access control list for your client.
@@ -7774,7 +8952,12 @@ Delete a log stream.
```java -client.logStreams().delete("id"); +client.networkAcls().update( + "id", + UpdateNetworkAclRequestContent + .builder() + .build() +); ```
@@ -7789,104 +8972,80 @@ client.logStreams().delete("id");
-**id:** `String` — The id of the log stream to delete +**id:** `String` — The id of the ACL to update.
- - +
+
+**description:** `Optional` +
-
-
client.logStreams.update(id, request) -> UpdateLogStreamResponseContent
-#### 📝 Description +**active:** `Optional` — Indicates whether or not this access control list is actively being used + +
+
+**priority:** `Optional` — Indicates the order in which the ACL will be evaluated relative to other ACL rules. + +
+
+
-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. +**rule:** `Optional` + +
+
+ + -**Update the status of a log stream** -```json -{ - "status": "active|paused" -} -``` + + +
-**Update the name of a log stream** +## Organizations +
client.organizations.list() -> SyncPagingIterable&lt;Organization&gt; +
+
-```json -{ - "name": "string" -} -``` +#### 📝 Description -**Update the sink properties of a stream of type `http`** +
+
-```json -{ - "sink": { - "httpEndpoint": "string", - "httpContentType": "string", - "httpContentFormat": "JSONARRAY|JSONLINES", - "httpAuthorization": "string" - } -} -``` +
+
-**Update the sink properties of a stream of type `datadog`** +Retrieve detailed list of all Organizations available in your tenant. For more information, see Auth0 Organizations. -```json -{ - "sink": { - "datadogRegion": "string", - "datadogApiKey": "string" - } -} -``` +This endpoint supports two types of pagination: -**Update the sink properties of a stream of type `splunk`** +- Offset pagination +- Checkpoint pagination -```json -{ - "sink": { - "splunkDomain": "string", - "splunkToken": "string", - "splunkPort": "string", - "splunkSecure": "boolean" - } -} -``` +Checkpoint pagination must be used if you need to retrieve more than 1000 organizations. -**Update the sink properties of a stream of type `sumo`** +**Checkpoint Pagination** -```json -{ - "sink": { - "sumoSourceAddress": "string" - } -} -``` +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.
@@ -7901,10 +9060,14 @@ Note: For log streams of type `eventbridge` and `eventgrid`, updating the `sink`
```java -client.logStreams().update( - "id", - UpdateLogStreamRequestContent +client.organizations().list( + ListOrganizationsRequestParameters .builder() + .includeTotals(true) + .from("from") + .take(1) + .sort("sort") + .includeClientAssociationFor("include_client_association_for") .build() ); ``` @@ -7921,23 +9084,7 @@ client.logStreams().update(
-**id:** `String` — The id of the log stream to get - -
-
- -
-
- -**name:** `Optional` — log stream name - -
-
- -
-
- -**status:** `Optional` +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
@@ -7945,7 +9092,7 @@ client.logStreams().update(
-**isPriority:** `Optional` — True for priority log streams, false for non-priority +**from:** `Optional` — Optional Id from which to start selection.
@@ -7953,7 +9100,7 @@ client.logStreams().update(
-**filters:** `Optional>` — Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. +**take:** `Optional` — Number of results per page. Defaults to 50.
@@ -7961,7 +9108,7 @@ client.logStreams().update(
-**piiConfig:** `Optional` +**sort:** `Optional` — Field to sort by. Use field:order where order is 1 for ascending and -1 for descending. e.g. created_at:1. We currently support sorting by the following fields: name, display_name and created_at.
@@ -7969,7 +9116,7 @@ client.logStreams().update(
-**sink:** `Optional` +**includeClientAssociationFor:** `Optional` — Client ID. When set, each returned organization that has an association with this client gains a client object describing it; organizations without one omit the field.
@@ -7981,8 +9128,7 @@ client.logStreams().update(
-## Logs -
client.logs.list() -> SyncPagingIterable&lt;Log&gt; +
client.organizations.create(request) -> CreateOrganizationResponseContent
@@ -7994,32 +9140,7 @@ client.logStreams().update(
-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](https://auth0.com/docs/logs/log-event-type-codes). - -**To set custom search criteria, use the following parameters:** - -- **q:** Search Criteria using [Query String Syntax](https://auth0.com/docs/logs/log-search-query-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](https://auth0.com/docs/product-lifecycle/deprecations-and-migrations/migrate-to-tenant-log-search-v3#pagination) - -For more information on the list of fields that can be used in `fields` and `sort`, see [Searchable Fields](https://auth0.com/docs/logs/log-search-query-syntax#searchable-fields). - -Auth0 [limits the number of logs](https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#limitations) 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](https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#retrieve-logs-by-checkpoint). - -**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. +Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review [Create Your First Organization](https://auth0.com/docs/manage-users/organizations/create-first-organization).
@@ -8034,16 +9155,10 @@ Auth0 [limits the number of logs](https://auth0.com/docs/logs/retrieve-log-event
```java -client.logs().list( - ListLogsRequestParameters +client.organizations().create( + CreateOrganizationRequestContent .builder() - .page(1) - .perPage(1) - .sort("sort") - .fields("fields") - .includeFields(true) - .includeTotals(true) - .search("search") + .name("name") .build() ); ``` @@ -8060,7 +9175,7 @@ client.logs().list(
-**page:** `Optional` — Page index of the results to return. First page is 0. +**name:** `String` — The name of this organization.
@@ -8068,7 +9183,7 @@ client.logs().list(
-**perPage:** `Optional` — Number of results per page. Paging is disabled if parameter not sent. Default: 50. Max value: 100 +**displayName:** `Optional` — Friendly name of this organization.
@@ -8076,7 +9191,7 @@ client.logs().list(
-**sort:** `Optional` — Field to use for sorting appended with :1 for ascending and :-1 for descending. e.g. date:-1 +**branding:** `Optional`
@@ -8084,7 +9199,7 @@ client.logs().list(
-**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. +**metadata:** `Optional>>`
@@ -8092,7 +9207,7 @@ client.logs().list(
-**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false) +**enabledConnections:** `Optional>` — Connections that will be enabled for this organization. See POST enabled_connections endpoint for the object format. (Max of 10 connections allowed)
@@ -8100,7 +9215,7 @@ client.logs().list(
-**includeTotals:** `Optional` — Return results as an array when false (default). Return results inside an object that also contains a total result count when true. +**tokenQuota:** `Optional`
@@ -8108,11 +9223,15 @@ client.logs().list(
-**search:** `Optional` +**thirdPartyClientAccess:** `Optional` + +
+
-Retrieves logs that match the specified search criteria. This parameter can be combined with all the others in the /api/logs endpoint but is specified separately for clarity. -If no fields are provided a case insensitive 'starts with' search is performed on all of the following fields: client_name, connection, user_name. Otherwise, you can specify multiple fields and specify the search using the %field%:%search%, for example: application:node user:"John@contoso.com". -Values specified without quotes are matched using a case insensitive 'starts with' search. If quotes are used a case insensitve exact search is used. If multiple fields are used, the AND operator is used to join the clauses. +
+
+ +**isAppEntitlementActive:** `Optional` — Whether app entitlement is active for this organization.
@@ -8124,7 +9243,7 @@ Values specified without quotes are matched using a case insensitive 'starts wit
-
client.logs.get(id) -> GetLogResponseContent +
client.organizations.getByName(name) -> GetOrganizationByNameResponseContent
@@ -8136,7 +9255,7 @@ Values specified without quotes are matched using a case insensitive 'starts wit
-Retrieve an individual log event. +Retrieve details about a single Organization specified by name.
@@ -8151,7 +9270,7 @@ Retrieve an individual log event.
```java -client.logs().get("id"); +client.organizations().getByName("name"); ```
@@ -8166,7 +9285,7 @@ client.logs().get("id");
-**id:** `String` — log_id of the log to retrieve. +**name:** `String` — name of the organization to retrieve.
@@ -8178,8 +9297,7 @@ client.logs().get("id");
-## NetworkAcls -
client.networkAcls.list() -> SyncPagingIterable&lt;NetworkAclsResponseContent&gt; +
client.organizations.get(id) -> GetOrganizationResponseContent
@@ -8191,7 +9309,7 @@ client.logs().get("id");
-Get all access control list entries for your client. +Retrieve details about a single Organization specified by ID.
@@ -8206,14 +9324,7 @@ Get all access control list entries for your client.
```java -client.networkAcls().list( - ListNetworkAclsRequestParameters - .builder() - .page(1) - .perPage(1) - .includeTotals(true) - .build() -); +client.organizations().get("id"); ```
@@ -8228,23 +9339,63 @@ client.networkAcls().list(
-**page:** `Optional` — Use this field to request a specific page of the list results. +**id:** `String` — ID of the organization to retrieve.
+ + + + + + +
+
client.organizations.delete(id)
-**perPage:** `Optional` — The amount of results per page. - +#### 📝 Description + +
+
+ +
+
+ +Remove an Organization from your tenant. This action cannot be undone. + +**Note**: Members are automatically disassociated from an Organization when it is deleted. However, this action does **not** delete these users from your tenant.
+
+
+ +#### 🔌 Usage
-**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). +
+
+ +```java +client.organizations().delete("id"); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — Organization identifier.
@@ -8256,7 +9407,7 @@ client.networkAcls().list(
-
client.networkAcls.create(request) +
client.organizations.update(id, request) -> UpdateOrganizationResponseContent
@@ -8268,7 +9419,7 @@ client.networkAcls().list(
-Create a new access control list for your client. +Update the details of a specific [Organization](https://auth0.com/docs/manage-users/organizations/configure-organizations/create-organizations), such as name and display name, branding options, and metadata.
@@ -8283,22 +9434,10 @@ Create a new access control list for your client.
```java -client.networkAcls().create( - CreateNetworkAclRequestContent +client.organizations().update( + "id", + UpdateOrganizationRequestContent .builder() - .description("description") - .active(true) - .rule( - NetworkAclRule - .builder() - .action( - NetworkAclAction - .builder() - .build() - ) - .scope(NetworkAclRuleScopeEnum.MANAGEMENT) - .build() - ) .build() ); ``` @@ -8307,15 +9446,47 @@ client.networkAcls().create(
-#### ⚙️ Parameters - +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — ID of the organization to update. + +
+
+ +
+
+ +**displayName:** `Optional` — Friendly name of this organization. + +
+
+ +
+
+ +**name:** `Optional` — The name of this organization. + +
+
+
+**branding:** `Optional` + +
+
+
-**description:** `String` +**metadata:** `Optional>>`
@@ -8323,7 +9494,7 @@ client.networkAcls().create(
-**active:** `Boolean` — Indicates whether or not this access control list is actively being used +**tokenQuota:** `Optional`
@@ -8331,7 +9502,7 @@ client.networkAcls().create(
-**priority:** `Optional` — Indicates the order in which the ACL will be evaluated relative to other ACL rules. +**thirdPartyClientAccess:** `Optional`
@@ -8339,7 +9510,7 @@ client.networkAcls().create(
-**rule:** `NetworkAclRule` +**isAppEntitlementActive:** `Optional` — Whether app entitlement is active for this organization.
@@ -8351,7 +9522,8 @@ client.networkAcls().create(
-
client.networkAcls.get(id) -> GetNetworkAclsResponseContent +## Prompts +
client.prompts.getSettings() -> GetSettingsResponseContent
@@ -8363,7 +9535,7 @@ client.networkAcls().create(
-Get a specific access control list entry for your client. +Retrieve details of the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.
@@ -8378,34 +9550,19 @@ Get a specific access control list entry for your client.
```java -client.networkAcls().get("id"); +client.prompts().getSettings(); ```
-#### ⚙️ Parameters - -
-
- -
-
- -**id:** `String` — The id of the access control list to retrieve. - -
-
-
-
-
-
client.networkAcls.set(id, request) -> SetNetworkAclsResponseContent +
client.prompts.updateSettings(request) -> UpdateSettingsResponseContent
@@ -8417,7 +9574,7 @@ client.networkAcls().get("id");
-Update existing access control list for your client. +Update the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.
@@ -8432,23 +9589,9 @@ Update existing access control list for your client.
```java -client.networkAcls().set( - "id", - SetNetworkAclRequestContent +client.prompts().updateSettings( + UpdateSettingsRequestContent .builder() - .description("description") - .active(true) - .rule( - NetworkAclRule - .builder() - .action( - NetworkAclAction - .builder() - .build() - ) - .scope(NetworkAclRuleScopeEnum.MANAGEMENT) - .build() - ) .build() ); ``` @@ -8465,23 +9608,7 @@ client.networkAcls().set(
-**id:** `String` — The id of the ACL to update. - -
-
- -
-
- -**description:** `String` - -
-
- -
-
- -**active:** `Boolean` — Indicates whether or not this access control list is actively being used +**universalLoginExperience:** `Optional`
@@ -8489,7 +9616,7 @@ client.networkAcls().set(
-**priority:** `Optional` — Indicates the order in which the ACL will be evaluated relative to other ACL rules. +**identifierFirst:** `Optional` — Whether identifier first is enabled or not
@@ -8497,7 +9624,7 @@ client.networkAcls().set(
-**rule:** `NetworkAclRule` +**webauthnPlatformFirstFactor:** `Optional` — Use WebAuthn with Device Biometrics as the first authentication factor
@@ -8509,24 +9636,11 @@ client.networkAcls().set(
-
client.networkAcls.delete(id) -
-
- -#### 📝 Description - -
-
- +## RateLimitPolicies +
client.rateLimitPolicies.list() -> SyncPagingIterable&lt;RateLimitPolicy&gt;
-Delete existing access control list for your client. -
-
-
-
- #### 🔌 Usage
@@ -8536,7 +9650,16 @@ Delete existing access control list for your client.
```java -client.networkAcls().delete("id"); +client.rateLimitPolicies().list( + ListRateLimitPoliciesRequestParameters + .builder() + .resource(RateLimitPolicyResourceEnum.OAUTH_AUTHENTICATION_API) + .consumer(RateLimitPolicyConsumerEnum.CLIENT) + .consumerSelector("consumer_selector") + .take(1) + .from("from") + .build() +); ```
@@ -8551,35 +9674,53 @@ client.networkAcls().delete("id");
-**id:** `String` — The id of the ACL to delete +**resource:** `Optional` — The API protected by the Rate Limit Policy.
-
-
+
+
+**consumer:** `Optional` — The consumer to which the rate limit policy applies. +
-
-
client.networkAcls.update(id, request) -> UpdateNetworkAclResponseContent
-#### 📝 Description +**consumerSelector:** `Optional` — Identifier or category within the consumer to which the policy applies. Supported values: `client_id:` to target a specific client by ID, `client_id:` to target a CIMD client by URI, `cimd_clients` to target all CIMD clients, `third_party_clients` to target all third-party clients, or `default` to apply the policy to any consumer identifier not otherwise explicitly targeted. + +
+
+**take:** `Optional` — Number of results per page. Defaults to 50. + +
+
+
-Update existing access control list for your client. +**from:** `Optional` — Cursor for pagination. + +
+
+ + +
+ +
client.rateLimitPolicies.create(request) -> CreateRateLimitPolicyResponseContent +
+
#### 🔌 Usage @@ -8590,10 +9731,20 @@ Update existing access control list for your client.
```java -client.networkAcls().update( - "id", - UpdateNetworkAclRequestContent +client.rateLimitPolicies().create( + CreateRateLimitPolicyRequestContent .builder() + .resource(RateLimitPolicyResourceEnum.OAUTH_AUTHENTICATION_API) + .consumer(RateLimitPolicyConsumerEnum.CLIENT) + .consumerSelector("consumer_selector") + .configuration( + RateLimitPolicyConfiguration.of( + RateLimitPolicyConfigurationZero + .builder() + .action(RateLimitPolicyConfigurationZeroAction.ALLOW) + .build() + ) + ) .build() ); ``` @@ -8610,7 +9761,7 @@ client.networkAcls().update(
-**id:** `String` — The id of the ACL to update. +**resource:** `RateLimitPolicyResourceEnum`
@@ -8618,7 +9769,7 @@ client.networkAcls().update(
-**description:** `Optional` +**consumer:** `RateLimitPolicyConsumerEnum`
@@ -8626,7 +9777,7 @@ client.networkAcls().update(
-**active:** `Optional` — Indicates whether or not this access control list is actively being used +**consumerSelector:** `String` — Identifier or category within the consumer to which the policy applies. Supported values: `client_id:` to target a specific client by ID, `client_id:` to target a CIMD client by URI, `cimd_clients` to target all CIMD clients, `third_party_clients` to target all third-party clients, or `default` to apply the policy to any consumer identifier not otherwise explicitly targeted.
@@ -8634,15 +9785,47 @@ client.networkAcls().update(
-**priority:** `Optional` — Indicates the order in which the ACL will be evaluated relative to other ACL rules. +**configuration:** `RateLimitPolicyConfiguration`
+
+
+ + + + +
+ +
client.rateLimitPolicies.get(id) -> GetRateLimitPolicyResponseContent +
+
+ +#### 🔌 Usage
-**rule:** `Optional` +
+
+ +```java +client.rateLimitPolicies().get("id"); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — Unique identifier for the Rate Limit Policy.
@@ -8654,12 +9837,11 @@ client.networkAcls().update(
-## Organizations -
client.organizations.list() -> SyncPagingIterable&lt;Organization&gt; +
client.rateLimitPolicies.delete(id)
-#### 📝 Description +#### 🔌 Usage
@@ -8667,27 +9849,37 @@ client.networkAcls().update(
-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. +```java +client.rateLimitPolicies().delete("id"); +``` +
+
+
+
-**Checkpoint Pagination** +#### ⚙️ Parameters -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. +**id:** `String` — Unique identifier for the Rate Limit Policy. + +
+
+ +
+
+ +
client.rateLimitPolicies.update(id, request) -> UpdateRateLimitPolicyResponseContent +
+
#### 🔌 Usage @@ -8698,12 +9890,18 @@ To search by checkpoint, use the following parameters:
```java -client.organizations().list( - ListOrganizationsRequestParameters +client.rateLimitPolicies().update( + "id", + PatchRateLimitPolicyRequestContent .builder() - .from("from") - .take(1) - .sort("sort") + .configuration( + PatchRateLimitPolicyConfigurationRequestContent.of( + PatchRateLimitPolicyConfigurationRequestContentZero + .builder() + .action(PatchRateLimitPolicyConfigurationRequestContentZeroAction.ALLOW) + .build() + ) + ) .build() ); ``` @@ -8720,15 +9918,7 @@ client.organizations().list(
-**from:** `Optional` — Optional Id from which to start selection. - -
-
- -
-
- -**take:** `Optional` — Number of results per page. Defaults to 50. +**id:** `String` — Unique identifier for the Rate Limit Policy.
@@ -8736,7 +9926,7 @@ client.organizations().list(
-**sort:** `Optional` — Field to sort by. Use field:order where order is 1 for ascending and -1 for descending. e.g. created_at:1. We currently support sorting by the following fields: name, display_name and created_at. +**configuration:** `PatchRateLimitPolicyConfigurationRequestContent`
@@ -8748,7 +9938,8 @@ client.organizations().list(
-
client.organizations.create(request) -> CreateOrganizationResponseContent +## RefreshTokens +
client.refreshTokens.list() -> SyncPagingIterable&lt;RefreshTokenResponseContent&gt;
@@ -8760,7 +9951,7 @@ client.organizations().list(
-Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review [Create Your First Organization](https://auth0.com/docs/manage-users/organizations/create-first-organization). +Retrieve a paginated list of refresh tokens for a specific user, with optional filtering by client ID. Results are sorted by credential_id ascending.
@@ -8775,10 +9966,15 @@ Create a new Organization within your tenant. To learn more about Organization
```java -client.organizations().create( - CreateOrganizationRequestContent +client.refreshTokens().list( + GetRefreshTokensRequestParameters .builder() - .name("name") + .userId("user_id") + .clientId("client_id") + .from("from") + .take(1) + .fields("fields") + .includeFields(true) .build() ); ``` @@ -8795,15 +9991,7 @@ client.organizations().create(
-**name:** `String` — The name of this organization. - -
-
- -
-
- -**displayName:** `Optional` — Friendly name of this organization. +**userId:** `String` — ID of the user whose refresh tokens to retrieve. Required.
@@ -8811,7 +9999,7 @@ client.organizations().create(
-**branding:** `Optional` +**clientId:** `Optional` — Filter results by client ID. Only valid when user_id is provided.
@@ -8819,7 +10007,7 @@ client.organizations().create(
-**metadata:** `Optional>>` +**from:** `Optional` — An opaque cursor from which to start the selection (exclusive). Expires after 24 hours. Obtained from the next property of a previous response.
@@ -8827,7 +10015,7 @@ client.organizations().create(
-**enabledConnections:** `Optional>` — Connections that will be enabled for this organization. See POST enabled_connections endpoint for the object format. (Max of 10 connections allowed) +**take:** `Optional` — Number of results per page. Defaults to 50.
@@ -8835,7 +10023,7 @@ client.organizations().create(
-**tokenQuota:** `Optional` +**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.
@@ -8843,7 +10031,7 @@ client.organizations().create(
-**thirdPartyClientAccess:** `Optional` +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false).
@@ -8855,7 +10043,7 @@ client.organizations().create(
-
client.organizations.getByName(name) -> GetOrganizationByNameResponseContent +
client.refreshTokens.revoke(request)
@@ -8867,7 +10055,7 @@ client.organizations().create(
-Retrieve details about a single Organization specified by name. +Revoke refresh tokens in bulk by ID list, user, user+client, or user+client+audience.
@@ -8882,7 +10070,11 @@ Retrieve details about a single Organization specified by name.
```java -client.organizations().getByName("name"); +client.refreshTokens().revoke( + RevokeRefreshTokensRequestContent + .builder() + .build() +); ```
@@ -8897,7 +10089,31 @@ client.organizations().getByName("name");
-**name:** `String` — name of the organization to retrieve. +**ids:** `Optional>` — Array of refresh token IDs to revoke. Limited to 100 at a time. + +
+
+ +
+
+ +**userId:** `Optional` — Revoke all refresh tokens for this user. + +
+
+ +
+
+ +**clientId:** `Optional` — Revoke refresh tokens for this client. Must be paired with `user_id`; optionally narrowed further with `audience`. + +
+
+ +
+
+ +**audience:** `Optional` — Resource server identifier (audience) to scope the revocation. Must be used with both `user_id` and `client_id`.
@@ -8909,7 +10125,7 @@ client.organizations().getByName("name");
-
client.organizations.get(id) -> GetOrganizationResponseContent +
client.refreshTokens.get(id) -> GetRefreshTokenResponseContent
@@ -8921,7 +10137,7 @@ client.organizations().getByName("name");
-Retrieve details about a single Organization specified by ID. +Retrieve refresh token information.
@@ -8936,7 +10152,7 @@ Retrieve details about a single Organization specified by ID.
```java -client.organizations().get("id"); +client.refreshTokens().get("id"); ```
@@ -8951,7 +10167,7 @@ client.organizations().get("id");
-**id:** `String` — ID of the organization to retrieve. +**id:** `String` — ID refresh token to retrieve
@@ -8963,7 +10179,7 @@ client.organizations().get("id");
-
client.organizations.delete(id) +
client.refreshTokens.delete(id)
@@ -8975,9 +10191,7 @@ client.organizations().get("id");
-Remove an Organization from your tenant. This action cannot be undone. - -**Note**: Members are automatically disassociated from an Organization when it is deleted. However, this action does **not** delete these users from your tenant. +Delete a refresh token by its ID.
@@ -8992,7 +10206,7 @@ Remove an Organization from your tenant. This action cannot be undone.
```java -client.organizations().delete("id"); +client.refreshTokens().delete("id"); ```
@@ -9007,7 +10221,7 @@ client.organizations().delete("id");
-**id:** `String` — Organization identifier. +**id:** `String` — ID of the refresh token to delete.
@@ -9019,7 +10233,7 @@ client.organizations().delete("id");
-
client.organizations.update(id, request) -> UpdateOrganizationResponseContent +
client.refreshTokens.update(id, request) -> UpdateRefreshTokenResponseContent
@@ -9031,7 +10245,7 @@ client.organizations().delete("id");
-Update the details of a specific [Organization](https://auth0.com/docs/manage-users/organizations/configure-organizations/create-organizations), such as name and display name, branding options, and metadata. +Update a refresh token by its ID.
@@ -9046,9 +10260,9 @@ Update the details of a specific [Organization](https://auth0.com/docs/manage-us
```java -client.organizations().update( +client.refreshTokens().update( "id", - UpdateOrganizationRequestContent + UpdateRefreshTokenRequestContent .builder() .build() ); @@ -9066,47 +10280,7 @@ client.organizations().update(
-**id:** `String` — ID of the organization to update. - -
-
- -
-
- -**displayName:** `Optional` — Friendly name of this organization. - -
-
- -
-
- -**name:** `Optional` — The name of this organization. - -
-
- -
-
- -**branding:** `Optional` - -
-
- -
-
- -**metadata:** `Optional>>` - -
-
- -
-
- -**tokenQuota:** `Optional` +**id:** `String` — ID of the refresh token to update.
@@ -9114,7 +10288,7 @@ client.organizations().update(
-**thirdPartyClientAccess:** `Optional` +**refreshTokenMetadata:** `Optional>` — Metadata associated with the refresh token. Pass null or {} to remove all metadata.
@@ -9126,8 +10300,8 @@ client.organizations().update(
-## Prompts -
client.prompts.getSettings() -> GetSettingsResponseContent +## ResourceServers +
client.resourceServers.list() -> SyncPagingIterable&lt;ResourceServer&gt;
@@ -9139,7 +10313,7 @@ client.organizations().update(
-Retrieve details of the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features. +Retrieve details of all APIs associated with your tenant.
@@ -9154,23 +10328,25 @@ Retrieve details of the Universal Login configuration of your tenant. This inclu
```java -client.prompts().getSettings(); +client.resourceServers().list( + ListResourceServerRequestParameters + .builder() + .page(1) + .perPage(1) + .includeTotals(true) + .includeFields(true) + .identifiers( + Arrays.asList("identifiers") + ) + .build() +); ```
- - - -
- -
client.prompts.updateSettings(request) -> UpdateSettingsResponseContent -
-
- -#### 📝 Description +#### ⚙️ Parameters
@@ -9178,41 +10354,23 @@ client.prompts().getSettings();
-Update the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features. -
-
+**identifiers:** `Optional` — An optional filter on the resource server identifier. Must be URL encoded and may be specified multiple times (max 10).
e.g. ../resource-servers?identifiers=id1&identifiers=id2 +
-#### 🔌 Usage - -
-
-
-```java -client.prompts().updateSettings( - UpdateSettingsRequestContent - .builder() - .build() -); -``` -
-
+**page:** `Optional` — Page index of the results to return. First page is 0. +
-#### ⚙️ Parameters - -
-
-
-**universalLoginExperience:** `Optional` +**perPage:** `Optional` — Number of results per page.
@@ -9220,7 +10378,7 @@ client.prompts().updateSettings(
-**identifierFirst:** `Optional` — Whether identifier first is enabled or not +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
@@ -9228,7 +10386,7 @@ client.prompts().updateSettings(
-**webauthnPlatformFirstFactor:** `Optional` — Use WebAuthn with Device Biometrics as the first authentication factor +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false).
@@ -9240,11 +10398,24 @@ client.prompts().updateSettings(
-## RateLimitPolicies -
client.rateLimitPolicies.list() -> SyncPagingIterable&lt;RateLimitPolicy&gt; +
client.resourceServers.create(request) -> CreateResourceServerResponseContent +
+
+ +#### 📝 Description + +
+
+
+Create a new API associated with your tenant. Note that all new APIs must be registered with Auth0. For more information, read APIs. +
+
+
+
+ #### 🔌 Usage
@@ -9254,14 +10425,10 @@ client.prompts().updateSettings(
```java -client.rateLimitPolicies().list( - ListRateLimitPoliciesRequestParameters +client.resourceServers().create( + CreateResourceServerRequestContent .builder() - .resource(RateLimitPolicyResourceEnum.OAUTH_AUTHENTICATION_API) - .consumer(RateLimitPolicyConsumerEnum.CLIENT) - .consumerSelector("consumer_selector") - .take(1) - .from("from") + .identifier("identifier") .build() ); ``` @@ -9278,7 +10445,23 @@ client.rateLimitPolicies().list(
-**resource:** `Optional` — The API protected by the Rate Limit Policy. +**name:** `Optional` — Friendly name for this resource server. Can not contain `<` or `>` characters. + +
+
+ +
+
+ +**identifier:** `String` — Unique identifier for the API used as the audience parameter on authorization calls. Can not be changed once set. + +
+
+ +
+
+ +**scopes:** `Optional>` — List of permissions (scopes) that this API uses.
@@ -9286,7 +10469,7 @@ client.rateLimitPolicies().list(
-**consumer:** `Optional` — The consumer to which the rate limit policy applies. +**signingAlg:** `Optional`
@@ -9294,7 +10477,7 @@ client.rateLimitPolicies().list(
-**consumerSelector:** `Optional` — Identifier or category within the consumer to which the policy applies. Supported values: `client_id:` to target a specific client by ID, `client_id:` to target a CIMD client by URI, `cimd_clients` to target all CIMD clients, `third_party_clients` to target all third-party clients, or `default` to apply the policy to any consumer identifier not otherwise explicitly targeted. +**signingSecret:** `Optional` — Secret used to sign tokens when using symmetric algorithms (HS256).
@@ -9302,7 +10485,7 @@ client.rateLimitPolicies().list(
-**take:** `Optional` — Number of results per page. Defaults to 50. +**allowOfflineAccess:** `Optional` — Whether refresh tokens can be issued for this API (true) or not (false).
@@ -9310,62 +10493,71 @@ client.rateLimitPolicies().list(
-**from:** `Optional` — Cursor for pagination. +**allowOnlineAccess:** `Optional` — Whether Online Refresh Tokens can be issued for this API (true) or not (false).
+ +
+
+ +**allowOnlineAccessWithEphemeralSessions:** `Optional` — Whether Online Refresh Tokens can be issued even when sessions are configured as ephemeral (true) or not (false). +
+
+
+**tokenLifetime:** `Optional` — Expiration value (in seconds) for access tokens issued for this API from the token endpoint. +
-
-
client.rateLimitPolicies.create(request) -> CreateRateLimitPolicyResponseContent
-#### 🔌 Usage +**tokenDialect:** `Optional` + +
+
+**skipConsentForVerifiableFirstPartyClients:** `Optional` — Whether to skip user consent for applications flagged as first party (true) or not (false). + +
+
+
-```java -client.rateLimitPolicies().create( - CreateRateLimitPolicyRequestContent - .builder() - .resource(RateLimitPolicyResourceEnum.OAUTH_AUTHENTICATION_API) - .consumer(RateLimitPolicyConsumerEnum.CLIENT) - .consumerSelector("consumer_selector") - .configuration( - RateLimitPolicyConfiguration.of( - RateLimitPolicyConfigurationZero - .builder() - .action(RateLimitPolicyConfigurationZeroAction.ALLOW) - .build() - ) - ) - .build() -); -``` +**enforcePolicies:** `Optional` — Whether to enforce authorization policies (true) or to ignore them (false). +
+ +
+
+ +**tokenEncryption:** `Optional` +
-#### ⚙️ Parameters -
+**consentPolicy:** `Optional` + +
+
+
-**resource:** `RateLimitPolicyResourceEnum` +**authorizationDetails:** `Optional>`
@@ -9373,7 +10565,7 @@ client.rateLimitPolicies().create(
-**consumer:** `RateLimitPolicyConsumerEnum` +**proofOfPossession:** `Optional`
@@ -9381,7 +10573,7 @@ client.rateLimitPolicies().create(
-**consumerSelector:** `String` — Identifier or category within the consumer to which the policy applies. Supported values: `client_id:` to target a specific client by ID, `client_id:` to target a CIMD client by URI, `cimd_clients` to target all CIMD clients, `third_party_clients` to target all third-party clients, or `default` to apply the policy to any consumer identifier not otherwise explicitly targeted. +**subjectTypeAuthorization:** `Optional`
@@ -9389,7 +10581,7 @@ client.rateLimitPolicies().create(
-**configuration:** `RateLimitPolicyConfiguration` +**authorizationPolicy:** `Optional`
@@ -9401,11 +10593,11 @@ client.rateLimitPolicies().create(
-
client.rateLimitPolicies.get(id) -> GetRateLimitPolicyResponseContent +
client.resourceServers.get(id) -> GetResourceServerResponseContent
-#### 🔌 Usage +#### 📝 Description
@@ -9413,15 +10605,13 @@ client.rateLimitPolicies().create(
-```java -client.rateLimitPolicies().get("id"); -``` +Retrieve API details with the given ID.
-#### ⚙️ Parameters +#### 🔌 Usage
@@ -9429,23 +10619,21 @@ client.rateLimitPolicies().get("id");
-**id:** `String` — Unique identifier for the Rate Limit Policy. - -
-
+```java +client.resourceServers().get( + "id", + GetResourceServerRequestParameters + .builder() + .includeFields(true) + .build() +); +```
- -
-
- -
client.rateLimitPolicies.delete(id) -
-
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -9453,23 +10641,15 @@ client.rateLimitPolicies().get("id");
-```java -client.rateLimitPolicies().delete("id"); -``` -
-
+**id:** `String` — ID or audience of the resource server to retrieve. +
-#### ⚙️ Parameters -
-
-
- -**id:** `String` — Unique identifier for the Rate Limit Policy. +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false).
@@ -9481,11 +10661,11 @@ client.rateLimitPolicies().delete("id");
-
client.rateLimitPolicies.update(id, request) -> UpdateRateLimitPolicyResponseContent +
client.resourceServers.delete(id)
-#### 🔌 Usage +#### 📝 Description
@@ -9493,28 +10673,13 @@ client.rateLimitPolicies().delete("id");
-```java -client.rateLimitPolicies().update( - "id", - PatchRateLimitPolicyRequestContent - .builder() - .configuration( - PatchRateLimitPolicyConfigurationRequestContent.of( - PatchRateLimitPolicyConfigurationRequestContentZero - .builder() - .action(PatchRateLimitPolicyConfigurationRequestContentZeroAction.ALLOW) - .build() - ) - ) - .build() -); -``` +Delete an existing API by ID. For more information, read API Settings.
-#### ⚙️ Parameters +#### 🔌 Usage
@@ -9522,15 +10687,23 @@ client.rateLimitPolicies().update(
-**id:** `String` — Unique identifier for the Rate Limit Policy. - +```java +client.resourceServers().delete("id"); +``` +
+
+#### ⚙️ Parameters +
-**configuration:** `PatchRateLimitPolicyConfigurationRequestContent` +
+
+ +**id:** `String` — ID or the audience of the resource server to delete.
@@ -9542,8 +10715,7 @@ client.rateLimitPolicies().update(
-## RefreshTokens -
client.refreshTokens.list() -> SyncPagingIterable&lt;RefreshTokenResponseContent&gt; +
client.resourceServers.update(id, request) -> UpdateResourceServerResponseContent
@@ -9555,7 +10727,7 @@ client.rateLimitPolicies().update(
-Retrieve a paginated list of refresh tokens for a specific user, with optional filtering by client ID. Results are sorted by credential_id ascending. +Change an existing API setting by resource server ID. For more information, read API Settings.
@@ -9570,15 +10742,10 @@ Retrieve a paginated list of refresh tokens for a specific user, with optional f
```java -client.refreshTokens().list( - GetRefreshTokensRequestParameters +client.resourceServers().update( + "id", + UpdateResourceServerRequestContent .builder() - .userId("user_id") - .clientId("client_id") - .from("from") - .take(1) - .fields("fields") - .includeFields(true) .build() ); ``` @@ -9595,7 +10762,7 @@ client.refreshTokens().list(
-**userId:** `String` — ID of the user whose refresh tokens to retrieve. Required. +**id:** `String` — ID or audience of the resource server to update.
@@ -9603,7 +10770,7 @@ client.refreshTokens().list(
-**clientId:** `Optional` — Filter results by client ID. Only valid when user_id is provided. +**name:** `Optional` — Friendly name for this resource server. Can not contain `<` or `>` characters.
@@ -9611,7 +10778,7 @@ client.refreshTokens().list(
-**from:** `Optional` — An opaque cursor from which to start the selection (exclusive). Expires after 24 hours. Obtained from the next property of a previous response. +**scopes:** `Optional>` — List of permissions (scopes) that this API uses.
@@ -9619,7 +10786,7 @@ client.refreshTokens().list(
-**take:** `Optional` — Number of results per page. Defaults to 50. +**signingAlg:** `Optional`
@@ -9627,7 +10794,7 @@ client.refreshTokens().list(
-**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. +**signingSecret:** `Optional` — Secret used to sign tokens when using symmetric algorithms (HS256).
@@ -9635,65 +10802,31 @@ client.refreshTokens().list(
-**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). +**skipConsentForVerifiableFirstPartyClients:** `Optional` — Whether to skip user consent for applications flagged as first party (true) or not (false).
-
-
- - - - -
- -
client.refreshTokens.revoke(request) -
-
- -#### 📝 Description - -
-
-Revoke refresh tokens in bulk by ID list, user, user+client, or user+client+audience. -
-
+**allowOfflineAccess:** `Optional` — Whether refresh tokens can be issued for this API (true) or not (false). +
-#### 🔌 Usage - -
-
-
-```java -client.refreshTokens().revoke( - RevokeRefreshTokensRequestContent - .builder() - .build() -); -``` -
-
+**allowOnlineAccess:** `Optional` — Whether Online Refresh Tokens can be issued for this API (true) or not (false). +
-#### ⚙️ Parameters - -
-
-
-**ids:** `Optional>` — Array of refresh token IDs to revoke. Limited to 100 at a time. +**allowOnlineAccessWithEphemeralSessions:** `Optional` — Whether Online Refresh Tokens can be issued even when sessions are configured as ephemeral (true) or not (false).
@@ -9701,7 +10834,7 @@ client.refreshTokens().revoke(
-**userId:** `Optional` — Revoke all refresh tokens for this user. +**tokenLifetime:** `Optional` — Expiration value (in seconds) for access tokens issued for this API from the token endpoint.
@@ -9709,7 +10842,7 @@ client.refreshTokens().revoke(
-**clientId:** `Optional` — Revoke refresh tokens for this client. Must be paired with `user_id`; optionally narrowed further with `audience`. +**tokenDialect:** `Optional`
@@ -9717,61 +10850,55 @@ client.refreshTokens().revoke(
-**audience:** `Optional` — Resource server identifier (audience) to scope the revocation. Must be used with both `user_id` and `client_id`. +**enforcePolicies:** `Optional` — Whether authorization policies are enforced (true) or not enforced (false).
-
-
- - -
-
-
- -
client.refreshTokens.get(id) -> GetRefreshTokenResponseContent -
-
- -#### 📝 Description - -
-
-Retrieve refresh token information. -
-
+**tokenEncryption:** `Optional` +
-#### 🔌 Usage -
+**consentPolicy:** `Optional` + +
+
+
-```java -client.refreshTokens().get("id"); -``` +**authorizationDetails:** `Optional>` +
+ +
+
+ +**proofOfPossession:** `Optional` +
-#### ⚙️ Parameters -
+**subjectTypeAuthorization:** `Optional` + +
+
+
-**id:** `String` — ID refresh token to retrieve +**authorizationPolicy:** `Optional`
@@ -9783,7 +10910,8 @@ client.refreshTokens().get("id");
-
client.refreshTokens.delete(id) +## Roles +
client.roles.list() -> SyncPagingIterable&lt;Role&gt;
@@ -9795,7 +10923,9 @@ client.refreshTokens().get("id");
-Delete a refresh token by its ID. +Retrieve detailed list of user roles created in your tenant. + +**Note**: The returned list does not include standard roles available for tenant members, such as Admin or Support Access.
@@ -9810,7 +10940,17 @@ Delete a refresh token by its ID.
```java -client.refreshTokens().delete("id"); +client.roles().list( + ListRolesRequestParameters + .builder() + .perPage(1) + .page(1) + .includeTotals(true) + .nameFilter("name_filter") + .type(RoleTypeEnum.TENANT) + .ownerId("owner_id") + .build() +); ```
@@ -9825,66 +10965,39 @@ client.refreshTokens().delete("id");
-**id:** `String` — ID of the refresh token to delete. +**perPage:** `Optional` — Number of results per page. Defaults to 50.
- - - - - - -
-
client.refreshTokens.update(id, request) -> UpdateRefreshTokenResponseContent
-#### 📝 Description - -
-
+**page:** `Optional` — Page index of the results to return. First page is 0. + +
+
-Update a refresh token by its ID. -
-
+**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). +
-#### 🔌 Usage - -
-
-
-```java -client.refreshTokens().update( - "id", - UpdateRefreshTokenRequestContent - .builder() - .build() -); -``` -
-
+**nameFilter:** `Optional` — Optional filter on name (case-insensitive). +
-#### ⚙️ Parameters - -
-
-
-**id:** `String` — ID of the refresh token to update. +**type:** `Optional` — Optional filter on the type of the role
@@ -9892,7 +11005,7 @@ client.refreshTokens().update(
-**refreshTokenMetadata:** `Optional>` — Metadata associated with the refresh token. Pass null or {} to remove all metadata. +**ownerId:** `Optional` — Filter organization-level roles by owner ID. Required when type is "organization".
@@ -9904,8 +11017,7 @@ client.refreshTokens().update(
-## ResourceServers -
client.resourceServers.list() -> SyncPagingIterable&lt;ResourceServer&gt; +
client.roles.create(request) -> CreateRoleResponseContent
@@ -9917,7 +11029,9 @@ client.refreshTokens().update(
-Retrieve details of all APIs associated with your tenant. +Create a user role for [Role-Based Access Control](https://auth0.com/docs/manage-users/access-control/rbac). + +**Note**: New roles are not associated with any permissions by default. To assign existing permissions to your role, review Associate Permissions with a Role. To create new permissions, review Add API Permissions.
@@ -9932,16 +11046,10 @@ Retrieve details of all APIs associated with your tenant.
```java -client.resourceServers().list( - ListResourceServerRequestParameters +client.roles().create( + CreateRoleRequestContent .builder() - .page(1) - .perPage(1) - .includeTotals(true) - .includeFields(true) - .identifiers( - Arrays.asList("identifiers") - ) + .name("name") .build() ); ``` @@ -9958,15 +11066,7 @@ client.resourceServers().list(
-**identifiers:** `Optional` — An optional filter on the resource server identifier. Must be URL encoded and may be specified multiple times (max 10).
e.g. ../resource-servers?identifiers=id1&identifiers=id2 - -
-
- -
-
- -**page:** `Optional` — Page index of the results to return. First page is 0. +**name:** `String` — Name of the role.
@@ -9974,7 +11074,7 @@ client.resourceServers().list(
-**perPage:** `Optional` — Number of results per page. +**description:** `Optional` — Description of the role.
@@ -9982,7 +11082,7 @@ client.resourceServers().list(
-**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). +**type:** `Optional` — The type of the role. Defaults to tenant.
@@ -9990,7 +11090,7 @@ client.resourceServers().list(
-**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). +**ownerId:** `Optional` — The ID of the organization that owns this role. Required when type is "organization".
@@ -10002,7 +11102,7 @@ client.resourceServers().list(
-
client.resourceServers.create(request) -> CreateResourceServerResponseContent +
client.roles.get(id) -> GetRoleResponseContent
@@ -10014,7 +11114,7 @@ client.resourceServers().list(
-Create a new API associated with your tenant. Note that all new APIs must be registered with Auth0. For more information, read APIs. +Retrieve details about a specific [user role](https://auth0.com/docs/manage-users/access-control/rbac) specified by ID.
@@ -10029,12 +11129,7 @@ Create a new API associated with your tenant. Note that all new APIs must be reg
```java -client.resourceServers().create( - CreateResourceServerRequestContent - .builder() - .identifier("identifier") - .build() -); +client.roles().get("id"); ```
@@ -10049,127 +11144,120 @@ client.resourceServers().create(
-**name:** `Optional` — Friendly name for this resource server. Can not contain `<` or `>` characters. +**id:** `String` — ID of the role to retrieve.
+ + -
-
-**identifier:** `String` — Unique identifier for the API used as the audience parameter on authorization calls. Can not be changed once set. -
+
+
client.roles.delete(id)
-**scopes:** `Optional>` — List of permissions (scopes) that this API uses. - -
-
+#### 📝 Description
-**signingAlg:** `Optional` - -
-
-
-**signingSecret:** `Optional` — Secret used to sign tokens when using symmetric algorithms (HS256). - +Delete a specific [user role](https://auth0.com/docs/manage-users/access-control/rbac) from your tenant. Once deleted, it is removed from any user who was previously assigned that role. This action cannot be undone. +
+
+#### 🔌 Usage +
-**allowOfflineAccess:** `Optional` — Whether refresh tokens can be issued for this API (true) or not (false). - -
-
-
-**allowOnlineAccess:** `Optional` — Whether Online Refresh Tokens can be issued for this API (true) or not (false). - +```java +client.roles().delete("id"); +``` +
+
+#### ⚙️ Parameters +
-**allowOnlineAccessWithEphemeralSessions:** `Optional` — Whether Online Refresh Tokens can be issued even when sessions are configured as ephemeral (true) or not (false). - -
-
-
-**tokenLifetime:** `Optional` — Expiration value (in seconds) for access tokens issued for this API from the token endpoint. +**id:** `String` — ID of the role to delete.
+ + -
-
-**tokenDialect:** `Optional` -
+
+
client.roles.update(id, request) -> UpdateRoleResponseContent
-**skipConsentForVerifiableFirstPartyClients:** `Optional` — Whether to skip user consent for applications flagged as first party (true) or not (false). - -
-
+#### 📝 Description
-**enforcePolicies:** `Optional` — Whether to enforce authorization policies (true) or to ignore them (false). - -
-
-
-**tokenEncryption:** `Optional` - +Modify the details of a specific [user role](https://auth0.com/docs/manage-users/access-control/rbac) specified by ID. +
+
+#### 🔌 Usage +
-**consentPolicy:** `Optional` - -
-
-
-**authorizationDetails:** `Optional>` - +```java +client.roles().update( + "id", + UpdateRoleRequestContent + .builder() + .build() +); +```
+ + + +#### ⚙️ Parameters
-**proofOfPossession:** `Optional` +
+
+ +**id:** `String` — ID of the role to update.
@@ -10177,7 +11265,7 @@ client.resourceServers().create(
-**subjectTypeAuthorization:** `Optional` +**name:** `Optional` — Name of this role.
@@ -10185,7 +11273,7 @@ client.resourceServers().create(
-**authorizationPolicy:** `Optional` +**description:** `Optional` — Description of this role.
@@ -10197,7 +11285,8 @@ client.resourceServers().create(
-
client.resourceServers.get(id) -> GetResourceServerResponseContent +## Rules +
client.rules.list() -> SyncPagingIterable&lt;Rule&gt;
@@ -10209,7 +11298,7 @@ client.resourceServers().create(
-Retrieve API details with the given ID. +Retrieve a filtered list of [rules](https://auth0.com/docs/rules). Accepts a list of fields to include or exclude.
@@ -10224,10 +11313,14 @@ Retrieve API details with the given ID
```java -client.resourceServers().get( - "id", - GetResourceServerRequestParameters +client.rules().list( + ListRulesRequestParameters .builder() + .page(1) + .perPage(1) + .includeTotals(true) + .enabled(true) + .fields("fields") .includeFields(true) .build() ); @@ -10245,7 +11338,7 @@ client.resourceServers().get(
-**id:** `String` — ID or audience of the resource server to retrieve. +**page:** `Optional` — Page index of the results to return. First page is 0.
@@ -10253,61 +11346,39 @@ client.resourceServers().get(
-**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). +**perPage:** `Optional` — Number of results per page.
-
-
- - - - -
-
client.resourceServers.delete(id)
-#### 📝 Description - -
-
+**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). + +
+
-Delete an existing API by ID. For more information, read API Settings. -
-
+**enabled:** `Optional` — Optional filter on whether a rule is enabled (true) or disabled (false). +
-#### 🔌 Usage - -
-
-
-```java -client.resourceServers().delete("id"); -``` -
-
+**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. +
-#### ⚙️ Parameters - -
-
-
-**id:** `String` — ID or the audience of the resource server to delete. +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false).
@@ -10319,7 +11390,7 @@ client.resourceServers().delete("id");
-
client.resourceServers.update(id, request) -> UpdateResourceServerResponseContent +
client.rules.create(request) -> CreateRuleResponseContent
@@ -10331,7 +11402,9 @@ client.resourceServers().delete("id");
-Change an existing API setting by resource server ID. For more information, read API Settings. +Create a [new rule](https://auth0.com/docs/rules#create-a-new-rule-using-the-management-api). + +Note: Changing a rule's stage of execution from the default `login_success` can change the rule's function signature to have user omitted.
@@ -10346,10 +11419,11 @@ Change an existing API setting by resource server ID. For more information, read
```java -client.resourceServers().update( - "id", - UpdateResourceServerRequestContent +client.rules().create( + CreateRuleRequestContent .builder() + .name("name") + .script("script") .build() ); ``` @@ -10366,7 +11440,7 @@ client.resourceServers().update(
-**id:** `String` — ID or audience of the resource server to update. +**name:** `String` — Name of this rule.
@@ -10374,7 +11448,7 @@ client.resourceServers().update(
-**name:** `Optional` — Friendly name for this resource server. Can not contain `<` or `>` characters. +**script:** `String` — Code to be executed when this rule runs.
@@ -10382,7 +11456,7 @@ client.resourceServers().update(
-**scopes:** `Optional>` — List of permissions (scopes) that this API uses. +**order:** `Optional` — Order that this rule should execute in relative to other rules. Lower-valued rules execute first.
@@ -10390,63 +11464,68 @@ client.resourceServers().update(
-**signingAlg:** `Optional` +**enabled:** `Optional` — Whether the rule is enabled (true), or disabled (false).
+
+
-
-
-**signingSecret:** `Optional` — Secret used to sign tokens when using symmetric algorithms (HS256). -
+
+
client.rules.get(id) -> GetRuleResponseContent
-**skipConsentForVerifiableFirstPartyClients:** `Optional` — Whether to skip user consent for applications flagged as first party (true) or not (false). - -
-
+#### 📝 Description
-**allowOfflineAccess:** `Optional` — Whether refresh tokens can be issued for this API (true) or not (false). - -
-
-
-**allowOnlineAccess:** `Optional` — Whether Online Refresh Tokens can be issued for this API (true) or not (false). - +Retrieve [rule](https://auth0.com/docs/rules) details. Accepts a list of fields to include or exclude in the result. +
+
+#### 🔌 Usage +
-**allowOnlineAccessWithEphemeralSessions:** `Optional` — Whether Online Refresh Tokens can be issued even when sessions are configured as ephemeral (true) or not (false). - -
-
-
-**tokenLifetime:** `Optional` — Expiration value (in seconds) for access tokens issued for this API from the token endpoint. - +```java +client.rules().get( + "id", + GetRuleRequestParameters + .builder() + .fields("fields") + .includeFields(true) + .build() +); +``` +
+
+#### ⚙️ Parameters +
-**tokenDialect:** `Optional` +
+
+ +**id:** `String` — ID of the rule to retrieve.
@@ -10454,7 +11533,7 @@ client.resourceServers().update(
-**enforcePolicies:** `Optional` — Whether authorization policies are enforced (true) or not enforced (false). +**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.
@@ -10462,47 +11541,61 @@ client.resourceServers().update(
-**tokenEncryption:** `Optional` +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false).
+
+
-
-
-**consentPolicy:** `Optional` -
+
+
client.rules.delete(id)
-**authorizationDetails:** `Optional>` - -
-
+#### 📝 Description
-**proofOfPossession:** `Optional` - +
+
+ +Delete a rule. +
+
+#### 🔌 Usage +
-**subjectTypeAuthorization:** `Optional` - +
+
+ +```java +client.rules().delete("id"); +``` +
+
+#### ⚙️ Parameters +
-**authorizationPolicy:** `Optional` +
+
+ +**id:** `String` — ID of the rule to delete.
@@ -10514,8 +11607,7 @@ client.resourceServers().update(
-## Roles -
client.roles.list() -> SyncPagingIterable&lt;Role&gt; +
client.rules.update(id, request) -> UpdateRuleResponseContent
@@ -10527,9 +11619,7 @@ client.resourceServers().update(
-Retrieve detailed list of user roles created in your tenant. - -**Note**: The returned list does not include standard roles available for tenant members, such as Admin or Support Access. +Update an existing rule.
@@ -10544,13 +11634,10 @@ Retrieve detailed list of user roles created in your tenant.
```java -client.roles().list( - ListRolesRequestParameters +client.rules().update( + "id", + UpdateRuleRequestContent .builder() - .perPage(1) - .page(1) - .includeTotals(true) - .nameFilter("name_filter") .build() ); ``` @@ -10567,7 +11654,7 @@ client.roles().list(
-**perPage:** `Optional` — Number of results per page. Defaults to 50. +**id:** `String` — ID of the rule to retrieve.
@@ -10575,7 +11662,7 @@ client.roles().list(
-**page:** `Optional` — Page index of the results to return. First page is 0. +**script:** `Optional` — Code to be executed when this rule runs.
@@ -10583,7 +11670,7 @@ client.roles().list(
-**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). +**name:** `Optional` — Name of this rule.
@@ -10591,7 +11678,15 @@ client.roles().list(
-**nameFilter:** `Optional` — Optional filter on name (case-insensitive). +**order:** `Optional` — Order that this rule should execute in relative to other rules. Lower-valued rules execute first. + +
+
+ +
+
+ +**enabled:** `Optional` — Whether the rule is enabled (true), or disabled (false).
@@ -10603,7 +11698,8 @@ client.roles().list(
-
client.roles.create(request) -> CreateRoleResponseContent +## RulesConfigs +
client.rulesConfigs.list() -> List&lt;RulesConfig&gt;
@@ -10615,9 +11711,9 @@ client.roles().list(
-Create a user role for [Role-Based Access Control](https://auth0.com/docs/manage-users/access-control/rbac). +Retrieve rules config variable keys. -**Note**: New roles are not associated with any permissions by default. To assign existing permissions to your role, review Associate Permissions with a Role. To create new permissions, review Add API Permissions. + Note: For security, config variable values cannot be retrieved outside rule execution.
@@ -10632,47 +11728,19 @@ Create a user role for [Role-Based Access Control](https://auth0.com/docs/manage
```java -client.roles().create( - CreateRoleRequestContent - .builder() - .name("name") - .build() -); +client.rulesConfigs().list(); ```
-#### ⚙️ Parameters - -
-
- -
-
- -**name:** `String` — Name of the role. - -
-
- -
-
- -**description:** `Optional` — Description of the role. - -
-
-
-
-
-
client.roles.get(id) -> GetRoleResponseContent +
client.rulesConfigs.set(key, request) -> SetRulesConfigResponseContent
@@ -10684,7 +11752,7 @@ client.roles().create(
-Retrieve details about a specific [user role](https://auth0.com/docs/manage-users/access-control/rbac) specified by ID. +Sets a rules config variable.
@@ -10699,7 +11767,13 @@ Retrieve details about a specific [user role](https://auth0.com/docs/manage-user
```java -client.roles().get("id"); +client.rulesConfigs().set( + "key", + SetRulesConfigRequestContent + .builder() + .value("value") + .build() +); ```
@@ -10714,7 +11788,15 @@ client.roles().get("id");
-**id:** `String` — ID of the role to retrieve. +**key:** `String` — Key of the rules config variable to set (max length: 127 characters). + +
+
+ +
+
+ +**value:** `String` — Value for a rules config variable.
@@ -10726,7 +11808,7 @@ client.roles().get("id");
-
client.roles.delete(id) +
client.rulesConfigs.delete(key)
@@ -10738,7 +11820,7 @@ client.roles().get("id");
-Delete a specific [user role](https://auth0.com/docs/manage-users/access-control/rbac) from your tenant. Once deleted, it is removed from any user who was previously assigned that role. This action cannot be undone. +Delete a rules config variable identified by its key.
@@ -10753,7 +11835,7 @@ Delete a specific [user role](https://auth0.com/docs/manage-users/access-control
```java -client.roles().delete("id"); +client.rulesConfigs().delete("key"); ```
@@ -10768,7 +11850,7 @@ client.roles().delete("id");
-**id:** `String` — ID of the role to delete. +**key:** `String` — Key of the rules config variable to delete.
@@ -10780,7 +11862,8 @@ client.roles().delete("id");
-
client.roles.update(id, request) -> UpdateRoleResponseContent +## SelfServiceProfiles +
client.selfServiceProfiles.list() -> SyncPagingIterable&lt;SelfServiceProfile&gt;
@@ -10792,7 +11875,7 @@ client.roles().delete("id");
-Modify the details of a specific [user role](https://auth0.com/docs/manage-users/access-control/rbac) specified by ID. +Retrieves self-service profiles.
@@ -10807,10 +11890,12 @@ Modify the details of a specific [user role](https://auth0.com/docs/manage-users
```java -client.roles().update( - "id", - UpdateRoleRequestContent +client.selfServiceProfiles().list( + ListSelfServiceProfilesRequestParameters .builder() + .page(1) + .perPage(1) + .includeTotals(true) .build() ); ``` @@ -10827,7 +11912,7 @@ client.roles().update(
-**id:** `String` — ID of the role to update. +**page:** `Optional` — Page index of the results to return. First page is 0.
@@ -10835,7 +11920,7 @@ client.roles().update(
-**name:** `Optional` — Name of this role. +**perPage:** `Optional` — Number of results per page. Defaults to 50.
@@ -10843,7 +11928,7 @@ client.roles().update(
-**description:** `Optional` — Description of this role. +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
@@ -10855,8 +11940,7 @@ client.roles().update(
-## Rules -
client.rules.list() -> SyncPagingIterable&lt;Rule&gt; +
client.selfServiceProfiles.create(request) -> CreateSelfServiceProfileResponseContent
@@ -10868,7 +11952,7 @@ client.roles().update(
-Retrieve a filtered list of [rules](https://auth0.com/docs/rules). Accepts a list of fields to include or exclude. +Creates a self-service profile.
@@ -10883,15 +11967,10 @@ Retrieve a filtered list of [rules](https://auth0.com/docs/rules). Accepts a lis
```java -client.rules().list( - ListRulesRequestParameters +client.selfServiceProfiles().create( + CreateSelfServiceProfileRequestContent .builder() - .page(1) - .perPage(1) - .includeTotals(true) - .enabled(true) - .fields("fields") - .includeFields(true) + .name("name") .build() ); ``` @@ -10908,7 +11987,7 @@ client.rules().list(
-**page:** `Optional` — Page index of the results to return. First page is 0. +**name:** `String` — The name of the self-service Profile.
@@ -10916,7 +11995,7 @@ client.rules().list(
-**perPage:** `Optional` — Number of results per page. +**description:** `Optional` — The description of the self-service Profile.
@@ -10924,7 +12003,7 @@ client.rules().list(
-**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). +**branding:** `Optional`
@@ -10932,7 +12011,7 @@ client.rules().list(
-**enabled:** `Optional` — Optional filter on whether a rule is enabled (true) or disabled (false). +**allowedStrategies:** `Optional>` — List of IdP strategies that will be shown to users during the Self-Service Enterprise Configuration flow. Possible values: [`oidc`, `samlp`, `waad`, `google-apps`, `adfs`, `okta`, `auth0-samlp`, `okta-samlp`, `keycloak-samlp`, `pingfederate`]
@@ -10940,7 +12019,7 @@ client.rules().list(
-**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. +**userAttributes:** `Optional>` — List of attributes to be mapped that will be shown to the user during the Self-Service Enterprise Configuration flow.
@@ -10948,7 +12027,7 @@ client.rules().list(
-**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). +**userAttributeProfileId:** `Optional` — ID of the user-attribute-profile to associate with this self-service profile.
@@ -10960,7 +12039,7 @@ client.rules().list(
-
client.rules.create(request) -> CreateRuleResponseContent +
client.selfServiceProfiles.get(id) -> GetSelfServiceProfileResponseContent
@@ -10972,9 +12051,7 @@ client.rules().list(
-Create a [new rule](https://auth0.com/docs/rules#create-a-new-rule-using-the-management-api). - -Note: Changing a rule's stage of execution from the default `login_success` can change the rule's function signature to have user omitted. +Retrieves a self-service profile by Id.
@@ -10989,13 +12066,7 @@ Note: Changing a rule's stage of execution from the default `login_success` can
```java -client.rules().create( - CreateRuleRequestContent - .builder() - .name("name") - .script("script") - .build() -); +client.selfServiceProfiles().get("id"); ```
@@ -11010,31 +12081,61 @@ client.rules().create(
-**name:** `String` — Name of this rule. +**id:** `String` — The id of the self-service profile to retrieve
+ + + + + + +
+
client.selfServiceProfiles.delete(id)
-**script:** `String` — Code to be executed when this rule runs. - +#### 📝 Description + +
+
+ +
+
+ +Deletes a self-service profile by Id. +
+
+#### 🔌 Usage +
-**order:** `Optional` — Order that this rule should execute in relative to other rules. Lower-valued rules execute first. - +
+
+ +```java +client.selfServiceProfiles().delete("id"); +``` +
+
+#### ⚙️ Parameters +
-**enabled:** `Optional` — Whether the rule is enabled (true), or disabled (false). +
+
+ +**id:** `String` — The id of the self-service profile to delete
@@ -11046,7 +12147,7 @@ client.rules().create(
-
client.rules.get(id) -> GetRuleResponseContent +
client.selfServiceProfiles.update(id, request) -> UpdateSelfServiceProfileResponseContent
@@ -11058,7 +12159,7 @@ client.rules().create(
-Retrieve [rule](https://auth0.com/docs/rules) details. Accepts a list of fields to include or exclude in the result. +Updates a self-service profile.
@@ -11073,12 +12174,10 @@ Retrieve [rule](https://auth0.com/docs/rules) details. Accepts a list of fields
```java -client.rules().get( +client.selfServiceProfiles().update( "id", - GetRuleRequestParameters + UpdateSelfServiceProfileRequestContent .builder() - .fields("fields") - .includeFields(true) .build() ); ``` @@ -11095,7 +12194,7 @@ client.rules().get(
-**id:** `String` — ID of the rule to retrieve. +**id:** `String` — The id of the self-service profile to update
@@ -11103,7 +12202,7 @@ client.rules().get(
-**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. +**name:** `Optional` — The name of the self-service Profile.
@@ -11111,7 +12210,39 @@ client.rules().get(
-**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). +**description:** `Optional` + +
+
+ +
+
+ +**branding:** `Optional` + +
+
+ +
+
+ +**allowedStrategies:** `Optional>` — List of IdP strategies that will be shown to users during the Self-Service Enterprise Configuration flow. Possible values: [`oidc`, `samlp`, `waad`, `google-apps`, `adfs`, `okta`, `auth0-samlp`, `okta-samlp`, `keycloak-samlp`, `pingfederate`] + +
+
+ +
+
+ +**userAttributes:** `Optional>` + +
+
+ +
+
+ +**userAttributeProfileId:** `Optional` — ID of the user-attribute-profile to associate with this self-service profile.
@@ -11123,7 +12254,8 @@ client.rules().get(
-
client.rules.delete(id) +## Sessions +
client.sessions.get(id) -> GetSessionResponseContent
@@ -11135,7 +12267,7 @@ client.rules().get(
-Delete a rule. +Retrieve session information.
@@ -11150,7 +12282,7 @@ Delete a rule.
```java -client.rules().delete("id"); +client.sessions().get("id"); ```
@@ -11165,7 +12297,7 @@ client.rules().delete("id");
-**id:** `String` — ID of the rule to delete. +**id:** `String` — ID of session to retrieve
@@ -11177,7 +12309,7 @@ client.rules().delete("id");
-
client.rules.update(id, request) -> UpdateRuleResponseContent +
client.sessions.delete(id)
@@ -11189,7 +12321,7 @@ client.rules().delete("id");
-Update an existing rule. +Delete a session by ID.
@@ -11204,12 +12336,7 @@ Update an existing rule.
```java -client.rules().update( - "id", - UpdateRuleRequestContent - .builder() - .build() -); +client.sessions().delete("id"); ```
@@ -11224,56 +12351,37 @@ client.rules().update(
-**id:** `String` — ID of the rule to retrieve. +**id:** `String` — ID of the session to delete.
+ + -
-
-**script:** `Optional` — Code to be executed when this rule runs. -
+
+
client.sessions.update(id, request) -> UpdateSessionResponseContent
-**name:** `Optional` — Name of this rule. - -
-
+#### 📝 Description
-**order:** `Optional` — Order that this rule should execute in relative to other rules. Lower-valued rules execute first. - -
-
-
-**enabled:** `Optional` — Whether the rule is enabled (true), or disabled (false). - -
-
+Update session information. - - -
- -## RulesConfigs -
client.rulesConfigs.list() -> List&lt;RulesConfig&gt; -
-
-#### 📝 Description +#### 🔌 Usage
@@ -11281,15 +12389,20 @@ client.rules().update(
-Retrieve rules config variable keys. - - Note: For security, config variable values cannot be retrieved outside rule execution. +```java +client.sessions().update( + "id", + UpdateSessionRequestContent + .builder() + .build() +); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -11297,9 +12410,16 @@ Retrieve rules config variable keys.
-```java -client.rulesConfigs().list(); -``` +**id:** `String` — ID of the session to update. + +
+
+ +
+
+ +**sessionMetadata:** `Optional>` — Metadata associated with the session. Pass null or {} to remove all session_metadata. +
@@ -11310,7 +12430,7 @@ client.rulesConfigs().list();
-
client.rulesConfigs.set(key, request) -> SetRulesConfigResponseContent +
client.sessions.revoke(id)
@@ -11322,7 +12442,7 @@ client.rulesConfigs().list();
-Sets a rules config variable. +Revokes a session by ID and all associated refresh tokens.
@@ -11337,13 +12457,7 @@ Sets a rules config variable.
```java -client.rulesConfigs().set( - "key", - SetRulesConfigRequestContent - .builder() - .value("value") - .build() -); +client.sessions().revoke("id"); ```
@@ -11358,15 +12472,7 @@ client.rulesConfigs().set(
-**key:** `String` — Key of the rules config variable to set (max length: 127 characters). - -
-
- -
-
- -**value:** `String` — Value for a rules config variable. +**id:** `String` — ID of the session to revoke.
@@ -11378,7 +12484,8 @@ client.rulesConfigs().set(
-
client.rulesConfigs.delete(key) +## Stats +
client.stats.getActiveUsersCount() -> Double
@@ -11390,7 +12497,7 @@ client.rulesConfigs().set(
-Delete a rules config variable identified by its key. +Retrieve the number of active users that logged in during the last 30 days.
@@ -11405,35 +12512,19 @@ Delete a rules config variable identified by its key.
```java -client.rulesConfigs().delete("key"); +client.stats().getActiveUsersCount(); ```
-#### ⚙️ Parameters - -
-
- -
-
- -**key:** `String` — Key of the rules config variable to delete. - -
-
-
-
-
-## SelfServiceProfiles -
client.selfServiceProfiles.list() -> SyncPagingIterable&lt;SelfServiceProfile&gt; +
client.stats.getDaily() -> List&lt;DailyStats&gt;
@@ -11445,7 +12536,7 @@ client.rulesConfigs().delete("key");
-Retrieves self-service profiles. +Retrieve the number of logins, signups and breached-password detections (subscription required) that occurred each day within a specified date range.
@@ -11460,12 +12551,11 @@ Retrieves self-service profiles.
```java -client.selfServiceProfiles().list( - ListSelfServiceProfilesRequestParameters +client.stats().getDaily( + GetDailyStatsRequestParameters .builder() - .page(1) - .perPage(1) - .includeTotals(true) + .from("from") + .to("to") .build() ); ``` @@ -11482,15 +12572,7 @@ client.selfServiceProfiles().list(
-**page:** `Optional` — Page index of the results to return. First page is 0. - -
-
- -
-
- -**perPage:** `Optional` — Number of results per page. Defaults to 50. +**from:** `Optional` — Optional first day of the date range (inclusive) in YYYYMMDD format.
@@ -11498,7 +12580,7 @@ client.selfServiceProfiles().list(
-**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). +**to:** `Optional` — Optional last day of the date range (inclusive) in YYYYMMDD format.
@@ -11510,7 +12592,8 @@ client.selfServiceProfiles().list(
-
client.selfServiceProfiles.create(request) -> CreateSelfServiceProfileResponseContent +## SupplementalSignals +
client.supplementalSignals.get() -> GetSupplementalSignalsResponseContent
@@ -11522,7 +12605,7 @@ client.selfServiceProfiles().list(
-Creates a self-service profile. +Get the supplemental signals configuration for a tenant.
@@ -11537,67 +12620,66 @@ Creates a self-service profile.
```java -client.selfServiceProfiles().create( - CreateSelfServiceProfileRequestContent - .builder() - .name("name") - .build() -); +client.supplementalSignals().get(); ```
-#### ⚙️ Parameters + + +
+ +
client.supplementalSignals.patch(request) -> PatchSupplementalSignalsResponseContent
+#### 📝 Description +
-**name:** `String` — The name of the self-service Profile. - -
-
-
-**description:** `Optional` — The description of the self-service Profile. - +Update the supplemental signals configuration for a tenant. +
+
+#### 🔌 Usage +
-**branding:** `Optional` - -
-
-
-**allowedStrategies:** `Optional>` — List of IdP strategies that will be shown to users during the Self-Service Enterprise Configuration flow. Possible values: [`oidc`, `samlp`, `waad`, `google-apps`, `adfs`, `okta`, `auth0-samlp`, `okta-samlp`, `keycloak-samlp`, `pingfederate`] - +```java +client.supplementalSignals().patch( + UpdateSupplementalSignalsRequestContent + .builder() + .akamaiEnabled(true) + .build() +); +```
+ + + +#### ⚙️ Parameters
-**userAttributes:** `Optional>` — List of attributes to be mapped that will be shown to the user during the Self-Service Enterprise Configuration flow. - -
-
-
-**userAttributeProfileId:** `Optional` — ID of the user-attribute-profile to associate with this self-service profile. +**akamaiEnabled:** `Boolean` — Indicates if incoming Akamai Headers should be processed
@@ -11609,7 +12691,8 @@ client.selfServiceProfiles().create(
-
client.selfServiceProfiles.get(id) -> GetSelfServiceProfileResponseContent +## Tickets +
client.tickets.verifyEmail(request) -> VerifyEmailTicketResponseContent
@@ -11621,7 +12704,7 @@ client.selfServiceProfiles().create(
-Retrieves a self-service profile by Id. +Create an email verification ticket for a given user. An email verification ticket is a generated URL that the user can consume to verify their email address.
@@ -11636,7 +12719,12 @@ Retrieves a self-service profile by Id.
```java -client.selfServiceProfiles().get("id"); +client.tickets().verifyEmail( + VerifyEmailTicketRequestContent + .builder() + .userId("user_id") + .build() +); ```
@@ -11651,61 +12739,55 @@ client.selfServiceProfiles().get("id");
-**id:** `String` — The id of the self-service profile to retrieve +**resultUrl:** `Optional` — URL the user will be redirected to in the classic Universal Login experience once the ticket is used. Cannot be specified when using client_id or organization_id.
- - +
+
+**userId:** `String` — user_id of for whom the ticket should be created. +
-
-
client.selfServiceProfiles.delete(id)
-#### 📝 Description - -
-
+**clientId:** `Optional` — ID of the client (application). If provided for tenants using the New Universal Login experience, the email template and UI displays application details, and the user is prompted to redirect to the application's default login route after the ticket is used. client_id is required to use the Password Reset Post Challenge trigger. + +
+
-Deletes a self-service profile by Id. -
-
+**organizationId:** `Optional` — (Optional) Organization ID – the ID of the Organization. If provided, organization parameters will be made available to the email template and organization branding will be applied to the prompt. In addition, the redirect link in the prompt will include organization_id and organization_name query string parameters. +
-#### 🔌 Usage -
-
-
- -```java -client.selfServiceProfiles().delete("id"); -``` -
-
+**ttlSec:** `Optional` — Number of seconds for which the ticket is valid before expiration. If unspecified or set to 0, this value defaults to 432000 seconds (5 days). +
-#### ⚙️ Parameters -
+**includeEmailInRedirect:** `Optional` — Whether to include the email address as part of the returnUrl in the reset_email (true), or not (false). + +
+
+
-**id:** `String` — The id of the self-service profile to delete +**identity:** `Optional`
@@ -11717,7 +12799,7 @@ client.selfServiceProfiles().delete("id");
-
client.selfServiceProfiles.update(id, request) -> UpdateSelfServiceProfileResponseContent +
client.tickets.changePassword(request) -> ChangePasswordTicketResponseContent
@@ -11729,7 +12811,9 @@ client.selfServiceProfiles().delete("id");
-Updates a self-service profile. +Create a password change ticket for a given user. A password change ticket is a generated URL that the user can consume to start a reset password flow. + +Note: This endpoint does not verify the given user’s identity. If you call this endpoint within your application, you must design your application to verify the user’s identity.
@@ -11744,9 +12828,8 @@ Updates a self-service profile.
```java -client.selfServiceProfiles().update( - "id", - UpdateSelfServiceProfileRequestContent +client.tickets().changePassword( + ChangePasswordTicketRequestContent .builder() .build() ); @@ -11764,7 +12847,7 @@ client.selfServiceProfiles().update(
-**id:** `String` — The id of the self-service profile to update +**resultUrl:** `Optional` — URL the user will be redirected to in the classic Universal Login experience once the ticket is used. Cannot be specified when using organization_id. May be specified together with client_id when the tenant has a custom password reset page enabled and a password-reset-post-challenge Action bound.
@@ -11772,7 +12855,7 @@ client.selfServiceProfiles().update(
-**name:** `Optional` — The name of the self-service Profile. +**userId:** `Optional` — user_id of for whom the ticket should be created.
@@ -11780,7 +12863,7 @@ client.selfServiceProfiles().update(
-**description:** `Optional` +**clientId:** `Optional` — ID of the client (application). If provided for tenants using the New Universal Login experience, the email template and UI displays application details, and the user is prompted to redirect to the application's default login route after the ticket is used. client_id is required to use the Password Reset Post Challenge trigger.
@@ -11788,7 +12871,7 @@ client.selfServiceProfiles().update(
-**branding:** `Optional` +**organizationId:** `Optional` — (Optional) Organization ID – the ID of the Organization. If provided, organization parameters will be made available to the email template and organization branding will be applied to the prompt. In addition, the redirect link in the prompt will include organization_id and organization_name query string parameters.
@@ -11796,7 +12879,7 @@ client.selfServiceProfiles().update(
-**allowedStrategies:** `Optional>` — List of IdP strategies that will be shown to users during the Self-Service Enterprise Configuration flow. Possible values: [`oidc`, `samlp`, `waad`, `google-apps`, `adfs`, `okta`, `auth0-samlp`, `okta-samlp`, `keycloak-samlp`, `pingfederate`] +**connectionId:** `Optional` — ID of the connection. If provided, allows the user to be specified using email instead of user_id. If you set this value, you must also send the email parameter. You cannot send user_id when specifying a connection_id.
@@ -11804,7 +12887,7 @@ client.selfServiceProfiles().update(
-**userAttributes:** `Optional>` +**email:** `Optional` — Email address of the user for whom the tickets should be created. Requires the connection_id parameter. Cannot be specified when using user_id.
@@ -11812,62 +12895,31 @@ client.selfServiceProfiles().update(
-**userAttributeProfileId:** `Optional` — ID of the user-attribute-profile to associate with this self-service profile. +**ttlSec:** `Optional` — Number of seconds for which the ticket is valid before expiration. If unspecified or set to 0, this value defaults to 432000 seconds (5 days).
-
-
- - - - -
- -## Sessions -
client.sessions.get(id) -> GetSessionResponseContent -
-
- -#### 📝 Description - -
-
-Retrieve session information. -
-
+**markEmailAsVerified:** `Optional` — Whether to set the email_verified attribute to true (true) or whether it should not be updated (false). +
-#### 🔌 Usage -
-
-
- -```java -client.sessions().get("id"); -``` -
-
+**includeEmailInRedirect:** `Optional` — Whether to include the email address as part of the returnUrl in the reset_email (true), or not (false). +
-#### ⚙️ Parameters -
-
-
- -**id:** `String` — ID of session to retrieve +**identity:** `Optional`
@@ -11879,7 +12931,8 @@ client.sessions().get("id");
-
client.sessions.delete(id) +## TokenExchangeProfiles +
client.tokenExchangeProfiles.list() -> SyncPagingIterable&lt;TokenExchangeProfileResponseContent&gt;
@@ -11891,7 +12944,16 @@ client.sessions().get("id");
-Delete a session by ID. +Retrieve a list of all Token Exchange Profiles available in your tenant. + +By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details. + +This endpoint supports Checkpoint pagination. 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.
@@ -11906,7 +12968,13 @@ Delete a session by ID.
```java -client.sessions().delete("id"); +client.tokenExchangeProfiles().list( + TokenExchangeProfilesListRequest + .builder() + .from("from") + .take(1) + .build() +); ```
@@ -11921,7 +12989,15 @@ client.sessions().delete("id");
-**id:** `String` — ID of the session to delete. +**from:** `Optional` — Optional Id from which to start selection. + +
+
+ +
+
+ +**take:** `Optional` — Number of results per page. Defaults to 50.
@@ -11933,7 +13009,7 @@ client.sessions().delete("id");
-
client.sessions.update(id, request) -> UpdateSessionResponseContent +
client.tokenExchangeProfiles.create(request) -> CreateTokenExchangeProfileResponseContent
@@ -11945,7 +13021,9 @@ client.sessions().delete("id");
-Update session information. +Create a new Token Exchange Profile within your tenant. + +By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
@@ -11960,10 +13038,13 @@ Update session information.
```java -client.sessions().update( - "id", - UpdateSessionRequestContent +client.tokenExchangeProfiles().create( + CreateTokenExchangeProfileRequestContent .builder() + .name("name") + .subjectTokenType("subject_token_type") + .actionId("action_id") + .type(TokenExchangeProfileTypeEnum.CUSTOM_AUTHENTICATION) .build() ); ``` @@ -11980,7 +13061,7 @@ client.sessions().update(
-**id:** `String` — ID of the session to update. +**name:** `String` — Friendly name of this profile.
@@ -11988,7 +13069,23 @@ client.sessions().update(
-**sessionMetadata:** `Optional>` — Metadata associated with the session. Pass null or {} to remove all session_metadata. +**subjectTokenType:** `String` — Subject token type for this profile. When receiving a token exchange request on the Authentication API, the corresponding token exchange profile with a matching subject_token_type will be executed. This must be a URI. + +
+
+ +
+
+ +**actionId:** `String` — The ID of the Custom Token Exchange action to execute for this profile, in order to validate the subject_token. The action must use the custom-token-exchange trigger. + +
+
+ +
+
+ +**type:** `TokenExchangeProfileTypeEnum`
@@ -12000,7 +13097,7 @@ client.sessions().update(
-
client.sessions.revoke(id) +
client.tokenExchangeProfiles.get(id) -> GetTokenExchangeProfileResponseContent
@@ -12012,7 +13109,9 @@ client.sessions().update(
-Revokes a session by ID and all associated refresh tokens. +Retrieve details about a single Token Exchange Profile specified by ID. + +By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
@@ -12027,7 +13126,7 @@ Revokes a session by ID and all associated refresh tokens.
```java -client.sessions().revoke("id"); +client.tokenExchangeProfiles().get("id"); ```
@@ -12042,7 +13141,7 @@ client.sessions().revoke("id");
-**id:** `String` — ID of the session to revoke. +**id:** `String` — ID of the Token Exchange Profile to retrieve.
@@ -12054,8 +13153,7 @@ client.sessions().revoke("id");
-## Stats -
client.stats.getActiveUsersCount() -> Double +
client.tokenExchangeProfiles.delete(id)
@@ -12067,7 +13165,9 @@ client.sessions().revoke("id");
-Retrieve the number of active users that logged in during the last 30 days. +Delete a Token Exchange Profile within your tenant. + +By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
@@ -12082,19 +13182,34 @@ Retrieve the number of active users that logged in during the last 30 days.
```java -client.stats().getActiveUsersCount(); +client.tokenExchangeProfiles().delete("id"); ```
+#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — ID of the Token Exchange Profile to delete. + +
+
+
+
+
-
client.stats.getDaily() -> List&lt;DailyStats&gt; +
client.tokenExchangeProfiles.update(id, request)
@@ -12106,7 +13221,9 @@ client.stats().getActiveUsersCount();
-Retrieve the number of logins, signups and breached-password detections (subscription required) that occurred each day within a specified date range. +Update a Token Exchange Profile within your tenant. + +By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
@@ -12121,11 +13238,10 @@ Retrieve the number of logins, signups and breached-password detections (subscri
```java -client.stats().getDaily( - GetDailyStatsRequestParameters +client.tokenExchangeProfiles().update( + "id", + UpdateTokenExchangeProfileRequestContent .builder() - .from("from") - .to("to") .build() ); ``` @@ -12142,7 +13258,7 @@ client.stats().getDaily(
-**from:** `Optional` — Optional first day of the date range (inclusive) in YYYYMMDD format. +**id:** `String` — ID of the Token Exchange Profile to update.
@@ -12150,48 +13266,16 @@ client.stats().getDaily(
-**to:** `Optional` — Optional last day of the date range (inclusive) in YYYYMMDD format. +**name:** `Optional` — Friendly name of this profile.
-
-
- - - - -
- -## SupplementalSignals -
client.supplementalSignals.get() -> GetSupplementalSignalsResponseContent -
-
- -#### 📝 Description - -
-
- -
-
- -Get the supplemental signals configuration for a tenant. -
-
-
-
- -#### 🔌 Usage - -
-
-```java -client.supplementalSignals().get(); -``` +**subjectTokenType:** `Optional` — Subject token type for this profile. When receiving a token exchange request on the Authentication API, the corresponding token exchange profile with a matching subject_token_type will be executed. This must be a URI. +
@@ -12202,7 +13286,8 @@ client.supplementalSignals().get();
-
client.supplementalSignals.patch(request) -> PatchSupplementalSignalsResponseContent +## UserAttributeProfiles +
client.userAttributeProfiles.list() -> SyncPagingIterable&lt;UserAttributeProfile&gt;
@@ -12214,7 +13299,7 @@ client.supplementalSignals().get();
-Update the supplemental signals configuration for a tenant. +Retrieve a list of User Attribute Profiles. This endpoint supports Checkpoint pagination.
@@ -12229,10 +13314,11 @@ Update the supplemental signals configuration for a tenant.
```java -client.supplementalSignals().patch( - UpdateSupplementalSignalsRequestContent +client.userAttributeProfiles().list( + ListUserAttributeProfileRequestParameters .builder() - .akamaiEnabled(true) + .from("from") + .take(1) .build() ); ``` @@ -12249,7 +13335,15 @@ client.supplementalSignals().patch(
-**akamaiEnabled:** `Boolean` — Indicates if incoming Akamai Headers should be processed +**from:** `Optional` — Optional Id from which to start selection. + +
+
+ +
+
+ +**take:** `Optional` — Number of results per page. Defaults to 5.
@@ -12261,8 +13355,7 @@ client.supplementalSignals().patch(
-## Tickets -
client.tickets.verifyEmail(request) -> VerifyEmailTicketResponseContent +
client.userAttributeProfiles.create(request) -> CreateUserAttributeProfileResponseContent
@@ -12274,7 +13367,7 @@ client.supplementalSignals().patch(
-Create an email verification ticket for a given user. An email verification ticket is a generated URL that the user can consume to verify their email address. +Create a User Attribute Profile.
@@ -12289,10 +13382,21 @@ Create an email verification ticket for a given user. An email verification tick
```java -client.tickets().verifyEmail( - VerifyEmailTicketRequestContent +client.userAttributeProfiles().create( + CreateUserAttributeProfileRequestContent .builder() - .userId("user_id") + .name("name") + .userAttributes( + new HashMap() {{ + put("key", UserAttributeProfileUserAttributeAdditionalProperties + .builder() + .description("description") + .label("label") + .profileRequired(true) + .auth0Mapping("auth0_mapping") + .build()); + }} + ) .build() ); ``` @@ -12309,7 +13413,7 @@ client.tickets().verifyEmail(
-**resultUrl:** `Optional` — URL the user will be redirected to in the classic Universal Login experience once the ticket is used. Cannot be specified when using client_id or organization_id. +**name:** `String`
@@ -12317,7 +13421,7 @@ client.tickets().verifyEmail(
-**userId:** `String` — user_id of for whom the ticket should be created. +**userId:** `Optional`
@@ -12325,40 +13429,47 @@ client.tickets().verifyEmail(
-**clientId:** `Optional` — ID of the client (application). If provided for tenants using the New Universal Login experience, the email template and UI displays application details, and the user is prompted to redirect to the application's default login route after the ticket is used. client_id is required to use the Password Reset Post Challenge trigger. +**userAttributes:** `Map`
+
+
-
-
-**organizationId:** `Optional` — (Optional) Organization ID – the ID of the Organization. If provided, organization parameters will be made available to the email template and organization branding will be applied to the prompt. In addition, the redirect link in the prompt will include organization_id and organization_name query string parameters. -
+
+
client.userAttributeProfiles.listTemplates() -> ListUserAttributeProfileTemplateResponseContent
-**ttlSec:** `Optional` — Number of seconds for which the ticket is valid before expiration. If unspecified or set to 0, this value defaults to 432000 seconds (5 days). - -
-
+#### 📝 Description
-**includeEmailInRedirect:** `Optional` — Whether to include the email address as part of the returnUrl in the reset_email (true), or not (false). - +
+
+ +Retrieve a list of User Attribute Profile Templates.
+
+
+ +#### 🔌 Usage
-**identity:** `Optional` - +
+
+ +```java +client.userAttributeProfiles().listTemplates(); +```
@@ -12369,7 +13480,7 @@ client.tickets().verifyEmail(
-
client.tickets.changePassword(request) -> ChangePasswordTicketResponseContent +
client.userAttributeProfiles.getTemplate(id) -> GetUserAttributeProfileTemplateResponseContent
@@ -12381,9 +13492,7 @@ client.tickets().verifyEmail(
-Create a password change ticket for a given user. A password change ticket is a generated URL that the user can consume to start a reset password flow. - -Note: This endpoint does not verify the given user’s identity. If you call this endpoint within your application, you must design your application to verify the user’s identity. +Retrieve a User Attribute Profile Template.
@@ -12398,11 +13507,7 @@ Note: This endpoint does not verify the given user’s identity. If you call thi
```java -client.tickets().changePassword( - ChangePasswordTicketRequestContent - .builder() - .build() -); +client.userAttributeProfiles().getTemplate("id"); ```
@@ -12417,79 +13522,61 @@ client.tickets().changePassword(
-**resultUrl:** `Optional` — URL the user will be redirected to in the classic Universal Login experience once the ticket is used. Cannot be specified when using organization_id. May be specified together with client_id when the tenant has a custom password reset page enabled and a password-reset-post-challenge Action bound. +**id:** `String` — ID of the user-attribute-profile-template to retrieve.
- -
-
- -**userId:** `Optional` — user_id of for whom the ticket should be created. -
-
-
-**clientId:** `Optional` — ID of the client (application). If provided for tenants using the New Universal Login experience, the email template and UI displays application details, and the user is prompted to redirect to the application's default login route after the ticket is used. client_id is required to use the Password Reset Post Challenge trigger. -
+
+
client.userAttributeProfiles.get(id) -> GetUserAttributeProfileResponseContent
-**organizationId:** `Optional` — (Optional) Organization ID – the ID of the Organization. If provided, organization parameters will be made available to the email template and organization branding will be applied to the prompt. In addition, the redirect link in the prompt will include organization_id and organization_name query string parameters. - -
-
+#### 📝 Description
-**connectionId:** `Optional` — ID of the connection. If provided, allows the user to be specified using email instead of user_id. If you set this value, you must also send the email parameter. You cannot send user_id when specifying a connection_id. - -
-
-
-**email:** `Optional` — Email address of the user for whom the tickets should be created. Requires the connection_id parameter. Cannot be specified when using user_id. - +Retrieve details about a single User Attribute Profile specified by ID. +
+
+#### 🔌 Usage +
-**ttlSec:** `Optional` — Number of seconds for which the ticket is valid before expiration. If unspecified or set to 0, this value defaults to 432000 seconds (5 days). - -
-
-
-**markEmailAsVerified:** `Optional` — Whether to set the email_verified attribute to true (true) or whether it should not be updated (false). - +```java +client.userAttributeProfiles().get("id"); +``` +
+
+#### ⚙️ Parameters +
-**includeEmailInRedirect:** `Optional` — Whether to include the email address as part of the returnUrl in the reset_email (true), or not (false). - -
-
-
-**identity:** `Optional` +**id:** `String` — ID of the user-attribute-profile to retrieve.
@@ -12501,8 +13588,7 @@ client.tickets().changePassword(
-## TokenExchangeProfiles -
client.tokenExchangeProfiles.list() -> SyncPagingIterable&lt;TokenExchangeProfileResponseContent&gt; +
client.userAttributeProfiles.delete(id)
@@ -12514,16 +13600,7 @@ client.tickets().changePassword(
-Retrieve a list of all Token Exchange Profiles available in your tenant. - -By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details. - -This endpoint supports Checkpoint pagination. 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. +Delete a single User Attribute Profile specified by ID.
@@ -12538,13 +13615,7 @@ This endpoint supports Checkpoint pagination. To search by checkpoint, use the f
```java -client.tokenExchangeProfiles().list( - TokenExchangeProfilesListRequest - .builder() - .from("from") - .take(1) - .build() -); +client.userAttributeProfiles().delete("id"); ```
@@ -12559,15 +13630,7 @@ client.tokenExchangeProfiles().list(
-**from:** `Optional` — Optional Id from which to start selection. - -
-
- -
-
- -**take:** `Optional` — Number of results per page. Defaults to 50. +**id:** `String` — ID of the user-attribute-profile to delete.
@@ -12579,7 +13642,7 @@ client.tokenExchangeProfiles().list(
-
client.tokenExchangeProfiles.create(request) -> CreateTokenExchangeProfileResponseContent +
client.userAttributeProfiles.update(id, request) -> UpdateUserAttributeProfileResponseContent
@@ -12591,9 +13654,7 @@ client.tokenExchangeProfiles().list(
-Create a new Token Exchange Profile within your tenant. - -By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details. +Update the details of a specific User attribute profile, such as name, user_id and user_attributes.
@@ -12608,13 +13669,10 @@ By using this feature, you agree to the applicable Free Trial terms in [Okta’s
```java -client.tokenExchangeProfiles().create( - CreateTokenExchangeProfileRequestContent +client.userAttributeProfiles().update( + "id", + UpdateUserAttributeProfileRequestContent .builder() - .name("name") - .subjectTokenType("subject_token_type") - .actionId("action_id") - .type(TokenExchangeProfileTypeEnum.CUSTOM_AUTHENTICATION) .build() ); ``` @@ -12631,7 +13689,7 @@ client.tokenExchangeProfiles().create(
-**name:** `String` — Friendly name of this profile. +**id:** `String` — ID of the user attribute profile to update.
@@ -12639,7 +13697,7 @@ client.tokenExchangeProfiles().create(
-**subjectTokenType:** `String` — Subject token type for this profile. When receiving a token exchange request on the Authentication API, the corresponding token exchange profile with a matching subject_token_type will be executed. This must be a URI. +**name:** `Optional`
@@ -12647,7 +13705,7 @@ client.tokenExchangeProfiles().create(
-**actionId:** `String` — The ID of the Custom Token Exchange action to execute for this profile, in order to validate the subject_token. The action must use the custom-token-exchange trigger. +**userId:** `Optional`
@@ -12655,7 +13713,7 @@ client.tokenExchangeProfiles().create(
-**type:** `TokenExchangeProfileTypeEnum` +**userAttributes:** `Optional>`
@@ -12667,7 +13725,8 @@ client.tokenExchangeProfiles().create(
-
client.tokenExchangeProfiles.get(id) -> GetTokenExchangeProfileResponseContent +## UserBlocks +
client.userBlocks.listByIdentifier() -> ListUserBlocksByIdentifierResponseContent
@@ -12679,9 +13738,7 @@ client.tokenExchangeProfiles().create(
-Retrieve details about a single Token Exchange Profile specified by ID. - -By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details. +Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for a user with the given identifier (username, phone number, or email).
@@ -12696,7 +13753,13 @@ By using this feature, you agree to the applicable Free Trial terms in [Okta’s
```java -client.tokenExchangeProfiles().get("id"); +client.userBlocks().listByIdentifier( + ListUserBlocksByIdentifierRequestParameters + .builder() + .identifier("identifier") + .considerBruteForceEnablement(true) + .build() +); ```
@@ -12711,7 +13774,20 @@ client.tokenExchangeProfiles().get("id");
-**id:** `String` — ID of the Token Exchange Profile to retrieve. +**identifier:** `String` — Should be any of a username, phone number, or email. + +
+
+ +
+
+ +**considerBruteForceEnablement:** `Optional` + + + If true and Brute Force Protection is enabled and configured to block logins, will return a list of blocked IP addresses. + If true and Brute Force Protection is disabled, will return an empty list. +
@@ -12723,7 +13799,7 @@ client.tokenExchangeProfiles().get("id");
-
client.tokenExchangeProfiles.delete(id) +
client.userBlocks.deleteByIdentifier()
@@ -12735,9 +13811,9 @@ client.tokenExchangeProfiles().get("id");
-Delete a Token Exchange Profile within your tenant. +Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given identifier (username, phone number, or email). -By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details. +Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
@@ -12752,7 +13828,12 @@ By using this feature, you agree to the applicable Free Trial terms in [Okta's M
```java -client.tokenExchangeProfiles().delete("id"); +client.userBlocks().deleteByIdentifier( + DeleteUserBlocksByIdentifierRequestParameters + .builder() + .identifier("identifier") + .build() +); ```
@@ -12767,7 +13848,7 @@ client.tokenExchangeProfiles().delete("id");
-**id:** `String` — ID of the Token Exchange Profile to delete. +**identifier:** `String` — Should be any of a username, phone number, or email.
@@ -12779,7 +13860,7 @@ client.tokenExchangeProfiles().delete("id");
-
client.tokenExchangeProfiles.update(id, request) +
client.userBlocks.list(id) -> ListUserBlocksResponseContent
@@ -12791,9 +13872,7 @@ client.tokenExchangeProfiles().delete("id");
-Update a Token Exchange Profile within your tenant. - -By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details. +Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
@@ -12808,10 +13887,11 @@ By using this feature, you agree to the applicable Free Trial terms in [Okta's M
```java -client.tokenExchangeProfiles().update( +client.userBlocks().list( "id", - UpdateTokenExchangeProfileRequestContent + ListUserBlocksRequestParameters .builder() + .considerBruteForceEnablement(true) .build() ); ``` @@ -12828,7 +13908,7 @@ client.tokenExchangeProfiles().update(
-**id:** `String` — ID of the Token Exchange Profile to update. +**id:** `String` — user_id of the user blocks to retrieve.
@@ -12836,15 +13916,12 @@ client.tokenExchangeProfiles().update(
-**name:** `Optional` — Friendly name of this profile. - -
-
+**considerBruteForceEnablement:** `Optional` -
-
-**subjectTokenType:** `Optional` — Subject token type for this profile. When receiving a token exchange request on the Authentication API, the corresponding token exchange profile with a matching subject_token_type will be executed. This must be a URI. + If true and Brute Force Protection is enabled and configured to block logins, will return a list of blocked IP addresses. + If true and Brute Force Protection is disabled, will return an empty list. +
@@ -12856,8 +13933,7 @@ client.tokenExchangeProfiles().update(
-## UserAttributeProfiles -
client.userAttributeProfiles.list() -> SyncPagingIterable&lt;UserAttributeProfile&gt; +
client.userBlocks.delete(id)
@@ -12869,7 +13945,9 @@ client.tokenExchangeProfiles().update(
-Retrieve a list of User Attribute Profiles. This endpoint supports Checkpoint pagination. +Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID. + +Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
@@ -12884,13 +13962,7 @@ Retrieve a list of User Attribute Profiles. This endpoint supports Checkpoint pa
```java -client.userAttributeProfiles().list( - ListUserAttributeProfileRequestParameters - .builder() - .from("from") - .take(1) - .build() -); +client.userBlocks().delete("id"); ```
@@ -12905,15 +13977,7 @@ client.userAttributeProfiles().list(
-**from:** `Optional` — Optional Id from which to start selection. - -
-
- -
-
- -**take:** `Optional` — Number of results per page. Defaults to 5. +**id:** `String` — The user_id of the user to update.
@@ -12925,7 +13989,8 @@ client.userAttributeProfiles().list(
-
client.userAttributeProfiles.create(request) -> CreateUserAttributeProfileResponseContent +## Users +
client.users.list() -> SyncPagingIterable&lt;UserResponseSchema&gt;
@@ -12937,7 +14002,24 @@ client.userAttributeProfiles().list(
-Create a User Attribute Profile. +Retrieve details of users. It is possible to: + +- Specify a search criteria for users +- Sort the users to be returned +- Select the fields to be returned +- Specify the number of users to retrieve per page and the page index + + + +The `q` query parameter can be used to get users that match the specified criteria [using query string syntax.](https://auth0.com/docs/users/search/v3/query-syntax) + +[Learn more about searching for users.](https://auth0.com/docs/users/search/v3) + +Read about [best practices](https://auth0.com/docs/users/search/best-practices) when working with the API endpoints for retrieving users. + + + +Auth0 limits the number of users you can return. If you exceed this threshold, please redefine your search, use the [export job](https://auth0.com/docs/api/management/v2#!/Jobs/post_users_exports), or the [User Import / Export](https://auth0.com/docs/extensions/user-import-export) extension.
@@ -12952,21 +14034,19 @@ Create a User Attribute Profile.
```java -client.userAttributeProfiles().create( - CreateUserAttributeProfileRequestContent +client.users().list( + ListUsersRequestParameters .builder() - .name("name") - .userAttributes( - new HashMap() {{ - put("key", UserAttributeProfileUserAttributeAdditionalProperties - .builder() - .description("description") - .label("label") - .profileRequired(true) - .auth0Mapping("auth0_mapping") - .build()); - }} - ) + .page(1) + .perPage(1) + .includeTotals(true) + .sort("sort") + .connection("connection") + .fields("fields") + .includeFields(true) + .q("q") + .searchEngine(SearchEngineVersionsEnum.V1) + .primaryOrder(true) .build() ); ``` @@ -12983,7 +14063,7 @@ client.userAttributeProfiles().create(
-**name:** `String` +**page:** `Optional` — Page index of the results to return. First page is 0.
@@ -12991,7 +14071,7 @@ client.userAttributeProfiles().create(
-**userId:** `Optional` +**perPage:** `Optional` — Number of results per page.
@@ -12999,47 +14079,64 @@ client.userAttributeProfiles().create(
-**userAttributes:** `Map` +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
-
-
+
+
+**sort:** `Optional` — Field to sort by. Use field:order where order is 1 for ascending and -1 for descending. e.g. created_at:1 +
-
-
client.userAttributeProfiles.listTemplates() -> ListUserAttributeProfileTemplateResponseContent
-#### 📝 Description +**connection:** `Optional` — Connection filter. Only applies when using search_engine=v1. To filter by connection with search_engine=v2|v3, use q=identities.connection:"connection_name" + +
+
+**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. + +
+
+
-Retrieve a list of User Attribute Profile Templates. +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). +
+ +
+
+ +**q:** `Optional` — Query in Lucene query string syntax. Some query types cannot be used on metadata fields, for details see Searchable Fields. +
-#### 🔌 Usage -
+**searchEngine:** `Optional` — The version of the search engine + +
+
+
-```java -client.userAttributeProfiles().listTemplates(); -``` +**primaryOrder:** `Optional` — If true (default), results are returned in a deterministic order. If false, results may be returned in a non-deterministic order, which can enhance performance for complex queries targeting a small number of users. Set to false only when consistent ordering and pagination is not required. +
@@ -13050,7 +14147,7 @@ client.userAttributeProfiles().listTemplates();
-
client.userAttributeProfiles.getTemplate(id) -> GetUserAttributeProfileTemplateResponseContent +
client.users.create(request) -> CreateUserResponseContent
@@ -13062,7 +14159,9 @@ client.userAttributeProfiles().listTemplates();
-Retrieve a User Attribute Profile Template. +Create a new user for a given [database](https://auth0.com/docs/connections/database) or [passwordless](https://auth0.com/docs/connections/passwordless) connection. + +Note: `connection` is required but other parameters such as `email` and `password` are dependent upon the type of connection.
@@ -13077,7 +14176,12 @@ Retrieve a User Attribute Profile Template.
```java -client.userAttributeProfiles().getTemplate("id"); +client.users().create( + CreateUserRequestContent + .builder() + .connection("connection") + .build() +); ```
@@ -13092,115 +14196,135 @@ client.userAttributeProfiles().getTemplate("id");
-**id:** `String` — ID of the user-attribute-profile-template to retrieve. +**email:** `Optional` — The user's email.
- - +
+
+**phoneNumber:** `Optional` — The user's phone number (following the E.164 recommendation). +
-
-
client.userAttributeProfiles.get(id) -> GetUserAttributeProfileResponseContent
-#### 📝 Description +**userMetadata:** `Optional>` + +
+
+**blocked:** `Optional` — Whether this user was blocked by an administrator (true) or not (false). + +
+
+
-Retrieve details about a single User Attribute Profile specified by ID. -
-
+**emailVerified:** `Optional` — Whether this email address is verified (true) or unverified (false). User will receive a verification email after creation if `email_verified` is false or not specified + -#### 🔌 Usage -
+**phoneVerified:** `Optional` — Whether this phone number has been verified (true) or not (false). + +
+
+
-```java -client.userAttributeProfiles().get("id"); -``` -
-
+**appMetadata:** `Optional>` + -#### ⚙️ Parameters -
+**givenName:** `Optional` — The user's given name(s). + +
+
+
-**id:** `String` — ID of the user-attribute-profile to retrieve. +**familyName:** `Optional` — The user's family name(s).
- - +
+
+**name:** `Optional` — The user's full name. +
-
-
client.userAttributeProfiles.delete(id)
-#### 📝 Description +**nickname:** `Optional` — The user's nickname. + +
+
+**picture:** `Optional` — A URI pointing to the user's picture. + +
+
+
-Delete a single User Attribute Profile specified by ID. -
-
+**userId:** `Optional` — The external user's id provided by the identity provider. + -#### 🔌 Usage -
+**connection:** `String` — Name of the connection this user should be created in. + +
+
+
-```java -client.userAttributeProfiles().delete("id"); -``` -
-
+**password:** `Optional` — Initial password for this user. Only valid for auth0 connection strategy. + -#### ⚙️ Parameters -
+**verifyEmail:** `Optional` — Whether the user will receive a verification email after creation (true) or no email (false). Overrides behavior of `email_verified` parameter. + +
+
+
-**id:** `String` — ID of the user-attribute-profile to delete. +**username:** `Optional` — The user's username. Only valid if the connection requires a username.
@@ -13212,7 +14336,7 @@ client.userAttributeProfiles().delete("id");
-
client.userAttributeProfiles.update(id, request) -> UpdateUserAttributeProfileResponseContent +
client.users.listUsersByEmail() -> List&lt;UserResponseSchema&gt;
@@ -13224,7 +14348,11 @@ client.userAttributeProfiles().delete("id");
-Update the details of a specific User attribute profile, such as name, user_id and user_attributes. +Find users by email. If Auth0 is the identity provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it. + +For example, if you register a user as JohnSmith@example.com, Auth0 saves the user's email as johnsmith@example.com. + +Therefore, when using this endpoint, make sure that you are searching for users via email addresses using the correct case.
@@ -13239,10 +14367,12 @@ Update the details of a specific User attribute profile, such as name, user_id a
```java -client.userAttributeProfiles().update( - "id", - UpdateUserAttributeProfileRequestContent +client.users().listUsersByEmail( + ListUsersByEmailRequestParameters .builder() + .email("email") + .fields("fields") + .includeFields(true) .build() ); ``` @@ -13259,15 +14389,7 @@ client.userAttributeProfiles().update(
-**id:** `String` — ID of the user attribute profile to update. - -
-
- -
-
- -**name:** `Optional` +**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.
@@ -13275,7 +14397,7 @@ client.userAttributeProfiles().update(
-**userId:** `Optional` +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). Defaults to true.
@@ -13283,7 +14405,7 @@ client.userAttributeProfiles().update(
-**userAttributes:** `Optional>` +**email:** `String` — Email address to search for (case-sensitive).
@@ -13295,8 +14417,7 @@ client.userAttributeProfiles().update(
-## UserBlocks -
client.userBlocks.listByIdentifier() -> ListUserBlocksByIdentifierResponseContent +
client.users.get(id) -> GetUserResponseContent
@@ -13308,7 +14429,7 @@ client.userAttributeProfiles().update(
-Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for a user with the given identifier (username, phone number, or email). +Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see [Retrieve Users with the Get Users Endpoint](https://auth0.com/docs/manage-users/user-search/retrieve-users-with-get-users-endpoint).
@@ -13323,11 +14444,12 @@ Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/a
```java -client.userBlocks().listByIdentifier( - ListUserBlocksByIdentifierRequestParameters +client.users().get( + "id", + GetUserRequestParameters .builder() - .identifier("identifier") - .considerBruteForceEnablement(true) + .fields("fields") + .includeFields(true) .build() ); ``` @@ -13344,7 +14466,7 @@ client.userBlocks().listByIdentifier(
-**identifier:** `String` — Should be any of a username, phone number, or email. +**id:** `String` — ID of the user to retrieve.
@@ -13352,12 +14474,15 @@ client.userBlocks().listByIdentifier(
-**considerBruteForceEnablement:** `Optional` +**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. + +
+
+
+
- If true and Brute Force Protection is enabled and configured to block logins, will return a list of blocked IP addresses. - If true and Brute Force Protection is disabled, will return an empty list. - +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false).
@@ -13369,7 +14494,7 @@ client.userBlocks().listByIdentifier(
-
client.userBlocks.deleteByIdentifier() +
client.users.delete(id)
@@ -13381,9 +14506,7 @@ client.userBlocks().listByIdentifier(
-Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given identifier (username, phone number, or email). - -Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user). +Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see [Delete Users](https://auth0.com/docs/manage-users/user-accounts/delete-users).
@@ -13398,12 +14521,7 @@ Note: This endpoint does not unblock users that were [blocked by a tenant admini
```java -client.userBlocks().deleteByIdentifier( - DeleteUserBlocksByIdentifierRequestParameters - .builder() - .identifier("identifier") - .build() -); +client.users().delete("id"); ```
@@ -13418,7 +14536,7 @@ client.userBlocks().deleteByIdentifier(
-**identifier:** `String` — Should be any of a username, phone number, or email. +**id:** `String` — ID of the user to delete.
@@ -13430,19 +14548,109 @@ client.userBlocks().deleteByIdentifier(
-
client.userBlocks.list(id) -> ListUserBlocksResponseContent -
-
+
client.users.update(id, request) -> UpdateUserResponseContent +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Update a user. + +These are the attributes that can be updated at the root level: + +- app_metadata +- blocked +- email +- email_verified +- family_name +- given_name +- name +- nickname +- password +- phone_number +- phone_verified +- picture +- username +- user_metadata +- verify_email + +Some considerations: + +- The properties of the new object will replace the old ones. +- The metadata fields are an exception to this rule (`user_metadata` and `app_metadata`). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level. +- If you are updating `email`, `email_verified`, `phone_number`, `phone_verified`, `username` or `password` of a secondary identity, you need to specify the `connection` property too. +- If you are updating `email` or `phone_number` you can specify, optionally, the `client_id` property. +- Updating `email_verified` is not supported for enterprise and passwordless sms connections. +- Updating the `blocked` to `false` does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state. +- Supported attributes can be unset by supplying `null` as the value. + +**Updating a field (non-metadata property)** + +To mark the email address of a user as verified, the body to send should be: + +```json +{ "email_verified": true } +``` + +**Updating a user metadata root property** + +Let's assume that our test user has the following `user_metadata`: + +```json +{ "user_metadata" : { "profileCode": 1479 } } +``` + +To add the field `addresses` the body to send should be: + +```json +{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }} +``` + +The modified object ends up with the following `user_metadata` property: + +```json +{ + "user_metadata": { + "profileCode": 1479, + "addresses": { "work_address": "100 Industrial Way" } + } +} +``` + +**Updating an inner user metadata property** -#### 📝 Description +If there's existing user metadata to which we want to add `"home_address": "742 Evergreen Terrace"` (using the `addresses` property) we should send the whole `addresses` object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be: -
-
+```json +{ + "user_metadata": { + "addresses": { + "work_address": "100 Industrial Way", + "home_address": "742 Evergreen Terrace" + } + } +} +``` -
-
+The modified object ends up with the following `user_metadata` property: -Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID. +```json +{ + "user_metadata": { + "profileCode": 1479, + "addresses": { + "work_address": "100 Industrial Way", + "home_address": "742 Evergreen Terrace" + } + } +} +```
@@ -13457,11 +14665,10 @@ Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/a
```java -client.userBlocks().list( +client.users().update( "id", - ListUserBlocksRequestParameters + UpdateUserRequestContent .builder() - .considerBruteForceEnablement(true) .build() ); ``` @@ -13478,7 +14685,7 @@ client.userBlocks().list(
-**id:** `String` — user_id of the user blocks to retrieve. +**id:** `String` — ID of the user to update.
@@ -13486,154 +14693,71 @@ client.userBlocks().list(
-**considerBruteForceEnablement:** `Optional` - - - If true and Brute Force Protection is enabled and configured to block logins, will return a list of blocked IP addresses. - If true and Brute Force Protection is disabled, will return an empty list. - +**blocked:** `Optional` — Whether this user was blocked by an administrator (true) or not (false).
-
-
- - -
-
-
- -
client.userBlocks.delete(id) -
-
- -#### 📝 Description
-
-
- -Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID. - -Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user). -
-
+**emailVerified:** `Optional` — Whether this email address is verified (true) or unverified (false). If set to false the user will not receive a verification email unless `verify_email` is set to true. +
-#### 🔌 Usage -
-
-
- -```java -client.userBlocks().delete("id"); -``` -
-
+**email:** `Optional` — Email address of this user. +
-#### ⚙️ Parameters -
-
-
- -**id:** `String` — The user_id of the user to update. +**phoneNumber:** `Optional` — The user's phone number (following the E.164 recommendation).
-
-
+
+
+**phoneVerified:** `Optional` — Whether this phone number has been verified (true) or not (false). +
-
-## Users -
client.users.list() -> SyncPagingIterable&lt;UserResponseSchema&gt;
-#### 📝 Description - -
-
+**userMetadata:** `Optional>` — User metadata to which this user has read/write access. + +
+
-Retrieve details of users. It is possible to: - -- Specify a search criteria for users -- Sort the users to be returned -- Select the fields to be returned -- Specify the number of users to retrieve per page and the page index - - - -The `q` query parameter can be used to get users that match the specified criteria [using query string syntax.](https://auth0.com/docs/users/search/v3/query-syntax) - -[Learn more about searching for users.](https://auth0.com/docs/users/search/v3) - -Read about [best practices](https://auth0.com/docs/users/search/best-practices) when working with the API endpoints for retrieving users. - - - -Auth0 limits the number of users you can return. If you exceed this threshold, please redefine your search, use the [export job](https://auth0.com/docs/api/management/v2#!/Jobs/post_users_exports), or the [User Import / Export](https://auth0.com/docs/extensions/user-import-export) extension. -
-
+**appMetadata:** `Optional>` — User metadata to which this user has read-only access. +
-#### 🔌 Usage - -
-
-
-```java -client.users().list( - ListUsersRequestParameters - .builder() - .page(1) - .perPage(1) - .includeTotals(true) - .sort("sort") - .connection("connection") - .fields("fields") - .includeFields(true) - .q("q") - .searchEngine(SearchEngineVersionsEnum.V1) - .primaryOrder(true) - .build() -); -``` -
-
+**givenName:** `Optional` — Given name/first name/forename of this user. +
-#### ⚙️ Parameters -
-
-
- -**page:** `Optional` — Page index of the results to return. First page is 0. +**familyName:** `Optional` — Family name/last name/surname of this user.
@@ -13641,7 +14765,7 @@ client.users().list(
-**perPage:** `Optional` — Number of results per page. +**name:** `Optional` — Name of this user.
@@ -13649,7 +14773,7 @@ client.users().list(
-**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). +**nickname:** `Optional` — Preferred nickname or alias of this user.
@@ -13657,7 +14781,7 @@ client.users().list(
-**sort:** `Optional` — Field to sort by. Use field:order where order is 1 for ascending and -1 for descending. e.g. created_at:1 +**picture:** `Optional` — URL to picture, photo, or avatar of this user.
@@ -13665,7 +14789,7 @@ client.users().list(
-**connection:** `Optional` — Connection filter. Only applies when using search_engine=v1. To filter by connection with search_engine=v2|v3, use q=identities.connection:"connection_name" +**verifyEmail:** `Optional` — Whether this user will receive a verification email after creation (true) or no email (false). Overrides behavior of `email_verified` parameter.
@@ -13673,7 +14797,7 @@ client.users().list(
-**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. +**verifyPhoneNumber:** `Optional` — Whether this user will receive a text after changing the phone number (true) or no text (false). Only valid when changing phone number for SMS connections.
@@ -13681,7 +14805,7 @@ client.users().list(
-**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). +**password:** `Optional` — New password for this user. Only valid for database connections.
@@ -13689,7 +14813,7 @@ client.users().list(
-**q:** `Optional` — Query in Lucene query string syntax. Some query types cannot be used on metadata fields, for details see Searchable Fields. +**connection:** `Optional` — Name of the connection to target for this user update.
@@ -13697,7 +14821,7 @@ client.users().list(
-**searchEngine:** `Optional` — The version of the search engine +**clientId:** `Optional` — Auth0 client ID. Only valid when updating email address.
@@ -13705,7 +14829,7 @@ client.users().list(
-**primaryOrder:** `Optional` — If true (default), results are returned in a deterministic order. If false, results may be returned in a non-deterministic order, which can enhance performance for complex queries targeting a small number of users. Set to false only when consistent ordering and pagination is not required. +**username:** `Optional` — The user's username. Only valid if the connection requires a username.
@@ -13717,7 +14841,7 @@ client.users().list(
-
client.users.create(request) -> CreateUserResponseContent +
client.users.regenerateRecoveryCode(id) -> RegenerateUsersRecoveryCodeResponseContent
@@ -13729,9 +14853,7 @@ client.users().list(
-Create a new user for a given [database](https://auth0.com/docs/connections/database) or [passwordless](https://auth0.com/docs/connections/passwordless) connection. - -Note: `connection` is required but other parameters such as `email` and `password` are dependent upon the type of connection. +Remove an existing multi-factor authentication (MFA) [recovery code](https://auth0.com/docs/secure/multi-factor-authentication/reset-user-mfa) and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate.
@@ -13746,12 +14868,7 @@ Note: `connection` is required but other parameters such as `email` and `passwor
```java -client.users().create( - CreateUserRequestContent - .builder() - .connection("connection") - .build() -); +client.users().regenerateRecoveryCode("id"); ```
@@ -13766,47 +14883,66 @@ client.users().create(
-**email:** `Optional` — The user's email. +**id:** `String` — ID of the user to regenerate a multi-factor authentication recovery code for.
+
+
-
-
-**phoneNumber:** `Optional` — The user's phone number (following the E.164 recommendation). -
+
+
client.users.revokeAccess(id, request)
-**userMetadata:** `Optional>` - -
-
+#### 📝 Description
-**blocked:** `Optional` — Whether this user was blocked by an administrator (true) or not (false). - +
+
+ +Revokes selected resources related to a user (sessions, refresh tokens, ...). +
+
+#### 🔌 Usage +
-**emailVerified:** `Optional` — Whether this email address is verified (true) or unverified (false). User will receive a verification email after creation if `email_verified` is false or not specified - +
+
+ +```java +client.users().revokeAccess( + "id", + RevokeUserAccessRequestContent + .builder() + .build() +); +``` +
+
+#### ⚙️ Parameters +
-**phoneVerified:** `Optional` — Whether this phone number has been verified (true) or not (false). +
+
+ +**id:** `String` — ID of the user.
@@ -13814,7 +14950,7 @@ client.users().create(
-**appMetadata:** `Optional>` +**sessionId:** `Optional` — ID of the session to revoke.
@@ -13822,63 +14958,69 @@ client.users().create(
-**givenName:** `Optional` — The user's given name(s). +**preserveRefreshTokens:** `Optional` — Whether to preserve the refresh tokens associated with the session.
+
+
-
-
-**familyName:** `Optional` — The user's family name(s). -
+
+ +## Actions Versions +
client.actions.versions.list(actionId) -> SyncPagingIterable&lt;ActionVersion&gt; +
+
+ +#### 📝 Description
-**name:** `Optional` — The user's full name. - -
-
-
-**nickname:** `Optional` — The user's nickname. - +Retrieve all of an action's versions. An action version is created whenever an action is deployed. An action version is immutable, once created. +
+
+#### 🔌 Usage +
-**picture:** `Optional` — A URI pointing to the user's picture. - -
-
-
-**userId:** `Optional` — The external user's id provided by the identity provider. - +```java +client.actions().versions().list( + "actionId", + ListActionVersionsRequestParameters + .builder() + .page(1) + .perPage(1) + .build() +); +``` +
+
+#### ⚙️ Parameters +
-**connection:** `String` — Name of the connection this user should be created in. - -
-
-
-**password:** `Optional` — Initial password for this user. Only valid for auth0 connection strategy. +**actionId:** `String` — The ID of the action.
@@ -13886,7 +15028,7 @@ client.users().create(
-**verifyEmail:** `Optional` — Whether the user will receive a verification email after creation (true) or no email (false). Overrides behavior of `email_verified` parameter. +**page:** `Optional` — Use this field to request a specific page of the list results.
@@ -13894,7 +15036,7 @@ client.users().create(
-**username:** `Optional` — The user's username. Only valid if the connection requires a username. +**perPage:** `Optional` — This field specify the maximum number of results to be returned by the server. 20 by default
@@ -13906,7 +15048,7 @@ client.users().create(
-
client.users.listUsersByEmail() -> List&lt;UserResponseSchema&gt; +
client.actions.versions.get(actionId, id) -> GetActionVersionResponseContent
@@ -13918,11 +15060,7 @@ client.users().create(
-Find users by email. If Auth0 is the identity provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it. - -For example, if you register a user as JohnSmith@example.com, Auth0 saves the user's email as johnsmith@example.com. - -Therefore, when using this endpoint, make sure that you are searching for users via email addresses using the correct case. +Retrieve a specific version of an action. An action version is created whenever an action is deployed. An action version is immutable, once created.
@@ -13937,14 +15075,7 @@ Therefore, when using this endpoint, make sure that you are searching for users
```java -client.users().listUsersByEmail( - ListUsersByEmailRequestParameters - .builder() - .email("email") - .fields("fields") - .includeFields(true) - .build() -); +client.actions().versions().get("actionId", "id"); ```
@@ -13959,15 +15090,7 @@ client.users().listUsersByEmail(
-**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. - -
-
- -
-
- -**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). Defaults to true. +**actionId:** `String` — The ID of the action.
@@ -13975,7 +15098,7 @@ client.users().listUsersByEmail(
-**email:** `String` — Email address to search for (case-sensitive). +**id:** `String` — The ID of the action version.
@@ -13987,7 +15110,7 @@ client.users().listUsersByEmail(
-
client.users.get(id) -> GetUserResponseContent +
client.actions.versions.deploy(actionId, id, request) -> DeployActionVersionResponseContent
@@ -13999,7 +15122,7 @@ client.users().listUsersByEmail(
-Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see [Retrieve Users with the Get Users Endpoint](https://auth0.com/docs/manage-users/user-search/retrieve-users-with-get-users-endpoint). +Performs the equivalent of a roll-back of an action to an earlier, specified version. Creates a new, deployed action version that is identical to the specified version. If this action is currently bound to a trigger, the system will begin executing the newly-created version immediately.
@@ -14014,13 +15137,14 @@ Retrieve user details. A list of fields to include or exclude may also be specif
```java -client.users().get( +client.actions().versions().deploy( + "actionId", "id", - GetUserRequestParameters - .builder() - .fields("fields") - .includeFields(true) - .build() + OptionalNullable.of( + DeployActionVersionRequestContent + .builder() + .build() + ) ); ```
@@ -14036,7 +15160,7 @@ client.users().get(
-**id:** `String` — ID of the user to retrieve. +**actionId:** `String` — The ID of an action.
@@ -14044,7 +15168,7 @@ client.users().get(
-**fields:** `Optional` — Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. +**id:** `String` — The ID of an action version.
@@ -14052,7 +15176,7 @@ client.users().get(
-**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). +**request:** `Optional`
@@ -14064,7 +15188,8 @@ client.users().get(
-
client.users.delete(id) +## Actions Executions +
client.actions.executions.get(id) -> GetActionExecutionResponseContent
@@ -14076,7 +15201,7 @@ client.users().get(
-Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see [Delete Users](https://auth0.com/docs/manage-users/user-accounts/delete-users). +Retrieve information about a specific execution of a trigger. Relevant execution IDs will be included in tenant logs generated as part of that authentication flow. Executions will only be stored for 10 days after their creation.
@@ -14091,7 +15216,7 @@ Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard inst
```java -client.users().delete("id"); +client.actions().executions().get("id"); ```
@@ -14106,7 +15231,7 @@ client.users().delete("id");
-**id:** `String` — ID of the user to delete. +**id:** `String` — The ID of the execution to retrieve.
@@ -14118,7 +15243,8 @@ client.users().delete("id");
-
client.users.update(id, request) -> UpdateUserResponseContent +## Actions Modules +
client.actions.modules.list() -> SyncPagingIterable&lt;ActionModuleListItem&gt;
@@ -14130,97 +15256,7 @@ client.users().delete("id");
-Update a user. - -These are the attributes that can be updated at the root level: - -- app_metadata -- blocked -- email -- email_verified -- family_name -- given_name -- name -- nickname -- password -- phone_number -- phone_verified -- picture -- username -- user_metadata -- verify_email - -Some considerations: - -- The properties of the new object will replace the old ones. -- The metadata fields are an exception to this rule (`user_metadata` and `app_metadata`). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level. -- If you are updating `email`, `email_verified`, `phone_number`, `phone_verified`, `username` or `password` of a secondary identity, you need to specify the `connection` property too. -- If you are updating `email` or `phone_number` you can specify, optionally, the `client_id` property. -- Updating `email_verified` is not supported for enterprise and passwordless sms connections. -- Updating the `blocked` to `false` does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state. -- Supported attributes can be unset by supplying `null` as the value. - -**Updating a field (non-metadata property)** - -To mark the email address of a user as verified, the body to send should be: - -```json -{ "email_verified": true } -``` - -**Updating a user metadata root property** - -Let's assume that our test user has the following `user_metadata`: - -```json -{ "user_metadata" : { "profileCode": 1479 } } -``` - -To add the field `addresses` the body to send should be: - -```json -{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }} -``` - -The modified object ends up with the following `user_metadata` property: - -```json -{ - "user_metadata": { - "profileCode": 1479, - "addresses": { "work_address": "100 Industrial Way" } - } -} -``` - -**Updating an inner user metadata property** - -If there's existing user metadata to which we want to add `"home_address": "742 Evergreen Terrace"` (using the `addresses` property) we should send the whole `addresses` object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be: - -```json -{ - "user_metadata": { - "addresses": { - "work_address": "100 Industrial Way", - "home_address": "742 Evergreen Terrace" - } - } -} -``` - -The modified object ends up with the following `user_metadata` property: - -```json -{ - "user_metadata": { - "profileCode": 1479, - "addresses": { - "work_address": "100 Industrial Way", - "home_address": "742 Evergreen Terrace" - } - } -} -``` +Retrieve a paginated list of all Actions Modules with optional filtering and totals.
@@ -14235,10 +15271,11 @@ The modified object ends up with the following `user_metadata` property:
```java -client.users().update( - "id", - UpdateUserRequestContent +client.actions().modules().list( + GetActionModulesRequestParameters .builder() + .page(1) + .perPage(1) .build() ); ``` @@ -14255,7 +15292,7 @@ client.users().update(
-**id:** `String` — ID of the user to update. +**page:** `Optional` — Page index of the results to return. First page is 0.
@@ -14263,39 +15300,67 @@ client.users().update(
-**blocked:** `Optional` — Whether this user was blocked by an administrator (true) or not (false). +**perPage:** `Optional` — Number of results per page. Paging is disabled if parameter not sent.
+
+
-
-
-**emailVerified:** `Optional` — Whether this email address is verified (true) or unverified (false). If set to false the user will not receive a verification email unless `verify_email` is set to true. -
+
+
client.actions.modules.create(request) -> CreateActionModuleResponseContent
-**email:** `Optional` — Email address of this user. - +#### 📝 Description + +
+
+ +
+
+ +Create a new Actions Module for reusable code across actions. +
+
+#### 🔌 Usage +
-**phoneNumber:** `Optional` — The user's phone number (following the E.164 recommendation). - +
+
+ +```java +client.actions().modules().create( + CreateActionModuleRequestContent + .builder() + .name("name") + .code("code") + .build() +); +``` +
+
+#### ⚙️ Parameters + +
+
+
-**phoneVerified:** `Optional` — Whether this phone number has been verified (true) or not (false). +**name:** `String` — The name of the action module.
@@ -14303,7 +15368,7 @@ client.users().update(
-**userMetadata:** `Optional>` — User metadata to which this user has read/write access. +**code:** `String` — The source code of the action module.
@@ -14311,7 +15376,7 @@ client.users().update(
-**appMetadata:** `Optional>` — User metadata to which this user has read-only access. +**secrets:** `Optional>` — The secrets to associate with the action module.
@@ -14319,7 +15384,7 @@ client.users().update(
-**givenName:** `Optional` — Given name/first name/forename of this user. +**dependencies:** `Optional>` — The npm dependencies of the action module.
@@ -14327,7 +15392,7 @@ client.users().update(
-**familyName:** `Optional` — Family name/last name/surname of this user. +**apiVersion:** `Optional` — The API version of the module.
@@ -14335,71 +15400,61 @@ client.users().update(
-**name:** `Optional` — Name of this user. +**publish:** `Optional` — Whether to publish the module immediately after creation.
+
+
-
-
-**nickname:** `Optional` — Preferred nickname or alias of this user. -
+
+
client.actions.modules.get(id) -> GetActionModuleResponseContent
-**picture:** `Optional` — URL to picture, photo, or avatar of this user. - -
-
+#### 📝 Description
-**verifyEmail:** `Optional` — Whether this user will receive a verification email after creation (true) or no email (false). Overrides behavior of `email_verified` parameter. - -
-
-
-**verifyPhoneNumber:** `Optional` — Whether this user will receive a text after changing the phone number (true) or no text (false). Only valid when changing phone number for SMS connections. - +Retrieve details of a specific Actions Module by its unique identifier. +
+
+#### 🔌 Usage +
-**password:** `Optional` — New password for this user. Only valid for database connections. - -
-
-
-**connection:** `Optional` — Name of the connection to target for this user update. - +```java +client.actions().modules().get("id"); +``` +
+
+#### ⚙️ Parameters +
-**clientId:** `Optional` — Auth0 client ID. Only valid when updating email address. - -
-
-
-**username:** `Optional` — The user's username. Only valid if the connection requires a username. +**id:** `String` — The ID of the action module to retrieve.
@@ -14411,7 +15466,7 @@ client.users().update(
-
client.users.regenerateRecoveryCode(id) -> RegenerateUsersRecoveryCodeResponseContent +
client.actions.modules.delete(id)
@@ -14423,7 +15478,7 @@ client.users().update(
-Remove an existing multi-factor authentication (MFA) [recovery code](https://auth0.com/docs/secure/multi-factor-authentication/reset-user-mfa) and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate. +Permanently delete an Actions Module. This will fail if the module is still in use by any actions.
@@ -14438,7 +15493,7 @@ Remove an existing multi-factor authentication (MFA) [recovery code](https://aut
```java -client.users().regenerateRecoveryCode("id"); +client.actions().modules().delete("id"); ```
@@ -14453,7 +15508,7 @@ client.users().regenerateRecoveryCode("id");
-**id:** `String` — ID of the user to regenerate a multi-factor authentication recovery code for. +**id:** `String` — The ID of the Actions Module to delete.
@@ -14465,7 +15520,7 @@ client.users().regenerateRecoveryCode("id");
-
client.users.revokeAccess(id, request) +
client.actions.modules.update(id, request) -> UpdateActionModuleResponseContent
@@ -14477,7 +15532,7 @@ client.users().regenerateRecoveryCode("id");
-Revokes selected resources related to a user (sessions, refresh tokens, ...). +Update properties of an existing Actions Module, such as code, dependencies, or secrets.
@@ -14492,9 +15547,9 @@ Revokes selected resources related to a user (sessions, refresh tokens, ...).
```java -client.users().revokeAccess( +client.actions().modules().update( "id", - RevokeUserAccessRequestContent + UpdateActionModuleRequestContent .builder() .build() ); @@ -14512,7 +15567,7 @@ client.users().revokeAccess(
-**id:** `String` — ID of the user. +**id:** `String` — The ID of the action module to update.
@@ -14520,7 +15575,7 @@ client.users().revokeAccess(
-**sessionId:** `Optional` — ID of the session to revoke. +**code:** `Optional` — The source code of the action module.
@@ -14528,7 +15583,15 @@ client.users().revokeAccess(
-**preserveRefreshTokens:** `Optional` — Whether to preserve the refresh tokens associated with the session. +**secrets:** `Optional>` — The secrets to associate with the action module. + +
+
+ +
+
+ +**dependencies:** `Optional>` — The npm dependencies of the action module.
@@ -14540,8 +15603,7 @@ client.users().revokeAccess(
-## Actions Versions -
client.actions.versions.list(actionId) -> SyncPagingIterable&lt;ActionVersion&gt; +
client.actions.modules.listActions(id) -> SyncPagingIterable&lt;ActionModuleAction&gt;
@@ -14553,7 +15615,7 @@ client.users().revokeAccess(
-Retrieve all of an action's versions. An action version is created whenever an action is deployed. An action version is immutable, once created. +Lists all actions that are using a specific Actions Module, showing which deployed action versions reference this Actions Module.
@@ -14568,9 +15630,9 @@ Retrieve all of an action's versions. An action version is created whenever an a
```java -client.actions().versions().list( - "actionId", - ListActionVersionsRequestParameters +client.actions().modules().listActions( + "id", + GetActionModuleActionsRequestParameters .builder() .page(1) .perPage(1) @@ -14590,7 +15652,7 @@ client.actions().versions().list(
-**actionId:** `String` — The ID of the action. +**id:** `String` — The unique ID of the module.
@@ -14598,7 +15660,7 @@ client.actions().versions().list(
-**page:** `Optional` — Use this field to request a specific page of the list results. +**page:** `Optional` — Page index of the results to return. First page is 0.
@@ -14606,7 +15668,7 @@ client.actions().versions().list(
-**perPage:** `Optional` — This field specify the maximum number of results to be returned by the server. 20 by default +**perPage:** `Optional` — Number of results per page.
@@ -14618,7 +15680,7 @@ client.actions().versions().list(
-
client.actions.versions.get(actionId, id) -> GetActionVersionResponseContent +
client.actions.modules.rollback(id, request) -> RollbackActionModuleResponseContent
@@ -14630,7 +15692,7 @@ client.actions().versions().list(
-Retrieve a specific version of an action. An action version is created whenever an action is deployed. An action version is immutable, once created. +Rolls back an Actions Module's draft to a previously created version. This action copies the code, dependencies, and secrets from the specified version into the current draft.
@@ -14645,7 +15707,13 @@ Retrieve a specific version of an action. An action version is created whenever
```java -client.actions().versions().get("actionId", "id"); +client.actions().modules().rollback( + "id", + RollbackActionModuleRequestParameters + .builder() + .moduleVersionId("module_version_id") + .build() +); ```
@@ -14660,7 +15728,7 @@ client.actions().versions().get("actionId", "id");
-**actionId:** `String` — The ID of the action. +**id:** `String` — The unique ID of the module to roll back.
@@ -14668,7 +15736,7 @@ client.actions().versions().get("actionId", "id");
-**id:** `String` — The ID of the action version. +**moduleVersionId:** `String` — The unique ID of the module version to roll back to.
@@ -14680,7 +15748,8 @@ client.actions().versions().get("actionId", "id");
-
client.actions.versions.deploy(actionId, id, request) -> DeployActionVersionResponseContent +## Actions Triggers +
client.actions.triggers.list() -> ListActionTriggersResponseContent
@@ -14692,7 +15761,7 @@ client.actions().versions().get("actionId", "id");
-Performs the equivalent of a roll-back of an action to an earlier, specified version. Creates a new, deployed action version that is identical to the specified version. If this action is currently bound to a trigger, the system will begin executing the newly-created version immediately. +Retrieve the set of triggers currently available within actions. A trigger is an extensibility point to which actions can be bound.
@@ -14707,14 +15776,53 @@ Performs the equivalent of a roll-back of an action to an earlier, specified ver
```java -client.actions().versions().deploy( - "actionId", +client.actions().triggers().list(); +``` +
+
+ + + + + + +
+ +## Actions Modules Versions +
client.actions.modules.versions.list(id) -> SyncPagingIterable&lt;ActionModuleVersion&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +List all published versions of a specific Actions Module. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.actions().modules().versions().list( "id", - OptionalNullable.of( - DeployActionVersionRequestContent - .builder() - .build() - ) + GetActionModuleVersionsRequestParameters + .builder() + .page(1) + .perPage(1) + .build() ); ```
@@ -14730,7 +15838,7 @@ client.actions().versions().deploy(
-**actionId:** `String` — The ID of an action. +**id:** `String` — The unique ID of the module.
@@ -14738,7 +15846,7 @@ client.actions().versions().deploy(
-**id:** `String` — The ID of an action version. +**page:** `Optional` — Use this field to request a specific page of the list results.
@@ -14746,7 +15854,7 @@ client.actions().versions().deploy(
-**request:** `Optional` +**perPage:** `Optional` — The maximum number of results to be returned by the server in a single response. 20 by default.
@@ -14758,8 +15866,7 @@ client.actions().versions().deploy(
-## Actions Executions -
client.actions.executions.get(id) -> GetActionExecutionResponseContent +
client.actions.modules.versions.create(id) -> CreateActionModuleVersionResponseContent
@@ -14771,7 +15878,7 @@ client.actions().versions().deploy(
-Retrieve information about a specific execution of a trigger. Relevant execution IDs will be included in tenant logs generated as part of that authentication flow. Executions will only be stored for 10 days after their creation. +Creates a new immutable version of an Actions Module from the current draft version. This publishes the draft as a new version that can be referenced by actions, while maintaining the existing draft for continued development.
@@ -14786,7 +15893,7 @@ Retrieve information about a specific execution of a trigger. Relevant execution
```java -client.actions().executions().get("id"); +client.actions().modules().versions().create("id"); ```
@@ -14801,7 +15908,69 @@ client.actions().executions().get("id");
-**id:** `String` — The ID of the execution to retrieve. +**id:** `String` — The ID of the action module to create a version for. + +
+
+ + + + + + +
+ +
client.actions.modules.versions.get(id, versionId) -> GetActionModuleVersionResponseContent +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve the details of a specific, immutable version of an Actions Module. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.actions().modules().versions().get("id", "versionId"); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique ID of the module. + +
+
+ +
+
+ +**versionId:** `String` — The unique ID of the module version to retrieve.
@@ -14813,8 +15982,8 @@ client.actions().executions().get("id");
-## Actions Modules -
client.actions.modules.list() -> SyncPagingIterable&lt;ActionModuleListItem&gt; +## Actions Triggers Bindings +
client.actions.triggers.bindings.list(triggerId) -> SyncPagingIterable&lt;ActionBinding&gt;
@@ -14826,7 +15995,7 @@ client.actions().executions().get("id");
-Retrieve a paginated list of all Actions Modules with optional filtering and totals. +Retrieve the actions that are bound to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The list of actions returned reflects the order in which they will be executed during the appropriate flow.
@@ -14841,8 +16010,9 @@ Retrieve a paginated list of all Actions Modules with optional filtering and tot
```java -client.actions().modules().list( - GetActionModulesRequestParameters +client.actions().triggers().bindings().list( + ActionTriggerTypeEnum.POST_LOGIN, + ListActionTriggerBindingsRequestParameters .builder() .page(1) .perPage(1) @@ -14862,7 +16032,7 @@ client.actions().modules().list(
-**page:** `Optional` — Page index of the results to return. First page is 0. +**triggerId:** `ActionTriggerTypeEnum` — An actions extensibility point.
@@ -14870,7 +16040,15 @@ client.actions().modules().list(
-**perPage:** `Optional` — Number of results per page. Paging is disabled if parameter not sent. +**page:** `Optional` — Use this field to request a specific page of the list results. + +
+
+ +
+
+ +**perPage:** `Optional` — The maximum number of results to be returned in a single request. 20 by default
@@ -14882,7 +16060,7 @@ client.actions().modules().list(
-
client.actions.modules.create(request) -> CreateActionModuleResponseContent +
client.actions.triggers.bindings.updateMany(triggerId, request) -> UpdateActionBindingsResponseContent
@@ -14894,7 +16072,7 @@ client.actions().modules().list(
-Create a new Actions Module for reusable code across actions. +Update the actions that are bound (i.e. attached) to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The order in which the actions are provided will determine the order in which they are executed.
@@ -14909,11 +16087,10 @@ Create a new Actions Module for reusable code across actions.
```java -client.actions().modules().create( - CreateActionModuleRequestContent +client.actions().triggers().bindings().updateMany( + ActionTriggerTypeEnum.POST_LOGIN, + UpdateActionBindingsRequestContent .builder() - .name("name") - .code("code") .build() ); ``` @@ -14930,7 +16107,7 @@ client.actions().modules().create(
-**name:** `String` — The name of the action module. +**triggerId:** `ActionTriggerTypeEnum` — An actions extensibility point.
@@ -14938,39 +16115,62 @@ client.actions().modules().create(
-**code:** `String` — The source code of the action module. +**bindings:** `Optional>` — The actions that will be bound to this trigger. The order in which they are included will be the order in which they are executed.
+
+
-
-
-**secrets:** `Optional>` — The secrets to associate with the action module. -
+
+## Anomaly Blocks +
client.anomaly.blocks.checkIp(id)
-**dependencies:** `Optional>` — The npm dependencies of the action module. - +#### 📝 Description + +
+
+ +
+
+ +Check if the given IP address is blocked via the Suspicious IP Throttling due to multiple suspicious attempts. +
+
+#### 🔌 Usage +
-**apiVersion:** `Optional` — The API version of the module. - +
+
+ +```java +client.anomaly().blocks().checkIp("id"); +``` +
+
+#### ⚙️ Parameters +
-**publish:** `Optional` — Whether to publish the module immediately after creation. +
+
+ +**id:** `String` — IP address to check.
@@ -14982,7 +16182,7 @@ client.actions().modules().create(
-
client.actions.modules.get(id) -> GetActionModuleResponseContent +
client.anomaly.blocks.unblockIp(id)
@@ -14994,7 +16194,7 @@ client.actions().modules().create(
-Retrieve details of a specific Actions Module by its unique identifier. +Remove a block imposed by Suspicious IP Throttling for the given IP address.
@@ -15009,7 +16209,7 @@ Retrieve details of a specific Actions Module by its unique identifier.
```java -client.actions().modules().get("id"); +client.anomaly().blocks().unblockIp("id"); ```
@@ -15024,7 +16224,7 @@ client.actions().modules().get("id");
-**id:** `String` — The ID of the action module to retrieve. +**id:** `String` — IP address to unblock.
@@ -15036,7 +16236,8 @@ client.actions().modules().get("id");
-
client.actions.modules.delete(id) +## AttackProtection BotDetection +
client.attackProtection.botDetection.get() -> GetBotDetectionSettingsResponseContent
@@ -15048,7 +16249,7 @@ client.actions().modules().get("id");
-Permanently delete an Actions Module. This will fail if the module is still in use by any actions. +Get the Bot Detection configuration of your tenant.
@@ -15063,34 +16264,19 @@ Permanently delete an Actions Module. This will fail if the module is still in u
```java -client.actions().modules().delete("id"); +client.attackProtection().botDetection().get(); ```
-#### ⚙️ Parameters - -
-
- -
-
- -**id:** `String` — The ID of the Actions Module to delete. - -
-
-
-
-
-
client.actions.modules.update(id, request) -> UpdateActionModuleResponseContent +
client.attackProtection.botDetection.update(request) -> UpdateBotDetectionSettingsResponseContent
@@ -15102,7 +16288,7 @@ client.actions().modules().delete("id");
-Update properties of an existing Actions Module, such as code, dependencies, or secrets. +Update the Bot Detection configuration of your tenant.
@@ -15117,9 +16303,8 @@ Update properties of an existing Actions Module, such as code, dependencies, or
```java -client.actions().modules().update( - "id", - UpdateActionModuleRequestContent +client.attackProtection().botDetection().update( + UpdateBotDetectionSettingsRequestContent .builder() .build() ); @@ -15137,7 +16322,7 @@ client.actions().modules().update(
-**id:** `String` — The ID of the action module to update. +**botDetectionLevel:** `Optional`
@@ -15145,7 +16330,7 @@ client.actions().modules().update(
-**code:** `Optional` — The source code of the action module. +**challengePasswordPolicy:** `Optional`
@@ -15153,7 +16338,7 @@ client.actions().modules().update(
-**secrets:** `Optional>` — The secrets to associate with the action module. +**challengePasswordlessPolicy:** `Optional`
@@ -15161,60 +16346,40 @@ client.actions().modules().update(
-**dependencies:** `Optional>` — The npm dependencies of the action module. +**challengePasswordResetPolicy:** `Optional`
-
-
- - - -
- -
client.actions.modules.listActions(id) -> SyncPagingIterable&lt;ActionModuleAction&gt;
-#### 📝 Description - -
-
+**allowlist:** `Optional>` + +
+
-Lists all actions that are using a specific Actions Module, showing which deployed action versions reference this Actions Module. +**monitoringModeEnabled:** `Optional` +
-#### 🔌 Usage -
-
+
+
+
+## AttackProtection BreachedPasswordDetection +
client.attackProtection.breachedPasswordDetection.get() -> GetBreachedPasswordDetectionSettingsResponseContent
-```java -client.actions().modules().listActions( - "id", - GetActionModuleActionsRequestParameters - .builder() - .page(1) - .perPage(1) - .build() -); -``` -
-
- - - -#### ⚙️ Parameters +#### 📝 Description
@@ -15222,24 +16387,23 @@ client.actions().modules().listActions(
-**id:** `String` — The unique ID of the module. - +Retrieve details of the Breached Password Detection configuration of your tenant. +
+
+#### 🔌 Usage +
-**page:** `Optional` — Page index of the results to return. First page is 0. - -
-
-
-**perPage:** `Optional` — Number of results per page. - +```java +client.attackProtection().breachedPasswordDetection().get(); +```
@@ -15250,7 +16414,7 @@ client.actions().modules().listActions(
-
client.actions.modules.rollback(id, request) -> RollbackActionModuleResponseContent +
client.attackProtection.breachedPasswordDetection.update(request) -> UpdateBreachedPasswordDetectionSettingsResponseContent
@@ -15262,7 +16426,7 @@ client.actions().modules().listActions(
-Rolls back an Actions Module's draft to a previously created version. This action copies the code, dependencies, and secrets from the specified version into the current draft. +Update details of the Breached Password Detection configuration of your tenant.
@@ -15277,11 +16441,9 @@ Rolls back an Actions Module's draft to a previously created version. This actio
```java -client.actions().modules().rollback( - "id", - RollbackActionModuleRequestParameters +client.attackProtection().breachedPasswordDetection().update( + UpdateBreachedPasswordDetectionSettingsRequestContent .builder() - .moduleVersionId("module_version_id") .build() ); ``` @@ -15298,7 +16460,7 @@ client.actions().modules().rollback(
-**id:** `String` — The unique ID of the module to roll back. +**enabled:** `Optional` — Whether or not breached password detection is active.
@@ -15306,7 +16468,37 @@ client.actions().modules().rollback(
-**moduleVersionId:** `String` — The unique ID of the module version to roll back to. +**shields:** `Optional>` + +Action to take when a breached password is detected during a login. + Possible values: block, user_notification, admin_notification. + +
+
+ +
+
+ +**adminNotificationFrequency:** `Optional>` + +When "admin_notification" is enabled, determines how often email notifications are sent. + Possible values: immediately, daily, weekly, monthly. + +
+
+ +
+
+ +**method:** `Optional` + +
+
+ +
+
+ +**stage:** `Optional`
@@ -15318,8 +16510,8 @@ client.actions().modules().rollback(
-## Actions Triggers -
client.actions.triggers.list() -> ListActionTriggersResponseContent +## AttackProtection BruteForceProtection +
client.attackProtection.bruteForceProtection.get() -> GetBruteForceSettingsResponseContent
@@ -15331,7 +16523,7 @@ client.actions().modules().rollback(
-Retrieve the set of triggers currently available within actions. A trigger is an extensibility point to which actions can be bound. +Retrieve details of the Brute-force Protection configuration of your tenant.
@@ -15346,7 +16538,7 @@ Retrieve the set of triggers currently available within actions. A trigger is an
```java -client.actions().triggers().list(); +client.attackProtection().bruteForceProtection().get(); ```
@@ -15358,8 +16550,7 @@ client.actions().triggers().list();
-## Actions Modules Versions -
client.actions.modules.versions.list(id) -> SyncPagingIterable&lt;ActionModuleVersion&gt; +
client.attackProtection.bruteForceProtection.update(request) -> UpdateBruteForceSettingsResponseContent
@@ -15371,7 +16562,7 @@ client.actions().triggers().list();
-List all published versions of a specific Actions Module. +Update the Brute-force Protection configuration of your tenant.
@@ -15386,12 +16577,9 @@ List all published versions of a specific Actions Module.
```java -client.actions().modules().versions().list( - "id", - GetActionModuleVersionsRequestParameters +client.attackProtection().bruteForceProtection().update( + UpdateBruteForceSettingsRequestContent .builder() - .page(1) - .perPage(1) .build() ); ``` @@ -15400,15 +16588,34 @@ client.actions().modules().versions().list(
-#### ⚙️ Parameters - +#### ⚙️ Parameters + +
+
+ +
+
+ +**enabled:** `Optional` — Whether or not brute force attack protections are active. + +
+
+
+**shields:** `Optional>` + +Action to take when a brute force protection threshold is violated. + Possible values: block, user_notification. + +
+
+
-**id:** `String` — The unique ID of the module. +**allowlist:** `Optional>` — List of trusted IP addresses that will not have attack protection enforced against them.
@@ -15416,7 +16623,7 @@ client.actions().modules().versions().list(
-**page:** `Optional` — Use this field to request a specific page of the list results. +**mode:** `Optional`
@@ -15424,7 +16631,7 @@ client.actions().modules().versions().list(
-**perPage:** `Optional` — The maximum number of results to be returned by the server in a single response. 20 by default. +**maxAttempts:** `Optional` — Maximum number of unsuccessful attempts.
@@ -15436,7 +16643,8 @@ client.actions().modules().versions().list(
-
client.actions.modules.versions.create(id) -> CreateActionModuleVersionResponseContent +## AttackProtection Captcha +
client.attackProtection.captcha.get() -> GetAttackProtectionCaptchaResponseContent
@@ -15448,7 +16656,7 @@ client.actions().modules().versions().list(
-Creates a new immutable version of an Actions Module from the current draft version. This publishes the draft as a new version that can be referenced by actions, while maintaining the existing draft for continued development. +Get the CAPTCHA configuration for your client.
@@ -15463,34 +16671,19 @@ Creates a new immutable version of an Actions Module from the current draft vers
```java -client.actions().modules().versions().create("id"); +client.attackProtection().captcha().get(); ```
-#### ⚙️ Parameters - -
-
- -
-
- -**id:** `String` — The ID of the action module to create a version for. - -
-
-
-
-
-
client.actions.modules.versions.get(id, versionId) -> GetActionModuleVersionResponseContent +
client.attackProtection.captcha.update(request) -> UpdateAttackProtectionCaptchaResponseContent
@@ -15502,7 +16695,7 @@ client.actions().modules().versions().create("id");
-Retrieve the details of a specific, immutable version of an Actions Module. +Update existing CAPTCHA configuration for your client.
@@ -15517,7 +16710,11 @@ Retrieve the details of a specific, immutable version of an Actions Module.
```java -client.actions().modules().versions().get("id", "versionId"); +client.attackProtection().captcha().update( + UpdateAttackProtectionCaptchaRequestContent + .builder() + .build() +); ```
@@ -15532,7 +16729,7 @@ client.actions().modules().versions().get("id", "versionId");
-**id:** `String` — The unique ID of the module. +**activeProviderId:** `Optional`
@@ -15540,86 +16737,96 @@ client.actions().modules().versions().get("id", "versionId");
-**versionId:** `String` — The unique ID of the module version to retrieve. +**arkose:** `Optional`
- - +
+
+**authChallenge:** `Optional` +
-
-## Actions Triggers Bindings -
client.actions.triggers.bindings.list(triggerId) -> SyncPagingIterable&lt;ActionBinding&gt;
-#### 📝 Description +**hcaptcha:** `Optional` + +
+
+**friendlyCaptcha:** `Optional` + +
+
+
-Retrieve the actions that are bound to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The list of actions returned reflects the order in which they will be executed during the appropriate flow. -
-
+**recaptchaEnterprise:** `Optional` + -#### 🔌 Usage -
+**recaptchaV2:** `Optional` + +
+
+
-```java -client.actions().triggers().bindings().list( - ActionTriggerTypeEnum.POST_LOGIN, - ListActionTriggerBindingsRequestParameters - .builder() - .page(1) - .perPage(1) - .build() -); -``` +**simpleCaptcha:** `Optional>` +
-#### ⚙️ Parameters + + +
+ +## AttackProtection PhoneProviderProtection +
client.attackProtection.phoneProviderProtection.get() -> GetPhoneProviderProtectionResponseContent
+#### 📝 Description +
-**triggerId:** `ActionTriggerTypeEnum` — An actions extensibility point. - -
-
-
-**page:** `Optional` — Use this field to request a specific page of the list results. - +Get the phone provider protection configuration for a tenant.
+
+
+ +#### 🔌 Usage
-**perPage:** `Optional` — The maximum number of results to be returned in a single request. 20 by default - +
+
+ +```java +client.attackProtection().phoneProviderProtection().get(); +```
@@ -15630,7 +16837,7 @@ client.actions().triggers().bindings().list(
-
client.actions.triggers.bindings.updateMany(triggerId, request) -> UpdateActionBindingsResponseContent +
client.attackProtection.phoneProviderProtection.patch(request) -> PatchPhoneProviderProtectionResponseContent
@@ -15642,7 +16849,7 @@ client.actions().triggers().bindings().list(
-Update the actions that are bound (i.e. attached) to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The order in which the actions are provided will determine the order in which they are executed. +Update the phone provider protection configuration for a tenant.
@@ -15657,10 +16864,10 @@ Update the actions that are bound (i.e. attached) to a trigger. Once an action i
```java -client.actions().triggers().bindings().updateMany( - ActionTriggerTypeEnum.POST_LOGIN, - UpdateActionBindingsRequestContent +client.attackProtection().phoneProviderProtection().patch( + PatchPhoneProviderProtectionRequestContent .builder() + .type(PhoneProviderProtectionBackoffStrategyEnum.EXPONENTIAL) .build() ); ``` @@ -15677,15 +16884,7 @@ client.actions().triggers().bindings().updateMany(
-**triggerId:** `ActionTriggerTypeEnum` — An actions extensibility point. - -
-
- -
-
- -**bindings:** `Optional>` — The actions that will be bound to this trigger. The order in which they are included will be the order in which they are executed. +**type:** `PhoneProviderProtectionBackoffStrategyEnum`
@@ -15697,8 +16896,8 @@ client.actions().triggers().bindings().updateMany(
-## Anomaly Blocks -
client.anomaly.blocks.checkIp(id) +## AttackProtection SuspiciousIpThrottling +
client.attackProtection.suspiciousIpThrottling.get() -> GetSuspiciousIpThrottlingSettingsResponseContent
@@ -15710,7 +16909,7 @@ client.actions().triggers().bindings().updateMany(
-Check if the given IP address is blocked via the Suspicious IP Throttling due to multiple suspicious attempts. +Retrieve details of the Suspicious IP Throttling configuration of your tenant.
@@ -15725,34 +16924,19 @@ Check if the given IP address is blocked via the
-#### ⚙️ Parameters - -
-
- -
-
- -**id:** `String` — IP address to check. - -
-
-
-
-
-
client.anomaly.blocks.unblockIp(id) +
client.attackProtection.suspiciousIpThrottling.update(request) -> UpdateSuspiciousIpThrottlingSettingsResponseContent
@@ -15764,7 +16948,7 @@ client.anomaly().blocks().checkIp("id");
-Remove a block imposed by Suspicious IP Throttling for the given IP address. +Update the details of the Suspicious IP Throttling configuration of your tenant.
@@ -15779,7 +16963,11 @@ Remove a block imposed by
@@ -15794,36 +16982,49 @@ client.anomaly().blocks().unblockIp("id");
-**id:** `String` — IP address to unblock. +**enabled:** `Optional` — Whether or not suspicious IP throttling attack protections are active.
- - +
+
+ +**shields:** `Optional>` +Action to take when a suspicious IP throttling threshold is violated. + Possible values: block, admin_notification. +
-
-## AttackProtection BotDetection -
client.attackProtection.botDetection.get() -> GetBotDetectionSettingsResponseContent
-#### 📝 Description - -
-
+**allowlist:** `Optional>` + +
+
-Get the Bot Detection configuration of your tenant. +**stage:** `Optional` + +
+
+ + +
+ +## Branding Templates +
client.branding.templates.getUniversalLogin() -> GetUniversalLoginTemplateResponseContent +
+
#### 🔌 Usage @@ -15834,7 +17035,7 @@ Get the Bot Detection configuration of your tenant.
```java -client.attackProtection().botDetection().get(); +client.branding().templates().getUniversalLogin(); ```
@@ -15846,7 +17047,7 @@ client.attackProtection().botDetection().get();
-
client.attackProtection.botDetection.update(request) -> UpdateBotDetectionSettingsResponseContent +
client.branding.templates.updateUniversalLogin(request)
@@ -15858,81 +17059,62 @@ client.attackProtection().botDetection().get();
-Update the Bot Detection configuration of your tenant. -
-
-
-
+Update the Universal Login branding template. -#### 🔌 Usage +When `content-type` header is set to `application/json`: -
-
+```json +{ + "template": "{% assign resolved_dir = dir | default: \"auto\" %}{%- auth0:head -%}{%- auth0:widget -%}" +} +``` -
-
+When `content-type` header is set to `text/html`: -```java -client.attackProtection().botDetection().update( - UpdateBotDetectionSettingsRequestContent - .builder() - .build() -); +```html + +{% assign resolved_dir = dir | default: "auto" %} + + + {%- auth0:head -%} + + + {%- auth0:widget -%} + + ```
-#### ⚙️ Parameters - -
-
+#### 🔌 Usage
-**botDetectionLevel:** `Optional` - -
-
-
-**challengePasswordPolicy:** `Optional` - +```java +client.branding().templates().updateUniversalLogin( + UpdateUniversalLoginTemplateRequestContent.of("string") +); +```
- -
-
- -**challengePasswordlessPolicy:** `Optional` -
-
-
- -**challengePasswordResetPolicy:** `Optional` - -
-
+#### ⚙️ Parameters
-**allowlist:** `Optional>` - -
-
-
-**monitoringModeEnabled:** `Optional` +**request:** `UpdateUniversalLoginTemplateRequestContent`
@@ -15944,25 +17126,10 @@ client.attackProtection().botDetection().update(
-## AttackProtection BreachedPasswordDetection -
client.attackProtection.breachedPasswordDetection.get() -> GetBreachedPasswordDetectionSettingsResponseContent -
-
- -#### 📝 Description - -
-
- +
client.branding.templates.deleteUniversalLogin()
-Retrieve details of the Breached Password Detection configuration of your tenant. -
-
-
-
- #### 🔌 Usage
@@ -15972,7 +17139,7 @@ Retrieve details of the Breached Password Detection configuration of your tenant
```java -client.attackProtection().breachedPasswordDetection().get(); +client.branding().templates().deleteUniversalLogin(); ```
@@ -15984,7 +17151,8 @@ client.attackProtection().breachedPasswordDetection().get();
-
client.attackProtection.breachedPasswordDetection.update(request) -> UpdateBreachedPasswordDetectionSettingsResponseContent +## Branding Themes +
client.branding.themes.create(request) -> CreateBrandingThemeResponseContent
@@ -15996,7 +17164,7 @@ client.attackProtection().breachedPasswordDetection().get();
-Update details of the Breached Password Detection configuration of your tenant. +Create branding theme.
@@ -16011,9 +17179,112 @@ Update details of the Breached Password Detection configuration of your tenant.
```java -client.attackProtection().breachedPasswordDetection().update( - UpdateBreachedPasswordDetectionSettingsRequestContent +client.branding().themes().create( + CreateBrandingThemeRequestContent .builder() + .borders( + BrandingThemeBorders + .builder() + .buttonBorderRadius(1.1) + .buttonBorderWeight(1.1) + .buttonsStyle(BrandingThemeBordersButtonsStyleEnum.PILL) + .inputBorderRadius(1.1) + .inputBorderWeight(1.1) + .inputsStyle(BrandingThemeBordersInputsStyleEnum.PILL) + .showWidgetShadow(true) + .widgetBorderWeight(1.1) + .widgetCornerRadius(1.1) + .build() + ) + .colors( + BrandingThemeColors + .builder() + .bodyText("body_text") + .error("error") + .header("header") + .icons("icons") + .inputBackground("input_background") + .inputBorder("input_border") + .inputFilledText("input_filled_text") + .inputLabelsPlaceholders("input_labels_placeholders") + .linksFocusedComponents("links_focused_components") + .primaryButton("primary_button") + .primaryButtonLabel("primary_button_label") + .secondaryButtonBorder("secondary_button_border") + .secondaryButtonLabel("secondary_button_label") + .success("success") + .widgetBackground("widget_background") + .widgetBorder("widget_border") + .build() + ) + .fonts( + BrandingThemeFonts + .builder() + .bodyText( + BrandingThemeFontBodyText + .builder() + .bold(true) + .size(1.1) + .build() + ) + .buttonsText( + BrandingThemeFontButtonsText + .builder() + .bold(true) + .size(1.1) + .build() + ) + .fontUrl("font_url") + .inputLabels( + BrandingThemeFontInputLabels + .builder() + .bold(true) + .size(1.1) + .build() + ) + .links( + BrandingThemeFontLinks + .builder() + .bold(true) + .size(1.1) + .build() + ) + .linksStyle(BrandingThemeFontLinksStyleEnum.NORMAL) + .referenceTextSize(1.1) + .subtitle( + BrandingThemeFontSubtitle + .builder() + .bold(true) + .size(1.1) + .build() + ) + .title( + BrandingThemeFontTitle + .builder() + .bold(true) + .size(1.1) + .build() + ) + .build() + ) + .pageBackground( + BrandingThemePageBackground + .builder() + .backgroundColor("background_color") + .backgroundImageUrl("background_image_url") + .pageLayout(BrandingThemePageBackgroundPageLayoutEnum.CENTER) + .build() + ) + .widget( + BrandingThemeWidget + .builder() + .headerTextAlignment(BrandingThemeWidgetHeaderTextAlignmentEnum.CENTER) + .logoHeight(1.1) + .logoPosition(BrandingThemeWidgetLogoPositionEnum.CENTER) + .logoUrl("logo_url") + .socialButtonsLayout(BrandingThemeWidgetSocialButtonsLayoutEnum.BOTTOM) + .build() + ) .build() ); ``` @@ -16030,7 +17301,7 @@ client.attackProtection().breachedPasswordDetection().update(
-**enabled:** `Optional` — Whether or not breached password detection is active. +**borders:** `BrandingThemeBorders`
@@ -16038,10 +17309,15 @@ client.attackProtection().breachedPasswordDetection().update(
-**shields:** `Optional>` +**colors:** `BrandingThemeColors` + +
+
-Action to take when a breached password is detected during a login. - Possible values: block, user_notification, admin_notification. +
+
+ +**displayName:** `Optional` — Display Name
@@ -16049,10 +17325,15 @@ Action to take when a breached password is detected during a login.
-**adminNotificationFrequency:** `Optional>` +**fonts:** `BrandingThemeFonts` + +
+
-When "admin_notification" is enabled, determines how often email notifications are sent. - Possible values: immediately, daily, weekly, monthly. +
+
+ +**identifiers:** `Optional`
@@ -16060,7 +17341,7 @@ When "admin_notification" is enabled, determines how often email notifications a
-**method:** `Optional` +**pageBackground:** `BrandingThemePageBackground`
@@ -16068,7 +17349,7 @@ When "admin_notification" is enabled, determines how often email notifications a
-**stage:** `Optional` +**widget:** `BrandingThemeWidget`
@@ -16080,8 +17361,7 @@ When "admin_notification" is enabled, determines how often email notifications a
-## AttackProtection BruteForceProtection -
client.attackProtection.bruteForceProtection.get() -> GetBruteForceSettingsResponseContent +
client.branding.themes.getDefault() -> GetBrandingDefaultThemeResponseContent
@@ -16093,7 +17373,7 @@ When "admin_notification" is enabled, determines how often email notifications a
-Retrieve details of the Brute-force Protection configuration of your tenant. +Retrieve default branding theme.
@@ -16108,7 +17388,7 @@ Retrieve details of the Brute-force Protection configuration of your tenant.
```java -client.attackProtection().bruteForceProtection().get(); +client.branding().themes().getDefault(); ```
@@ -16120,7 +17400,7 @@ client.attackProtection().bruteForceProtection().get();
-
client.attackProtection.bruteForceProtection.update(request) -> UpdateBruteForceSettingsResponseContent +
client.branding.themes.get(themeId) -> GetBrandingThemeResponseContent
@@ -16132,7 +17412,7 @@ client.attackProtection().bruteForceProtection().get();
-Update the Brute-force Protection configuration of your tenant. +Retrieve branding theme.
@@ -16147,11 +17427,7 @@ Update the Brute-force Protection configuration of your tenant.
```java -client.attackProtection().bruteForceProtection().update( - UpdateBruteForceSettingsRequestContent - .builder() - .build() -); +client.branding().themes().get("themeId"); ```
@@ -16166,42 +17442,7 @@ client.attackProtection().bruteForceProtection().update(
-**enabled:** `Optional` — Whether or not brute force attack protections are active. - -
-
- -
-
- -**shields:** `Optional>` - -Action to take when a brute force protection threshold is violated. - Possible values: block, user_notification. - -
-
- -
-
- -**allowlist:** `Optional>` — List of trusted IP addresses that will not have attack protection enforced against them. - -
-
- -
-
- -**mode:** `Optional` - -
-
- -
-
- -**maxAttempts:** `Optional` — Maximum number of unsuccessful attempts. +**themeId:** `String` — The ID of the theme
@@ -16213,8 +17454,7 @@ Action to take when a brute force protection threshold is violated.
-## AttackProtection Captcha -
client.attackProtection.captcha.get() -> GetAttackProtectionCaptchaResponseContent +
client.branding.themes.delete(themeId)
@@ -16226,7 +17466,7 @@ Action to take when a brute force protection threshold is violated.
-Get the CAPTCHA configuration for your client. +Delete branding theme.
@@ -16241,19 +17481,34 @@ Get the CAPTCHA configuration for your client.
```java -client.attackProtection().captcha().get(); +client.branding().themes().delete("themeId"); ```
+#### ⚙️ Parameters + +
+
+ +
+
+ +**themeId:** `String` — The ID of the theme + +
+
+
+
+
-
client.attackProtection.captcha.update(request) -> UpdateAttackProtectionCaptchaResponseContent +
client.branding.themes.update(themeId, request) -> UpdateBrandingThemeResponseContent
@@ -16265,7 +17520,7 @@ client.attackProtection().captcha().get();
-Update existing CAPTCHA configuration for your client. +Update branding theme.
@@ -16280,9 +17535,113 @@ Update existing CAPTCHA configuration for your client.
```java -client.attackProtection().captcha().update( - UpdateAttackProtectionCaptchaRequestContent +client.branding().themes().update( + "themeId", + UpdateBrandingThemeRequestContent .builder() + .borders( + BrandingThemeBorders + .builder() + .buttonBorderRadius(1.1) + .buttonBorderWeight(1.1) + .buttonsStyle(BrandingThemeBordersButtonsStyleEnum.PILL) + .inputBorderRadius(1.1) + .inputBorderWeight(1.1) + .inputsStyle(BrandingThemeBordersInputsStyleEnum.PILL) + .showWidgetShadow(true) + .widgetBorderWeight(1.1) + .widgetCornerRadius(1.1) + .build() + ) + .colors( + BrandingThemeColors + .builder() + .bodyText("body_text") + .error("error") + .header("header") + .icons("icons") + .inputBackground("input_background") + .inputBorder("input_border") + .inputFilledText("input_filled_text") + .inputLabelsPlaceholders("input_labels_placeholders") + .linksFocusedComponents("links_focused_components") + .primaryButton("primary_button") + .primaryButtonLabel("primary_button_label") + .secondaryButtonBorder("secondary_button_border") + .secondaryButtonLabel("secondary_button_label") + .success("success") + .widgetBackground("widget_background") + .widgetBorder("widget_border") + .build() + ) + .fonts( + BrandingThemeFonts + .builder() + .bodyText( + BrandingThemeFontBodyText + .builder() + .bold(true) + .size(1.1) + .build() + ) + .buttonsText( + BrandingThemeFontButtonsText + .builder() + .bold(true) + .size(1.1) + .build() + ) + .fontUrl("font_url") + .inputLabels( + BrandingThemeFontInputLabels + .builder() + .bold(true) + .size(1.1) + .build() + ) + .links( + BrandingThemeFontLinks + .builder() + .bold(true) + .size(1.1) + .build() + ) + .linksStyle(BrandingThemeFontLinksStyleEnum.NORMAL) + .referenceTextSize(1.1) + .subtitle( + BrandingThemeFontSubtitle + .builder() + .bold(true) + .size(1.1) + .build() + ) + .title( + BrandingThemeFontTitle + .builder() + .bold(true) + .size(1.1) + .build() + ) + .build() + ) + .pageBackground( + BrandingThemePageBackground + .builder() + .backgroundColor("background_color") + .backgroundImageUrl("background_image_url") + .pageLayout(BrandingThemePageBackgroundPageLayoutEnum.CENTER) + .build() + ) + .widget( + BrandingThemeWidget + .builder() + .headerTextAlignment(BrandingThemeWidgetHeaderTextAlignmentEnum.CENTER) + .logoHeight(1.1) + .logoPosition(BrandingThemeWidgetLogoPositionEnum.CENTER) + .logoUrl("logo_url") + .socialButtonsLayout(BrandingThemeWidgetSocialButtonsLayoutEnum.BOTTOM) + .build() + ) .build() ); ``` @@ -16299,7 +17658,7 @@ client.attackProtection().captcha().update(
-**activeProviderId:** `Optional` +**themeId:** `String` — The ID of the theme
@@ -16307,7 +17666,7 @@ client.attackProtection().captcha().update(
-**arkose:** `Optional` +**borders:** `BrandingThemeBorders`
@@ -16315,7 +17674,7 @@ client.attackProtection().captcha().update(
-**authChallenge:** `Optional` +**colors:** `BrandingThemeColors`
@@ -16323,7 +17682,7 @@ client.attackProtection().captcha().update(
-**hcaptcha:** `Optional` +**displayName:** `Optional` — Display Name
@@ -16331,7 +17690,7 @@ client.attackProtection().captcha().update(
-**friendlyCaptcha:** `Optional` +**fonts:** `BrandingThemeFonts`
@@ -16339,7 +17698,7 @@ client.attackProtection().captcha().update(
-**recaptchaEnterprise:** `Optional` +**identifiers:** `Optional`
@@ -16347,7 +17706,7 @@ client.attackProtection().captcha().update(
-**recaptchaV2:** `Optional` +**pageBackground:** `BrandingThemePageBackground`
@@ -16355,7 +17714,7 @@ client.attackProtection().captcha().update(
-**simpleCaptcha:** `Optional>` +**widget:** `BrandingThemeWidget`
@@ -16367,47 +17726,8 @@ client.attackProtection().captcha().update(
-## AttackProtection PhoneProviderProtection -
client.attackProtection.phoneProviderProtection.get() -> GetPhoneProviderProtectionResponseContent -
-
- -#### 📝 Description - -
-
- -
-
- -Get the phone provider protection configuration for a tenant. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```java -client.attackProtection().phoneProviderProtection().get(); -``` -
-
-
-
- - -
-
-
- -
client.attackProtection.phoneProviderProtection.patch(request) -> PatchPhoneProviderProtectionResponseContent +## Branding Phone Providers +
client.branding.phone.providers.list() -> ListBrandingPhoneProvidersResponseContent
@@ -16419,7 +17739,7 @@ client.attackProtection().phoneProviderProtection().get();
-Update the phone provider protection configuration for a tenant. +Retrieve a list of [phone providers](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details set for a Tenant. A list of fields to include or exclude may also be specified.
@@ -16434,10 +17754,10 @@ Update the phone provider protection configuration for a tenant.
```java -client.attackProtection().phoneProviderProtection().patch( - PatchPhoneProviderProtectionRequestContent +client.branding().phone().providers().list( + ListBrandingPhoneProvidersRequestParameters .builder() - .type(PhoneProviderProtectionBackoffStrategyEnum.EXPONENTIAL) + .disabled(true) .build() ); ``` @@ -16454,7 +17774,7 @@ client.attackProtection().phoneProviderProtection().patch(
-**type:** `PhoneProviderProtectionBackoffStrategyEnum` +**disabled:** `Optional` — Whether the provider is enabled (false) or disabled (true).
@@ -16466,47 +17786,7 @@ client.attackProtection().phoneProviderProtection().patch(
-## AttackProtection SuspiciousIpThrottling -
client.attackProtection.suspiciousIpThrottling.get() -> GetSuspiciousIpThrottlingSettingsResponseContent -
-
- -#### 📝 Description - -
-
- -
-
- -Retrieve details of the Suspicious IP Throttling configuration of your tenant. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```java -client.attackProtection().suspiciousIpThrottling().get(); -``` -
-
-
-
- - -
-
-
- -
client.attackProtection.suspiciousIpThrottling.update(request) -> UpdateSuspiciousIpThrottlingSettingsResponseContent +
client.branding.phone.providers.create(request) -> CreateBrandingPhoneProviderResponseContent
@@ -16518,7 +17798,8 @@ client.attackProtection().suspiciousIpThrottling().get();
-Update the details of the Suspicious IP Throttling configuration of your tenant. +Create a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers). +The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
@@ -16533,9 +17814,18 @@ Update the details of the Suspicious IP Throttling configuration of your tenant.
```java -client.attackProtection().suspiciousIpThrottling().update( - UpdateSuspiciousIpThrottlingSettingsRequestContent +client.branding().phone().providers().create( + CreateBrandingPhoneProviderRequestContent .builder() + .name(PhoneProviderNameEnum.TWILIO) + .credentials( + PhoneProviderCredentials.of( + TwilioProviderCredentials + .builder() + .authToken("auth_token") + .build() + ) + ) .build() ); ``` @@ -16552,7 +17842,7 @@ client.attackProtection().suspiciousIpThrottling().update(
-**enabled:** `Optional` — Whether or not suspicious IP throttling attack protections are active. +**name:** `PhoneProviderNameEnum`
@@ -16560,10 +17850,7 @@ client.attackProtection().suspiciousIpThrottling().update(
-**shields:** `Optional>` - -Action to take when a suspicious IP throttling threshold is violated. - Possible values: block, admin_notification. +**disabled:** `Optional` — Whether the provider is enabled (false) or disabled (true).
@@ -16571,7 +17858,7 @@ Action to take when a suspicious IP throttling threshold is violated.
-**allowlist:** `Optional>` +**configuration:** `Optional`
@@ -16579,7 +17866,7 @@ Action to take when a suspicious IP throttling threshold is violated.
-**stage:** `Optional` +**credentials:** `PhoneProviderCredentials`
@@ -16591,11 +17878,24 @@ Action to take when a suspicious IP throttling threshold is violated.
-## Branding Templates -
client.branding.templates.getUniversalLogin() -> GetUniversalLoginTemplateResponseContent +
client.branding.phone.providers.get(id) -> GetBrandingPhoneProviderResponseContent +
+
+ +#### 📝 Description + +
+
+
+Retrieve [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details. A list of fields to include or exclude may also be specified. +
+
+
+
+ #### 🔌 Usage
@@ -16605,19 +17905,34 @@ Action to take when a suspicious IP throttling threshold is violated.
```java -client.branding().templates().getUniversalLogin(); +client.branding().phone().providers().get("id"); ```
+#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+
+
+
-
client.branding.templates.updateUniversalLogin(request) +
client.branding.phone.providers.delete(id)
@@ -16629,30 +17944,7 @@ client.branding().templates().getUniversalLogin();
-Update the Universal Login branding template. - -When `content-type` header is set to `application/json`: - -```json -{ - "template": "{% assign resolved_dir = dir | default: \"auto\" %}{%- auth0:head -%}{%- auth0:widget -%}" -} -``` - -When `content-type` header is set to `text/html`: - -```html - -{% assign resolved_dir = dir | default: "auto" %} - - - {%- auth0:head -%} - - - {%- auth0:widget -%} - - -``` +Delete the configured phone provider.
@@ -16667,9 +17959,7 @@ When `content-type` header is set to `text/html`:
```java -client.branding().templates().updateUniversalLogin( - UpdateUniversalLoginTemplateRequestContent.of("string") -); +client.branding().phone().providers().delete("id"); ```
@@ -16684,7 +17974,7 @@ client.branding().templates().updateUniversalLogin(
-**request:** `UpdateUniversalLoginTemplateRequestContent` +**id:** `String`
@@ -16696,11 +17986,11 @@ client.branding().templates().updateUniversalLogin(
-
client.branding.templates.deleteUniversalLogin() +
client.branding.phone.providers.update(id, request) -> UpdateBrandingPhoneProviderResponseContent
-#### 🔌 Usage +#### 📝 Description
@@ -16708,25 +17998,14 @@ client.branding().templates().updateUniversalLogin(
-```java -client.branding().templates().deleteUniversalLogin(); -``` -
-
+Update a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers). +The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
- -
-
- -## Branding Themes -
client.branding.themes.create(request) -> CreateBrandingThemeResponseContent -
-
-#### 📝 Description +#### 🔌 Usage
@@ -16734,13 +18013,20 @@ client.branding().templates().deleteUniversalLogin();
-Create branding theme. +```java +client.branding().phone().providers().update( + "id", + UpdateBrandingPhoneProviderRequestContent + .builder() + .build() +); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -16748,130 +18034,31 @@ Create branding theme.
-```java -client.branding().themes().create( - CreateBrandingThemeRequestContent - .builder() - .borders( - BrandingThemeBorders - .builder() - .buttonBorderRadius(1.1) - .buttonBorderWeight(1.1) - .buttonsStyle(BrandingThemeBordersButtonsStyleEnum.PILL) - .inputBorderRadius(1.1) - .inputBorderWeight(1.1) - .inputsStyle(BrandingThemeBordersInputsStyleEnum.PILL) - .showWidgetShadow(true) - .widgetBorderWeight(1.1) - .widgetCornerRadius(1.1) - .build() - ) - .colors( - BrandingThemeColors - .builder() - .bodyText("body_text") - .error("error") - .header("header") - .icons("icons") - .inputBackground("input_background") - .inputBorder("input_border") - .inputFilledText("input_filled_text") - .inputLabelsPlaceholders("input_labels_placeholders") - .linksFocusedComponents("links_focused_components") - .primaryButton("primary_button") - .primaryButtonLabel("primary_button_label") - .secondaryButtonBorder("secondary_button_border") - .secondaryButtonLabel("secondary_button_label") - .success("success") - .widgetBackground("widget_background") - .widgetBorder("widget_border") - .build() - ) - .fonts( - BrandingThemeFonts - .builder() - .bodyText( - BrandingThemeFontBodyText - .builder() - .bold(true) - .size(1.1) - .build() - ) - .buttonsText( - BrandingThemeFontButtonsText - .builder() - .bold(true) - .size(1.1) - .build() - ) - .fontUrl("font_url") - .inputLabels( - BrandingThemeFontInputLabels - .builder() - .bold(true) - .size(1.1) - .build() - ) - .links( - BrandingThemeFontLinks - .builder() - .bold(true) - .size(1.1) - .build() - ) - .linksStyle(BrandingThemeFontLinksStyleEnum.NORMAL) - .referenceTextSize(1.1) - .subtitle( - BrandingThemeFontSubtitle - .builder() - .bold(true) - .size(1.1) - .build() - ) - .title( - BrandingThemeFontTitle - .builder() - .bold(true) - .size(1.1) - .build() - ) - .build() - ) - .pageBackground( - BrandingThemePageBackground - .builder() - .backgroundColor("background_color") - .backgroundImageUrl("background_image_url") - .pageLayout(BrandingThemePageBackgroundPageLayoutEnum.CENTER) - .build() - ) - .widget( - BrandingThemeWidget - .builder() - .headerTextAlignment(BrandingThemeWidgetHeaderTextAlignmentEnum.CENTER) - .logoHeight(1.1) - .logoPosition(BrandingThemeWidgetLogoPositionEnum.CENTER) - .logoUrl("logo_url") - .socialButtonsLayout(BrandingThemeWidgetSocialButtonsLayoutEnum.BOTTOM) - .build() - ) - .build() -); -``` +**id:** `String` +
+ +
+
+ +**name:** `Optional` +
-#### ⚙️ Parameters -
+**disabled:** `Optional` — Whether the provider is enabled (false) or disabled (true). + +
+
+
-**borders:** `BrandingThemeBorders` +**credentials:** `Optional`
@@ -16879,31 +18066,53 @@ client.branding().themes().create(
-**colors:** `BrandingThemeColors` +**configuration:** `Optional`
+
+
+ + +
+
+
+ +
client.branding.phone.providers.test(id, request) -> CreatePhoneProviderSendTestResponseContent +
+
+ +#### 🔌 Usage + +
+
-**displayName:** `Optional` — Display Name - +```java +client.branding().phone().providers().test( + "id", + CreatePhoneProviderSendTestRequestContent + .builder() + .to("to") + .build() +); +``` +
+
+#### ⚙️ Parameters +
-**fonts:** `BrandingThemeFonts` - -
-
-
-**identifiers:** `Optional` +**id:** `String`
@@ -16911,7 +18120,7 @@ client.branding().themes().create(
-**pageBackground:** `BrandingThemePageBackground` +**to:** `String` — The recipient phone number to receive a given notification.
@@ -16919,7 +18128,7 @@ client.branding().themes().create(
-**widget:** `BrandingThemeWidget` +**deliveryMethod:** `Optional`
@@ -16931,11 +18140,12 @@ client.branding().themes().create(
-
client.branding.themes.getDefault() -> GetBrandingDefaultThemeResponseContent +## Branding Phone Templates +
client.branding.phone.templates.list() -> ListPhoneTemplatesResponseContent
-#### 📝 Description +#### 🔌 Usage
@@ -16943,13 +18153,20 @@ client.branding().themes().create(
-Retrieve default branding theme. +```java +client.branding().phone().templates().list( + ListPhoneTemplatesRequestParameters + .builder() + .disabled(true) + .build() +); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -16957,9 +18174,8 @@ Retrieve default branding theme.
-```java -client.branding().themes().getDefault(); -``` +**disabled:** `Optional` — Whether the template is enabled (false) or disabled (true). +
@@ -16970,11 +18186,11 @@ client.branding().themes().getDefault();
-
client.branding.themes.get(themeId) -> GetBrandingThemeResponseContent +
client.branding.phone.templates.create(request) -> CreatePhoneTemplateResponseContent
-#### 📝 Description +#### 🔌 Usage
@@ -16982,13 +18198,19 @@ client.branding().themes().getDefault();
-Retrieve branding theme. +```java +client.branding().phone().templates().create( + CreatePhoneTemplateRequestContent + .builder() + .build() +); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -16996,23 +18218,23 @@ Retrieve branding theme.
-```java -client.branding().themes().get("themeId"); -``` -
-
+**type:** `Optional` +
-#### ⚙️ Parameters -
+**disabled:** `Optional` — Whether the template is enabled (false) or disabled (true). + +
+
+
-**themeId:** `String` — The ID of the theme +**content:** `Optional`
@@ -17024,24 +18246,10 @@ client.branding().themes().get("themeId");
-
client.branding.themes.delete(themeId) -
-
- -#### 📝 Description - -
-
- +
client.branding.phone.templates.get(id) -> GetPhoneTemplateResponseContent
-Delete branding theme. -
-
-
-
- #### 🔌 Usage
@@ -17051,7 +18259,7 @@ Delete branding theme.
```java -client.branding().themes().delete("themeId"); +client.branding().phone().templates().get("id"); ```
@@ -17066,7 +18274,7 @@ client.branding().themes().delete("themeId");
-**themeId:** `String` — The ID of the theme +**id:** `String`
@@ -17078,24 +18286,10 @@ client.branding().themes().delete("themeId");
-
client.branding.themes.update(themeId, request) -> UpdateBrandingThemeResponseContent -
-
- -#### 📝 Description - -
-
- +
client.branding.phone.templates.delete(id)
-Update branding theme. -
-
-
-
- #### 🔌 Usage
@@ -17105,115 +18299,7 @@ Update branding theme.
```java -client.branding().themes().update( - "themeId", - UpdateBrandingThemeRequestContent - .builder() - .borders( - BrandingThemeBorders - .builder() - .buttonBorderRadius(1.1) - .buttonBorderWeight(1.1) - .buttonsStyle(BrandingThemeBordersButtonsStyleEnum.PILL) - .inputBorderRadius(1.1) - .inputBorderWeight(1.1) - .inputsStyle(BrandingThemeBordersInputsStyleEnum.PILL) - .showWidgetShadow(true) - .widgetBorderWeight(1.1) - .widgetCornerRadius(1.1) - .build() - ) - .colors( - BrandingThemeColors - .builder() - .bodyText("body_text") - .error("error") - .header("header") - .icons("icons") - .inputBackground("input_background") - .inputBorder("input_border") - .inputFilledText("input_filled_text") - .inputLabelsPlaceholders("input_labels_placeholders") - .linksFocusedComponents("links_focused_components") - .primaryButton("primary_button") - .primaryButtonLabel("primary_button_label") - .secondaryButtonBorder("secondary_button_border") - .secondaryButtonLabel("secondary_button_label") - .success("success") - .widgetBackground("widget_background") - .widgetBorder("widget_border") - .build() - ) - .fonts( - BrandingThemeFonts - .builder() - .bodyText( - BrandingThemeFontBodyText - .builder() - .bold(true) - .size(1.1) - .build() - ) - .buttonsText( - BrandingThemeFontButtonsText - .builder() - .bold(true) - .size(1.1) - .build() - ) - .fontUrl("font_url") - .inputLabels( - BrandingThemeFontInputLabels - .builder() - .bold(true) - .size(1.1) - .build() - ) - .links( - BrandingThemeFontLinks - .builder() - .bold(true) - .size(1.1) - .build() - ) - .linksStyle(BrandingThemeFontLinksStyleEnum.NORMAL) - .referenceTextSize(1.1) - .subtitle( - BrandingThemeFontSubtitle - .builder() - .bold(true) - .size(1.1) - .build() - ) - .title( - BrandingThemeFontTitle - .builder() - .bold(true) - .size(1.1) - .build() - ) - .build() - ) - .pageBackground( - BrandingThemePageBackground - .builder() - .backgroundColor("background_color") - .backgroundImageUrl("background_image_url") - .pageLayout(BrandingThemePageBackgroundPageLayoutEnum.CENTER) - .build() - ) - .widget( - BrandingThemeWidget - .builder() - .headerTextAlignment(BrandingThemeWidgetHeaderTextAlignmentEnum.CENTER) - .logoHeight(1.1) - .logoPosition(BrandingThemeWidgetLogoPositionEnum.CENTER) - .logoUrl("logo_url") - .socialButtonsLayout(BrandingThemeWidgetSocialButtonsLayoutEnum.BOTTOM) - .build() - ) - .build() -); +client.branding().phone().templates().delete("id"); ```
@@ -17228,47 +18314,52 @@ client.branding().themes().update(
-**themeId:** `String` — The ID of the theme +**id:** `String`
+
+
-
-
-**borders:** `BrandingThemeBorders` -
+
+
client.branding.phone.templates.update(id, request) -> UpdatePhoneTemplateResponseContent
-**colors:** `BrandingThemeColors` - -
-
+#### 🔌 Usage
-**displayName:** `Optional` — Display Name - +
+
+ +```java +client.branding().phone().templates().update( + "id", + UpdatePhoneTemplateRequestContent + .builder() + .build() +); +``` +
+
+#### ⚙️ Parameters +
-**fonts:** `BrandingThemeFonts` - -
-
-
-**identifiers:** `Optional` +**id:** `String`
@@ -17276,7 +18367,7 @@ client.branding().themes().update(
-**pageBackground:** `BrandingThemePageBackground` +**content:** `Optional`
@@ -17284,7 +18375,7 @@ client.branding().themes().update(
-**widget:** `BrandingThemeWidget` +**disabled:** `Optional` — Whether the template is enabled (false) or disabled (true).
@@ -17296,12 +18387,11 @@ client.branding().themes().update(
-## Branding Phone Providers -
client.branding.phone.providers.list() -> ListBrandingPhoneProvidersResponseContent +
client.branding.phone.templates.reset(id, request) -> ResetPhoneTemplateResponseContent
-#### 📝 Description +#### 🔌 Usage
@@ -17309,13 +18399,20 @@ client.branding().themes().update(
-Retrieve a list of [phone providers](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details set for a Tenant. A list of fields to include or exclude may also be specified. +```java +client.branding().phone().templates().reset( + "id", + ResetPhoneTemplateRequestContent.of(new + HashMap() {{put("key", "value"); + }}) +); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -17323,28 +18420,15 @@ Retrieve a list of [phone providers](https://auth0.com/docs/customize/phone-mess
-```java -client.branding().phone().providers().list( - ListBrandingPhoneProvidersRequestParameters - .builder() - .disabled(true) - .build() -); -``` -
-
+**id:** `String` +
-#### ⚙️ Parameters - -
-
-
-**disabled:** `Optional` — Whether the provider is enabled (false) or disabled (true). +**request:** `Object`
@@ -17356,25 +18440,10 @@ client.branding().phone().providers().list(
-
client.branding.phone.providers.create(request) -> CreateBrandingPhoneProviderResponseContent -
-
- -#### 📝 Description - -
-
- +
client.branding.phone.templates.test(id, request) -> CreatePhoneTemplateTestNotificationResponseContent
-Create a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers). -The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property). -
-
-
-
- #### 🔌 Usage
@@ -17384,18 +18453,11 @@ The `credentials` object requires different properties depending on the phone pr
```java -client.branding().phone().providers().create( - CreateBrandingPhoneProviderRequestContent +client.branding().phone().templates().test( + "id", + CreatePhoneTemplateTestNotificationRequestContent .builder() - .name(PhoneProviderNameEnum.TWILIO) - .credentials( - PhoneProviderCredentials.of( - TwilioProviderCredentials - .builder() - .authToken("auth_token") - .build() - ) - ) + .to("to") .build() ); ``` @@ -17412,15 +18474,7 @@ client.branding().phone().providers().create(
-**name:** `PhoneProviderNameEnum` - -
-
- -
-
- -**disabled:** `Optional` — Whether the provider is enabled (false) or disabled (true). +**id:** `String`
@@ -17428,7 +18482,7 @@ client.branding().phone().providers().create(
-**configuration:** `Optional` +**to:** `String` — Destination of the testing phone notification
@@ -17436,7 +18490,7 @@ client.branding().phone().providers().create(
-**credentials:** `PhoneProviderCredentials` +**deliveryMethod:** `Optional` — Medium to use to send the notification
@@ -17448,11 +18502,12 @@ client.branding().phone().providers().create(
-
client.branding.phone.providers.get(id) -> GetBrandingPhoneProviderResponseContent +## ClientGrants Organizations +
client.clientGrants.organizations.list(id) -> SyncPagingIterable&lt;Organization&gt;
-#### 📝 Description +#### 🔌 Usage
@@ -17460,13 +18515,23 @@ client.branding().phone().providers().create(
-Retrieve [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details. A list of fields to include or exclude may also be specified. +```java +client.clientGrants().organizations().list( + "id", + ListClientGrantOrganizationsRequestParameters + .builder() + .includeTotals(true) + .from("from") + .take(1) + .build() +); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -17474,23 +18539,31 @@ Retrieve [phone provider](https://auth0.com/docs/customize/phone-messages/config
-```java -client.branding().phone().providers().get("id"); -``` +**id:** `String` — ID of the client grant +
+ +
+
+ +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). +
-#### ⚙️ Parameters -
+**from:** `Optional` — Optional Id from which to start selection. + +
+
+
-**id:** `String` +**take:** `Optional` — Number of results per page. Defaults to 50.
@@ -17502,7 +18575,8 @@ client.branding().phone().providers().get("id");
-
client.branding.phone.providers.delete(id) +## Clients Credentials +
client.clients.credentials.list(clientId) -> List&lt;ClientCredential&gt;
@@ -17514,7 +18588,9 @@ client.branding().phone().providers().get("id");
-Delete the configured phone provider. +Get the details of a client credential. + +**Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
@@ -17529,7 +18605,7 @@ Delete the configured phone provider.
```java -client.branding().phone().providers().delete("id"); +client.clients().credentials().list("client_id"); ```
@@ -17544,7 +18620,7 @@ client.branding().phone().providers().delete("id");
-**id:** `String` +**clientId:** `String` — ID of the client.
@@ -17556,7 +18632,7 @@ client.branding().phone().providers().delete("id");
-
client.branding.phone.providers.update(id, request) -> UpdateBrandingPhoneProviderResponseContent +
client.clients.credentials.create(clientId, request) -> PostClientCredentialResponseContent
@@ -17568,89 +18644,67 @@ client.branding().phone().providers().delete("id");
-Update a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers). -The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property). -
-
-
-
+Create a client credential associated to your application. Credentials can be used to configure Private Key JWT and mTLS authentication methods, as well as for JWT-secured Authorization requests. -#### 🔌 Usage +**Public Key** -
-
+Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests. -
-
+Sample: -```java -client.branding().phone().providers().update( - "id", - UpdateBrandingPhoneProviderRequestContent - .builder() - .build() -); +```json +{ + "credential_type": "public_key", + "name": "string", + "pem": "string", + "alg": "RS256", + "parse_expiry_from_cert": false, + "expires_at": "2022-12-31T23:59:59Z" +} ``` -
-
-
-
- -#### ⚙️ Parameters - -
-
-
-
+**Certificate (CA-signed & self-signed)** -**id:** `String` - -
-
+Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN. -
-
+CA-signed Certificate Sample (pem): -**name:** `Optional` - -
-
+```json +{ + "credential_type": "x509_cert", + "name": "string", + "pem": "string" +} +``` -
-
+CA-signed Certificate Sample (subject_dn): -**disabled:** `Optional` — Whether the provider is enabled (false) or disabled (true). - -
-
+```json +{ + "credential_type": "cert_subject_dn", + "name": "string", + "subject_dn": "string" +} +``` -
-
+Self-signed Certificate Sample: -**credentials:** `Optional` - -
-
+```json +{ + "credential_type": "cert_subject_dn", + "name": "string", + "pem": "string" +} +``` -
-
+The credential will be created but not yet enabled for use until you set the corresponding properties in the client: -**configuration:** `Optional` - -
-
+- To enable the credential for Private Key JWT or mTLS authentication methods, set the `client_authentication_methods` property on the client. For more information, read [Configure Private Key JWT Authentication](https://auth0.com/docs/get-started/applications/configure-private-key-jwt) and [Configure mTLS Authentication](https://auth0.com/docs/get-started/applications/configure-mtls) +- To enable the credential for JWT-secured Authorization requests, set the `signed_request_object`property on the client. For more information, read [Configure JWT-secured Authorization Requests (JAR)](https://auth0.com/docs/get-started/applications/configure-jar)
- - -
- -
client.branding.phone.providers.test(id, request) -> CreatePhoneProviderSendTestResponseContent -
-
#### 🔌 Usage @@ -17659,13 +18713,13 @@ client.branding().phone().providers().update(
- -```java -client.branding().phone().providers().test( - "id", - CreatePhoneProviderSendTestRequestContent + +```java +client.clients().credentials().create( + "client_id", + PostClientCredentialRequestContent .builder() - .to("to") + .credentialType(ClientCredentialTypeEnum.PUBLIC_KEY) .build() ); ``` @@ -17682,7 +18736,7 @@ client.branding().phone().providers().test(
-**id:** `String` +**clientId:** `String` — ID of the client.
@@ -17690,7 +18744,7 @@ client.branding().phone().providers().test(
-**to:** `String` — The recipient phone number to receive a given notification. +**credentialType:** `ClientCredentialTypeEnum`
@@ -17698,53 +18752,55 @@ client.branding().phone().providers().test(
-**deliveryMethod:** `Optional` +**name:** `Optional` — Friendly name for a credential.
-
-
+
+
+**subjectDn:** `Optional` — Subject Distinguished Name. Mutually exclusive with `pem` property. Applies to `cert_subject_dn` credential type. +
-
-## Branding Phone Templates -
client.branding.phone.templates.list() -> ListPhoneTemplatesResponseContent
-#### 🔌 Usage +**pem:** `Optional` — PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped. + +
+
+**alg:** `Optional` + +
+
+
-```java -client.branding().phone().templates().list( - ListPhoneTemplatesRequestParameters - .builder() - .disabled(true) - .build() -); -``` -
-
+**parseExpiryFromCert:** `Optional` — Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. Applies to `public_key` credential type. + -#### ⚙️ Parameters -
+**expiresAt:** `Optional` — The ISO 8601 formatted date representing the expiration of the credential. If not specified (not recommended), the credential never expires. Applies to `public_key` credential type. + +
+
+
-**disabled:** `Optional` — Whether the template is enabled (false) or disabled (true). +**kid:** `Optional` — Optional kid (Key ID), used to uniquely identify the credential. If not specified, a kid value will be auto-generated. The kid header parameter in JWTs sent by your client should match this value. Valid format is [0-9a-zA-Z-_]{10,64}
@@ -17756,11 +18812,11 @@ client.branding().phone().templates().list(
-
client.branding.phone.templates.create(request) -> CreatePhoneTemplateResponseContent +
client.clients.credentials.get(clientId, credentialId) -> GetClientCredentialResponseContent
-#### 🔌 Usage +#### 📝 Description
@@ -17768,19 +18824,15 @@ client.branding().phone().templates().list(
-```java -client.branding().phone().templates().create( - CreatePhoneTemplateRequestContent - .builder() - .build() -); -``` +Get the details of a client credential. + +**Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
-#### ⚙️ Parameters +#### 🔌 Usage
@@ -17788,15 +18840,23 @@ client.branding().phone().templates().create(
-**type:** `Optional` - +```java +client.clients().credentials().get("client_id", "credential_id"); +``` +
+
+#### ⚙️ Parameters +
-**disabled:** `Optional` — Whether the template is enabled (false) or disabled (true). +
+
+ +**clientId:** `String` — ID of the client.
@@ -17804,7 +18864,7 @@ client.branding().phone().templates().create(
-**content:** `Optional` +**credentialId:** `String` — ID of the credential.
@@ -17816,11 +18876,11 @@ client.branding().phone().templates().create(
-
client.branding.phone.templates.get(id) -> GetPhoneTemplateResponseContent +
client.clients.credentials.delete(clientId, credentialId)
-#### 🔌 Usage +#### 📝 Description
@@ -17828,15 +18888,13 @@ client.branding().phone().templates().create(
-```java -client.branding().phone().templates().get("id"); -``` +Delete a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow.
-#### ⚙️ Parameters +#### 🔌 Usage
@@ -17844,23 +18902,15 @@ client.branding().phone().templates().get("id");
-**id:** `String` - -
-
+```java +client.clients().credentials().delete("client_id", "credential_id"); +```
- -
-
- -
client.branding.phone.templates.delete(id) -
-
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -17868,23 +18918,15 @@ client.branding().phone().templates().get("id");
-```java -client.branding().phone().templates().delete("id"); -``` -
-
+**clientId:** `String` — ID of the client. +
-#### ⚙️ Parameters -
-
-
- -**id:** `String` +**credentialId:** `String` — ID of the credential to delete.
@@ -17896,10 +18938,24 @@ client.branding().phone().templates().delete("id");
-
client.branding.phone.templates.update(id, request) -> UpdatePhoneTemplateResponseContent +
client.clients.credentials.update(clientId, credentialId, request) -> PatchClientCredentialResponseContent +
+
+ +#### 📝 Description +
+
+
+ +Change a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow. +
+
+
+
+ #### 🔌 Usage
@@ -17909,9 +18965,10 @@ client.branding().phone().templates().delete("id");
```java -client.branding().phone().templates().update( - "id", - UpdatePhoneTemplateRequestContent +client.clients().credentials().update( + "client_id", + "credential_id", + PatchClientCredentialRequestContent .builder() .build() ); @@ -17929,7 +18986,7 @@ client.branding().phone().templates().update(
-**id:** `String` +**clientId:** `String` — ID of the client.
@@ -17937,7 +18994,7 @@ client.branding().phone().templates().update(
-**content:** `Optional` +**credentialId:** `String` — ID of the credential.
@@ -17945,7 +19002,7 @@ client.branding().phone().templates().update(
-**disabled:** `Optional` — Whether the template is enabled (false) or disabled (true). +**expiresAt:** `Optional` — The ISO 8601 formatted date representing the expiration of the credential.
@@ -17957,10 +19014,28 @@ client.branding().phone().templates().update(
-
client.branding.phone.templates.reset(id, request) -> ResetPhoneTemplateResponseContent +## Clients Connections +
client.clients.connections.get(id) -> SyncPagingIterable&lt;ConnectionForList&gt; +
+
+ +#### 📝 Description + +
+
+
+Retrieve all connections that are enabled for the specified [Application](https://www.auth0.com/docs/get-started/applications), using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified. + +- This endpoint requires the `read:connections` scope and any one of `read:clients` or `read:client_summary`. +- **Note**: The first time you call this endpoint, 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 further results are remaining. +
+
+
+
+ #### 🔌 Usage
@@ -17970,11 +19045,18 @@ client.branding().phone().templates().update(
```java -client.branding().phone().templates().reset( +client.clients().connections().get( "id", - ResetPhoneTemplateRequestContent.of(new - HashMap() {{put("key", "value"); - }}) + ConnectionsGetRequest + .builder() + .from("from") + .take(1) + .fields("fields") + .includeFields(true) + .strategy( + Arrays.asList(ConnectionStrategyEnum.AD) + ) + .build() ); ```
@@ -17990,7 +19072,7 @@ client.branding().phone().templates().reset(
-**id:** `String` +**id:** `String` — ID of the client for which to retrieve enabled connections.
@@ -17998,53 +19080,23 @@ client.branding().phone().templates().reset(
-**request:** `Object` +**strategy:** `Optional` — Provide strategies to only retrieve connections with such strategies
-
-
- - - - -
- -
client.branding.phone.templates.test(id, request) -> CreatePhoneTemplateTestNotificationResponseContent -
-
- -#### 🔌 Usage - -
-
-```java -client.branding().phone().templates().test( - "id", - CreatePhoneTemplateTestNotificationRequestContent - .builder() - .to("to") - .build() -); -``` -
-
+**from:** `Optional` — Optional Id from which to start selection. +
-#### ⚙️ Parameters -
-
-
- -**id:** `String` +**take:** `Optional` — Number of results per page. Defaults to 50.
@@ -18052,7 +19104,7 @@ client.branding().phone().templates().test(
-**to:** `String` — Destination of the testing phone notification +**fields:** `Optional` — A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields
@@ -18060,7 +19112,7 @@ client.branding().phone().templates().test(
-**deliveryMethod:** `Optional` — Medium to use to send the notification +**includeFields:** `Optional` — true if the fields specified are to be included in the result, false otherwise (defaults to true)
@@ -18072,12 +19124,12 @@ client.branding().phone().templates().test(
-## ClientGrants Organizations -
client.clientGrants.organizations.list(id) -> SyncPagingIterable&lt;Organization&gt; +## Connections DirectoryProvisioning +
client.connections.directoryProvisioning.list() -> SyncPagingIterable&lt;DirectoryProvisioning&gt;
-#### 🔌 Usage +#### 📝 Description
@@ -18085,10 +19137,23 @@ client.branding().phone().templates().test(
-```java -client.clientGrants().organizations().list( - "id", - ListClientGrantOrganizationsRequestParameters +Retrieve a list of directory provisioning configurations of a tenant. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.connections().directoryProvisioning().list( + ListDirectoryProvisioningsRequestParameters .builder() .from("from") .take(1) @@ -18108,14 +19173,6 @@ client.clientGrants().organizations().list(
-**id:** `String` — ID of the client grant - -
-
- -
-
- **from:** `Optional` — Optional Id from which to start selection.
@@ -18136,8 +19193,7 @@ client.clientGrants().organizations().list(
-## Clients Credentials -
client.clients.credentials.list(clientId) -> List&lt;ClientCredential&gt; +
client.connections.directoryProvisioning.get(id) -> GetDirectoryProvisioningResponseContent
@@ -18149,9 +19205,7 @@ client.clientGrants().organizations().list(
-Get the details of a client credential. - -**Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client. +Retrieve the directory provisioning configuration of a connection.
@@ -18166,7 +19220,7 @@ Get the details of a client credential.
```java -client.clients().credentials().list("client_id"); +client.connections().directoryProvisioning().get("id"); ```
@@ -18181,7 +19235,7 @@ client.clients().credentials().list("client_id");
-**clientId:** `String` — ID of the client. +**id:** `String` — The id of the connection to retrieve its directory provisioning configuration
@@ -18193,7 +19247,7 @@ client.clients().credentials().list("client_id");
-
client.clients.credentials.create(clientId, request) -> PostClientCredentialResponseContent +
client.connections.directoryProvisioning.create(id, request) -> CreateDirectoryProvisioningResponseContent
@@ -18205,63 +19259,7 @@ client.clients().credentials().list("client_id");
-Create a client credential associated to your application. Credentials can be used to configure Private Key JWT and mTLS authentication methods, as well as for JWT-secured Authorization requests. - -**Public Key** - -Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests. - -Sample: - -```json -{ - "credential_type": "public_key", - "name": "string", - "pem": "string", - "alg": "RS256", - "parse_expiry_from_cert": false, - "expires_at": "2022-12-31T23:59:59Z" -} -``` - -**Certificate (CA-signed & self-signed)** - -Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN. - -CA-signed Certificate Sample (pem): - -```json -{ - "credential_type": "x509_cert", - "name": "string", - "pem": "string" -} -``` - -CA-signed Certificate Sample (subject_dn): - -```json -{ - "credential_type": "cert_subject_dn", - "name": "string", - "subject_dn": "string" -} -``` - -Self-signed Certificate Sample: - -```json -{ - "credential_type": "cert_subject_dn", - "name": "string", - "pem": "string" -} -``` - -The credential will be created but not yet enabled for use until you set the corresponding properties in the client: - -- To enable the credential for Private Key JWT or mTLS authentication methods, set the `client_authentication_methods` property on the client. For more information, read [Configure Private Key JWT Authentication](https://auth0.com/docs/get-started/applications/configure-private-key-jwt) and [Configure mTLS Authentication](https://auth0.com/docs/get-started/applications/configure-mtls) -- To enable the credential for JWT-secured Authorization requests, set the `signed_request_object`property on the client. For more information, read [Configure JWT-secured Authorization Requests (JAR)](https://auth0.com/docs/get-started/applications/configure-jar) +Create a directory provisioning configuration for a connection.
@@ -18276,12 +19274,13 @@ The credential will be created but not yet enabled for use until you set the cor
```java -client.clients().credentials().create( - "client_id", - PostClientCredentialRequestContent - .builder() - .credentialType(ClientCredentialTypeEnum.PUBLIC_KEY) - .build() +client.connections().directoryProvisioning().create( + "id", + OptionalNullable.of( + CreateDirectoryProvisioningRequestContent + .builder() + .build() + ) ); ```
@@ -18297,7 +19296,7 @@ client.clients().credentials().create(
-**clientId:** `String` — ID of the client. +**id:** `String` — The id of the connection to create its directory provisioning configuration
@@ -18305,63 +19304,61 @@ client.clients().credentials().create(
-**credentialType:** `ClientCredentialTypeEnum` +**request:** `Optional`
+ +
-
-
-**name:** `Optional` — Friendly name for a credential. -
+
+
client.connections.directoryProvisioning.delete(id)
-**subjectDn:** `Optional` — Subject Distinguished Name. Mutually exclusive with `pem` property. Applies to `cert_subject_dn` credential type. - -
-
+#### 📝 Description
-**pem:** `Optional` — PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped. - -
-
-
-**alg:** `Optional` - +Delete the directory provisioning configuration of a connection. +
+
+#### 🔌 Usage +
-**parseExpiryFromCert:** `Optional` — Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. Applies to `public_key` credential type. - -
-
-
-**expiresAt:** `Optional` — The ISO 8601 formatted date representing the expiration of the credential. If not specified (not recommended), the credential never expires. Applies to `public_key` credential type. - +```java +client.connections().directoryProvisioning().delete("id"); +``` +
+
+#### ⚙️ Parameters +
-**kid:** `Optional` — Optional kid (Key ID), used to uniquely identify the credential. If not specified, a kid value will be auto-generated. The kid header parameter in JWTs sent by your client should match this value. Valid format is [0-9a-zA-Z-_]{10,64} +
+
+ +**id:** `String` — The id of the connection to delete its directory provisioning configuration
@@ -18373,7 +19370,7 @@ client.clients().credentials().create(
-
client.clients.credentials.get(clientId, credentialId) -> GetClientCredentialResponseContent +
client.connections.directoryProvisioning.update(id, request) -> UpdateDirectoryProvisioningResponseContent
@@ -18385,9 +19382,7 @@ client.clients().credentials().create(
-Get the details of a client credential. - -**Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client. +Update the directory provisioning configuration of a connection.
@@ -18402,7 +19397,14 @@ Get the details of a client credential.
```java -client.clients().credentials().get("client_id", "credential_id"); +client.connections().directoryProvisioning().update( + "id", + OptionalNullable.of( + UpdateDirectoryProvisioningRequestContent + .builder() + .build() + ) +); ```
@@ -18417,7 +19419,7 @@ client.clients().credentials().get("client_id", "credential_id");
-**clientId:** `String` — ID of the client. +**id:** `String` — The id of the connection to create its directory provisioning configuration
@@ -18425,7 +19427,7 @@ client.clients().credentials().get("client_id", "credential_id");
-**credentialId:** `String` — ID of the credential. +**request:** `Optional`
@@ -18437,7 +19439,7 @@ client.clients().credentials().get("client_id", "credential_id");
-
client.clients.credentials.delete(clientId, credentialId) +
client.connections.directoryProvisioning.getDefaultMapping(id) -> GetDirectoryProvisioningDefaultMappingResponseContent
@@ -18449,7 +19451,7 @@ client.clients().credentials().get("client_id", "credential_id");
-Delete a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow. +Retrieve the directory provisioning default attribute mapping of a connection.
@@ -18464,7 +19466,7 @@ Delete a client credential you previously created. May be enabled or disabled. F
```java -client.clients().credentials().delete("client_id", "credential_id"); +client.connections().directoryProvisioning().getDefaultMapping("id"); ```
@@ -18479,15 +19481,7 @@ client.clients().credentials().delete("client_id", "credential_id");
-**clientId:** `String` — ID of the client. - -
-
- -
-
- -**credentialId:** `String` — ID of the credential to delete. +**id:** `String` — The id of the connection to retrieve its directory provisioning configuration
@@ -18499,7 +19493,7 @@ client.clients().credentials().delete("client_id", "credential_id");
-
client.clients.credentials.update(clientId, credentialId, request) -> PatchClientCredentialResponseContent +
client.connections.directoryProvisioning.listSynchronizedGroups(id) -> SyncPagingIterable&lt;SynchronizedGroupPayload&gt;
@@ -18511,7 +19505,7 @@ client.clients().credentials().delete("client_id", "credential_id");
-Change a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow. +Retrieve the configured synchronized groups for a connection directory provisioning configuration.
@@ -18526,11 +19520,13 @@ Change a client credential you previously created. May be enabled or disabled. F
```java -client.clients().credentials().update( - "client_id", - "credential_id", - PatchClientCredentialRequestContent +client.connections().directoryProvisioning().listSynchronizedGroups( + "id", + ListSynchronizedGroupsRequestParameters .builder() + .from("from") + .take(1) + .q("q") .build() ); ``` @@ -18547,7 +19543,7 @@ client.clients().credentials().update(
-**clientId:** `String` — ID of the client. +**id:** `String` — The id of the connection to list synchronized groups for.
@@ -18555,7 +19551,7 @@ client.clients().credentials().update(
-**credentialId:** `String` — ID of the credential. +**from:** `Optional` — Optional Id from which to start selection.
@@ -18563,7 +19559,15 @@ client.clients().credentials().update(
-**expiresAt:** `Optional` — The ISO 8601 formatted date representing the expiration of the credential. +**take:** `Optional` — Number of results per page. Defaults to 50. + +
+
+ +
+
+ +**q:** `Optional` — Query in Lucene query string syntax. Only prefix search on "name" or "email" fields are allowed, with a single wildcard suffix. Operators, modifiers, and groupings are not allowed. Terms are treated as case-insensitive. Example query: "name:engineering*".
@@ -18575,8 +19579,7 @@ client.clients().credentials().update(
-## Clients Connections -
client.clients.connections.get(id) -> SyncPagingIterable&lt;ConnectionForList&gt; +
client.connections.directoryProvisioning.addSynchronizedGroupSelections(id, request)
@@ -18588,10 +19591,7 @@ client.clients().credentials().update(
-Retrieve all connections that are enabled for the specified [Application](https://www.auth0.com/docs/get-started/applications), using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified. - -- This endpoint requires the `read:connections` scope and any one of `read:clients` or `read:client_summary`. -- **Note**: The first time you call this endpoint, 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 further results are remaining. +Add synchronized group selections to a directory provisioning configuration.
@@ -18606,16 +19606,17 @@ Retrieve all connections that are enabled for the specified [Application](https:
```java -client.clients().connections().get( +client.connections().directoryProvisioning().addSynchronizedGroupSelections( "id", - ConnectionsGetRequest + AddSynchronizedGroupsRequestContent .builder() - .from("from") - .take(1) - .fields("fields") - .includeFields(true) - .strategy( - Arrays.asList(ConnectionStrategyEnum.AD) + .groups( + Arrays.asList( + SynchronizedGroupPayload + .builder() + .id("id") + .build() + ) ) .build() ); @@ -18625,47 +19626,15 @@ client.clients().connections().get(
-#### ⚙️ Parameters - -
-
- -
-
- -**id:** `String` — ID of the client for which to retrieve enabled connections. - -
-
- -
-
- -**strategy:** `Optional` — Provide strategies to only retrieve connections with such strategies - -
-
- -
-
- -**from:** `Optional` — Optional Id from which to start selection. - -
-
- +#### ⚙️ Parameters +
-**take:** `Optional` — Number of results per page. Defaults to 50. - -
-
-
-**fields:** `Optional` — A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields +**id:** `String` — The id of the connection to add synchronized groups to
@@ -18673,7 +19642,7 @@ client.clients().connections().get(
-**includeFields:** `Optional` — true if the fields specified are to be included in the result, false otherwise (defaults to true) +**groups:** `List` — Array of Google Workspace Directory group objects to synchronize.
@@ -18685,8 +19654,7 @@ client.clients().connections().get(
-## Connections DirectoryProvisioning -
client.connections.directoryProvisioning.list() -> SyncPagingIterable&lt;DirectoryProvisioning&gt; +
client.connections.directoryProvisioning.set(id, request)
@@ -18698,7 +19666,7 @@ client.clients().connections().get(
-Retrieve a list of directory provisioning configurations of a tenant. +Create or replace the selected groups for a connection directory provisioning configuration.
@@ -18713,11 +19681,18 @@ Retrieve a list of directory provisioning configurations of a tenant.
```java -client.connections().directoryProvisioning().list( - ListDirectoryProvisioningsRequestParameters +client.connections().directoryProvisioning().set( + "id", + ReplaceSynchronizedGroupsRequestContent .builder() - .from("from") - .take(1) + .groups( + Arrays.asList( + SynchronizedGroupPayload + .builder() + .id("id") + .build() + ) + ) .build() ); ``` @@ -18734,7 +19709,7 @@ client.connections().directoryProvisioning().list(
-**from:** `Optional` — Optional Id from which to start selection. +**id:** `String` — The id of the connection to create or replace synchronized groups for
@@ -18742,7 +19717,7 @@ client.connections().directoryProvisioning().list(
-**take:** `Optional` — Number of results per page. Defaults to 50. +**groups:** `List` — Array of Google Workspace Directory group objects to synchronize.
@@ -18754,7 +19729,7 @@ client.connections().directoryProvisioning().list(
-
client.connections.directoryProvisioning.get(id) -> GetDirectoryProvisioningResponseContent +
client.connections.directoryProvisioning.deleteSynchronizedGroupSelections(id, request)
@@ -18766,7 +19741,7 @@ client.connections().directoryProvisioning().list(
-Retrieve the directory provisioning configuration of a connection. +Delete synchronized group selections for a directory provisioning configuration
@@ -18781,7 +19756,20 @@ Retrieve the directory provisioning configuration of a connection.
```java -client.connections().directoryProvisioning().get("id"); +client.connections().directoryProvisioning().deleteSynchronizedGroupSelections( + "id", + DeleteSynchronizedGroupsRequestContent + .builder() + .groups( + Arrays.asList( + SynchronizedGroupSelectionId + .builder() + .id("id") + .build() + ) + ) + .build() +); ```
@@ -18796,7 +19784,15 @@ client.connections().directoryProvisioning().get("id");
-**id:** `String` — The id of the connection to retrieve its directory provisioning configuration +**id:** `String` — The id of the connection to delete synchronized group selections for + +
+
+ +
+
+ +**groups:** `List` — Array of groups to remove from the selection set.
@@ -18808,7 +19804,8 @@ client.connections().directoryProvisioning().get("id");
-
client.connections.directoryProvisioning.create(id, request) -> CreateDirectoryProvisioningResponseContent +## Connections ScimConfiguration +
client.connections.scimConfiguration.list() -> SyncPagingIterable&lt;ScimConfiguration&gt;
@@ -18820,7 +19817,7 @@ client.connections().directoryProvisioning().get("id");
-Create a directory provisioning configuration for a connection. +Retrieve a list of SCIM configurations of a tenant.
@@ -18835,13 +19832,12 @@ Create a directory provisioning configuration for a connection.
```java -client.connections().directoryProvisioning().create( - "id", - OptionalNullable.of( - CreateDirectoryProvisioningRequestContent - .builder() - .build() - ) +client.connections().scimConfiguration().list( + ListScimConfigurationsRequestParameters + .builder() + .from("from") + .take(1) + .build() ); ```
@@ -18857,7 +19853,7 @@ client.connections().directoryProvisioning().create(
-**id:** `String` — The id of the connection to create its directory provisioning configuration +**from:** `Optional` — Optional Id from which to start selection.
@@ -18865,7 +19861,7 @@ client.connections().directoryProvisioning().create(
-**request:** `Optional` +**take:** `Optional` — Number of results per page. Defaults to 50.
@@ -18877,7 +19873,7 @@ client.connections().directoryProvisioning().create(
-
client.connections.directoryProvisioning.delete(id) +
client.connections.scimConfiguration.get(id) -> GetScimConfigurationResponseContent
@@ -18889,7 +19885,7 @@ client.connections().directoryProvisioning().create(
-Delete the directory provisioning configuration of a connection. +Retrieves a scim configuration by its `connectionId`.
@@ -18904,7 +19900,7 @@ Delete the directory provisioning configuration of a connection.
```java -client.connections().directoryProvisioning().delete("id"); +client.connections().scimConfiguration().get("id"); ```
@@ -18919,7 +19915,7 @@ client.connections().directoryProvisioning().delete("id");
-**id:** `String` — The id of the connection to delete its directory provisioning configuration +**id:** `String` — The id of the connection to retrieve its SCIM configuration
@@ -18931,7 +19927,7 @@ client.connections().directoryProvisioning().delete("id");
-
client.connections.directoryProvisioning.update(id, request) -> UpdateDirectoryProvisioningResponseContent +
client.connections.scimConfiguration.create(id, request) -> CreateScimConfigurationResponseContent
@@ -18943,7 +19939,7 @@ client.connections().directoryProvisioning().delete("id");
-Update the directory provisioning configuration of a connection. +Create a scim configuration for a connection.
@@ -18958,10 +19954,10 @@ Update the directory provisioning configuration of a connection.
```java -client.connections().directoryProvisioning().update( +client.connections().scimConfiguration().create( "id", OptionalNullable.of( - UpdateDirectoryProvisioningRequestContent + CreateScimConfigurationRequestContent .builder() .build() ) @@ -18980,7 +19976,7 @@ client.connections().directoryProvisioning().update(
-**id:** `String` — The id of the connection to create its directory provisioning configuration +**id:** `String` — The id of the connection to create its SCIM configuration
@@ -18988,7 +19984,7 @@ client.connections().directoryProvisioning().update(
-**request:** `Optional` +**request:** `Optional`
@@ -19000,7 +19996,7 @@ client.connections().directoryProvisioning().update(
-
client.connections.directoryProvisioning.getDefaultMapping(id) -> GetDirectoryProvisioningDefaultMappingResponseContent +
client.connections.scimConfiguration.delete(id)
@@ -19012,7 +20008,7 @@ client.connections().directoryProvisioning().update(
-Retrieve the directory provisioning default attribute mapping of a connection. +Deletes a scim configuration by its `connectionId`.
@@ -19027,7 +20023,7 @@ Retrieve the directory provisioning default attribute mapping of a connection.
```java -client.connections().directoryProvisioning().getDefaultMapping("id"); +client.connections().scimConfiguration().delete("id"); ```
@@ -19042,7 +20038,7 @@ client.connections().directoryProvisioning().getDefaultMapping("id");
-**id:** `String` — The id of the connection to retrieve its directory provisioning configuration +**id:** `String` — The id of the connection to delete its SCIM configuration
@@ -19054,7 +20050,7 @@ client.connections().directoryProvisioning().getDefaultMapping("id");
-
client.connections.directoryProvisioning.listSynchronizedGroups(id) -> SyncPagingIterable&lt;SynchronizedGroupPayload&gt; +
client.connections.scimConfiguration.update(id, request) -> UpdateScimConfigurationResponseContent
@@ -19066,7 +20062,7 @@ client.connections().directoryProvisioning().getDefaultMapping("id");
-Retrieve the configured synchronized groups for a connection directory provisioning configuration. +Update a scim configuration by its `connectionId`.
@@ -19081,12 +20077,18 @@ Retrieve the configured synchronized groups for a connection directory provision
```java -client.connections().directoryProvisioning().listSynchronizedGroups( +client.connections().scimConfiguration().update( "id", - ListSynchronizedGroupsRequestParameters + UpdateScimConfigurationRequestContent .builder() - .from("from") - .take(1) + .userIdAttribute("user_id_attribute") + .mapping( + Arrays.asList( + ScimMappingItem + .builder() + .build() + ) + ) .build() ); ``` @@ -19103,7 +20105,7 @@ client.connections().directoryProvisioning().listSynchronizedGroups(
-**id:** `String` — The id of the connection to list synchronized groups for. +**id:** `String` — The id of the connection to update its SCIM configuration
@@ -19111,7 +20113,7 @@ client.connections().directoryProvisioning().listSynchronizedGroups(
-**from:** `Optional` — Optional Id from which to start selection. +**userIdAttribute:** `String` — User ID attribute for generating unique user ids
@@ -19119,7 +20121,7 @@ client.connections().directoryProvisioning().listSynchronizedGroups(
-**take:** `Optional` — Number of results per page. Defaults to 50. +**mapping:** `List` — The mapping between auth0 and SCIM
@@ -19131,7 +20133,7 @@ client.connections().directoryProvisioning().listSynchronizedGroups(
-
client.connections.directoryProvisioning.set(id, request) +
client.connections.scimConfiguration.getDefaultMapping(id) -> GetScimConfigurationDefaultMappingResponseContent
@@ -19143,7 +20145,7 @@ client.connections().directoryProvisioning().listSynchronizedGroups(
-Create or replace the selected groups for a connection directory provisioning configuration. +Retrieves a scim configuration's default mapping by its `connectionId`.
@@ -19158,20 +20160,7 @@ Create or replace the selected groups for a connection directory provisioning co
```java -client.connections().directoryProvisioning().set( - "id", - ReplaceSynchronizedGroupsRequestContent - .builder() - .groups( - Arrays.asList( - SynchronizedGroupPayload - .builder() - .id("id") - .build() - ) - ) - .build() -); +client.connections().scimConfiguration().getDefaultMapping("id"); ```
@@ -19186,15 +20175,7 @@ client.connections().directoryProvisioning().set(
-**id:** `String` — The id of the connection to create or replace synchronized groups for - -
-
- -
-
- -**groups:** `List` — Array of Google Workspace Directory group objects to synchronize. +**id:** `String` — The id of the connection to retrieve its default SCIM mapping
@@ -19206,8 +20187,8 @@ client.connections().directoryProvisioning().set(
-## Connections ScimConfiguration -
client.connections.scimConfiguration.list() -> SyncPagingIterable&lt;ScimConfiguration&gt; +## Connections Clients +
client.connections.clients.get(id) -> SyncPagingIterable&lt;ConnectionEnabledClient&gt;
@@ -19219,7 +20200,9 @@ client.connections().directoryProvisioning().set(
-Retrieve a list of SCIM configurations of a tenant. +Retrieve all clients that have the specified [connection](https://auth0.com/docs/authenticate/identity-providers) enabled. + +**Note**: The first time you call this endpoint, 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 further results are remaining.
@@ -19234,11 +20217,12 @@ Retrieve a list of SCIM configurations of a tenant.
```java -client.connections().scimConfiguration().list( - ListScimConfigurationsRequestParameters +client.connections().clients().get( + "id", + GetConnectionEnabledClientsRequestParameters .builder() - .from("from") .take(1) + .from("from") .build() ); ``` @@ -19255,7 +20239,7 @@ client.connections().scimConfiguration().list(
-**from:** `Optional` — Optional Id from which to start selection. +**id:** `String` — The id of the connection for which enabled clients are to be retrieved
@@ -19265,6 +20249,14 @@ client.connections().scimConfiguration().list( **take:** `Optional` — Number of results per page. Defaults to 50. +
+
+ +
+
+ +**from:** `Optional` — Optional Id from which to start selection. +
@@ -19275,7 +20267,65 @@ client.connections().scimConfiguration().list(
-
client.connections.scimConfiguration.get(id) -> GetScimConfigurationResponseContent +
client.connections.clients.update(id, request) +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.connections().clients().update( + "id", + Arrays.asList( + UpdateEnabledClientConnectionsRequestContentItem + .builder() + .clientId("client_id") + .status(true) + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The id of the connection to modify + +
+
+ +
+
+ +**request:** `List` + +
+
+
+
+ + +
+
+
+ +## Connections Keys +
client.connections.keys.get(id) -> List&lt;ConnectionKey&gt;
@@ -19287,7 +20337,7 @@ client.connections().scimConfiguration().list(
-Retrieves a scim configuration by its `connectionId`. +Gets the connection keys for the Okta or OIDC connection strategy.
@@ -19302,7 +20352,7 @@ Retrieves a scim configuration by its `connectionId`.
```java -client.connections().scimConfiguration().get("id"); +client.connections().keys().get("id"); ```
@@ -19317,7 +20367,7 @@ client.connections().scimConfiguration().get("id");
-**id:** `String` — The id of the connection to retrieve its SCIM configuration +**id:** `String` — ID of the connection
@@ -19329,7 +20379,7 @@ client.connections().scimConfiguration().get("id");
-
client.connections.scimConfiguration.create(id, request) -> CreateScimConfigurationResponseContent +
client.connections.keys.create(id, request) -> List&lt;PostConnectionsKeysResponseContentItem&gt;
@@ -19341,7 +20391,7 @@ client.connections().scimConfiguration().get("id");
-Create a scim configuration for a connection. +Provision initial connection keys for Okta or OIDC connection strategies. This endpoint allows you to create keys before configuring the connection to use Private Key JWT authentication, enabling zero-downtime transitions.
@@ -19356,10 +20406,10 @@ Create a scim configuration for a connection.
```java -client.connections().scimConfiguration().create( +client.connections().keys().create( "id", OptionalNullable.of( - CreateScimConfigurationRequestContent + PostConnectionKeysRequestContent .builder() .build() ) @@ -19378,7 +20428,7 @@ client.connections().scimConfiguration().create(
-**id:** `String` — The id of the connection to create its SCIM configuration +**id:** `String` — ID of the connection
@@ -19386,7 +20436,7 @@ client.connections().scimConfiguration().create(
-**request:** `Optional` +**request:** `Optional`
@@ -19398,7 +20448,7 @@ client.connections().scimConfiguration().create(
-
client.connections.scimConfiguration.delete(id) +
client.connections.keys.rotate(id, request) -> RotateConnectionsKeysResponseContent
@@ -19410,7 +20460,7 @@ client.connections().scimConfiguration().create(
-Deletes a scim configuration by its `connectionId`. +Rotates the connection keys for the Okta or OIDC connection strategies.
@@ -19425,7 +20475,14 @@ Deletes a scim configuration by its `connectionId`.
```java -client.connections().scimConfiguration().delete("id"); +client.connections().keys().rotate( + "id", + OptionalNullable.of( + RotateConnectionKeysRequestContent + .builder() + .build() + ) +); ```
@@ -19440,7 +20497,15 @@ client.connections().scimConfiguration().delete("id");
-**id:** `String` — The id of the connection to delete its SCIM configuration +**id:** `String` — ID of the connection + +
+
+ +
+
+ +**request:** `Optional`
@@ -19452,7 +20517,8 @@ client.connections().scimConfiguration().delete("id");
-
client.connections.scimConfiguration.update(id, request) -> UpdateScimConfigurationResponseContent +## Connections Users +
client.connections.users.deleteByEmail(id)
@@ -19464,7 +20530,7 @@ client.connections().scimConfiguration().delete("id");
-Update a scim configuration by its `connectionId`. +Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.
@@ -19479,18 +20545,11 @@ Update a scim configuration by its `connectionId`.
```java -client.connections().scimConfiguration().update( +client.connections().users().deleteByEmail( "id", - UpdateScimConfigurationRequestContent + DeleteConnectionUsersByEmailQueryParameters .builder() - .userIdAttribute("user_id_attribute") - .mapping( - Arrays.asList( - ScimMappingItem - .builder() - .build() - ) - ) + .email("email") .build() ); ``` @@ -19507,15 +20566,7 @@ client.connections().scimConfiguration().update(
-**id:** `String` — The id of the connection to update its SCIM configuration - -
-
- -
-
- -**userIdAttribute:** `String` — User ID attribute for generating unique user ids +**id:** `String` — The id of the connection (currently only database connections are supported)
@@ -19523,7 +20574,7 @@ client.connections().scimConfiguration().update(
-**mapping:** `List` — The mapping between auth0 and SCIM +**email:** `String` — The email of the user to delete
@@ -19535,7 +20586,8 @@ client.connections().scimConfiguration().update(
-
client.connections.scimConfiguration.getDefaultMapping(id) -> GetScimConfigurationDefaultMappingResponseContent +## Connections DirectoryProvisioning Synchronizations +
client.connections.directoryProvisioning.synchronizations.create(id) -> CreateDirectorySynchronizationResponseContent
@@ -19547,7 +20599,7 @@ client.connections().scimConfiguration().update(
-Retrieves a scim configuration's default mapping by its `connectionId`. +Request an on-demand synchronization of the directory.
@@ -19562,7 +20614,7 @@ Retrieves a scim configuration's default mapping by its `connectionId`.
```java -client.connections().scimConfiguration().getDefaultMapping("id"); +client.connections().directoryProvisioning().synchronizations().create("id"); ```
@@ -19577,7 +20629,7 @@ client.connections().scimConfiguration().getDefaultMapping("id");
-**id:** `String` — The id of the connection to retrieve its default SCIM mapping +**id:** `String` — The id of the connection to trigger synchronization for
@@ -19589,8 +20641,8 @@ client.connections().scimConfiguration().getDefaultMapping("id");
-## Connections Clients -
client.connections.clients.get(id) -> SyncPagingIterable&lt;ConnectionEnabledClient&gt; +## Connections ScimConfiguration Tokens +
client.connections.scimConfiguration.tokens.get(id) -> List&lt;ScimTokenItem&gt;
@@ -19602,9 +20654,7 @@ client.connections().scimConfiguration().getDefaultMapping("id");
-Retrieve all clients that have the specified [connection](https://auth0.com/docs/authenticate/identity-providers) enabled. - -**Note**: The first time you call this endpoint, 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 further results are remaining. +Retrieves all scim tokens by its connection `id`.
@@ -19619,14 +20669,7 @@ Retrieve all clients that have the specified [connection](https://auth0.com/docs
```java -client.connections().clients().get( - "id", - GetConnectionEnabledClientsRequestParameters - .builder() - .take(1) - .from("from") - .build() -); +client.connections().scimConfiguration().tokens().get("id"); ```
@@ -19641,23 +20684,7 @@ client.connections().clients().get(
-**id:** `String` — The id of the connection for which enabled clients are to be retrieved - -
-
- -
-
- -**take:** `Optional` — Number of results per page. Defaults to 50. - -
-
- -
-
- -**from:** `Optional` — Optional Id from which to start selection. +**id:** `String` — The id of the connection to retrieve its SCIM configuration
@@ -19669,11 +20696,11 @@ client.connections().clients().get(
-
client.connections.clients.update(id, request) +
client.connections.scimConfiguration.tokens.create(id, request) -> CreateScimTokenResponseContent
-#### 🔌 Usage +#### 📝 Description
@@ -19681,57 +20708,34 @@ client.connections().clients().get(
-```java -client.connections().clients().update( - "id", - Arrays.asList( - UpdateEnabledClientConnectionsRequestContentItem - .builder() - .clientId("client_id") - .status(true) - .build() - ) -); -``` +Create a scim token for a scim client.
-#### ⚙️ Parameters - -
-
+#### 🔌 Usage
-**id:** `String` — The id of the connection to modify - -
-
-
-**request:** `List` - -
-
+```java +client.connections().scimConfiguration().tokens().create( + "id", + CreateScimTokenRequestContent + .builder() + .build() +); +```
- -
-
- -## Connections Keys -
client.connections.keys.get(id) -> List&lt;ConnectionKey&gt; -
-
-#### 📝 Description +#### ⚙️ Parameters
@@ -19739,37 +20743,23 @@ client.connections().clients().update(
-Gets the connection keys for the Okta or OIDC connection strategy. -
-
+**id:** `String` — The id of the connection to create its SCIM token +
-#### 🔌 Usage - -
-
-
-```java -client.connections().keys().get("id"); -``` -
-
+**scopes:** `Optional>` — The scopes of the scim token +
-#### ⚙️ Parameters - -
-
-
-**id:** `String` — ID of the connection +**tokenLifetime:** `Optional` — Lifetime of the token in seconds. Must be greater than 900
@@ -19781,7 +20771,7 @@ client.connections().keys().get("id");
-
client.connections.keys.create(id, request) -> List&lt;PostConnectionsKeysResponseContentItem&gt; +
client.connections.scimConfiguration.tokens.delete(id, tokenId)
@@ -19793,7 +20783,7 @@ client.connections().keys().get("id");
-Provision initial connection keys for Okta or OIDC connection strategies. This endpoint allows you to create keys before configuring the connection to use Private Key JWT authentication, enabling zero-downtime transitions. +Deletes a scim token by its connection `id` and `tokenId`.
@@ -19808,14 +20798,7 @@ Provision initial connection keys for Okta or OIDC connection strategies. This e
```java -client.connections().keys().create( - "id", - OptionalNullable.of( - PostConnectionKeysRequestContent - .builder() - .build() - ) -); +client.connections().scimConfiguration().tokens().delete("id", "tokenId"); ```
@@ -19830,7 +20813,7 @@ client.connections().keys().create(
-**id:** `String` — ID of the connection +**id:** `String` — The connection id that owns the SCIM token to delete
@@ -19838,7 +20821,7 @@ client.connections().keys().create(
-**request:** `Optional` +**tokenId:** `String` — The id of the scim token to delete
@@ -19850,7 +20833,8 @@ client.connections().keys().create(
-
client.connections.keys.rotate(id, request) -> RotateConnectionsKeysResponseContent +## Emails Provider +
client.emails.provider.get() -> GetEmailProviderResponseContent
@@ -19862,7 +20846,7 @@ client.connections().keys().create(
-Rotates the connection keys for the Okta or OIDC connection strategies. +Retrieve details of the [email provider configuration](https://auth0.com/docs/customize/email/smtp-email-providers) in your tenant. A list of fields to include or exclude may also be specified.
@@ -19877,13 +20861,12 @@ Rotates the connection keys for the Okta or OIDC connection strategies.
```java -client.connections().keys().rotate( - "id", - OptionalNullable.of( - RotateConnectionKeysRequestContent - .builder() - .build() - ) +client.emails().provider().get( + GetEmailProviderRequestParameters + .builder() + .fields("fields") + .includeFields(true) + .build() ); ```
@@ -19899,7 +20882,7 @@ client.connections().keys().rotate(
-**id:** `String` — ID of the connection +**fields:** `Optional` — Comma-separated list of fields to include or exclude (dependent upon include_fields) from the result. Leave empty to retrieve `name` and `enabled`. Additional fields available include `credentials`, `default_from_address`, and `settings`.
@@ -19907,7 +20890,7 @@ client.connections().keys().rotate(
-**request:** `Optional` +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false).
@@ -19919,8 +20902,7 @@ client.connections().keys().rotate(
-## Connections Users -
client.connections.users.deleteByEmail(id) +
client.emails.provider.create(request) -> CreateEmailProviderResponseContent
@@ -19932,7 +20914,31 @@ client.connections().keys().rotate(
-Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported. +Create an [email provider](https://auth0.com/docs/email/providers). The `credentials` object +requires different properties depending on the email provider (which is specified using the `name` property): + +- `mandrill` requires `api_key` +- `sendgrid` requires `api_key` +- `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use + the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in + North America. `eu` or `null` are the only valid values for `region`. +- `mailgun` requires `api_key` and `domain`. Optionally, set `region` to + `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or + `null` are the only valid values for `region`. +- `ses` requires `accessKeyId`, `secretAccessKey`, and `region` +- `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and + `smtp_pass` + +Depending on the type of provider it is possible to specify `settings` object with different configuration +options, which will be used when sending an email: + +- `smtp` provider, `settings` may contain `headers` object. + - When using AWS SES SMTP host, you may provide a name of configuration set in + `X-SES-Configuration-Set` header. Value must be a string. + - When using Sparkpost host, you may provide value for + `X-MSYS_API` header. Value must be an object. +- For `ses` provider, `settings` may contain `message` object, where you can provide + a name of configuration set in `configuration_set_name` property. Value must be a string.
@@ -19947,11 +20953,18 @@ Deletes a specified connection user by its email (you cannot delete all users fr
```java -client.connections().users().deleteByEmail( - "id", - DeleteConnectionUsersByEmailQueryParameters +client.emails().provider().create( + CreateEmailProviderRequestContent .builder() - .email("email") + .name(EmailProviderNameEnum.MAILGUN) + .credentials( + EmailProviderCredentialsSchema.of( + EmailProviderCredentialsSchemaZero + .builder() + .apiKey("api_key") + .build() + ) + ) .build() ); ``` @@ -19968,7 +20981,7 @@ client.connections().users().deleteByEmail(
-**id:** `String` — The id of the connection (currently only database connections are supported) +**name:** `EmailProviderNameEnum`
@@ -19976,62 +20989,31 @@ client.connections().users().deleteByEmail(
-**email:** `String` — The email of the user to delete +**enabled:** `Optional` — Whether the provider is enabled (true) or disabled (false).
-
-
- - - - -
- -## Connections DirectoryProvisioning Synchronizations -
client.connections.directoryProvisioning.synchronizations.create(id) -> CreateDirectorySynchronizationResponseContent -
-
- -#### 📝 Description - -
-
-Request an on-demand synchronization of the directory. -
-
+**defaultFromAddress:** `Optional` — Email address to use as "from" when no other address specified. +
-#### 🔌 Usage - -
-
-
-```java -client.connections().directoryProvisioning().synchronizations().create("id"); -``` -
-
+**credentials:** `EmailProviderCredentialsSchema` +
-#### ⚙️ Parameters - -
-
-
-**id:** `String` — The id of the connection to trigger synchronization for +**settings:** `Optional>`
@@ -20043,8 +21025,7 @@ client.connections().directoryProvisioning().synchronizations().create("id");
-## Connections ScimConfiguration Tokens -
client.connections.scimConfiguration.tokens.get(id) -> List&lt;ScimTokenItem&gt; +
client.emails.provider.delete()
@@ -20056,7 +21037,7 @@ client.connections().directoryProvisioning().synchronizations().create("id");
-Retrieves all scim tokens by its connection `id`. +Delete the email provider.
@@ -20071,34 +21052,19 @@ Retrieves all scim tokens by its connection `id`.
```java -client.connections().scimConfiguration().tokens().get("id"); +client.emails().provider().delete(); ```
-#### ⚙️ Parameters - -
-
- -
-
- -**id:** `String` — The id of the connection to retrieve its SCIM configuration - -
-
-
-
-
-
client.connections.scimConfiguration.tokens.create(id, request) -> CreateScimTokenResponseContent +
client.emails.provider.update(request) -> UpdateEmailProviderResponseContent
@@ -20110,7 +21076,32 @@ client.connections().scimConfiguration().tokens().get("id");
-Create a scim token for a scim client. +Update an [email provider](https://auth0.com/docs/email/providers). The `credentials` object +requires different properties depending on the email provider (which is specified using the `name` property): + +- `mandrill` requires `api_key` +- `sendgrid` requires `api_key` +- `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use + the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in + North America. `eu` or `null` are the only valid values for `region`. +- `mailgun` requires `api_key` and `domain`. Optionally, set `region` to + `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or + `null` are the only valid values for `region`. +- `ses` requires `accessKeyId`, `secretAccessKey`, and `region` +- `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and + `smtp_pass` + +Depending on the type of provider it is possible to specify `settings` object with different configuration +options, which will be used when sending an email: + +- `smtp` provider, `settings` may contain `headers` object. + - When using AWS SES SMTP host, you may provide a name of configuration set in + `X-SES-Configuration-Set` header. Value must be a string. + - When using Sparkpost host, you may provide value for + `X-MSYS_API` header. Value must be an object. + + For `ses` provider, `settings` may contain `message` object, where you can provide + a name of configuration set in `configuration_set_name` property. Value must be a string.
@@ -20125,9 +21116,8 @@ Create a scim token for a scim client.
```java -client.connections().scimConfiguration().tokens().create( - "id", - CreateScimTokenRequestContent +client.emails().provider().update( + UpdateEmailProviderRequestContent .builder() .build() ); @@ -20145,7 +21135,7 @@ client.connections().scimConfiguration().tokens().create(
-**id:** `String` — The id of the connection to create its SCIM token +**name:** `Optional`
@@ -20153,7 +21143,7 @@ client.connections().scimConfiguration().tokens().create(
-**scopes:** `Optional>` — The scopes of the scim token +**enabled:** `Optional` — Whether the provider is enabled (true) or disabled (false).
@@ -20161,35 +21151,38 @@ client.connections().scimConfiguration().tokens().create(
-**tokenLifetime:** `Optional` — Lifetime of the token in seconds. Must be greater than 900 +**defaultFromAddress:** `Optional` — Email address to use as "from" when no other address specified.
-
-
- - - -
- -
client.connections.scimConfiguration.tokens.delete(id, tokenId)
-#### 📝 Description - -
-
+**credentials:** `Optional` + +
+
-Deletes a scim token by its connection `id` and `tokenId`. +**settings:** `Optional>` + +
+
+ + +
+ +## EventStreams Deliveries +
client.eventStreams.deliveries.list(id) -> SyncPagingIterable&lt;EventStreamDelivery&gt; +
+
#### 🔌 Usage @@ -20200,7 +21193,18 @@ Deletes a scim token by its connection `id` and `tokenId`.
```java -client.connections().scimConfiguration().tokens().delete("id", "tokenId"); +client.eventStreams().deliveries().list( + "id", + ListEventStreamDeliveriesRequestParameters + .builder() + .statuses("statuses") + .eventTypes("event_types") + .dateFrom("date_from") + .dateTo("date_to") + .from("from") + .take(1) + .build() +); ```
@@ -20215,7 +21219,7 @@ client.connections().scimConfiguration().tokens().delete("id", "tokenId");
-**id:** `String` — The connection id that owns the SCIM token to delete +**id:** `String` — Unique identifier for the event stream.
@@ -20223,36 +21227,61 @@ client.connections().scimConfiguration().tokens().delete("id", "tokenId");
-**tokenId:** `String` — The id of the scim token to delete +**statuses:** `Optional` — Comma-separated list of statuses by which to filter
+ +
+
+ +**eventTypes:** `Optional` — Comma-separated list of event types by which to filter +
+
+
+**dateFrom:** `Optional` — An RFC-3339 date-time for redelivery start, inclusive. Does not allow sub-second precision. +
-
-## Emails Provider -
client.emails.provider.get() -> GetEmailProviderResponseContent
-#### 📝 Description +**dateTo:** `Optional` — An RFC-3339 date-time for redelivery end, exclusive. Does not allow sub-second precision. + +
+
+**from:** `Optional` — Optional Id from which to start selection. + +
+
+
-Retrieve details of the [email provider configuration](https://auth0.com/docs/customize/email/smtp-email-providers) in your tenant. A list of fields to include or exclude may also be specified. +**take:** `Optional` — Number of results per page. Defaults to 50. + +
+
+ + +
+ +
client.eventStreams.deliveries.getHistory(id, eventId) -> GetEventStreamDeliveryHistoryResponseContent +
+
#### 🔌 Usage @@ -20263,13 +21292,7 @@ Retrieve details of the [email provider configuration](https://auth0.com/docs/cu
```java -client.emails().provider().get( - GetEmailProviderRequestParameters - .builder() - .fields("fields") - .includeFields(true) - .build() -); +client.eventStreams().deliveries().getHistory("id", "event_id"); ```
@@ -20284,7 +21307,7 @@ client.emails().provider().get(
-**fields:** `Optional` — Comma-separated list of fields to include or exclude (dependent upon include_fields) from the result. Leave empty to retrieve `name` and `enabled`. Additional fields available include `credentials`, `default_from_address`, and `settings`. +**id:** `String` — Unique identifier for the event stream.
@@ -20292,7 +21315,7 @@ client.emails().provider().get(
-**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). +**eventId:** `String` — Unique identifier for the event
@@ -20304,48 +21327,11 @@ client.emails().provider().get(
-
client.emails.provider.create(request) -> CreateEmailProviderResponseContent -
-
- -#### 📝 Description - -
-
- +## EventStreams Redeliveries +
client.eventStreams.redeliveries.create(id, request) -> CreateEventStreamRedeliveryResponseContent
-Create an [email provider](https://auth0.com/docs/email/providers). The `credentials` object -requires different properties depending on the email provider (which is specified using the `name` property): - -- `mandrill` requires `api_key` -- `sendgrid` requires `api_key` -- `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use - the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in - North America. `eu` or `null` are the only valid values for `region`. -- `mailgun` requires `api_key` and `domain`. Optionally, set `region` to - `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or - `null` are the only valid values for `region`. -- `ses` requires `accessKeyId`, `secretAccessKey`, and `region` -- `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and - `smtp_pass` - -Depending on the type of provider it is possible to specify `settings` object with different configuration -options, which will be used when sending an email: - -- `smtp` provider, `settings` may contain `headers` object. - - When using AWS SES SMTP host, you may provide a name of configuration set in - `X-SES-Configuration-Set` header. Value must be a string. - - When using Sparkpost host, you may provide value for - `X-MSYS_API` header. Value must be an object. -- For `ses` provider, `settings` may contain `message` object, where you can provide - a name of configuration set in `configuration_set_name` property. Value must be a string. -
-
-
-
- #### 🔌 Usage
@@ -20354,19 +21340,11 @@ options, which will be used when sending an email:
-```java -client.emails().provider().create( - CreateEmailProviderRequestContent - .builder() - .name(EmailProviderNameEnum.MAILGUN) - .credentials( - EmailProviderCredentialsSchema.of( - EmailProviderCredentialsSchemaZero - .builder() - .apiKey("api_key") - .build() - ) - ) +```java +client.eventStreams().redeliveries().create( + "id", + CreateEventStreamRedeliveryRequestContent + .builder() .build() ); ``` @@ -20383,7 +21361,7 @@ client.emails().provider().create(
-**name:** `EmailProviderNameEnum` +**id:** `String` — Unique identifier for the event stream.
@@ -20391,7 +21369,7 @@ client.emails().provider().create(
-**enabled:** `Optional` — Whether the provider is enabled (true) or disabled (false). +**dateFrom:** `Optional` — An RFC-3339 date-time for redelivery start, inclusive. Does not allow sub-second precision.
@@ -20399,7 +21377,7 @@ client.emails().provider().create(
-**defaultFromAddress:** `Optional` — Email address to use as "from" when no other address specified. +**dateTo:** `Optional` — An RFC-3339 date-time for redelivery end, exclusive. Does not allow sub-second precision.
@@ -20407,7 +21385,7 @@ client.emails().provider().create(
-**credentials:** `EmailProviderCredentialsSchema` +**statuses:** `Optional>` — Filter by status
@@ -20415,7 +21393,7 @@ client.emails().provider().create(
-**settings:** `Optional>` +**eventTypes:** `Optional>` — Filter by event type
@@ -20427,11 +21405,11 @@ client.emails().provider().create(
-
client.emails.provider.delete() +
client.eventStreams.redeliveries.createById(id, eventId)
-#### 📝 Description +#### 🔌 Usage
@@ -20439,13 +21417,15 @@ client.emails().provider().create(
-Delete the email provider. +```java +client.eventStreams().redeliveries().createById("id", "event_id"); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -20453,9 +21433,16 @@ Delete the email provider.
-```java -client.emails().provider().delete(); -``` +**id:** `String` — Unique identifier for the event stream. + +
+
+ +
+
+ +**eventId:** `String` — Unique identifier for the event +
@@ -20466,49 +21453,11 @@ client.emails().provider().delete();
-
client.emails.provider.update(request) -> UpdateEmailProviderResponseContent -
-
- -#### 📝 Description - -
-
- +## Flows Executions +
client.flows.executions.list(flowId) -> SyncPagingIterable&lt;FlowExecutionSummary&gt;
-Update an [email provider](https://auth0.com/docs/email/providers). The `credentials` object -requires different properties depending on the email provider (which is specified using the `name` property): - -- `mandrill` requires `api_key` -- `sendgrid` requires `api_key` -- `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use - the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in - North America. `eu` or `null` are the only valid values for `region`. -- `mailgun` requires `api_key` and `domain`. Optionally, set `region` to - `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or - `null` are the only valid values for `region`. -- `ses` requires `accessKeyId`, `secretAccessKey`, and `region` -- `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and - `smtp_pass` - -Depending on the type of provider it is possible to specify `settings` object with different configuration -options, which will be used when sending an email: - -- `smtp` provider, `settings` may contain `headers` object. - - When using AWS SES SMTP host, you may provide a name of configuration set in - `X-SES-Configuration-Set` header. Value must be a string. - - When using Sparkpost host, you may provide value for - `X-MSYS_API` header. Value must be an object. - - For `ses` provider, `settings` may contain `message` object, where you can provide - a name of configuration set in `configuration_set_name` property. Value must be a string. -
-
-
-
- #### 🔌 Usage
@@ -20518,9 +21467,13 @@ options, which will be used when sending an email:
```java -client.emails().provider().update( - UpdateEmailProviderRequestContent +client.flows().executions().list( + "flow_id", + ListFlowExecutionsRequestParameters .builder() + .includeTotals(true) + .from("from") + .take(1) .build() ); ``` @@ -20537,15 +21490,7 @@ client.emails().provider().update(
-**name:** `Optional` - -
-
- -
-
- -**enabled:** `Optional` — Whether the provider is enabled (true) or disabled (false). +**flowId:** `String` — Flow id
@@ -20553,7 +21498,7 @@ client.emails().provider().update(
-**defaultFromAddress:** `Optional` — Email address to use as "from" when no other address specified. +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
@@ -20561,7 +21506,7 @@ client.emails().provider().update(
-**credentials:** `Optional` +**from:** `Optional` — Optional Id from which to start selection.
@@ -20569,7 +21514,7 @@ client.emails().provider().update(
-**settings:** `Optional>` +**take:** `Optional` — Number of results per page. Defaults to 50.
@@ -20581,8 +21526,7 @@ client.emails().provider().update(
-## EventStreams Deliveries -
client.eventStreams.deliveries.list(id) -> List&lt;EventStreamDelivery&gt; +
client.flows.executions.get(flowId, executionId) -> GetFlowExecutionResponseContent
@@ -20595,16 +21539,14 @@ client.emails().provider().update(
```java -client.eventStreams().deliveries().list( - "id", - ListEventStreamDeliveriesRequestParameters +client.flows().executions().get( + "flow_id", + "execution_id", + GetFlowExecutionRequestParameters .builder() - .statuses("statuses") - .eventTypes("event_types") - .dateFrom("date_from") - .dateTo("date_to") - .from("from") - .take(1) + .hydrate( + Arrays.asList(GetFlowExecutionRequestParametersHydrateEnum.DEBUG) + ) .build() ); ``` @@ -20621,7 +21563,7 @@ client.eventStreams().deliveries().list(
-**id:** `String` — Unique identifier for the event stream. +**flowId:** `String` — Flow id
@@ -20629,7 +21571,7 @@ client.eventStreams().deliveries().list(
-**statuses:** `Optional` — Comma-separated list of statuses by which to filter +**executionId:** `String` — Flow execution id
@@ -20637,31 +21579,47 @@ client.eventStreams().deliveries().list(
-**eventTypes:** `Optional` — Comma-separated list of event types by which to filter +**hydrate:** `Optional` — Hydration param
+
+
-
-
-**dateFrom:** `Optional` — An RFC-3339 date-time for redelivery start, inclusive. Does not allow sub-second precision. -
+
+ +
client.flows.executions.delete(flowId, executionId) +
+
+ +#### 🔌 Usage
-**dateTo:** `Optional` — An RFC-3339 date-time for redelivery end, exclusive. Does not allow sub-second precision. - +
+
+ +```java +client.flows().executions().delete("flow_id", "execution_id"); +``` +
+
+#### ⚙️ Parameters +
-**from:** `Optional` — Optional Id from which to start selection. +
+
+ +**flowId:** `String` — Flows id
@@ -20669,7 +21627,7 @@ client.eventStreams().deliveries().list(
-**take:** `Optional` — Number of results per page. Defaults to 50. +**executionId:** `String` — Flow execution identifier
@@ -20681,7 +21639,8 @@ client.eventStreams().deliveries().list(
-
client.eventStreams.deliveries.getHistory(id, eventId) -> GetEventStreamDeliveryHistoryResponseContent +## Flows Vault Connections +
client.flows.vault.connections.list() -> SyncPagingIterable&lt;FlowsVaultConnectionSummary&gt;
@@ -20694,7 +21653,14 @@ client.eventStreams().deliveries().list(
```java -client.eventStreams().deliveries().getHistory("id", "event_id"); +client.flows().vault().connections().list( + ListFlowsVaultConnectionsRequestParameters + .builder() + .page(1) + .perPage(1) + .includeTotals(true) + .build() +); ```
@@ -20709,7 +21675,7 @@ client.eventStreams().deliveries().getHistory("id", "event_id");
-**id:** `String` — Unique identifier for the event stream. +**page:** `Optional` — Page index of the results to return. First page is 0.
@@ -20717,7 +21683,15 @@ client.eventStreams().deliveries().getHistory("id", "event_id");
-**eventId:** `String` — Unique identifier for the event +**perPage:** `Optional` — Number of results per page. Defaults to 50. + +
+
+ +
+
+ +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
@@ -20729,8 +21703,7 @@ client.eventStreams().deliveries().getHistory("id", "event_id");
-## EventStreams Redeliveries -
client.eventStreams.redeliveries.create(id, request) -> CreateEventStreamRedeliveryResponseContent +
client.flows.vault.connections.create(request) -> CreateFlowsVaultConnectionResponseContent
@@ -20743,11 +21716,24 @@ client.eventStreams().deliveries().getHistory("id", "event_id");
```java -client.eventStreams().redeliveries().create( - "id", - CreateEventStreamRedeliveryRequestContent - .builder() - .build() +client.flows().vault().connections().create( + CreateFlowsVaultConnectionRequestContent.of( + CreateFlowsVaultConnectionActivecampaign.of( + CreateFlowsVaultConnectionActivecampaignApiKey + .builder() + .name("name") + .appId(FlowsVaultConnectionAppIdActivecampaignEnum.ACTIVECAMPAIGN) + .setup( + FlowsVaultConnectioSetupApiKeyWithBaseUrl + .builder() + .type(FlowsVaultConnectioSetupTypeApiKeyEnum.API_KEY) + .apiKey("api_key") + .baseUrl("base_url") + .build() + ) + .build() + ) + ) ); ```
@@ -20763,39 +21749,47 @@ client.eventStreams().redeliveries().create(
-**id:** `String` — Unique identifier for the event stream. +**request:** `CreateFlowsVaultConnectionRequestContent`
+ +
-
-
-**dateFrom:** `Optional` — An RFC-3339 date-time for redelivery start, inclusive. Does not allow sub-second precision. -
+
+
client.flows.vault.connections.get(id) -> GetFlowsVaultConnectionResponseContent
-**dateTo:** `Optional` — An RFC-3339 date-time for redelivery end, exclusive. Does not allow sub-second precision. - -
-
+#### 🔌 Usage
-**statuses:** `Optional>` — Filter by status - +
+
+ +```java +client.flows().vault().connections().get("id"); +``` +
+
+#### ⚙️ Parameters +
-**eventTypes:** `Optional>` — Filter by event type +
+
+ +**id:** `String` — Flows Vault connection ID
@@ -20807,7 +21801,7 @@ client.eventStreams().redeliveries().create(
-
client.eventStreams.redeliveries.createById(id, eventId) +
client.flows.vault.connections.delete(id)
@@ -20820,7 +21814,7 @@ client.eventStreams().redeliveries().create(
```java -client.eventStreams().redeliveries().createById("id", "event_id"); +client.flows().vault().connections().delete("id"); ```
@@ -20835,15 +21829,7 @@ client.eventStreams().redeliveries().createById("id", "event_id");
-**id:** `String` — Unique identifier for the event stream. - -
-
- -
-
- -**eventId:** `String` — Unique identifier for the event +**id:** `String` — Vault connection id
@@ -20855,8 +21841,7 @@ client.eventStreams().redeliveries().createById("id", "event_id");
-## Flows Executions -
client.flows.executions.list(flowId) -> SyncPagingIterable&lt;FlowExecutionSummary&gt; +
client.flows.vault.connections.update(id, request) -> UpdateFlowsVaultConnectionResponseContent
@@ -20869,12 +21854,10 @@ client.eventStreams().redeliveries().createById("id", "event_id");
```java -client.flows().executions().list( - "flow_id", - ListFlowExecutionsRequestParameters +client.flows().vault().connections().update( + "id", + UpdateFlowsVaultConnectionRequestContent .builder() - .from("from") - .take(1) .build() ); ``` @@ -20891,7 +21874,7 @@ client.flows().executions().list(
-**flowId:** `String` — Flow id +**id:** `String` — Flows Vault connection ID
@@ -20899,7 +21882,7 @@ client.flows().executions().list(
-**from:** `Optional` — Optional Id from which to start selection. +**name:** `Optional` — Flows Vault Connection name.
@@ -20907,7 +21890,7 @@ client.flows().executions().list(
-**take:** `Optional` — Number of results per page. Defaults to 50. +**setup:** `Optional`
@@ -20919,10 +21902,25 @@ client.flows().executions().list(
-
client.flows.executions.get(flowId, executionId) -> GetFlowExecutionResponseContent +## Groups Members +
client.groups.members.get(id) -> SyncPagingIterable&lt;GroupMember&gt; +
+
+ +#### 📝 Description + +
+
+
+List all users that are a member of this group. +
+
+
+
+ #### 🔌 Usage
@@ -20932,14 +21930,14 @@ client.flows().executions().list(
```java -client.flows().executions().get( - "flow_id", - "execution_id", - GetFlowExecutionRequestParameters +client.groups().members().get( + "id", + GetGroupMembersRequestParameters .builder() - .hydrate( - Arrays.asList(GetFlowExecutionRequestParametersHydrateEnum.DEBUG) - ) + .fields("fields") + .includeFields(true) + .from("from") + .take(1) .build() ); ``` @@ -20956,7 +21954,7 @@ client.flows().executions().get(
-**flowId:** `String` — Flow id +**id:** `String` — Unique identifier for the group (service-generated).
@@ -20964,7 +21962,7 @@ client.flows().executions().get(
-**executionId:** `String` — Flow execution id +**fields:** `Optional` — A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields
@@ -20972,70 +21970,52 @@ client.flows().executions().get(
-**hydrate:** `Optional` — Hydration param +**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false).
-
-
- -
-
-
- -
client.flows.executions.delete(flowId, executionId)
-#### 🔌 Usage - -
-
+**from:** `Optional` — Optional Id from which to start selection. + +
+
-```java -client.flows().executions().delete("flow_id", "execution_id"); -``` +**take:** `Optional` — Number of results per page. Defaults to 50. +
-#### ⚙️ Parameters + + +
+ +## Groups Roles +
client.groups.roles.list(id) -> SyncPagingIterable&lt;Role&gt;
+#### 📝 Description +
-**flowId:** `String` — Flows id - -
-
-
-**executionId:** `String` — Flow execution identifier - -
-
+Lists the [roles](https://auth0.com/docs/manage-users/access-control/rbac) assigned to a group.
- - -
- -## Flows Vault Connections -
client.flows.vault.connections.list() -> SyncPagingIterable&lt;FlowsVaultConnectionSummary&gt; -
-
#### 🔌 Usage @@ -21046,12 +22026,12 @@ client.flows().executions().delete("flow_id", "execution_id");
```java -client.flows().vault().connections().list( - ListFlowsVaultConnectionsRequestParameters +client.groups().roles().list( + "id", + ListGroupRolesRequestParameters .builder() - .page(1) - .perPage(1) - .includeTotals(true) + .from("from") + .take(1) .build() ); ``` @@ -21068,7 +22048,7 @@ client.flows().vault().connections().list(
-**page:** `Optional` — Page index of the results to return. First page is 0. +**id:** `String` — Unique identifier for the group (service-generated).
@@ -21076,7 +22056,7 @@ client.flows().vault().connections().list(
-**perPage:** `Optional` — Number of results per page. Defaults to 50. +**from:** `Optional` — Optional Id from which to start selection.
@@ -21084,7 +22064,7 @@ client.flows().vault().connections().list(
-**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). +**take:** `Optional` — Number of results per page. Defaults to 50.
@@ -21096,11 +22076,11 @@ client.flows().vault().connections().list(
-
client.flows.vault.connections.create(request) -> CreateFlowsVaultConnectionResponseContent +
client.groups.roles.create(id, request)
-#### 🔌 Usage +#### 📝 Description
@@ -21108,33 +22088,13 @@ client.flows().vault().connections().list(
-```java -client.flows().vault().connections().create( - CreateFlowsVaultConnectionRequestContent.of( - CreateFlowsVaultConnectionActivecampaign.of( - CreateFlowsVaultConnectionActivecampaignApiKey - .builder() - .name("name") - .appId(FlowsVaultConnectionAppIdActivecampaignEnum.ACTIVECAMPAIGN) - .setup( - FlowsVaultConnectioSetupApiKeyWithBaseUrl - .builder() - .type(FlowsVaultConnectioSetupTypeApiKeyEnum.API_KEY) - .apiKey("api_key") - .baseUrl("base_url") - .build() - ) - .build() - ) - ) -); -``` +Assign one or more [roles](https://auth0.com/docs/manage-users/access-control/rbac) to a specified group.
-#### ⚙️ Parameters +#### 🔌 Usage
@@ -21142,23 +22102,23 @@ client.flows().vault().connections().create(
-**request:** `CreateFlowsVaultConnectionRequestContent` - -
-
+```java +client.groups().roles().create( + "id", + CreateGroupRolesRequestParameters + .builder() + .roles( + Arrays.asList("roles") + ) + .build() +); +```
- -
-
- -
client.flows.vault.connections.get(id) -> GetFlowsVaultConnectionResponseContent -
-
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -21166,23 +22126,15 @@ client.flows().vault().connections().create(
-```java -client.flows().vault().connections().get("id"); -``` -
-
+**id:** `String` — Unique identifier for the group (service-generated). +
-#### ⚙️ Parameters - -
-
-
-**id:** `String` — Flows Vault connection ID +**roles:** `List` — Array of role IDs to assign to the group.
@@ -21194,27 +22146,11 @@ client.flows().vault().connections().get("id");
-
client.flows.vault.connections.delete(id) -
-
- -#### 🔌 Usage - -
-
- +
client.groups.roles.delete(id, request)
-```java -client.flows().vault().connections().delete("id"); -``` -
-
-
-
- -#### ⚙️ Parameters +#### 📝 Description
@@ -21222,21 +22158,11 @@ client.flows().vault().connections().delete("id");
-**id:** `String` — Vault connection id - -
-
+Unassign one or more [roles](https://auth0.com/docs/manage-users/access-control/rbac) from a specified group.
- -
-
- -
client.flows.vault.connections.update(id, request) -> UpdateFlowsVaultConnectionResponseContent -
-
#### 🔌 Usage @@ -21247,10 +22173,13 @@ client.flows().vault().connections().delete("id");
```java -client.flows().vault().connections().update( +client.groups().roles().delete( "id", - UpdateFlowsVaultConnectionRequestContent + DeleteGroupRolesRequestContent .builder() + .roles( + Arrays.asList("roles") + ) .build() ); ``` @@ -21267,15 +22196,7 @@ client.flows().vault().connections().update(
-**id:** `String` — Flows Vault connection ID - -
-
- -
-
- -**name:** `Optional` — Flows Vault Connection name. +**id:** `String` — Unique identifier for the group (service-generated).
@@ -21283,7 +22204,7 @@ client.flows().vault().connections().update(
-**setup:** `Optional` +**roles:** `List` — Array of role IDs to remove from the group.
@@ -21295,8 +22216,8 @@ client.flows().vault().connections().update(
-## Groups Members -
client.groups.members.get(id) -> SyncPagingIterable&lt;GroupMember&gt; +## Guardian Enrollments +
client.guardian.enrollments.createTicket(request) -> CreateGuardianEnrollmentTicketResponseContent
@@ -21308,7 +22229,7 @@ client.flows().vault().connections().update(
-List all users that are a member of this group. +Create a [multi-factor authentication (MFA) enrollment ticket](https://auth0.com/docs/secure/multi-factor-authentication/auth0-guardian/create-custom-enrollment-tickets), and optionally send an email with the created ticket to a given user. Enrollment tickets can specify which factor users must enroll with or allow existing MFA users to enroll in additional factors.
@@ -21323,14 +22244,10 @@ List all users that are a member of this group.
```java -client.groups().members().get( - "id", - GetGroupMembersRequestParameters +client.guardian().enrollments().createTicket( + CreateGuardianEnrollmentTicketRequestContent .builder() - .fields("fields") - .includeFields(true) - .from("from") - .take(1) + .userId("user_id") .build() ); ``` @@ -21347,7 +22264,15 @@ client.groups().members().get(
-**id:** `String` — Unique identifier for the group (service-generated). +**userId:** `String` — user_id for the enrollment ticket + +
+
+ +
+
+ +**email:** `Optional` — alternate email to which the enrollment email will be sent. Optional - by default, the email will be sent to the user's default address
@@ -21355,7 +22280,7 @@ client.groups().members().get(
-**fields:** `Optional` — A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields +**sendMail:** `Optional` — Send an email to the user to start the enrollment
@@ -21363,7 +22288,7 @@ client.groups().members().get(
-**includeFields:** `Optional` — Whether specified fields are to be included (true) or excluded (false). +**emailLocale:** `Optional` — Optional. Specify the locale of the enrollment email. Used with send_email.
@@ -21371,7 +22296,7 @@ client.groups().members().get(
-**from:** `Optional` — Optional Id from which to start selection. +**factor:** `Optional`
@@ -21379,7 +22304,7 @@ client.groups().members().get(
-**take:** `Optional` — Number of results per page. Defaults to 50. +**allowMultipleEnrollments:** `Optional` — Optional. Allows a user who has previously enrolled in MFA to enroll with additional factors.
Note: Parameter can only be used with Universal Login; it cannot be used with Classic Login or custom MFA pages.
@@ -21391,8 +22316,7 @@ client.groups().members().get(
-## Groups Roles -
client.groups.roles.list(id) -> SyncPagingIterable&lt;Role&gt; +
client.guardian.enrollments.get(id) -> GetGuardianEnrollmentResponseContent
@@ -21404,7 +22328,7 @@ client.groups().members().get(
-Lists the [roles](https://auth0.com/docs/manage-users/access-control/rbac) assigned to a group. +Retrieve details, such as status and type, for a specific multi-factor authentication enrollment registered to a user account.
@@ -21419,14 +22343,7 @@ Lists the [roles](https://auth0.com/docs/manage-users/access-control/rbac) assig
```java -client.groups().roles().list( - "id", - ListGroupRolesRequestParameters - .builder() - .from("from") - .take(1) - .build() -); +client.guardian().enrollments().get("id"); ```
@@ -21441,23 +22358,7 @@ client.groups().roles().list(
-**id:** `String` — Unique identifier for the group (service-generated). - -
-
- -
-
- -**from:** `Optional` — Optional Id from which to start selection. - -
-
- -
-
- -**take:** `Optional` — Number of results per page. Defaults to 50. +**id:** `String` — ID of the enrollment to be retrieve.
@@ -21469,7 +22370,7 @@ client.groups().roles().list(
-
client.groups.roles.create(id, request) +
client.guardian.enrollments.delete(id)
@@ -21481,7 +22382,7 @@ client.groups().roles().list(
-Assign one or more [roles](https://auth0.com/docs/manage-users/access-control/rbac) to a specified group. +Remove a specific multi-factor authentication (MFA) enrollment from a user's account. This allows the user to re-enroll with MFA. For more information, review [Reset User Multi-Factor Authentication and Recovery Codes](https://auth0.com/docs/secure/multi-factor-authentication/reset-user-mfa).
@@ -21496,15 +22397,7 @@ Assign one or more [roles](https://auth0.com/docs/manage-users/access-control/rb
```java -client.groups().roles().create( - "id", - CreateGroupRolesRequestParameters - .builder() - .roles( - Arrays.asList("roles") - ) - .build() -); +client.guardian().enrollments().delete("id"); ```
@@ -21519,16 +22412,48 @@ client.groups().roles().create(
-**id:** `String` — Unique identifier for the group (service-generated). +**id:** `String` — ID of the enrollment to be deleted.
+ + + + + + +
+## Guardian Factors +
client.guardian.factors.list() -> List&lt;GuardianFactor&gt;
-**roles:** `List` — Array of role IDs to assign to the group. - +#### 📝 Description + +
+
+ +
+
+ +Retrieve details of all multi-factor authentication factors associated with your tenant. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.guardian().factors().list(); +```
@@ -21539,7 +22464,7 @@ client.groups().roles().create(
-
client.groups.roles.delete(id, request) +
client.guardian.factors.set(name, request) -> SetGuardianFactorResponseContent
@@ -21551,7 +22476,7 @@ client.groups().roles().create(
-Unassign one or more [roles](https://auth0.com/docs/manage-users/access-control/rbac) from a specified group. +Update the status (i.e., enabled or disabled) of a specific multi-factor authentication factor.
@@ -21566,13 +22491,11 @@ Unassign one or more [roles](https://auth0.com/docs/manage-users/access-control/
```java -client.groups().roles().delete( - "id", - DeleteGroupRolesRequestContent +client.guardian().factors().set( + GuardianFactorNameEnum.PUSH_NOTIFICATION, + SetGuardianFactorRequestContent .builder() - .roles( - Arrays.asList("roles") - ) + .enabled(true) .build() ); ``` @@ -21589,7 +22512,7 @@ client.groups().roles().delete(
-**id:** `String` — Unique identifier for the group (service-generated). +**name:** `GuardianFactorNameEnum` — Factor name. Can be `sms`, `push-notification`, `email`, `duo` `otp` `webauthn-roaming`, `webauthn-platform`, or `recovery-code`.
@@ -21597,7 +22520,7 @@ client.groups().roles().delete(
-**roles:** `List` — Array of role IDs to remove from the group. +**enabled:** `Boolean` — Whether this factor is enabled (true) or disabled (false).
@@ -21609,8 +22532,8 @@ client.groups().roles().delete(
-## Guardian Enrollments -
client.guardian.enrollments.createTicket(request) -> CreateGuardianEnrollmentTicketResponseContent +## Guardian Policies +
client.guardian.policies.list() -> List&lt;MfaPolicyEnum&gt;
@@ -21622,7 +22545,14 @@ client.groups().roles().delete(
-Create a [multi-factor authentication (MFA) enrollment ticket](https://auth0.com/docs/secure/multi-factor-authentication/auth0-guardian/create-custom-enrollment-tickets), and optionally send an email with the created ticket to a given user. Enrollment tickets can specify which factor users must enroll with or allow existing MFA users to enroll in additional factors. +Retrieve the [multi-factor authentication (MFA) policies](https://auth0.com/docs/secure/multi-factor-authentication/enable-mfa) configured for your tenant. + +The following policies are supported: + +- `all-applications` policy prompts with MFA for all logins. +- `confidence-score` policy prompts with MFA only for low confidence logins. + +**Note**: The `confidence-score` policy is part of the [Adaptive MFA feature](https://auth0.com/docs/secure/multi-factor-authentication/adaptive-mfa). Adaptive MFA requires an add-on for the Enterprise plan; review [Auth0 Pricing](https://auth0.com/pricing) for more details.
@@ -21637,67 +22567,70 @@ Create a [multi-factor authentication (MFA) enrollment ticket](https://auth0.com
```java -client.guardian().enrollments().createTicket( - CreateGuardianEnrollmentTicketRequestContent - .builder() - .userId("user_id") - .build() -); +client.guardian().policies().list(); ```
-#### ⚙️ Parameters + + +
+ +
client.guardian.policies.set(request) -> List&lt;MfaPolicyEnum&gt;
+#### 📝 Description +
-**userId:** `String` — user_id for the enrollment ticket - -
-
-
-**email:** `Optional` — alternate email to which the enrollment email will be sent. Optional - by default, the email will be sent to the user's default address - +Set [multi-factor authentication (MFA) policies](https://auth0.com/docs/secure/multi-factor-authentication/enable-mfa) for your tenant. + +The following policies are supported: + +- `all-applications` policy prompts with MFA for all logins. +- `confidence-score` policy prompts with MFA only for low confidence logins. + +**Note**: The `confidence-score` policy is part of the [Adaptive MFA feature](https://auth0.com/docs/secure/multi-factor-authentication/adaptive-mfa). Adaptive MFA requires an add-on for the Enterprise plan; review [Auth0 Pricing](https://auth0.com/pricing) for more details. +
+
+#### 🔌 Usage +
-**sendMail:** `Optional` — Send an email to the user to start the enrollment - -
-
-
-**emailLocale:** `Optional` — Optional. Specify the locale of the enrollment email. Used with send_email. - +```java +client.guardian().policies().set( + Arrays.asList(MfaPolicyEnum.ALL_APPLICATIONS) +); +``` +
+
+#### ⚙️ Parameters +
-**factor:** `Optional` - -
-
-
-**allowMultipleEnrollments:** `Optional` — Optional. Allows a user who has previously enrolled in MFA to enroll with additional factors.
Note: Parameter can only be used with Universal Login; it cannot be used with Classic Login or custom MFA pages. +**request:** `List`
@@ -21709,7 +22642,8 @@ client.guardian().enrollments().createTicket(
-
client.guardian.enrollments.get(id) -> GetGuardianEnrollmentResponseContent +## Guardian Factors Phone +
client.guardian.factors.phone.getMessageTypes() -> GetGuardianFactorPhoneMessageTypesResponseContent
@@ -21721,7 +22655,7 @@ client.guardian().enrollments().createTicket(
-Retrieve details, such as status and type, for a specific multi-factor authentication enrollment registered to a user account. +Retrieve list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.
@@ -21736,34 +22670,19 @@ Retrieve details, such as status and type, for a specific multi-factor authentic
```java -client.guardian().enrollments().get("id"); +client.guardian().factors().phone().getMessageTypes(); ```
-#### ⚙️ Parameters - -
-
- -
-
- -**id:** `String` — ID of the enrollment to be retrieve. - -
-
-
-
-
-
client.guardian.enrollments.delete(id) +
client.guardian.factors.phone.setMessageTypes(request) -> SetGuardianFactorPhoneMessageTypesResponseContent
@@ -21775,7 +22694,7 @@ client.guardian().enrollments().get("id");
-Remove a specific multi-factor authentication (MFA) enrollment from a user's account. This allows the user to re-enroll with MFA. For more information, review [Reset User Multi-Factor Authentication and Recovery Codes](https://auth0.com/docs/secure/multi-factor-authentication/reset-user-mfa). +Replace the list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.
@@ -21790,7 +22709,14 @@ Remove a specific multi-factor authentication (MFA) enrollment from a user's acc
```java -client.guardian().enrollments().delete("id"); +client.guardian().factors().phone().setMessageTypes( + SetGuardianFactorPhoneMessageTypesRequestContent + .builder() + .messageTypes( + Arrays.asList(GuardianFactorPhoneFactorMessageTypeEnum.SMS) + ) + .build() +); ```
@@ -21805,7 +22731,7 @@ client.guardian().enrollments().delete("id");
-**id:** `String` — ID of the enrollment to be deleted. +**messageTypes:** `List` — The list of phone factors to enable on the tenant. Can include `sms` and `voice`.
@@ -21817,8 +22743,7 @@ client.guardian().enrollments().delete("id");
-## Guardian Factors -
client.guardian.factors.list() -> List&lt;GuardianFactor&gt; +
client.guardian.factors.phone.getTwilioProvider() -> GetGuardianFactorsProviderPhoneTwilioResponseContent
@@ -21830,7 +22755,7 @@ client.guardian().enrollments().delete("id");
-Retrieve details of all multi-factor authentication factors associated with your tenant. +Retrieve configuration details for a Twilio phone provider that has been set up in your tenant. To learn more, review Configure SMS and Voice Notifications for MFA.
@@ -21845,7 +22770,7 @@ Retrieve details of all Configure SMS and Voice Notifications for MFA.
@@ -21884,11 +22809,9 @@ Update the status (i.e., enabled or disabled) of a specific multi-factor authent
```java -client.guardian().factors().set( - GuardianFactorNameEnum.PUSH_NOTIFICATION, - SetGuardianFactorRequestContent +client.guardian().factors().phone().setTwilioProvider( + SetGuardianFactorsProviderPhoneTwilioRequestContent .builder() - .enabled(true) .build() ); ``` @@ -21905,7 +22828,23 @@ client.guardian().factors().set(
-**name:** `GuardianFactorNameEnum` — Factor name. Can be `sms`, `push-notification`, `email`, `duo` `otp` `webauthn-roaming`, `webauthn-platform`, or `recovery-code`. +**from:** `Optional` — From number + +
+
+ +
+
+ +**messagingServiceSid:** `Optional` — Copilot SID + +
+
+ +
+
+ +**authToken:** `Optional` — Twilio Authentication token
@@ -21913,7 +22852,7 @@ client.guardian().factors().set(
-**enabled:** `Boolean` — Whether this factor is enabled (true) or disabled (false). +**sid:** `Optional` — Twilio SID
@@ -21925,8 +22864,7 @@ client.guardian().factors().set(
-## Guardian Policies -
client.guardian.policies.list() -> List&lt;MfaPolicyEnum&gt; +
client.guardian.factors.phone.getSelectedProvider() -> GetGuardianFactorsProviderPhoneResponseContent
@@ -21938,14 +22876,7 @@ client.guardian().factors().set(
-Retrieve the [multi-factor authentication (MFA) policies](https://auth0.com/docs/secure/multi-factor-authentication/enable-mfa) configured for your tenant. - -The following policies are supported: - -- `all-applications` policy prompts with MFA for all logins. -- `confidence-score` policy prompts with MFA only for low confidence logins. - -**Note**: The `confidence-score` policy is part of the [Adaptive MFA feature](https://auth0.com/docs/secure/multi-factor-authentication/adaptive-mfa). Adaptive MFA requires an add-on for the Enterprise plan; review [Auth0 Pricing](https://auth0.com/pricing) for more details. +Retrieve details of the multi-factor authentication phone provider configured for your tenant.
@@ -21960,7 +22891,7 @@ The following policies are supported:
```java -client.guardian().policies().list(); +client.guardian().factors().phone().getSelectedProvider(); ```
@@ -21972,31 +22903,10 @@ client.guardian().policies().list();
-
client.guardian.policies.set(request) -> List&lt;MfaPolicyEnum&gt; -
-
- -#### 📝 Description - -
-
- +
client.guardian.factors.phone.setProvider(request) -> SetGuardianFactorsProviderPhoneResponseContent
-Set [multi-factor authentication (MFA) policies](https://auth0.com/docs/secure/multi-factor-authentication/enable-mfa) for your tenant. - -The following policies are supported: - -- `all-applications` policy prompts with MFA for all logins. -- `confidence-score` policy prompts with MFA only for low confidence logins. - -**Note**: The `confidence-score` policy is part of the [Adaptive MFA feature](https://auth0.com/docs/secure/multi-factor-authentication/adaptive-mfa). Adaptive MFA requires an add-on for the Enterprise plan; review [Auth0 Pricing](https://auth0.com/pricing) for more details. -
-
-
-
- #### 🔌 Usage
@@ -22006,8 +22916,11 @@ The following policies are supported:
```java -client.guardian().policies().set( - Arrays.asList(MfaPolicyEnum.ALL_APPLICATIONS) +client.guardian().factors().phone().setProvider( + SetGuardianFactorsProviderPhoneRequestContent + .builder() + .provider(GuardianFactorsProviderSmsProviderEnum.AUTH0) + .build() ); ```
@@ -22023,7 +22936,7 @@ client.guardian().policies().set(
-**request:** `List` +**provider:** `GuardianFactorsProviderSmsProviderEnum`
@@ -22035,8 +22948,7 @@ client.guardian().policies().set(
-## Guardian Factors Phone -
client.guardian.factors.phone.getMessageTypes() -> GetGuardianFactorPhoneMessageTypesResponseContent +
client.guardian.factors.phone.getTemplates() -> GetGuardianFactorPhoneTemplatesResponseContent
@@ -22048,7 +22960,7 @@ client.guardian().policies().set(
-Retrieve list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant. +Retrieve details of the multi-factor authentication enrollment and verification templates for phone-type factors available in your tenant.
@@ -22063,7 +22975,7 @@ Retrieve list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant. +Customize the messages sent to complete phone enrollment and verification (subscription required).
@@ -22102,12 +23014,11 @@ Replace the list of
-**messageTypes:** `List` — The list of phone factors to enable on the tenant. Can include `sms` and `voice`. +**enrollmentMessage:** `String` — Message sent to the user when they are invited to enroll with a phone number. + +
+ + +
+
+ +**verificationMessage:** `String` — Message sent to the user when they are prompted to verify their account.
@@ -22136,7 +23055,8 @@ client.guardian().factors().phone().setMessageTypes(
-
client.guardian.factors.phone.getTwilioProvider() -> GetGuardianFactorsProviderPhoneTwilioResponseContent +## Guardian Factors PushNotification +
client.guardian.factors.pushNotification.getApnsProvider() -> GetGuardianFactorsProviderApnsResponseContent
@@ -22148,7 +23068,7 @@ client.guardian().factors().phone().setMessageTypes(
-Retrieve configuration details for a Twilio phone provider that has been set up in your tenant. To learn more, review Configure SMS and Voice Notifications for MFA. +Retrieve configuration details for the multi-factor authentication APNS provider associated with your tenant.
@@ -22163,7 +23083,7 @@ Retrieve configuration details for a Twilio phone provider that has been set up
```java -client.guardian().factors().phone().getTwilioProvider(); +client.guardian().factors().pushNotification().getApnsProvider(); ```
@@ -22175,7 +23095,7 @@ client.guardian().factors().phone().getTwilioProvider();
-
client.guardian.factors.phone.setTwilioProvider(request) -> SetGuardianFactorsProviderPhoneTwilioResponseContent +
client.guardian.factors.pushNotification.setApnsProvider(request) -> SetGuardianFactorsProviderPushNotificationApnsResponseContent
@@ -22187,7 +23107,7 @@ client.guardian().factors().phone().getTwilioProvider();
-Update the configuration of a Twilio phone provider that has been set up in your tenant. To learn more, review Configure SMS and Voice Notifications for MFA. +Overwrite all configuration details of the multi-factor authentication APNS provider associated with your tenant.
@@ -22202,8 +23122,8 @@ Update the configuration of a Twilio phone provider that has been set up in your
```java -client.guardian().factors().phone().setTwilioProvider( - SetGuardianFactorsProviderPhoneTwilioRequestContent +client.guardian().factors().pushNotification().setApnsProvider( + SetGuardianFactorsProviderPushNotificationApnsRequestContent .builder() .build() ); @@ -22221,15 +23141,7 @@ client.guardian().factors().phone().setTwilioProvider(
-**from:** `Optional` — From number - -
-
- -
-
- -**messagingServiceSid:** `Optional` — Copilot SID +**sandbox:** `Optional`
@@ -22237,7 +23149,7 @@ client.guardian().factors().phone().setTwilioProvider(
-**authToken:** `Optional` — Twilio Authentication token +**bundleId:** `Optional`
@@ -22245,7 +23157,7 @@ client.guardian().factors().phone().setTwilioProvider(
-**sid:** `Optional` — Twilio SID +**p12:** `Optional`
@@ -22257,7 +23169,7 @@ client.guardian().factors().phone().setTwilioProvider(
-
client.guardian.factors.phone.getSelectedProvider() -> GetGuardianFactorsProviderPhoneResponseContent +
client.guardian.factors.pushNotification.updateApnsProvider(request) -> UpdateGuardianFactorsProviderPushNotificationApnsResponseContent
@@ -22269,7 +23181,7 @@ client.guardian().factors().phone().setTwilioProvider(
-Retrieve details of the multi-factor authentication phone provider configured for your tenant. +Modify configuration details of the multi-factor authentication APNS provider associated with your tenant.
@@ -22284,23 +23196,18 @@ Retrieve details of the multi-factor authentication phone provider configured fo
```java -client.guardian().factors().phone().getSelectedProvider(); +client.guardian().factors().pushNotification().updateApnsProvider( + UpdateGuardianFactorsProviderPushNotificationApnsRequestContent + .builder() + .build() +); ```
- - - -
- -
client.guardian.factors.phone.setProvider(request) -> SetGuardianFactorsProviderPhoneResponseContent -
-
- -#### 🔌 Usage +#### ⚙️ Parameters
@@ -22308,28 +23215,23 @@ client.guardian().factors().phone().getSelectedProvider();
-```java -client.guardian().factors().phone().setProvider( - SetGuardianFactorsProviderPhoneRequestContent - .builder() - .provider(GuardianFactorsProviderSmsProviderEnum.AUTH0) - .build() -); -``` -
-
+**sandbox:** `Optional` +
-#### ⚙️ Parameters -
+**bundleId:** `Optional` + +
+
+
-**provider:** `GuardianFactorsProviderSmsProviderEnum` +**p12:** `Optional`
@@ -22341,7 +23243,7 @@ client.guardian().factors().phone().setProvider(
-
client.guardian.factors.phone.getTemplates() -> GetGuardianFactorPhoneTemplatesResponseContent +
client.guardian.factors.pushNotification.setFcmProvider(request) -> Map&lt;String, Object&gt;
@@ -22353,7 +23255,7 @@ client.guardian().factors().phone().setProvider(
-Retrieve details of the multi-factor authentication enrollment and verification templates for phone-type factors available in your tenant. +Overwrite all configuration details of the multi-factor authentication FCM provider associated with your tenant.
@@ -22368,19 +23270,38 @@ Retrieve details of the multi-factor authentication enrollment and verification
```java -client.guardian().factors().phone().getTemplates(); +client.guardian().factors().pushNotification().setFcmProvider( + SetGuardianFactorsProviderPushNotificationFcmRequestContent + .builder() + .build() +); ```
+#### ⚙️ Parameters + +
+
+ +
+
+ +**serverKey:** `Optional` + +
+
+
+
+
-
client.guardian.factors.phone.setTemplates(request) -> SetGuardianFactorPhoneTemplatesResponseContent +
client.guardian.factors.pushNotification.updateFcmProvider(request) -> Map&lt;String, Object&gt;
@@ -22392,7 +23313,7 @@ client.guardian().factors().phone().getTemplates();
-Customize the messages sent to complete phone enrollment and verification (subscription required). +Modify configuration details of the multi-factor authentication FCM provider associated with your tenant.
@@ -22407,11 +23328,9 @@ Customize the messages sent to complete phone enrollment and verification (subsc
```java -client.guardian().factors().phone().setTemplates( - SetGuardianFactorPhoneTemplatesRequestContent +client.guardian().factors().pushNotification().updateFcmProvider( + UpdateGuardianFactorsProviderPushNotificationFcmRequestContent .builder() - .enrollmentMessage("enrollment_message") - .verificationMessage("verification_message") .build() ); ``` @@ -22428,15 +23347,7 @@ client.guardian().factors().phone().setTemplates(
-**enrollmentMessage:** `String` — Message sent to the user when they are invited to enroll with a phone number. - -
-
- -
-
- -**verificationMessage:** `String` — Message sent to the user when they are prompted to verify their account. +**serverKey:** `Optional`
@@ -22448,8 +23359,7 @@ client.guardian().factors().phone().setTemplates(
-## Guardian Factors PushNotification -
client.guardian.factors.pushNotification.getApnsProvider() -> GetGuardianFactorsProviderApnsResponseContent +
client.guardian.factors.pushNotification.setFcmv1Provider(request) -> Map&lt;String, Object&gt;
@@ -22461,7 +23371,7 @@ client.guardian().factors().phone().setTemplates(
-Retrieve configuration details for the multi-factor authentication APNS provider associated with your tenant. +Overwrite all configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.
@@ -22476,19 +23386,38 @@ Retrieve configuration details for the multi-factor authentication APNS provider
```java -client.guardian().factors().pushNotification().getApnsProvider(); +client.guardian().factors().pushNotification().setFcmv1Provider( + SetGuardianFactorsProviderPushNotificationFcmv1RequestContent + .builder() + .build() +); ```
+#### ⚙️ Parameters + +
+
+ +
+
+ +**serverCredentials:** `Optional` + +
+
+
+
+
-
client.guardian.factors.pushNotification.setApnsProvider(request) -> SetGuardianFactorsProviderPushNotificationApnsResponseContent +
client.guardian.factors.pushNotification.updateFcmv1Provider(request) -> Map&lt;String, Object&gt;
@@ -22500,7 +23429,7 @@ client.guardian().factors().pushNotification().getApnsProvider();
-Overwrite all configuration details of the multi-factor authentication APNS provider associated with your tenant. +Modify configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.
@@ -22515,8 +23444,8 @@ Overwrite all configuration details of the multi-factor authentication APNS prov
```java -client.guardian().factors().pushNotification().setApnsProvider( - SetGuardianFactorsProviderPushNotificationApnsRequestContent +client.guardian().factors().pushNotification().updateFcmv1Provider( + UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent .builder() .build() ); @@ -22534,24 +23463,47 @@ client.guardian().factors().pushNotification().setApnsProvider(
-**sandbox:** `Optional` +**serverCredentials:** `Optional`
+
+
+ + + + +
+
client.guardian.factors.pushNotification.getSnsProvider() -> GetGuardianFactorsProviderSnsResponseContent
-**bundleId:** `Optional` - +#### 📝 Description + +
+
+ +
+
+ +Retrieve configuration details for an AWS SNS push notification provider that has been enabled for MFA. To learn more, review [Configure Push Notifications for MFA](https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-push-notifications-for-mfa). +
+
+#### 🔌 Usage + +
+
+
-**p12:** `Optional` - +```java +client.guardian().factors().pushNotification().getSnsProvider(); +```
@@ -22562,7 +23514,7 @@ client.guardian().factors().pushNotification().setApnsProvider(
-
client.guardian.factors.pushNotification.updateApnsProvider(request) -> UpdateGuardianFactorsProviderPushNotificationApnsResponseContent +
client.guardian.factors.pushNotification.setSnsProvider(request) -> SetGuardianFactorsProviderPushNotificationSnsResponseContent
@@ -22574,7 +23526,7 @@ client.guardian().factors().pushNotification().setApnsProvider(
-Modify configuration details of the multi-factor authentication APNS provider associated with your tenant. +Configure the [AWS SNS push notification provider configuration](https://auth0.com/docs/multifactor-authentication/developer/sns-configuration) (subscription required).
@@ -22589,8 +23541,8 @@ Modify configuration details of the multi-factor authentication APNS provider as
```java -client.guardian().factors().pushNotification().updateApnsProvider( - UpdateGuardianFactorsProviderPushNotificationApnsRequestContent +client.guardian().factors().pushNotification().setSnsProvider( + SetGuardianFactorsProviderPushNotificationSnsRequestContent .builder() .build() ); @@ -22608,7 +23560,7 @@ client.guardian().factors().pushNotification().updateApnsProvider(
-**sandbox:** `Optional` +**awsAccessKeyId:** `Optional`
@@ -22616,7 +23568,7 @@ client.guardian().factors().pushNotification().updateApnsProvider(
-**bundleId:** `Optional` +**awsSecretAccessKey:** `Optional`
@@ -22624,7 +23576,23 @@ client.guardian().factors().pushNotification().updateApnsProvider(
-**p12:** `Optional` +**awsRegion:** `Optional` + +
+
+ +
+
+ +**snsApnsPlatformApplicationArn:** `Optional` + +
+
+ +
+
+ +**snsGcmPlatformApplicationArn:** `Optional`
@@ -22636,7 +23604,7 @@ client.guardian().factors().pushNotification().updateApnsProvider(
-
client.guardian.factors.pushNotification.setFcmProvider(request) -> Map&lt;String, Object&gt; +
client.guardian.factors.pushNotification.updateSnsProvider(request) -> UpdateGuardianFactorsProviderPushNotificationSnsResponseContent
@@ -22648,7 +23616,7 @@ client.guardian().factors().pushNotification().updateApnsProvider(
-Overwrite all configuration details of the multi-factor authentication FCM provider associated with your tenant. +Configure the [AWS SNS push notification provider configuration](https://auth0.com/docs/multifactor-authentication/developer/sns-configuration) (subscription required).
@@ -22663,8 +23631,8 @@ Overwrite all configuration details of the multi-factor authentication FCM provi
```java -client.guardian().factors().pushNotification().setFcmProvider( - SetGuardianFactorsProviderPushNotificationFcmRequestContent +client.guardian().factors().pushNotification().updateSnsProvider( + UpdateGuardianFactorsProviderPushNotificationSnsRequestContent .builder() .build() ); @@ -22682,65 +23650,39 @@ client.guardian().factors().pushNotification().setFcmProvider(
-**serverKey:** `Optional` +**awsAccessKeyId:** `Optional`
-
-
- - - -
- -
client.guardian.factors.pushNotification.updateFcmProvider(request) -> Map&lt;String, Object&gt;
-#### 📝 Description - -
-
+**awsSecretAccessKey:** `Optional` + +
+
-Modify configuration details of the multi-factor authentication FCM provider associated with your tenant. -
-
+**awsRegion:** `Optional` +
-#### 🔌 Usage - -
-
-
-```java -client.guardian().factors().pushNotification().updateFcmProvider( - UpdateGuardianFactorsProviderPushNotificationFcmRequestContent - .builder() - .build() -); -``` -
-
+**snsApnsPlatformApplicationArn:** `Optional` +
-#### ⚙️ Parameters - -
-
-
-**serverKey:** `Optional` +**snsGcmPlatformApplicationArn:** `Optional`
@@ -22752,7 +23694,7 @@ client.guardian().factors().pushNotification().updateFcmProvider(
-
client.guardian.factors.pushNotification.setFcmv1Provider(request) -> Map&lt;String, Object&gt; +
client.guardian.factors.pushNotification.getSelectedProvider() -> GetGuardianFactorsProviderPushNotificationResponseContent
@@ -22764,7 +23706,7 @@ client.guardian().factors().pushNotification().updateFcmProvider(
-Overwrite all configuration details of the multi-factor authentication FCMV1 provider associated with your tenant. +Modify the push notification provider configured for your tenant. For more information, review Configure Push Notifications for MFA.
@@ -22779,38 +23721,19 @@ Overwrite all configuration details of the multi-factor authentication FCMV1 pro
```java -client.guardian().factors().pushNotification().setFcmv1Provider( - SetGuardianFactorsProviderPushNotificationFcmv1RequestContent - .builder() - .build() -); +client.guardian().factors().pushNotification().getSelectedProvider(); ```
-#### ⚙️ Parameters - -
-
- -
-
- -**serverCredentials:** `Optional` - -
-
-
-
-
-
client.guardian.factors.pushNotification.updateFcmv1Provider(request) -> Map&lt;String, Object&gt; +
client.guardian.factors.pushNotification.setProvider(request) -> SetGuardianFactorsProviderPushNotificationResponseContent
@@ -22822,7 +23745,7 @@ client.guardian().factors().pushNotification().setFcmv1Provider(
-Modify configuration details of the multi-factor authentication FCMV1 provider associated with your tenant. +Modify the push notification provider configured for your tenant. For more information, review Configure Push Notifications for MFA.
@@ -22837,9 +23760,10 @@ Modify configuration details of the multi-factor authentication FCMV1 provider a
```java -client.guardian().factors().pushNotification().updateFcmv1Provider( - UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent +client.guardian().factors().pushNotification().setProvider( + SetGuardianFactorsProviderPushNotificationRequestContent .builder() + .provider(GuardianFactorsProviderPushNotificationProviderDataEnum.GUARDIAN) .build() ); ``` @@ -22856,7 +23780,7 @@ client.guardian().factors().pushNotification().updateFcmv1Provider(
-**serverCredentials:** `Optional` +**provider:** `GuardianFactorsProviderPushNotificationProviderDataEnum`
@@ -22868,7 +23792,8 @@ client.guardian().factors().pushNotification().updateFcmv1Provider(
-
client.guardian.factors.pushNotification.getSnsProvider() -> GetGuardianFactorsProviderSnsResponseContent +## Guardian Factors Sms +
client.guardian.factors.sms.getTwilioProvider() -> GetGuardianFactorsProviderSmsTwilioResponseContent
@@ -22880,7 +23805,9 @@ client.guardian().factors().pushNotification().updateFcmv1Provider(
-Retrieve configuration details for an AWS SNS push notification provider that has been enabled for MFA. To learn more, review [Configure Push Notifications for MFA](https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-push-notifications-for-mfa). +Retrieve the Twilio SMS provider configuration (subscription required). + + A new endpoint is available to retrieve the Twilio configuration related to phone factors (phone Twilio configuration). It has the same payload as this one. Please use it instead.
@@ -22895,7 +23822,7 @@ Retrieve configuration details for an AWS SNS push notification provider that ha
```java -client.guardian().factors().pushNotification().getSnsProvider(); +client.guardian().factors().sms().getTwilioProvider(); ```
@@ -22907,7 +23834,7 @@ client.guardian().factors().pushNotification().getSnsProvider();
-
client.guardian.factors.pushNotification.setSnsProvider(request) -> SetGuardianFactorsProviderPushNotificationSnsResponseContent +
client.guardian.factors.sms.setTwilioProvider(request) -> SetGuardianFactorsProviderSmsTwilioResponseContent
@@ -22919,7 +23846,9 @@ client.guardian().factors().pushNotification().getSnsProvider();
-Configure the [AWS SNS push notification provider configuration](https://auth0.com/docs/multifactor-authentication/developer/sns-configuration) (subscription required). +This endpoint has been deprecated. To complete this action, use the Update Twilio phone configuration endpoint. + + Previous functionality: Update the Twilio SMS provider configuration.
@@ -22934,8 +23863,8 @@ Configure the [AWS SNS push notification provider configuration](https://auth0.c
```java -client.guardian().factors().pushNotification().setSnsProvider( - SetGuardianFactorsProviderPushNotificationSnsRequestContent +client.guardian().factors().sms().setTwilioProvider( + SetGuardianFactorsProviderSmsTwilioRequestContent .builder() .build() ); @@ -22953,15 +23882,7 @@ client.guardian().factors().pushNotification().setSnsProvider(
-**awsAccessKeyId:** `Optional` - -
-
- -
-
- -**awsSecretAccessKey:** `Optional` +**from:** `Optional` — From number
@@ -22969,7 +23890,7 @@ client.guardian().factors().pushNotification().setSnsProvider(
-**awsRegion:** `Optional` +**messagingServiceSid:** `Optional` — Copilot SID
@@ -22977,7 +23898,7 @@ client.guardian().factors().pushNotification().setSnsProvider(
-**snsApnsPlatformApplicationArn:** `Optional` +**authToken:** `Optional` — Twilio Authentication token
@@ -22985,7 +23906,7 @@ client.guardian().factors().pushNotification().setSnsProvider(
-**snsGcmPlatformApplicationArn:** `Optional` +**sid:** `Optional` — Twilio SID
@@ -22997,7 +23918,7 @@ client.guardian().factors().pushNotification().setSnsProvider(
-
client.guardian.factors.pushNotification.updateSnsProvider(request) -> UpdateGuardianFactorsProviderPushNotificationSnsResponseContent +
client.guardian.factors.sms.getSelectedProvider() -> GetGuardianFactorsProviderSmsResponseContent
@@ -23009,7 +23930,9 @@ client.guardian().factors().pushNotification().setSnsProvider(
-Configure the [AWS SNS push notification provider configuration](https://auth0.com/docs/multifactor-authentication/developer/sns-configuration) (subscription required). +This endpoint has been deprecated. To complete this action, use the Retrieve phone configuration endpoint instead. + + Previous functionality: Retrieve details for the multi-factor authentication SMS provider configured for your tenant.
@@ -23024,58 +23947,68 @@ Configure the [AWS SNS push notification provider configuration](https://auth0.c
```java -client.guardian().factors().pushNotification().updateSnsProvider( - UpdateGuardianFactorsProviderPushNotificationSnsRequestContent - .builder() - .build() -); +client.guardian().factors().sms().getSelectedProvider(); ```
-#### ⚙️ Parameters + + +
+ +
client.guardian.factors.sms.setProvider(request) -> SetGuardianFactorsProviderSmsResponseContent
+#### 📝 Description +
-**awsAccessKeyId:** `Optional` - -
-
-
-**awsSecretAccessKey:** `Optional` - +This endpoint has been deprecated. To complete this action, use the Update phone configuration endpoint instead. + + Previous functionality: Update the multi-factor authentication SMS provider configuration in your tenant. +
+
+#### 🔌 Usage +
-**awsRegion:** `Optional` - -
-
-
-**snsApnsPlatformApplicationArn:** `Optional` - +```java +client.guardian().factors().sms().setProvider( + SetGuardianFactorsProviderSmsRequestContent + .builder() + .provider(GuardianFactorsProviderSmsProviderEnum.AUTH0) + .build() +); +``` +
+
+#### ⚙️ Parameters +
-**snsGcmPlatformApplicationArn:** `Optional` +
+
+ +**provider:** `GuardianFactorsProviderSmsProviderEnum`
@@ -23087,7 +24020,7 @@ client.guardian().factors().pushNotification().updateSnsProvider(
-
client.guardian.factors.pushNotification.getSelectedProvider() -> GetGuardianFactorsProviderPushNotificationResponseContent +
client.guardian.factors.sms.getTemplates() -> Optional&lt;GetGuardianFactorSmsTemplatesResponseContent&gt;
@@ -23099,7 +24032,9 @@ client.guardian().factors().pushNotification().updateSnsProvider(
-Modify the push notification provider configured for your tenant. For more information, review Configure Push Notifications for MFA. +This endpoint has been deprecated. To complete this action, use the Retrieve enrollment and verification phone templates endpoint instead. + + Previous function: Retrieve details of SMS enrollment and verification templates configured for your tenant.
@@ -23114,7 +24049,7 @@ Modify the push notification provider configured for your tenant. For more infor
```java -client.guardian().factors().pushNotification().getSelectedProvider(); +client.guardian().factors().sms().getTemplates(); ```
@@ -23126,7 +24061,7 @@ client.guardian().factors().pushNotification().getSelectedProvider();
-
client.guardian.factors.pushNotification.setProvider(request) -> SetGuardianFactorsProviderPushNotificationResponseContent +
client.guardian.factors.sms.setTemplates(request) -> SetGuardianFactorSmsTemplatesResponseContent
@@ -23138,7 +24073,9 @@ client.guardian().factors().pushNotification().getSelectedProvider();
-Modify the push notification provider configured for your tenant. For more information, review Configure Push Notifications for MFA. +This endpoint has been deprecated. To complete this action, use the Update enrollment and verification phone templates endpoint instead. + + Previous functionality: Customize the messages sent to complete SMS enrollment and verification.
@@ -23153,10 +24090,11 @@ Modify the push notification provider configured for your tenant. For more infor
```java -client.guardian().factors().pushNotification().setProvider( - SetGuardianFactorsProviderPushNotificationRequestContent +client.guardian().factors().sms().setTemplates( + SetGuardianFactorSmsTemplatesRequestContent .builder() - .provider(GuardianFactorsProviderPushNotificationProviderDataEnum.GUARDIAN) + .enrollmentMessage("enrollment_message") + .verificationMessage("verification_message") .build() ); ``` @@ -23173,7 +24111,15 @@ client.guardian().factors().pushNotification().setProvider(
-**provider:** `GuardianFactorsProviderPushNotificationProviderDataEnum` +**enrollmentMessage:** `String` — Message sent to the user when they are invited to enroll with a phone number. + +
+
+ +
+
+ +**verificationMessage:** `String` — Message sent to the user when they are prompted to verify their account.
@@ -23185,8 +24131,8 @@ client.guardian().factors().pushNotification().setProvider(
-## Guardian Factors Sms -
client.guardian.factors.sms.getTwilioProvider() -> GetGuardianFactorsProviderSmsTwilioResponseContent +## Guardian Factors Duo Settings +
client.guardian.factors.duo.settings.get() -> GetGuardianFactorDuoSettingsResponseContent
@@ -23198,9 +24144,7 @@ client.guardian().factors().pushNotification().setProvider(
-Retrieve the Twilio SMS provider configuration (subscription required). - - A new endpoint is available to retrieve the Twilio configuration related to phone factors (phone Twilio configuration). It has the same payload as this one. Please use it instead. +Retrieves the DUO account and factor configuration.
@@ -23215,7 +24159,7 @@ Retrieve the Update Twilio phone configuration endpoint. - - Previous functionality: Update the Twilio SMS provider configuration. +Set the DUO account configuration and other properties specific to this factor.
@@ -23256,8 +24198,8 @@ This endpoint has been deprecated. To complete this action, use the Retrieve phone configuration endpoint instead. - - Previous functionality: Retrieve details for the multi-factor authentication SMS provider configured for your tenant. +```java +client.guardian().factors().duo().settings().update( + UpdateGuardianFactorDuoSettingsRequestContent + .builder() + .build() +); +``` -#### 🔌 Usage +#### ⚙️ Parameters
@@ -23339,9 +24277,24 @@ This endpoint has been deprecated. To complete this action, use the Update phone configuration endpoint instead. - - Previous functionality: Update the multi-factor authentication SMS provider configuration in your tenant. +Retrieve a hook's secrets by the ID of the hook.
@@ -23381,12 +24333,7 @@ This endpoint has been deprecated. To complete this action, use the @@ -23401,7 +24348,7 @@ client.guardian().factors().sms().setProvider(
-**provider:** `GuardianFactorsProviderSmsProviderEnum` +**id:** `String` — ID of the hook to retrieve secrets from.
@@ -23413,7 +24360,7 @@ client.guardian().factors().sms().setProvider(
-
client.guardian.factors.sms.getTemplates() -> Optional&lt;GetGuardianFactorSmsTemplatesResponseContent&gt; +
client.hooks.secrets.create(id, request)
@@ -23425,9 +24372,7 @@ client.guardian().factors().sms().setProvider(
-This endpoint has been deprecated. To complete this action, use the Retrieve enrollment and verification phone templates endpoint instead. - - Previous function: Retrieve details of SMS enrollment and verification templates configured for your tenant. +Add one or more secrets to an existing hook. Accepts an object of key-value pairs, where the key is the name of the secret. A hook can have a maximum of 20 secrets.
@@ -23442,19 +24387,47 @@ This endpoint has been deprecated. To complete this action, use the () {{ + put("key", "value"); + }} +); ```
+#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The id of the hook to retrieve + +
+
+ +
+
+ +**request:** `Map` + +
+
+
+
+
-
client.guardian.factors.sms.setTemplates(request) -> SetGuardianFactorSmsTemplatesResponseContent +
client.hooks.secrets.delete(id, request)
@@ -23466,9 +24439,7 @@ client.guardian().factors().sms().getTemplates();
-This endpoint has been deprecated. To complete this action, use the Update enrollment and verification phone templates endpoint instead. - - Previous functionality: Customize the messages sent to complete SMS enrollment and verification. +Delete one or more existing secrets for a given hook. Accepts an array of secret names to delete.
@@ -23483,12 +24454,9 @@ This endpoint has been deprecated. To complete this action, use the @@ -23504,7 +24472,7 @@ client.guardian().factors().sms().setTemplates(
-**enrollmentMessage:** `String` — Message sent to the user when they are invited to enroll with a phone number. +**id:** `String` — ID of the hook whose secrets to delete.
@@ -23512,7 +24480,7 @@ client.guardian().factors().sms().setTemplates(
-**verificationMessage:** `String` — Message sent to the user when they are prompted to verify their account. +**request:** `List`
@@ -23524,8 +24492,7 @@ client.guardian().factors().sms().setTemplates(
-## Guardian Factors Duo Settings -
client.guardian.factors.duo.settings.get() -> GetGuardianFactorDuoSettingsResponseContent +
client.hooks.secrets.update(id, request)
@@ -23537,7 +24504,7 @@ client.guardian().factors().sms().setTemplates(
-Retrieves the DUO account and factor configuration. +Update one or more existing secrets for an existing hook. Accepts an object of key-value pairs, where the key is the name of the existing secret.
@@ -23552,23 +24519,19 @@ Retrieves the DUO account and factor configuration.
```java -client.guardian().factors().duo().settings().get(); +client.hooks().secrets().update( + "id", + new HashMap() {{ + put("key", "value"); + }} +); ```
- - - -
- -
client.guardian.factors.duo.settings.set(request) -> SetGuardianFactorDuoSettingsResponseContent -
-
- -#### 📝 Description +#### ⚙️ Parameters
@@ -23576,71 +24539,44 @@ client.guardian().factors().duo().settings().get();
-Set the DUO account configuration and other properties specific to this factor. -
-
+**id:** `String` — ID of the hook whose secrets to update. +
-#### 🔌 Usage - -
-
-
-```java -client.guardian().factors().duo().settings().set( - SetGuardianFactorDuoSettingsRequestContent - .builder() - .build() -); -``` +**request:** `Map` +
-#### ⚙️ Parameters -
-
+
+
+
+## Jobs UsersExports +
client.jobs.usersExports.create(request) -> CreateExportUsersResponseContent
-**ikey:** `Optional` - -
-
+#### 📝 Description
-**skey:** `Optional` - -
-
-
-**host:** `Optional` - -
-
+Export all users to a file via a long-running job. - - -
- -
client.guardian.factors.duo.settings.update(request) -> UpdateGuardianFactorDuoSettingsResponseContent -
-
#### 🔌 Usage @@ -23651,8 +24587,8 @@ client.guardian().factors().duo().settings().set(
```java -client.guardian().factors().duo().settings().update( - UpdateGuardianFactorDuoSettingsRequestContent +client.jobs().usersExports().create( + CreateExportUsersRequestContent .builder() .build() ); @@ -23670,7 +24606,7 @@ client.guardian().factors().duo().settings().update(
-**ikey:** `Optional` +**connectionId:** `Optional` — connection_id of the connection from which users will be exported.
@@ -23678,7 +24614,7 @@ client.guardian().factors().duo().settings().update(
-**skey:** `Optional` +**format:** `Optional`
@@ -23686,7 +24622,15 @@ client.guardian().factors().duo().settings().update(
-**host:** `Optional` +**limit:** `Optional` — Limit the number of records. + +
+
+ +
+
+ +**fields:** `Optional>` — List of fields to be included in the CSV. Defaults to a predefined set of fields.
@@ -23698,8 +24642,8 @@ client.guardian().factors().duo().settings().update(
-## Hooks Secrets -
client.hooks.secrets.get(id) -> Map&lt;String, String&gt; +## Jobs UsersImports +
client.jobs.usersImports.create(request) -> CreateImportUsersResponseContent
@@ -23711,7 +24655,7 @@ client.guardian().factors().duo().settings().update(
-Retrieve a hook's secrets by the ID of the hook. +Import users from a formatted file into a connection via a long-running job. When importing users, with or without upsert, the `email_verified` is set to `false` when the email address is added or updated. Users must verify their email address. To avoid this behavior, set `email_verified` to `true` in the imported data.
@@ -23726,34 +24670,26 @@ Retrieve a hook's secrets by the ID of the hook.
```java -client.hooks().secrets().get("id"); +client.jobs().usersImports().create( + null, + CreateImportUsersRequestContent + .builder() + .connectionId("connection_id") + .build() +); ```
-#### ⚙️ Parameters - -
-
- -
-
- -**id:** `String` — ID of the hook to retrieve secrets from. - -
-
-
-
-
-
client.hooks.secrets.create(id, request) +## Jobs VerificationEmail +
client.jobs.verificationEmail.create(request) -> CreateVerificationEmailResponseContent
@@ -23765,7 +24701,9 @@ client.hooks().secrets().get("id");
-Add one or more secrets to an existing hook. Accepts an object of key-value pairs, where the key is the name of the secret. A hook can have a maximum of 20 secrets. +Send an email to the specified user that asks them to click a link to [verify their email address](https://auth0.com/docs/email/custom#verification-email). + +Note: You must have the `Status` toggle enabled for the verification email template for the email to be sent.
@@ -23780,11 +24718,11 @@ Add one or more secrets to an existing hook. Accepts an object of key-value pair
```java -client.hooks().secrets().create( - "id", - new HashMap() {{ - put("key", "value"); - }} +client.jobs().verificationEmail().create( + CreateVerificationEmailRequestContent + .builder() + .userId("user_id") + .build() ); ```
@@ -23800,7 +24738,7 @@ client.hooks().secrets().create(
-**id:** `String` — The id of the hook to retrieve +**userId:** `String` — user_id of the user to send the verification email to.
@@ -23808,7 +24746,23 @@ client.hooks().secrets().create(
-**request:** `Map` +**clientId:** `Optional` — client_id of the client (application). If no value provided, the global Client ID will be used. + +
+
+ +
+
+ +**identity:** `Optional` + +
+
+ +
+
+ +**organizationId:** `Optional` — (Optional) Organization ID – the ID of the Organization. If provided, organization parameters will be made available to the email template and organization branding will be applied to the prompt. In addition, the redirect link in the prompt will include organization_id and organization_name query string parameters.
@@ -23820,7 +24774,8 @@ client.hooks().secrets().create(
-
client.hooks.secrets.delete(id, request) +## Jobs Errors +
client.jobs.errors.get(id) -> Optional&lt;ErrorsGetResponse&gt;
@@ -23832,7 +24787,7 @@ client.hooks().secrets().create(
-Delete one or more existing secrets for a given hook. Accepts an array of secret names to delete. +Retrieve error details of a failed job.
@@ -23847,10 +24802,7 @@ Delete one or more existing secrets for a given hook. Accepts an array of secret
```java -client.hooks().secrets().delete( - "id", - Arrays.asList("string") -); +client.jobs().errors().get("id"); ```
@@ -23865,15 +24817,7 @@ client.hooks().secrets().delete(
-**id:** `String` — ID of the hook whose secrets to delete. - -
-
- -
-
- -**request:** `List` +**id:** `String` — ID of the job.
@@ -23885,7 +24829,8 @@ client.hooks().secrets().delete(
-
client.hooks.secrets.update(id, request) +## Keys CustomSigning +
client.keys.customSigning.get() -> GetCustomSigningKeysResponseContent
@@ -23897,7 +24842,7 @@ client.hooks().secrets().delete(
-Update one or more existing secrets for an existing hook. Accepts an object of key-value pairs, where the key is the name of the existing secret. +Get entire jwks representation of custom signing keys.
@@ -23912,48 +24857,19 @@ Update one or more existing secrets for an existing hook. Accepts an object of k
```java -client.hooks().secrets().update( - "id", - new HashMap() {{ - put("key", "value"); - }} -); +client.keys().customSigning().get(); ```
-#### ⚙️ Parameters - -
-
- -
-
- -**id:** `String` — ID of the hook whose secrets to update. - -
-
- -
-
- -**request:** `Map` - -
-
-
-
-
-## Jobs UsersExports -
client.jobs.usersExports.create(request) -> CreateExportUsersResponseContent +
client.keys.customSigning.set(request) -> SetCustomSigningKeysResponseContent
@@ -23965,7 +24881,7 @@ client.hooks().secrets().update(
-Export all users to a file via a long-running job. +Create or replace entire jwks representation of custom signing keys.
@@ -23980,9 +24896,17 @@ Export all users to a file via a long-running job.
```java -client.jobs().usersExports().create( - CreateExportUsersRequestContent +client.keys().customSigning().set( + SetCustomSigningKeysRequestContent .builder() + .keys( + Arrays.asList( + CustomSigningKeyJwk + .builder() + .kty(CustomSigningKeyTypeEnum.EC) + .build() + ) + ) .build() ); ``` @@ -23999,31 +24923,7 @@ client.jobs().usersExports().create(
-**connectionId:** `Optional` — connection_id of the connection from which users will be exported. - -
-
- -
-
- -**format:** `Optional` - -
-
- -
-
- -**limit:** `Optional` — Limit the number of records. - -
-
- -
-
- -**fields:** `Optional>` — List of fields to be included in the CSV. Defaults to a predefined set of fields. +**keys:** `List` — An array of custom public signing keys.
@@ -24035,8 +24935,7 @@ client.jobs().usersExports().create(
-## Jobs UsersImports -
client.jobs.usersImports.create(request) -> CreateImportUsersResponseContent +
client.keys.customSigning.delete()
@@ -24048,7 +24947,7 @@ client.jobs().usersExports().create(
-Import users from a formatted file into a connection via a long-running job. When importing users, with or without upsert, the `email_verified` is set to `false` when the email address is added or updated. Users must verify their email address. To avoid this behavior, set `email_verified` to `true` in the imported data. +Delete entire jwks representation of custom signing keys.
@@ -24063,13 +24962,7 @@ Import users from a
@@ -24081,8 +24974,8 @@ client.jobs().usersImports().create(
-## Jobs VerificationEmail -
client.jobs.verificationEmail.create(request) -> CreateVerificationEmailResponseContent +## Keys Encryption +
client.keys.encryption.list() -> SyncPagingIterable&lt;EncryptionKey&gt;
@@ -24094,9 +24987,7 @@ client.jobs().usersImports().create(
-Send an email to the specified user that asks them to click a link to [verify their email address](https://auth0.com/docs/email/custom#verification-email). - -Note: You must have the `Status` toggle enabled for the verification email template for the email to be sent. +Retrieve details of all the encryption keys associated with your tenant.
@@ -24111,10 +25002,12 @@ Note: You must have the `Status` toggle enabled for the verification email templ
```java -client.jobs().verificationEmail().create( - CreateVerificationEmailRequestContent +client.keys().encryption().list( + ListEncryptionKeysRequestParameters .builder() - .userId("user_id") + .page(1) + .perPage(1) + .includeTotals(true) .build() ); ``` @@ -24131,15 +25024,7 @@ client.jobs().verificationEmail().create(
-**userId:** `String` — user_id of the user to send the verification email to. - -
-
- -
-
- -**clientId:** `Optional` — client_id of the client (application). If no value provided, the global Client ID will be used. +**page:** `Optional` — Page index of the results to return. First page is 0.
@@ -24147,7 +25032,7 @@ client.jobs().verificationEmail().create(
-**identity:** `Optional` +**perPage:** `Optional` — Number of results per page. Default value is 50, maximum value is 100.
@@ -24155,7 +25040,7 @@ client.jobs().verificationEmail().create(
-**organizationId:** `Optional` — (Optional) Organization ID – the ID of the Organization. If provided, organization parameters will be made available to the email template and organization branding will be applied to the prompt. In addition, the redirect link in the prompt will include organization_id and organization_name query string parameters. +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
@@ -24167,8 +25052,7 @@ client.jobs().verificationEmail().create(
-## Jobs Errors -
client.jobs.errors.get(id) -> Optional&lt;ErrorsGetResponse&gt; +
client.keys.encryption.create(request) -> CreateEncryptionKeyResponseContent
@@ -24180,7 +25064,7 @@ client.jobs().verificationEmail().create(
-Retrieve error details of a failed job. +Create the new, pre-activated encryption key, without the key material.
@@ -24195,7 +25079,12 @@ Retrieve error details of a failed job.
```java -client.jobs().errors().get("id"); +client.keys().encryption().create( + CreateEncryptionKeyRequestContent + .builder() + .type(CreateEncryptionKeyType.CUSTOMER_PROVIDED_ROOT_KEY) + .build() +); ```
@@ -24210,7 +25099,7 @@ client.jobs().errors().get("id");
-**id:** `String` — ID of the job. +**type:** `CreateEncryptionKeyType`
@@ -24222,8 +25111,7 @@ client.jobs().errors().get("id");
-## Keys CustomSigning -
client.keys.customSigning.get() -> GetCustomSigningKeysResponseContent +
client.keys.encryption.rekey()
@@ -24235,7 +25123,7 @@ client.jobs().errors().get("id");
-Get entire jwks representation of custom signing keys. +Perform rekeying operation on the key hierarchy.
@@ -24250,7 +25138,7 @@ Get entire jwks representation of custom signing keys.
```java -client.keys().customSigning().get(); +client.keys().encryption().rekey(); ```
@@ -24262,7 +25150,7 @@ client.keys().customSigning().get();
-
client.keys.customSigning.set(request) -> SetCustomSigningKeysResponseContent +
client.keys.encryption.get(kid) -> GetEncryptionKeyResponseContent
@@ -24274,7 +25162,7 @@ client.keys().customSigning().get();
-Create or replace entire jwks representation of custom signing keys. +Retrieve details of the encryption key with the given ID.
@@ -24289,19 +25177,7 @@ Create or replace entire jwks representation of custom signing keys.
```java -client.keys().customSigning().set( - SetCustomSigningKeysRequestContent - .builder() - .keys( - Arrays.asList( - CustomSigningKeyJwk - .builder() - .kty(CustomSigningKeyTypeEnum.EC) - .build() - ) - ) - .build() -); +client.keys().encryption().get("kid"); ```
@@ -24316,7 +25192,7 @@ client.keys().customSigning().set(
-**keys:** `List` — An array of custom public signing keys. +**kid:** `String` — Encryption key ID
@@ -24328,7 +25204,7 @@ client.keys().customSigning().set(
-
client.keys.customSigning.delete() +
client.keys.encryption.import_(kid, request) -> ImportEncryptionKeyResponseContent
@@ -24340,23 +25216,52 @@ client.keys().customSigning().set(
-Delete entire jwks representation of custom signing keys. -
-
+Import wrapped key material and activate encryption key. +
+
+ + + +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.keys().encryption().import_( + "kid", + ImportEncryptionKeyRequestContent + .builder() + .wrappedKey("wrapped_key") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**kid:** `String` — Encryption key ID +
-#### 🔌 Usage - -
-
-
-```java -client.keys().customSigning().delete(); -``` +**wrappedKey:** `String` — Base64 encoded ciphertext of key material wrapped by public wrapping key. +
@@ -24367,8 +25272,7 @@ client.keys().customSigning().delete();
-## Keys Encryption -
client.keys.encryption.list() -> SyncPagingIterable&lt;EncryptionKey&gt; +
client.keys.encryption.delete(kid)
@@ -24380,7 +25284,7 @@ client.keys().customSigning().delete();
-Retrieve details of all the encryption keys associated with your tenant. +Delete the custom provided encryption key with the given ID and move back to using native encryption key.
@@ -24395,14 +25299,7 @@ Retrieve details of all the encryption keys associated with your tenant.
```java -client.keys().encryption().list( - ListEncryptionKeysRequestParameters - .builder() - .page(1) - .perPage(1) - .includeTotals(true) - .build() -); +client.keys().encryption().delete("kid"); ```
@@ -24417,23 +25314,7 @@ client.keys().encryption().list(
-**page:** `Optional` — Page index of the results to return. First page is 0. - -
-
- -
-
- -**perPage:** `Optional` — Number of results per page. Default value is 50, maximum value is 100. - -
-
- -
-
- -**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). +**kid:** `String` — Encryption key ID
@@ -24445,7 +25326,7 @@ client.keys().encryption().list(
-
client.keys.encryption.create(request) -> CreateEncryptionKeyResponseContent +
client.keys.encryption.createPublicWrappingKey(kid) -> CreateEncryptionKeyPublicWrappingResponseContent
@@ -24457,7 +25338,7 @@ client.keys().encryption().list(
-Create the new, pre-activated encryption key, without the key material. +Create the public wrapping key to wrap your own encryption key material.
@@ -24472,12 +25353,7 @@ Create the new, pre-activated encryption key, without the key material.
```java -client.keys().encryption().create( - CreateEncryptionKeyRequestContent - .builder() - .type(CreateEncryptionKeyType.CUSTOMER_PROVIDED_ROOT_KEY) - .build() -); +client.keys().encryption().createPublicWrappingKey("kid"); ```
@@ -24492,7 +25368,7 @@ client.keys().encryption().create(
-**type:** `CreateEncryptionKeyType` +**kid:** `String` — Encryption key ID
@@ -24504,7 +25380,8 @@ client.keys().encryption().create(
-
client.keys.encryption.rekey() +## Keys Signing +
client.keys.signing.list() -> List&lt;SigningKeys&gt;
@@ -24516,7 +25393,7 @@ client.keys().encryption().create(
-Perform rekeying operation on the key hierarchy. +Retrieve details of all the application signing keys associated with your tenant.
@@ -24531,7 +25408,7 @@ Perform rekeying operation on the key hierarchy.
```java -client.keys().encryption().rekey(); +client.keys().signing().list(); ```
@@ -24543,7 +25420,7 @@ client.keys().encryption().rekey();
-
client.keys.encryption.get(kid) -> GetEncryptionKeyResponseContent +
client.keys.signing.rotate() -> RotateSigningKeysResponseContent
@@ -24555,7 +25432,7 @@ client.keys().encryption().rekey();
-Retrieve details of the encryption key with the given ID. +Rotate the application signing key of your tenant.
@@ -24570,34 +25447,19 @@ Retrieve details of the encryption key with the given ID.
```java -client.keys().encryption().get("kid"); +client.keys().signing().rotate(); ```
-#### ⚙️ Parameters - -
-
- -
-
- -**kid:** `String` — Encryption key ID - -
-
-
-
-
-
client.keys.encryption.import_(kid, request) -> ImportEncryptionKeyResponseContent +
client.keys.signing.get(kid) -> GetSigningKeysResponseContent
@@ -24609,7 +25471,7 @@ client.keys().encryption().get("kid");
-Import wrapped key material and activate encryption key. +Retrieve details of the application signing key with the given ID.
@@ -24624,13 +25486,7 @@ Import wrapped key material and activate encryption key.
```java -client.keys().encryption().import_( - "kid", - ImportEncryptionKeyRequestContent - .builder() - .wrappedKey("wrapped_key") - .build() -); +client.keys().signing().get("kid"); ```
@@ -24645,15 +25501,7 @@ client.keys().encryption().import_(
-**kid:** `String` — Encryption key ID - -
-
- -
-
- -**wrappedKey:** `String` — Base64 encoded ciphertext of key material wrapped by public wrapping key. +**kid:** `String` — Key id of the key to retrieve
@@ -24665,7 +25513,7 @@ client.keys().encryption().import_(
-
client.keys.encryption.delete(kid) +
client.keys.signing.revoke(kid) -> RevokedSigningKeysResponseContent
@@ -24677,7 +25525,7 @@ client.keys().encryption().import_(
-Delete the custom provided encryption key with the given ID and move back to using native encryption key. +Revoke the application signing key with the given ID.
@@ -24692,7 +25540,7 @@ Delete the custom provided encryption key with the given ID and move back to usi
```java -client.keys().encryption().delete("kid"); +client.keys().signing().revoke("kid"); ```
@@ -24707,7 +25555,7 @@ client.keys().encryption().delete("kid");
-**kid:** `String` — Encryption key ID +**kid:** `String` — Key id of the key to revoke
@@ -24719,11 +25567,12 @@ client.keys().encryption().delete("kid");
-
client.keys.encryption.createPublicWrappingKey(kid) -> CreateEncryptionKeyPublicWrappingResponseContent +## Organizations ClientGrants +
client.organizations.clientGrants.list(id) -> SyncPagingIterable&lt;OrganizationClientGrant&gt;
-#### 📝 Description +#### 🔌 Usage
@@ -24731,13 +25580,28 @@ client.keys().encryption().delete("kid");
-Create the public wrapping key to wrap your own encryption key material. +```java +client.organizations().clientGrants().list( + "id", + ListOrganizationClientGrantsRequestParameters + .builder() + .audience("audience") + .clientId("client_id") + .page(1) + .perPage(1) + .includeTotals(true) + .grantIds( + Arrays.asList("grant_ids") + ) + .build() +); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -24745,23 +25609,55 @@ Create the public wrapping key to wrap your own encryption key material.
-```java -client.keys().encryption().createPublicWrappingKey("kid"); -``` +**id:** `String` — Organization identifier. +
+ +
+
+ +**audience:** `Optional` — Optional filter on audience of the client grant. +
-#### ⚙️ Parameters +
+
+ +**clientId:** `Optional` — Optional filter on client_id of the client grant. + +
+
+**grantIds:** `Optional` — Optional filter on the ID of the client grant. Must be URL encoded and may be specified multiple times (max 10).
e.g. ../client-grants?grant_ids=id1&grant_ids=id2 + +
+
+
-**kid:** `String` — Encryption key ID +**page:** `Optional` — Page index of the results to return. First page is 0. + +
+
+ +
+
+ +**perPage:** `Optional` — Number of results per page. Defaults to 50. + +
+
+ +
+
+ +**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
@@ -24773,12 +25669,11 @@ client.keys().encryption().createPublicWrappingKey("kid");
-## Keys Signing -
client.keys.signing.list() -> List&lt;SigningKeys&gt; +
client.organizations.clientGrants.create(id, request) -> AssociateOrganizationClientGrantResponseContent
-#### 📝 Description +#### 🔌 Usage
@@ -24786,13 +25681,21 @@ client.keys().encryption().createPublicWrappingKey("kid");
-Retrieve details of all the application signing keys associated with your tenant. +```java +client.organizations().clientGrants().create( + "id", + AssociateOrganizationClientGrantRequestContent + .builder() + .grantId("grant_id") + .build() +); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -24800,9 +25703,16 @@ Retrieve details of all the application signing keys associated with your tenant
-```java -client.keys().signing().list(); -``` +**id:** `String` — Organization identifier. + +
+
+ +
+
+ +**grantId:** `String` — A Client Grant ID to add to the organization. +
@@ -24813,11 +25723,11 @@ client.keys().signing().list();
-
client.keys.signing.rotate() -> RotateSigningKeysResponseContent +
client.organizations.clientGrants.delete(id, grantId)
-#### 📝 Description +#### 🔌 Usage
@@ -24825,13 +25735,15 @@ client.keys().signing().list();
-Rotate the application signing key of your tenant. +```java +client.organizations().clientGrants().delete("id", "grant_id"); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -24839,9 +25751,16 @@ Rotate the application signing key of your tenant.
-```java -client.keys().signing().rotate(); -``` +**id:** `String` — Organization identifier. + +
+
+ +
+
+ +**grantId:** `String` — The Client Grant ID to remove from the organization +
@@ -24852,7 +25771,8 @@ client.keys().signing().rotate();
-
client.keys.signing.get(kid) -> GetSigningKeysResponseContent +## Organizations Clients +
client.organizations.clients.list(id) -> SyncPagingIterable&lt;OrganizationClient&gt;
@@ -24864,7 +25784,12 @@ client.keys().signing().rotate();
-Retrieve details of the application signing key with the given ID. +List all clients associated with an organization, using checkpoint pagination. +
    +
  • + Note: The first time you call this endpoint, 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 further results are remaining. +
  • +
@@ -24879,7 +25804,14 @@ Retrieve details of the application signing key with the given ID.
```java -client.keys().signing().get("kid"); +client.organizations().clients().list( + "id", + ListOrganizationClientsRequestParameters + .builder() + .from("from") + .take(1) + .build() +); ```
@@ -24894,7 +25826,23 @@ client.keys().signing().get("kid");
-**kid:** `String` — Key id of the key to retrieve +**id:** `String` — ID of the organization. + +
+
+ +
+
+ +**from:** `Optional` — Optional Id from which to start selection. + +
+
+ +
+
+ +**take:** `Optional` — Number of results per page. Defaults to 50. Values greater than the maximum of 100 are capped at 100.
@@ -24906,7 +25854,7 @@ client.keys().signing().get("kid");
-
client.keys.signing.revoke(kid) -> RevokedSigningKeysResponseContent +
client.organizations.clients.create(id, request) -> List&lt;OrganizationClient&gt;
@@ -24918,7 +25866,7 @@ client.keys().signing().get("kid");
-Revoke the application signing key with the given ID. +Associate one or more clients with an organization.
@@ -24933,7 +25881,21 @@ Revoke the application signing key with the given ID.
```java -client.keys().signing().revoke("kid"); +client.organizations().clients().create( + "id", + CreateOrganizationClientsRequestContent + .builder() + .clients( + Arrays.asList( + CreateOrganizationClientRequestItem + .builder() + .clientId("client_id") + .useForMemberAccess(true) + .build() + ) + ) + .build() +); ```
@@ -24948,7 +25910,15 @@ client.keys().signing().revoke("kid");
-**kid:** `String` — Key id of the key to revoke +**id:** `String` — ID of the organization. + +
+
+ +
+
+ +**clients:** `List` — List of clients to associate with the organization.
@@ -24960,11 +25930,24 @@ client.keys().signing().revoke("kid");
-## Organizations ClientGrants -
client.organizations.clientGrants.list(id) -> SyncPagingIterable&lt;OrganizationClientGrant&gt; +
client.organizations.clients.delete(id, request) +
+
+ +#### 📝 Description + +
+
+
+Remove one or more client associations from an organization. +
+
+
+
+ #### 🔌 Usage
@@ -24974,17 +25957,12 @@ client.keys().signing().revoke("kid");
```java -client.organizations().clientGrants().list( +client.organizations().clients().delete( "id", - ListOrganizationClientGrantsRequestParameters + DeleteOrganizationClientsRequestContent .builder() - .audience("audience") - .clientId("client_id") - .page(1) - .perPage(1) - .includeTotals(true) - .grantIds( - Arrays.asList("grant_ids") + .clients( + Arrays.asList("clients") ) .build() ); @@ -25002,7 +25980,7 @@ client.organizations().clientGrants().list(
-**id:** `String` — Organization identifier. +**id:** `String` — ID of the organization.
@@ -25010,61 +25988,35 @@ client.organizations().clientGrants().list(
-**audience:** `Optional` — Optional filter on audience of the client grant. +**clients:** `List` — List of client IDs to disassociate from the organization.
- -
-
- -**clientId:** `Optional` — Optional filter on client_id of the client grant. -
-
-
-**grantIds:** `Optional` — Optional filter on the ID of the client grant. Must be URL encoded and may be specified multiple times (max 10).
e.g. ../client-grants?grant_ids=id1&grant_ids=id2 -
+
+
client.organizations.clients.get(id, clientId) -> GetOrganizationClientResponseContent
-**page:** `Optional` — Page index of the results to return. First page is 0. - -
-
+#### 📝 Description
-**perPage:** `Optional` — Number of results per page. Defaults to 50. - -
-
-
-**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). - -
-
+Get a specific client association for an organization. - - -
- -
client.organizations.clientGrants.create(id, request) -> AssociateOrganizationClientGrantResponseContent -
-
#### 🔌 Usage @@ -25075,13 +26027,7 @@ client.organizations().clientGrants().list(
```java -client.organizations().clientGrants().create( - "id", - AssociateOrganizationClientGrantRequestContent - .builder() - .grantId("grant_id") - .build() -); +client.organizations().clients().get("id", "client_id"); ```
@@ -25096,7 +26042,7 @@ client.organizations().clientGrants().create(
-**id:** `String` — Organization identifier. +**id:** `String` — ID of the organization.
@@ -25104,7 +26050,7 @@ client.organizations().clientGrants().create(
-**grantId:** `String` — A Client Grant ID to add to the organization. +**clientId:** `String` — ID of the client association to retrieve.
@@ -25116,10 +26062,24 @@ client.organizations().clientGrants().create(
-
client.organizations.clientGrants.delete(id, grantId) +
client.organizations.clients.update(id, clientId, request) -> UpdateOrganizationClientResponseContent +
+
+ +#### 📝 Description + +
+
+
+Update an organization client association. +
+
+
+
+ #### 🔌 Usage
@@ -25129,7 +26089,13 @@ client.organizations().clientGrants().create(
```java -client.organizations().clientGrants().delete("id", "grant_id"); +client.organizations().clients().update( + "id", + "client_id", + UpdateOrganizationClientRequestContent + .builder() + .build() +); ```
@@ -25144,7 +26110,7 @@ client.organizations().clientGrants().delete("id", "grant_id");
-**id:** `String` — Organization identifier. +**id:** `String` — ID of the organization.
@@ -25152,7 +26118,15 @@ client.organizations().clientGrants().delete("id", "grant_id");
-**grantId:** `String` — The Client Grant ID to remove from the organization +**clientId:** `String` — ID of the client association to update. + +
+
+ +
+
+ +**useForMemberAccess:** `Optional` — Whether this client is used for member access to the organization.
@@ -26775,7 +27749,7 @@ List organization members. This endpoint is subject to eventual consistency. New users may not be immediately included in the response and deleted users may not be immediately removed from it. - Use the `fields` parameter to optionally define the specific member details retrieved. If `fields` is left blank, all fields (except roles) are returned. -- Member roles are not sent by default. Use `fields=roles` to retrieve the roles assigned to each listed member. To use this parameter, you must include the `read:organization_member_roles` scope in the token. +- Member roles are not sent by default. Use `fields=roles` to retrieve the roles assigned to each listed member. To use this parameter, you must include the `read:organization_member_roles` scope in the token. Only directly assigned roles are returned. To also include group-based role assignments, use `GET /api/v2/organizations/{id}/members/{user_id}/effective-roles`. This endpoint supports two types of pagination: @@ -26805,6 +27779,7 @@ client.organizations().members().list( "id", ListOrganizationMembersRequestParameters .builder() + .includeTotals(true) .from("from") .take(1) .fields("fields") @@ -26833,6 +27808,14 @@ client.organizations().members().list(
+**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). + +
+
+ +
+
+ **from:** `Optional` — Optional Id from which to start selection.
@@ -27423,6 +28406,8 @@ client.organizations().members().effectiveRoles().list( Retrieve detailed list of roles assigned to a given user within the context of a specific Organization. Users can be members of multiple Organizations with unique roles assigned for each membership. This action only returns the roles associated with the specified Organization; any roles assigned to the user within other Organizations are not included. + +**Note**: Returns only direct role assignments for this member. To also include group-based role assignments, use `GET /api/v2/organizations/{id}/members/{user_id}/effective-roles`.
@@ -27777,6 +28762,11 @@ client.organizations().members().effectiveRoles().sources().groups().list(
List the organization members assigned a specific role within the context of an organization. +
    +
  • + Note: Returns only members with direct role assignments. For groups assigned to this role within the organization, use GET /api/v2/organizations/{organization_id}/roles/{role_id}/groups. +
  • +
@@ -27864,6 +28854,93 @@ client.organizations().roles().members().list( + + +
+ +## Organizations Roles Groups +
client.organizations.roles.groups.list(organizationId, roleId) -> SyncPagingIterable&lt;RoleGroup&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve the list of groups assigned to a role in the context of an organization. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.organizations().roles().groups().list( + "organization_id", + "role_id", + ListOrganizationRoleGroupsRequestParameters + .builder() + .from("from") + .take(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**organizationId:** `String` — ID of the organization. + +
+
+ +
+
+ +**roleId:** `String` — ID of the role. + +
+
+ +
+
+ +**from:** `Optional` — Optional Id from which to start selection. + +
+
+ +
+
+ +**take:** `Optional` — Number of results per page. Defaults to 50. + +
+
+
+
+ +
@@ -29167,6 +30244,8 @@ client.roles().permissions().delete( Retrieve list of users associated with a specific role. For Dashboard instructions, review [View Users Assigned to Roles](https://auth0.com/docs/manage-users/access-control/configure-core-rbac/roles/view-users-assigned-to-roles). +**Note**: Returns only users with direct role assignments. For groups assigned to this role, use `GET /api/v2/roles/{id}/groups`. + This endpoint supports two types of pagination: - Offset pagination @@ -29200,6 +30279,7 @@ client.roles().users().list( "id", ListRoleUsersRequestParameters .builder() + .includeTotals(true) .from("from") .take(1) .build() @@ -29226,6 +30306,14 @@ client.roles().users().list(
+**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). + +
+
+ +
+
+ **from:** `Optional` — Optional Id from which to start selection.
@@ -31126,6 +32214,7 @@ client.users().groups().get( .builder() .fields("fields") .includeFields(true) + .includeTotals(true) .from("from") .take(1) .build() @@ -31168,6 +32257,14 @@ client.users().groups().get(
+**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). + +
+
+ +
+
+ **from:** `Optional` — Optional Id from which to start selection.
@@ -31700,6 +32797,8 @@ client.users().organizations().list(
Retrieve all permissions associated with the user. + +**Note**: Returns only permissions from direct assignments and directly assigned roles. For permissions a user has via group-based role assignments, use `GET /api/v2/users/{id}/effective-permissions`.
@@ -32021,6 +33120,8 @@ client.users().riskAssessments().clear( Retrieve detailed list of all user roles currently assigned to a user. **Note**: This action retrieves all roles assigned to a user in the context of your whole tenant. To retrieve Organization-specific roles, use the following endpoint: [Get user roles assigned to an Organization member](https://auth0.com/docs/api/management/v2/organizations/get-organization-member-roles). + +**Note**: Returns only direct role assignments. To also include group-based role assignments, use `GET /api/v2/users/{id}/effective-roles`.
@@ -32270,6 +33371,7 @@ client.users().refreshToken().list( "user_id", ListRefreshTokensRequestParameters .builder() + .includeTotals(true) .from("from") .take(1) .build() @@ -32296,6 +33398,14 @@ client.users().refreshToken().list(
+**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). + +
+
+ +
+
+ **from:** `Optional` — An optional cursor from which to start the selection (exclusive).
@@ -32402,6 +33512,7 @@ client.users().sessions().list( "user_id", ListUserSessionsRequestParameters .builder() + .includeTotals(true) .from("from") .take(1) .build() @@ -32428,6 +33539,14 @@ client.users().sessions().list(
+**includeTotals:** `Optional` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). + +
+
+ +
+
+ **from:** `Optional` — An optional cursor from which to start the selection (exclusive).
diff --git a/src/main/java/com/auth0/client/mgmt/AgentsClient.java b/src/main/java/com/auth0/client/mgmt/AgentsClient.java new file mode 100644 index 00000000..c65b25b5 --- /dev/null +++ b/src/main/java/com/auth0/client/mgmt/AgentsClient.java @@ -0,0 +1,129 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.auth0.client.mgmt; + +import com.auth0.client.mgmt.core.ClientOptions; +import com.auth0.client.mgmt.core.RequestOptions; +import com.auth0.client.mgmt.core.SyncPagingIterable; +import com.auth0.client.mgmt.types.AgentResponseContent; +import com.auth0.client.mgmt.types.CreateAgentRequestContent; +import com.auth0.client.mgmt.types.ListAgentsRequestParameters; +import com.auth0.client.mgmt.types.PatchAgentRequestParameters; + +public class AgentsClient { + protected final ClientOptions clientOptions; + + private final RawAgentsClient rawClient; + + public AgentsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawAgentsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawAgentsClient withRawResponse() { + return this.rawClient; + } + + /** + * Get agents + */ + public SyncPagingIterable list() { + return this.rawClient.list().body(); + } + + /** + * Get agents + */ + public SyncPagingIterable list(RequestOptions requestOptions) { + return this.rawClient.list(requestOptions).body(); + } + + /** + * Get agents + */ + public SyncPagingIterable list(ListAgentsRequestParameters request) { + return this.rawClient.list(request).body(); + } + + /** + * Get agents + */ + public SyncPagingIterable list( + ListAgentsRequestParameters request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).body(); + } + + /** + * Create an agent + */ + public AgentResponseContent create(CreateAgentRequestContent request) { + return this.rawClient.create(request).body(); + } + + /** + * Create an agent + */ + public AgentResponseContent create(CreateAgentRequestContent request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).body(); + } + + /** + * Get an agent + */ + public AgentResponseContent read(String id) { + return this.rawClient.read(id).body(); + } + + /** + * Get an agent + */ + public AgentResponseContent read(String id, RequestOptions requestOptions) { + return this.rawClient.read(id, requestOptions).body(); + } + + /** + * Delete an agent + */ + public void delete(String id) { + this.rawClient.delete(id).body(); + } + + /** + * Delete an agent + */ + public void delete(String id, RequestOptions requestOptions) { + this.rawClient.delete(id, requestOptions).body(); + } + + /** + * Update an agent + */ + public AgentResponseContent update(String id) { + return this.rawClient.update(id).body(); + } + + /** + * Update an agent + */ + public AgentResponseContent update(String id, RequestOptions requestOptions) { + return this.rawClient.update(id, requestOptions).body(); + } + + /** + * Update an agent + */ + public AgentResponseContent update(String id, PatchAgentRequestParameters request) { + return this.rawClient.update(id, request).body(); + } + + /** + * Update an agent + */ + public AgentResponseContent update(String id, PatchAgentRequestParameters request, RequestOptions requestOptions) { + return this.rawClient.update(id, request, requestOptions).body(); + } +} diff --git a/src/main/java/com/auth0/client/mgmt/AsyncAgentsClient.java b/src/main/java/com/auth0/client/mgmt/AsyncAgentsClient.java new file mode 100644 index 00000000..e6598c36 --- /dev/null +++ b/src/main/java/com/auth0/client/mgmt/AsyncAgentsClient.java @@ -0,0 +1,132 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.auth0.client.mgmt; + +import com.auth0.client.mgmt.core.ClientOptions; +import com.auth0.client.mgmt.core.RequestOptions; +import com.auth0.client.mgmt.core.SyncPagingIterable; +import com.auth0.client.mgmt.types.AgentResponseContent; +import com.auth0.client.mgmt.types.CreateAgentRequestContent; +import com.auth0.client.mgmt.types.ListAgentsRequestParameters; +import com.auth0.client.mgmt.types.PatchAgentRequestParameters; +import java.util.concurrent.CompletableFuture; + +public class AsyncAgentsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawAgentsClient rawClient; + + public AsyncAgentsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawAgentsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawAgentsClient withRawResponse() { + return this.rawClient; + } + + /** + * Get agents + */ + public CompletableFuture> list() { + return this.rawClient.list().thenApply(response -> response.body()); + } + + /** + * Get agents + */ + public CompletableFuture> list(RequestOptions requestOptions) { + return this.rawClient.list(requestOptions).thenApply(response -> response.body()); + } + + /** + * Get agents + */ + public CompletableFuture> list(ListAgentsRequestParameters request) { + return this.rawClient.list(request).thenApply(response -> response.body()); + } + + /** + * Get agents + */ + public CompletableFuture> list( + ListAgentsRequestParameters request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Create an agent + */ + public CompletableFuture create(CreateAgentRequestContent request) { + return this.rawClient.create(request).thenApply(response -> response.body()); + } + + /** + * Create an agent + */ + public CompletableFuture create( + CreateAgentRequestContent request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Get an agent + */ + public CompletableFuture read(String id) { + return this.rawClient.read(id).thenApply(response -> response.body()); + } + + /** + * Get an agent + */ + public CompletableFuture read(String id, RequestOptions requestOptions) { + return this.rawClient.read(id, requestOptions).thenApply(response -> response.body()); + } + + /** + * Delete an agent + */ + public CompletableFuture delete(String id) { + return this.rawClient.delete(id).thenApply(response -> response.body()); + } + + /** + * Delete an agent + */ + public CompletableFuture delete(String id, RequestOptions requestOptions) { + return this.rawClient.delete(id, requestOptions).thenApply(response -> response.body()); + } + + /** + * Update an agent + */ + public CompletableFuture update(String id) { + return this.rawClient.update(id).thenApply(response -> response.body()); + } + + /** + * Update an agent + */ + public CompletableFuture update(String id, RequestOptions requestOptions) { + return this.rawClient.update(id, requestOptions).thenApply(response -> response.body()); + } + + /** + * Update an agent + */ + public CompletableFuture update(String id, PatchAgentRequestParameters request) { + return this.rawClient.update(id, request).thenApply(response -> response.body()); + } + + /** + * Update an agent + */ + public CompletableFuture update( + String id, PatchAgentRequestParameters request, RequestOptions requestOptions) { + return this.rawClient.update(id, request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/auth0/client/mgmt/AsyncManagementApi.java b/src/main/java/com/auth0/client/mgmt/AsyncManagementApi.java index 46b51ca6..4604539c 100644 --- a/src/main/java/com/auth0/client/mgmt/AsyncManagementApi.java +++ b/src/main/java/com/auth0/client/mgmt/AsyncManagementApi.java @@ -20,6 +20,8 @@ public class AsyncManagementApi { protected final Supplier actionsClient; + protected final Supplier agentsClient; + protected final Supplier brandingClient; protected final Supplier clientGrantsClient; @@ -111,6 +113,7 @@ public class AsyncManagementApi { public AsyncManagementApi(ClientOptions clientOptions) { this.clientOptions = clientOptions; this.actionsClient = Suppliers.memoize(() -> new AsyncActionsClient(clientOptions)); + this.agentsClient = Suppliers.memoize(() -> new AsyncAgentsClient(clientOptions)); this.brandingClient = Suppliers.memoize(() -> new AsyncBrandingClient(clientOptions)); this.clientGrantsClient = Suppliers.memoize(() -> new AsyncClientGrantsClient(clientOptions)); this.clientsClient = Suppliers.memoize(() -> new AsyncClientsClient(clientOptions)); @@ -161,6 +164,10 @@ public AsyncActionsClient actions() { return this.actionsClient.get(); } + public AsyncAgentsClient agents() { + return this.agentsClient.get(); + } + public AsyncBrandingClient branding() { return this.brandingClient.get(); } diff --git a/src/main/java/com/auth0/client/mgmt/AsyncOrganizationsClient.java b/src/main/java/com/auth0/client/mgmt/AsyncOrganizationsClient.java index 1fba755a..b36fa923 100644 --- a/src/main/java/com/auth0/client/mgmt/AsyncOrganizationsClient.java +++ b/src/main/java/com/auth0/client/mgmt/AsyncOrganizationsClient.java @@ -8,6 +8,7 @@ import com.auth0.client.mgmt.core.Suppliers; import com.auth0.client.mgmt.core.SyncPagingIterable; import com.auth0.client.mgmt.organizations.AsyncClientGrantsClient; +import com.auth0.client.mgmt.organizations.AsyncClientsClient; import com.auth0.client.mgmt.organizations.AsyncConnectionsClient; import com.auth0.client.mgmt.organizations.AsyncDiscoveryDomainsClient; import com.auth0.client.mgmt.organizations.AsyncEnabledConnectionsClient; @@ -33,6 +34,8 @@ public class AsyncOrganizationsClient { protected final Supplier clientGrantsClient; + protected final Supplier clientsClient; + protected final Supplier connectionsClient; protected final Supplier discoveryDomainsClient; @@ -51,6 +54,7 @@ public AsyncOrganizationsClient(ClientOptions clientOptions) { this.clientOptions = clientOptions; this.rawClient = new AsyncRawOrganizationsClient(clientOptions); this.clientGrantsClient = Suppliers.memoize(() -> new AsyncClientGrantsClient(clientOptions)); + this.clientsClient = Suppliers.memoize(() -> new AsyncClientsClient(clientOptions)); this.connectionsClient = Suppliers.memoize(() -> new AsyncConnectionsClient(clientOptions)); this.discoveryDomainsClient = Suppliers.memoize(() -> new AsyncDiscoveryDomainsClient(clientOptions)); this.enabledConnectionsClient = Suppliers.memoize(() -> new AsyncEnabledConnectionsClient(clientOptions)); @@ -242,6 +246,10 @@ public AsyncClientGrantsClient clientGrants() { return this.clientGrantsClient.get(); } + public AsyncClientsClient clients() { + return this.clientsClient.get(); + } + public AsyncConnectionsClient connections() { return this.connectionsClient.get(); } diff --git a/src/main/java/com/auth0/client/mgmt/AsyncRawAgentsClient.java b/src/main/java/com/auth0/client/mgmt/AsyncRawAgentsClient.java new file mode 100644 index 00000000..b600fc24 --- /dev/null +++ b/src/main/java/com/auth0/client/mgmt/AsyncRawAgentsClient.java @@ -0,0 +1,617 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.auth0.client.mgmt; + +import com.auth0.client.mgmt.core.ClientOptions; +import com.auth0.client.mgmt.core.ManagementApiException; +import com.auth0.client.mgmt.core.ManagementApiHttpResponse; +import com.auth0.client.mgmt.core.ManagementException; +import com.auth0.client.mgmt.core.MediaTypes; +import com.auth0.client.mgmt.core.ObjectMappers; +import com.auth0.client.mgmt.core.QueryStringMapper; +import com.auth0.client.mgmt.core.RequestOptions; +import com.auth0.client.mgmt.core.RetryInterceptor; +import com.auth0.client.mgmt.core.SyncPagingIterable; +import com.auth0.client.mgmt.errors.BadRequestError; +import com.auth0.client.mgmt.errors.ConflictError; +import com.auth0.client.mgmt.errors.ForbiddenError; +import com.auth0.client.mgmt.errors.NotFoundError; +import com.auth0.client.mgmt.errors.TooManyRequestsError; +import com.auth0.client.mgmt.errors.UnauthorizedError; +import com.auth0.client.mgmt.types.AgentResponseContent; +import com.auth0.client.mgmt.types.CreateAgentRequestContent; +import com.auth0.client.mgmt.types.ListAgentsRequestParameters; +import com.auth0.client.mgmt.types.ListAgentsResponseContent; +import com.auth0.client.mgmt.types.PatchAgentRequestParameters; +import com.fasterxml.jackson.core.JsonProcessingException; +import java.io.IOException; +import java.util.List; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawAgentsClient { + protected final ClientOptions clientOptions; + + public AsyncRawAgentsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * Get agents + */ + public CompletableFuture>> list() { + return list(ListAgentsRequestParameters.builder().build()); + } + + /** + * Get agents + */ + public CompletableFuture>> list( + RequestOptions requestOptions) { + return list(ListAgentsRequestParameters.builder().build(), requestOptions); + } + + /** + * Get agents + */ + public CompletableFuture>> list( + ListAgentsRequestParameters request) { + return list(request, null); + } + + /** + * Get agents + */ + public CompletableFuture>> list( + ListAgentsRequestParameters request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("agents"); + if (!request.getFrom().isAbsent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "from", request.getFrom().orElse(null), false); + } + QueryStringMapper.addQueryParameter(httpUrl, "take", request.getTake().orElse(50), 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) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + if (requestOptions != null && requestOptions.getMaxRetries().isPresent()) { + okhttpRequest = okhttpRequest + .newBuilder() + .tag( + RetryInterceptor.MaxRetriesOverride.class, + new RetryInterceptor.MaxRetriesOverride( + requestOptions.getMaxRetries().get())) + .build(); + } + CompletableFuture>> future = + new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + ListAgentsResponseContent parsedResponse = ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, ListAgentsResponseContent.class); + Optional startingAfter = parsedResponse.getNext(); + ListAgentsRequestParameters nextRequest = ListAgentsRequestParameters.builder() + .from(request) + .from(startingAfter) + .build(); + List result = parsedResponse.getAgents(); + future.complete(new ManagementApiHttpResponse<>( + new SyncPagingIterable( + startingAfter.isPresent(), result, parsedResponse, () -> { + try { + return list(nextRequest, requestOptions) + .get() + .body(); + } catch (InterruptedException | ExecutionException e) { + throw new RuntimeException(e); + } + }), + response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 429: + future.completeExceptionally(new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new ManagementApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (JsonProcessingException e) { + future.completeExceptionally( + new ManagementException("Failed to deserialize response: " + e.getMessage(), e)); + } catch (IOException e) { + future.completeExceptionally(new ManagementException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new ManagementException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Create an agent + */ + public CompletableFuture> create( + CreateAgentRequestContent request) { + return create(request, null); + } + + /** + * Create an agent + */ + public CompletableFuture> create( + CreateAgentRequestContent request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("agents"); + if (requestOptions != null) { + requestOptions.getQueryParameters().forEach((_key, _value) -> { + httpUrl.addQueryParameter(_key, _value); + }); + } + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new ManagementException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl.build()) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + if (requestOptions != null && requestOptions.getMaxRetries().isPresent()) { + okhttpRequest = okhttpRequest + .newBuilder() + .tag( + RetryInterceptor.MaxRetriesOverride.class, + new RetryInterceptor.MaxRetriesOverride( + requestOptions.getMaxRetries().get())) + .build(); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new ManagementApiHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, AgentResponseContent.class), + response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 409: + future.completeExceptionally(new ConflictError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 429: + future.completeExceptionally(new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new ManagementApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (JsonProcessingException e) { + future.completeExceptionally( + new ManagementException("Failed to deserialize response: " + e.getMessage(), e)); + } catch (IOException e) { + future.completeExceptionally(new ManagementException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new ManagementException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Get an agent + */ + public CompletableFuture> read(String id) { + return read(id, null); + } + + /** + * Get an agent + */ + public CompletableFuture> read( + String id, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("agents") + .addPathSegment(id); + if (requestOptions != null) { + requestOptions.getQueryParameters().forEach((_key, _value) -> { + httpUrl.addQueryParameter(_key, _value); + }); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + if (requestOptions != null && requestOptions.getMaxRetries().isPresent()) { + okhttpRequest = okhttpRequest + .newBuilder() + .tag( + RetryInterceptor.MaxRetriesOverride.class, + new RetryInterceptor.MaxRetriesOverride( + requestOptions.getMaxRetries().get())) + .build(); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new ManagementApiHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, AgentResponseContent.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 429: + future.completeExceptionally(new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new ManagementApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (JsonProcessingException e) { + future.completeExceptionally( + new ManagementException("Failed to deserialize response: " + e.getMessage(), e)); + } catch (IOException e) { + future.completeExceptionally(new ManagementException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new ManagementException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Delete an agent + */ + public CompletableFuture> delete(String id) { + return delete(id, null); + } + + /** + * Delete an agent + */ + public CompletableFuture> delete(String id, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("agents") + .addPathSegment(id); + if (requestOptions != null) { + requestOptions.getQueryParameters().forEach((_key, _value) -> { + httpUrl.addQueryParameter(_key, _value); + }); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl.build()) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + if (requestOptions != null && requestOptions.getMaxRetries().isPresent()) { + okhttpRequest = okhttpRequest + .newBuilder() + .tag( + RetryInterceptor.MaxRetriesOverride.class, + new RetryInterceptor.MaxRetriesOverride( + requestOptions.getMaxRetries().get())) + .build(); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + if (response.isSuccessful()) { + future.complete(new ManagementApiHttpResponse<>(null, response)); + return; + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 429: + future.completeExceptionally(new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new ManagementApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (JsonProcessingException e) { + future.completeExceptionally( + new ManagementException("Failed to deserialize response: " + e.getMessage(), e)); + } catch (IOException e) { + future.completeExceptionally(new ManagementException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new ManagementException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Update an agent + */ + public CompletableFuture> update(String id) { + return update(id, PatchAgentRequestParameters.builder().build()); + } + + /** + * Update an agent + */ + public CompletableFuture> update( + String id, RequestOptions requestOptions) { + return update(id, PatchAgentRequestParameters.builder().build(), requestOptions); + } + + /** + * Update an agent + */ + public CompletableFuture> update( + String id, PatchAgentRequestParameters request) { + return update(id, request, null); + } + + /** + * Update an agent + */ + public CompletableFuture> update( + String id, PatchAgentRequestParameters request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("agents") + .addPathSegment(id); + if (requestOptions != null) { + requestOptions.getQueryParameters().forEach((_key, _value) -> { + httpUrl.addQueryParameter(_key, _value); + }); + } + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new ManagementException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl.build()) + .method("PATCH", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + if (requestOptions != null && requestOptions.getMaxRetries().isPresent()) { + okhttpRequest = okhttpRequest + .newBuilder() + .tag( + RetryInterceptor.MaxRetriesOverride.class, + new RetryInterceptor.MaxRetriesOverride( + requestOptions.getMaxRetries().get())) + .build(); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new ManagementApiHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, AgentResponseContent.class), + response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 429: + future.completeExceptionally(new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new ManagementApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (JsonProcessingException e) { + future.completeExceptionally( + new ManagementException("Failed to deserialize response: " + e.getMessage(), e)); + } catch (IOException e) { + future.completeExceptionally(new ManagementException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new ManagementException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/auth0/client/mgmt/AsyncRawClientGrantsClient.java b/src/main/java/com/auth0/client/mgmt/AsyncRawClientGrantsClient.java index ce2be7a5..81a82aff 100644 --- a/src/main/java/com/auth0/client/mgmt/AsyncRawClientGrantsClient.java +++ b/src/main/java/com/auth0/client/mgmt/AsyncRawClientGrantsClient.java @@ -83,6 +83,8 @@ public CompletableFuture>> l QueryStringMapper.addQueryParameter( httpUrl, "include_fields", request.getIncludeFields().orElse(null), false); } + QueryStringMapper.addQueryParameter( + httpUrl, "include_totals", request.getIncludeTotals().orElse(true), false); if (!request.getFrom().isAbsent()) { QueryStringMapper.addQueryParameter( httpUrl, "from", request.getFrom().orElse(null), false); diff --git a/src/main/java/com/auth0/client/mgmt/AsyncRawOrganizationsClient.java b/src/main/java/com/auth0/client/mgmt/AsyncRawOrganizationsClient.java index e731a3d4..89745f55 100644 --- a/src/main/java/com/auth0/client/mgmt/AsyncRawOrganizationsClient.java +++ b/src/main/java/com/auth0/client/mgmt/AsyncRawOrganizationsClient.java @@ -136,6 +136,8 @@ public CompletableFuture { httpUrl.addQueryParameter(_key, _value); diff --git a/src/main/java/com/auth0/client/mgmt/AsyncRawRolesClient.java b/src/main/java/com/auth0/client/mgmt/AsyncRawRolesClient.java index aab7c44e..3dcebd15 100644 --- a/src/main/java/com/auth0/client/mgmt/AsyncRawRolesClient.java +++ b/src/main/java/com/auth0/client/mgmt/AsyncRawRolesClient.java @@ -94,6 +94,14 @@ public CompletableFuture>> li QueryStringMapper.addQueryParameter( httpUrl, "name_filter", request.getNameFilter().orElse(null), false); } + if (!request.getType().isAbsent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "type", request.getType().orElse(null), false); + } + if (!request.getOwnerId().isAbsent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "owner_id", request.getOwnerId().orElse(null), false); + } if (requestOptions != null) { requestOptions.getQueryParameters().forEach((_key, _value) -> { httpUrl.addQueryParameter(_key, _value); diff --git a/src/main/java/com/auth0/client/mgmt/ManagementApi.java b/src/main/java/com/auth0/client/mgmt/ManagementApi.java index 7e28f9f7..d17fb3c1 100644 --- a/src/main/java/com/auth0/client/mgmt/ManagementApi.java +++ b/src/main/java/com/auth0/client/mgmt/ManagementApi.java @@ -20,6 +20,8 @@ public class ManagementApi { protected final Supplier actionsClient; + protected final Supplier agentsClient; + protected final Supplier brandingClient; protected final Supplier clientGrantsClient; @@ -111,6 +113,7 @@ public class ManagementApi { public ManagementApi(ClientOptions clientOptions) { this.clientOptions = clientOptions; this.actionsClient = Suppliers.memoize(() -> new ActionsClient(clientOptions)); + this.agentsClient = Suppliers.memoize(() -> new AgentsClient(clientOptions)); this.brandingClient = Suppliers.memoize(() -> new BrandingClient(clientOptions)); this.clientGrantsClient = Suppliers.memoize(() -> new ClientGrantsClient(clientOptions)); this.clientsClient = Suppliers.memoize(() -> new ClientsClient(clientOptions)); @@ -161,6 +164,10 @@ public ActionsClient actions() { return this.actionsClient.get(); } + public AgentsClient agents() { + return this.agentsClient.get(); + } + public BrandingClient branding() { return this.brandingClient.get(); } diff --git a/src/main/java/com/auth0/client/mgmt/OrganizationsClient.java b/src/main/java/com/auth0/client/mgmt/OrganizationsClient.java index 74ed88d6..f50ee76c 100644 --- a/src/main/java/com/auth0/client/mgmt/OrganizationsClient.java +++ b/src/main/java/com/auth0/client/mgmt/OrganizationsClient.java @@ -8,6 +8,7 @@ import com.auth0.client.mgmt.core.Suppliers; import com.auth0.client.mgmt.core.SyncPagingIterable; import com.auth0.client.mgmt.organizations.ClientGrantsClient; +import com.auth0.client.mgmt.organizations.ClientsClient; import com.auth0.client.mgmt.organizations.ConnectionsClient; import com.auth0.client.mgmt.organizations.DiscoveryDomainsClient; import com.auth0.client.mgmt.organizations.EnabledConnectionsClient; @@ -32,6 +33,8 @@ public class OrganizationsClient { protected final Supplier clientGrantsClient; + protected final Supplier clientsClient; + protected final Supplier connectionsClient; protected final Supplier discoveryDomainsClient; @@ -50,6 +53,7 @@ public OrganizationsClient(ClientOptions clientOptions) { this.clientOptions = clientOptions; this.rawClient = new RawOrganizationsClient(clientOptions); this.clientGrantsClient = Suppliers.memoize(() -> new ClientGrantsClient(clientOptions)); + this.clientsClient = Suppliers.memoize(() -> new ClientsClient(clientOptions)); this.connectionsClient = Suppliers.memoize(() -> new ConnectionsClient(clientOptions)); this.discoveryDomainsClient = Suppliers.memoize(() -> new DiscoveryDomainsClient(clientOptions)); this.enabledConnectionsClient = Suppliers.memoize(() -> new EnabledConnectionsClient(clientOptions)); @@ -239,6 +243,10 @@ public ClientGrantsClient clientGrants() { return this.clientGrantsClient.get(); } + public ClientsClient clients() { + return this.clientsClient.get(); + } + public ConnectionsClient connections() { return this.connectionsClient.get(); } diff --git a/src/main/java/com/auth0/client/mgmt/RawAgentsClient.java b/src/main/java/com/auth0/client/mgmt/RawAgentsClient.java new file mode 100644 index 00000000..f6db6d9a --- /dev/null +++ b/src/main/java/com/auth0/client/mgmt/RawAgentsClient.java @@ -0,0 +1,483 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.auth0.client.mgmt; + +import com.auth0.client.mgmt.core.ClientOptions; +import com.auth0.client.mgmt.core.ManagementApiException; +import com.auth0.client.mgmt.core.ManagementApiHttpResponse; +import com.auth0.client.mgmt.core.ManagementException; +import com.auth0.client.mgmt.core.MediaTypes; +import com.auth0.client.mgmt.core.ObjectMappers; +import com.auth0.client.mgmt.core.QueryStringMapper; +import com.auth0.client.mgmt.core.RequestOptions; +import com.auth0.client.mgmt.core.RetryInterceptor; +import com.auth0.client.mgmt.core.SyncPagingIterable; +import com.auth0.client.mgmt.errors.BadRequestError; +import com.auth0.client.mgmt.errors.ConflictError; +import com.auth0.client.mgmt.errors.ForbiddenError; +import com.auth0.client.mgmt.errors.NotFoundError; +import com.auth0.client.mgmt.errors.TooManyRequestsError; +import com.auth0.client.mgmt.errors.UnauthorizedError; +import com.auth0.client.mgmt.types.AgentResponseContent; +import com.auth0.client.mgmt.types.CreateAgentRequestContent; +import com.auth0.client.mgmt.types.ListAgentsRequestParameters; +import com.auth0.client.mgmt.types.ListAgentsResponseContent; +import com.auth0.client.mgmt.types.PatchAgentRequestParameters; +import com.fasterxml.jackson.core.JsonProcessingException; +import java.io.IOException; +import java.util.List; +import java.util.Optional; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawAgentsClient { + protected final ClientOptions clientOptions; + + public RawAgentsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * Get agents + */ + public ManagementApiHttpResponse> list() { + return list(ListAgentsRequestParameters.builder().build()); + } + + /** + * Get agents + */ + public ManagementApiHttpResponse> list(RequestOptions requestOptions) { + return list(ListAgentsRequestParameters.builder().build(), requestOptions); + } + + /** + * Get agents + */ + public ManagementApiHttpResponse> list( + ListAgentsRequestParameters request) { + return list(request, null); + } + + /** + * Get agents + */ + public ManagementApiHttpResponse> list( + ListAgentsRequestParameters request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("agents"); + if (!request.getFrom().isAbsent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "from", request.getFrom().orElse(null), false); + } + QueryStringMapper.addQueryParameter(httpUrl, "take", request.getTake().orElse(50), 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) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + if (requestOptions != null && requestOptions.getMaxRetries().isPresent()) { + okhttpRequest = okhttpRequest + .newBuilder() + .tag( + RetryInterceptor.MaxRetriesOverride.class, + new RetryInterceptor.MaxRetriesOverride( + requestOptions.getMaxRetries().get())) + .build(); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + ListAgentsResponseContent parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ListAgentsResponseContent.class); + Optional startingAfter = parsedResponse.getNext(); + ListAgentsRequestParameters nextRequest = ListAgentsRequestParameters.builder() + .from(request) + .from(startingAfter) + .build(); + List result = parsedResponse.getAgents(); + return new ManagementApiHttpResponse<>( + new SyncPagingIterable( + startingAfter.isPresent(), result, parsedResponse, () -> list( + nextRequest, requestOptions) + .body()), + response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 429: + throw new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new ManagementApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (JsonProcessingException e) { + throw new ManagementException("Failed to deserialize response: " + e.getMessage(), e); + } catch (IOException e) { + throw new ManagementException("Network error executing HTTP request", e); + } + } + + /** + * Create an agent + */ + public ManagementApiHttpResponse create(CreateAgentRequestContent request) { + return create(request, null); + } + + /** + * Create an agent + */ + public ManagementApiHttpResponse create( + CreateAgentRequestContent request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("agents"); + if (requestOptions != null) { + requestOptions.getQueryParameters().forEach((_key, _value) -> { + httpUrl.addQueryParameter(_key, _value); + }); + } + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new ManagementException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl.build()) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + if (requestOptions != null && requestOptions.getMaxRetries().isPresent()) { + okhttpRequest = okhttpRequest + .newBuilder() + .tag( + RetryInterceptor.MaxRetriesOverride.class, + new RetryInterceptor.MaxRetriesOverride( + requestOptions.getMaxRetries().get())) + .build(); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new ManagementApiHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, AgentResponseContent.class), response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 409: + throw new ConflictError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 429: + throw new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new ManagementApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (JsonProcessingException e) { + throw new ManagementException("Failed to deserialize response: " + e.getMessage(), e); + } catch (IOException e) { + throw new ManagementException("Network error executing HTTP request", e); + } + } + + /** + * Get an agent + */ + public ManagementApiHttpResponse read(String id) { + return read(id, null); + } + + /** + * Get an agent + */ + public ManagementApiHttpResponse read(String id, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("agents") + .addPathSegment(id); + if (requestOptions != null) { + requestOptions.getQueryParameters().forEach((_key, _value) -> { + httpUrl.addQueryParameter(_key, _value); + }); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + if (requestOptions != null && requestOptions.getMaxRetries().isPresent()) { + okhttpRequest = okhttpRequest + .newBuilder() + .tag( + RetryInterceptor.MaxRetriesOverride.class, + new RetryInterceptor.MaxRetriesOverride( + requestOptions.getMaxRetries().get())) + .build(); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new ManagementApiHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, AgentResponseContent.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 429: + throw new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new ManagementApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (JsonProcessingException e) { + throw new ManagementException("Failed to deserialize response: " + e.getMessage(), e); + } catch (IOException e) { + throw new ManagementException("Network error executing HTTP request", e); + } + } + + /** + * Delete an agent + */ + public ManagementApiHttpResponse delete(String id) { + return delete(id, null); + } + + /** + * Delete an agent + */ + public ManagementApiHttpResponse delete(String id, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("agents") + .addPathSegment(id); + if (requestOptions != null) { + requestOptions.getQueryParameters().forEach((_key, _value) -> { + httpUrl.addQueryParameter(_key, _value); + }); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl.build()) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + if (requestOptions != null && requestOptions.getMaxRetries().isPresent()) { + okhttpRequest = okhttpRequest + .newBuilder() + .tag( + RetryInterceptor.MaxRetriesOverride.class, + new RetryInterceptor.MaxRetriesOverride( + requestOptions.getMaxRetries().get())) + .build(); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + if (response.isSuccessful()) { + return new ManagementApiHttpResponse<>(null, response); + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 429: + throw new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new ManagementApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (JsonProcessingException e) { + throw new ManagementException("Failed to deserialize response: " + e.getMessage(), e); + } catch (IOException e) { + throw new ManagementException("Network error executing HTTP request", e); + } + } + + /** + * Update an agent + */ + public ManagementApiHttpResponse update(String id) { + return update(id, PatchAgentRequestParameters.builder().build()); + } + + /** + * Update an agent + */ + public ManagementApiHttpResponse update(String id, RequestOptions requestOptions) { + return update(id, PatchAgentRequestParameters.builder().build(), requestOptions); + } + + /** + * Update an agent + */ + public ManagementApiHttpResponse update(String id, PatchAgentRequestParameters request) { + return update(id, request, null); + } + + /** + * Update an agent + */ + public ManagementApiHttpResponse update( + String id, PatchAgentRequestParameters request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("agents") + .addPathSegment(id); + if (requestOptions != null) { + requestOptions.getQueryParameters().forEach((_key, _value) -> { + httpUrl.addQueryParameter(_key, _value); + }); + } + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new ManagementException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl.build()) + .method("PATCH", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + if (requestOptions != null && requestOptions.getMaxRetries().isPresent()) { + okhttpRequest = okhttpRequest + .newBuilder() + .tag( + RetryInterceptor.MaxRetriesOverride.class, + new RetryInterceptor.MaxRetriesOverride( + requestOptions.getMaxRetries().get())) + .build(); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new ManagementApiHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, AgentResponseContent.class), response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 429: + throw new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new ManagementApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (JsonProcessingException e) { + throw new ManagementException("Failed to deserialize response: " + e.getMessage(), e); + } catch (IOException e) { + throw new ManagementException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/auth0/client/mgmt/RawClientGrantsClient.java b/src/main/java/com/auth0/client/mgmt/RawClientGrantsClient.java index e9b648f7..2be177c5 100644 --- a/src/main/java/com/auth0/client/mgmt/RawClientGrantsClient.java +++ b/src/main/java/com/auth0/client/mgmt/RawClientGrantsClient.java @@ -78,6 +78,8 @@ public ManagementApiHttpResponse> HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) .newBuilder() .addPathSegments("client-grants"); + QueryStringMapper.addQueryParameter( + httpUrl, "include_totals", request.getIncludeTotals().orElse(true), false); if (!request.getFrom().isAbsent()) { QueryStringMapper.addQueryParameter( httpUrl, "from", request.getFrom().orElse(null), false); diff --git a/src/main/java/com/auth0/client/mgmt/RawConnectionsClient.java b/src/main/java/com/auth0/client/mgmt/RawConnectionsClient.java index 5919c8e3..62341fdc 100644 --- a/src/main/java/com/auth0/client/mgmt/RawConnectionsClient.java +++ b/src/main/java/com/auth0/client/mgmt/RawConnectionsClient.java @@ -130,6 +130,8 @@ public ManagementApiHttpResponse> list( HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) .newBuilder() .addPathSegments("connections"); + QueryStringMapper.addQueryParameter( + httpUrl, "include_totals", request.getIncludeTotals().orElse(true), false); if (!request.getFrom().isAbsent()) { QueryStringMapper.addQueryParameter( httpUrl, "from", request.getFrom().orElse(null), false); diff --git a/src/main/java/com/auth0/client/mgmt/RawGroupsClient.java b/src/main/java/com/auth0/client/mgmt/RawGroupsClient.java index 9c75aa17..02566f9c 100644 --- a/src/main/java/com/auth0/client/mgmt/RawGroupsClient.java +++ b/src/main/java/com/auth0/client/mgmt/RawGroupsClient.java @@ -92,6 +92,8 @@ public ManagementApiHttpResponse> list( QueryStringMapper.addQueryParameter( httpUrl, "include_fields", request.getIncludeFields().orElse(null), false); } + QueryStringMapper.addQueryParameter( + httpUrl, "include_totals", request.getIncludeTotals().orElse(true), false); if (!request.getFrom().isAbsent()) { QueryStringMapper.addQueryParameter( httpUrl, "from", request.getFrom().orElse(null), false); diff --git a/src/main/java/com/auth0/client/mgmt/RawOrganizationsClient.java b/src/main/java/com/auth0/client/mgmt/RawOrganizationsClient.java index 09bb80b3..d1203604 100644 --- a/src/main/java/com/auth0/client/mgmt/RawOrganizationsClient.java +++ b/src/main/java/com/auth0/client/mgmt/RawOrganizationsClient.java @@ -130,6 +130,8 @@ public ManagementApiHttpResponse> list( HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) .newBuilder() .addPathSegments("organizations"); + QueryStringMapper.addQueryParameter( + httpUrl, "include_totals", request.getIncludeTotals().orElse(true), false); if (!request.getFrom().isAbsent()) { QueryStringMapper.addQueryParameter( httpUrl, "from", request.getFrom().orElse(null), false); @@ -139,6 +141,13 @@ public ManagementApiHttpResponse> list( QueryStringMapper.addQueryParameter( httpUrl, "sort", request.getSort().orElse(null), false); } + if (!request.getIncludeClientAssociationFor().isAbsent()) { + QueryStringMapper.addQueryParameter( + httpUrl, + "include_client_association_for", + request.getIncludeClientAssociationFor().orElse(null), + false); + } if (requestOptions != null) { requestOptions.getQueryParameters().forEach((_key, _value) -> { httpUrl.addQueryParameter(_key, _value); diff --git a/src/main/java/com/auth0/client/mgmt/RawRolesClient.java b/src/main/java/com/auth0/client/mgmt/RawRolesClient.java index c5a37c59..ea7eb9ec 100644 --- a/src/main/java/com/auth0/client/mgmt/RawRolesClient.java +++ b/src/main/java/com/auth0/client/mgmt/RawRolesClient.java @@ -88,6 +88,14 @@ public ManagementApiHttpResponse> list( QueryStringMapper.addQueryParameter( httpUrl, "name_filter", request.getNameFilter().orElse(null), false); } + if (!request.getType().isAbsent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "type", request.getType().orElse(null), false); + } + if (!request.getOwnerId().isAbsent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "owner_id", request.getOwnerId().orElse(null), false); + } if (requestOptions != null) { requestOptions.getQueryParameters().forEach((_key, _value) -> { httpUrl.addQueryParameter(_key, _value); diff --git a/src/main/java/com/auth0/client/mgmt/clientgrants/AsyncRawOrganizationsClient.java b/src/main/java/com/auth0/client/mgmt/clientgrants/AsyncRawOrganizationsClient.java index ae436b51..f838836e 100644 --- a/src/main/java/com/auth0/client/mgmt/clientgrants/AsyncRawOrganizationsClient.java +++ b/src/main/java/com/auth0/client/mgmt/clientgrants/AsyncRawOrganizationsClient.java @@ -65,6 +65,8 @@ public CompletableFuture> list( .addPathSegments("client-grants") .addPathSegment(id) .addPathSegments("organizations"); + QueryStringMapper.addQueryParameter( + httpUrl, "include_totals", request.getIncludeTotals().orElse(true), false); if (!request.getFrom().isAbsent()) { QueryStringMapper.addQueryParameter( httpUrl, "from", request.getFrom().orElse(null), false); diff --git a/src/main/java/com/auth0/client/mgmt/clientgrants/types/ListClientGrantOrganizationsRequestParameters.java b/src/main/java/com/auth0/client/mgmt/clientgrants/types/ListClientGrantOrganizationsRequestParameters.java index be8f7751..9de18ba9 100644 --- a/src/main/java/com/auth0/client/mgmt/clientgrants/types/ListClientGrantOrganizationsRequestParameters.java +++ b/src/main/java/com/auth0/client/mgmt/clientgrants/types/ListClientGrantOrganizationsRequestParameters.java @@ -23,6 +23,8 @@ @JsonInclude(JsonInclude.Include.NON_ABSENT) @JsonDeserialize(builder = ListClientGrantOrganizationsRequestParameters.Builder.class) public final class ListClientGrantOrganizationsRequestParameters { + private final OptionalNullable includeTotals; + private final OptionalNullable from; private final OptionalNullable take; @@ -30,12 +32,28 @@ public final class ListClientGrantOrganizationsRequestParameters { private final Map additionalProperties; private ListClientGrantOrganizationsRequestParameters( - OptionalNullable from, OptionalNullable take, Map additionalProperties) { + OptionalNullable includeTotals, + OptionalNullable from, + OptionalNullable take, + Map additionalProperties) { + this.includeTotals = includeTotals; this.from = from; this.take = take; this.additionalProperties = additionalProperties; } + /** + * @return Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). + */ + @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = NullableNonemptyFilter.class) + @JsonProperty("include_totals") + public OptionalNullable getIncludeTotals() { + if (includeTotals == null) { + return OptionalNullable.absent(); + } + return includeTotals; + } + /** * @return Optional Id from which to start selection. */ @@ -60,6 +78,12 @@ public OptionalNullable getTake() { return take; } + @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = NullableNonemptyFilter.class) + @JsonProperty("include_totals") + private OptionalNullable _getIncludeTotals() { + return includeTotals; + } + @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = NullableNonemptyFilter.class) @JsonProperty("from") private OptionalNullable _getFrom() { @@ -85,12 +109,12 @@ public Map getAdditionalProperties() { } private boolean equalTo(ListClientGrantOrganizationsRequestParameters other) { - return from.equals(other.from) && take.equals(other.take); + return includeTotals.equals(other.includeTotals) && from.equals(other.from) && take.equals(other.take); } @java.lang.Override public int hashCode() { - return Objects.hash(this.from, this.take); + return Objects.hash(this.includeTotals, this.from, this.take); } @java.lang.Override @@ -104,6 +128,8 @@ public static Builder builder() { @JsonIgnoreProperties(ignoreUnknown = true) public static final class Builder { + private OptionalNullable includeTotals = OptionalNullable.absent(); + private OptionalNullable from = OptionalNullable.absent(); private OptionalNullable take = OptionalNullable.absent(); @@ -114,11 +140,46 @@ public static final class Builder { private Builder() {} public Builder from(ListClientGrantOrganizationsRequestParameters other) { + includeTotals(other.getIncludeTotals()); from(other.getFrom()); take(other.getTake()); return this; } + /** + *

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

+ */ + @JsonSetter(value = "include_totals", nulls = Nulls.SKIP) + public Builder includeTotals(@Nullable OptionalNullable includeTotals) { + this.includeTotals = includeTotals; + return this; + } + + public Builder includeTotals(Boolean includeTotals) { + this.includeTotals = OptionalNullable.of(includeTotals); + return this; + } + + public Builder includeTotals(Optional includeTotals) { + if (includeTotals.isPresent()) { + this.includeTotals = OptionalNullable.of(includeTotals.get()); + } else { + this.includeTotals = OptionalNullable.absent(); + } + return this; + } + + public Builder includeTotals(com.auth0.client.mgmt.core.Nullable includeTotals) { + if (includeTotals.isNull()) { + this.includeTotals = OptionalNullable.ofNull(); + } else if (includeTotals.isEmpty()) { + this.includeTotals = OptionalNullable.absent(); + } else { + this.includeTotals = OptionalNullable.of(includeTotals.get()); + } + return this; + } + /** *

Optional Id from which to start selection.

*/ @@ -188,7 +249,7 @@ public Builder take(com.auth0.client.mgmt.core.Nullable take) { } public ListClientGrantOrganizationsRequestParameters build() { - return new ListClientGrantOrganizationsRequestParameters(from, take, additionalProperties); + return new ListClientGrantOrganizationsRequestParameters(includeTotals, from, take, additionalProperties); } public Builder additionalProperty(String key, Object value) { diff --git a/src/main/java/com/auth0/client/mgmt/connections/AsyncDirectoryProvisioningClient.java b/src/main/java/com/auth0/client/mgmt/connections/AsyncDirectoryProvisioningClient.java index 94cf3256..a7526405 100644 --- a/src/main/java/com/auth0/client/mgmt/connections/AsyncDirectoryProvisioningClient.java +++ b/src/main/java/com/auth0/client/mgmt/connections/AsyncDirectoryProvisioningClient.java @@ -4,6 +4,8 @@ package com.auth0.client.mgmt.connections; import com.auth0.client.mgmt.connections.directoryprovisioning.AsyncSynchronizationsClient; +import com.auth0.client.mgmt.connections.types.AddSynchronizedGroupsRequestContent; +import com.auth0.client.mgmt.connections.types.DeleteSynchronizedGroupsRequestContent; import com.auth0.client.mgmt.connections.types.ListDirectoryProvisioningsRequestParameters; import com.auth0.client.mgmt.connections.types.ListSynchronizedGroupsRequestParameters; import com.auth0.client.mgmt.connections.types.ReplaceSynchronizedGroupsRequestContent; @@ -215,6 +217,24 @@ public CompletableFuture> listSynch .thenApply(response -> response.body()); } + /** + * Add synchronized group selections to a directory provisioning configuration. + */ + public CompletableFuture addSynchronizedGroupSelections( + String id, AddSynchronizedGroupsRequestContent request) { + return this.rawClient.addSynchronizedGroupSelections(id, request).thenApply(response -> response.body()); + } + + /** + * Add synchronized group selections to a directory provisioning configuration. + */ + public CompletableFuture addSynchronizedGroupSelections( + String id, AddSynchronizedGroupsRequestContent request, RequestOptions requestOptions) { + return this.rawClient + .addSynchronizedGroupSelections(id, request, requestOptions) + .thenApply(response -> response.body()); + } + /** * Create or replace the selected groups for a connection directory provisioning configuration. */ @@ -230,6 +250,24 @@ public CompletableFuture set( return this.rawClient.set(id, request, requestOptions).thenApply(response -> response.body()); } + /** + * Delete synchronized group selections for a directory provisioning configuration + */ + public CompletableFuture deleteSynchronizedGroupSelections( + String id, DeleteSynchronizedGroupsRequestContent request) { + return this.rawClient.deleteSynchronizedGroupSelections(id, request).thenApply(response -> response.body()); + } + + /** + * Delete synchronized group selections for a directory provisioning configuration + */ + public CompletableFuture deleteSynchronizedGroupSelections( + String id, DeleteSynchronizedGroupsRequestContent request, RequestOptions requestOptions) { + return this.rawClient + .deleteSynchronizedGroupSelections(id, request, requestOptions) + .thenApply(response -> response.body()); + } + public AsyncSynchronizationsClient synchronizations() { return this.synchronizationsClient.get(); } diff --git a/src/main/java/com/auth0/client/mgmt/connections/AsyncRawDirectoryProvisioningClient.java b/src/main/java/com/auth0/client/mgmt/connections/AsyncRawDirectoryProvisioningClient.java index 5d947ecb..e12a95bf 100644 --- a/src/main/java/com/auth0/client/mgmt/connections/AsyncRawDirectoryProvisioningClient.java +++ b/src/main/java/com/auth0/client/mgmt/connections/AsyncRawDirectoryProvisioningClient.java @@ -3,6 +3,8 @@ */ package com.auth0.client.mgmt.connections; +import com.auth0.client.mgmt.connections.types.AddSynchronizedGroupsRequestContent; +import com.auth0.client.mgmt.connections.types.DeleteSynchronizedGroupsRequestContent; import com.auth0.client.mgmt.connections.types.ListDirectoryProvisioningsRequestParameters; import com.auth0.client.mgmt.connections.types.ListSynchronizedGroupsRequestParameters; import com.auth0.client.mgmt.connections.types.ReplaceSynchronizedGroupsRequestContent; @@ -828,6 +830,9 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) { httpUrl, "from", request.getFrom().orElse(null), false); } QueryStringMapper.addQueryParameter(httpUrl, "take", request.getTake().orElse(50), false); + if (!request.getQ().isAbsent()) { + QueryStringMapper.addQueryParameter(httpUrl, "q", request.getQ().orElse(null), false); + } if (requestOptions != null) { requestOptions.getQueryParameters().forEach((_key, _value) -> { httpUrl.addQueryParameter(_key, _value); @@ -934,6 +939,118 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) { return future; } + /** + * Add synchronized group selections to a directory provisioning configuration. + */ + public CompletableFuture> addSynchronizedGroupSelections( + String id, AddSynchronizedGroupsRequestContent request) { + return addSynchronizedGroupSelections(id, request, null); + } + + /** + * Add synchronized group selections to a directory provisioning configuration. + */ + public CompletableFuture> addSynchronizedGroupSelections( + String id, AddSynchronizedGroupsRequestContent request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("connections") + .addPathSegment(id) + .addPathSegments("directory-provisioning") + .addPathSegments("synchronized-groups"); + if (requestOptions != null) { + requestOptions.getQueryParameters().forEach((_key, _value) -> { + httpUrl.addQueryParameter(_key, _value); + }); + } + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new ManagementException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl.build()) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + if (requestOptions != null && requestOptions.getMaxRetries().isPresent()) { + okhttpRequest = okhttpRequest + .newBuilder() + .tag( + RetryInterceptor.MaxRetriesOverride.class, + new RetryInterceptor.MaxRetriesOverride( + requestOptions.getMaxRetries().get())) + .build(); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + if (response.isSuccessful()) { + future.complete(new ManagementApiHttpResponse<>(null, response)); + return; + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 429: + future.completeExceptionally(new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new ManagementApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (JsonProcessingException e) { + future.completeExceptionally( + new ManagementException("Failed to deserialize response: " + e.getMessage(), e)); + } catch (IOException e) { + future.completeExceptionally(new ManagementException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new ManagementException("Network error executing HTTP request", e)); + } + }); + return future; + } + /** * Create or replace the selected groups for a connection directory provisioning configuration. */ @@ -1050,4 +1167,116 @@ public void onFailure(@NotNull Call call, @NotNull IOException e) { }); return future; } + + /** + * Delete synchronized group selections for a directory provisioning configuration + */ + public CompletableFuture> deleteSynchronizedGroupSelections( + String id, DeleteSynchronizedGroupsRequestContent request) { + return deleteSynchronizedGroupSelections(id, request, null); + } + + /** + * Delete synchronized group selections for a directory provisioning configuration + */ + public CompletableFuture> deleteSynchronizedGroupSelections( + String id, DeleteSynchronizedGroupsRequestContent request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("connections") + .addPathSegment(id) + .addPathSegments("directory-provisioning") + .addPathSegments("synchronized-groups"); + if (requestOptions != null) { + requestOptions.getQueryParameters().forEach((_key, _value) -> { + httpUrl.addQueryParameter(_key, _value); + }); + } + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new ManagementException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl.build()) + .method("DELETE", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + if (requestOptions != null && requestOptions.getMaxRetries().isPresent()) { + okhttpRequest = okhttpRequest + .newBuilder() + .tag( + RetryInterceptor.MaxRetriesOverride.class, + new RetryInterceptor.MaxRetriesOverride( + requestOptions.getMaxRetries().get())) + .build(); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + if (response.isSuccessful()) { + future.complete(new ManagementApiHttpResponse<>(null, response)); + return; + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 429: + future.completeExceptionally(new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new ManagementApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (JsonProcessingException e) { + future.completeExceptionally( + new ManagementException("Failed to deserialize response: " + e.getMessage(), e)); + } catch (IOException e) { + future.completeExceptionally(new ManagementException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new ManagementException("Network error executing HTTP request", e)); + } + }); + return future; + } } diff --git a/src/main/java/com/auth0/client/mgmt/connections/DirectoryProvisioningClient.java b/src/main/java/com/auth0/client/mgmt/connections/DirectoryProvisioningClient.java index 53333a62..f28bcc9d 100644 --- a/src/main/java/com/auth0/client/mgmt/connections/DirectoryProvisioningClient.java +++ b/src/main/java/com/auth0/client/mgmt/connections/DirectoryProvisioningClient.java @@ -4,6 +4,8 @@ package com.auth0.client.mgmt.connections; import com.auth0.client.mgmt.connections.directoryprovisioning.SynchronizationsClient; +import com.auth0.client.mgmt.connections.types.AddSynchronizedGroupsRequestContent; +import com.auth0.client.mgmt.connections.types.DeleteSynchronizedGroupsRequestContent; import com.auth0.client.mgmt.connections.types.ListDirectoryProvisioningsRequestParameters; import com.auth0.client.mgmt.connections.types.ListSynchronizedGroupsRequestParameters; import com.auth0.client.mgmt.connections.types.ReplaceSynchronizedGroupsRequestContent; @@ -211,6 +213,23 @@ public SyncPagingIterable listSynchronizedGroups( .body(); } + /** + * Add synchronized group selections to a directory provisioning configuration. + */ + public void addSynchronizedGroupSelections(String id, AddSynchronizedGroupsRequestContent request) { + this.rawClient.addSynchronizedGroupSelections(id, request).body(); + } + + /** + * Add synchronized group selections to a directory provisioning configuration. + */ + public void addSynchronizedGroupSelections( + String id, AddSynchronizedGroupsRequestContent request, RequestOptions requestOptions) { + this.rawClient + .addSynchronizedGroupSelections(id, request, requestOptions) + .body(); + } + /** * Create or replace the selected groups for a connection directory provisioning configuration. */ @@ -225,6 +244,23 @@ public void set(String id, ReplaceSynchronizedGroupsRequestContent request, Requ this.rawClient.set(id, request, requestOptions).body(); } + /** + * Delete synchronized group selections for a directory provisioning configuration + */ + public void deleteSynchronizedGroupSelections(String id, DeleteSynchronizedGroupsRequestContent request) { + this.rawClient.deleteSynchronizedGroupSelections(id, request).body(); + } + + /** + * Delete synchronized group selections for a directory provisioning configuration + */ + public void deleteSynchronizedGroupSelections( + String id, DeleteSynchronizedGroupsRequestContent request, RequestOptions requestOptions) { + this.rawClient + .deleteSynchronizedGroupSelections(id, request, requestOptions) + .body(); + } + public SynchronizationsClient synchronizations() { return this.synchronizationsClient.get(); } diff --git a/src/main/java/com/auth0/client/mgmt/connections/RawDirectoryProvisioningClient.java b/src/main/java/com/auth0/client/mgmt/connections/RawDirectoryProvisioningClient.java index 4c30b1a0..4350c901 100644 --- a/src/main/java/com/auth0/client/mgmt/connections/RawDirectoryProvisioningClient.java +++ b/src/main/java/com/auth0/client/mgmt/connections/RawDirectoryProvisioningClient.java @@ -3,6 +3,8 @@ */ package com.auth0.client.mgmt.connections; +import com.auth0.client.mgmt.connections.types.AddSynchronizedGroupsRequestContent; +import com.auth0.client.mgmt.connections.types.DeleteSynchronizedGroupsRequestContent; import com.auth0.client.mgmt.connections.types.ListDirectoryProvisioningsRequestParameters; import com.auth0.client.mgmt.connections.types.ListSynchronizedGroupsRequestParameters; import com.auth0.client.mgmt.connections.types.ReplaceSynchronizedGroupsRequestContent; @@ -664,6 +666,9 @@ public ManagementApiHttpResponse> l httpUrl, "from", request.getFrom().orElse(null), false); } QueryStringMapper.addQueryParameter(httpUrl, "take", request.getTake().orElse(50), false); + if (!request.getQ().isAbsent()) { + QueryStringMapper.addQueryParameter(httpUrl, "q", request.getQ().orElse(null), false); + } if (requestOptions != null) { requestOptions.getQueryParameters().forEach((_key, _value) -> { httpUrl.addQueryParameter(_key, _value); @@ -738,6 +743,94 @@ public ManagementApiHttpResponse> l } } + /** + * Add synchronized group selections to a directory provisioning configuration. + */ + public ManagementApiHttpResponse addSynchronizedGroupSelections( + String id, AddSynchronizedGroupsRequestContent request) { + return addSynchronizedGroupSelections(id, request, null); + } + + /** + * Add synchronized group selections to a directory provisioning configuration. + */ + public ManagementApiHttpResponse addSynchronizedGroupSelections( + String id, AddSynchronizedGroupsRequestContent request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("connections") + .addPathSegment(id) + .addPathSegments("directory-provisioning") + .addPathSegments("synchronized-groups"); + if (requestOptions != null) { + requestOptions.getQueryParameters().forEach((_key, _value) -> { + httpUrl.addQueryParameter(_key, _value); + }); + } + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new ManagementException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl.build()) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + if (requestOptions != null && requestOptions.getMaxRetries().isPresent()) { + okhttpRequest = okhttpRequest + .newBuilder() + .tag( + RetryInterceptor.MaxRetriesOverride.class, + new RetryInterceptor.MaxRetriesOverride( + requestOptions.getMaxRetries().get())) + .build(); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + if (response.isSuccessful()) { + return new ManagementApiHttpResponse<>(null, response); + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 429: + throw new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new ManagementApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (JsonProcessingException e) { + throw new ManagementException("Failed to deserialize response: " + e.getMessage(), e); + } catch (IOException e) { + throw new ManagementException("Network error executing HTTP request", e); + } + } + /** * Create or replace the selected groups for a connection directory provisioning configuration. */ @@ -827,4 +920,92 @@ public ManagementApiHttpResponse set( throw new ManagementException("Network error executing HTTP request", e); } } + + /** + * Delete synchronized group selections for a directory provisioning configuration + */ + public ManagementApiHttpResponse deleteSynchronizedGroupSelections( + String id, DeleteSynchronizedGroupsRequestContent request) { + return deleteSynchronizedGroupSelections(id, request, null); + } + + /** + * Delete synchronized group selections for a directory provisioning configuration + */ + public ManagementApiHttpResponse deleteSynchronizedGroupSelections( + String id, DeleteSynchronizedGroupsRequestContent request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("connections") + .addPathSegment(id) + .addPathSegments("directory-provisioning") + .addPathSegments("synchronized-groups"); + if (requestOptions != null) { + requestOptions.getQueryParameters().forEach((_key, _value) -> { + httpUrl.addQueryParameter(_key, _value); + }); + } + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new ManagementException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl.build()) + .method("DELETE", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + if (requestOptions != null && requestOptions.getMaxRetries().isPresent()) { + okhttpRequest = okhttpRequest + .newBuilder() + .tag( + RetryInterceptor.MaxRetriesOverride.class, + new RetryInterceptor.MaxRetriesOverride( + requestOptions.getMaxRetries().get())) + .build(); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + if (response.isSuccessful()) { + return new ManagementApiHttpResponse<>(null, response); + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 429: + throw new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new ManagementApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (JsonProcessingException e) { + throw new ManagementException("Failed to deserialize response: " + e.getMessage(), e); + } catch (IOException e) { + throw new ManagementException("Network error executing HTTP request", e); + } + } } diff --git a/src/main/java/com/auth0/client/mgmt/connections/types/AddSynchronizedGroupsRequestContent.java b/src/main/java/com/auth0/client/mgmt/connections/types/AddSynchronizedGroupsRequestContent.java new file mode 100644 index 00000000..14325a61 --- /dev/null +++ b/src/main/java/com/auth0/client/mgmt/connections/types/AddSynchronizedGroupsRequestContent.java @@ -0,0 +1,125 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.auth0.client.mgmt.connections.types; + +import com.auth0.client.mgmt.core.ObjectMappers; +import com.auth0.client.mgmt.types.SynchronizedGroupPayload; +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = AddSynchronizedGroupsRequestContent.Builder.class) +public final class AddSynchronizedGroupsRequestContent { + private final List groups; + + private final Map additionalProperties; + + private AddSynchronizedGroupsRequestContent( + List groups, Map additionalProperties) { + this.groups = groups; + this.additionalProperties = additionalProperties; + } + + /** + * @return Array of Google Workspace Directory group objects to synchronize. + */ + @JsonProperty("groups") + public List getGroups() { + return groups; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof AddSynchronizedGroupsRequestContent + && equalTo((AddSynchronizedGroupsRequestContent) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(AddSynchronizedGroupsRequestContent other) { + return groups.equals(other.groups); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.groups); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private List groups = new ArrayList<>(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(AddSynchronizedGroupsRequestContent other) { + groups(other.getGroups()); + return this; + } + + /** + *

Array of Google Workspace Directory group objects to synchronize.

+ */ + @JsonSetter(value = "groups", nulls = Nulls.SKIP) + public Builder groups(List groups) { + this.groups.clear(); + if (groups != null) { + this.groups.addAll(groups); + } + return this; + } + + public Builder addGroups(SynchronizedGroupPayload groups) { + this.groups.add(groups); + return this; + } + + public Builder addAllGroups(List groups) { + if (groups != null) { + this.groups.addAll(groups); + } + return this; + } + + public AddSynchronizedGroupsRequestContent build() { + return new AddSynchronizedGroupsRequestContent(groups, additionalProperties); + } + + public Builder additionalProperty(String key, Object value) { + this.additionalProperties.put(key, value); + return this; + } + + public Builder additionalProperties(Map additionalProperties) { + this.additionalProperties.putAll(additionalProperties); + return this; + } + } +} diff --git a/src/main/java/com/auth0/client/mgmt/connections/types/DeleteSynchronizedGroupsRequestContent.java b/src/main/java/com/auth0/client/mgmt/connections/types/DeleteSynchronizedGroupsRequestContent.java new file mode 100644 index 00000000..5d5a7e1c --- /dev/null +++ b/src/main/java/com/auth0/client/mgmt/connections/types/DeleteSynchronizedGroupsRequestContent.java @@ -0,0 +1,125 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.auth0.client.mgmt.connections.types; + +import com.auth0.client.mgmt.core.ObjectMappers; +import com.auth0.client.mgmt.types.SynchronizedGroupSelectionId; +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DeleteSynchronizedGroupsRequestContent.Builder.class) +public final class DeleteSynchronizedGroupsRequestContent { + private final List groups; + + private final Map additionalProperties; + + private DeleteSynchronizedGroupsRequestContent( + List groups, Map additionalProperties) { + this.groups = groups; + this.additionalProperties = additionalProperties; + } + + /** + * @return Array of groups to remove from the selection set. + */ + @JsonProperty("groups") + public List getGroups() { + return groups; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DeleteSynchronizedGroupsRequestContent + && equalTo((DeleteSynchronizedGroupsRequestContent) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DeleteSynchronizedGroupsRequestContent other) { + return groups.equals(other.groups); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.groups); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private List groups = new ArrayList<>(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(DeleteSynchronizedGroupsRequestContent other) { + groups(other.getGroups()); + return this; + } + + /** + *

Array of groups to remove from the selection set.

+ */ + @JsonSetter(value = "groups", nulls = Nulls.SKIP) + public Builder groups(List groups) { + this.groups.clear(); + if (groups != null) { + this.groups.addAll(groups); + } + return this; + } + + public Builder addGroups(SynchronizedGroupSelectionId groups) { + this.groups.add(groups); + return this; + } + + public Builder addAllGroups(List groups) { + if (groups != null) { + this.groups.addAll(groups); + } + return this; + } + + public DeleteSynchronizedGroupsRequestContent build() { + return new DeleteSynchronizedGroupsRequestContent(groups, additionalProperties); + } + + public Builder additionalProperty(String key, Object value) { + this.additionalProperties.put(key, value); + return this; + } + + public Builder additionalProperties(Map additionalProperties) { + this.additionalProperties.putAll(additionalProperties); + return this; + } + } +} diff --git a/src/main/java/com/auth0/client/mgmt/connections/types/ListSynchronizedGroupsRequestParameters.java b/src/main/java/com/auth0/client/mgmt/connections/types/ListSynchronizedGroupsRequestParameters.java index 44183765..24870862 100644 --- a/src/main/java/com/auth0/client/mgmt/connections/types/ListSynchronizedGroupsRequestParameters.java +++ b/src/main/java/com/auth0/client/mgmt/connections/types/ListSynchronizedGroupsRequestParameters.java @@ -27,12 +27,18 @@ public final class ListSynchronizedGroupsRequestParameters { private final OptionalNullable take; + private final OptionalNullable q; + private final Map additionalProperties; private ListSynchronizedGroupsRequestParameters( - OptionalNullable from, OptionalNullable take, Map additionalProperties) { + OptionalNullable from, + OptionalNullable take, + OptionalNullable q, + Map additionalProperties) { this.from = from; this.take = take; + this.q = q; this.additionalProperties = additionalProperties; } @@ -60,6 +66,18 @@ public OptionalNullable getTake() { return take; } + /** + * @return Query in Lucene query string syntax. Only prefix search on "name" or "email" fields are allowed, with a single wildcard suffix. Operators, modifiers, and groupings are not allowed. Terms are treated as case-insensitive. Example query: "name:engineering*". + */ + @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = NullableNonemptyFilter.class) + @JsonProperty("q") + public OptionalNullable getQ() { + if (q == null) { + return OptionalNullable.absent(); + } + return q; + } + @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = NullableNonemptyFilter.class) @JsonProperty("from") private OptionalNullable _getFrom() { @@ -72,6 +90,12 @@ private OptionalNullable _getTake() { return take; } + @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = NullableNonemptyFilter.class) + @JsonProperty("q") + private OptionalNullable _getQ() { + return q; + } + @java.lang.Override public boolean equals(Object other) { if (this == other) return true; @@ -85,12 +109,12 @@ public Map getAdditionalProperties() { } private boolean equalTo(ListSynchronizedGroupsRequestParameters other) { - return from.equals(other.from) && take.equals(other.take); + return from.equals(other.from) && take.equals(other.take) && q.equals(other.q); } @java.lang.Override public int hashCode() { - return Objects.hash(this.from, this.take); + return Objects.hash(this.from, this.take, this.q); } @java.lang.Override @@ -108,6 +132,8 @@ public static final class Builder { private OptionalNullable take = OptionalNullable.absent(); + private OptionalNullable q = OptionalNullable.absent(); + @JsonAnySetter private Map additionalProperties = new HashMap<>(); @@ -116,6 +142,7 @@ private Builder() {} public Builder from(ListSynchronizedGroupsRequestParameters other) { from(other.getFrom()); take(other.getTake()); + q(other.getQ()); return this; } @@ -187,8 +214,42 @@ public Builder take(com.auth0.client.mgmt.core.Nullable take) { return this; } + /** + *

Query in Lucene query string syntax. Only prefix search on "name" or "email" fields are allowed, with a single wildcard suffix. Operators, modifiers, and groupings are not allowed. Terms are treated as case-insensitive. Example query: "name:engineering*".

+ */ + @JsonSetter(value = "q", nulls = Nulls.SKIP) + public Builder q(@Nullable OptionalNullable q) { + this.q = q; + return this; + } + + public Builder q(String q) { + this.q = OptionalNullable.of(q); + return this; + } + + public Builder q(Optional q) { + if (q.isPresent()) { + this.q = OptionalNullable.of(q.get()); + } else { + this.q = OptionalNullable.absent(); + } + return this; + } + + public Builder q(com.auth0.client.mgmt.core.Nullable q) { + if (q.isNull()) { + this.q = OptionalNullable.ofNull(); + } else if (q.isEmpty()) { + this.q = OptionalNullable.absent(); + } else { + this.q = OptionalNullable.of(q.get()); + } + return this; + } + public ListSynchronizedGroupsRequestParameters build() { - return new ListSynchronizedGroupsRequestParameters(from, take, additionalProperties); + return new ListSynchronizedGroupsRequestParameters(from, take, q, additionalProperties); } public Builder additionalProperty(String key, Object value) { diff --git a/src/main/java/com/auth0/client/mgmt/eventstreams/AsyncDeliveriesClient.java b/src/main/java/com/auth0/client/mgmt/eventstreams/AsyncDeliveriesClient.java index a90f8678..cc355810 100644 --- a/src/main/java/com/auth0/client/mgmt/eventstreams/AsyncDeliveriesClient.java +++ b/src/main/java/com/auth0/client/mgmt/eventstreams/AsyncDeliveriesClient.java @@ -5,10 +5,10 @@ import com.auth0.client.mgmt.core.ClientOptions; import com.auth0.client.mgmt.core.RequestOptions; +import com.auth0.client.mgmt.core.SyncPagingIterable; import com.auth0.client.mgmt.eventstreams.types.ListEventStreamDeliveriesRequestParameters; import com.auth0.client.mgmt.types.EventStreamDelivery; import com.auth0.client.mgmt.types.GetEventStreamDeliveryHistoryResponseContent; -import java.util.List; import java.util.concurrent.CompletableFuture; public class AsyncDeliveriesClient { @@ -28,20 +28,20 @@ public AsyncRawDeliveriesClient withRawResponse() { return this.rawClient; } - public CompletableFuture> list(String id) { + public CompletableFuture> list(String id) { return this.rawClient.list(id).thenApply(response -> response.body()); } - public CompletableFuture> list(String id, RequestOptions requestOptions) { + public CompletableFuture> list(String id, RequestOptions requestOptions) { return this.rawClient.list(id, requestOptions).thenApply(response -> response.body()); } - public CompletableFuture> list( + public CompletableFuture> list( String id, ListEventStreamDeliveriesRequestParameters request) { return this.rawClient.list(id, request).thenApply(response -> response.body()); } - public CompletableFuture> list( + public CompletableFuture> list( String id, ListEventStreamDeliveriesRequestParameters request, RequestOptions requestOptions) { return this.rawClient.list(id, request, requestOptions).thenApply(response -> response.body()); } diff --git a/src/main/java/com/auth0/client/mgmt/eventstreams/AsyncRawDeliveriesClient.java b/src/main/java/com/auth0/client/mgmt/eventstreams/AsyncRawDeliveriesClient.java index 78791103..4ccb8016 100644 --- a/src/main/java/com/auth0/client/mgmt/eventstreams/AsyncRawDeliveriesClient.java +++ b/src/main/java/com/auth0/client/mgmt/eventstreams/AsyncRawDeliveriesClient.java @@ -11,6 +11,7 @@ import com.auth0.client.mgmt.core.QueryStringMapper; import com.auth0.client.mgmt.core.RequestOptions; import com.auth0.client.mgmt.core.RetryInterceptor; +import com.auth0.client.mgmt.core.SyncPagingIterable; import com.auth0.client.mgmt.errors.BadRequestError; import com.auth0.client.mgmt.errors.ForbiddenError; import com.auth0.client.mgmt.errors.NotFoundError; @@ -19,11 +20,13 @@ import com.auth0.client.mgmt.eventstreams.types.ListEventStreamDeliveriesRequestParameters; import com.auth0.client.mgmt.types.EventStreamDelivery; import com.auth0.client.mgmt.types.GetEventStreamDeliveryHistoryResponseContent; +import com.auth0.client.mgmt.types.ListEventStreamDeliveriesResponseContent; import com.fasterxml.jackson.core.JsonProcessingException; -import com.fasterxml.jackson.core.type.TypeReference; import java.io.IOException; import java.util.List; +import java.util.Optional; import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; import okhttp3.Call; import okhttp3.Callback; import okhttp3.Headers; @@ -41,21 +44,21 @@ public AsyncRawDeliveriesClient(ClientOptions clientOptions) { this.clientOptions = clientOptions; } - public CompletableFuture>> list(String id) { + public CompletableFuture>> list(String id) { return list(id, ListEventStreamDeliveriesRequestParameters.builder().build()); } - public CompletableFuture>> list( + public CompletableFuture>> list( String id, RequestOptions requestOptions) { return list(id, ListEventStreamDeliveriesRequestParameters.builder().build(), requestOptions); } - public CompletableFuture>> list( + public CompletableFuture>> list( String id, ListEventStreamDeliveriesRequestParameters request) { return list(id, request, null); } - public CompletableFuture>> list( + public CompletableFuture>> list( String id, ListEventStreamDeliveriesRequestParameters request, RequestOptions requestOptions) { HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) .newBuilder() @@ -107,16 +110,34 @@ public CompletableFuture>> l requestOptions.getMaxRetries().get())) .build(); } - CompletableFuture>> future = new CompletableFuture<>(); + CompletableFuture>> future = + new CompletableFuture<>(); client.newCall(okhttpRequest).enqueue(new Callback() { @Override public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { try (ResponseBody responseBody = response.body()) { String responseBodyString = responseBody != null ? responseBody.string() : "{}"; if (response.isSuccessful()) { + ListEventStreamDeliveriesResponseContent parsedResponse = ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, ListEventStreamDeliveriesResponseContent.class); + Optional startingAfter = parsedResponse.getNext(); + ListEventStreamDeliveriesRequestParameters nextRequest = + ListEventStreamDeliveriesRequestParameters.builder() + .from(request) + .from(startingAfter) + .build(); + List result = parsedResponse.getDeliveries(); future.complete(new ManagementApiHttpResponse<>( - ObjectMappers.JSON_MAPPER.readValue( - responseBodyString, new TypeReference>() {}), + new SyncPagingIterable( + startingAfter.isPresent(), result, parsedResponse, () -> { + try { + return list(id, nextRequest, requestOptions) + .get() + .body(); + } catch (InterruptedException | ExecutionException e) { + throw new RuntimeException(e); + } + }), response)); return; } diff --git a/src/main/java/com/auth0/client/mgmt/eventstreams/DeliveriesClient.java b/src/main/java/com/auth0/client/mgmt/eventstreams/DeliveriesClient.java index 0d9b4e87..fa05c66a 100644 --- a/src/main/java/com/auth0/client/mgmt/eventstreams/DeliveriesClient.java +++ b/src/main/java/com/auth0/client/mgmt/eventstreams/DeliveriesClient.java @@ -5,10 +5,10 @@ import com.auth0.client.mgmt.core.ClientOptions; import com.auth0.client.mgmt.core.RequestOptions; +import com.auth0.client.mgmt.core.SyncPagingIterable; import com.auth0.client.mgmt.eventstreams.types.ListEventStreamDeliveriesRequestParameters; import com.auth0.client.mgmt.types.EventStreamDelivery; import com.auth0.client.mgmt.types.GetEventStreamDeliveryHistoryResponseContent; -import java.util.List; public class DeliveriesClient { protected final ClientOptions clientOptions; @@ -27,19 +27,19 @@ public RawDeliveriesClient withRawResponse() { return this.rawClient; } - public List list(String id) { + public SyncPagingIterable list(String id) { return this.rawClient.list(id).body(); } - public List list(String id, RequestOptions requestOptions) { + public SyncPagingIterable list(String id, RequestOptions requestOptions) { return this.rawClient.list(id, requestOptions).body(); } - public List list(String id, ListEventStreamDeliveriesRequestParameters request) { + public SyncPagingIterable list(String id, ListEventStreamDeliveriesRequestParameters request) { return this.rawClient.list(id, request).body(); } - public List list( + public SyncPagingIterable list( String id, ListEventStreamDeliveriesRequestParameters request, RequestOptions requestOptions) { return this.rawClient.list(id, request, requestOptions).body(); } diff --git a/src/main/java/com/auth0/client/mgmt/eventstreams/RawDeliveriesClient.java b/src/main/java/com/auth0/client/mgmt/eventstreams/RawDeliveriesClient.java index 92557992..9276a536 100644 --- a/src/main/java/com/auth0/client/mgmt/eventstreams/RawDeliveriesClient.java +++ b/src/main/java/com/auth0/client/mgmt/eventstreams/RawDeliveriesClient.java @@ -11,6 +11,7 @@ import com.auth0.client.mgmt.core.QueryStringMapper; import com.auth0.client.mgmt.core.RequestOptions; import com.auth0.client.mgmt.core.RetryInterceptor; +import com.auth0.client.mgmt.core.SyncPagingIterable; import com.auth0.client.mgmt.errors.BadRequestError; import com.auth0.client.mgmt.errors.ForbiddenError; import com.auth0.client.mgmt.errors.NotFoundError; @@ -19,10 +20,11 @@ import com.auth0.client.mgmt.eventstreams.types.ListEventStreamDeliveriesRequestParameters; import com.auth0.client.mgmt.types.EventStreamDelivery; import com.auth0.client.mgmt.types.GetEventStreamDeliveryHistoryResponseContent; +import com.auth0.client.mgmt.types.ListEventStreamDeliveriesResponseContent; import com.fasterxml.jackson.core.JsonProcessingException; -import com.fasterxml.jackson.core.type.TypeReference; import java.io.IOException; import java.util.List; +import java.util.Optional; import okhttp3.Headers; import okhttp3.HttpUrl; import okhttp3.OkHttpClient; @@ -37,20 +39,21 @@ public RawDeliveriesClient(ClientOptions clientOptions) { this.clientOptions = clientOptions; } - public ManagementApiHttpResponse> list(String id) { + public ManagementApiHttpResponse> list(String id) { return list(id, ListEventStreamDeliveriesRequestParameters.builder().build()); } - public ManagementApiHttpResponse> list(String id, RequestOptions requestOptions) { + public ManagementApiHttpResponse> list( + String id, RequestOptions requestOptions) { return list(id, ListEventStreamDeliveriesRequestParameters.builder().build(), requestOptions); } - public ManagementApiHttpResponse> list( + public ManagementApiHttpResponse> list( String id, ListEventStreamDeliveriesRequestParameters request) { return list(id, request, null); } - public ManagementApiHttpResponse> list( + public ManagementApiHttpResponse> list( String id, ListEventStreamDeliveriesRequestParameters request, RequestOptions requestOptions) { HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) .newBuilder() @@ -106,9 +109,20 @@ public ManagementApiHttpResponse> list( ResponseBody responseBody = response.body(); String responseBodyString = responseBody != null ? responseBody.string() : "{}"; if (response.isSuccessful()) { + ListEventStreamDeliveriesResponseContent parsedResponse = ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, ListEventStreamDeliveriesResponseContent.class); + Optional startingAfter = parsedResponse.getNext(); + ListEventStreamDeliveriesRequestParameters nextRequest = + ListEventStreamDeliveriesRequestParameters.builder() + .from(request) + .from(startingAfter) + .build(); + List result = parsedResponse.getDeliveries(); return new ManagementApiHttpResponse<>( - ObjectMappers.JSON_MAPPER.readValue( - responseBodyString, new TypeReference>() {}), + new SyncPagingIterable( + startingAfter.isPresent(), result, parsedResponse, () -> list( + id, nextRequest, requestOptions) + .body()), response); } try { diff --git a/src/main/java/com/auth0/client/mgmt/flows/AsyncRawExecutionsClient.java b/src/main/java/com/auth0/client/mgmt/flows/AsyncRawExecutionsClient.java index c1a54751..61111e90 100644 --- a/src/main/java/com/auth0/client/mgmt/flows/AsyncRawExecutionsClient.java +++ b/src/main/java/com/auth0/client/mgmt/flows/AsyncRawExecutionsClient.java @@ -66,6 +66,8 @@ public CompletableFuture> list( .addPathSegments("flows") .addPathSegment(flowId) .addPathSegments("executions"); + QueryStringMapper.addQueryParameter( + httpUrl, "include_totals", request.getIncludeTotals().orElse(true), false); if (!request.getFrom().isAbsent()) { QueryStringMapper.addQueryParameter( httpUrl, "from", request.getFrom().orElse(null), false); diff --git a/src/main/java/com/auth0/client/mgmt/flows/types/ListFlowExecutionsRequestParameters.java b/src/main/java/com/auth0/client/mgmt/flows/types/ListFlowExecutionsRequestParameters.java index c7f26792..1d1298a2 100644 --- a/src/main/java/com/auth0/client/mgmt/flows/types/ListFlowExecutionsRequestParameters.java +++ b/src/main/java/com/auth0/client/mgmt/flows/types/ListFlowExecutionsRequestParameters.java @@ -23,6 +23,8 @@ @JsonInclude(JsonInclude.Include.NON_ABSENT) @JsonDeserialize(builder = ListFlowExecutionsRequestParameters.Builder.class) public final class ListFlowExecutionsRequestParameters { + private final OptionalNullable includeTotals; + private final OptionalNullable from; private final OptionalNullable take; @@ -30,12 +32,28 @@ public final class ListFlowExecutionsRequestParameters { private final Map additionalProperties; private ListFlowExecutionsRequestParameters( - OptionalNullable from, OptionalNullable take, Map additionalProperties) { + OptionalNullable includeTotals, + OptionalNullable from, + OptionalNullable take, + Map additionalProperties) { + this.includeTotals = includeTotals; this.from = from; this.take = take; this.additionalProperties = additionalProperties; } + /** + * @return Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). + */ + @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = NullableNonemptyFilter.class) + @JsonProperty("include_totals") + public OptionalNullable getIncludeTotals() { + if (includeTotals == null) { + return OptionalNullable.absent(); + } + return includeTotals; + } + /** * @return Optional Id from which to start selection. */ @@ -60,6 +78,12 @@ public OptionalNullable getTake() { return take; } + @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = NullableNonemptyFilter.class) + @JsonProperty("include_totals") + private OptionalNullable _getIncludeTotals() { + return includeTotals; + } + @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = NullableNonemptyFilter.class) @JsonProperty("from") private OptionalNullable _getFrom() { @@ -85,12 +109,12 @@ public Map getAdditionalProperties() { } private boolean equalTo(ListFlowExecutionsRequestParameters other) { - return from.equals(other.from) && take.equals(other.take); + return includeTotals.equals(other.includeTotals) && from.equals(other.from) && take.equals(other.take); } @java.lang.Override public int hashCode() { - return Objects.hash(this.from, this.take); + return Objects.hash(this.includeTotals, this.from, this.take); } @java.lang.Override @@ -104,6 +128,8 @@ public static Builder builder() { @JsonIgnoreProperties(ignoreUnknown = true) public static final class Builder { + private OptionalNullable includeTotals = OptionalNullable.absent(); + private OptionalNullable from = OptionalNullable.absent(); private OptionalNullable take = OptionalNullable.absent(); @@ -114,11 +140,46 @@ public static final class Builder { private Builder() {} public Builder from(ListFlowExecutionsRequestParameters other) { + includeTotals(other.getIncludeTotals()); from(other.getFrom()); take(other.getTake()); return this; } + /** + *

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

+ */ + @JsonSetter(value = "include_totals", nulls = Nulls.SKIP) + public Builder includeTotals(@Nullable OptionalNullable includeTotals) { + this.includeTotals = includeTotals; + return this; + } + + public Builder includeTotals(Boolean includeTotals) { + this.includeTotals = OptionalNullable.of(includeTotals); + return this; + } + + public Builder includeTotals(Optional includeTotals) { + if (includeTotals.isPresent()) { + this.includeTotals = OptionalNullable.of(includeTotals.get()); + } else { + this.includeTotals = OptionalNullable.absent(); + } + return this; + } + + public Builder includeTotals(com.auth0.client.mgmt.core.Nullable includeTotals) { + if (includeTotals.isNull()) { + this.includeTotals = OptionalNullable.ofNull(); + } else if (includeTotals.isEmpty()) { + this.includeTotals = OptionalNullable.absent(); + } else { + this.includeTotals = OptionalNullable.of(includeTotals.get()); + } + return this; + } + /** *

Optional Id from which to start selection.

*/ @@ -188,7 +249,7 @@ public Builder take(com.auth0.client.mgmt.core.Nullable take) { } public ListFlowExecutionsRequestParameters build() { - return new ListFlowExecutionsRequestParameters(from, take, additionalProperties); + return new ListFlowExecutionsRequestParameters(includeTotals, from, take, additionalProperties); } public Builder additionalProperty(String key, Object value) { diff --git a/src/main/java/com/auth0/client/mgmt/organizations/AsyncClientsClient.java b/src/main/java/com/auth0/client/mgmt/organizations/AsyncClientsClient.java new file mode 100644 index 00000000..6abc012d --- /dev/null +++ b/src/main/java/com/auth0/client/mgmt/organizations/AsyncClientsClient.java @@ -0,0 +1,162 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.auth0.client.mgmt.organizations; + +import com.auth0.client.mgmt.core.ClientOptions; +import com.auth0.client.mgmt.core.RequestOptions; +import com.auth0.client.mgmt.core.SyncPagingIterable; +import com.auth0.client.mgmt.organizations.types.CreateOrganizationClientsRequestContent; +import com.auth0.client.mgmt.organizations.types.DeleteOrganizationClientsRequestContent; +import com.auth0.client.mgmt.organizations.types.ListOrganizationClientsRequestParameters; +import com.auth0.client.mgmt.organizations.types.UpdateOrganizationClientRequestContent; +import com.auth0.client.mgmt.types.GetOrganizationClientResponseContent; +import com.auth0.client.mgmt.types.OrganizationClient; +import com.auth0.client.mgmt.types.UpdateOrganizationClientResponseContent; +import java.util.List; +import java.util.concurrent.CompletableFuture; + +public class AsyncClientsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawClientsClient rawClient; + + public AsyncClientsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawClientsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawClientsClient withRawResponse() { + return this.rawClient; + } + + /** + * List all clients associated with an organization, using checkpoint pagination. + *

    + *
  • + * Note: The first time you call this endpoint, 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 further results are remaining. + *
  • + *

+ */ + public CompletableFuture> list(String id) { + return this.rawClient.list(id).thenApply(response -> response.body()); + } + + /** + * List all clients associated with an organization, using checkpoint pagination. + *

    + *
  • + * Note: The first time you call this endpoint, 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 further results are remaining. + *
  • + *

+ */ + public CompletableFuture> list(String id, RequestOptions requestOptions) { + return this.rawClient.list(id, requestOptions).thenApply(response -> response.body()); + } + + /** + * List all clients associated with an organization, using checkpoint pagination. + *

    + *
  • + * Note: The first time you call this endpoint, 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 further results are remaining. + *
  • + *

+ */ + public CompletableFuture> list( + String id, ListOrganizationClientsRequestParameters request) { + return this.rawClient.list(id, request).thenApply(response -> response.body()); + } + + /** + * List all clients associated with an organization, using checkpoint pagination. + *

    + *
  • + * Note: The first time you call this endpoint, 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 further results are remaining. + *
  • + *

+ */ + public CompletableFuture> list( + String id, ListOrganizationClientsRequestParameters request, RequestOptions requestOptions) { + return this.rawClient.list(id, request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Associate one or more clients with an organization. + */ + public CompletableFuture> create( + String id, CreateOrganizationClientsRequestContent request) { + return this.rawClient.create(id, request).thenApply(response -> response.body()); + } + + /** + * Associate one or more clients with an organization. + */ + public CompletableFuture> create( + String id, CreateOrganizationClientsRequestContent request, RequestOptions requestOptions) { + return this.rawClient.create(id, request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Remove one or more client associations from an organization. + */ + public CompletableFuture delete(String id, DeleteOrganizationClientsRequestContent request) { + return this.rawClient.delete(id, request).thenApply(response -> response.body()); + } + + /** + * Remove one or more client associations from an organization. + */ + public CompletableFuture delete( + String id, DeleteOrganizationClientsRequestContent request, RequestOptions requestOptions) { + return this.rawClient.delete(id, request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Get a specific client association for an organization. + */ + public CompletableFuture get(String id, String clientId) { + return this.rawClient.get(id, clientId).thenApply(response -> response.body()); + } + + /** + * Get a specific client association for an organization. + */ + public CompletableFuture get( + String id, String clientId, RequestOptions requestOptions) { + return this.rawClient.get(id, clientId, requestOptions).thenApply(response -> response.body()); + } + + /** + * Update an organization client association. + */ + public CompletableFuture update(String id, String clientId) { + return this.rawClient.update(id, clientId).thenApply(response -> response.body()); + } + + /** + * Update an organization client association. + */ + public CompletableFuture update( + String id, String clientId, RequestOptions requestOptions) { + return this.rawClient.update(id, clientId, requestOptions).thenApply(response -> response.body()); + } + + /** + * Update an organization client association. + */ + public CompletableFuture update( + String id, String clientId, UpdateOrganizationClientRequestContent request) { + return this.rawClient.update(id, clientId, request).thenApply(response -> response.body()); + } + + /** + * Update an organization client association. + */ + public CompletableFuture update( + String id, String clientId, UpdateOrganizationClientRequestContent request, RequestOptions requestOptions) { + return this.rawClient.update(id, clientId, request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/auth0/client/mgmt/organizations/AsyncMembersClient.java b/src/main/java/com/auth0/client/mgmt/organizations/AsyncMembersClient.java index b42e9461..648296f3 100644 --- a/src/main/java/com/auth0/client/mgmt/organizations/AsyncMembersClient.java +++ b/src/main/java/com/auth0/client/mgmt/organizations/AsyncMembersClient.java @@ -44,7 +44,7 @@ public AsyncRawMembersClient withRawResponse() { * This endpoint is subject to eventual consistency. New users may not be immediately included in the response and deleted users may not be immediately removed from it. *
    *
  • Use the fields parameter to optionally define the specific member details retrieved. If fields is left blank, all fields (except roles) are returned.
  • - *
  • Member roles are not sent by default. Use fields=roles to retrieve the roles assigned to each listed member. To use this parameter, you must include the read:organization_member_roles scope in the token.
  • + *
  • Member roles are not sent by default. Use fields=roles to retrieve the roles assigned to each listed member. To use this parameter, you must include the read:organization_member_roles scope in the token. Only directly assigned roles are returned. To also include group-based role assignments, use GET /api/v2/organizations/{id}/members/{user_id}/effective-roles.
  • *
*

This endpoint supports two types of pagination:

*