Do not miss any Logto API references changes, ever again

Subscribe to the Logto API references changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
16 structure changes including:
10 Additions
6 Modifications
Modified 6 Breaking
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customProfileFields property Modified
        • Property is now required
          Breaking
        • config property Modified
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customProfileFields property Modified
        • Property is now required
        • config property Modified
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • forgotPasswordMethods property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • forgotPasswordMethods property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • forgotPasswordMethods property Added
POST /api/interaction/bind-mfa
  • Body
  • application/json content type Modified
    • object-4, object-5 alternatives Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /api/interaction/mfa
  • Body
  • application/json content type Modified
    • object-4, object-5 alternatives Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
Added 10
DELETE /api/custom-profile-fields/{name}
GET /api/custom-profile-fields
GET /api/custom-profile-fields/{name}
GET /api/experience/interaction
POST /api/custom-profile-fields
POST /api/custom-profile-fields/batch
POST /api/custom-profile-fields/properties/sie-order
POST /api/experience/verification/mfa-verification-code
POST /api/experience/verification/mfa-verification-code/verify
PUT /api/custom-profile-fields/{name}
2 structure changes including:
2 Modifications
Modified 2
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customProfileFields property Modified
        • config property Modified
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customProfileFields property Modified
        • config property Modified
22 structure changes including:
10 Additions
12 Modifications
Modified 12
PUT /api/interaction/mfa
  • Body
  • application/json content type Modified
    • object-4, object-5 alternatives Added
POST /api/verifications/social
  • Body
  • application/json content type Modified
    • scope property Added
POST /api/interaction/verification/social-authorization-uri
  • Body
  • application/json content type Modified
    • scope property Added
POST /api/interaction/bind-mfa
  • Body
  • application/json content type Modified
    • object-4, object-5 alternatives Added
POST /api/connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • formItems property Modified
        • object-1, object-2, object-3 alternatives Modified
PATCH /api/connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • formItems property Modified
        • object-1, object-2, object-3 alternatives Modified
GET /api/connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • formItems property Modified
        • object-1, object-2, object-3 alternatives Modified
GET /api/connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • formItems property Modified
        • object-1, object-2, object-3 alternatives Modified
GET /api/connector-factories/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • formItems property Modified
        • object-1, object-2, object-3 alternatives Modified
GET /api/connector-factories
  • Response
  • 200 response Modified
    • application/json content type Modified
      • formItems property Modified
        • object-1, object-2, object-3 alternatives Modified
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customProfileFields property Modified
        • config property Modified
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customProfileFields property Modified
        • config property Modified
Added 10
PUT /api/my-account/identities/{target}/access-token
POST /api/my-account/mfa-verifications/totp-secret/generate
POST /api/my-account/mfa-verifications/backup-codes/generate
GET /api/users/{userId}/sso-identities/{ssoConnectorId}
GET /api/users/{userId}/identities/{target}
GET /api/users/{userId}/all-identities
GET /api/my-account/sso-identities/{connectorId}/access-token
GET /api/my-account/mfa-verifications/backup-codes
GET /api/my-account/identities/{target}/access-token
DELETE /api/secrets/{id}
4 structure changes including:
4 Modifications
Modified 4
GET /api/connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableTokenStorage property Added
GET /api/connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableTokenStorage property Added
PATCH /api/connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableTokenStorage property Added
POST /api/connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableTokenStorage property Added
15 structure changes including:
15 Modifications
Modified 15
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • socialConnectors property Modified
        • isTokenStorageSupported property Added
      • customProfileFields property Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • socialConnectors property Modified
        • isTokenStorageSupported property Added
      • customProfileFields property Added
GET /api/connector-factories
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isTokenStorageSupported property Added
GET /api/connector-factories/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isTokenStorageSupported property Added
GET /api/connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isTokenStorageSupported property Added
GET /api/connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isTokenStorageSupported property Added
GET /api/organizations/{id}/jit/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableTokenStorage property Added
GET /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableTokenStorage property Added
GET /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableTokenStorage property Added
PATCH /api/connectors/{id}
  • Body
  • application/json content type Modified
    • enableTokenStorage property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isTokenStorageSupported property Added
PATCH /api/my-account
  • Body
  • application/json content type Modified
    • customData property Added
PATCH /api/sso-connectors/{id}
  • Body
  • application/json content type Modified
    • enableTokenStorage property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableTokenStorage property Added
POST /api/connectors
  • Body
  • application/json content type Modified
    • enableTokenStorage property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isTokenStorageSupported property Added
