OAuth & OpenID Connect
このセクションでは、データを交換できるように、外部クライアントをTimelineに接続できます。
OAuthは、あるサービス(アプリケーション)に対して他のサービスのユーザーリソースにアクセスする権利を付与できる承認プロトコルです。このプロトコルにより、アプリケーションにユーザー名とパスワードを渡す必要がなくなります。これにより、サードパーティのアプリケーションがリソースオーナーに代わって、アプリケーションまたはサービスへのアクセスを制限できるようになります。
サードパーティのアプリケーションをTimelineで外部クライアントとして登録して、接続を作成することができます。そのために、左のバーの下部にあるあなたのユーザーアバターをクリックして、 アカウント設定を選択し、OAuth & OpenID Connect タブへ進んでください。次に、 クライアントを登録をクリックして、表示された OAuthクライアントの登録ウィンドウで必要な事項を記入してください。
クライアントが登録された後、ご利用のアプリケーションのコードーベースでクライアントをセットアップする際に選択された認証フローのサポートを実装することが必要になる可能性があります。Timeline側からの情報が必要な場合、次のリンクを使って、Timeline's OAuth 2.0 metadataを参照してください。https://{your.timeline.instance}.com/api/auth/oauth/.well-known/oauth-authorization-server
接続が両側でセットアップされたら、登録されたアプリケーション(クライアント)は、ログインおよびデータ交換のためにあなたのアカウントにアクセスできるようになります。情報交換は、OAuth 2.0のaccess_tokenにより管理され、アクセスは、接続されているサードパーティのアプリケーションにより開始された認証が成功した場合のみ許可されます。
OAuth 2.0に関する技術的な情報や詳細が必要な場合、https://www.rfc-editor.org/rfc/rfc6749リンクを使って、OAuth 2.0仕様書の最新版および、
https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topicsリンクを使って、OAuth 2.0実装セキュリティのベストプラクティスをお読みください。
Timeline API専用ガイド Timeline API guide > Registering OAuth Client in Timelineを使って、OAuthの登録に関する詳細な情報を入手し、APIを通じてTimeline機能を利用するための接続を作成するステップの一例を確認できます。
OpenID Connect
新規クライアントを登録する際に、OpenID Connectも有効にすることができます。これは、OAuth 2.0の機能を拡大するプロトコルであり、認証済みのユーザーのプロファイルデータの一部を収集するオプションがあります。OpenID Connectを有効にすることにより、Timeline自体がIDプロバイダーとなっているインフラストラクチャーにシングルサインオンを実装するためにこの技術を使うことができます。
有効にした場合、苦情処理を選択するように促され、Timelineのプロファイルにおいてユーザー情報が反映されます。
- email
TimelineがユーザーのIDとして認識する、登録の際に使用されたメールアドレス - name
ユーザーのお名前と名字 - given_name
ユーザーのお名前 - family_name
ユーザーの 名字 - phone_number
ユーザーの電話番号 - locale
ユーザーが選択した言語 - zoneinfo
ユーザーのタイムゾーン
この苦情処理の値は、個別のJWT(JSON Web Token)であるid_tokenのコンテンツの一部となります。この追加トークンは、必要なOAuth認証フローを実行する際にaccess_tokenとともに取得され、ユーザーは認証リクエストとともに"openid"スコープ値を送信します。JWTはユーザーIDをエンコードし、その安全性を確保します。それをデコードするには、ご利用のアプリケーションのコードベースで実装されている標準JWTライブラリーを使うことができます。以下は、Timelineのユーザーデータを含むid_tokensの一例を挙げます。
OpenIDを使用した認証フローに対するサポートの実装についてTimeline側からの情報が必要な場合、次のリンクを使って、Timeline's OpenID Connect metadataを参照してください。https://{your.timeline.instance}.com/api/auth/oauth/.well-known/openid-configuration
05.09.2024 16:23:55