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
1 structure change including:
1 Addition
Added 1
POST /api/sentinel-activities/delete
4 structure changes including:
4 Modifications
Modified 4
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sentinelPolicy property Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sentinelPolicy property Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sentinelPolicy property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • sentinelPolicy property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sentinelPolicy property Added
4 structure changes including:
4 Additions
Added 4
DELETE /api/one-time-tokens/{id}
GET /api/one-time-tokens
GET /api/one-time-tokens/{id}
PUT /api/one-time-tokens/{id}/status
1 structure change including:
1 Modification
Modified 1
POST /api/experience/verification/verification-code
  • Response
  • 422 response Added
5 structure changes including:
5 Modifications
Modified 5 Breaking
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • captchaPolicy property Modified
        • signIn, signUp, forgotPassword properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • enabled property Added
      • captchaConfig property Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • captchaPolicy property Modified
        • signIn, signUp, forgotPassword properties Removed
        • enabled property Added
      • captchaConfig property Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • captchaPolicy property Modified
        • signIn, signUp, forgotPassword properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • enabled property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • captchaPolicy property Modified
      • signIn, signUp, forgotPassword properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • enabled property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • captchaPolicy property Modified
        • signIn, signUp, forgotPassword properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • enabled property Added
PUT /api/experience
  • Body
  • application/json content type Modified
    • captchaToken property Added
  • Response
  • 422 response Added
4 structure changes including:
4 Modifications
Modified 4
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • signUp property Modified
        • secondaryIdentifiers property Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • signUp property Modified
        • secondaryIdentifiers property Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • signUp property Modified
        • secondaryIdentifiers property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • signUp property Modified
      • secondaryIdentifiers property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • signUp property Modified
        • secondaryIdentifiers property Added
2 structure changes including:
2 Modifications
Modified 2
GET /api/captcha-provider
  • Response
  • 200 response Modified
    • application/json content type Modified
      • config property Modified
        • object-2 alternative Modified
PUT /api/captcha-provider
  • Body
  • application/json content type Modified
    • config property Modified
      • object-2 alternative Modified
        • projectId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • config property Modified
        • object-2 alternative Modified
1 structure change including:
1 Addition
Added 1
POST /api/experience/verification/one-time-token/verify
3 structure changes including:
3 Additions
Added 3
DELETE /api/captcha-provider
GET /api/captcha-provider
PUT /api/captcha-provider
7 structure changes including:
1 Breaking change
2 Additions
4 Modifications
1 Removal
Modified 4
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • captchaPolicy property Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • captchaPolicy property Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • captchaPolicy property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • captchaPolicy property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • captchaPolicy property Added
Removed 1 Breaking
POST /api/one-time-tokens
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
POST /api/one-time-tokens
POST /api/one-time-tokens/verify
5 structure changes including:
1 Addition
4 Modifications
Modified 4
GET /api/.well-known/experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mfa property Modified
        • organizationRequiredMfaPolicy property Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mfa property Modified
        • organizationRequiredMfaPolicy property Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mfa property Modified
        • organizationRequiredMfaPolicy property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • mfa property Modified
      • organizationRequiredMfaPolicy property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • mfa property Modified
        • organizationRequiredMfaPolicy property Added
Added 1
POST /api/one-time-tokens
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