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

Nov 13, 2023

dev
Cloud
Compare

API structure has changed

214 structure changes including:
96 Breaking changes
95 Additions
23 Modifications
96 Removals
Modified 23 Breaking
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoConnectors property Modified
      • isDevelopmentTenant property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • tenantId property Added
GET /api/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
      • tenantId property Added
GET /api/custom-phrases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
GET /api/hooks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
GET /api/interaction/single-sign-on/connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Full types went from array[string] to array[object]
        Breaking
      • id, ssoOnly properties Added
GET /api/organization-roles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
GET /api/organization-scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
GET /api/organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
GET /api/resources
  • Response
  • 200 response Modified
    • application/json content type Modified
      • scopes property Modified
      • tenantId property Added
GET /api/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
GET /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
GET /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • tenantId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
POST /api/applications
  • Body
  • application/json content type Modified
    • customClientMetadata property Modified
    • tenantId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
      • tenantId property Added
POST /api/hooks
  • Body
  • application/json content type Modified
    • tenantId property Added
POST /api/organization-roles
  • Body
  • application/json content type Modified
    • tenantId property Added
POST /api/organization-scopes
  • Body
  • application/json content type Modified
    • tenantId property Added
POST /api/organizations
  • Body
  • application/json content type Modified
    • tenantId property Added
POST /api/resources
  • Body
  • application/json content type Modified
    • tenantId property Added
POST /api/roles
  • Body
  • application/json content type Modified
    • tenantId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
