Skip to content

reference.md

Latest commit

 

History

History
824 lines (592 loc) · 11 KB

reference.md

File metadata and controls

824 lines (592 loc) · 11 KB
Raw

Reference

factors

client.factors.list() -> ListFactorsResponseContent

📝 Description

List of factors enabled for the Auth0 tenant and available for enrollment by this user.

🔌 Usage

client.factors().list();

AuthenticationMethods

client.authenticationMethods.list() -> ListAuthenticationMethodsResponseContent

📝 Description

Retrieve detailed list of authentication methods belonging to the authenticated user.

🔌 Usage

client.authenticationMethods().list(
    ListAuthenticationMethodsRequestParameters
        .builder()
        .type(
            OptionalNullable.of(FactorTypeEnum.PASSWORD)
        )
        .build()
);

⚙️ Parameters

type: Optional<FactorTypeEnum> — Filter authentication methods by type

client.authenticationMethods.create(request) -> CreateAuthenticationMethodResponseContent

📝 Description

Start the enrollment of a supported authentication method.

🔌 Usage

client.authenticationMethods().create(
    CreateAuthenticationMethodRequestContent.phone(
        CreatePhoneAuthenticationMethod
            .builder()
            .phoneNumber("phone_number")
            .build()
    )
);

⚙️ Parameters

request: CreateAuthenticationMethodRequestContent

client.authenticationMethods.get(authenticationMethodId) -> GetAuthenticationMethodResponseContent

📝 Description

Retrieves a single authentication method belonging to the authenticated user.

🔌 Usage

client.authenticationMethods().get("authentication_method_id");

⚙️ Parameters

authenticationMethodId: String — Authentication Method ID. This value is part of the Location header returned when creating an authentication method. It should be used as it is, without any modifications.

client.authenticationMethods.delete(authenticationMethodId)

📝 Description

Deletes a single authentication method belonging to the authenticated user.

🔌 Usage

client.authenticationMethods().delete("authentication_method_id");

⚙️ Parameters

authenticationMethodId: String — Authentication Method ID. This value is part of the Location header returned when creating an authentication method. It should be used as it is, without any modifications.

client.authenticationMethods.update(authenticationMethodId, request) -> UpdateAuthenticationMethodResponseContent

📝 Description

Updates a single authentication method

🔌 Usage

client.authenticationMethods().update(
    "authentication_method_id",
    UpdateAuthenticationMethodRequestContent
        .builder()
        .build()
);

⚙️ Parameters

authenticationMethodId: String — Authentication Method ID. This value is part of the Location header returned when creating an authentication method. It should be used as it is, without any modifications.

name: Optional<String> — The friendly name of the authentication method

preferredAuthenticationMethod: Optional<PhoneAuthenticationMethodEnum> — The preferred authentication method (for phone authenticators)

client.authenticationMethods.verify(authenticationMethodId, request) -> VerifyAuthenticationMethodResponseContent

📝 Description

Confirm the enrollment of a supported authentication method.

🔌 Usage

client.authenticationMethods().verify(
    "authentication_method_id",
    VerifyAuthenticationMethodRequestContent.of(
        VerifyEmailAuthenticationMethod
            .builder()
            .authSession("Fe26.2**05c400ed...")
            .otpCode("123456")
            .build()
    )
);

⚙️ Parameters

authenticationMethodId: String — Authentication Method ID. This value is part of the Location header returned when creating an authentication method. It should be used as it is, without any modifications.

request: VerifyAuthenticationMethodRequestContent

ConnectedAccounts

client.connectedAccounts.create(request) -> CreateConnectedAccountsResponseContent

📝 Description

Start an authorization flow to link the authenticated user's account with an external identity provider.

🔌 Usage

client.connectedAccounts().create(
    CreateConnectedAccountsRequestContent
        .builder()
        .connection("connection")
        .redirectUri("redirect_uri")
        .build()
);

⚙️ Parameters

connection: String — The name of the connection to link the account with (e.g., 'google-oauth2', 'facebook').

redirectUri: String — The URI to redirect to after the connection process completes.

state: Optional<String> — An opaque value used to maintain state between the request and callback.

codeChallenge: Optional<String> — The PKCE code challenge derived from the code verifier.

codeChallengeMethod: Optional<CreateConnectedAccountsRequestContentCodeChallengeMethod> — The method used to derive the code challenge. Required when code_challenge is provided.

scopes: Optional<List<String>> — Defines the permissions that the client requests from the Identity Provider. Must include the standard scopes used to identify the user (e.g. 'openid', 'email', 'profile'), the scope required to obtain refresh tokens if needed (e.g. 'offline_access'), and any custom scopes the client needs to access protected resources.

authorizationParams: Optional<AuthorizationParams>

client.connectedAccounts.complete(request) -> CompleteConnectedAccountsResponseContent

📝 Description

Complete a previously started authorization flow to link the authenticated user's account with an external identity provider.

🔌 Usage

client.connectedAccounts().complete(
    CompleteConnectedAccountsRequestContent
        .builder()
        .authSession("auth_session")
        .connectCode("connect_code")
        .redirectUri("redirect_uri")
        .build()
);

⚙️ Parameters

authSession: String — The authentication session identifier

connectCode: String — The authorization code returned from the connect flow

redirectUri: String — The redirect URI used in the original request

codeVerifier: Optional<String> — The PKCE code verifier

client.connectedAccounts.list() -> SyncPagingIterable&lt;ConnectedAccount&gt;

📝 Description

Retrieve connected accounts belonging to the authenticated user.

🔌 Usage

client.connectedAccounts().list(
    ListConnectedAccountsRequestParameters
        .builder()
        .connection(
            OptionalNullable.of(
                ConnectionNamesFilter.of("connection")
            )
        )
        .from(
            OptionalNullable.of("from")
        )
        .take(
            OptionalNullable.of(1)
        )
        .build()
);

⚙️ Parameters

connection: Optional<ConnectionNamesFilter> — Filter connected accounts by connection names

from: Optional<String> — Cursor for pagination - start retrieving results from this point

take: Optional<Integer> — Number of results to return (1-20)

client.connectedAccounts.delete(id)

📝 Description

Delete a connected account belonging to the authenticated user.

🔌 Usage

client.connectedAccounts().delete("id");

⚙️ Parameters

id: String — The unique identifier of the connected account

ConnectedAccounts Connections

client.connectedAccounts.connections.list() -> SyncPagingIterable&lt;ConnectedAccountConnection&gt;

📝 Description

Retrieve available connections that can be used for account linking by the authenticated user.

🔌 Usage

client.connectedAccounts().connections().list(
    ListConnectedAccountsConnectionsRequestParameters
        .builder()
        .from(
            OptionalNullable.of("from")
        )
        .take(
            OptionalNullable.of(1)
        )
        .build()
);

⚙️ Parameters

from: Optional<String> — Cursor for pagination - start retrieving results from this point

take: Optional<Integer> — Number of results to return (1-20)