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
7 structure changes including:
7 Modifications
Modified 7
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • captchaConfig property Modified
        • domain, mode properties Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • captchaConfig property Modified
        • domain, mode properties Added
GET /api/captcha-provider
  • Response
  • 200 response Modified
    • application/json content type Modified
      • config property Modified
        • object-2 alternative Modified
GET /api/my-account/mfa-verifications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lastUsedAt property Added
GET /api/users/{userId}/mfa-verifications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lastUsedAt property Added
POST /api/my-account/mfa-verifications
  • Body
  • application/json content type Modified
    • alternative Modified
      • object-2 alternative Modified
        • code property Added
      • object-5 alternative Modified
        • code property Added
PUT /api/captcha-provider
  • Body
  • application/json content type Modified
    • config property Modified
      • object-2 alternative Modified
        • domain, mode properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • config property Modified
        • object-2 alternative Modified
2 structure changes including:
2 Modifications
Modified 2
GET /api/saml/{id}/authn
  • Query
  • RelayState query parameter Modified
    • Type went from string to string | null
POST /api/saml/{id}/authn
  • Body
  • application/json content type Modified
    • RelayState property Modified
      • Type went from string to string | null
1 structure change including:
1 Modification
Modified 1
PATCH /api/applications/{id}
  • Body
  • application/json content type Modified
    • protectedAppMetadata property Modified
      • Type went from object to object | null
3 structure changes including:
3 Modifications
Modified 3
GET /api/domains
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
GET /api/domains/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
POST /api/domains
  • Response
  • 201 response Modified
    • application/json content type Modified
      • createdAt property Added
4 structure changes including:
4 Modifications
Modified 4
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • hideLogtoBranding property Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • hideLogtoBranding property Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • hideLogtoBranding property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • hideLogtoBranding property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • hideLogtoBranding property Added
3 structure changes including:
2 Additions
1 Modification
Modified 1 Breaking
PATCH /api/users/{userId}/personal-access-tokens/{name}
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Added 2
PATCH /api/users/{userId}/personal-access-tokens
POST /api/users/{userId}/personal-access-tokens/delete
4 structure changes including:
4 Additions
Added 4
GET /api/my-account/logto-configs
GET /api/users/{userId}/logto-configs
PATCH /api/my-account/logto-configs
PATCH /api/users/{userId}/logto-configs
22 structure changes including:
22 Breaking changes
22 Removals
Removed 22 Breaking
DELETE /api/interaction
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/interaction/profile
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/interaction/consent
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/interaction/single-sign-on/connectors
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/interaction/identifiers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/interaction/profile
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/interaction/bind-mfa
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/interaction/consent
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/interaction/single-sign-on/{connectorId}/authentication
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/interaction/single-sign-on/{connectorId}/authorization-url
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/interaction/single-sign-on/{connectorId}/registration
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/interaction/submit
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/interaction/verification/social-authorization-uri
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/interaction/verification/totp
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/interaction/verification/verification-code
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/interaction/verification/webauthn-authentication
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/interaction/verification/webauthn-registration
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/interaction
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/interaction/event
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/interaction/mfa
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/interaction/mfa-skipped
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/interaction/profile
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
3 structure changes including:
3 Modifications
Modified 3
POST /api/organization-invitations
  • Body
  • application/json content type Modified
    • messagePayload property Modified
      • object-1 alternative Modified
        • uiLocales property Added
POST /api/organization-invitations/{id}/message
  • Body
  • application/json content type Modified
    • uiLocales property Added
POST /api/verifications/verification-code
  • Body
  • application/json content type Modified
    • templateType property Added
      • string-1, string-2 properties Added
3 structure changes including:
3 Additions
Added 3
GET /api/my-account/mfa-settings
PATCH /api/my-account/mfa-settings
POST /api/experience/profile/mfa/mfa-suggestion-skipped
6 structure changes including:
6 Modifications
Modified 6
GET /api/configs/jwt-customizer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
        • value property Modified
GET /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
        • contextSample property Modified
GET /api/experience/interaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mfa property Modified
        • webAuthn property Modified
PATCH /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
        • contextSample property Modified
POST /api/configs/jwt-customizer/test
  • Body
  • application/json content type Modified
    • object-1 property Modified
      • context property Modified
        • interaction property Modified
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
9 structure changes including:
9 Modifications
Modified 9
GET /api/applications/{applicationId}/sign-in-experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customCss property Added
GET /api/applications/{id}/organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • color, customCss properties Added
GET /api/applications/{id}/users/{userId}/consent-organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • organizations property Modified
        • color, customCss properties Added
GET /api/organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • color, customCss properties Added
GET /api/organizations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • color, customCss properties Added
GET /api/users/{userId}/organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • color, customCss properties Added
PATCH /api/organizations/{id}
  • Body
  • application/json content type Modified
    • color, customCss properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • color, customCss properties Added
POST /api/organizations
  • Body
  • application/json content type Modified
    • color, customCss properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • color, customCss properties Added
PUT /api/applications/{applicationId}/sign-in-experience
  • Body
  • application/json content type Modified
    • customCss property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customCss property Added
  • 201 response Modified
    • application/json content type Modified
      • customCss property Added
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