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
PUT /api/users/{userId}/identities/{target}
1 structure change including:
1 Modification
Modified 1
POST /api/applications
  • Response
  • 500 response Added
14 structure changes including:
14 Modifications
Modified 14
DELETE /api/applications/{id}
  • Response
  • 422 response Added
DELETE /api/applications/{id}/protected-app-metadata/custom-domains/{domain}
  • Response
  • 501 response Added
GET /api/applications/{id}/protected-app-metadata/custom-domains
  • Response
  • 501 response Added
GET /api/systems/application
  • Response
  • 501 response Added
PATCH /api/sso-connectors/{id}
  • Response
  • 409 response Added
POST /api/applications/{id}/protected-app-metadata/custom-domains
  • Response
  • 501 response Added
POST /api/authn/saml/{connectorId}
  • Response
  • 404 response Added
POST /api/interaction/submit
  • Response
  • 403 response Added
POST /api/interaction/verification/verification-code
  • Response
  • 501 response Added
POST /api/interaction/verification/webauthn-authentication
  • Response
  • 400 response Added
POST /api/sso-connectors
  • Response
  • 409 response Added
POST /api/verification-codes
  • Response
  • 501 response Added
PUT /api/applications/{applicationId}/sign-in-experience
  • Response
  • 422 response Added
PUT /api/organization-invitations/{id}/status
  • Response
  • 422 response Added
4 structure changes including:
1 Addition
3 Modifications
Modified 3 Breaking
GET /api/organization-invitations
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/organization-invitations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • magicLinkId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • organizationRoles property Added
POST /api/organization-invitations
  • Body
  • application/json content type Modified
    • messagePayload property Added
  • Query
  • skipEmail query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Added 1
PUT /api/organization-invitations/{id}/status
3 structure changes including:
1 Addition
2 Modifications
Modified 2
GET /api/organization-invitations
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/organization-invitations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • inviterId property Modified
        • Full types went from string to string | null
Added 1
POST /api/organization-invitations
8 structure changes including:
1 Addition
7 Modifications
Modified 7
GET /api/applications
  • Query
  • isThirdParty query parameter Modified
    • Full types went from string("true") to string("true") | string("false")
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/applications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata property Modified
GET /api/applications/{id}/protected-app-metadata/custom-domains
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/interaction/consent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • redirectUri property Added
GET /api/roles/{id}/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
PATCH /api/applications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata property Modified
POST /api/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata property Modified
Added 1
DELETE /api/applications/{id}/protected-app-metadata/custom-domains/{domain}
14 structure changes including:
8 Additions
6 Modifications
Modified 6 Breaking
GET /api/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/applications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata property Modified
GET /api/roles/{id}/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
PATCH /api/applications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata property Modified
POST /api/applications
  • Body
  • application/json content type Modified
    • protectedAppMetadata property Modified
      • host property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • subDomain property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata property Modified
POST /api/interaction/consent
  • Body
  • application/json content type Added
  • Response
  • 400 response Added
Added 8
DELETE /api/applications/{id}/users/{userId}/consent-organizations/{organizationId}
GET /api/applications/{id}/protected-app-metadata/custom-domains
GET /api/applications/{id}/users/{userId}/consent-organizations
GET /api/interaction/consent
GET /api/systems/application
POST /api/applications/{id}/protected-app-metadata/custom-domains
POST /api/applications/{id}/users/{userId}/consent-organizations
PUT /api/applications/{id}/users/{userId}/consent-organizations
3 structure changes including:
3 Additions
Added 3
DELETE /api/organization-invitations/{id}
GET /api/organization-invitations
GET /api/organization-invitations/{id}
1 structure change including:
1 Modification
Modified 1 Breaking
PATCH /api/applications/{id}
  • Body
  • application/json content type Modified
    • protectedAppMetadata property Modified
      • Full types went from object | null to object
        Breaking
      • pageRules property Modified
      • host property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
2 structure changes including:
2 Modifications
Modified 2
GET /api/configs/admin-console
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification property Modified
PATCH /api/configs/admin-console
  • Body
  • application/json content type Modified
    • checkedChargeNotification property Modified
      • token property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification property Modified
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /api/configs/admin-console
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification property Added
PATCH /api/configs/admin-console
  • Body
  • application/json content type Modified
    • checkedChargeNotification property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification property Added
POST /api/applications
  • Body
  • application/json content type Modified
    • protectedAppMetadata property Modified
      • Full types went from object | null to object
        Breaking
      • sessionDuration, pageRules properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
2 structure changes including:
2 Additions
Added 2
GET /api/applications/{applicationId}/sign-in-experience
PUT /api/applications/{applicationId}/sign-in-experience
8 structure changes including:
3 Additions
5 Modifications
Modified 5 Breaking
GET /api/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Query
  • excludeRoleId, isThirdParty query parameters Added
GET /api/applications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata, isThirdParty properties Added
GET /api/roles/{id}/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
PATCH /api/applications/{id}
  • Body
  • application/json content type Modified
    • secret, type properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • protectedAppMetadata property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata, isThirdParty properties Added
POST /api/applications
  • Body
  • application/json content type Modified
    • secret property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • protectedAppMetadata, isThirdParty properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata, isThirdParty properties Added
