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
1 structure change including:
1 Modification
Modified 1 Breaking
PATCH /api/applications/{id}
  • Body
  • application/json content type Modified
    • protectedAppMetadata property Modified
      • Full types went from object | null to object
        Breaking
      • pageRules property Modified
      • host property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
2 structure changes including:
2 Modifications
Modified 2
GET /api/configs/admin-console
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification property Modified
PATCH /api/configs/admin-console
  • Body
  • application/json content type Modified
    • checkedChargeNotification property Modified
      • token property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification property Modified
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /api/configs/admin-console
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification property Added
PATCH /api/configs/admin-console
  • Body
  • application/json content type Modified
    • checkedChargeNotification property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification property Added
POST /api/applications
  • Body
  • application/json content type Modified
    • protectedAppMetadata property Modified
      • Full types went from object | null to object
        Breaking
      • sessionDuration, pageRules properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
2 structure changes including:
2 Additions
Added 2
GET /api/applications/{applicationId}/sign-in-experience
PUT /api/applications/{applicationId}/sign-in-experience
8 structure changes including:
3 Additions
5 Modifications
Modified 5 Breaking
GET /api/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Query
  • excludeRoleId, isThirdParty query parameters Added
GET /api/applications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata, isThirdParty properties 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
    • secret, type properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • protectedAppMetadata property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata, isThirdParty properties Added
POST /api/applications
  • Body
  • application/json content type Modified
    • secret property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • protectedAppMetadata, isThirdParty properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata, isThirdParty properties Added
Added 3
DELETE /api/applications/{applicationId}/user-consent-scopes/{scopeType}/{scopeId}
GET /api/applications/{applicationId}/user-consent-scopes
POST /api/applications/{applicationId}/user-consent-scopes
18 structure changes including:
5 Breaking changes
5 Additions
8 Modifications
5 Removals
Modified 8 Breaking
GET /api/configs/oidc/{keyType}
  • Response
  • 404 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PATCH /api/hooks/{id}
  • Body
  • application/json content type Modified
    • event property Modified
      • Property is now deprecated
    • config property Modified
POST /api/authn/saml/{connectorId}
  • Operation is now deprecated
POST /api/authn/single-sign-on/saml/{connectorId}
  • Body
  • application/json content type Modified
    • SAMLResponse property Added
POST /api/connectors/{connectorId}/authorization-uri
  • Response
  • 200 response Modified
    • application/json content type Modified
      • redirectUri property 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 property Modified
      • Property is now deprecated
    • config property Modified
POST /api/hooks/{id}/test
  • Body
  • application/json content type Modified
    • config property Modified
    • event property Added
Removed 5 Breaking
PATCH /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
GET /api/sign-in-exp
  • 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/logs
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 5
PATCH /api/sign-in-exp
GET /api/sso-connector-providers
GET /api/sign-in-exp
GET /api/logs/{id}
GET /api/logs
3 structure changes including:
3 Modifications
Modified 3
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • singleSignOnEnabled property Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • singleSignOnEnabled property Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • singleSignOnEnabled property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • singleSignOnEnabled property Added
6 structure changes including:
1 Breaking change
5 Modifications
1 Removal
Modified 5
GET /api/sso-connector-factories
  • Response
  • 200 response Modified
    • application/json content type Modified
      • standardConnectors, providerConnectors properties Modified
GET /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding property Modified
      • name, providerLogoDark properties Added
GET /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding property Modified
      • name, providerLogoDark properties Added
PATCH /api/sso-connectors/{id}
  • Body
  • application/json content type Modified
    • branding property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding property Modified
      • name, providerLogoDark properties Added
POST /api/sso-connectors
  • Body
  • application/json content type Modified
    • branding property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding property Modified
Removed 1 Breaking
PATCH /api/sso-connectors/{id}/config
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
5 structure changes including:
1 Addition
4 Modifications
Modified 4 Breaking
GET /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerProperties property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerProperties property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PATCH /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerProperties 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
      • providerProperties property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
Added 1
POST /api/interaction/single-sign-on/{connectorId}/registration
5 structure changes including:
1 Addition
4 Modifications
Modified 4
GET /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerProperties property Added
GET /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerProperties property Added
PATCH /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerProperties property Added
PATCH /api/sso-connectors/{id}/config
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerProperties property Added
  • Query
  • partialValidateConfig query parameter Added
