Skip to main content
Auth0 の製品開発において、私たちは次の方針で取り組んでいます。
  • お客様にいち早く、かつ継続的に価値を提供し、そのフィードバックをもとに改善を重ねる
  • お客様を深く理解することに努め、あらゆる意思決定においてその視点を踏まえる
  • よりよい判断ができるよう、徹底してデータを収集・分析する
  • 機能を追加する際は、製品全体の現在の姿、理想の姿、将来の姿を見据えて構想し、設計する
このドキュメントでは、Auth0 プラットフォームにおける後方互換性のある変更 (非破壊的変更) と、後方互換性のない変更 (破壊的変更) の考え方について説明します。これらの違いを理解することで、開発者は Auth0 のサービスを利用する際に、自身のアプリケーションに生じうる影響をあらかじめ把握できます。 このドキュメントでは、連携に関する期待値を明確にするために、一般的な変更とその互換性について概説します。ここで説明する変更は、網羅的または包括的なものではありません。互換性のない変更の詳細については、以下のトピックを参照してください。

​
Auth0 API

Auth0 は、Authentication API や Management API などの API を提供・維持しています。これらの API はそれぞれ、文書化された API 仕様と関連する成果物に基づき、Auth0 と顧客の間の契約を定めるものです。Auth0 は、IETF や OIDC などの標準化団体が策定した広く認知された標準に従っています。標準が存在しない場合は、ベストプラクティスに従って独自の API を開発しています。 これらの API に対する変更は、後方互換性のあるものもないものも含め、機能、セキュリティ、またはパフォーマンスを向上させるために、必要に応じて行われます。

​
後方互換性があり、非破壊的な変更

後方互換性のある変更は、Auth0 プラットフォームと顧客のアプリケーション間の相互運用性を損なわず、顧客が直ちに対応したり、移行プロセスに参加したりする必要もありません。 互換性を損なわない変更の例には、次のようなものがあります。
  • 不透明文字列: 不透明文字列 (例: トークン、ID) の形式やサイズは変更される場合があります。クライアントは、サイズや形式が固定であると想定すべきではありません。不透明文字列の最大サイズは 4096 文字を超えません。
  • のサイズ: の仕様 (RFC6749) では、JWT 資格情報のサイズは定義されていません。Auth0 はサイズが可変の JWT を発行することがあるため、クライアントは特定のサイズを前提にすべきではありません。
  • 認可コードのサイズ: クライアントは、OAuth 仕様に従い、認可コードのサイズが変動する可能性があることを想定しておく必要があります。
  • 認識されないレスポンスパラメータ: クライアントは認識されないレスポンスパラメータを無視する必要があります。これにより、Auth0 は現在の機能に影響を与えることなく新機能を追加できます。
  • 新しいリソース、フィールド、ヘッダー、またはスコープ: 新しい API リソース、フィールド、ヘッダー、またはスコープが追加されても、それらの要素を認識しない、または使用しない既存のクライアントには影響しません。
後方互換性のある変更についてさらに詳しくは、製品ライフサイクルステージに記載されている Auth0 の API 変更ガイドラインを参照してください。

​
後方互換性のない変更 (互換性のない変更)

後方互換性のない変更は、Auth0 プラットフォームと顧客のアプリケーション間の相互運用性を変えてしまうことで、不具合や障害を引き起こす可能性があります。このような変更が必要な場合は、顧客がテナント実装を調整できるよう、非推奨化と移行プロセスに従って事前通知とサポートが提供されます。 互換性のない変更の例としては、次のようなものがあります。
  • API リソースの削除: API リソースが削除または名前変更されると、そのリソースに依存しているクライアントにとって互換性のない変更となります。
  • URI 構造の変更: 既存の URI の構造を変更すると、それに依存しているクライアントに影響が及ぶ可能性があります。
  • メソッド、パラメータ、またはフィールドの削除: メソッド、パラメータ、またはフィールドが削除または名前変更されると、これらの要素を使用しているクライアントにとって互換性のない変更となります。
  • デフォルト値の変更: フィールドのデフォルト値の変更は、既存の連携に影響を与え、互換性のない変更に該当する可能性があります。
  • エラーレスポンスおよびステータスコードの変更: エラーレスポンスの形式、エラーコード、またはステータスコードの変更は、既存のクライアントの動作を損なう可能性があります。
  • JWT 形式: token の JWT 形式の変更は、互換性のない変更です
  • JSON 形式: JSON 値の型の変更は、互換性のない変更です。
互換性のない変更がある場合は、必ず非推奨化プロセスが開始され、顧客には通知が行われるとともに、新しい動作へ移行するために少なくとも 6 か月の猶予が提供されます。詳細については、非推奨化と提供終了プロセスを参照してください。

​
Auth0の取り組み

Auth0は、後方互換性のない変更による影響を、次のプロセスによって最小限に抑えます。
  • 非推奨化のお知らせ: Auth0は、今後予定されている変更をお客様に事前に知らせるため、非推奨化を告知します。
  • 移行期間: お客様には、更新後の機能へ移行するために最低6か月の期間が設けられ、当社の移行プロセスでガイダンスが提供されます。
  • サポート終了: 移行期間が終了すると、非推奨となった機能はサポート終了段階に入り、以後は利用できなくなります。

​
文書化されていない API

文書化されていない Auth0 API はプライベートなものと見なされ、予告なく変更される場合があります。これらの API は非推奨化プロセスの対象ではないため、本番システムでこれらに依存することは避けてください。