Added 3
DELETE /api/applications/{applicationId}/user-consent-scopes/{scopeType}/{scopeId}
GET /api/applications/{applicationId}/user-consent-scopes
POST /api/applications/{applicationId}/user-consent-scopes
18 structure changes including:
5 Breaking changes
5 Additions
8 Modifications
5 Removals
Modified 8 Breaking
GET /api/configs/oidc/{keyType}
  • Response
  • 404 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PATCH /api/hooks/{id}
  • Body
  • application/json content type Modified
    • event property Modified
      • Property is now deprecated
    • config property Modified
POST /api/authn/saml/{connectorId}
  • Operation is now deprecated
POST /api/authn/single-sign-on/saml/{connectorId}
  • Body
  • application/json content type Modified
    • SAMLResponse property Added
POST /api/connectors/{connectorId}/authorization-uri
  • Response
  • 200 response Modified
    • application/json content type Modified
      • redirectUri property Added
POST /api/connectors/{factoryId}/test
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204, 404 responses Added
POST /api/hooks
  • Body
  • application/json content type Modified
    • event property Modified
      • Property is now deprecated
    • config property Modified
POST /api/hooks/{id}/test
  • Body
  • application/json content type Modified
    • config property Modified
    • event property Added
Removed 5 Breaking
PATCH /api/sign-in-exp
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/sso-connector-factories
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/sign-in-exp
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/logs/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/logs
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 5
PATCH /api/sign-in-exp
GET /api/sso-connector-providers
GET /api/sign-in-exp
GET /api/logs/{id}
GET /api/logs
3 structure changes including:
3 Modifications
Modified 3
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • singleSignOnEnabled property Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • singleSignOnEnabled property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • singleSignOnEnabled property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • singleSignOnEnabled property Added
6 structure changes including:
1 Breaking change
5 Modifications
1 Removal
Modified 5
GET /api/sso-connector-factories
  • Response
  • 200 response Modified
    • application/json content type Modified
      • standardConnectors, providerConnectors properties Modified
GET /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding property Modified
      • name, providerLogoDark properties Added
GET /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding property Modified
      • name, providerLogoDark properties Added
PATCH /api/sso-connectors/{id}
  • Body
  • application/json content type Modified
    • branding property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding property Modified
      • name, providerLogoDark properties Added
POST /api/sso-connectors
  • Body
  • application/json content type Modified
    • branding property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding property Modified
Removed 1 Breaking
PATCH /api/sso-connectors/{id}/config
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
5 structure changes including:
1 Addition
4 Modifications
Modified 4 Breaking
GET /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerProperties property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerProperties property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PATCH /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerProperties property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PATCH /api/sso-connectors/{id}/config
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerProperties property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
Added 1
POST /api/interaction/single-sign-on/{connectorId}/registration
5 structure changes including:
1 Addition
4 Modifications
Modified 4
GET /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerProperties property Added
GET /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerProperties property Added
PATCH /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerProperties property Added
PATCH /api/sso-connectors/{id}/config
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerProperties property Added
  • Query
  • partialValidateConfig query parameter Added
Added 1
POST /api/authn/single-sign-on/saml/{connectorId}
21 structure changes including:
21 Modifications
Modified 21 Breaking
DELETE /api/configs/oidc/{keyType}/{keyId}
  • Path
  • keyId path parameter Added
DELETE /api/sso-connectors/{id}
  • Path
  • id path parameter Added
DELETE /api/users/{userId}/identities/{target}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Added
DELETE /api/users/{userId}/mfa-verifications/{verificationId}
  • Path
  • verificationId path parameter Added
GET /api/connector-factories/{id}
  • Path
  • id path parameter Added
GET /api/custom-phrases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • translation property Modified
GET /api/custom-phrases/{languageTag}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • translation property Modified
GET /api/organization-roles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • scopes property Added
  • 400 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • q query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/roles/{id}/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Added
GET /api/sso-connectors/{id}
  • Path
  • id path parameter Added
GET /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Added
GET /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Added
  • Query
  • includeSsoIdentities query parameter Added
PATCH /api/sso-connectors/{id}
  • Path
  • id path parameter Added
PATCH /api/sso-connectors/{id}/config
  • Path
  • id path parameter Added
PATCH /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Added
PATCH /api/users/{userId}/is-suspended
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Added
PATCH /api/users/{userId}/password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Added
POST /api/connectors/{factoryId}/test
  • Path
  • factoryId path parameter Added
POST /api/organization-roles
  • Body
  • application/json content type Modified
    • organizationScopeIds property Added
POST /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Added
PUT /api/custom-phrases/{languageTag}
  • Body
  • application/json content type Modified
    • [translationKey] property Modified
5 structure changes including:
5 Modifications
Modified 5
DELETE /api/organizations/{id}/users/{userId}
  • Response
  • 404 response Added
PATCH /api/organization-roles/{id}
  • Response
  • 422 response Added
PATCH /api/organization-scopes/{id}
  • Response
  • 422 response Added
POST /api/organization-roles
  • Response
  • 422 response Added
POST /api/organization-scopes
  • Response
  • 422 response Added