Added 1
POST /api/authn/single-sign-on/saml/{connectorId}
21 structure changes including:
21 Modifications
Modified 21 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 property 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 property Modified
GET /api/custom-phrases/{languageTag}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • translation property Modified
GET /api/organization-roles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • scopes property Added
  • 400 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • q query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/roles/{id}/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Added
GET /api/sso-connectors/{id}
  • Path
  • id path parameter Added
GET /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Added
GET /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property 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
PATCH /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Added
PATCH /api/users/{userId}/is-suspended
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Added
PATCH /api/users/{userId}/password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Added
POST /api/connectors/{factoryId}/test
  • Path
  • factoryId path parameter Added
POST /api/organization-roles
  • Body
  • application/json content type Modified
    • organizationScopeIds property Added
POST /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities property Added
PUT /api/custom-phrases/{languageTag}
  • Body
  • application/json content type Modified
    • [translationKey] property Modified
5 structure changes including:
5 Modifications
Modified 5
DELETE /api/organizations/{id}/users/{userId}
  • Response
  • 404 response Added
PATCH /api/organization-roles/{id}
  • Response
  • 422 response Added
PATCH /api/organization-scopes/{id}
  • Response
  • 422 response Added
POST /api/organization-roles
  • Response
  • 422 response Added
POST /api/organization-scopes
  • Response
  • 422 response Added
217 structure changes including:
97 Breaking changes
97 Additions
23 Modifications
97 Removals
Modified 23 Breaking
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
      • tenantId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/configs/admin-console
  • Response
  • 200 response Modified
    • application/json content type Modified
      • developmentTenantMigrationNotification property Added
GET /api/custom-phrases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/hooks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/logs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/organization-roles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/organization-scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/resources
  • Response
  • 200 response Modified
    • application/json content type Modified
      • scopes property Modified
      • tenantId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /api/roles
  • Body
  • application/json content type Modified
    • tenantId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /api/resources
  • Body
  • application/json content type Modified
    • tenantId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/organizations
  • Body
  • application/json content type Modified
    • tenantId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/organization-scopes
  • Body
  • application/json content type Modified
    • tenantId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/organization-roles
  • Body
  • application/json content type Modified
    • tenantId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/hooks
  • Body
  • application/json content type Modified
    • tenantId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/applications
  • Body
  • application/json content type Modified
    • customClientMetadata property Modified
    • tenantId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata property Modified
      • tenantId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • tenantId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId 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
GET /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
Removed 97 Breaking
DELETE /api/applications/:applicationId/roles/:roleId
  • 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/users/:userId
  • 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/mfa-verifications/:verificationId
  • 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/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
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
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
GET /api/organization-scopes/:id
  • 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/:relationId
  • 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/:relationId
  • 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
  • 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/:userId/roles
  • 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/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/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/swagger.json
  • 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 97
DELETE /api/applications/{applicationId}/roles/{roleId}
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}
GET /api/swagger.json
GET /api/users/{userId}
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/{organizationScopeId}
DELETE /api/organization-scopes/{id}
DELETE /api/organizations/{id}
DELETE /api/organizations/{id}/users/{userId}
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}
GET /api/applications/{applicationId}/roles
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}/authentication
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/roles
POST /api/organizations/{id}/users/{userId}/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}/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
POST /api/authn/saml/{connectorId}
6 structure changes including:
6 Modifications
Modified 6 Breaking
GET /api/interaction/single-sign-on/connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Full types went from array[object] to array[string]
        Breaking
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/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
13 structure changes including:
1 Addition
12 Modifications
Modified 12 Breaking
DELETE /api/users/:userId/identities/:target
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isDevelopmentTenant property Added
GET /api/logs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId property Added
GET /api/organizations/:id/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
      • tenantId, passwordEncrypted, passwordEncryptionMethod, logtoConfig, mfaVerifications properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/roles/:id/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
GET /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
GET /api/users/:userId
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
PATCH /api/users/:userId
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
PATCH /api/users/:userId/is-suspended
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
PATCH /api/users/:userId/password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
POST /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities property Modified
POST /api/users/:userId/identities
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Additional properties: property Modified
Added 1
POST /api/interaction/single-sign-on/:connectorId/authentication
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
5 structure changes including:
1 Breaking change
1 Addition
3 Modifications
1 Removal
Modified 3 Breaking
DELETE /api/organizations/{id}/users/{userId}
  • Response
  • 404 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/organization-roles
  • Response
  • 422 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/organization-scopes
  • Response
  • 422 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
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
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