リソース定義一覧

PocketSign Link v2 が提供する全組織・全サービスからREAD要求可能な組み込みのリソース定義の一覧です。

統合リソース

署名用電子証明書と券面事項入力補助APのうち、更新日時（updatedAt）が新しい方の値を使用し、どちらにも値がない場合は手入力の値にフォールバックする算出リソースです。 署名用電子証明書と券面事項入力補助APの更新日時が同じ場合は、署名用電子証明書の値を使用します。 通常のサービス連携では、個別の情報源ごとのリソースではなく、こちらの統合リソースを使います。

エイリアス	表示名	カテゴリ
klon/merged_first_name	名前	基本4情報
klon/merged_last_name	名字	基本4情報
klon/merged_maiden_name	旧姓	基本4情報
klon/merged_full_name	氏名	基本4情報
klon/merged_popular_name	通称	基本4情報
klon/merged_gender	性別	基本4情報
klon/merged_prefecture_address	都道府県名までの住所	基本4情報
klon/merged_city_address	市区町村までの住所	基本4情報
klon/merged_full_address	住所	基本4情報
klon/merged_moving_abroad_date	国外転出日	基本4情報
klon/merged_birth_year	誕生年	基本4情報
klon/merged_birth_day	誕生日	基本4情報
klon/merged_birth_date	生年月日	基本4情報
klon/merged_first_name_ruby	名前のフリガナ	基本4情報
klon/merged_last_name_ruby	名字のフリガナ	基本4情報
klon/merged_maiden_name_ruby	旧姓のフリガナ	基本4情報
klon/merged_full_name_ruby	氏名のフリガナ	基本4情報

連絡先

エイリアス	表示名	カテゴリ
klon/email_address	メールアドレス	連絡先
klon/phone_number	電話番号	連絡先

実行リソース

値そのものではなく、端末機能の利用やプッシュ通知送信などの権限を表すリソースです。

エイリアス	表示名	カテゴリ
klon/push_notification	プッシュ通知を送るための権限	端末に対する権限
klon/access_camera	端末のカメラにアクセスするための権限	端末に対する権限
klon/get_current_position	端末の位置情報にアクセスするための権限	端末に対する権限
klon/get_high_accuracy_current_position	端末の詳細な位置情報にアクセスするための権限	端末に対する権限
klon/access_fitness_data	身体活動に関する情報にアクセスするための権限	ヘルスケア情報

証明書現況確認

JPKI 証明書の失効確認を行うための実行リソースです。

エイリアス	表示名
klon/check_jpki_card_digital_signature_certificate_revocation	カード署名用電子証明書の失効確認
klon/check_jpki_card_user_authentication_certificate_revocation	カード利用者証明用電子証明書の失効確認
klon/check_jpki_mobile_digital_signature_certificate_revocation	スマホ署名用電子証明書の失効確認
klon/check_jpki_mobile_user_authentication_certificate_revocation	スマホ利用者証明用電子証明書の失効確認

情報源ごとのリソース

以下は、署名用電子証明書・券面事項入力補助AP・手入力それぞれの情報源から取得した値をそのまま保持する格納リソースです。 通常は上記の統合リソースを使い、情報源の区別が必要な場合にのみ参照します。

署名用電子証明書

エイリアスのプレフィックスは klon/signing_ です。

エイリアス	表示名
klon/signing_first_name	署名用電子証明書を用いて取得した名前
klon/signing_last_name	署名用電子証明書を用いて取得した名字
klon/signing_maiden_name	署名用電子証明書を用いて取得した旧姓
klon/signing_full_name	署名用電子証明書を用いて取得した氏名
klon/signing_popular_name	署名用電子証明書を用いて取得した通称
klon/signing_gender	署名用電子証明書を用いて取得した性別
klon/signing_prefecture_address	署名用電子証明書を用いて取得した都道府県名までの住所
klon/signing_city_address	署名用電子証明書を用いて取得した市区町村までの住所
klon/signing_full_address	署名用電子証明書を用いて取得した住所
klon/signing_moving_abroad_date	署名用電子証明書を用いて取得した国外転出日
klon/signing_birth_year	署名用電子証明書を用いて取得した誕生年
klon/signing_birth_day	署名用電子証明書を用いて取得した誕生日
klon/signing_birth_date	署名用電子証明書を用いて取得した生年月日
klon/signing_first_name_ruby	署名用電子証明書を用いて取得した名前のフリガナ
klon/signing_last_name_ruby	署名用電子証明書を用いて取得した名字のフリガナ
klon/signing_maiden_name_ruby	署名用電子証明書を用いて取得した旧姓のフリガナ
klon/signing_full_name_ruby	署名用電子証明書を用いて取得した氏名のフリガナ

