OpenID Connect Client Setup

OPTiM Store へ OpenID Connect Relying Party としての登録を行うためのAPIです。
OPTiM Store では、OAuth 2.0 Dynamic Client Registration Protocol に準拠した形で OpenID Connect Client Registration Request を受け付けています。

Request

Method

POST

Resource URL

URLは、OPTiM Store との契約時にご連絡いたします。
本章では、https://store-xyz-api.optim.co.jp/api/idp/connect/register として記載致します。

Header Parameters

Content-Type: application/json

Query Parameters

なし

Request Parameters

key	type	description
software_statement	String	Software Statement AttributesのJSONを署名したJWT形式の文字列

Sample Body

{
  "software_statement": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IjNJSDZkVTZfM0UzRE83Sl9xRElKdVVjTXBTQmlkbEpPalJuS1ZaZ0I1WWsifQ.eyJpc3MiOiJodHRwczovL3lvdXItc2VydmljZS5leGFtcGxlLmNvbS9jb250cmFjdC9hcGkiLCJhdWQiOiJ7eyBjb25uZWN0X3JlZ2lzdHJhdGlvbl9lbmRwb2ludCB9fSIsInJlZGlyZWN0X3VyaXMiOlsiaHR0cHM6Ly95b3VyLXNlcnZpY2UuZXhhbXBsZS5jb20vY29ubmVjdC9jYWxsYmFjayJdLCJpYXQiOjE0NjQwNTM3MDYsImV4cCI6MTQ2NDA1NDMwNn0.i2zqja0pr2CKY037wM79JEDmkAxa46bBum-ijiSHNE1BtLIQtuQxuh-VXA0R371vbCyIRo1O_NJDsviMkKMYE7-_HJ8LL7rxJNEqhc1itHplbyA9Ip1Hi2qlxZhHalU3Le91paN2P9jFpaj2jpMxpvM8ynGBdxzRpbtiEGBfSjCD0-PDPUb7B_15NLqdmRCtqf2vIA_JnErWk595R4esSNgvRicUqOFGhFnQ_Dtq-w5u2beSCWe9K0amA2wEjgpdkKcOj6RraNDxpxCge5BKQmhUXoe2rJRPcZsm7_ku7FdIdtcori3VJeU2UrEFApnnmglY0bItRdIoXzenJ_KzpQ"
}

Software Statement Attributes

key	type	description
iss	string	リクエスト発行者 (issuer) の識別子です。御社サービスの Contract Start API Endpoint URL となります。
aud	string	リクエスト受信者 (audience) の識別子です。OPTiM Store の OpenID Connect Client Registration API Endpoint URL となります。
redirect_uris	array	OPTiM Store で認証されたユーザーが御社サービスにリダイレクトされて返される際の Callback Endpoint URL です。特に複数の redirect_uri を使い分ける必要の無い場合は、要素数1の JSON Array としてください。
iat	integer	リクエスト生成日時 (issued_at) を示す Unix Timestamp です。
exp	integer	リクエストの有効期限 (expires_at) を示す Unix Timestamp です。

Software Statement Signing Key

Contract Setup APIで、御社サービスから OPTiM Store ヘ渡した公開鍵に紐づく秘密鍵
- 御社サービス側では、該当の秘密鍵で署名を行ってください

Contract Statement Sample JSON

{
  "iss": "https://your-service.example.com/contract/api",
  "aud": "https://store-xyz-api.optim.co.jp/api/idp/connect/register",
  "redirect_uris": [
    "https://your-service.example.com/optim-store/callback"
  ],
  "iat": 1464053706,
  "exp": 1464054306
}

Response

正常なリクエストである場合、OPTiM Store から下記に従ったレスポンスが返却されます。

Response Code

201 Created

Response Parameters

key	type	description
client_id	string	御社サービスから OPTiM Store へ認証連携を行う際に必要な、テナント契約に紐付いた client_id(クライアント識別子)
client_secret	string	御社サービスから OPTiM Store へ認証連携を行う際に必要な、テナント契約に紐付いた client_secret(クライアントのシークレット)

Sample Body

{
  "client_id": "37969af118b7a9e5aed8f7e7b6252ecd",
  "client_secret": "1d966bb7eb7f8d6f5114e1cc04b0f7edb16f49e5f22843bf4bf640338fd6daec"
}

注意事項

レスポンスの各パラメータは、 255 byte 以下の JSON String としてください。