POST /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
POST /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
Removed 96 Breaking
GET /api/applications/{applicationId}/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/applications/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/users/{userId}/roles/{roleId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/configs/oidc/{keyType}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/connector-factories/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/users/{userId}/mfa-verifications/{verificationId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/users/{userId}/identities/{target}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/users/{userId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/sso-connectors/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/applications/{applicationId}/roles/{roleId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/connectors/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/custom-phrases/{languageTag}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/domains/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/hooks/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/hooks/{id}/recent-logs
  • 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/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
PATCH /api/users/{userId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/applications/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/configs/oidc/{keyType}/{keyId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/connectors/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/custom-phrases/{languageTag}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/domains/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/hooks/{id}
  • Removing a resource is always breaking unless it was deprecated before
    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
DELETE /api/resources/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/resources/{resourceId}/scopes/{scopeId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/roles/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/roles/{id}/applications/{applicationId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/roles/{id}/scopes/{scopeId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/roles/{id}/users/{userId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/users/{userId}/custom-data
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/users/{userId}/is-suspended
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/users/{userId}/password
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/applications/{applicationId}/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/authn/saml/{connectorId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/configs/oidc/{keyType}/rotate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/connectors/{connectorId}/authorization-uri
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/connectors/{factoryId}/test
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/hooks/{id}/test
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/interaction/single-sign-on/{connectorId}/authentication
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/interaction/single-sign-on/{connectorId}/authorization-url
  • 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/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
POST /api/resources/{resourceId}/scopes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/roles/{id}/applications
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/roles/{id}/scopes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/roles/{id}/users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/users/{userId}/identities
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/users/{userId}/mfa-verifications
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/users/{userId}/password/verify
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/users/{userId}/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/applications/{applicationId}/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/custom-phrases/{languageTag}
  • 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
PUT /api/users/{userId}/roles
  • 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/{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
GET /api/resources/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/resources/{resourceId}/scopes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/roles/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/roles/{id}/applications
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/roles/{id}/scopes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/roles/{id}/users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/sso-connectors/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/users/{userId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/users/{userId}/custom-data
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/users/{userId}/has-password
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/users/{userId}/mfa-verifications
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/users/{userId}/organizations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/users/{userId}/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/applications/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/connectors/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/hooks/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/hooks/{id}/signing-key
  • 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
PATCH /api/resources/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/resources/{id}/is-default
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/resources/{resourceId}/scopes/{scopeId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/roles/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/sso-connectors/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/sso-connectors/{id}/config
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 95
GET /api/applications/:applicationId/roles
GET /api/applications/:id
GET /api/configs/oidc/:keyType
GET /api/connector-factories/:id
GET /api/connectors/:id
GET /api/custom-phrases/:languageTag
GET /api/domains/:id
GET /api/hooks/:id
GET /api/hooks/:id/recent-logs
GET /api/logs/:id
GET /api/organization-roles/:id
GET /api/organization-roles/:id/scopes
GET /api/organization-scopes/:id
GET /api/organizations/:id
GET /api/organizations/:id/users
GET /api/organizations/:id/users/:userId/roles
GET /api/resources/:id
GET /api/resources/:resourceId/scopes
GET /api/roles/:id
GET /api/roles/:id/applications
GET /api/roles/:id/scopes
GET /api/roles/:id/users
GET /api/sso-connectors/:id
POST /api/authn/saml/:connectorId
DELETE /api/applications/:applicationId/roles/:roleId
DELETE /api/applications/:id
DELETE /api/configs/oidc/:keyType/:keyId
DELETE /api/connectors/:id
DELETE /api/custom-phrases/:languageTag
DELETE /api/domains/:id
DELETE /api/hooks/:id
DELETE /api/organization-roles/:id
DELETE /api/organization-roles/:id/scopes/:relationId
DELETE /api/organization-scopes/:id
DELETE /api/organizations/:id
DELETE /api/organizations/:id/users/:relationId
DELETE /api/organizations/:id/users/:userId/roles/:roleId
DELETE /api/resources/:id
DELETE /api/resources/:resourceId/scopes/:scopeId
DELETE /api/roles/:id
DELETE /api/roles/:id/applications/:applicationId
DELETE /api/roles/:id/scopes/:scopeId
DELETE /api/roles/:id/users/:userId
DELETE /api/sso-connectors/:id
DELETE /api/users/:userId
DELETE /api/users/:userId/identities/:target
DELETE /api/users/:userId/mfa-verifications/:verificationId
DELETE /api/users/:userId/roles/:roleId
POST /api/configs/oidc/:keyType/rotate
POST /api/connectors/:connectorId/authorization-uri
POST /api/connectors/:factoryId/test
POST /api/hooks/:id/test
POST /api/interaction/single-sign-on/:connectorId/authorization-url
POST /api/organization-roles/:id/scopes
POST /api/organizations/:id/users
POST /api/organizations/:id/users/:userId/roles
POST /api/organizations/:id/users/roles
POST /api/resources/:resourceId/scopes
POST /api/roles/:id/applications
POST /api/roles/:id/scopes
POST /api/roles/:id/users
POST /api/users/:userId/identities
POST /api/users/:userId/mfa-verifications
POST /api/users/:userId/password/verify
POST /api/users/:userId/roles
PUT /api/applications/:applicationId/roles
PUT /api/custom-phrases/:languageTag
PUT /api/organization-roles/:id/scopes
PUT /api/organizations/:id/users
PUT /api/organizations/:id/users/:userId/roles
PUT /api/users/:userId/roles
GET /api/users/:userId
GET /api/users/:userId/custom-data
GET /api/users/:userId/has-password
GET /api/users/:userId/mfa-verifications
GET /api/users/:userId/organizations
GET /api/users/:userId/roles
PATCH /api/applications/:id
PATCH /api/connectors/:id
PATCH /api/hooks/:id
PATCH /api/hooks/:id/signing-key
PATCH /api/organization-roles/:id
PATCH /api/organization-scopes/:id
PATCH /api/organizations/:id
PATCH /api/resources/:id
PATCH /api/resources/:id/is-default
PATCH /api/resources/:resourceId/scopes/:scopeId
PATCH /api/roles/:id
PATCH /api/sso-connectors/:id
PATCH /api/sso-connectors/:id/config
PATCH /api/users/:userId
PATCH /api/users/:userId/custom-data
PATCH /api/users/:userId/is-suspended
PATCH /api/users/:userId/password
POST /api/applications/:applicationId/roles