Yahoo! ID連携用語集

Client ID(アプリケーションID)

パートナー企業様のWebサイトやアプリケーションを識別するIDです。最大255Byteの可変長文字列です。パートナー企業様が運営するWebサイトやアプリケーション単位で一つのID登録が必要です。

※Yahoo! ID連携 v2では「Client ID」、Yahoo! ID連携 v1では「アプリケーションID」と呼びます。

シークレット

サーバーサイド・アプリケーションとして登録した場合にClient ID(アプリケーションID)と対で発行される共有鍵です。ユーザーのパスワード同様、開発者はシークレット値を外部に漏れないように安全に管理する必要があります。40Byteの固定長文字列です。

サーバーサイド・アプリケーション

サーバー側で動作するアプリケーション、いわゆるWebサイトの総称です。

クライアントサイド・アプリケーション

ユーザーの端末上にインストールされるネイティブアプリケーションや、JavaScriptやFlashなどで実装されたブラウザー上で動作するWebアプリケーションなど、クライアント側で動作するアプリケーションの総称です。クライアントサイド・アプリケーションは仕組み上、シークレットを安全に保持できないことから、Client ID(アプリケーションID)登録時にシークレットは発行されません。

ユーザー識別子

Yahoo! JAPAN IDに対して一意に発行されるパートナー企業様向けのユーザーIDです。ID TokenもしくはUserInfo API経由で取得できます。ID Tokenを用いたシングルサインオンを実装する場合には、このユーザー識別子をアカウントにひもづけて管理してください。

Access Token(アクセストークン)

各種WebAPIにアクセスするための、最大3072Byteの可変長トークンです。通常は1時間の有効期限です。

Refresh Token(リフレッシュトークン)

アクセストークンを更新するために利用される、最大512Byteの可変長トークンです。通常長い有効期限が設けられており、アクセストークンの有効期限が切れた際に利用します。

ID Token(IDトークン)

ユーザーの認証情報を含む、最大1024Byteの可変長トークンです。認証情報にはID Tokenの発行元、発行先のClient ID(アプリケーションID)、発行日時、有効期限、ユーザー識別子などが含まれます。ID TokenはJWTと呼ばれるフォーマットで構成され、署名が付加されています。OpenID Connect の仕様上定義されています。

UserInfoAPI

パートナー企業様側で、Yahoo! JAPAN IDに紐付いたユーザーの属性情報を取得できる属性情報取得APIです。パートナー企業様のWebサイトとのID連携フローにおいて、会員登録をさせるときの登録情報フォームを補完するときに利用することができます。
詳細な仕様については別紙『属性取得API(UserInfoAPI)』を参照ください。

アプリケーションの管理

Yahoo! ID連携 v2

利用のルール

開発のヒント