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

Changelog

Last update:
Compare
7 structure changes including:
7 Modifications
Modified 7 Breaking
GET /api/applications/{applicationId}/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/roles/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isDefault attribute Added
GET /api/users/{userId}/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
PATCH /api/roles/{id}
  • Body
  • application/json content type Modified
    • isDefault attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isDefault attribute Added
POST /api/roles
  • Body
  • application/json content type Modified
    • isDefault attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isDefault attribute Added
POST /api/roles/{id}/scopes
  • Response
  • 200 response Modified
    • application/json content type Removed

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

        Breaking

  • 201 response Added
1 structure change including:
1 Modification
Modified 1
POST /api/hooks
  • Body
  • application/json content type Modified
    • event attribute Modified

      • Type went from string | null to string

      • event property Modified

        • Type went from string | null to string

1 structure change including:
1 Modification
Modified 1
GET /api/interaction/consent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • organizations, missingResourceScopes attributes Modified
1 structure change including:
1 Modification
Modified 1
GET /api/interaction/consent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • organizations attribute Modified
2 structure changes including:
2 Modifications
Modified 2
GET /api/applications/{applicationId}/user-consent-scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • organizationResourceScopes attribute Added
POST /api/applications/{applicationId}/user-consent-scopes
  • Body
  • application/json content type Modified
    • organizationResourceScopes attribute Added
6 structure changes including:
6 Modifications
Modified 6
GET /api/applications/{id}/users/{userId}/consent-organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • organizations attribute Modified
GET /api/organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/organizations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customData attribute Added
GET /api/users/{userId}/organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
PATCH /api/organizations/{id}
  • Body
  • application/json content type Modified
    • customData attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customData attribute Added
POST /api/organizations
  • Body
  • application/json content type Modified
    • customData attribute Added
5 structure changes including:
1 Addition
4 Modifications
Modified 4
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}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1, object-2 alternatives Modified
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1, object-2 alternatives Modified
Added 1
GET /api/organizations/{id}/users/{userId}/scopes
8 structure changes including:
4 Additions
4 Modifications
Modified 4
GET /api/configs/admin-console
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification attribute Modified
GET /api/organization-roles
  • Response
  • 200 response Modified
    • application/json content type Modified
  • 400 response Added
  • Query
  • q query parameter 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
POST /api/organization-roles
  • Body
  • application/json content type Modified
    • resourceScopeIds attribute Added
Added 4
DELETE /api/organization-roles/{id}/resource-scopes/{scopeId}
GET /api/organization-roles/{id}/resource-scopes
POST /api/organization-roles/{id}/resource-scopes
PUT /api/organization-roles/{id}/resource-scopes
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 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
POST /api/configs/jwt-customizer/test
  • Body
  • application/json content type Modified
    • object-1 alternative Modified
      • envVars attribute Removed

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

          Breaking

      • environmentVariables attribute Added
    • object-2 alternative Modified
      • envVars attribute Removed

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

          Breaking

      • environmentVariables attribute Added
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
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 attribute Removed

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

          Breaking

      • envVars, script, token, context attributes Added
    • object-2 alternative Modified
      • payload attribute Removed

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

          Breaking

      • envVars, script, token attributes 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 attribute 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 attribute Modified
    • object-2 alternative Modified
      • payload attribute 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 attribute Added
PATCH /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerType attribute 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 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
POST /api/users/{userId}/identities
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Additional properties: attribute 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/roles/{id}/scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
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

PATCH /api/users/{userId}/password
  • 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}
  • 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/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

GET /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities attribute Modified
      • updatedAt, profile attributes 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 attribute Modified
GET /api/applications/{applicationId}/user-consent-scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • resourceScopes attribute Modified
DELETE /api/users/{userId}/identities/{target}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities attribute Modified
      • updatedAt, profile attributes 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 attribute Modified
      • object-2 alternative Modified
POST /api/organization-invitations/{id}/message
  • Body
  • application/json content type Modified
    • Additional properties: attribute 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 attributes 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 attributes Added
1 structure change including:
1 Modification
Modified 1
POST /api/roles
  • Response
  • 404 response Added