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
10 structure changes including:
6 Breaking changes
1 Addition
4 Modifications
5 Removals
Modified 4 Breaking
GET /api/users/{userId}/sso-identities/{ssoConnectorId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentity, tokenSecret properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • enterpriseSsoIdentity, tokenSet properties Added
  • Query
  • includeTokenSecret query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/custom-profile-fields/sie-order
  • Path went from /api/custom-profile-fields/properties/sie-order to /api/custom-profile-fields/sie-order (same operationId)
    Breaking
POST /api/interaction/verification/social-authorization-uri
  • Body
  • application/json content type Modified
    • scope property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/verifications/social
  • Body
  • application/json content type Modified
    • scope property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
Removed 5 Breaking
DELETE /api/secrets/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/experience/interaction
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/users/{userId}/all-identities
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/users/{userId}/identities/{target}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/my-account/identities/{target}/access-token
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /api/users/{userId}/identities/{target}/secret
10 structure changes including:
2 Breaking changes
5 Additions
4 Modifications
1 Removal
Modified 4 Breaking
GET /api/users/{userId}/sso-identities/{ssoConnectorId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enterpriseSsoIdentity, tokenSet properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ssoIdentity, tokenSecret properties Added
  • Query
  • includeTokenSecret query parameter Added
POST /api/custom-profile-fields/properties/sie-order
  • Path went from /api/custom-profile-fields/sie-order to /api/custom-profile-fields/properties/sie-order (same operationId)
    Breaking
POST /api/interaction/verification/social-authorization-uri
  • Body
  • application/json content type Modified
    • scope property Added
POST /api/verifications/social
  • Body
  • application/json content type Modified
    • scope property Added
Removed 1 Breaking
GET /api/users/{userId}/identities/{target}/secret
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 5
DELETE /api/secrets/{id}
GET /api/experience/interaction
GET /api/users/{userId}/all-identities
GET /api/users/{userId}/identities/{target}
PUT /api/my-account/identities/{target}/access-token
5 structure changes including:
3 Breaking changes
1 Addition
2 Modifications
2 Removals
Modified 2 Breaking
GET /api/users/{userId}/sso-identities/{ssoConnectorId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentity, tokenSecret properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • enterpriseSsoIdentity, tokenSet properties Added
  • Query
  • includeTokenSecret query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/custom-profile-fields/sie-order
  • Path went from /api/custom-profile-fields/properties/sie-order to /api/custom-profile-fields/sie-order (same operationId)
    Breaking
Removed 2 Breaking
GET /api/users/{userId}/all-identities
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/users/{userId}/identities/{target}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /api/users/{userId}/identities/{target}/secret
5 structure changes including:
2 Breaking changes
2 Additions
2 Modifications
1 Removal
Modified 2 Breaking
GET /api/users/{userId}/sso-identities/{ssoConnectorId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enterpriseSsoIdentity, tokenSet properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ssoIdentity, tokenSecret properties Added
  • Query
  • includeTokenSecret query parameter Added
POST /api/custom-profile-fields/properties/sie-order
  • Path went from /api/custom-profile-fields/sie-order to /api/custom-profile-fields/properties/sie-order (same operationId)
    Breaking
Removed 1 Breaking
GET /api/users/{userId}/identities/{target}/secret
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
GET /api/users/{userId}/all-identities
GET /api/users/{userId}/identities/{target}
3 structure changes including:
3 Modifications
Modified 3 Breaking
POST /api/experience/verification/social/{connectorId}/verify
  • Body
  • application/json content type Modified
    • isExternalWebsiteGoogleOneTap property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/experience/verification/sso/{connectorId}/verify
  • Body
  • application/json content type Modified
    • isExternalWebsiteGoogleOneTap property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/verifications/social/verify
  • Body
  • application/json content type Modified
    • isExternalWebsiteGoogleOneTap property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
3 structure changes including:
3 Modifications
Modified 3
POST /api/experience/verification/social/{connectorId}/verify
  • Body
  • application/json content type Modified
    • isExternalWebsiteGoogleOneTap property Added
POST /api/experience/verification/sso/{connectorId}/verify
  • Body
  • application/json content type Modified
    • isExternalWebsiteGoogleOneTap property Added
POST /api/verifications/social/verify
  • Body
  • application/json content type Modified
    • isExternalWebsiteGoogleOneTap property Added
3 structure changes including:
3 Modifications
Modified 3 Breaking
POST /api/experience/verification/social/{connectorId}/verify
  • Body
  • application/json content type Modified
    • isExternalWebsiteGoogleOneTap property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/experience/verification/sso/{connectorId}/verify
  • Body
  • application/json content type Modified
    • isExternalWebsiteGoogleOneTap property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/verifications/social/verify
  • Body
  • application/json content type Modified
    • isExternalWebsiteGoogleOneTap property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
3 structure changes including:
3 Modifications
Modified 3
POST /api/experience/verification/social/{connectorId}/verify
  • Body
  • application/json content type Modified
    • isExternalWebsiteGoogleOneTap property Added
POST /api/experience/verification/sso/{connectorId}/verify
  • Body
  • application/json content type Modified
    • isExternalWebsiteGoogleOneTap property Added
POST /api/verifications/social/verify
  • Body
  • application/json content type Modified
    • isExternalWebsiteGoogleOneTap property Added
5 structure changes including:
5 Modifications
Modified 5 Breaking
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
PATCH /api/my-account/mfa-settings
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
POST /api/connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • enableTokenStorage property Added
2 structure changes including:
2 Additions
Added 2
GET /api/my-account/identities/{target}/access-token
GET /api/my-account/sso-identities/{connectorId}/access-token
1 structure change including:
1 Breaking change
1 Removal
Removed 1 Breaking
POST /api/my-account/mfa-verifications/totp/verify
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
7 structure changes including:
1 Breaking change
1 Addition
5 Modifications
1 Removal
Modified 5
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
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
Removed 1 Breaking
POST /api/experience/verification/google-one-tap/verify
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
POST /api/my-account/mfa-verifications/totp/verify
1 structure change including:
1 Modification
Modified 1
POST /api/experience/verification/google-one-tap/verify
  • Response
  • 422 response Added
1 structure change including:
1 Modification
Modified 1
POST /api/experience/verification/google-one-tap/verify
  • Response
  • 200 response Modified
    • application/json content type Modified
      • verifiedEmail property Added
6 structure changes including:
1 Breaking change
5 Modifications
1 Removal
Modified 5
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
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
Removed 1 Breaking
POST /api/my-account/mfa-verifications/totp/verify
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
6 structure changes including:
1 Addition
5 Modifications
Modified 5
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
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
Added 1
POST /api/experience/verification/google-one-tap/verify
12 structure changes including:
1 Addition
11 Modifications
Modified 11
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/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/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
        • contextSample property Modified
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/configs/jwt-customizer/test
  • Body
  • application/json content type Modified
    • object-1 property Modified
      • context property Modified
        • interaction property Modified
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
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
Added 1
GET /api/users/{userId}/sso-identities/{ssoConnectorId}
4 structure changes including:
1 Addition
3 Modifications
Modified 3 Breaking
GET /api/my-account/mfa-settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • requireMfaOnSignIn property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • skipMfaOnSignIn property Added
PATCH /api/my-account
  • Body
  • application/json content type Modified
    • customData property Added
PATCH /api/my-account/mfa-settings
  • Body
  • application/json content type Modified
    • requireMfaOnSignIn property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • skipMfaOnSignIn property Added
Added 1
POST /api/my-account/mfa-verifications/totp/verify
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /api/my-account/mfa-settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • skipMfaOnSignIn property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • requireMfaOnSignIn property Added
PATCH /api/my-account/mfa-settings
  • Body
  • application/json content type Modified
    • skipMfaOnSignIn property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • requireMfaOnSignIn property Added
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /api/my-account/mfa-settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • requireMfaOnSignIn property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • skipMfaOnSignIn property Added
PATCH /api/my-account/mfa-settings
  • Body
  • application/json content type Modified
    • requireMfaOnSignIn property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • skipMfaOnSignIn property Added