Change Updates

Do not miss any Logto API references changes, ever again

Subscribe to the Logto API references changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
35 structure changes including:
1 Addition
34 Modifications
Modified 34 Breaking
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customUiAssetId attribute Removed

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

          Breaking

      • customUiAssets attribute Added
POST /api/organizations/{id}/applications/{applicationId}/roles
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/organizations/{id}/jit/email-domains
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/organizations/{id}/jit/roles
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/organizations/{id}/jit/sso-connectors
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/organizations/{id}/users
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/organizations/{id}/users/roles
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/organizations/{id}/users/{userId}/roles
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/resources
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/resources/{resourceId}/scopes
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/roles/{id}/applications
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/roles/{id}/scopes
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/roles/{id}/users
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/users/{userId}/roles
  • Response
  • 201 response Modified
    • application/json content type Added
PUT /api/applications/{applicationId}/sign-in-experience
  • Response
  • 201 response Modified
    • application/json content type Added
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 201 response Modified
    • application/json content type Added
PUT /api/custom-phrases/{languageTag}
  • Response
  • 201 response Modified
    • application/json content type Added
PUT /api/users/{userId}/identities/{target}
  • Response
  • 201 response Modified
    • application/json content type Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customUiAssetId attribute Removed

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

          Breaking

      • customUiAssets attribute Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • customUiAssetId attribute Removed

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

        Breaking

    • customUiAssets attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customUiAssetId attribute Removed

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

          Breaking

      • customUiAssets attribute Added
POST /api/applications/{applicationId}/roles
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/applications/{applicationId}/user-consent-scopes
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/applications/{id}/protected-app-metadata/custom-domains
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/applications/{id}/users/{userId}/consent-organizations
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/domains
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/hooks
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/organization-invitations
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/organization-roles
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/organization-roles/{id}/resource-scopes
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/organization-roles/{id}/scopes
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/organization-scopes
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/organizations
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/organizations/{id}/applications
  • Response
  • 201 response Modified
    • application/json content type Added
POST /api/organizations/{id}/applications/roles
  • Response
  • 201 response Modified
    • application/json content type Added
Added 1
POST /api/subject-tokens
18 structure changes including:
18 Modifications
Modified 18
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding attribute Modified
  • 400 response Added
  • Query
  • organizationId, appId query parameters Added
GET /api/applications/{applicationId}/sign-in-experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding attribute Modified
      • color attribute Added
GET /api/applications/{id}/organizations
  • 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 attribute Modified
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
GET /api/interaction/consent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • application attribute 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
      • branding attribute Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding attribute Modified
GET /api/users/{userId}/organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
PATCH /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
PATCH /api/organizations/{id}
  • Body
  • application/json content type Modified
    • branding attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding attribute Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • branding attribute Modified
      • darkFavicon property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding attribute Modified
POST /api/configs/jwt-customizer/test
  • Body
  • application/json content type Modified
    • object-1 alternative Modified
      • context attribute Modified
POST /api/organizations
  • Body
  • application/json content type Modified
    • branding attribute Added
PUT /api/applications/{applicationId}/sign-in-experience
  • Body
  • application/json content type Modified
    • branding attribute Modified
      • darkFavicon property Added
    • color attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • branding attribute Modified
      • color attribute Added
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
380 structure changes including:
189 Breaking changes
190 Additions
190 Removals
Removed 190 Breaking
GET /api/organization-roles/{id}/resource-scopes
  • 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
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organization-invitations/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organization-invitations
  • 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
GET /api/hooks/{id}/recent-logs
  • 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
  • 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/domains
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/dashboard/users/total
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/dashboard/users/new
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/dashboard/users/active
  • 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/custom-phrases
  • 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/connectors
  • 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/connector-factories
  • 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/configs/jwt-customizer/{tokenTypePath}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/organizations/{id}/users/{userId}/roles/{organizationRoleId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/sso-connectors
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/sso-connector-providers
  • 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/roles/{id}/users
  • 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}/applications
  • 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
  • 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/resources/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/resources
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organizations/{id}/users/{userId}/scopes
  • 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/organizations/{id}/users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organizations/{id}/jit/sso-connectors
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organizations/{id}/jit/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organizations/{id}/jit/email-domains
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organizations/{id}/applications/{applicationId}/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/organizations/{id}/applications
  • 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
  • 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/organization-scopes
  • 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
