Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Logto API references logo
dev
  • main default
  • dev

Topics

  • Introduction
  • Authentication

Endpoints

  • Account center
    • Get account center settings GET
    • Update account center settings PATCH
  • Applications
    • Get applications GET
    • Create an application POST
    • Get application GET
    • Delete application DELETE
    • Update application PATCH
    • Update application custom data PATCH
    • Get application API resource roles GET
    • Update API resource roles for application PUT
    • Assign API resource roles to application POST
    • Remove a API resource role from application DELETE
    • Get application custom domains. GET
    • Add a custom domain to the application. POST
    • Remove custom domain. DELETE
    • Get application organizations GET
    • Delete application legacy secret DELETE
    • Get application secrets GET
    • Add application secret POST
    • Delete application secret DELETE
    • Update application secret PATCH
    • List all the user consent scopes of an application. GET
    • Assign user consent scopes to application. POST
    • Remove user consent scope from application. DELETE
    • Get the application level sign-in experience GET
    • Update application level sign-in experience PUT
    • List all the user consented organizations of a application. GET
    • Grant a list of organization access of a user for a application. PUT
    • Grant a list of organization access of a user for a application. POST
    • Revoke a user's access to an organization for a application. DELETE
  • Audit logs
    • Get logs GET
    • Get log GET
  • Authn
    • Hasura auth hook endpoint GET
    • SAML ACS endpoint (social) POST
    • SAML ACS endpoint (SSO) POST
  • Captcha provider
    • Get captcha provider GET
    • Update captcha provider PUT
    • Delete captcha provider DELETE
  • Configs
    • Get admin console config GET
    • Update admin console config PATCH
    • Get OIDC keys GET
    • Delete OIDC key DELETE
    • Rotate OIDC keys POST
    • Get JWT customizer GET
    • Create or update JWT customizer PUT
    • Delete JWT customizer DELETE
    • Update JWT customizer PATCH
    • Get all JWT customizers GET
    • Test JWT customizer POST
  • Connector factories
    • Get connector factories GET
    • Get connector factory GET
  • Connectors
    • Get connectors GET
    • Create connector POST
    • Get connector GET
    • Delete connector DELETE
    • Update connector PATCH
    • Test passwordless connector POST
    • Get connector's authorization URI POST
  • Custom phrases
    • Get all custom phrases GET
    • Get custom phrases GET
    • Upsert custom phrases PUT
    • Delete custom phrase DELETE
  • Custom profile fields
    • Get all custom profile fields GET
    • Create a custom profile field POST
    • Get a custom profile field by name GET
    • Update a custom profile field by name PUT
    • Delete a custom profile field by name DELETE
    • Batch create custom profile fields POST
    • Update the display order of the custom profile fields in Sign-in Experience. POST
  • Dashboard
    • Get total user count GET
    • Get new user count GET
    • Get active user data GET
  • Domains
    • Get domains GET
    • Create domain POST
    • Get domain GET
    • Delete domain DELETE
  • Email templates
    • Get email templates GET
    • Replace email templates PUT
    • Delete email templates DELETE
    • Get email template by ID GET
    • Delete an email template DELETE
    • Update email template details PATCH
  • Experience
    • Init new interaction PUT
    • Update interaction event PUT
    • Identify user for the current interaction POST
    • Submit interaction POST
    • Get public interaction data GET
    • Create password verification record POST
    • Create and send verification code POST
    • Verify verification code POST
    • Create and send MFA verification code POST
    • Verify MFA verification code POST
    • Create social verification POST
    • Verify social verification POST
    • Create enterprise SSO verification POST
    • Verify enterprise SSO verification POST
    • Create TOTP secret POST
    • Verify TOTP verification POST
    • Create WebAuthn registration verification POST
    • Verify WebAuthn registration verification POST
    • Create WebAuthn authentication verification POST
    • Verify WebAuthn authentication verification POST
    • Generate backup codes POST
    • Verify backup code POST
    • Create new password identity verification POST
    • Verify one-time token POST
    • Add user profile POST
    • Reset user password PUT
    • Skip MFA binding flow POST
    • Skip additional MFA suggestion POST
    • Bind MFA verification by verificationId POST
    • Get enabled SSO connectors by the given email's domain GET
  • Hooks
    • Get hooks GET
    • Create a hook POST
    • Get hook GET
    • Delete hook DELETE
    • Update hook PATCH
    • Get recent logs for a hook GET
    • Test hook POST
    • Update signing key for a hook PATCH
  • My account
    • Get profile GET
    • Update profile PATCH
    • Update other profile PATCH
    • Update password POST
    • Get MFA settings GET
    • Update MFA settings PATCH
    • Get logto config GET
    • Update logto config PATCH
    • Retrieve the access token issued by a third-party social provider GET
    • Update the access token for a social identity by verification ID PUT
    • Retrieve the access token issued by a third-party enterprise SSO provider GET
    • Update primary email POST
    • Delete primary email DELETE
    • Update primary phone POST
    • Delete primary phone DELETE
    • Add a user identity POST
    • Delete a user identity DELETE
    • Get MFA verifications GET
    • Add a MFA verification POST
    • Generate a TOTP secret POST
    • Generate backup codes POST
    • Get backup codes GET
    • Update a MFA verification name PATCH
    • Delete an MFA verification DELETE
  • One-time tokens
    • Get one-time tokens GET
    • Create one-time token POST
    • Get one-time token by ID GET
    • Delete one-time token by ID DELETE
    • Verify one-time token POST
    • Update one-time token status PUT
  • Organization invitations
    • Get organization invitation GET
    • Delete organization invitation DELETE
    • Get organization invitations GET
    • Create organization invitation POST
    • Resend invitation message POST
    • Update organization invitation status PUT
  • Organization roles
    • Get organization role GET
    • Delete organization role DELETE
    • Update organization role PATCH
    • Get organization roles GET
    • Create an organization role POST
    • Get organization role scopes GET
    • Replace organization scopes for organization role PUT
    • Assign organization scopes to organization role POST
    • Remove organization scope DELETE
    • Get organization role resource scopes GET
    • Replace resource scopes for organization role PUT
    • Assign resource scopes to organization role POST
    • Remove resource scope DELETE
  • Organization scopes
    • Get organization scopes GET
    • Create an organization scope POST
    • Get organization scope GET
    • Delete organization scope DELETE
    • Update organization scope PATCH
  • Organizations
    • Get organizations GET
    • Create an organization POST
    • Get organization GET
    • Delete organization DELETE
    • Update organization PATCH
    • Get organization user members GET
    • Replace organization user members PUT
    • Add user members to organization POST
    • Remove user member from organization DELETE
    • Assign roles to organization user members POST
    • Get roles for a user in an organization GET
    • Update roles for a user in an organization PUT
    • Assign roles to a user in an organization POST
    • Remove a role from a user in an organization DELETE
    • Get scopes for a user in an organization tailored by the organization roles GET
    • Get organization applications GET
    • Replace organization applications PUT
    • Add organization application POST
    • Remove organization application DELETE
    • Assign roles to applications in an organization POST
    • Get organization application roles GET
    • Replace organization application roles PUT
    • Add organization application role POST
    • Remove organization application role DELETE
    • Get organization JIT email domains GET
    • Replace organization JIT email domains PUT
    • Add organization JIT email domain POST
    • Remove organization JIT email domain DELETE
    • Get organization JIT default roles GET
    • Replace organization JIT default roles PUT
    • Add organization JIT default roles POST
    • Remove organization JIT default role DELETE
    • Get organization JIT SSO connectors GET
    • Replace organization JIT SSO connectors PUT
    • Add organization JIT SSO connectors POST
    • Remove organization JIT SSO connector DELETE
  • Resources
    • Get API resources GET
    • Create an API resource POST
    • Get API resource GET
    • Delete API resource DELETE
    • Update API resource PATCH
    • Set API resource as default PATCH
    • Get API resource scopes GET
    • Create API resource scope POST
    • Delete API resource scope DELETE
    • Update API resource scope PATCH
  • Roles
    • Get roles GET
    • Create a role POST
    • Get role GET
    • Delete role DELETE
    • Update role PATCH
    • Get role users GET
    • Assign role to users POST
    • Remove role from user DELETE
    • Get role applications GET
    • Assign role to applications POST
    • Remove role from application DELETE
    • Get role scopes GET
    • Link scopes to role POST
    • Unlink scope from role DELETE
  • SAML applications
    • Create SAML application POST
    • Get SAML application GET
    • Delete SAML application DELETE
    • Update SAML application PATCH
    • List SAML application secrets GET
    • Create SAML application secret POST
    • Delete SAML application secret DELETE
    • Update SAML application secret PATCH
    • Get SAML application metadata GET
    • SAML application callback GET
  • SAML applications auth flow
    • Handle SAML authentication request (Redirect binding) GET
    • Handle SAML authentication request (POST binding) POST
  • Secrets
    • Delete secret DELETE
  • Sentinel activities
    • Bulk delete sentinel activities POST
  • Sign-in experience
    • Get default sign-in experience settings GET
    • Update default sign-in experience settings PATCH
    • Check if a password meets the password policy POST
    • Upload custom UI assets POST
  • SSO connector providers
    • List all the supported SSO connector provider details GET
  • SSO connectors
    • List SSO connectors GET
    • Create SSO connector POST
    • Get SSO connector GET
    • Delete SSO connector DELETE
    • Update SSO connector PATCH
    • Get IdP initiated auth config GET
    • Set IdP initiated auth config PUT
    • Delete IdP initiated auth config DELETE
  • Status
    • Health check GET
  • Subject tokens
    • Create a new subject token. POST
  • Swagger.json
    • Get Swagger JSON GET
  • Systems
    • Get the application constants. GET
  • User assets
    • Get service status GET
    • Upload asset POST
  • Users
    • Get user GET
    • Delete user DELETE
    • Update user PATCH
    • Get user custom data GET
    • Update user custom data PATCH
    • Get user logto config GET
    • Update user logto config PATCH
    • Update user profile PATCH
    • Get users GET
    • Create user POST
    • Update user password PATCH
    • Verify user password POST
    • Check if user has password GET
    • Update user suspension status PATCH
    • Get roles for user GET
    • Update roles for user PUT
    • Assign roles to user POST
    • Remove role from user DELETE
    • Retrieve a user's social identity and associated token storage . GET
    • Update social identity of user PUT
    • Delete social identity from user DELETE
    • Link social identity to user POST
    • Get organizations for a user GET
    • Get user's MFA verifications GET
    • Create an MFA verification for a user POST
    • Delete an MFA verification for a user DELETE
    • Get personal access tokens GET
    • Add personal access token POST
    • Update personal access token PATCH
    • Delete personal access token DELETE
    • Update personal access token PATCH
    • Delete personal access token POST
    • Retrieve a user's enterprise SSO identity and associated token secret (if token storage is enabled). GET
    • Retrieve social identities, enterprise SSO identities and associated token secret (if token storage is enabled) for a user. GET
  • Verification codes
    • Request and send a verification code POST
    • Verify a verification code POST
  • Verifications
    • Create a record by password POST
    • Create a record by verification code POST
    • Verify verification code POST
    • Create a social verification record POST
    • Verify a social verification record POST
    • Generate WebAuthn registration options POST
    • Verify WebAuthn registration POST
  • Well-known
    • Get full sign-in experience GET
    • Get localized phrases GET
    • Get full sign-in experience GET
    • Get default account center GET
    • Get Management API swagger JSON GET
    • Get Experience API swagger JSON GET
    • Get User API swagger JSON GET
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Logto API references logo

Status

Ask AI
  • Open in ChatGPT
  • Open in Claude

  • View as Markdown
  • Copy as Markdown

Endpoints for health check.