Skip to content

Latest commit

Β 

History

History
690 lines (497 loc) Β· 10.1 KB

reference.md

File metadata and controls

690 lines (497 loc) Β· 10.1 KB

Reference

factors

client.Factors.ListAsync() -> WithRawResponseTask<ListFactorsResponseContent>

πŸ“ Description

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

πŸ”Œ Usage

await client.Factors.ListAsync();

AuthenticationMethods

client.AuthenticationMethods.ListAsync(ListAuthenticationMethodsRequestParameters { ... }) -> WithRawResponseTask<ListAuthenticationMethodsResponseContent>

πŸ“ Description

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

πŸ”Œ Usage

await client.AuthenticationMethods.ListAsync(
    new ListAuthenticationMethodsRequestParameters { Type = FactorTypeEnum.Password }
);

βš™οΈ Parameters

request: ListAuthenticationMethodsRequestParameters

client.AuthenticationMethods.CreateAsync(CreateAuthenticationMethodRequestContent { ... }) -> WithRawResponseTask<CreateAuthenticationMethodResponseContent>

πŸ“ Description

Start the enrollment of a supported authentication method.

πŸ”Œ Usage

await client.AuthenticationMethods.CreateAsync(
    new CreateAuthenticationMethodRequestContent(
        new CreateAuthenticationMethodRequestContent.Phone(
            new CreatePhoneAuthenticationMethod { PhoneNumber = "phone_number" }
        )
    )
);

βš™οΈ Parameters

request: CreateAuthenticationMethodRequestContent

client.AuthenticationMethods.GetAsync(authenticationMethodId) -> WithRawResponseTask<GetAuthenticationMethodResponseContent>

πŸ“ Description

Retrieves a single authentication method belonging to the authenticated user.

πŸ”Œ Usage

await client.AuthenticationMethods.GetAsync("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.DeleteAsync(authenticationMethodId) -> WithRawResponseTask

πŸ“ Description

Deletes a single authentication method belonging to the authenticated user.

πŸ”Œ Usage

await client.AuthenticationMethods.DeleteAsync("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.UpdateAsync(authenticationMethodId, UpdateAuthenticationMethodRequestContent { ... }) -> WithRawResponseTask<UpdateAuthenticationMethodResponseContent>

πŸ“ Description

Updates a single authentication method

πŸ”Œ Usage

await client.AuthenticationMethods.UpdateAsync(
    "authentication_method_id",
    new UpdateAuthenticationMethodRequestContent()
);

βš™οΈ 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: UpdateAuthenticationMethodRequestContent

client.AuthenticationMethods.VerifyAsync(authenticationMethodId, VerifyAuthenticationMethodRequestContent { ... }) -> WithRawResponseTask<VerifyAuthenticationMethodResponseContent>

πŸ“ Description

Confirm the enrollment of a supported authentication method.

πŸ”Œ Usage

await client.AuthenticationMethods.VerifyAsync(
    "authentication_method_id",
    new VerifyEmailAuthenticationMethod { AuthSession = "Fe26.2**05c400ed...", OtpCode = "123456" }
);

βš™οΈ 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.CreateAsync(CreateConnectedAccountsRequestContent { ... }) -> WithRawResponseTask<CreateConnectedAccountsResponseContent>

πŸ“ Description

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

πŸ”Œ Usage

await client.ConnectedAccounts.CreateAsync(
    new CreateConnectedAccountsRequestContent
    {
        Connection = "connection",
        RedirectUri = "redirect_uri",
    }
);

βš™οΈ Parameters

request: CreateConnectedAccountsRequestContent

client.ConnectedAccounts.CompleteAsync(CompleteConnectedAccountsRequestContent { ... }) -> WithRawResponseTask<CompleteConnectedAccountsResponseContent>

πŸ“ Description

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

πŸ”Œ Usage

await client.ConnectedAccounts.CompleteAsync(
    new CompleteConnectedAccountsRequestContent
    {
        AuthSession = "auth_session",
        ConnectCode = "connect_code",
        RedirectUri = "redirect_uri",
    }
);

βš™οΈ Parameters

request: CompleteConnectedAccountsRequestContent

client.ConnectedAccounts.ListAsync(ListConnectedAccountsRequestParameters { ... }) -> Pager<ConnectedAccount>

πŸ“ Description

Retrieve connected accounts belonging to the authenticated user.

πŸ”Œ Usage

await client.ConnectedAccounts.ListAsync(
    new ListConnectedAccountsRequestParameters
    {
        Connection = "connection",
        From = "from",
        Take = 1,
    }
);

βš™οΈ Parameters

request: ListConnectedAccountsRequestParameters

client.ConnectedAccounts.DeleteAsync(id) -> WithRawResponseTask

πŸ“ Description

Delete a connected account belonging to the authenticated user.

πŸ”Œ Usage

await client.ConnectedAccounts.DeleteAsync("id");

βš™οΈ Parameters

id: string β€” The unique identifier of the connected account

ConnectedAccounts Connections

client.ConnectedAccounts.Connections.ListAsync(ListConnectedAccountsConnectionsRequestParameters { ... }) -> Pager<ConnectedAccountConnection>

πŸ“ Description

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

πŸ”Œ Usage

await client.ConnectedAccounts.Connections.ListAsync(
    new ListConnectedAccountsConnectionsRequestParameters { From = "from", Take = 1 }
);

βš™οΈ Parameters

request: ListConnectedAccountsConnectionsRequestParameters