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
5 structure changes including:
5 Modifications
Modified 5 Breaking
GET /api/configs/jwt-customizer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1, object-2 alternatives Modified
GET /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1, object-2 alternatives Modified
PATCH /api/configs/jwt-customizer/{tokenTypePath}
  • Body
  • application/json content type Modified
    • envVars property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • environmentVariables property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1, object-2 alternatives Modified
POST /api/configs/jwt-customizer/test
  • Body
  • application/json content type Modified
    • object-1 alternative Modified
      • envVars property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • environmentVariables property Added
    • object-2 alternative Modified
      • envVars property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • environmentVariables property Added
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Body
  • application/json content type Modified
    • envVars property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • environmentVariables property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1, object-2 alternatives Modified
5 structure changes including:
1 Addition
4 Modifications
Modified 4 Breaking
GET /api/configs/jwt-customizer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
GET /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
POST /api/configs/jwt-customizer/test
  • Body
  • application/json content type Modified
    • object-1 alternative Modified
      • payload property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • envVars, script, token, context properties Added
    • object-2 alternative Modified
      • payload property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • envVars, script, token properties Added
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
Added 1
PATCH /api/configs/jwt-customizer/{tokenTypePath}
2 structure changes including:
1 Addition
1 Modification
Modified 1
POST /api/configs/jwt-customizer/test
  • Body
  • application/json content type Modified
    • object-1 alternative Modified
      • payload property Modified
Added 1
GET /api/configs/jwt-customizer
3 structure changes including:
3 Modifications
Modified 3
GET /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1, object-2 alternatives Modified
POST /api/configs/jwt-customizer/test
  • Body
  • application/json content type Modified
    • object-1 alternative Modified
      • payload property Modified
    • object-2 alternative Modified
      • payload property Modified
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1, object-2 alternatives Modified
4 structure changes including:
4 Modifications
Modified 4
GET /api/sso-connector-providers
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerType property Added
PATCH /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerType property Added
22 structure changes including:
2 Additions
20 Modifications
Modified 20 Breaking
PUT /api/users/{userId}/identities/{target}
  • Body
  • application/json content type Modified
    • details property Modified
      • Additional properties: property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Additional properties: property Modified
POST /api/users/{userId}/identities
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Additional properties: property Modified
POST /api/users
  • Body
  • application/json content type Modified
    • profile property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
      • updatedAt, profile properties Added
POST /api/roles/{id}/scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
POST /api/resources/{resourceId}/scopes
  • Body
  • application/json content type Modified
    • description property Modified
      • Full types went from string to string | null
      • Property is no longer required
      • description property Modified
        • Full types went from string to string | null
        • Property is no longer required
PATCH /api/users/{userId}/password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
      • updatedAt, profile properties Added
PATCH /api/users/{userId}/is-suspended
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
      • updatedAt, profile properties Added
PATCH /api/users/{userId}
  • Body
  • application/json content type Modified
    • profile property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
      • updatedAt, profile properties Added
PATCH /api/resources/{resourceId}/scopes/{scopeId}
  • Body
  • application/json content type Modified
    • description property Modified
      • Full types went from string to string | null
      • description property Modified
        • Full types went from string to string | null
  • Response
  • 200 response Modified
    • application/json content type Modified
      • description property Modified
        • Full types went from string to string | null
GET /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
      • updatedAt, profile properties Added
GET /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/roles/{id}/users
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/roles/{id}/scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/resources/{resourceId}/scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/resources
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/organizations/{id}/users
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/organization-invitations
  • Query
  • invitee query parameter Added
GET /api/interaction/consent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • missingResourceScopes property Modified
GET /api/applications/{applicationId}/user-consent-scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • resourceScopes property Modified
DELETE /api/users/{userId}/identities/{target}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
      • updatedAt, profile properties Added
Added 2
POST /api/configs/jwt-customizer/test
PATCH /api/users/{userId}/profile
2 structure changes including:
2 Modifications
Modified 2
POST /api/organization-invitations
  • Body
  • application/json content type Modified
    • messagePayload property Modified
      • object-2 alternative Modified
POST /api/organization-invitations/{id}/message
  • Body
  • application/json content type Modified
    • Additional properties: property Added
1 structure change including:
1 Modification
Modified 1
POST /api/interaction/single-sign-on/{connectorId}/authentication
  • Response
  • 422 response Added
4 structure changes including:
3 Additions
1 Modification
Modified 1
POST /api/users
  • Body
  • application/json content type Modified
    • avatar, customData properties Added
Added 3
DELETE /api/configs/jwt-customizer/{tokenTypePath}
GET /api/configs/jwt-customizer/{tokenTypePath}
PUT /api/configs/jwt-customizer/{tokenTypePath}
3 structure changes including:
1 Addition
2 Modifications
Modified 2 Breaking
GET /api/organization-invitations
  • Query
  • q, page, page_size query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • organizationId, inviterId query parameters Added
POST /api/organization-invitations
  • Response
  • 422 response Added
Added 1
POST /api/organization-invitations/{id}/message
1 structure change including:
1 Modification
Modified 1
POST /api/users
  • Body
  • application/json content type Modified
    • passwordDigest, passwordAlgorithm properties Added
1 structure change including:
1 Modification
Modified 1
POST /api/roles
  • Response
  • 404 response Added
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}