SCIM Client Setup

SCIM Protocol に従い Provisioning をするために、SCIM Server となる御社サービスに対して OPTiM Store から SCIM Client を登録するための API です。
OAuth 2.0 Dynamic Client Registration Protocol に準拠した形で SCIM 用 OAuth Client を登録します。

御社サービス側に SCIM Client Registration API Endpoint をご用意いただく必要があります。当該 Endpoint URL は、OPTiM Store へのアプリ登録時に設定します。

Request

Method

  • POST

Resource URL

  • 任意のURL
    • 該当URLを、OPTiM Store 登録時にご連絡ください。
  • 本章では、 として記載致します。

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": "eyJhbGciOiJSUzI1NiIsImtpZCI6InU2N1BXM1JjMFRvM3RfNGZQejNDd2IwZnV4SUNYWGhJOFN3Qm5hazRDNlEifQ.eyJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6ImNsaWVudF9zZWNyZXRfYmFzaWMiLCJncmFudF90eXBlcyI6ImNsaWVudF9jcmVkZW50aWFscyIsImNsaWVudF9uYW1lIjoiT3B0aW0gU3RvcmUgQ29udHJhY3QjMTIzNDUifQ.aBu83V3iJrYpH6yZdBdEfERvJxCAdOKtHaIiELLCWVaY9iqNP8yiAfm2sXePG1WaPm2K_RPBc_03s-vJSwDr_opgt8Va5pSLLW90JQ-hLXZIav0yu2NF3ZWCOP0ku5hzpOopOHP2gLXMAA1Bt1FcqQTwH6TBgPWIe1zbvtQe4UgxQncmyllvlvmvGygmrPaUGS0GNMr_kbkP1yccwlb3C30Kea5Ljsc-Y4nsFCw81r90Dm-hoe3Ox8Jrjq9P5KC7Z_Cqj5CGmff3pCQIT3gjU677cSgJr7F-W0Xi15970Xlv_z4rUmNqTKQHOQgkCMj7VxTRO03ajf7KqjtmB8VkJw"
}

Software Statement Attributes

key type description
iss string リクエスト発行者 (issuer) の識別子です。OPTiM Store の URL となります。
aud string リクエスト受信者 (audience) の識別子です。御社サービスの SCIM Client Registration API Endpoint URL となります。
iat integer リクエスト生成日時 (issued_at) を示す Unix Timestamp です。
exp integer リクエストの有効期限 (expires_at) を示す Unix Timestamp です。

Software Statement Signing Key

  • Contract Setup APIで、OPTiM Storeから御社サービスへ渡した公開鍵に紐づく秘密鍵
    • 御社サービス側では、該当の公開鍵を利用し、software_statementのJWTの署名検証を行ってください。
    • 署名検証については、JOSE実装チュートリアル を参考にしてください。

Contract Statement Sample JSON

{
  "iss": "https://store-xyz.optim.co.jp",
  "aud": "",
  "iat": 1464053706,
  "exp": 1464054306
}

Response

御社サービス側でリクエストを承認された場合、下記に従ったレスポンスを返却してください。

Response Code

200 OK

Response Parameters

key type description
client_id string 御社サービスのSCIM APIにアクセスする際の、OAuth 2.0 の client_id(クライアント識別子)
client_secret string 御社サービスのSCIM APIにアクセスする際の、OAuth 2.0 の client_secret(クライアントのシークレット)

Sample Body

{
  "client_id": "a05d189799f16cd00088d8866283ee7e",
  "client_secret": "80fbd7da6000230b4575244ae8f854d6efe10eef46c68ba47806adc2df5a34cc"
}

注意事項

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