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

Jul 1, 2024

main
Cloud
Compare

API structure has changed

184 structure changes including:
14 Additions
170 Modifications
Modified 170 Breaking
PATCH /api/hooks/{id}/signing-key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
PATCH /api/organization-roles/{id}
  • Body
  • application/json content type Modified
    • tenantId, type properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId, type properties Added
  • Authentication
  • Management api authentication method Added
PATCH /api/organization-scopes/{id}
  • Body
  • application/json content type Modified
    • tenantId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
PATCH /api/organizations/{id}
  • Body
  • application/json content type Modified
    • tenantId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
PATCH /api/resources/{id}
  • Body
  • application/json content type Modified
    • tenantId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
PATCH /api/resources/{id}/is-default
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
PATCH /api/resources/{resourceId}/scopes/{scopeId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
PATCH /api/roles/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • tenantId, agreeToTermsPolicy properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId, agreeToTermsPolicy properties Added
  • Authentication
  • Management api authentication method Added
PATCH /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
PATCH /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
  • Authentication
  • Management api authentication method Added
PATCH /api/users/{userId}/custom-data
  • Authentication
  • Management api authentication method Added
PATCH /api/users/{userId}/is-suspended
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
  • Authentication
  • Management api authentication method Added
PATCH /api/users/{userId}/password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
  • Authentication
  • Management api authentication method Added
PATCH /api/users/{userId}/profile
  • Authentication
  • Management api authentication method 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
  • Authentication
  • Management api authentication method Added
POST /api/applications/{applicationId}/roles
  • Authentication
  • Management api authentication method Added
POST /api/applications/{applicationId}/user-consent-scopes
  • Authentication
  • Management api authentication method Added
POST /api/applications/{id}/protected-app-metadata/custom-domains
  • Authentication
  • Management api authentication method Added
POST /api/applications/{id}/users/{userId}/consent-organizations
  • Authentication
  • Management api authentication method Added
POST /api/configs/jwt-customizer/test
  • Body
  • application/json content type Modified
    • object-1 alternative Modified
      • context property Modified
  • Authentication
  • Management api authentication method Added
POST /api/configs/oidc/{keyType}/rotate
  • Authentication
  • Management api authentication method Added
POST /api/connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • formItems property Modified
  • Authentication
  • Management api authentication method Added
GET /api/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/roles/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
GET /api/roles/{id}/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/roles/{id}/scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/roles/{id}/users
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId, agreeToTermsPolicy properties Added
  • Authentication
  • Management api authentication method Added
GET /api/sso-connector-providers
  • Authentication
  • Management api authentication method Added
GET /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
GET /api/systems/application
  • Authentication
  • Management api authentication method Added
GET /api/user-assets/service-status
  • Authentication
  • Management api authentication method Added
GET /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
  • Authentication
  • Management api authentication method Added
GET /api/users/{userId}/custom-data
  • Authentication
  • Management api authentication method Added
GET /api/users/{userId}/has-password
  • Authentication
  • Management api authentication method Added
GET /api/users/{userId}/mfa-verifications
  • Authentication
  • Management api authentication method Added
GET /api/users/{userId}/organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/users/{userId}/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
PATCH /api/applications/{id}
  • 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
  • Authentication
  • Management api authentication method Added
PATCH /api/configs/admin-console
  • Authentication
  • Management api authentication method Added
PATCH /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
  • Authentication
  • Management api authentication method Added
PATCH /api/connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • formItems property Modified
  • Authentication
  • Management api authentication method Added
PATCH /api/hooks/{id}
  • Body
  • application/json content type Modified
    • tenantId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
POST /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
POST /api/user-assets
  • Authentication
  • Management api authentication method Added
POST /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
  • Authentication
  • Management api authentication method Added
POST /api/users/{userId}/identities
  • Authentication
  • Management api authentication method Added
POST /api/users/{userId}/mfa-verifications
  • Authentication
  • Management api authentication method Added
POST /api/users/{userId}/password/verify
  • Authentication
  • Management api authentication method Added
POST /api/users/{userId}/roles
  • Authentication
  • Management api authentication method Added
POST /api/verification-codes
  • Authentication
  • Management api authentication method Added
POST /api/verification-codes/verify
  • Authentication
  • Management api authentication method Added
PUT /api/applications/{applicationId}/roles
  • Authentication
  • Management api authentication method Added
PUT /api/applications/{applicationId}/sign-in-experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
PUT /api/applications/{id}/users/{userId}/consent-organizations
  • Authentication
  • Management api authentication method Added
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
  • Authentication
  • Management api authentication method Added
PUT /api/custom-phrases/{languageTag}
  • Authentication
  • Management api authentication method Added
PUT /api/organization-invitations/{id}/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
PUT /api/organization-roles/{id}/resource-scopes
  • Authentication
  • Management api authentication method Added
PUT /api/organization-roles/{id}/scopes
  • Authentication
  • Management api authentication method Added
PUT /api/organizations/{id}/jit/email-domains
  • Authentication
  • Management api authentication method Added
PUT /api/organizations/{id}/jit/roles
  • Authentication
  • Management api authentication method Added
PUT /api/organizations/{id}/users
  • Authentication
  • Management api authentication method Added
PUT /api/organizations/{id}/users/{userId}/roles
  • Authentication
  • Management api authentication method Added
PUT /api/users/{userId}/identities/{target}
  • Authentication
  • Management api authentication method Added
PUT /api/users/{userId}/roles
  • Authentication
  • Management api authentication method Added
POST /api/connectors/{connectorId}/authorization-uri
  • Authentication
  • Management api authentication method Added
POST /api/connectors/{factoryId}/test
  • Authentication
  • Management api authentication method Added
POST /api/domains
  • Authentication
  • Management api authentication method Added
POST /api/hooks
  • Body
  • application/json content type Modified
    • tenantId property Added
  • Authentication
  • Management api authentication method Added
POST /api/hooks/{id}/test
  • Authentication
  • Management api authentication method Added
POST /api/organization-invitations
  • Authentication
  • Management api authentication method Added
POST /api/organization-invitations/{id}/message
  • Authentication
  • Management api authentication method Added
POST /api/organization-roles
  • Body
  • application/json content type Modified
    • tenantId, type properties Added
  • Authentication
  • Management api authentication method Added
POST /api/organization-roles/{id}/resource-scopes
  • Authentication
  • Management api authentication method Added
POST /api/organization-roles/{id}/scopes
  • Authentication
  • Management api authentication method Added
POST /api/organization-scopes
  • Body
  • application/json content type Modified
    • tenantId property Added
  • Authentication
  • Management api authentication method Added
POST /api/organizations
  • Body
  • application/json content type Modified
    • tenantId property Added
  • Authentication
  • Management api authentication method Added
POST /api/organizations/{id}/jit/email-domains
  • Authentication
  • Management api authentication method Added
POST /api/organizations/{id}/jit/roles
  • Authentication
  • Management api authentication method Added
POST /api/organizations/{id}/users
  • Authentication
  • Management api authentication method Added
POST /api/organizations/{id}/users/roles
  • Authentication
  • Management api authentication method Added
POST /api/organizations/{id}/users/{userId}/roles
  • Authentication
  • Management api authentication method Added
POST /api/resources
  • Body
  • application/json content type Modified
    • tenantId property Added
  • Authentication
  • Management api authentication method Added
POST /api/resources/{resourceId}/scopes
  • Authentication
  • Management api authentication method 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
  • Authentication
  • Management api authentication method Added
POST /api/roles/{id}/applications
  • Authentication
  • Management api authentication method Added
POST /api/roles/{id}/scopes
  • Authentication
  • Management api authentication method Added
POST /api/roles/{id}/users
  • Authentication
  • Management api authentication method Added
DELETE /api/applications/{applicationId}/roles/{roleId}
  • Authentication
  • Management api authentication method Added
DELETE /api/organizations/{id}/users/{userId}/roles/{organizationRoleId}
  • Path went from `/api/organizations/{id}/users/{userId}/roles/{roleId}` to `/api/organizations/{id}/users/{userId}/roles/{organizationRoleId}` (same operationId)
  • Path
  • roleId path parameter Removed

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

      Breaking

  • organizationRoleId path parameter Added
  • Authentication
  • Management api authentication method Added
DELETE /api/resources/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/resources/{resourceId}/scopes/{scopeId}
  • Authentication
  • Management api authentication method Added
DELETE /api/roles/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/roles/{id}/applications/{applicationId}
  • Authentication
  • Management api authentication method Added
DELETE /api/roles/{id}/scopes/{scopeId}
  • Authentication
  • Management api authentication method Added
DELETE /api/roles/{id}/users/{userId}
  • Authentication
  • Management api authentication method Added
DELETE /api/sso-connectors/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/users/{userId}
  • Authentication
  • Management api authentication method Added
DELETE /api/users/{userId}/identities/{target}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Modified
  • Authentication
  • Management api authentication method Added
DELETE /api/users/{userId}/mfa-verifications/{verificationId}
  • Authentication
  • Management api authentication method Added
DELETE /api/users/{userId}/roles/{roleId}
  • Authentication
  • Management api authentication method Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • socialConnectors property Modified
      • tenantId, agreeToTermsPolicy, googleOneTap properties Added
GET /api/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Query
  • excludeOrganizationId query parameter Added
  • Authentication
  • Management api authentication method Added
GET /api/applications/{applicationId}/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/applications/{applicationId}/sign-in-experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
GET /api/applications/{applicationId}/user-consent-scopes
  • Authentication
  • Management api authentication method Added
GET /api/applications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
GET /api/applications/{id}/protected-app-metadata/custom-domains
  • Authentication
  • Management api authentication method Added
DELETE /api/applications/{applicationId}/user-consent-scopes/{scopeType}/{scopeId}
  • Authentication
  • Management api authentication method Added
DELETE /api/applications/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/applications/{id}/protected-app-metadata/custom-domains/{domain}
  • Authentication
  • Management api authentication method Added
DELETE /api/applications/{id}/users/{userId}/consent-organizations/{organizationId}
  • Authentication
  • Management api authentication method Added
DELETE /api/configs/jwt-customizer/{tokenTypePath}
  • Authentication
  • Management api authentication method Added
DELETE /api/configs/oidc/{keyType}/{keyId}
  • Authentication
  • Management api authentication method Added
DELETE /api/connectors/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/custom-phrases/{languageTag}
  • Authentication
  • Management api authentication method Added
DELETE /api/domains/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/hooks/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/organization-invitations/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/organization-roles/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/organization-roles/{id}/resource-scopes/{scopeId}
  • Authentication
  • Management api authentication method Added
DELETE /api/organization-roles/{id}/scopes/{organizationScopeId}
  • Authentication
  • Management api authentication method Added
DELETE /api/organization-scopes/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/organizations/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/organizations/{id}/jit/email-domains/{emailDomain}
  • Authentication
  • Management api authentication method Added
DELETE /api/organizations/{id}/jit/roles/{organizationRoleId}
  • Authentication
  • Management api authentication method Added
DELETE /api/organizations/{id}/users/{userId}
  • Authentication
  • Management api authentication method Added
GET /api/applications/{id}/users/{userId}/consent-organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • organizations property Modified
  • Authentication
  • Management api authentication method Added
GET /api/logs/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
GET /api/organization-invitations
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organization-invitations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
GET /api/organization-roles
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organization-roles/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId, type properties Added
  • Authentication
  • Management api authentication method Added
GET /api/organization-roles/{id}/resource-scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organization-roles/{id}/scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organization-scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organization-scopes/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
GET /api/organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organizations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
GET /api/organizations/{id}/jit/email-domains
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organizations/{id}/jit/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organizations/{id}/users
  • Authentication
  • Management api authentication method Added
GET /api/organizations/{id}/users/{userId}/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organizations/{id}/users/{userId}/scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/resources
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/resources/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
GET /api/resources/{resourceId}/scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/configs/admin-console
  • Authentication
  • Management api authentication method Added
GET /api/configs/jwt-customizer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
  • Authentication
  • Management api authentication method Added
GET /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
  • Authentication
  • Management api authentication method Added
GET /api/configs/oidc/{keyType}
  • Authentication
  • Management api authentication method Added
GET /api/connector-factories
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/connector-factories/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • formItems property Modified
  • Authentication
  • Management api authentication method Added
GET /api/connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • formItems property Modified
  • Authentication
  • Management api authentication method Added
GET /api/custom-phrases
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/logs
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/hooks/{id}/recent-logs
  • Authentication
  • Management api authentication method Added
GET /api/hooks/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
GET /api/hooks
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/domains/{id}
  • Authentication
  • Management api authentication method Added
GET /api/domains
  • Authentication
  • Management api authentication method Added
GET /api/dashboard/users/total
  • Authentication
  • Management api authentication method Added
GET /api/dashboard/users/new
  • Authentication
  • Management api authentication method Added
GET /api/dashboard/users/active
  • Authentication
  • Management api authentication method Added
GET /api/custom-phrases/{languageTag}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
  • Authentication
  • Management api authentication method Added
Added 14
DELETE /api/organizations/{id}/applications/{applicationId}
DELETE /api/organizations/{id}/applications/{applicationId}/roles/{organizationRoleId}
DELETE /api/organizations/{id}/jit/sso-connectors/{ssoConnectorId}
GET /api/applications/{id}/organizations
GET /api/organizations/{id}/applications
GET /api/organizations/{id}/applications/{applicationId}/roles
GET /api/organizations/{id}/jit/sso-connectors
POST /api/organizations/{id}/applications
POST /api/organizations/{id}/applications/roles
POST /api/organizations/{id}/applications/{applicationId}/roles
POST /api/organizations/{id}/jit/sso-connectors
PUT /api/organizations/{id}/applications
PUT /api/organizations/{id}/applications/{applicationId}/roles
PUT /api/organizations/{id}/jit/sso-connectors