Change Updates

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
2 structure changes including:
2 Modifications
Modified 2
GET /api/hooks/{id}/recent-logs
  • Query
  • start_time, end_time query parameters Added
GET /api/logs
  • Query
  • start_time, end_time query parameters Added
2 structure changes including:
2 Modifications
Modified 2
GET /api/hooks/{id}/recent-logs
  • Query
  • enableCap query parameter Added
GET /api/logs
  • Query
  • enableCap query parameter Added
10 structure changes including:
1 Addition
9 Modifications
Modified 9 Breaking
GET /api/.well-known/account-center
  • Response
  • 200 response Modified
    • application/json content type Modified
      • profileFields property Added
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customUiCsp property Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customUiCsp property Added
GET /api/account-center
  • Response
  • 200 response Modified
    • application/json content type Modified
      • profileFields property Added
GET /api/my-account/sessions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sessions property Modified
        • isCurrent property Modified
          • Property is now required
            Breaking
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customUiCsp property Added
PATCH /api/account-center
  • Body
  • application/json content type Modified
    • profileFields property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • profileFields property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • customUiCsp property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customUiCsp property Added
POST /api/my-account/identities
  • Response
  • 422 response Added
Added 1
PUT /api/my-account/identities
1 structure change including:
1 Modification
Modified 1
GET /api/my-account/sessions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sessions property Modified
        • isCurrent property Added
4 structure changes including:
4 Modifications
Modified 4
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • signUpProfileFields property Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • signUpProfileFields property Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • signUpProfileFields property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • signUpProfileFields property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • signUpProfileFields property Added
2 structure changes including:
2 Modifications
Modified 2
GET /api/configs/oidc/{keyType}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • effectiveAt property Added
POST /api/configs/oidc/{keyType}/rotate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • effectiveAt property Added
2 structure changes including:
1 Addition
1 Modification
Modified 1
POST /api/configs/oidc/{keyType}/rotate
  • Body
  • application/json content type Modified
    • rotationGracePeriod property Added
Added 1
POST /api/domains/cleanup
4 structure changes including:
4 Modifications
Modified 4
GET /api/configs/oidc/{keyType}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status property Added
POST /api/configs/oidc/{keyType}/rotate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status property Added
POST /api/organizations/{id}/users
  • Response
  • 201 response Modified
    • application/json content type Modified
      • Type is now object
      • property Added
POST /api/organizations/{id}/users/{userId}/roles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • Type is now object
      • property Added
7 structure changes including:
7 Modifications
Modified 7
GET /api/.well-known/account-center
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customCss property Added
GET /api/account-center
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customCss property Added
GET /api/configs/jwt-customizer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • property Modified
        • object-1, object-2 alternatives Modified
GET /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1, object-2 alternatives Modified
PATCH /api/account-center
  • Body
  • application/json content type Modified
    • customCss property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customCss property Added
PATCH /api/configs/jwt-customizer/{tokenTypePath}
  • Body
  • application/json content type Modified
    • blockIssuanceOnError property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1, object-2 alternatives Modified
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Body
  • application/json content type Modified
    • blockIssuanceOnError property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1, object-2 alternatives Modified
  • 201 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1, object-2 alternatives Modified
3 structure changes including:
3 Modifications
Modified 3
GET /api/.well-known/account-center
  • Response
  • 200 response Modified
    • application/json content type Modified
      • deleteAccountUrl property Added
GET /api/account-center
  • Response
  • 200 response Modified
    • application/json content type Modified
      • deleteAccountUrl property Added
PATCH /api/account-center
  • Body
  • application/json content type Modified
    • deleteAccountUrl property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • deleteAccountUrl property Added
3 structure changes including:
3 Additions
Added 3
DELETE /api/my-account/grants/{grantId}
GET /api/my-account/grants
PUT /api/my-account/mfa-verifications/totp
8 structure changes including:
8 Modifications
Modified 8
GET /api/configs/jwt-customizer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • property Modified
        • object-1 alternative Modified
GET /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1 alternative Modified
GET /api/my-account/sessions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sessions property Modified
        • lastSubmission property Modified
GET /api/users/{userId}/sessions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sessions property Modified
        • lastSubmission property Modified
