Add a MFA verification to the user, a logto-verification-id in header is required for checking sensitive permissions.

Lua path

app.integrations.logto.add_mfa_verification

Full name

logto.logto_add_mfa_verification

Create a new one-time token associated with an email address. The token can be used for verification purposes and has an expiration time.

Lua path

app.integrations.logto.create_one_time_token

Full name

logto.logto_add_one_time_tokens

Add an application to the organization.

Lua path

app.integrations.logto.add_organization_application

Full name

logto.logto_add_organization_applications

Add users as members to the specified organization with the given user IDs.

Lua path

app.integrations.logto.add_user_members_organization

Full name

logto.logto_add_organization_users

Add an identity (social identity) to the user, a logto-verification-id in header is required for checking sensitive permissions, and a verification record for the social identity is required.

Lua path

app.integrations.logto.add_user_identity

Full name

logto.logto_add_user_identities

Adds user profile data to the current experience interaction. - For `Register`: The profile data provided before the identification request will be used to create a new user account. - For `SignIn` and `Register`: The profile data provided after the user is identified will be used to update the user's profile when the interaction is submitted. - `ForgotPassword`: Not supported.

Lua path

app.integrations.logto.add_user_profile

Full name

logto.logto_add_user_profile

The Assertion Consumer Service (ACS) endpoint for Simple Assertion Markup Language (SAML) social connectors. SAML social connectors are deprecated. Use the SSO SAML connector instead.

Lua path

app.integrations.logto.saml_acs_endpoint_social

Full name

logto.logto_assert_saml

The Assertion Consumer Service (ACS) endpoint for Simple Assertion Markup Language (SAML) single sign-on (SSO) connectors. This endpoint is used to complete the SAML SSO authentication flow. It receives the SAML assertion response from the identity provider (IdP) and redirects the user to complete the authentication flow.

Lua path

app.integrations.logto.saml_acs_endpoint_sso

Full name

logto.logto_assert_single_sign_on_saml

Assign API resource roles to the specified application. The API resource roles will be added to the existing API resource roles.

Lua path

app.integrations.logto.assign_api_resource_roles_application

Full name

logto.logto_assign_application_roles

Add a role to the application in the organization.

Lua path

app.integrations.logto.add_organization_application_role

Full name

logto.logto_assign_organization_roles_to_application

Assign roles to applications in the specified organization.

Lua path

app.integrations.logto.assign_roles_applications_organization

Full name

logto.logto_assign_organization_roles_to_applications

Assign roles to a user in the specified organization with the provided data.

Lua path

app.integrations.logto.assign_roles_user_organization

Full name

logto.logto_assign_organization_roles_to_user

Assign roles to user members of the specified organization.

Lua path

app.integrations.logto.assign_roles_organization_user_members

Full name

logto.logto_assign_organization_roles_to_users

Assign API resource roles to the user. The roles will be added to the existing roles.

Lua path

app.integrations.logto.assign_roles_user

Full name

logto.logto_assign_user_roles

Bind new MFA verification to the user profile using the verificationId.

Lua path

app.integrations.logto.bind_mfa_verification_by_verificationid

Full name

logto.logto_bind_mfa_verification

Bind a WebAuthn credential as a passkey for sign-in purposes. Unlike `POST /api/experience/profile/mfa` with `type: WebAuthn`, this endpoint is exclusively for adding a passkey as a sign-in method and does NOT mark the user's optional MFA as enabled.

Lua path

app.integrations.logto.bind_passkey_sign

Full name

logto.logto_bind_passkey

Check if a password meets the password policy in the sign-in experience settings.

Lua path

app.integrations.logto.check_if_password_meets_password_policy

Full name

logto.logto_check_password_with_default_sign_in_experience

Clean up custom domains that have been inactive (not verified) for a specified number of days. This uses Cloudflare as the source of truth to determine domain activity.

Lua path

app.integrations.logto.cleanup_stale_domains

Full name

logto.logto_cleanup_domains

Create a new MFA verification code and send it to the user's bound identifier (email or phone). This endpoint automatically uses the user's bound email address or phone number from their profile for MFA verification. The user must be identified before calling this endpoint.

Lua path

app.integrations.logto.create_and_send_mfa_verification_code

Full name

logto.logto_create_and_send_mfa_verification_code

Create a new `CodeVerification` record and sends the code to the specified identifier. The code verification can be used to verify the given identifier.

Lua path

app.integrations.logto.create_and_send_verification_code

Full name

logto.logto_create_and_send_verification_code

Create a new application with the given data.

Lua path

app.integrations.logto.create_application

Full name

logto.logto_create_application

Add a custom domain to the application. You'll need to setup DNS record later.

Lua path

app.integrations.logto.add_custom_domain_application

Full name

logto.logto_create_application_protected_app_metadata_custom_domain

Add a new secret for the application.

Lua path

app.integrations.logto.add_application_secret

Full name

logto.logto_create_application_secret

Grant a list of organization access of a user for a application by application id and user id. The user must be a member of all the organizations. Only third-party application needs to be granted access to organizations, all the other applications can request for all the organizations' access by default.

Lua path

app.integrations.logto.grant_list_organization_access_user_application

Full name

logto.logto_create_application_user_consent_organization

Assign the user consent scopes to an application by application id

Lua path

app.integrations.logto.assign_user_consent_scopes_application

Full name

logto.logto_create_application_user_consent_scope

Create a connector with the given data.

Lua path

app.integrations.logto.create_connector

Full name

logto.logto_create_connector

Get authorization URI for specified connector by providing redirect URI and randomly generated state.

Lua path

app.integrations.logto.get_connector_authorization_uri

Full name

logto.logto_create_connector_authorization_uri

Test a passwordless (email or SMS) connector by sending a test message to the given phone number or email address.

Lua path

app.integrations.logto.test_passwordless_connector

Full name

logto.logto_create_connector_test

Create a custom profile field.

Lua path

app.integrations.logto.create_custom_profile_field

Full name

logto.logto_create_custom_profile_field

Create multiple custom profile fields in a single request (max 20 items).

Lua path

app.integrations.logto.batch_create_custom_profile_fields

Full name

logto.logto_create_custom_profile_fields_batch

Create a new domain with the given data. The maximum domain number is 1, once created, can not be modified, you'll have to delete and recreate one.

Lua path

app.integrations.logto.create_domain

Full name

logto.logto_create_domain

Create a new EnterpriseSSO verification record and return the provider's authorization URI for the given connector.

Lua path

app.integrations.logto.create_enterprise_sso_verification

Full name

logto.logto_create_enterprise_sso_verification

Create a new hook with the given data.

Lua path

