Page tree
Skip to end of metadata
Go to start of metadata

Services API

Services APIは、学認クラウドゲートウェイサービスが利用者に対して提示するページと同等の情報を学認参加機関が取得するためのAPIです。

認証は学認におけるIdPメタデータに記載されている証明書を用いたTLSクライアント証明書認証により行います。証明書の extended Key Usage (eKU) に clientAuth が記載されていなければなりません。
また、学認クラウドゲートウェイサービスが提示する証明書も学認におけるIdPメタデータに記載されているものとなりますので、IdP側で適切に検証してください。

リクエストURL

  • 機関所属の利用者が利用可能なサービスを取得

https://cg.gakunin.jp/api/services/@me

  • 利用者の所属機関と所属グループで利用可能なサービスを取得

https://cg.gakunin.jp/api/services/利用者ID(ePPN)

機関所属の利用者が利用可能なサービスを取得

 @meを指定した場合は、当該機関所属の利用者として利用可能なサービスの一覧を応答します。

 利用者の所属機関と所属グループで利用可能なサービスを取得

利用者ID(ePPN)を指定した場合は、当該利用者の所属機関と所属グループで利用可能なサービスの一覧を応答します。

学認クラウドゲートウェイサービスのアカウントが作成されていない利用者のIDを指定した場合には、@meを指定した場合と同等の内容を応答します。

レスポンス

[
    {
        "name": "<サービス名称>",
        "service_url": <サービスURL>
        "logo": "<ロゴURL>",
        "introduction": "<紹介文>",
        "public_tags": [
            "<公開タグ>",
            ...
        ],
        "private_tags" : [
            "<プライベートタグ>",
            ...
        ],
        "groups": [
            {
                name: "<グループ名称>",
                url: "<グループURL>"
            },
            ...
        ]
    },
    ...
]
フィールド名内容備考
nameサービスの名称
service_urlサービスのURLoptional
logoサービスのロゴイメージのURL
introduction紹介文optional
public_tags公開タグの配列optional
private_tagsプライベートタグの配列optional
groupsグループ情報の配列optional

nameグループの名称
urlグループに接続されたサービスのURL

備考欄にoptionalと記載のあるフィールドは、値がない場合には含まれません。

エラーレスポンス

HTTPステータス原因
403クライアント認証に失敗した場合

認証したIdPのスコープと指定したePPNのScopeが異なる場合


 

  • No labels