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
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
10 structure changes including:
10 Modifications
Modified 10 Breaking
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/one-time-tokens
  • Response
  • 200 response Modified
    • application/json content type Modified
      • context property Modified
        • googleIdentitySub property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/one-time-tokens/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • context property Modified
        • googleIdentitySub property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
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
POST /api/one-time-tokens
  • Body
  • application/json content type Modified
    • context property Modified
      • googleIdentitySub property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • context property Modified
        • googleIdentitySub property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /api/one-time-tokens/verify
  • Response
  • 200 response Modified
    • application/json content type Modified
      • context property Modified
        • googleIdentitySub property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
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
PUT /api/one-time-tokens/{id}/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • context property Modified
        • googleIdentitySub property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
10 structure changes including:
10 Modifications
Modified 10
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/one-time-tokens
  • Response
  • 200 response Modified
    • application/json content type Modified
      • context property Modified
        • googleIdentitySub property Added
GET /api/one-time-tokens/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • context property Modified
        • googleIdentitySub property Added
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
POST /api/one-time-tokens
  • Body
  • application/json content type Modified
    • context property Modified
      • googleIdentitySub property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • context property Modified
        • googleIdentitySub property Added
POST /api/one-time-tokens/verify
  • Response
  • 200 response Modified
    • application/json content type Modified
      • context property Modified
        • googleIdentitySub 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
PUT /api/one-time-tokens/{id}/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • context property Modified
        • googleIdentitySub property Added
4 structure changes including:
1 Breaking change
3 Additions
1 Removal
Removed 1 Breaking
GET /api/google-one-tap/verify
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 3
GET /api/my-account/mfa-settings
GET /api/users/{userId}/identities/{target}/secret
PATCH /api/my-account/mfa-settings
9 structure changes including:
1 Breaking change
1 Addition
8 Modifications
Modified 8 Breaking
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customProfileFields property Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customProfileFields property Added
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
POST /api/google-one-tap/verify
  • Verb went from GET to POST (same operationId)
    Breaking
  • Query
  • idToken query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Body
  • application/json content type 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/google-one-tap/verify
1 structure change including:
1 Breaking change
1 Modification
Modified 1 Breaking
GET /api/google-one-tap/verify
  • Verb went from POST to GET (same operationId)
    Breaking
  • Body
  • application/json content type Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • idToken query parameter Added
8 structure changes including:
8 Modifications
Modified 8
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • socialConnectors property Modified
        • isTokenStorageSupported property Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • socialConnectors property Modified
        • isTokenStorageSupported 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
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
POST /api/connectors
  • Body
  • application/json content type Modified
    • enableTokenStorage property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isTokenStorageSupported property Added
1 structure change including:
1 Addition
Added 1
GET /api/my-account/mfa-verifications/backup-codes
2 structure changes including:
1 Addition
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
Added 1
POST /api/my-account/mfa-verifications/backup-codes/generate
7 structure changes including:
7 Additions
Added 7
DELETE /api/custom-profile-fields/{name}
GET /api/custom-profile-fields
GET /api/custom-profile-fields/{name}
POST /api/custom-profile-fields
POST /api/custom-profile-fields/sie-order
POST /api/my-account/mfa-verifications/totp-secret/generate
PUT /api/custom-profile-fields/{name}
2 structure changes including:
2 Additions
Added 2
GET /api/google-one-tap/config
POST /api/google-one-tap/verify
5 structure changes including:
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 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
19 structure changes including:
6 Additions
13 Modifications
Modified 13
POST /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
        • updatedAt 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/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/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}
2 structure changes including:
2 Modifications
Modified 2
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • emailBlocklistPolicy property Modified
        • blockDisposableAddress property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • emailBlocklistPolicy property Modified
      • blockDisposableAddress property Added
2 structure changes including:
2 Modifications
Modified 2
POST /api/my-account/primary-email
  • Response
  • 422 response Added
POST /api/my-account/primary-phone
  • Response
  • 422 response Added