券面事項入力補助AP

エイリアスのプレフィックスは klon/ticket_ です。

エイリアス	表示名
klon/ticket_first_name	券面事項入力補助APを用いて取得した名前
klon/ticket_last_name	券面事項入力補助APを用いて取得した名字
klon/ticket_maiden_name	券面事項入力補助APを用いて取得した旧姓
klon/ticket_full_name	券面事項入力補助APを用いて取得した氏名
klon/ticket_popular_name	券面事項入力補助APを用いて取得した通称
klon/ticket_gender	券面事項入力補助APを用いて取得した性別
klon/ticket_prefecture_address	券面事項入力補助APを用いて取得した都道府県名までの住所
klon/ticket_city_address	券面事項入力補助APを用いて取得した市区町村までの住所
klon/ticket_full_address	券面事項入力補助APを用いて取得した住所
klon/ticket_moving_abroad_date	券面事項入力補助APを用いて取得した国外転出日
klon/ticket_birth_year	券面事項入力補助APを用いて取得した誕生年
klon/ticket_birth_day	券面事項入力補助APを用いて取得した誕生日
klon/ticket_birth_date	券面事項入力補助APを用いて取得した生年月日
klon/ticket_first_name_ruby	券面事項入力補助APを用いて取得した名前のフリガナ
klon/ticket_last_name_ruby	券面事項入力補助APを用いて取得した名字のフリガナ
klon/ticket_maiden_name_ruby	券面事項入力補助APを用いて取得した旧姓のフリガナ
klon/ticket_full_name_ruby	券面事項入力補助APを用いて取得した氏名のフリガナ

手入力

エイリアスのプレフィックスは klon/manual_ です。

エイリアス	表示名
klon/manual_first_name	手入力で取得した名前
klon/manual_last_name	手入力で取得した名字
klon/manual_maiden_name	手入力で取得した旧姓
klon/manual_full_name	手入力で取得した氏名
klon/manual_popular_name	手入力で取得した通称
klon/manual_gender	手入力で取得した性別
klon/manual_prefecture_address	手入力で取得した都道府県名までの住所
klon/manual_city_address	手入力で取得した市区町村までの住所
klon/manual_full_address	手入力で取得した住所
klon/manual_moving_abroad_date	手入力で取得した国外転出日
klon/manual_birth_year	手入力で取得した誕生年
klon/manual_birth_day	手入力で取得した誕生日
klon/manual_birth_date	手入力で取得した生年月日
klon/manual_first_name_ruby	手入力で取得した名前のフリガナ
klon/manual_last_name_ruby	手入力で取得した名字のフリガナ
klon/manual_maiden_name_ruby	手入力で取得した旧姓のフリガナ
klon/manual_full_name_ruby	手入力で取得した氏名のフリガナ

サービスごとの自動生成リソース

サービスを新規作成すると、そのサービスに対するユーザーの subscription_id を返す算出リソースが自動的に作成されます。 デフォルトのリソース要求の許可設定はサービスが属する組織の全サービスです。

自動生成されるエイリアスは 2 種類あります。

エイリアス形式	例
klon/service.{service-id}.subscription-id	klon/service.550e8400-e29b-41d4-a716-446655440000.subscription-id
klon/service.{org-slug}.{service-slug}.subscription-id	klon/service.my_org.my-service.subscription-id