app.integrations.logto.create_hook

Full name

logto.logto_create_hook

Test the specified hook with the given events and config.

Lua path

app.integrations.logto.test_hook

Full name

logto.logto_create_hook_test

Create a NewPasswordIdentity verification record for the new user registration use. The verification record includes a unique user identifier and a password that can be used to create a new user account.

Lua path

app.integrations.logto.create_new_password_identity_verification

Full name

logto.logto_create_new_password_identity_verification

Create or replace the user's TOTP MFA verification with a new authenticator app binding. If the user already has a TOTP verification, it will be replaced; otherwise, a new one will be created. Requires a logto-verification-id header for sensitive permission checks, a valid TOTP secret, and a valid TOTP code generated from the secret.

Lua path

app.integrations.logto.create_or_replace_authenticator_app

Full name

logto.logto_create_or_replace_totp_mfa_verification

Create a new organization with the given data.

Lua path

app.integrations.logto.create_organization

Full name

logto.logto_create_organization

Create an organization invitation and optionally send it via email. The tenant should have an email connector configured if you want to send the invitation via email at this point.

Lua path

app.integrations.logto.create_organization_invitation

Full name

logto.logto_create_organization_invitation

Resend the invitation message to the invitee.

Lua path

app.integrations.logto.resend_invitation_message

Full name

logto.logto_create_organization_invitation_message

Add a new email domain for just-in-time provisioning of users in the organization.

Lua path

app.integrations.logto.add_organization_jit_email_domain

Full name

logto.logto_create_organization_jit_email_domain

Add new organization roles that will be assigned to users during just-in-time provisioning.

Lua path

app.integrations.logto.add_organization_jit_default_roles

Full name

logto.logto_create_organization_jit_role

Add new enterprise SSO connectors for just-in-time provisioning of users in the organization.

Lua path

app.integrations.logto.add_organization_jit_sso_connectors

Full name

logto.logto_create_organization_jit_sso_connector

Create a new organization role with the given data.

Lua path

app.integrations.logto.create_organization_role

Full name

logto.logto_create_organization_role

Assign resource scopes to the specified organization role

Lua path

app.integrations.logto.assign_resource_scopes_organization_role

Full name

logto.logto_create_organization_role_resource_scope

Assign organization scopes to the specified organization role

Lua path

app.integrations.logto.assign_organization_scopes_organization_role

Full name

logto.logto_create_organization_role_scope

Create a new organization scope with the given data.

Lua path

app.integrations.logto.create_organization_scope

Full name

logto.logto_create_organization_scope

Create and verify a new Password verification record. The verification record can only be created if the provided user credentials are correct.

Lua path

app.integrations.logto.create_password_verification_record

Full name

logto.logto_create_password_verification

Create an API resource in the current tenant.

Lua path

app.integrations.logto.create_api_resource

Full name

logto.logto_create_resource

Create a new scope (permission) for an API resource.

Lua path

app.integrations.logto.create_api_resource_scope

Full name

logto.logto_create_resource_scope

Create a new role with the given data.

Lua path

app.integrations.logto.create_role

Full name

logto.logto_create_role

Assign a role to a list of applications. The role must have the type `Application`.

Lua path

app.integrations.logto.assign_role_applications

Full name

logto.logto_create_role_application

Link a list of API resource scopes (permissions) to a role. The original linked scopes will be kept.

Lua path

app.integrations.logto.link_scopes_role

Full name

logto.logto_create_role_scope

Assign a role to a list of users. The role must have the type `User`.

Lua path

app.integrations.logto.assign_role_users

Full name

logto.logto_create_role_user

Create a new SAML application with the given configuration. A default signing certificate with 3 years lifetime will be automatically created.

Lua path

app.integrations.logto.create_saml_application

Full name

logto.logto_create_saml_application

Create a new signing certificate for the SAML application.

Lua path

app.integrations.logto.create_saml_application_secret

Full name

logto.logto_create_saml_application_secret

Process SAML authentication request using HTTP POST binding.

Lua path

app.integrations.logto.handle_saml_authentication_request_post_binding

Full name

logto.logto_create_saml_authn

Create WebAuthn authentication options for passkey sign-in. The user will be resolved later by the credential during verification.

Lua path

app.integrations.logto.create_passkey_sign_webauthn_authentication

Full name

logto.logto_create_sign_in_passkey_authentication

Create WebAuthn authentication options for passkey sign-in with an identifier. The identifier is used to look up the user's WebAuthn credentials and generate non-discoverable authentication options.

Lua path

app.integrations.logto.create_passkey_sign_webauthn_authentication_with_identifier

Full name

logto.logto_create_sign_in_passkey_authentication_with_identifier

Create a new SocialVerification record and return the provider's authorization URI for the given connector.

Lua path

app.integrations.logto.create_social_verification

Full name

logto.logto_create_social_verification

Create an new SSO connector instance for a given provider.

Lua path

app.integrations.logto.create_sso_connector

Full name

logto.logto_create_sso_connector

Create a new subject token for the use of impersonating the user.

Lua path

app.integrations.logto.create_new_subject_token

Full name

logto.logto_create_subject_token

Create a new TOTP verification record and generate a new TOTP secret for the user. This secret can be used to bind a new TOTP verification to the user's profile. The verification record must be verified before the secret can be used to bind a new TOTP verification to the user's profile.

Lua path

app.integrations.logto.create_totp_secret

Full name

logto.logto_create_totp_secret

Create a new user with the given data.

Lua path

app.integrations.logto.create_user

Full name

logto.logto_create_user

Upload a user asset.

Lua path

app.integrations.logto.upload_asset

Full name

logto.logto_create_user_asset

