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
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
3 structure changes including:
3 Modifications
Modified 3 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
7 structure changes including:
6 Additions
1 Modification
Modified 1
POST /api/user-assets
  • Body
  • multipart/form-data content type 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
12 structure changes including:
12 Additions
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
1 structure change including:
1 Modification
Modified 1 Breaking
PUT /api/interaction/profile
  • Response
  • 422 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
1 structure change including:
1 Modification
Modified 1
PUT /api/interaction/profile
  • Response
  • 422 response Added
14 structure changes including:
10 Breaking changes
4 Additions
8 Modifications
2 Removals
Modified 8 Breaking
DELETE /api/my-account/identities/{target}
  • Path went from /api/profile/identities/{target} to /api/my-account/identities/{target} (same operationId)
    Breaking
  • Query
  • verificationRecordId query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/my-account
  • Path went from /api/profile to /api/my-account (same operationId)
    Breaking
PATCH /api/my-account
  • Path went from /api/profile to /api/my-account (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • username property Modified
      • Type went from string(regex) to string(regex) | null
PATCH /api/my-account/profile
  • Path went from /api/profile/profile to /api/my-account/profile (same operationId)
    Breaking
POST /api/my-account/identities
  • Path went from /api/profile/identities to /api/my-account/identities (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • verificationRecordId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/my-account/password
  • Path went from /api/profile/password to /api/my-account/password (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • verificationRecordId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/my-account/primary-email
  • Path went from /api/profile/primary-email to /api/my-account/primary-email (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • verificationRecordId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/my-account/primary-phone
  • Path went from /api/profile/primary-phone to /api/my-account/primary-phone (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • verificationRecordId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
Removed 2 Breaking
GET /api/account-center
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/account-center
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 4
DELETE /api/my-account/primary-email
DELETE /api/my-account/primary-phone
GET /api/account-center
PATCH /api/account-center
4 structure changes including:
4 Modifications
Modified 4
GET /api/.well-known/experience
  • 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/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • supportEmail, supportWebsiteUrl, unknownSessionRedirectUrl properties Added
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
2 structure changes including:
2 Additions
Added 2
GET /api/account-center
PATCH /api/account-center
2 structure changes including:
1 Addition
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
Added 1
DELETE /api/profile/identities/{target}
3 structure changes including:
3 Additions
Added 3
POST /api/profile/identities
POST /api/verifications/social
POST /api/verifications/social/verify
3 structure changes including:
1 Addition
2 Modifications
Modified 2
POST /api/verifications/password
  • Response
  • 201 response Modified
    • application/json content type Modified
      • expiresAt property Added
POST /api/verifications/verification-code
  • Response
  • 201 response Modified
    • application/json content type Modified
      • expiresAt property Added
Added 1
POST /api/profile/primary-phone
6 structure changes including:
4 Additions
2 Modifications
Modified 2
POST /api/authn/single-sign-on/saml/{connectorId}
  • Body
  • application/json content type Modified
    • RelayState property Modified
      • Property is no longer required
POST /api/profile/password
  • Response
  • 422 response Added
Added 4
DELETE /api/sso-connectors/{id}/idp-initiated-auth-config
GET /api/sso-connectors/{id}/idp-initiated-auth-config
PATCH /api/profile/profile
PUT /api/sso-connectors/{id}/idp-initiated-auth-config
5 structure changes including:
5 Additions
Added 5
GET /api/profile
PATCH /api/profile
POST /api/profile/primary-email
POST /api/verifications/verification-code
POST /api/verifications/verification-code/verify
3 structure changes including:
3 Additions
Added 3
GET /api/.well-known/user.openapi.json
POST /api/profile/password
POST /api/verifications/password
3 structure changes including:
2 Breaking changes
1 Addition
2 Modifications
Modified 2 Breaking
POST /api/experience/profile
  • Path went from /api/users/{userId}/profile to /api/experience/profile (same operationId)
    Breaking
  • Verb went from PATCH to POST (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • object alternative Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • object-1, object-2, object-3, object-4, object-5 alternatives Added
  • Path
  • userId path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200, 401 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204, 422 responses Added
  • Authentication
  • OAuth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/experience/verification/verification-code/verify
  • Path went from /api/verification-codes/verify to /api/experience/verification/verification-code/verify (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • object property Modified
      • Removing polymorphism is always breaking
        Breaking
  • Response
  • 204, 401, 403 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200, 404, 501 responses Added
  • Authentication
  • OAuth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Added 1
POST /api/sign-in-exp/default/check-password
7 structure changes including:
3 Additions
4 Modifications
Modified 4
GET /api/.well-known/sign-in-exp
  • Operation is now deprecated
GET /api/hooks/{id}/recent-logs
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/logs
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/logs/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • payload property Modified
Added 3
GET /api/.well-known/experience
GET /api/.well-known/experience.openapi.json
GET /api/.well-known/management.openapi.json
2 structure changes including:
1 Breaking change
1 Addition
1 Removal
Removed 1 Breaking
GET /api/experience/verification/sso/connectors
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /api/experience/sso-connectors
25 structure changes including:
25 Additions
Added 25
GET /api/experience/verification/sso/connectors
POST /api/experience/identification
POST /api/experience/profile
POST /api/experience/profile/mfa
POST /api/experience/profile/mfa/mfa-skipped
POST /api/experience/submit
POST /api/experience/verification/backup-code/generate
POST /api/experience/verification/backup-code/verify
POST /api/experience/verification/new-password-identity
POST /api/experience/verification/password
POST /api/experience/verification/social/{connectorId}/authorization-uri
POST /api/experience/verification/social/{connectorId}/verify
POST /api/experience/verification/sso/{connectorId}/authorization-uri
POST /api/experience/verification/sso/{connectorId}/verify
POST /api/experience/verification/totp/secret
POST /api/experience/verification/totp/verify
POST /api/experience/verification/verification-code
POST /api/experience/verification/verification-code/verify
POST /api/experience/verification/web-authn/authentication
POST /api/experience/verification/web-authn/authentication/verify
POST /api/experience/verification/web-authn/registration
POST /api/experience/verification/web-authn/registration/verify
PUT /api/experience
PUT /api/experience/interaction-event
PUT /api/experience/profile/password