POST /api/experience/profile
  • Body
  • application/json content type Modified
    • object-1 property Modified
      • values property Added
    • object-2 property Modified
      • values property Added
    • object-3 property Modified
      • values property Added
    • object-4 property Modified
      • values property Added
    • object-5 property Modified
      • values property Added
    • object-6 property Added
POST /api/sso-connectors
  • Body
  • application/json content type Modified
    • enableTokenStorage property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableTokenStorage property Added
1 structure change including:
1 Modification
Modified 1 Breaking
POST /api/my-account/mfa-verifications
  • Body
  • application/json content type Modified
    • alternative Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • object-1, object-2, object-3, object-4, object-5, object-6 alternatives Added
  • Response
  • 422 response Added
24 structure changes including:
6 Additions
18 Modifications
Modified 18
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
        • contextSample property Modified
  • 201 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
        • contextSample property Modified
POST /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
        • updatedAt property Added
POST /api/configs/jwt-customizer/test
  • Body
  • application/json content type Modified
    • object-1 property Modified
      • context property Modified
        • interaction property Added
PATCH /api/users/{userId}/password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
        • updatedAt property Added
PATCH /api/users/{userId}/is-suspended
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
        • updatedAt property Added
PATCH /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
        • updatedAt property Added
PATCH /api/my-account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
        • updatedAt property Added
PATCH /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
        • contextSample property Modified
PATCH /api/account-center
  • Body
  • application/json content type Modified
    • fields property Modified
      • mfa property Added
    • webauthnRelatedOrigins property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • fields property Modified
        • mfa property Added
      • webauthnRelatedOrigins property Added
GET /api/users/{userId}/mfa-verifications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • name property Added
GET /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
        • updatedAt property Added
GET /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
        • updatedAt property Added
GET /api/roles/{id}/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
        • updatedAt property Added
GET /api/my-account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
        • updatedAt property Added
GET /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
        • contextSample property Modified
GET /api/configs/jwt-customizer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
        • value property Modified
GET /api/account-center
  • Response
  • 200 response Modified
    • application/json content type Modified
      • fields property Modified
        • mfa property Added
      • webauthnRelatedOrigins property Added
DELETE /api/users/{userId}/identities/{target}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
        • updatedAt property Added
Added 6
POST /api/verifications/web-authn/registration/verify
POST /api/verifications/web-authn/registration
POST /api/my-account/mfa-verifications
PATCH /api/my-account/mfa-verifications/{verificationId}/name
GET /api/my-account/mfa-verifications
DELETE /api/my-account/mfa-verifications/{verificationId}
6 structure changes including:
6 Modifications
Modified 6
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • emailBlocklistPolicy property Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • emailBlocklistPolicy property Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • emailBlocklistPolicy property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • emailBlocklistPolicy property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • emailBlocklistPolicy property Added
POST /api/my-account/primary-email
  • Response
  • 422 response Added
POST /api/my-account/primary-phone
  • Response
  • 422 response Added
4 structure changes including:
4 Additions
Added 4
DELETE /api/captcha-provider
GET /api/captcha-provider
POST /api/sentinel-activities/delete
PUT /api/captcha-provider
7 structure changes including:
7 Additions
Added 7
DELETE /api/one-time-tokens/{id}
GET /api/one-time-tokens
GET /api/one-time-tokens/{id}
POST /api/experience/verification/one-time-token/verify
POST /api/one-time-tokens
POST /api/one-time-tokens/verify
PUT /api/one-time-tokens/{id}/status
4 structure changes including:
4 Modifications
Modified 4
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sentinelPolicy property Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sentinelPolicy property Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sentinelPolicy property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • sentinelPolicy property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sentinelPolicy property Added
6 structure changes including:
6 Modifications
Modified 6 Breaking
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • signUp property Modified
        • secondaryIdentifiers property Added
      • captchaPolicy property Modified
        • signIn, signUp, forgotPassword properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • enabled property Added
      • captchaConfig property Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • signUp property Modified
        • secondaryIdentifiers property Added
      • captchaPolicy property Modified
        • signIn, signUp, forgotPassword properties Removed
        • enabled property Added
      • captchaConfig property Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • signUp property Modified
        • secondaryIdentifiers property Added
      • captchaPolicy property Modified
        • signIn, signUp, forgotPassword properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • enabled property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • signUp property Modified
      • secondaryIdentifiers property Added
    • captchaPolicy property Modified
      • signIn, signUp, forgotPassword properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • enabled property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • signUp property Modified
        • secondaryIdentifiers property Added
      • captchaPolicy property Modified
        • signIn, signUp, forgotPassword properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • enabled property Added
