サービスの作成と設定
このページでは、PocketSign Platform で組織情報を登録してからサービスを作成し、OIDC クライアントの設定値を取得するまでの手順を示します。手順を終えると、サービスのバックエンドから OIDC 連携を実装するために必要な次の値が揃います。
- クライアント ID
- クライアントシークレット
- サービス ID
前提条件
- PocketSign Platform にアクセスできるアカウントを持っていること
手順
1. PocketSign Platform にログインする
利用する環境に応じた Platform のオリジンへアクセスします。環境ごとのオリジンは 環境 を参照してください。
2. 組織情報を登録する
インスタンスごとに組織情報を一度だけ登録します。登録時に決める項目は次のとおりです。
| 項目 | 説明 |
|---|---|
| slug | 組織を URL や識別子で参照する短い文字列。登録後に変更できません |
| 組織名 | サービス利用者にも表示される正式名称 |
| 住所・代表者 | 法人情報 |
slug はリソース定義のエイリアスなどにも使われます(例: my_org/account_profile)。後から変更できないため、慎重に決めてください。
3. サービスを作成する
組織内に提供するサービスを作成します。サービスは OIDC クライアントを持つ単位です。
サービスを作成すると、サービス ID が払い出されます。後続の OIDC クライアント設定や Webhook 設定はサービスに紐づきます。
サービスの公開向け基本情報(表示名・短縮名・説明・問い合わせ先・アイコン)は同じサービス画面から設定できます。これらは同意画面などでエンドユーザーに表示されます。
4. OIDC クライアントを作成する
サービス画面の OIDC クライアント設定から、新しいクライアントを作成します。
作成時に決める主な項目は次のとおりです。各項目が何に効くかは クライアント設定 を参照してください。
- クライアント認証方式(
client_secret_basic/client_secret_post/private_key_jwt) redirect_uris- 各種 TTL
環境ごとに別のクライアントを作る運用を推奨します。理由と運用パターンは OIDC クライアント を参照してください。
5. redirect_uri を登録する
クライアントが認可フローで遷移する先の URI を登録します。
- 環境ごとに別のクライアントを作り、各クライアントには当該環境の URI だけを登録します
authorizeとtokenのリクエストで使うredirect_uriは、登録した URI と完全一致する必要があります
6. クライアントシークレットを保管する
作成直後に表示されるクライアントシークレットは、その画面でしか確認できません。サービスのバックエンド用のシークレットマネージャー等に保管してください。
シークレットの管理とローテーション運用は シークレットの管理 を参照してください。
続けて設定する項目
サービスの要件に応じて、ここから次の設定を進めます。
- 非同期通知を扱うサービスは、Webhook の登録(ウェブフック設定)
- ポケットサイン開発環境で動作確認するには、開発用デバッグユーザー と 開発環境 認証アプリ
次のステップ
OIDC クライアントの設定値が揃ったら、OIDC の概要 または 通常のログイン連携 に進み、サービス側の実装を開始してください。