Logto API references

Changelog

Last update:
Compare

API structure has changed

Modified 14
DELETE /api/applications/{id}
  • Response
  • 422 response Added
GET /api/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Query
  • isThirdParty query parameter Added
GET /api/applications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata, isThirdParty attributes Added
GET /api/roles/{id}/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
PATCH /api/applications/{id}
  • Body
  • application/json content type Modified
    • protectedAppMetadata attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata, isThirdParty attributes Added
PATCH /api/sso-connectors/{id}
  • Response
  • 409 response Added
POST /api/applications
  • Body
  • application/json content type Modified
    • isThirdParty, protectedAppMetadata attributes Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata, isThirdParty attributes Added
  • 500 response Added
POST /api/authn/saml/{connectorId}
  • Response
  • 404 response Added
POST /api/interaction/consent
  • Body
  • application/json content type Added
  • Response
  • 400 response Added
POST /api/interaction/submit
  • Response
  • 403 response Added
POST /api/interaction/verification/verification-code
  • Response
  • 501 response Added
POST /api/interaction/verification/webauthn-authentication
  • Response
  • 400 response Added
POST /api/sso-connectors
  • Response
  • 409 response Added
POST /api/verification-codes
  • Response
  • 501 response Added
Added 14
DELETE /api/applications/{applicationId}/user-consent-scopes/{scopeType}/{scopeId}
DELETE /api/applications/{id}/protected-app-metadata/custom-domains/{domain}
DELETE /api/applications/{id}/users/{userId}/consent-organizations/{organizationId}
GET /api/applications/{applicationId}/sign-in-experience
GET /api/applications/{applicationId}/user-consent-scopes
GET /api/applications/{id}/protected-app-metadata/custom-domains
GET /api/applications/{id}/users/{userId}/consent-organizations
GET /api/interaction/consent
GET /api/systems/application
POST /api/applications/{applicationId}/user-consent-scopes
POST /api/applications/{id}/protected-app-metadata/custom-domains
POST /api/applications/{id}/users/{userId}/consent-organizations
PUT /api/applications/{applicationId}/sign-in-experience
PUT /api/applications/{id}/users/{userId}/consent-organizations

API structure has changed

Modified 5 Breaking
GET /api/applications
  • Query
  • excludeRoleId query parameter Added
GET /api/configs/admin-console
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification attribute Added
PATCH /api/applications/{id}
  • Body
  • application/json content type Modified
    • secret, type attributes Removed
      • Removing a resource is always breaking unless it was deprecated before

        Breaking

PATCH /api/configs/admin-console
  • Body
  • application/json content type Modified
    • checkedChargeNotification attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification attribute Added
POST /api/applications
  • Body
  • application/json content type Modified
    • secret attribute Removed
      • Removing a resource is always breaking unless it was deprecated before

        Breaking

API structure has changed

Modified 13 Breaking
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • singleSignOnEnabled attribute Added
GET /api/configs/oidc/{keyType}
  • Response
  • 404 response Removed
    • Removing a resource is always breaking unless it was deprecated before

      Breaking

GET /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding attribute Modified
      • name, providerLogoDark attributes Added
GET /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding attribute Modified
      • name, providerLogoDark attributes Added
PATCH /api/hooks/{id}
  • Body
  • application/json content type Modified
    • event attribute Modified
      • Attribute is now deprecated

    • config attribute Modified
PATCH /api/sso-connectors/{id}
  • Body
  • application/json content type Modified
    • branding attribute Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding attribute Modified
      • name, providerLogoDark attributes Added
POST /api/authn/saml/{connectorId}
  • Operation is now deprecated
POST /api/authn/single-sign-on/saml/{connectorId}
  • Body
  • application/json content type Modified
    • SAMLResponse attribute Added
POST /api/connectors/{connectorId}/authorization-uri
  • Response
  • 200 response Modified
    • application/json content type Modified
      • redirectUri attribute Added
POST /api/connectors/{factoryId}/test
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before

      Breaking

  • 204, 404 responses Added
POST /api/hooks
  • Body
  • application/json content type Modified
    • event attribute Modified
      • Attribute is now deprecated

    • config attribute Modified
POST /api/hooks/{id}/test
  • Body
  • application/json content type Modified
    • config attribute Modified
    • event attribute Added