POST /api/experience/verification/verification-code
  • Response
  • 422 response Added
PUT /api/experience
  • Body
  • application/json content type Modified
    • captchaToken property Added
  • Response
  • 422 response Added
4 structure changes including:
4 Modifications
Modified 4
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mfa property Modified
        • organizationRequiredMfaPolicy property Added
      • captchaPolicy property Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mfa property Modified
        • organizationRequiredMfaPolicy property Added
      • captchaPolicy property Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mfa property Modified
        • organizationRequiredMfaPolicy property Added
      • captchaPolicy property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • mfa property Modified
      • organizationRequiredMfaPolicy property Added
    • captchaPolicy property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mfa property Modified
        • organizationRequiredMfaPolicy property Added
      • captchaPolicy property Added
11 structure changes including:
6 Additions
5 Modifications
Modified 5 Breaking
POST /api/connectors/{factoryId}/test
  • Body
  • application/json content type Modified
    • locale property Added
POST /api/organization-invitations
  • Body
  • application/json content type Modified
    • messagePayload property Modified
      • object-2 alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • object-1 alternative Added
POST /api/organization-invitations/{id}/message
  • Body
  • application/json content type Modified
    • * property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • locale property Added
POST /api/organizations/{id}/users/{userId}/roles
  • Body
  • application/json content type Modified
    • organizationRoleIds property Modified
      • Property is no longer required
    • organizationRoleNames property Added
PUT /api/organizations/{id}/users/{userId}/roles
  • Body
  • application/json content type Modified
    • organizationRoleIds property Modified
      • Property is no longer required
    • organizationRoleNames property Added
Added 6
DELETE /api/email-templates
DELETE /api/email-templates/{id}
GET /api/email-templates
GET /api/email-templates/{id}
PATCH /api/email-templates/{id}/details
PUT /api/email-templates
13 structure changes including:
12 Additions
1 Modification
Modified 1
POST /api/user-assets
  • Body
  • multipart/form-data content type Added
Added 12
DELETE /api/saml-applications/{id}
DELETE /api/saml-applications/{id}/secrets/{secretId}
GET /api/saml-applications/{id}
GET /api/saml-applications/{id}/callback
GET /api/saml-applications/{id}/metadata
GET /api/saml-applications/{id}/secrets
GET /api/saml/{id}/authn
PATCH /api/saml-applications/{id}
PATCH /api/saml-applications/{id}/secrets/{secretId}
POST /api/saml-applications
POST /api/saml-applications/{id}/secrets
POST /api/saml/{id}/authn
1 structure change including:
1 Modification
Modified 1
PUT /api/interaction/profile
  • Response
  • 422 response Added
21 structure changes including:
17 Additions
4 Modifications
Modified 4
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • supportEmail property Added
      • string-1, string-2 properties Added
    • supportWebsiteUrl property Added
      • string-1, string-2 properties Added
    • unknownSessionRedirectUrl property Added
      • string-1, string-2 properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • supportEmail, supportWebsiteUrl, unknownSessionRedirectUrl properties Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • supportEmail, supportWebsiteUrl, unknownSessionRedirectUrl properties Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • supportEmail, supportWebsiteUrl, unknownSessionRedirectUrl properties Added
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • supportEmail, supportWebsiteUrl, unknownSessionRedirectUrl properties Added
Added 17
POST /api/verifications/verification-code/verify
POST /api/verifications/verification-code
POST /api/verifications/social/verify
POST /api/verifications/social
POST /api/verifications/password
POST /api/my-account/primary-phone
POST /api/my-account/primary-email
POST /api/my-account/password
POST /api/my-account/identities
PATCH /api/my-account/profile
PATCH /api/my-account
PATCH /api/account-center
GET /api/my-account
GET /api/account-center
DELETE /api/my-account/primary-phone
DELETE /api/my-account/primary-email
DELETE /api/my-account/identities/{target}
1 structure change including:
1 Modification
Modified 1 Breaking
POST /api/users/{userId}/mfa-verifications
  • Body
  • application/json content type Modified
    • alternative Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • object-1, object-2, object-3, object-4 alternatives Added
1 structure change including:
1 Modification
Modified 1
POST /api/authn/single-sign-on/saml/{connectorId}
  • Body
  • application/json content type Modified
    • RelayState property Modified
      • Property is no longer required
1 structure change including:
1 Addition
Added 1
GET /api/.well-known/user.openapi.json