リソース定義
リソース定義の作成
PocketSign Platform の Link v2 画面でサイドバーの「リソース定義」に移動し、「新規作成」をクリックします。 リソース定義作成モーダルが開くので、必要事項を入力し、「作成」ボタンをクリックします。
作成時に決める主な項目は次のとおりです。
- 表示名: ユーザーに表示されるリソース名です。
- 説明: 同意画面などでユーザーに表示される説明です。
- カテゴリ: リソースの分類です。
- 値フォーマット: 格納する値の形式です。JSON を選ぶ場合は JSON Schema も設定します。
作成後に変更できない項目があります。値フォーマット、JSON Schema は、利用中のサービスに影響するため作成時に十分確認してください。
リソース定義の作成に成功した場合、新たに作成されたリソース定義がリソース定義一覧に表示されます。
リソース定義の設定
リソース一覧から操作したいリソース定義をクリックすると、各リソース定義の詳細の閲覧・編集ができます。
リソース定義 ID
リソース定義作成時に自動的に割り振られる ID です。 この ID は変更できません。
表示名
リソース定義の表示名です。 実際にユーザーに表示されます。
説明
リソース定義に関する説明です。 実際にユーザーに表示されます。
カテゴリ
リソースの分類です。同意画面や管理画面で、どの種類の情報・操作かを判別しやすくするために使用します。
種別
リソース定義の種類です。 「格納」または「算出」など、値を保存するリソースか、呼び出しにより値を返すリソースかを選択します。
エイリアス
OIDC の authorization_details などでリソースを参照するための別名です。作成時には設定できないため、作成後にリソース定義詳細画面で確認・追加します。
エイリアスを削除すると、既存の実装から参照できなくなる可能性があります。原則として、利用中のエイリアスは削除しないでください。
値フォーマット
格納する値の形式です。JSON を選んだ場合は JSON Schema によって値の構造を定義します。
データを書き込む際には、このスキーマに従った形式で値を保存する必要があります。 データを読み込む際には、このスキーマに従った形式の値が取得されます。 JSON Schema のバージョンは draft-07 です。
要求許可設定の追加
リソース定義の「要求許可設定」では、どのサービスにどの権限を許可するかを管理します。
リソース定義詳細画面の「要求許可を追加」で、許可範囲と許可する操作を選択します。
特定のサービスを追加する
許可範囲で「サービス」を選択すると、このリソース定義を要求できるサービスを個別に追加できます。 対象の組織とサービス、許可する操作を選択し、「追加」をクリックします。
サービスの追加に成功すると、要求許可設定の一覧が更新されます。
組織または全サービスを追加する
特定のサービスではなく、同一組織のサービスまたは全サービスに対してリソース要求を許可することもできます。 許可範囲で「組織」または「グローバル」を選択し、許可する操作を選択して「追加」をクリックします。
追加に成功すると、リソース定義詳細画面の要求許可設定に追加したサービスと権限が表示されます。