POST /api/sso-connectors
  • Body
  • application/json content type Modified
    • branding attribute Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding attribute Modified
Removed 6 Breaking
GET /api/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/sign-in-exp
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/sso-connector-factories
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/sign-in-exp
  • 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 5
GET /api/logs
GET /api/logs/{id}
GET /api/sign-in-exp
GET /api/sso-connector-providers
PATCH /api/sign-in-exp

API structure has changed

Added 28
DELETE /api/organization-roles/{id}
DELETE /api/organization-roles/{id}/scopes/{organizationScopeId}
DELETE /api/organization-scopes/{id}
DELETE /api/organizations/{id}
DELETE /api/organizations/{id}/users/{userId}
DELETE /api/organizations/{id}/users/{userId}/roles/{roleId}
GET /api/organization-roles
GET /api/organization-roles/{id}
GET /api/organization-roles/{id}/scopes
GET /api/organization-scopes
GET /api/organization-scopes/{id}
GET /api/organizations
GET /api/organizations/{id}
GET /api/organizations/{id}/users
GET /api/organizations/{id}/users/{userId}/roles
PATCH /api/organization-roles/{id}
PATCH /api/organization-scopes/{id}
PATCH /api/organizations/{id}
POST /api/organization-roles
POST /api/organization-roles/{id}/scopes
POST /api/organization-scopes
POST /api/organizations
POST /api/organizations/{id}/users
POST /api/organizations/{id}/users/roles
POST /api/organizations/{id}/users/{userId}/roles
PUT /api/organization-roles/{id}/scopes
PUT /api/organizations/{id}/users
PUT /api/organizations/{id}/users/{userId}/roles

API structure has changed

Modified 19 Breaking
DELETE /api/configs/oidc/{keyType}/{keyId}
  • Path
  • keyId path parameter Added
DELETE /api/sso-connectors/{id}
  • Path
  • id path parameter Added
DELETE /api/users/{userId}/identities/{target}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Added
DELETE /api/users/{userId}/mfa-verifications/{verificationId}
  • Path
  • verificationId path parameter Added
GET /api/connector-factories/{id}
  • Path
  • id path parameter Added
GET /api/custom-phrases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • translation attribute Modified
GET /api/custom-phrases/{languageTag}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • translation attribute Modified
GET /api/roles/{id}/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Added
GET /api/sso-connectors/{id}
  • Path
  • id path parameter Added
GET /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Added
GET /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Added
  • Query
  • includeSsoIdentities query parameter Added
PATCH /api/sso-connectors/{id}
  • Path
  • id path parameter Added
PATCH /api/sso-connectors/{id}/config
  • Path
  • id path parameter Added
  • Query
  • partialValidateConfig query parameter Added
PATCH /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Added
PATCH /api/users/{userId}/is-suspended
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Added
PATCH /api/users/{userId}/password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Added
POST /api/connectors/{factoryId}/test
  • Path
  • factoryId path parameter Added
POST /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Added
PUT /api/custom-phrases/{languageTag}
  • Body
  • application/json content type Modified
    • [translationKey] attribute Modified
Added 2
POST /api/authn/single-sign-on/saml/{connectorId}
POST /api/interaction/single-sign-on/{connectorId}/registration

API structure has changed

Modified 8 Breaking
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoConnectors attribute Modified
GET /api/configs/admin-console
  • Response
  • 200 response Modified
    • application/json content type Modified
      • developmentTenantMigrationNotification attribute Added
GET /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoOnly attribute 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 attribute 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 attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • developmentTenantMigrationNotification attribute Added
PATCH /api/sso-connectors/{id}
  • Body
  • application/json content type Modified
    • ssoOnly attribute Removed
      • Removing a resource is always breaking unless it was deprecated before

        Breaking

  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoOnly attribute 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 attribute Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

POST /api/sso-connectors
  • Body
  • application/json content type Modified
    • ssoOnly attribute Removed
      • Removing a resource is always breaking unless it was deprecated before

        Breaking

  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoOnly attribute 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

API structure has changed

Modified 2
PATCH /api/organization-roles/{id}
  • Response
  • 422 response Added
PATCH /api/organization-scopes/{id}
  • Response
  • 422 response Added

API structure has changed

Modified 1
DELETE /api/organizations/{id}/users/{userId}
  • Response
  • 404 response Added

API structure has changed

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

API structure has changed

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

API documentation has been created