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
36 structure changes including:
28 Breaking changes
8 Modifications
28 Removals
Modified 8 Breaking
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoConnectors property Modified
GET /api/configs/admin-console
  • Response
  • 200 response Modified
    • application/json content type Modified
      • developmentTenantMigrationNotification property Added
GET /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoOnly property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • Query
  • page, page_size query parameters Added
GET /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoOnly property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PATCH /api/configs/admin-console
  • Body
  • application/json content type Modified
    • developmentTenantMigrationNotification property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • developmentTenantMigrationNotification property Added
PATCH /api/sso-connectors/{id}
  • Body
  • application/json content type Modified
    • ssoOnly property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoOnly 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
      • ssoOnly property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /api/sso-connectors
  • Body
  • application/json content type Modified
    • ssoOnly property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoOnly property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
Removed 28 Breaking
DELETE /api/organization-roles/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/organization-roles/{id}/scopes/{organizationScopeId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/organization-scopes/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/organizations/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/organizations/{id}/users/{userId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/organizations/{id}/users/{userId}/roles/{roleId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organization-roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organization-roles/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organization-roles/{id}/scopes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organization-scopes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organization-scopes/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organizations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organizations/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organizations/{id}/users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organizations/{id}/users/{userId}/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/organization-roles/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/organization-scopes/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/organizations/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/organization-roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/organization-roles/{id}/scopes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/organization-scopes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/organizations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/organizations/{id}/users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/organizations/{id}/users/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/organizations/{id}/users/{userId}/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/organization-roles/{id}/scopes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/organizations/{id}/users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/organizations/{id}/users/{userId}/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
2 structure changes including:
2 Modifications
Modified 2
PATCH /api/organization-roles/{id}
  • Response
  • 422 response Added
PATCH /api/organization-scopes/{id}
  • Response
  • 422 response Added
1 structure change including:
1 Modification
Modified 1
DELETE /api/organizations/{id}/users/{userId}
  • Response
  • 404 response Added
90 structure changes including:
90 Modifications
Modified 90
DELETE /api/applications/{applicationId}/roles/{roleId}
  • Path
  • applicationId, roleId path parameters Added
DELETE /api/applications/{id}
  • Path
  • id path parameter Added
DELETE /api/configs/oidc/{keyType}/{keyId}
  • Path
  • keyType path parameter Added
DELETE /api/connectors/{id}
  • Path
  • id path parameter Added
DELETE /api/custom-phrases/{languageTag}
  • Path
  • languageTag path parameter Added
DELETE /api/domains/{id}
  • Path
  • id path parameter Added
DELETE /api/hooks/{id}
  • Path
  • id path parameter Added
DELETE /api/organization-roles/{id}
  • Path
  • id path parameter Added
DELETE /api/organization-roles/{id}/scopes/{organizationScopeId}
  • Path
  • id, organizationScopeId path parameters Added
DELETE /api/organization-scopes/{id}
  • Path
  • id path parameter Added
DELETE /api/organizations/{id}
  • Path
  • id path parameter Added
DELETE /api/organizations/{id}/users/{userId}
  • Path
  • id, userId path parameters Added
DELETE /api/organizations/{id}/users/{userId}/roles/{roleId}
  • Path
  • id, userId, roleId path parameters Added
DELETE /api/resources/{id}
  • Path
  • id path parameter Added
DELETE /api/resources/{resourceId}/scopes/{scopeId}
  • Path
  • resourceId, scopeId path parameters Added
DELETE /api/roles/{id}
  • Path
  • id path parameter Added
DELETE /api/roles/{id}/applications/{applicationId}
  • Path
  • id, applicationId path parameters Added
DELETE /api/roles/{id}/scopes/{scopeId}
  • Path
  • id, scopeId path parameters Added
DELETE /api/roles/{id}/users/{userId}
  • Path
  • id, userId path parameters Added
DELETE /api/users/{userId}
  • Path
  • userId path parameter Added
DELETE /api/users/{userId}/identities/{target}
  • Path
  • userId, target path parameters Added
DELETE /api/users/{userId}/mfa-verifications/{verificationId}
  • Path
  • userId path parameter Added
DELETE /api/users/{userId}/roles/{roleId}
  • Path
  • userId, roleId path parameters Added
GET /api/applications/{applicationId}/roles
  • Path
  • applicationId path parameter Added
GET /api/applications/{id}
  • Path
  • id path parameter Added
GET /api/configs/oidc/{keyType}
  • Path
  • keyType path parameter Added
GET /api/connectors/{id}
  • Path
  • id path parameter Added
GET /api/custom-phrases/{languageTag}
  • Path
  • languageTag path parameter Added
GET /api/domains/{id}
  • Path
  • id path parameter Added
GET /api/hooks/{id}
  • Path
  • id path parameter Added
GET /api/hooks/{id}/recent-logs
  • Path
  • id path parameter Added
GET /api/logs/{id}
  • Path
  • id path parameter Added
GET /api/organization-roles/{id}
  • Path
  • id path parameter Added
GET /api/organization-roles/{id}/scopes
  • Path
  • id path parameter Added
GET /api/organization-scopes/{id}
  • Path
  • id path parameter Added
GET /api/organizations/{id}
  • Path
  • id path parameter Added
GET /api/organizations/{id}/users
  • Path
  • id path parameter Added
GET /api/organizations/{id}/users/{userId}/roles
  • Path
  • id, userId path parameters Added
GET /api/resources/{id}
  • Path
  • id path parameter Added
GET /api/resources/{resourceId}/scopes
  • Path
  • resourceId path parameter Added
GET /api/roles/{id}
  • Path
  • id path parameter Added
GET /api/roles/{id}/applications
  • Path
  • id path parameter Added
GET /api/roles/{id}/scopes
  • Path
  • id path parameter Added
GET /api/roles/{id}/users
  • Path
  • id path parameter Added
GET /api/users/{userId}
  • Path
  • userId path parameter Added
GET /api/users/{userId}/custom-data
  • Path
  • userId path parameter Added
GET /api/users/{userId}/has-password
  • Path
  • userId path parameter Added
GET /api/users/{userId}/mfa-verifications
  • Path
  • userId path parameter Added
GET /api/users/{userId}/organizations
  • Path
  • userId path parameter Added
GET /api/users/{userId}/roles
  • Path
  • userId path parameter Added
PATCH /api/applications/{id}
  • Path
  • id path parameter Added
PATCH /api/connectors/{id}
  • Path
  • id path parameter Added
PATCH /api/hooks/{id}
  • Path
  • id path parameter Added
PATCH /api/hooks/{id}/signing-key
  • Path
  • id path parameter Added
PATCH /api/organization-roles/{id}
  • Path
  • id path parameter Added
PATCH /api/organization-scopes/{id}
  • Path
  • id path parameter Added
PATCH /api/organizations/{id}
  • Path
  • id path parameter Added
PATCH /api/resources/{id}
  • Path
  • id path parameter Added
PATCH /api/resources/{id}/is-default
  • Path
  • id path parameter Added
PATCH /api/resources/{resourceId}/scopes/{scopeId}
  • Path
  • resourceId, scopeId path parameters Added
PATCH /api/roles/{id}
  • Path
  • id path parameter Added
PATCH /api/users/{userId}
  • Path
  • userId path parameter Added
PATCH /api/users/{userId}/custom-data
  • Path
  • userId path parameter Added
PATCH /api/users/{userId}/is-suspended
  • Path
  • userId path parameter Added
PATCH /api/users/{userId}/password
  • Path
  • userId path parameter Added
POST /api/applications/{applicationId}/roles
  • Path
  • applicationId path parameter Added
POST /api/authn/saml/{connectorId}
  • Path
  • connectorId path parameter Added
POST /api/configs/oidc/{keyType}/rotate
  • Path
  • keyType path parameter Added
POST /api/connectors/{connectorId}/authorization-uri
  • Path
  • connectorId path parameter Added
POST /api/hooks/{id}/test
  • Path
  • id path parameter Added
POST /api/interaction/single-sign-on/{connectorId}/authentication
  • Path
  • connectorId path parameter Added
POST /api/interaction/single-sign-on/{connectorId}/authorization-url
  • Path
  • connectorId path parameter Added
POST /api/organization-roles/{id}/scopes
  • Path
  • id path parameter Added
POST /api/organizations/{id}/users
  • Path
  • id path parameter Added
POST /api/organizations/{id}/users/roles
  • Path
  • id path parameter Added
POST /api/organizations/{id}/users/{userId}/roles
  • Path
  • id, userId path parameters Added
POST /api/resources/{resourceId}/scopes
  • Path
  • resourceId path parameter Added
POST /api/roles/{id}/applications
  • Path
  • id path parameter Added
POST /api/roles/{id}/scopes
  • Path
  • id path parameter Added
POST /api/roles/{id}/users
  • Path
  • id path parameter Added
POST /api/users/{userId}/identities
  • Path
  • userId path parameter Added
POST /api/users/{userId}/mfa-verifications
  • Path
  • userId path parameter Added
POST /api/users/{userId}/password/verify
  • Path
  • userId path parameter Added
POST /api/users/{userId}/roles
  • Path
  • userId path parameter Added
PUT /api/applications/{applicationId}/roles
  • Path
  • applicationId path parameter Added
PUT /api/custom-phrases/{languageTag}
  • Path
  • languageTag path parameter Added
PUT /api/organization-roles/{id}/scopes
  • Path
  • id path parameter Added
PUT /api/organizations/{id}/users
  • Path
  • id path parameter Added
PUT /api/organizations/{id}/users/{userId}/roles
  • Path
  • id, userId path parameters Added
PUT /api/users/{userId}/roles
  • Path
  • userId path parameter Added
4 structure changes including:
1 Breaking change
1 Addition
2 Modifications
1 Removal
Modified 2
POST /api/organization-roles
  • Response
  • 422 response Added
POST /api/organization-scopes
  • Response
  • 422 response Added
Removed 1 Breaking
GET /api/swagger.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /api/swagger.json