メインコンテンツまでスキップ

リソース定義と権限

このページでは、PocketSign Platform からリソース定義の作成手順をまとめます。リソースの概念は リソースモデル を参照してください。

リソース定義を管理する​

組織は、自組織で扱うリソース定義を Platform から作成・更新できます。

リソース定義はサイドバーの「リソース定義」から一覧できます。ここでは表示名、説明、カテゴリ、種別を確認し、新規作成や詳細編集へ進みます。

Platform のリソース定義一覧画面。表示名、説明、カテゴリ、種別の列と新規作成ボタンが表示されている

リソース定義の作成​

リソース定義を作成するときに決める項目は次のとおりです。各項目の意味は リソースモデル を参照してください。

  • 表示名・説明
  • カテゴリ
  • 値フォーマット（string / json / binary）

リソース要求の許可設定​

リソース定義はデフォルトでは、定義した組織内のサービスだけが要求できます。他組織のサービスからの要求を許可する場合は、リソース定義に対して許可ルールを追加します。

リソース定義詳細画面の「リソース要求の許可設定」で、許可範囲と許可する操作を選択します。

リソース要求の許可設定の追加フォーム。許可範囲と許可する操作を選択する

サービスが要求できるリソースは、サービス詳細画面の「リソース要求」タブで確認します。以下はサンプルサービス（sample-service）の例です。要求可能リソース一覧は検索欄で絞り込めます。

サンプルサービスのリソース要求画面。デフォルト要求リソースと、署名用で絞り込んだ要求可能リソース一覧が表示されている

許可ルールでは次を設定します。

  • 許可範囲
    • グローバル: 全組織の全サービス
    • 組織: 指定した組織の全サービス
    • サービス: 指定した組織の指定したサービス
  • 許可する権限（READ / WRITE / INVOKE のうち、リソース種別が許容するもの）

許可していない組織のサービスから要求が来ても、認可フローでエラーになります。

リソース定義変更時の影響範囲​

すでに利用されているリソース定義を変更する際は、次の影響を確認してください。

  • 表示名・説明・カテゴリ: ユーザーに表示される同意画面の表示に反映されます。
  • エイリアス: エイリアスを変更すると、エイリアスでリソースを参照していたサービスは旧エイリアスでは参照できなくなります。原則として変更しないでください。
  • JSON Schema（json 種別）: スキーマの破壊的変更によって、既に Registry に保存されている値がスキーマに適合しなくなった場合、引き続き値は読み取りできますが、同じ値で書き込みはできなくなります。

関連ページ​