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
4 structure changes including:
4 Additions
Added 4
DELETE /api/organizations/{id}/jit/sso-connectors/{ssoConnectorId}
GET /api/organizations/{id}/jit/sso-connectors
POST /api/organizations/{id}/jit/sso-connectors
PUT /api/organizations/{id}/jit/sso-connectors
4 structure changes including:
4 Additions
Added 4
DELETE /api/organizations/{id}/applications/{applicationId}
GET /api/organizations/{id}/applications
POST /api/organizations/{id}/applications
PUT /api/organizations/{id}/applications
3 structure changes including:
3 Modifications
Modified 3
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • agreeToTermsPolicy property Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • agreeToTermsPolicy property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • agreeToTermsPolicy property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • agreeToTermsPolicy property Added
28 structure changes including:
8 Additions
20 Modifications
Modified 20
POST /api/organizations
  • Body
  • application/json content type Modified
    • isMfaRequired property Added
POST /api/connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customData, fromEmail properties Added
POST /api/applications
  • Body
  • application/json content type Modified
    • oidcClientMetadata property Modified
      • backchannelLogoutUri, backchannelLogoutSessionRequired properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • oidcClientMetadata property Modified
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • socialSignIn property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • socialSignIn property Added
PATCH /api/organizations/{id}
  • Body
  • application/json content type Modified
    • isMfaRequired property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isMfaRequired property Added
PATCH /api/connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customData, fromEmail properties Added
PATCH /api/applications/{id}
  • Body
  • application/json content type Modified
    • oidcClientMetadata property Modified
      • backchannelLogoutUri, backchannelLogoutSessionRequired properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • oidcClientMetadata property Modified
GET /api/users/{userId}/organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • socialSignIn property Added
GET /api/roles/{id}/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/organizations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isMfaRequired property Added
GET /api/organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customData, fromEmail properties Added
GET /api/connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/connector-factories/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customData, fromEmail properties Added
GET /api/connector-factories
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/applications/{id}/users/{userId}/consent-organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • organizations property Modified
GET /api/applications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • oidcClientMetadata property Modified
GET /api/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • socialConnectors property Modified
      • socialSignIn, googleOneTap properties Added
Added 8
PUT /api/organizations/{id}/jit/roles
PUT /api/organizations/{id}/jit/email-domains
POST /api/organizations/{id}/jit/roles
POST /api/organizations/{id}/jit/email-domains
GET /api/organizations/{id}/jit/roles
GET /api/organizations/{id}/jit/email-domains
DELETE /api/organizations/{id}/jit/roles/{organizationRoleId}
DELETE /api/organizations/{id}/jit/email-domains/{emailDomain}
2 structure changes including:
2 Modifications
Modified 2
POST /api/interaction/single-sign-on/{connectorId}/authentication
  • Response
  • 500 response Added
POST /api/interaction/single-sign-on/{connectorId}/registration
  • Response
  • 500 response Added
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 property 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 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isDefault property Added
POST /api/roles
  • Body
  • application/json content type Modified
    • isDefault property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isDefault property 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 property Modified
      • Full types went from string | null to string
      • event property Modified
        • Full types 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 properties Modified
1 structure change including:
1 Modification
Modified 1
GET /api/interaction/consent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • organizations property 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 property Added
POST /api/applications/{applicationId}/user-consent-scopes
  • Body
  • application/json content type Modified
    • organizationResourceScopes property 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 property 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 property 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 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customData property Added
POST /api/organizations
  • Body
  • application/json content type Modified
    • customData property 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 property 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 property Modified
      • tenantMember property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification property Modified
POST /api/organization-roles
  • Body
  • application/json content type Modified
    • resourceScopeIds property 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 property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • environmentVariables property 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 property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • environmentVariables property Added
    • object-2 alternative Modified
      • envVars property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • environmentVariables property Added
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Body
  • application/json content type Modified
    • envVars property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • environmentVariables property 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 property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • envVars, script, token, context properties Added
    • object-2 alternative Modified
      • payload property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • envVars, script, token properties 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 property 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 property Modified
    • object-2 alternative Modified
      • payload property 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 property Added
PATCH /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerType property 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 property 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: property Modified
POST /api/users/{userId}/identities
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Additional properties: property Modified
POST /api/users
  • Body
  • application/json content type Modified
    • profile property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
      • updatedAt, profile properties 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 property Modified
      • Full types went from string to string | null
      • Property is no longer required
      • description property Modified
        • Full types went from string to string | null
        • Property is no longer required
PATCH /api/users/{userId}/password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
      • updatedAt, profile properties Added
PATCH /api/users/{userId}/is-suspended
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
      • updatedAt, profile properties Added
PATCH /api/users/{userId}
  • Body
  • application/json content type Modified
    • profile property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
      • updatedAt, profile properties Added
PATCH /api/resources/{resourceId}/scopes/{scopeId}
  • Body
  • application/json content type Modified
    • description property Modified
      • Full types went from string to string | null
      • description property Modified
        • Full types went from string to string | null
  • Response
  • 200 response Modified
    • application/json content type Modified
      • description property Modified
        • Full types went from string to string | null
GET /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
      • updatedAt, profile properties 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 property Modified
GET /api/applications/{applicationId}/user-consent-scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • resourceScopes property Modified
DELETE /api/users/{userId}/identities/{target}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
      • updatedAt, profile properties 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 property Modified
      • object-2 alternative Modified
POST /api/organization-invitations/{id}/message
  • Body
  • application/json content type Modified
    • Additional properties: property Added