DELETE /api/organizations/{id}/users/{userId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/organizations/{id}/jit/sso-connectors/{ssoConnectorId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/organizations/{id}/jit/roles/{organizationRoleId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/organizations/{id}/jit/email-domains/{emailDomain}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/organizations/{id}/applications/{applicationId}/roles/{organizationRoleId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/organizations/{id}/applications/{applicationId}
  • 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/organization-scopes/{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-roles/{id}/resource-scopes/{scopeId}
  • 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-invitations/{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/domains/{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/connectors/{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/configs/jwt-customizer/{tokenTypePath}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/applications/{id}/users/{userId}/consent-organizations/{organizationId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/applications/{id}/protected-app-metadata/custom-domains/{domain}
  • 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/applications/{applicationId}/user-consent-scopes/{scopeType}/{scopeId}
  • 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/configs/jwt-customizer
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/configs/admin-console
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/authn/hasura
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/applications/{id}/users/{userId}/consent-organizations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/applications/{id}/protected-app-metadata/custom-domains
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/applications/{id}/organizations
  • 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/applications/{applicationId}/user-consent-scopes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/applications/{applicationId}/sign-in-experience
  • 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
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/.well-known/sign-in-exp
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/.well-known/phrases
  • 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
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/roles/{id}/users/{userId}
  • 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}/applications/{applicationId}
  • 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/resources/{resourceId}/scopes/{scopeId}
  • 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
POST /api/user-assets
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/sso-connectors
  • 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/roles/{id}/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
  • 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/resources
  • 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/organizations/{id}/users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/organizations/{id}/jit/sso-connectors
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/organizations/{id}/jit/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/organizations/{id}/jit/email-domains
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/organizations/{id}/applications/{applicationId}/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/organizations/{id}/applications/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/organizations/{id}/applications
  • 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/organization-scopes
  • 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-roles/{id}/resource-scopes
  • 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-invitations/{id}/message
  • 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
PUT /api/users/{userId}/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/users/{userId}/identities/{target}
  • 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/organizations/{id}/users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/organizations/{id}/jit/sso-connectors
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/organizations/{id}/jit/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/organizations/{id}/jit/email-domains
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/organizations/{id}/applications/{applicationId}/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/organizations/{id}/applications
  • 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/organization-roles/{id}/resource-scopes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/organization-invitations/{id}/status
  • 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/configs/jwt-customizer/{tokenTypePath}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/applications/{id}/users/{userId}/consent-organizations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/applications/{applicationId}/sign-in-experience
  • 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
POST /api/verification-codes/verify
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/verification-codes
  • 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
POST /api/users/{userId}/password/verify
  • 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}/identities
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/users
  • 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/{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/organization-scopes/{id}
  • 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/hooks/{id}/signing-key
  • 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/connectors/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/configs/jwt-customizer/{tokenTypePath}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/configs/admin-console
  • 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
GET /api/users/{userId}/roles
  • 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}/mfa-verifications
  • 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}/custom-data
  • 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
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/user-assets/service-status
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/systems/application
  • 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/status
  • 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
POST /api/organization-invitations
  • 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/hooks
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/domains
  • 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/connectors/{connectorId}/authorization-uri
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/connectors
  • 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/configs/jwt-customizer/test
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/authn/single-sign-on/saml/{connectorId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/authn/saml/{connectorId}
POST /api/applications/{id}/users/{userId}/consent-organizations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/applications/{id}/protected-app-metadata/custom-domains
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/applications/{applicationId}/user-consent-scopes
  • 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/applications
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/users/{userId}/profile
  • 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
PATCH /api/users/{userId}/is-suspended
  • 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}
  • 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/sign-in-exp
  • 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
Added 190
GET /api/organization-roles/{id}/resource-scopes
GET /api/organization-roles/{id}
GET /api/organization-roles
GET /api/organization-invitations/{id}
GET /api/organization-invitations
GET /api/logs/{id}
GET /api/logs
GET /api/hooks/{id}/recent-logs
GET /api/hooks/{id}
GET /api/hooks
GET /api/domains/{id}
GET /api/domains
GET /api/dashboard/users/total
GET /api/dashboard/users/new
GET /api/dashboard/users/active
GET /api/custom-phrases/{languageTag}
GET /api/custom-phrases
GET /api/connectors/{id}
GET /api/connectors
GET /api/connector-factories/{id}
GET /api/connector-factories
GET /api/configs/oidc/{keyType}
GET /api/configs/jwt-customizer/{tokenTypePath}
DELETE /api/organizations/{id}/users/{userId}/roles/{organizationRoleId}
GET /api/sso-connectors
GET /api/sso-connector-providers
GET /api/sign-in-exp
GET /api/roles/{id}/users
GET /api/roles/{id}/scopes
GET /api/roles/{id}/applications
GET /api/roles/{id}
GET /api/roles
GET /api/resources/{resourceId}/scopes
GET /api/resources/{id}
GET /api/resources
GET /api/organizations/{id}/users/{userId}/scopes
GET /api/organizations/{id}/users/{userId}/roles
GET /api/organizations/{id}/users
GET /api/organizations/{id}/jit/sso-connectors
GET /api/organizations/{id}/jit/roles
GET /api/organizations/{id}/jit/email-domains
GET /api/organizations/{id}/applications/{applicationId}/roles
GET /api/organizations/{id}/applications
GET /api/organizations/{id}
GET /api/organizations
GET /api/organization-scopes/{id}
GET /api/organization-scopes
GET /api/organization-roles/{id}/scopes
DELETE /api/organizations/{id}/users/{userId}
DELETE /api/organizations/{id}/jit/sso-connectors/{ssoConnectorId}
DELETE /api/organizations/{id}/jit/roles/{organizationRoleId}
DELETE /api/organizations/{id}/jit/email-domains/{emailDomain}
DELETE /api/organizations/{id}/applications/{applicationId}/roles/{organizationRoleId}
DELETE /api/organizations/{id}/applications/{applicationId}
DELETE /api/organizations/{id}
DELETE /api/organization-scopes/{id}
DELETE /api/organization-roles/{id}/scopes/{organizationScopeId}
DELETE /api/organization-roles/{id}/resource-scopes/{scopeId}
DELETE /api/organization-roles/{id}
DELETE /api/organization-invitations/{id}
DELETE /api/hooks/{id}
DELETE /api/domains/{id}
DELETE /api/custom-phrases/{languageTag}
DELETE /api/connectors/{id}
DELETE /api/configs/oidc/{keyType}/{keyId}
DELETE /api/configs/jwt-customizer/{tokenTypePath}
DELETE /api/applications/{id}/users/{userId}/consent-organizations/{organizationId}
DELETE /api/applications/{id}/protected-app-metadata/custom-domains/{domain}
DELETE /api/applications/{id}
DELETE /api/applications/{applicationId}/user-consent-scopes/{scopeType}/{scopeId}
DELETE /api/applications/{applicationId}/roles/{roleId}
GET /api/configs/jwt-customizer
GET /api/configs/admin-console
GET /api/authn/hasura
GET /api/applications/{id}/users/{userId}/consent-organizations
GET /api/applications/{id}/protected-app-metadata/custom-domains
GET /api/applications/{id}/organizations
GET /api/applications/{id}
GET /api/applications/{applicationId}/user-consent-scopes
GET /api/applications/{applicationId}/sign-in-experience
GET /api/applications/{applicationId}/roles
GET /api/applications
GET /api/.well-known/sign-in-exp
GET /api/.well-known/phrases
DELETE /api/users/{userId}/roles/{roleId}
DELETE /api/users/{userId}/mfa-verifications/{verificationId}
DELETE /api/users/{userId}/identities/{target}
DELETE /api/users/{userId}
DELETE /api/sso-connectors/{id}
DELETE /api/roles/{id}/users/{userId}
DELETE /api/roles/{id}/scopes/{scopeId}
DELETE /api/roles/{id}/applications/{applicationId}
DELETE /api/roles/{id}
DELETE /api/resources/{resourceId}/scopes/{scopeId}
DELETE /api/resources/{id}
POST /api/user-assets
POST /api/sso-connectors
POST /api/roles/{id}/users
POST /api/roles/{id}/scopes
POST /api/roles/{id}/applications
POST /api/roles
POST /api/resources/{resourceId}/scopes
POST /api/resources
POST /api/organizations/{id}/users/{userId}/roles
POST /api/organizations/{id}/users/roles
POST /api/organizations/{id}/users
POST /api/organizations/{id}/jit/sso-connectors
POST /api/organizations/{id}/jit/roles
POST /api/organizations/{id}/jit/email-domains
POST /api/organizations/{id}/applications/{applicationId}/roles
POST /api/organizations/{id}/applications/roles
POST /api/organizations/{id}/applications
POST /api/organizations
POST /api/organization-scopes
POST /api/organization-roles/{id}/scopes
POST /api/organization-roles/{id}/resource-scopes
POST /api/organization-roles
POST /api/organization-invitations/{id}/message
PATCH /api/resources/{resourceId}/scopes/{scopeId}
PUT /api/users/{userId}/roles
PUT /api/users/{userId}/identities/{target}
PUT /api/organizations/{id}/users/{userId}/roles
PUT /api/organizations/{id}/users
PUT /api/organizations/{id}/jit/sso-connectors
PUT /api/organizations/{id}/jit/roles
PUT /api/organizations/{id}/jit/email-domains
PUT /api/organizations/{id}/applications/{applicationId}/roles
PUT /api/organizations/{id}/applications
PUT /api/organization-roles/{id}/scopes
PUT /api/organization-roles/{id}/resource-scopes
PUT /api/organization-invitations/{id}/status
PUT /api/custom-phrases/{languageTag}
PUT /api/configs/jwt-customizer/{tokenTypePath}
PUT /api/applications/{id}/users/{userId}/consent-organizations
PUT /api/applications/{applicationId}/sign-in-experience
PUT /api/applications/{applicationId}/roles
POST /api/verification-codes/verify
POST /api/verification-codes
POST /api/users/{userId}/roles
POST /api/users/{userId}/password/verify
POST /api/users/{userId}/mfa-verifications
POST /api/users/{userId}/identities
POST /api/users
PATCH /api/resources/{id}/is-default
PATCH /api/resources/{id}
PATCH /api/organizations/{id}
PATCH /api/organization-scopes/{id}
PATCH /api/organization-roles/{id}
PATCH /api/hooks/{id}/signing-key
PATCH /api/hooks/{id}
PATCH /api/connectors/{id}
PATCH /api/configs/jwt-customizer/{tokenTypePath}
PATCH /api/configs/admin-console
PATCH /api/applications/{id}
GET /api/users/{userId}/roles
GET /api/users/{userId}/organizations
GET /api/users/{userId}/mfa-verifications
GET /api/users/{userId}/has-password
GET /api/users/{userId}/custom-data
GET /api/users/{userId}
GET /api/users
GET /api/user-assets/service-status
GET /api/systems/application
GET /api/swagger.json
GET /api/status
GET /api/sso-connectors/{id}
POST /api/organization-invitations
POST /api/hooks/{id}/test
POST /api/hooks
POST /api/domains
POST /api/connectors/{factoryId}/test
POST /api/connectors/{connectorId}/authorization-uri
POST /api/connectors
POST /api/configs/oidc/{keyType}/rotate
POST /api/configs/jwt-customizer/test
POST /api/authn/single-sign-on/saml/{connectorId}
POST /api/authn/saml/{connectorId}
POST /api/applications/{id}/users/{userId}/consent-organizations
POST /api/applications/{id}/protected-app-metadata/custom-domains
POST /api/applications/{applicationId}/user-consent-scopes
POST /api/applications/{applicationId}/roles
POST /api/applications
PATCH /api/users/{userId}/profile
PATCH /api/users/{userId}/password
PATCH /api/users/{userId}/is-suspended
PATCH /api/users/{userId}/custom-data
PATCH /api/users/{userId}
PATCH /api/sso-connectors/{id}
PATCH /api/sign-in-exp
PATCH /api/roles/{id}
184 structure changes including:
14 Additions
170 Modifications
Modified 170 Breaking
PATCH /api/hooks/{id}/signing-key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
PATCH /api/organization-roles/{id}
  • Body
  • application/json content type Modified
    • tenantId, type attributes Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId, type attributes Added
  • Authentication
  • Management api authentication method Added
PATCH /api/organization-scopes/{id}
  • Body
  • application/json content type Modified
    • tenantId attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
PATCH /api/organizations/{id}
  • Body
  • application/json content type Modified
    • tenantId attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
PATCH /api/resources/{id}
  • Body
  • application/json content type Modified
    • tenantId attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
PATCH /api/resources/{id}/is-default
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
PATCH /api/resources/{resourceId}/scopes/{scopeId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
PATCH /api/roles/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • tenantId, agreeToTermsPolicy attributes Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId, agreeToTermsPolicy attributes Added
  • Authentication
  • Management api authentication method Added
PATCH /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
PATCH /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Modified
  • Authentication
  • Management api authentication method Added
PATCH /api/users/{userId}/custom-data
  • Authentication
  • Management api authentication method Added
PATCH /api/users/{userId}/is-suspended
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Modified
  • Authentication
  • Management api authentication method Added
PATCH /api/users/{userId}/password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Modified
  • Authentication
  • Management api authentication method Added
PATCH /api/users/{userId}/profile
  • Authentication
  • Management api authentication method Added
POST /api/applications
  • Body
  • application/json content type Modified
    • customClientMetadata attribute Modified
      • tenantId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata attribute Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
POST /api/applications/{applicationId}/roles
  • Authentication
  • Management api authentication method Added
POST /api/applications/{applicationId}/user-consent-scopes
  • Authentication
  • Management api authentication method Added
POST /api/applications/{id}/protected-app-metadata/custom-domains
  • Authentication
  • Management api authentication method Added
POST /api/applications/{id}/users/{userId}/consent-organizations
  • Authentication
  • Management api authentication method Added
POST /api/configs/jwt-customizer/test
  • Body
  • application/json content type Modified
    • object-1 alternative Modified
      • context attribute Modified
  • Authentication
  • Management api authentication method Added
POST /api/configs/oidc/{keyType}/rotate
  • Authentication
  • Management api authentication method Added
POST /api/connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • formItems attribute Modified
  • Authentication
  • Management api authentication method Added
GET /api/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/roles/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
GET /api/roles/{id}/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/roles/{id}/scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/roles/{id}/users
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId, agreeToTermsPolicy attributes Added
  • Authentication
  • Management api authentication method Added
GET /api/sso-connector-providers
  • Authentication
  • Management api authentication method Added
GET /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
GET /api/systems/application
  • Authentication
  • Management api authentication method Added
GET /api/user-assets/service-status
  • Authentication
  • Management api authentication method Added
GET /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Modified
  • Authentication
  • Management api authentication method Added
GET /api/users/{userId}/custom-data
  • Authentication
  • Management api authentication method Added
GET /api/users/{userId}/has-password
  • Authentication
  • Management api authentication method Added
GET /api/users/{userId}/mfa-verifications
  • Authentication
  • Management api authentication method Added
GET /api/users/{userId}/organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/users/{userId}/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
PATCH /api/applications/{id}
  • Body
  • application/json content type Modified
    • customClientMetadata attribute Modified
      • tenantId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata attribute Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
PATCH /api/configs/admin-console
  • Authentication
  • Management api authentication method Added
PATCH /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
  • Authentication
  • Management api authentication method Added
PATCH /api/connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • formItems attribute Modified
  • Authentication
  • Management api authentication method Added
PATCH /api/hooks/{id}
  • Body
  • application/json content type Modified
    • tenantId attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
POST /api/sso-connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
POST /api/user-assets
  • Authentication
  • Management api authentication method Added
POST /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Modified
  • Authentication
  • Management api authentication method Added
POST /api/users/{userId}/identities
  • Authentication
  • Management api authentication method Added
POST /api/users/{userId}/mfa-verifications
  • Authentication
  • Management api authentication method Added
POST /api/users/{userId}/password/verify
  • Authentication
  • Management api authentication method Added
POST /api/users/{userId}/roles
  • Authentication
  • Management api authentication method Added
POST /api/verification-codes
  • Authentication
  • Management api authentication method Added
POST /api/verification-codes/verify
  • Authentication
  • Management api authentication method Added
PUT /api/applications/{applicationId}/roles
  • Authentication
  • Management api authentication method Added
PUT /api/applications/{applicationId}/sign-in-experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
PUT /api/applications/{id}/users/{userId}/consent-organizations
  • Authentication
  • Management api authentication method Added
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
  • Authentication
  • Management api authentication method Added
PUT /api/custom-phrases/{languageTag}
  • Authentication
  • Management api authentication method Added
PUT /api/organization-invitations/{id}/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
PUT /api/organization-roles/{id}/resource-scopes
  • Authentication
  • Management api authentication method Added
PUT /api/organization-roles/{id}/scopes
  • Authentication
  • Management api authentication method Added
PUT /api/organizations/{id}/jit/email-domains
  • Authentication
  • Management api authentication method Added
PUT /api/organizations/{id}/jit/roles
  • Authentication
  • Management api authentication method Added
PUT /api/organizations/{id}/users
  • Authentication
  • Management api authentication method Added
PUT /api/organizations/{id}/users/{userId}/roles
  • Authentication
  • Management api authentication method Added
PUT /api/users/{userId}/identities/{target}
  • Authentication
  • Management api authentication method Added
PUT /api/users/{userId}/roles
  • Authentication
  • Management api authentication method Added
POST /api/connectors/{connectorId}/authorization-uri
  • Authentication
  • Management api authentication method Added
POST /api/connectors/{factoryId}/test
  • Authentication
  • Management api authentication method Added
POST /api/domains
  • Authentication
  • Management api authentication method Added
POST /api/hooks
  • Body
  • application/json content type Modified
    • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
POST /api/hooks/{id}/test
  • Authentication
  • Management api authentication method Added
POST /api/organization-invitations
  • Authentication
  • Management api authentication method Added
POST /api/organization-invitations/{id}/message
  • Authentication
  • Management api authentication method Added
POST /api/organization-roles
  • Body
  • application/json content type Modified
    • tenantId, type attributes Added
  • Authentication
  • Management api authentication method Added
POST /api/organization-roles/{id}/resource-scopes
  • Authentication
  • Management api authentication method Added
POST /api/organization-roles/{id}/scopes
  • Authentication
  • Management api authentication method Added
POST /api/organization-scopes
  • Body
  • application/json content type Modified
    • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
POST /api/organizations
  • Body
  • application/json content type Modified
    • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
POST /api/organizations/{id}/jit/email-domains
  • Authentication
  • Management api authentication method Added
POST /api/organizations/{id}/jit/roles
  • Authentication
  • Management api authentication method Added
POST /api/organizations/{id}/users
  • Authentication
  • Management api authentication method Added
POST /api/organizations/{id}/users/roles
  • Authentication
  • Management api authentication method Added
POST /api/organizations/{id}/users/{userId}/roles
  • Authentication
  • Management api authentication method Added
POST /api/resources
  • Body
  • application/json content type Modified
    • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
POST /api/resources/{resourceId}/scopes
  • Authentication
  • Management api authentication method Added
POST /api/roles
  • Body
  • application/json content type Modified
    • tenantId attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
POST /api/roles/{id}/applications
  • Authentication
  • Management api authentication method Added
POST /api/roles/{id}/scopes
  • Authentication
  • Management api authentication method Added
POST /api/roles/{id}/users
  • Authentication
  • Management api authentication method Added
DELETE /api/applications/{applicationId}/roles/{roleId}
  • Authentication
  • Management api authentication method Added
DELETE /api/organizations/{id}/users/{userId}/roles/{organizationRoleId}
  • Path went from `/api/organizations/{id}/users/{userId}/roles/{roleId}` to `/api/organizations/{id}/users/{userId}/roles/{organizationRoleId}` (same operationId)
  • Path
  • roleId path parameter Removed

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

      Breaking

  • organizationRoleId path parameter Added
  • Authentication
  • Management api authentication method Added
DELETE /api/resources/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/resources/{resourceId}/scopes/{scopeId}
  • Authentication
  • Management api authentication method Added
DELETE /api/roles/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/roles/{id}/applications/{applicationId}
  • Authentication
  • Management api authentication method Added
DELETE /api/roles/{id}/scopes/{scopeId}
  • Authentication
  • Management api authentication method Added
DELETE /api/roles/{id}/users/{userId}
  • Authentication
  • Management api authentication method Added
DELETE /api/sso-connectors/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/users/{userId}
  • Authentication
  • Management api authentication method Added
DELETE /api/users/{userId}/identities/{target}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Modified
  • Authentication
  • Management api authentication method Added
DELETE /api/users/{userId}/mfa-verifications/{verificationId}
  • Authentication
  • Management api authentication method Added
DELETE /api/users/{userId}/roles/{roleId}
  • Authentication
  • Management api authentication method Added
GET /api/.well-known/sign-in-exp
  • Response
  • 200 response Modified
    • application/json content type Modified
      • socialConnectors attribute Modified
      • tenantId, agreeToTermsPolicy, googleOneTap attributes Added
GET /api/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Query
  • excludeOrganizationId query parameter Added
  • Authentication
  • Management api authentication method Added
GET /api/applications/{applicationId}/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/applications/{applicationId}/sign-in-experience
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
GET /api/applications/{applicationId}/user-consent-scopes
  • Authentication
  • Management api authentication method Added
GET /api/applications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customClientMetadata attribute Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
GET /api/applications/{id}/protected-app-metadata/custom-domains
  • Authentication
  • Management api authentication method Added
DELETE /api/applications/{applicationId}/user-consent-scopes/{scopeType}/{scopeId}
  • Authentication
  • Management api authentication method Added
DELETE /api/applications/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/applications/{id}/protected-app-metadata/custom-domains/{domain}
  • Authentication
  • Management api authentication method Added
DELETE /api/applications/{id}/users/{userId}/consent-organizations/{organizationId}
  • Authentication
  • Management api authentication method Added
DELETE /api/configs/jwt-customizer/{tokenTypePath}
  • Authentication
  • Management api authentication method Added
DELETE /api/configs/oidc/{keyType}/{keyId}
  • Authentication
  • Management api authentication method Added
DELETE /api/connectors/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/custom-phrases/{languageTag}
  • Authentication
  • Management api authentication method Added
DELETE /api/domains/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/hooks/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/organization-invitations/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/organization-roles/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/organization-roles/{id}/resource-scopes/{scopeId}
  • Authentication
  • Management api authentication method Added
DELETE /api/organization-roles/{id}/scopes/{organizationScopeId}
  • Authentication
  • Management api authentication method Added
DELETE /api/organization-scopes/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/organizations/{id}
  • Authentication
  • Management api authentication method Added
DELETE /api/organizations/{id}/jit/email-domains/{emailDomain}
  • Authentication
  • Management api authentication method Added
DELETE /api/organizations/{id}/jit/roles/{organizationRoleId}
  • Authentication
  • Management api authentication method Added
DELETE /api/organizations/{id}/users/{userId}
  • Authentication
  • Management api authentication method Added
GET /api/applications/{id}/users/{userId}/consent-organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • organizations attribute Modified
  • Authentication
  • Management api authentication method Added
GET /api/logs/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
GET /api/organization-invitations
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organization-invitations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
GET /api/organization-roles
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organization-roles/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId, type attributes Added
  • Authentication
  • Management api authentication method Added
GET /api/organization-roles/{id}/resource-scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organization-roles/{id}/scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organization-scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organization-scopes/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
GET /api/organizations
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organizations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
GET /api/organizations/{id}/jit/email-domains
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organizations/{id}/jit/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organizations/{id}/users
  • Authentication
  • Management api authentication method Added
GET /api/organizations/{id}/users/{userId}/roles
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/organizations/{id}/users/{userId}/scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/resources
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/resources/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
GET /api/resources/{resourceId}/scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/configs/admin-console
  • Authentication
  • Management api authentication method Added
GET /api/configs/jwt-customizer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
  • Authentication
  • Management api authentication method Added
GET /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1 alternative Modified
  • Authentication
  • Management api authentication method Added
GET /api/configs/oidc/{keyType}
  • Authentication
  • Management api authentication method Added
GET /api/connector-factories
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/connector-factories/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • formItems attribute Modified
  • Authentication
  • Management api authentication method Added
GET /api/connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • formItems attribute Modified
  • Authentication
  • Management api authentication method Added
GET /api/custom-phrases
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/logs
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/hooks/{id}/recent-logs
  • Authentication
  • Management api authentication method Added
GET /api/hooks/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
GET /api/hooks
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • Management api authentication method Added
GET /api/domains/{id}
  • Authentication
  • Management api authentication method Added
GET /api/domains
  • Authentication
  • Management api authentication method Added
GET /api/dashboard/users/total
  • Authentication
  • Management api authentication method Added
GET /api/dashboard/users/new
  • Authentication
  • Management api authentication method Added
GET /api/dashboard/users/active
  • Authentication
  • Management api authentication method Added
GET /api/custom-phrases/{languageTag}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tenantId attribute Added
  • Authentication
  • Management api authentication method Added
Added 14
DELETE /api/organizations/{id}/applications/{applicationId}
DELETE /api/organizations/{id}/applications/{applicationId}/roles/{organizationRoleId}
DELETE /api/organizations/{id}/jit/sso-connectors/{ssoConnectorId}
GET /api/applications/{id}/organizations
GET /api/organizations/{id}/applications
GET /api/organizations/{id}/applications/{applicationId}/roles
GET /api/organizations/{id}/jit/sso-connectors
POST /api/organizations/{id}/applications
POST /api/organizations/{id}/applications/roles
POST /api/organizations/{id}/applications/{applicationId}/roles
POST /api/organizations/{id}/jit/sso-connectors
PUT /api/organizations/{id}/applications
PUT /api/organizations/{id}/applications/{applicationId}/roles
PUT /api/organizations/{id}/jit/sso-connectors
28 structure changes including:
8 Additions
20 Modifications
Modified 20
POST /api/organizations
  • Body
  • application/json content type Modified
    • isMfaRequired attribute Added
POST /api/connectors
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customData, fromEmail attributes Added
POST /api/applications
  • Body
  • application/json content type Modified
    • oidcClientMetadata attribute Modified
      • backchannelLogoutUri, backchannelLogoutSessionRequired properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • oidcClientMetadata attribute Modified
PATCH /api/sign-in-exp
  • Body
  • application/json content type Modified
    • socialSignIn attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • socialSignIn attribute Added
PATCH /api/organizations/{id}
  • Body
  • application/json content type Modified
    • isMfaRequired attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isMfaRequired attribute Added
PATCH /api/connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customData, fromEmail attributes Added
PATCH /api/applications/{id}
  • Body
  • application/json content type Modified
    • oidcClientMetadata attribute Modified
      • backchannelLogoutUri, backchannelLogoutSessionRequired properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • oidcClientMetadata attribute 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 attribute 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 attribute 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 attributes 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 attributes 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 attribute Modified
GET /api/applications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • oidcClientMetadata attribute 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 attribute Modified
      • socialSignIn attribute 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}
9 structure changes including:
9 Modifications
Modified 9 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 attribute 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 attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isDefault attribute Added
POST /api/interaction/single-sign-on/{connectorId}/authentication
  • Response
  • 500 response Added
POST /api/interaction/single-sign-on/{connectorId}/registration
  • Response
  • 500 response Added
POST /api/roles
  • Body
  • application/json content type Modified
    • isDefault attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isDefault attribute 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
9 structure changes including:
4 Additions
5 Modifications
Modified 5 Breaking
GET /api/applications/{applicationId}/user-consent-scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • organizationResourceScopes attribute Modified

        • Attribute is now required

          Breaking

        • Type is now array[object]

GET /api/interaction/consent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • organizations, missingResourceScopes attributes Modified
GET /api/organization-roles
  • Response
  • 200 response Modified
    • application/json content type Modified
POST /api/hooks
  • Body
  • application/json content type Modified
    • event attribute Modified

      • Type went from string | null to string

      • event property Modified

        • Type went from string | null to string

POST /api/organization-roles
  • Body
  • application/json content type Modified
    • resourceScopeIds attribute Modified

      • Attribute is now required

        Breaking

      • Type is now array[string]

      • resourceScopeIds property Modified

        • Property is now required

          Breaking

        • Type is now array[string]

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
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 attribute Added
POST /api/applications/{applicationId}/user-consent-scopes
  • Body
  • application/json content type Modified
    • organizationResourceScopes attribute 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 attribute 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 attribute 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 attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customData attribute Added
POST /api/organizations
  • Body
  • application/json content type Modified
    • customData attribute Added
11 structure changes including:
7 Additions
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 7
DELETE /api/organization-invitations/{id}
GET /api/organization-invitations
GET /api/organization-invitations/{id}
GET /api/organizations/{id}/users/{userId}/scopes
POST /api/organization-invitations
POST /api/organization-invitations/{id}/message
PUT /api/organization-invitations/{id}/status
33 structure changes including:
4 Additions
29 Modifications
Modified 29 Breaking
DELETE /api/users/{userId}/identities/{target}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities attribute Modified
      • updatedAt, profile attributes Added
GET /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerType attribute Added
GET /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities attribute Modified
      • updatedAt, profile attributes Added
PATCH /api/configs/admin-console
  • Body
  • application/json content type Modified
    • checkedChargeNotification attribute Modified
      • tenantMember property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification attribute Modified
PATCH /api/resources/{resourceId}/scopes/{scopeId}
  • Body
  • application/json content type Modified
    • description attribute Modified

      • Type went from string to string | null

      • description property Modified

        • Type went from string to string | null

  • Response
  • 200 response Modified
    • application/json content type Modified
      • description attribute Modified

        • Type went from string to string | null

PATCH /api/sso-connectors/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • providerType attribute Added
PATCH /api/users/{userId}
  • Body
  • application/json content type Modified
    • profile attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities attribute Modified
      • updatedAt, profile attributes Added
PATCH /api/users/{userId}/is-suspended
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities attribute Modified
      • updatedAt, profile attributes Added
PATCH /api/users/{userId}/password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities attribute Modified
      • updatedAt, profile attributes Added
POST /api/organization-roles
  • Body
  • application/json content type Modified
    • resourceScopeIds attribute Added
POST /api/resources/{resourceId}/scopes
  • Body
  • application/json content type Modified
    • description attribute Modified

      • Attribute is no longer required

      • Type went from string to string | null

      • description property Modified

        • Property is no longer required

        • Type went from string to string | null

POST /api/roles/{id}/scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
POST /api/users
  • Body
  • application/json content type Modified
    • profile attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • identities attribute Modified
      • updatedAt, profile attributes Added
POST /api/users/{userId}/identities
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Additional properties: attribute Modified
PUT /api/configs/jwt-customizer/{tokenTypePath}
  • Body
  • application/json content type Modified
    • envVars attribute Removed

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

        Breaking

    • environmentVariables attribute Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1, object-2 alternatives Modified
PUT /api/users/{userId}/identities/{target}
  • Body
  • application/json content type Modified
    • details attribute 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: attribute Modified
GET /api/applications/{applicationId}/user-consent-scopes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • resourceScopes attribute Modified
GET /api/configs/admin-console
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkedChargeNotification attribute Modified
GET /api/configs/jwt-customizer/{tokenTypePath}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object-1, object-2 alternatives Modified
GET /api/interaction/consent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • missingResourceScopes attribute Modified
GET /api/organization-roles
  • Query
  • q query parameter Added
  • Response
  • 400 response Added
GET /api/organizations/{id}/users
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/resources
  • 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/roles/{id}/scopes
  • 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/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
Added 4
POST /api/configs/jwt-customizer/test
PATCH /api/users/{userId}/profile
PATCH /api/configs/jwt-customizer/{tokenTypePath}
GET /api/configs/jwt-customizer
1 structure change including:
1 Modification
Modified 1
POST /api/interaction/single-sign-on/{connectorId}/authentication
  • Response
  • 422 response Added
4 structure changes including:
3 Additions
1 Modification
Modified 1
POST /api/users
  • Body
  • application/json content type Modified
    • avatar, customData attributes Added
Added 3
DELETE /api/configs/jwt-customizer/{tokenTypePath}
GET /api/configs/jwt-customizer/{tokenTypePath}
PUT /api/configs/jwt-customizer/{tokenTypePath}
1 structure change including:
1 Modification
Modified 1
POST /api/users
  • Body
  • application/json content type Modified
    • passwordDigest, passwordAlgorithm attributes Added
2 structure changes including:
1 Addition
1 Modification
Modified 1
POST /api/roles
  • Response
  • 404 response Added
Added 1
PUT /api/users/{userId}/identities/{target}
28 structure changes including:
14 Additions
14 Modifications
Modified 14
POST /api/verification-codes
  • Response
  • 501 response Added
POST /api/sso-connectors
  • Response
  • 409 response Added
POST /api/interaction/verification/webauthn-authentication
  • Response
  • 400 response Added
POST /api/interaction/verification/verification-code
  • Response
  • 501 response Added
POST /api/interaction/submit
  • Response
  • 403 response Added
POST /api/interaction/consent
  • Body
  • application/json content type Added
  • Response
  • 400 response Added
POST /api/authn/saml/{connectorId}
  • Response
  • 404 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
PATCH /api/sso-connectors/{id}
  • Response
  • 409 response Added
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
GET /api/roles/{id}/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /api/applications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • protectedAppMetadata, isThirdParty attributes Added
GET /api/applications
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Query
  • isThirdParty query parameter Added
DELETE /api/applications/{id}
  • Response
  • 422 response Added
Added 14
PUT /api/applications/{id}/users/{userId}/consent-organizations
PUT /api/applications/{applicationId}/sign-in-experience
POST /api/applications/{id}/users/{userId}/consent-organizations
POST /api/applications/{id}/protected-app-metadata/custom-domains
POST /api/applications/{applicationId}/user-consent-scopes
GET /api/systems/application
GET /api/interaction/consent
GET /api/applications/{id}/users/{userId}/consent-organizations
GET /api/applications/{id}/protected-app-metadata/custom-domains
GET /api/applications/{applicationId}/user-consent-scopes
GET /api/applications/{applicationId}/sign-in-experience
DELETE /api/applications/{id}/users/{userId}/consent-organizations/{organizationId}
DELETE /api/applications/{id}/protected-app-metadata/custom-domains/{domain}
DELETE /api/applications/{applicationId}/user-consent-scopes/{scopeType}/{scopeId}
5 structure changes including:
5 Modifications
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

24 structure changes including:
6 Breaking changes
5 Additions
13 Modifications
6 Removals
Modified 13 Breaking
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
POST /api/hooks/{id}/test
  • Body
  • application/json content type Modified
    • config attribute Modified
    • event attribute Added
POST /api/hooks
  • Body
  • application/json content type Modified
    • event attribute Modified

      • Attribute is now deprecated

    • config attribute Modified
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
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
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
PATCH /api/sign-in-exp
GET /api/sso-connector-providers
GET /api/sign-in-exp
GET /api/logs/{id}
GET /api/logs
28 structure changes including:
28 Additions
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
21 structure changes including:
2 Additions
19 Modifications
Modified 19 Breaking
PUT /api/custom-phrases/{languageTag}
  • Body
  • application/json content type Modified
    • [translationKey] attribute Modified
POST /api/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Added
POST /api/connectors/{factoryId}/test
  • Path
  • factoryId path parameter Added
PATCH /api/users/{userId}/password
  • 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}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Added
PATCH /api/sso-connectors/{id}/config
  • Path
  • id path parameter Added
  • Query
  • partialValidateConfig query parameter Added
PATCH /api/sso-connectors/{id}
  • Path
  • id path parameter Added
GET /api/users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Added
  • Query
  • includeSsoIdentities query parameter Added
GET /api/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/roles/{id}/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Added
GET /api/custom-phrases/{languageTag}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • translation attribute Modified
GET /api/custom-phrases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • translation attribute Modified
GET /api/connector-factories/{id}
  • Path
  • id path parameter Added
DELETE /api/users/{userId}/mfa-verifications/{verificationId}
  • Path
  • verificationId path parameter Added
DELETE /api/users/{userId}/identities/{target}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ssoIdentities attribute Added
DELETE /api/sso-connectors/{id}
  • Path
  • id path parameter Added
DELETE /api/configs/oidc/{keyType}/{keyId}
  • Path
  • keyId path parameter Added
Added 2
POST /api/interaction/single-sign-on/{connectorId}/registration
POST /api/authn/single-sign-on/saml/{connectorId}