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
Logto API references

Change #0247f3b5

Last update:
Compare

API structure has changed

33 structure changes including:
4 Additions
29 Modifications
Modified 29 Breaking
DELETE /api/users/{userId}/identities/{target}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities attribute Modified
      • updatedAt, profile attributes Added
GET /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerType attribute Added
GET /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities attribute Modified
      • updatedAt, profile attributes Added
PATCH /api/configs/admin-console
  • Body
  • application/json content type Modified
    • checkedChargeNotification attribute Modified
      • tenantMember property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification attribute Modified
PATCH /api/resources/{resourceId}/scopes/{scopeId}
  • Body
  • application/json content type Modified
    • description attribute Modified

      • Type went from string to string | null

      • description property Modified

        • Type went from string to string | null

  • Response
  • 200 response Modified
    • application/json content type Modified
      • description attribute Modified

        • Type went from string to string | null

PATCH /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerType attribute Added
PATCH /api/users/{userId}
  • Body
  • application/json content type Modified
    • profile attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities attribute Modified
      • updatedAt, profile attributes Added
PATCH /api/users/{userId}/is-suspended
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities attribute Modified
      • updatedAt, profile attributes Added
PATCH /api/users/{userId}/password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities attribute Modified
      • updatedAt, profile attributes Added
POST /api/organization-roles
  • Body
  • application/json content type Modified
    • resourceScopeIds attribute Added
POST /api/resources/{resourceId}/scopes
  • Body
  • application/json content type Modified
    • description attribute Modified

      • Attribute is no longer required

      • Type went from string to string | null

      • description property Modified

        • Property is no longer required

        • Type went from string to string | null

POST /api/roles/{id}/scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
POST /api/users
  • Body
  • application/json content type Modified
    • profile attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities attribute Modified
      • updatedAt, profile attributes Added
POST /api/users/{userId}/identities
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Additional properties: attribute Modified
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Body
  • application/json content type Modified
    • envVars attribute Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • environmentVariables attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1, object-2 alternatives Modified
PUT /api/users/{userId}/identities/{target}
  • Body
  • application/json content type Modified
    • details attribute 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: attribute Modified
GET /api/applications/{applicationId}/user-consent-scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • resourceScopes attribute Modified
GET /api/configs/admin-console
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification attribute Modified
GET /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1, object-2 alternatives Modified
GET /api/interaction/consent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • missingResourceScopes attribute Modified
GET /api/organization-roles
  • Query
  • q query parameter Added
  • Response
  • 400 response Added
GET /api/organizations/{id}/users
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/resources
  • 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/roles/{id}/scopes
  • 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/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
Added 4
POST /api/configs/jwt-customizer/test
PATCH /api/users/{userId}/profile
PATCH /api/configs/jwt-customizer/{tokenTypePath}
GET /api/configs/jwt-customizer