Link authenticated user identity from a social platform to a Logto user. The usage of this API is usually coupled with `POST /connectors/:connectorId/authorization-uri`. With the help of these pair of APIs, you can implement a user profile page with the link social account feature in your application. Note: Currently due to technical limitations, this API does not support the following connectors that rely on Logto interaction session: `@logto/connector-apple`, `@logto/connector-saml`, `@logto/c

Lua path

app.integrations.logto.link_social_identity_user

Full name

logto.logto_create_user_identity

Create a new MFA verification for a given user ID.

Lua path

app.integrations.logto.create_mfa_verification_user

Full name

logto.logto_create_user_mfa_verification

Add a new personal access token for the user.

Lua path

app.integrations.logto.add_personal_access_token

Full name

logto.logto_create_user_personal_access_token

Create a verification record by verifying the password.

Lua path

app.integrations.logto.create_record_by_password

Full name

logto.logto_create_verification_by_password

Create a social verification record and return the authorization URI.

Lua path

app.integrations.logto.create_social_verification_record

Full name

logto.logto_create_verification_by_social

Create a verification record and send the code to the specified identifier. The code verification can be used to verify the given identifier.

Lua path

app.integrations.logto.create_record_by_verification_code

Full name

logto.logto_create_verification_by_verification_code

Request a verification code for the provided identifier (email/phone). if you're using email as the identifier, you need to setup your email connector first. if you're using phone as the identifier, you need to setup your SMS connector first.

Lua path

app.integrations.logto.request_and_send_verification_code

Full name

logto.logto_create_verification_code

Create a new WebAuthn authentication verification record based on the user's existing WebAuthn credential. This verification record can be used to verify the user's WebAuthn credential.

Lua path

app.integrations.logto.create_webauthn_authentication_verification

Full name

logto.logto_create_web_authn_authentication_verification

Create a new WebAuthn registration verification record. The verification record can be used to bind a new WebAuthn credential to the user's profile.

Lua path

app.integrations.logto.create_webauthn_registration_verification

Full name

logto.logto_create_web_authn_registration_verification

Delete application by ID.

Lua path

app.integrations.logto.delete_application

Full name

logto.logto_delete_application

Delete the legacy secret for the application and replace it with a new internal secret. Note: This operation does not "really" delete the legacy secret because it is still needed for internal validation. We may remove the display of the legacy secret (the `secret` field in the application response) in the future.

Lua path

app.integrations.logto.delete_application_legacy_secret

Full name

logto.logto_delete_application_legacy_secret

Remove custom domain from the specified application.

Lua path

app.integrations.logto.remove_custom_domain

Full name

logto.logto_delete_application_protected_app_metadata_custom_domain

Remove a API resource role from the specified application.

Lua path

app.integrations.logto.remove_api_resource_role_from_application

Full name

logto.logto_delete_application_role

Delete a secret for the application by name.

Lua path

app.integrations.logto.delete_application_secret

Full name

logto.logto_delete_application_secret

Revoke a user's access to an organization for a application by application id, user id and organization id.

Lua path

app.integrations.logto.revoke_user_access_organization_application

Full name

logto.logto_delete_application_user_consent_organization

Remove the user consent scope from an application by application id, scope type and scope id

Lua path

app.integrations.logto.remove_user_consent_scope_from_application

Full name

logto.logto_delete_application_user_consent_scope

Delete the captcha provider.

Lua path

app.integrations.logto.delete_captcha_provider

Full name

logto.logto_delete_captcha_provider

Delete connector by ID.

Lua path

app.integrations.logto.delete_connector

Full name

logto.logto_delete_connector

Delete custom phrases for the specified language tag.

Lua path

app.integrations.logto.delete_custom_phrase

Full name

logto.logto_delete_custom_phrase

Delete a custom profile field by name.

Lua path

app.integrations.logto.delete_custom_profile_field_by_name

Full name

logto.logto_delete_custom_profile_field_by_name

Delete domain by ID.

Lua path

app.integrations.logto.delete_domain

Full name

logto.logto_delete_domain

Delete an email template by its ID.

Lua path

app.integrations.logto.delete_email_template

Full name

logto.logto_delete_email_template

Bulk delete email templates by their language tag and template type.

Lua path

app.integrations.logto.delete_email_templates

Full name

logto.logto_delete_email_templates

Revoke a specific user application grant by grant ID and remove the related session authorization. A logto-verification-id in header is required for revoking grants.

Lua path

app.integrations.logto.revoke_grant_by_id

Full name

logto.logto_delete_grant_by_id

Delete hook by ID.

Lua path

app.integrations.logto.delete_hook

Full name

logto.logto_delete_hook

Delete an identity (social identity) from the user, a logto-verification-id in header is required for checking sensitive permissions. The request is rejected if it would remove the user's last identifier.

Lua path

app.integrations.logto.delete_user_identity

Full name

logto.logto_delete_identity

Delete the JWT customizer for the given token type.

Lua path

app.integrations.logto.delete_jwt_customizer

Full name

logto.logto_delete_jwt_customizer

Delete an MFA verification, a logto-verification-id in header is required for checking sensitive permissions.

Lua path

app.integrations.logto.delete_mfa_verification

Full name

logto.logto_delete_mfa_verification

Delete an OIDC signing key by key type and key ID.

Lua path

app.integrations.logto.delete_oidc_key

Full name

logto.logto_delete_oidc_key

Delete a one-time token by its ID.

Lua path

app.integrations.logto.delete_one_time_token_by_id

Full name

logto.logto_delete_one_time_token

Delete organization by ID.

Lua path

app.integrations.logto.delete_organization

Full name

logto.logto_delete_organization

Remove an application from the organization.

Lua path

app.integrations.logto.remove_organization_application

Full name

logto.logto_delete_organization_application

Remove a role from the application in the organization.

Lua path

app.integrations.logto.remove_organization_application_role

Full name

logto.logto_delete_organization_application_role

Delete an organization invitation by ID.

Lua path

app.integrations.logto.delete_organization_invitation

Full name

logto.logto_delete_organization_invitation

Remove an email domain for just-in-time provisioning of users in the organization.

Lua path

app.integrations.logto.remove_organization_jit_email_domain

Full name

logto.logto_delete_organization_jit_email_domain

Remove an organization role that will be assigned to users during just-in-time provisioning.

Lua path

app.integrations.logto.remove_organization_jit_default_role

Full name

logto.logto_delete_organization_jit_role

Remove an enterprise SSO connector for just-in-time provisioning of users in the organization.

Lua path

app.integrations.logto.remove_organization_jit_sso_connector

Full name

logto.logto_delete_organization_jit_sso_connector

Delete organization role by ID.

Lua path

app.integrations.logto.delete_organization_role

Full name

logto.logto_delete_organization_role

Remove a resource scope assignment from the specified organization role.

Lua path

app.integrations.logto.remove_resource_scope

Full name

logto.logto_delete_organization_role_resource_scope

Remove a organization scope assignment from the specified organization role.

Lua path

app.integrations.logto.remove_organization_scope

Full name

logto.logto_delete_organization_role_scope

Delete organization scope by ID.

Lua path

app.integrations.logto.delete_organization_scope

Full name

logto.logto_delete_organization_scope

Remove a user's membership from the specified organization.

Lua path

app.integrations.logto.remove_user_member_from_organization

Full name

logto.logto_delete_organization_user

Remove a role assignment from a user in the specified organization.

Lua path

app.integrations.logto.remove_role_from_user_organization

Full name

logto.logto_delete_organization_user_role

Delete a token for the user by name.

Lua path

app.integrations.logto.delete_personal_access_token

Full name

logto.logto_delete_personal_access_token_post

Delete primary email for the user, a logto-verification-id header is required for checking sensitive permissions. The request is rejected if it would remove the user's last identifier.

Lua path

app.integrations.logto.delete_primary_email

Full name

logto.logto_delete_primary_email

Delete primary phone for the user, a logto-verification-id header is required for checking sensitive permissions. The request is rejected if it would remove the user's last identifier.

Lua path

app.integrations.logto.delete_primary_phone

Full name

logto.logto_delete_primary_phone

Delete an API resource by ID.

Lua path

app.integrations.logto.delete_api_resource

Full name

logto.logto_delete_resource

Delete an API resource scope (permission) from the given resource.

Lua path

app.integrations.logto.delete_api_resource_scope

Full name

logto.logto_delete_resource_scope

Delete a role with the given ID.

Lua path

app.integrations.logto.delete_role

Full name

logto.logto_delete_role

Remove the role from an application with the given ID.

Lua path

app.integrations.logto.remove_role_from_application

Full name

logto.logto_delete_role_application

Unlink an API resource scope (permission) from a role with the given ID.

Lua path

app.integrations.logto.unlink_scope_from_role

Full name

logto.logto_delete_role_scope

Remove a role from a user with the given ID.

Lua path

app.integrations.logto.remove_role_from_user

Full name

logto.logto_delete_role_user

Delete a SAML application by ID.

Lua path

app.integrations.logto.delete_saml_application

Full name

logto.logto_delete_saml_application

Delete a signing certificate of the SAML application. Active certificates cannot be deleted.

Lua path

app.integrations.logto.delete_saml_application_secret

Full name

logto.logto_delete_saml_application_secret

Delete a secret by its ID.

Lua path

app.integrations.logto.delete_secret

Full name

logto.logto_delete_secret

Remove sentinel activity reports based on the provided target value(identifier).Use this endpoint to unblock users who may be locked out due to too many failed authentication attempts.

Lua path

app.integrations.logto.bulk_delete_sentinel_activities

Full name

logto.logto_delete_sentinel_activities

Revoke a specific user session by its ID, optionally revoking target associated grants and tokens. A logto-verification-id in header is required for revoking sessions.

Lua path

app.integrations.logto.revoke_session_by_id

Full name

logto.logto_delete_session_by_id

Delete an SSO connector by ID.

Lua path

app.integrations.logto.delete_sso_connector

Full name

logto.logto_delete_sso_connector

Delete user with the given ID. Note all associated data will be deleted cascadingly.

Lua path

app.integrations.logto.delete_user

Full name

logto.logto_delete_user

Revoke a specific grant and its associated token chain by grant ID. Also removes the matching session authorization entry for this grant from the related active session. The grant must belong to the user.

Lua path

app.integrations.logto.revoke_user_grant

Full name

logto.logto_delete_user_grant

Delete a social identity from the user.

Lua path

app.integrations.logto.delete_social_identity_from_user

Full name

logto.logto_delete_user_identity

Delete an MFA verification for the user with the given verification ID. The verification ID must be associated with the given user ID.

Lua path

app.integrations.logto.delete_mfa_verification_user

Full name

logto.logto_delete_user_mfa_verification

Delete a token for the user by name using the legacy path parameter. Deprecated: use the POST /delete endpoint instead to avoid url name encoding issues.

Lua path

app.integrations.logto.delete_personal_access_token

Full name

logto.logto_delete_user_personal_access_token

Remove an API resource role from the user.

Lua path

app.integrations.logto.remove_role_from_user

Full name

logto.logto_delete_user_role

Revoke a specific user session by its ID, optionally revoking associated target grants and tokens.

Lua path

app.integrations.logto.revoke_user_session

Full name

logto.logto_delete_user_session

Create a new BackupCode verification record with new backup codes generated. This verification record will be used to bind the backup codes to the user's profile.

Lua path

app.integrations.logto.generate_backup_codes

Full name

logto.logto_generate_backup_codes

Generate backup codes for the user.

Lua path

app.integrations.logto.generate_backup_codes

Full name

logto.logto_generate_my_account_backup_codes

Generate a TOTP secret for the user.

Lua path

app.integrations.logto.generate_totp_secret

Full name

logto.logto_generate_totp_secret

Generate WebAuthn registration options for the user to register a new WebAuthn device.

Lua path

app.integrations.logto.generate_webauthn_registration_options

Full name

logto.logto_generate_web_authn_registration_options

Get the account center settings.

Lua path

app.integrations.logto.get_account_center_settings

Full name

logto.logto_get_account_center_settings

Get active user data, including daily active user (DAU), weekly active user (WAU) and monthly active user (MAU). It also includes an array of DAU in the past 30 days.

Lua path

app.integrations.logto.get_active_user_data

Full name

logto.logto_get_active_user_counts

Get the global configuration object for Logto Console.

Lua path

app.integrations.logto.get_admin_console_config

Full name

logto.logto_get_admin_console_config

Get application details by ID.

Lua path

app.integrations.logto.get_application

Full name

logto.logto_get_application

Get application level sign-in experience for a given application. - Only branding properties and terms links customization is supported for now. - Only third-party applications can have the sign-in experience customization for now.

Lua path

app.integrations.logto.get_application_level_sign_experience

Full name

logto.logto_get_application_sign_in_experience

Get all backup codes for the user with their usage status. Requires identity verification.

Lua path

app.integrations.logto.get_backup_codes

Full name

logto.logto_get_backup_codes

Get the captcha provider, you can only have one captcha provider.

Lua path

app.integrations.logto.get_captcha_provider

Full name

logto.logto_get_captcha_provider

Get connector data by ID

Lua path

app.integrations.logto.get_connector

Full name

logto.logto_get_connector

Get connector factory by the given ID.

Lua path

app.integrations.logto.get_connector_factory

Full name

logto.logto_get_connector_factory

Get custom phrases for the specified language tag.

Lua path

app.integrations.logto.get_custom_phrases

Full name

logto.logto_get_custom_phrase

Get a custom profile field by name.

Lua path

app.integrations.logto.get_custom_profile_field_by_name

Full name

logto.logto_get_custom_profile_field_by_name

Get domain details by ID, by calling this API, the domain status will be synced from remote provider.

Lua path

app.integrations.logto.get_domain

Full name

logto.logto_get_domain

Get the email template by its ID.

Lua path

app.integrations.logto.get_email_template_by_id

Full name

logto.logto_get_email_template

Extract the email domain from the provided email address. Returns all the enabled SSO connectors that match the email domain.

Lua path

app.integrations.logto.get_enabled_sso_connectors_by_given_email_domain

Full name

logto.logto_get_enabled_sso_connectors

This API retrieves the access token issued by a third-party enterprise SSO provider for a given SSO connector ID. Access is only available if token storage is enabled for the corresponding connector. When a user authenticates through a SSO provider, Logto automatically stores the provider's tokens in an encrypted form. You can use this API to securely retrieve the stored access token and use it to access third-party APIs on behalf of the user.

Lua path

app.integrations.logto.retrieve_access_token_issued_by_third_party_enterprise_sso_provider

Full name

logto.logto_get_enterprise_sso_identity_access_token

Retrieve all active application grants for the user. A logto-verification-id in header is required for checking grant details.

Lua path

app.integrations.logto.get_all_active_grants

Full name

logto.logto_get_grants

The `HASURA_GRAPHQL_AUTH_HOOK` endpoint for Hasura auth. Use this endpoint to integrate Hasura's [webhook authentication flow](https://hasura.io/docs/latest/auth/authentication/webhook/).

Lua path

app.integrations.logto.hasura_auth_hook_endpoint

Full name

logto.logto_get_hasura_auth

Get hook details by ID.

Lua path

app.integrations.logto.get_hook

Full name

logto.logto_get_hook

Get the ID token extended claims configuration for the tenant. This configuration controls which extended claims (e.g., `custom_data`, `identities`, `roles`, `organizations`, `organization_roles`) are included in ID tokens.

Lua path

app.integrations.logto.get_id_token_claims_configuration

Full name

logto.logto_get_id_token_config

Get the public interaction data.

Lua path

app.integrations.logto.get_public_interaction_data

Full name

logto.logto_get_interaction

Get the JWT customizer for the given token type.

Lua path

app.integrations.logto.get_jwt_customizer

Full name

logto.logto_get_jwt_customizer

Get log details by ID.

Lua path

app.integrations.logto.get

Full name

logto.logto_get_log

Retrieve the exposed portion of the current user's logto config. This includes MFA states (enabled, skipped, skipMfaOnSignIn) and passkey sign-in binding states (skipped). Passkey is a WebAuthn MFA factor and shares the same account center field access control as MFA.

Lua path

app.integrations.logto.get_config

Full name

logto.logto_get_logto_config

Get MFA settings for the user. This endpoint requires the Identities scope. Returns current MFA configuration preferences.

Lua path

app.integrations.logto.get_mfa_settings

Full name

logto.logto_get_mfa_settings

Get MFA verifications for the user.

Lua path

app.integrations.logto.get_mfa_verifications

Full name

logto.logto_get_mfa_verifications

Get new user count in the past 7 days.

Lua path

app.integrations.logto.get_new_user_count

Full name

logto.logto_get_new_user_counts

Get OIDC signing keys by key type. The actual key will be redacted from the result.

Lua path

app.integrations.logto.get_oidc_keys

Full name

logto.logto_get_oidc_keys

Get the OIDC session configuration for the tenant.

Lua path

app.integrations.logto.get_oidc_session_config

Full name

logto.logto_get_oidc_session_config

Get a one-time token by its ID.

Lua path

app.integrations.logto.get_one_time_token_by_id

Full name

logto.logto_get_one_time_token

Get organization details by ID.

Lua path

app.integrations.logto.get_organization

Full name

logto.logto_get_organization

Get an organization invitation by ID.

Lua path

app.integrations.logto.get_organization_invitation

Full name

logto.logto_get_organization_invitation

Get organization role details by ID.

Lua path

app.integrations.logto.get_organization_role

Full name

logto.logto_get_organization_role

Get organization scope details by ID.

Lua path

app.integrations.logto.get_organization_scope

Full name

logto.logto_get_organization_scope

Get profile for the user.

Lua path

app.integrations.logto.get_profile

Full name

logto.logto_get_profile

Get an API resource details by ID.

Lua path

app.integrations.logto.get_api_resource

Full name

logto.logto_get_resource

Get role details by ID.

Lua path

app.integrations.logto.get_role

Full name

logto.logto_get_role

Get SAML application details by ID.

Lua path

app.integrations.logto.get_saml_application

Full name

logto.logto_get_saml_application

Handle the OIDC callback for SAML application and generate SAML response.

Lua path

app.integrations.logto.saml_application_callback

Full name

logto.logto_get_saml_application_callback

Process SAML authentication request using HTTP Redirect binding.

Lua path

app.integrations.logto.handle_saml_authentication_request_redirect_binding

Full name

logto.logto_get_saml_authn

Retrieve all non-expired sessions for the user, including session metadata and interaction details when available. A logto-verification-id in header is required for checking sensitive session details.

Lua path

app.integrations.logto.get_all_active_sessions

Full name

logto.logto_get_sessions

Get the default sign-in experience settings.

Lua path

app.integrations.logto.get_default_sign_experience_settings

Full name

logto.logto_get_sign_in_exp

Get the full sign-in experience configuration.

Lua path

app.integrations.logto.get_full_sign_experience

Full name

logto.logto_get_sign_in_experience_config

Get localized phrases based on the specified language.

Lua path

app.integrations.logto.get_localized_phrases

Full name

logto.logto_get_sign_in_experience_phrases

This API retrieves the access token issued by a third-party social provider for a given social target. Access is only available if token storage is enabled for the corresponding social connector. When a user authenticates through a social provider, Logto automatically stores the provider's tokens in an encrypted form. You can use this API to securely retrieve the stored access token and use it to access third-party APIs on behalf of the user.

Lua path

app.integrations.logto.retrieve_access_token_issued_by_third_party_social_provider

Full name

logto.logto_get_social_identity_access_token

Get SSO connector data by ID. In addition to the raw SSO connector data, a copy of fetched or parsed IdP configs and a copy of connector provider's data will be attached.

Lua path

app.integrations.logto.get_sso_connector

Full name

logto.logto_get_sso_connector

The traditional health check API. No authentication needed. > **Note** > Even if 204 is returned, it does not guarantee all the APIs are working properly since they may depend on additional resources or external services.

Lua path

app.integrations.logto.health_check

Full name

logto.logto_get_status

The endpoint for the current JSON document. The JSON conforms to the [OpenAPI v3.0.1](https://spec.openapis.org/oas/v3.0.1) (a.k.a. Swagger) specification.

Lua path

app.integrations.logto.get_swagger_json

Full name

logto.logto_get_swagger_json

Get the application constants.

Lua path

app.integrations.logto.get_application_constants

Full name

logto.logto_get_system_application_config

Get total user count in the current tenant.

Lua path

app.integrations.logto.get_total_user_count

Full name

logto.logto_get_total_user_count

Get user data for the given ID.

Lua path

app.integrations.logto.get_user

Full name

logto.logto_get_user

Get user assets service status.

Lua path

app.integrations.logto.get_service_status

Full name

logto.logto_get_user_asset_service_status

Check if the user with the given ID has a password set.

Lua path

app.integrations.logto.check_if_user_has_password

Full name

logto.logto_get_user_has_password

This API retrieves the social identity and its associated token set for the specified user from the Logto Secret Vault. The token set will only be available if token storage is enabled for the corresponding social connector.

Lua path

app.integrations.logto.retrieve_user_social_identity_and_associated_token_storage

Full name

logto.logto_get_user_identity

Retrieve a non-expired session for the user by session ID, including session metadata and interaction details when available.

Lua path

app.integrations.logto.get_user_active_session

Full name

logto.logto_get_user_session

This API retrieves the user's enterprise SSO identity and associated token set record from the Logto Secret Vault. The token set will only be available if token storage is enabled for the corresponding SSO connector.

Lua path

app.integrations.logto.retrieve_user_enterprise_sso_identity_and_associated_token_secret_if_token_storage_is_enabled

Full name

logto.logto_get_user_sso_identity

Get the default account center configuration.

Lua path

app.integrations.logto.get_default_account_center

Full name

logto.logto_get_well_known_account_center

Get the full sign-in experience configuration.

Lua path

app.integrations.logto.get_full_sign_experience

Full name

logto.logto_get_well_known_experience

The endpoint for the Experience API JSON document. The JSON conforms to the [OpenAPI v3.0.1](https://spec.openapis.org/oas/v3.0.1) (a.k.a. Swagger) specification.

Lua path

app.integrations.logto.get_experience_api_swagger_json

Full name

logto.logto_get_well_known_experience_openapi_json

The endpoint for the Management API JSON document. The JSON conforms to the [OpenAPI v3.0.1](https://spec.openapis.org/oas/v3.0.1) (a.k.a. Swagger) specification.

Lua path

app.integrations.logto.get_management_api_swagger_json

Full name

logto.logto_get_well_known_management_openapi_json

The endpoint for the User API JSON document. The JSON conforms to the [OpenAPI v3.0.1](https://spec.openapis.org/oas/v3.0.1) (a.k.a. Swagger) specification.

Lua path

app.integrations.logto.get_user_api_swagger_json

Full name

logto.logto_get_well_known_user_openapi_json

This API identifies the user based on the verificationId within the current experience interaction: - `SignIn` and `ForgotPassword` interactions: Verifies the user's identity using the provided `verificationId`. - `Register` interaction: Creates a new user account using the profile data from the current interaction. If a verificationId is provided, the profile data will first be updated with the verification record before creating the account. If not, the account is created directly from the sto

Lua path

app.integrations.logto.identify_user_current_interaction

Full name

logto.logto_identify_user

Init a new experience interaction with the given interaction type. Any existing interaction data will be cleared.

Lua path

app.integrations.logto.init_new_interaction

Full name

logto.logto_init_interaction

Get the list of organizations that an application is associated with.

Lua path

app.integrations.logto.get_application_organizations

Full name

logto.logto_list_application_organizations

Get custom domains of the specified application, the application type should be protected app.

Lua path

app.integrations.logto.get_application_custom_domains

Full name

logto.logto_list_application_protected_app_metadata_custom_domains

Get API resource roles assigned to the specified application with pagination.

Lua path

app.integrations.logto.get_application_api_resource_roles

Full name

logto.logto_list_application_roles

Get all the secrets for the application.

Lua path

app.integrations.logto.get_application_secrets

Full name

logto.logto_list_application_secrets

List all the user consented organizations for a application by application id and user id.

Lua path

app.integrations.logto.list_all_user_consented_organizations_application

Full name

logto.logto_list_application_user_consent_organizations

List all the user consent scopes of an application by application id

Lua path

app.integrations.logto.list_all_user_consent_scopes_application

Full name

logto.logto_list_application_user_consent_scopes

Get applications that match the given query with pagination.

Lua path

app.integrations.logto.get_applications

Full name

logto.logto_list_applications

Get all connector factories data available in Logto.

Lua path

app.integrations.logto.get_connector_factories

Full name

logto.logto_list_connector_factories

Get all connectors in the current tenant.

Lua path

app.integrations.logto.get_connectors

Full name

logto.logto_list_connectors

Get all custom phrases for all languages.

Lua path

app.integrations.logto.get_all_custom_phrases

Full name

logto.logto_list_custom_phrases

Get all custom profile fields.

Lua path

app.integrations.logto.get_all_custom_profile_fields

Full name

logto.logto_list_custom_profile_fields

Get all of your custom domains.

Lua path

app.integrations.logto.get_domains

Full name

logto.logto_list_domains

Get the list of email templates.

Lua path

app.integrations.logto.get_email_templates

Full name

logto.logto_list_email_templates

Get recent logs that match the given query for the specified hook with pagination.

Lua path

app.integrations.logto.get_recent_hook

Full name

logto.logto_list_hook_recent_logs

Get a list of hooks with optional pagination.

Lua path

app.integrations.logto.get_hooks

Full name

logto.logto_list_hooks

Get all JWT customizers for the tenant.

Lua path

app.integrations.logto.get_all_jwt_customizers

Full name

logto.logto_list_jwt_customizers

Get logs that match the given query with pagination.

Lua path

app.integrations.logto.get

Full name

logto.logto_list_logs

Get a list of one-time tokens, filtering by email and status, with optional pagination.

Lua path

app.integrations.logto.get_one_time_tokens

Full name

logto.logto_list_one_time_tokens

Get roles associated with the application in the organization.

Lua path

app.integrations.logto.get_organization_application_roles

Full name

logto.logto_list_organization_application_roles

Get applications associated with the organization.

Lua path

app.integrations.logto.get_organization_applications

Full name

logto.logto_list_organization_applications

Get organization invitations.

Lua path

app.integrations.logto.get_organization_invitations

Full name

logto.logto_list_organization_invitations

Get email domains for just-in-time provisioning of users in the organization.

Lua path

app.integrations.logto.get_organization_jit_email_domains

Full name

logto.logto_list_organization_jit_email_domains

Get organization roles that will be assigned to users during just-in-time provisioning.

Lua path

app.integrations.logto.get_organization_jit_default_roles

Full name

logto.logto_list_organization_jit_roles

Get enterprise SSO connectors for just-in-time provisioning of users in the organization.

Lua path

app.integrations.logto.get_organization_jit_sso_connectors

Full name

logto.logto_list_organization_jit_sso_connectors

Get resource scopes that are assigned to the specified organization role with optional pagination.

Lua path

app.integrations.logto.get_organization_role_resource_scopes

Full name

logto.logto_list_organization_role_resource_scopes

Get organization scopes that are assigned to the specified organization role with optional pagination.

Lua path

app.integrations.logto.get_organization_role_scopes

Full name

logto.logto_list_organization_role_scopes

Get organization roles with pagination.

Lua path

app.integrations.logto.get_organization_roles

Full name

logto.logto_list_organization_roles

Get organization scopes that match with optional pagination.

Lua path

app.integrations.logto.get_organization_scopes

Full name

logto.logto_list_organization_scopes

Get roles assigned to a user in the specified organization with pagination.

Lua path

app.integrations.logto.get_roles_user_organization

Full name

logto.logto_list_organization_user_roles

Get scopes assigned to a user in the specified organization tailored by the organization roles. The scopes are derived from the organization roles assigned to the user.

Lua path

app.integrations.logto.get_scopes_user_organization_tailored_by_organization_roles

Full name

logto.logto_list_organization_user_scopes

Get users that are members of the specified organization for the given query with pagination.

Lua path

app.integrations.logto.get_organization_user_members

Full name

logto.logto_list_organization_users

Get organizations that match the given query with pagination.

Lua path

app.integrations.logto.get_organizations

Full name

logto.logto_list_organizations

Get scopes (permissions) defined for an API resource.

Lua path

app.integrations.logto.get_api_resource_scopes

Full name

logto.logto_list_resource_scopes

Get API resources in the current tenant with pagination.

Lua path

app.integrations.logto.get_api_resources

Full name

logto.logto_list_resources

Get applications that have the role assigned with pagination.

Lua path

app.integrations.logto.get_role_applications

Full name

logto.logto_list_role_applications

Get API resource scopes (permissions) linked with a role.

Lua path

app.integrations.logto.get_role_scopes

Full name

logto.logto_list_role_scopes

Get users who have the role assigned with pagination.

Lua path

app.integrations.logto.get_role_users

Full name

logto.logto_list_role_users

Get roles with filters and pagination.

Lua path

app.integrations.logto.get_roles

Full name

logto.logto_list_roles

Get the SAML metadata XML for the application.

Lua path

app.integrations.logto.get_saml_application_metadata

Full name

logto.logto_list_saml_application_metadata

Get all signing certificates of the SAML application.

Lua path

app.integrations.logto.list_saml_application_secrets

Full name

logto.logto_list_saml_application_secrets

Get a complete list of supported SSO connector providers.

Lua path

app.integrations.logto.list_all_supported_sso_connector_provider_details

Full name

logto.logto_list_sso_connector_providers

Get SSO connectors with pagination. In addition to the raw SSO connector data, a copy of fetched or parsed IdP configs and a copy of connector provider's data will be attached.

Lua path

app.integrations.logto.list_sso_connectors

Full name

logto.logto_list_sso_connectors

This API retrieves all identities (social and enterprise SSO) for a user, along with their associated token set records from the Logto Secret Vault. The token sets will only be available if token storage is enabled for the corresponding identity connector.

Lua path

app.integrations.logto.retrieve_social_identities_enterprise_sso_identities_and_associated_token_secret_if_token_storage_is_enabled_user

Full name

logto.logto_list_user_all_identities

Get custom data for the given user ID.

Lua path

app.integrations.logto.get_user_custom_data

Full name

logto.logto_list_user_custom_data

Retrieve all non-expired grants of the user. Optionally filter by application type via `appType`; when omitted, grants from all application types are returned.

Lua path

app.integrations.logto.get_user_active_grants

Full name

logto.logto_list_user_grants

Retrieve the exposed portion of a user's logto config. Includes MFA states (enabled, skipped, skipMfaOnSignIn) and passkey sign-in states (skipped).

Lua path

app.integrations.logto.get_user_config

Full name

logto.logto_list_user_logto_configs

Get a user's existing MFA verifications for a given user ID.

Lua path

app.integrations.logto.get_user_mfa_verifications

Full name

logto.logto_list_user_mfa_verifications

Get all organizations that the user is a member of. In each organization object, the user's roles in that organization are included in the `organizationRoles` array.

Lua path

app.integrations.logto.get_organizations_user

Full name

logto.logto_list_user_organizations

Get all personal access tokens for the user.

Lua path

app.integrations.logto.get_personal_access_tokens

Full name

logto.logto_list_user_personal_access_tokens

Get API resource roles assigned to the user with pagination.

Lua path

app.integrations.logto.get_roles_user

Full name

logto.logto_list_user_roles

Retrieve all non-expired sessions for the user, including session metadata and interaction details when available.

Lua path

app.integrations.logto.get_user_active_sessions

Full name

logto.logto_list_user_sessions

Get users with filters and pagination. Logto provides a very flexible way to query users. You can filter users by almost any fields with multiple modes. To learn more about the query syntax, please refer to [Advanced user search](https://docs.logto.io/docs/recipes/manage-users/advanced-user-search/).

Lua path

app.integrations.logto.get_users

Full name

logto.logto_list_users

Mark the user's MFA as enabled for the current interaction and persist in DB user configs upon successful submission.

Lua path

app.integrations.logto.mark_mfa_as_enabled

Full name

logto.logto_mark_mfa_enabled

Update API resource roles assigned to the specified application. This will replace the existing API resource roles.

Lua path

app.integrations.logto.update_api_resource_roles_application

Full name

logto.logto_replace_application_roles

Update application level sign-in experience for the specified application. Create a new sign-in experience if it does not exist. - Only branding properties and terms links customization is supported for now. - Only third-party applications can be customized for now. - Application level sign-in experience customization is optional, if provided, it will override the default branding and terms links.

Lua path

app.integrations.logto.update_application_level_sign_experience

Full name

logto.logto_replace_application_sign_in_experience

Grant a list of organization access of a user for a application by application id and user id. The user must be a member of all the organizations. Only third-party application needs to be granted access to organizations, all the other applications can request for all the organizations' access by default.

Lua path

app.integrations.logto.grant_list_organization_access_user_application

Full name

logto.logto_replace_application_user_consent_organizations

Upsert custom phrases for the specified language tag. Upsert means that if the custom phrases already exist, they will be updated. Otherwise, they will be created.

Lua path

app.integrations.logto.upsert_custom_phrases

Full name

logto.logto_replace_custom_phrase

Create or replace a list of email templates. If an email template with the same language tag and template type already exists, its details will be updated.

Lua path

app.integrations.logto.replace_email_templates

Full name

logto.logto_replace_email_templates

Update the status of a one-time token by its ID. This can be used to mark the token as consumed or expired.

Lua path

app.integrations.logto.update_one_time_token_status

Full name

logto.logto_replace_one_time_token_status

Replace all roles associated with the application in the organization with the given data.

Lua path

app.integrations.logto.replace_organization_application_roles

Full name

logto.logto_replace_organization_application_roles

Replace all applications associated with the organization with the given data.

Lua path

app.integrations.logto.replace_organization_applications

Full name

logto.logto_replace_organization_applications

Update the status of an organization invitation by ID.

Lua path

app.integrations.logto.update_organization_invitation_status

Full name

logto.logto_replace_organization_invitation_status

Replace all just-in-time provisioning email domains for the organization with the given data.

Lua path

app.integrations.logto.replace_organization_jit_email_domains

Full name

logto.logto_replace_organization_jit_email_domains

Replace all organization roles that will be assigned to users during just-in-time provisioning with the given data.

Lua path

app.integrations.logto.replace_organization_jit_default_roles

Full name

logto.logto_replace_organization_jit_roles

Replace all enterprise SSO connectors for just-in-time provisioning of users in the organization with the given data.

Lua path

app.integrations.logto.replace_organization_jit_sso_connectors

Full name

logto.logto_replace_organization_jit_sso_connectors

Replace all resource scopes that are assigned to the specified organization role with the given resource scopes. This effectively removes all existing organization scope assignments and replaces them with the new ones.

Lua path

app.integrations.logto.replace_resource_scopes_organization_role

Full name

logto.logto_replace_organization_role_resource_scopes

Replace all organization scopes that are assigned to the specified organization role with the given organization scopes. This effectively removes all existing organization scope assignments and replaces them with the new ones.

Lua path

app.integrations.logto.replace_organization_scopes_organization_role

Full name

logto.logto_replace_organization_role_scopes

Update roles assigned to a user in the specified organization with the provided data.

Lua path

app.integrations.logto.update_roles_user_organization

Full name

logto.logto_replace_organization_user_roles

Replace all user members for the specified organization with the given users. This effectively removing all existing user memberships in the organization and adding the new users as members.

Lua path

app.integrations.logto.replace_organization_user_members

Full name

logto.logto_replace_organization_users

Directly update a social identity of the user.

Lua path

app.integrations.logto.update_social_identity_user

Full name

logto.logto_replace_user_identity

Update API resource roles assigned to the user. This will replace the existing roles.

Lua path

app.integrations.logto.update_roles_user

Full name

logto.logto_replace_user_roles

Reset the user's password. (`ForgotPassword` interaction only)

Lua path

app.integrations.logto.reset_user_password

Full name

logto.logto_reset_user_password

A new key will be generated and prepend to the list of keys. Only two recent keys will be kept. The oldest key will be automatically removed if there are more than two keys.

Lua path

app.integrations.logto.rotate_oidc_keys

Full name

logto.logto_rotate_oidc_keys

Skip MFA verification binding flow. If the MFA is enabled in the sign-in experience settings and marked as `UserControlled`, the user can skip the MFA verification binding flow by calling this API.

Lua path

app.integrations.logto.skip_mfa_binding_flow

Full name

logto.logto_skip_mfa_binding_flow

Mark the optional additional MFA binding suggestion as skipped for the current interaction. When multiple MFA factors are enabled and only an email/phone factor is configured, a suggestion to add another factor may be shown; this endpoint records the choice to skip.

Lua path

app.integrations.logto.skip_additional_mfa_suggestion

Full name

logto.logto_skip_mfa_suggestion

Skip passkey binding flow. The users can temporarily skip the passkey binding flow by calling this API during sign-up. On sign-in, the skip flag will be persisted to user config.

Lua path

app.integrations.logto.skip_passkey_binding

Full name

logto.logto_skip_passkey_binding

Submit the current interaction. - Submit the verified user identity to the OIDC provider for further authentication (SignIn and Register). - Update the user's profile data if any (SignIn and Register). - Reset the password and clear all the interaction records (ForgotPassword).

Lua path

app.integrations.logto.submit_interaction

Full name

logto.logto_submit_interaction

Test the JWT customizer script with the given sample context and sample token payload.

Lua path

app.integrations.logto.test_jwt_customizer

Full name

logto.logto_test_jwt_customizer

Update the account center settings with the provided settings.

Lua path

app.integrations.logto.update_account_center_settings

Full name

logto.logto_update_account_center_settings

Update the global configuration object for Logto Console. This method performs a partial update.

Lua path

app.integrations.logto.update_admin_console_config

Full name

logto.logto_update_admin_console_config

Update application details by ID with the given data.

Lua path

app.integrations.logto.update_application

Full name

logto.logto_update_application

Update the custom data of an application.

Lua path

app.integrations.logto.update_application_custom_data

Full name

logto.logto_update_application_custom_data

Update a secret for the application by name.

Lua path

app.integrations.logto.update_application_secret

Full name

logto.logto_update_application_secret

Update the captcha provider with the provided settings.

Lua path

app.integrations.logto.update_captcha_provider

Full name

logto.logto_update_captcha_provider

Update connector by ID with the given data. This methods performs a partial update.

Lua path

app.integrations.logto.update_connector

Full name

logto.logto_update_connector

Update a custom profile field by name.

Lua path

app.integrations.logto.update_custom_profile_field_by_name

Full name

logto.logto_update_custom_profile_field_by_name

Update the display order of the custom profile fields in Sign-in Experience.

Lua path

app.integrations.logto.update_display_order_custom_profile_fields_sign_experience

Full name

logto.logto_update_custom_profile_fields_sie_order

Update the details of an email template by its ID.

Lua path

app.integrations.logto.update_email_template_details

Full name

logto.logto_update_email_template_details

Update hook details by ID with the given data.

Lua path

app.integrations.logto.update_hook

Full name

logto.logto_update_hook

Update the signing key for the specified hook.

Lua path

app.integrations.logto.update_signing_key_hook

Full name

logto.logto_update_hook_signing_key

Update the current experience interaction event to the given event type. This API is used to switch the interaction event between `SignIn` and `Register`, while keeping all the verification records data.

Lua path

app.integrations.logto.update_interaction_event

Full name

logto.logto_update_interaction_event

Update the JWT customizer for the given token type.

Lua path

app.integrations.logto.update_jwt_customizer

Full name

logto.logto_update_jwt_customizer

Update the exposed portion of the current user's logto config. Supports updating MFA states (enabled, skipped, skipMfaOnSignIn) and passkey sign-in binding states (skipped). Passkey is a WebAuthn MFA factor and shares the same account center field access control as MFA.

Lua path

app.integrations.logto.update_config

Full name

logto.logto_update_logto_config