概要

Authlete におけるクライアント ID

クライアント ID 別名

前述の課題を解決するのが「クライアント ID 別名 (Client ID Alias)」機能です。同機能を有効化すると、クライアントに対し、任意の文字列から成る「旧 ID」を、自動生成された「新 ID」とは別に割り当てられるようになります。

「クライアント ID 別名」機能は、クライアントからは透過的に動作します。クライアントは、認可リクエストやトークンリクエストの client_id リクエストパラメーター、あるいはトークンリクエストの Authorization ヘッダーに埋め込む値など、クライアント ID を用いるさまざまな場面で、「旧 ID」をそのまま使用できます。

またリソースサーバーは、トークンイントロスペクションの結果として、Authlete から「旧 ID」を取得できます。これにより、「旧 ID」の体系に基づく処理が可能となります。

---

設定方法

Authlete サービスの設定

「基本情報」タブの「Client ID の別名有効化」にて、「有効」を選択します。

クライアントの設定

「基本情報」タブの「Client ID の別名有効化」にて、「有効」を選択します。また同じく「Client ID の別名」にて、クライアント ID の別名として割り当てる値を入力します。

---

実行例

認可リクエスト

• リクエスト

curl -s -X POST .../auth/authorization
 -u $apiKey:$apiSecret
 -H 'Content-type: application/json'
 -d '{"parameters":
        "redirect_uri=https://client.example.org/cb/example.com
　　　　　&client_id=clientapp01
        &scope=payment
        &response_type=code"}'

• レスポンス

{
  "type": "authorizationResponse",
  "resultCode": "A004001",
  "resultMessage":
    "[A004001] Authlete has successfully issued a ticket
     to the service (API Key = 1415...) for the 
     authorization request from the client (ID = 1720...). 
     [response_type=code, openid=false]",
  "action": "INTERACTION",
  "client": {
    "clientId": 1720...,
    "clientIdAlias": "clientapp01",
    "clientIdAliasEnabled": true,
...

トークンリクエスト

• リクエスト

curl -s -X POST .../auth/token
 -u $apiKey:$apiSecret
 -H 'Content-type: application/json'
 -d '{"clientId":"clientapp01",
      "clientSecret":"...",
      "parameters":
        "redirect_uri=https://client.example.org/cb/example.com
         &grant_type=authorization_code
         &code=6GXV..."}'

• レスポンス

{
  "type": "tokenResponse",
  "resultCode": "A050001",
  "resultMessage":
    "[A050001] The token request (grant_type=authorization_code)
     was processed successfully.",
  "accessToken": "55Sp...",
  "action": "OK",
  "clientId": 17201083166161,
  "clientIdAlias": "clientapp01",
  "clientIdAliasUsed": true,
  "refreshToken": "xDcV...",
  "responseContent":
    "{\"access_token\":\"55Sp...\",
      \"refresh_token\":\"xDcV...\",
      \"scope\":\"payment\",
      \"token_type\":\"Bearer\",
      \"expires_in\":300}",
  "scopes": [
    "payment"
  ],
  "subject": "testuser01"
}

{
  "sub": "testuser01",
  "scope": "payment",
  "iss": "https://authlete.com",
  "exp": 1594...,
  "iat": 1594...,
  "client_id": "clientapp01",
  "jti": "IRBq..."
}

トークンイントロスペクション

• リクエスト

curl -s -X POST .../auth/introspection
 -u $apiKey:$apiSecret
 -H 'Content-type: application/json'
 -d '{"token":"55Sp..."}'

• レスポンス

{
  "type": "introspectionResponse",
  "resultCode": "A056001",
  "resultMessage": "[A056001] The access token is valid.",
  "action": "OK",
  "clientId": 1720...,
  "clientIdAlias": "clientapp01",
  "clientIdAliasUsed": true,
  "existent": true,
  "expiresAt": 1594632489000,
  "refreshable": true,
  "responseContent": "Bearer error=\"invalid_request\"",
  "scopes": [
    "payment"
  ],
  "subject": "testuser01",
  "sufficient": true,
  "usable": true
}