ページ ツリー

比較バージョン

キー

  • この行は追加されました。
  • この行は削除されました。
  • 書式設定が変更されました。

...

グループentityID/ID

%2Fadmin

取得値

グループを指定

グループメンバー一覧

 〃

グループ管理者一覧

SPコネクタを指定

仕様外

 〃

仕様外

※ グループentityID/IDとして指定できるのは、SPコネクタに直接接続しているグループのみです。

言語 はオプション項目であり、レスポンスで返す言語を指定します。
指定できるTYPEは、en と ja で、下記の優先順位でレスポンスを返します。
           リクエストURLの言語指定 > 英語入力 > 日本語入力
なお、英語、日本語ともGakuNin mAP(クラウドゲートウェイ)に登録がなければ、当該属性自体が存在しない状態で返します。

認可: 認証に用いた証明書に紐付くSPを対象SPとするSPコネクタについて、当該SPコネクタと指定したグループが接続している場合のみメンバー情報を取得することができます。なお、グループentityID/IDとして指定できるのは、SPコネクタに直接接続しているグループのみです。

下記に例を示します。
GakuNin mAP(クラウドゲートウェイ)に、氏名「日/英」、自己紹介「英」、所属「日/英とも空欄」で登録されていた場合、
リクエストの言語指定が「ja」であった場合は、氏名「日」、自己紹介「英」、所属「無し」を、
リクエストの言語指定が「en」であった場合は、氏名「英」、自己紹介「英」、所属「無し」を、
リクエストの言語指定がない場合は、氏名「英」、自己紹介「英」、所属「無し」を返します。

...

SPコネクタentityID は、「https://cg.gakunin.jp/sp/」とSPコネクタIDと組み合わせてURLエンコードした値です。
例えば、SPコネクタIDが GakuNinTF の場合は、
(元の値)https://cg.gakunin.jp/sp/GakuNinTF
URLエンコード後は、下記となります。
(変換後の値)https%3A%2F%2Fcg.gakunin.jp%2Fsp%2FGakuNinTF
※ %3A、%2Fのアルファベットは小文字も許容します。

SPコネクタとして @me が指定された場合は、認証に用いた証明書に紐付くSPを対象SPとする全てのSPコネクタと解釈され、いずれかのSPコネクタに接続しているグループ情報を返します。

言語 はオプション項目で、レスポンスで返す言語を指定します。
指定できるTYPEは、enとjaであり、下記の優先順位でレスポンスを返します。
          リクエストURLの言語指定 > 英語入力 > 日本語入力
なお、英語、日本語ともGakuNin mAP(クラウドゲートウェイ)に登録がなければ、当該属性自体が存在しない状態で返します。

認可: 指定されたSPコネクタは、認証に用いた証明書に紐付くSPを対象SPとするSPコネクタでなければなりません。

下記に例を示します。
GakuNin mAP(クラウドゲートウェイ)に、グループ名「日/英」、紹介文「日」で登録されていた場合、
リクエストの言語指定が「ja」であった場合は、グループ名「日」、紹介文「日」を、
リクエストの言語指定が「en」であった場合は、グループ名「英」、紹介文「日」を、
リクエストの言語指定がない場合は、グループ名「英」、紹介文「日」を返します。

...

HTTPステータス

原因

400

APIのURL不正

403

・提示された証明書が学認参加SPのものでない場合
・セレクタ(@me)が未設定の場合
・指定されたグループが対象となるSPコネクタと接続していない場合

404

指定されたグループがない場合

@meはクライアント証明書認証に用いた証明書に紐付くSPに紐付く0個以上のSPコネクタと解釈されます。該当する学認参加SPが存在する場合は、クラウドゲートウェイ上に対応するSPコネクタが存在しない場合でもエラーにはなりません。@meはクライアント証明書認証に用いた証明書に紐付くSPを対象SPとする0個以上のSPコネクタと解釈されます。該当する学認参加SPが存在する場合は、クラウドゲートウェイ上に対応するSPコネクタが存在しない場合でもエラーにはなりません。
※ レスポンスに返すデータが0件の場合は空配列のentryを返します。