GET /api/users/{userId}/sessions/{sessionId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lastSubmission property Modified
        • verificationRecords property Modified
PATCH /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1 alternative Modified
POST /api/configs/jwt-customizer/test
  • Body
  • application/json content type Modified
    • property Modified
      • object-1 property Modified
        • context property Modified
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1 alternative Modified
  • 201 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1 alternative Modified
12 structure changes including:
12 Modifications
Modified 12
DELETE /api/applications/{id}/legacy-secret
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
        • maxAllowedGrants property Added
GET /api/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
        • maxAllowedGrants property Added
GET /api/applications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
        • maxAllowedGrants property Added
GET /api/configs/jwt-customizer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • property Modified
        • object-1, object-2 alternatives Modified
GET /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1, object-2 alternatives Modified
GET /api/organizations/{id}/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
        • maxAllowedGrants property Added
GET /api/roles/{id}/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
        • maxAllowedGrants property Added
PATCH /api/applications/{id}
  • Body
  • application/json content type Modified
    • customClientMetadata property Modified
      • maxAllowedGrants property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
        • maxAllowedGrants property Added
PATCH /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1, object-2 alternatives Modified
POST /api/applications
  • Body
  • application/json content type Modified
    • customClientMetadata property Modified
      • maxAllowedGrants property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
        • maxAllowedGrants property Added
POST /api/configs/jwt-customizer/test
  • Body
  • application/json content type Modified
    • property Modified
      • object-1 property Modified
        • context property Modified
      • object-2 property Modified
        • context property Modified
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1, object-2 alternatives Modified
  • 201 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1, object-2 alternatives Modified
3 structure changes including:
3 Modifications
Modified 3
GET /api/my-account/sessions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sessions property Modified
        • payload property Modified
GET /api/users/{userId}/sessions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sessions property Modified
        • payload property Modified
GET /api/users/{userId}/sessions/{sessionId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • payload property Modified
        • authorizations property Modified
          • Property is no longer required
8 structure changes including:
2 Additions
6 Modifications
Modified 6
GET /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • passwordDigest, passwordAlgorithm properties Added
GET /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • passwordDigest, passwordAlgorithm properties Added
  • Query
  • includePasswordHash query parameter Added
PATCH /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • passwordDigest, passwordAlgorithm properties Added
PATCH /api/users/{userId}/is-suspended
  • Response
  • 200 response Modified
    • application/json content type Modified
      • passwordDigest, passwordAlgorithm properties Added
PATCH /api/users/{userId}/password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • passwordDigest, passwordAlgorithm properties Added
POST /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • passwordDigest, passwordAlgorithm properties Added
Added 2
DELETE /api/users/{userId}/grants/{grantId}
GET /api/users/{userId}/grants
2 structure changes including:
2 Breaking changes
2 Removals
Removed 2 Breaking
DELETE /api/users/{userId}/grants/{grantId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/users/{userId}/grants
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
2 structure changes including:
2 Additions
Added 2
DELETE /api/users/{userId}/grants/{grantId}
GET /api/users/{userId}/grants
2 structure changes including:
2 Additions
Added 2
GET /api/configs/oidc/session
PATCH /api/configs/oidc/session
8 structure changes including:
3 Breaking changes
3 Additions
2 Modifications
3 Removals
Modified 2
PATCH /api/my-account/logto-configs
  • Body
  • application/json content type Modified
    • mfa property Modified
      • additionalBindingSuggestionSkipped property Added
PATCH /api/users/{userId}/logto-configs
  • Body
  • application/json content type Modified
    • mfa property Modified
      • additionalBindingSuggestionSkipped property Added
Removed 3 Breaking
POST /api/experience/preflight/sign-in-web-authn/authentication
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/experience/verification/sign-in-web-authn/authentication
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/experience/verification/sign-in-web-authn/authentication/verify
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 3
POST /api/experience/preflight/sign-in-passkey/authentication
POST /api/experience/verification/sign-in-passkey/authentication
POST /api/experience/verification/sign-in-passkey/authentication/verify
12 structure changes including:
12 Modifications
Modified 12
DELETE /api/applications/{id}/legacy-secret
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
        • isDeviceFlow property Added
GET /api/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
        • isDeviceFlow property Added
GET /api/applications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
        • isDeviceFlow property Added
GET /api/configs/jwt-customizer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • property Modified
        • object-1, object-2 alternatives Modified
GET /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1, object-2 alternatives Modified
GET /api/organizations/{id}/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
        • isDeviceFlow property Added
GET /api/roles/{id}/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
        • isDeviceFlow property Added
PATCH /api/applications/{id}
  • Body
  • application/json content type Modified
    • customClientMetadata property Modified
      • isDeviceFlow property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
        • isDeviceFlow property Added
PATCH /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1, object-2 alternatives Modified
POST /api/applications
  • Body
  • application/json content type Modified
    • customClientMetadata property Modified
      • isDeviceFlow property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
        • isDeviceFlow property Added
POST /api/configs/jwt-customizer/test
  • Body
  • application/json content type Modified
    • property Modified
      • object-1 property Modified
        • context property Modified
      • object-2 property Modified
        • context property Modified
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1, object-2 alternatives Modified
  • 201 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-1, object-2 alternatives Modified