...
下記に例を示します。
GakuNin mAPに、氏名「日/英」、自己紹介「英」、所属「日/英とも空欄」で登録されていた場合、
リクエストの言語指定が「ja」であった場合は、氏名「日」、自己紹介「英」、所属「無し」を、
リクエストの言語指定が「en」であった場合は、氏名「英」、自己紹介「英」、所属「無し」を、
リクエストの言語指定がない場合は、氏名「英」、自己紹介「英」、所属「無し」を返します。
項目 | 日本語の登録 | 英語の登録 | lang=ja | lang=en | 言語指定なし |
---|---|---|---|---|---|
氏名 | 有 | 有 | 日本語 | 英語 | 英語 |
自己紹介 | - | 有 | 英語 | 英語 | 英語 |
所属 | - | - | - | - | - |
...
上記リクエストのレスポンスを以下に示します。(見易くなるように整形しています)
書式設定済み |
---|
{
"totalResults" : <ユーザ数>,
"entry" : [
{
"id" : "<mAPのeduPersonTargetedID>",
"displayName" : "<氏名>",
"aboutMe" : "<自己紹介>",
"emails" : [
{"type" : "email", "value" : "<mAPに登録したメールアドレス>"}
],
"languagesSpoken" : [
{"type" : "languageSpoken", "value" : "<mAPに登録した使用言語>"}
],
"organizations" : [
{"type" : "organization","value" : {"name" : "<mAPに登録した所属>"}}
],
"map_IdPEntityIDs" : [
{"type" : "map_IdPEntityID", "value" : "https://xxxxxx/idp/shibboleth"},
...
],
},
...
]
}
|
フィールド名 | 内容 | 備考 |
---|---|---|
totalResults | ユーザ数(全ての属性が許可されない場合そのユーザ分は差し引く) | Required |
id | mAPのeduPersonTargetedID |
|
displayName | 氏名 |
|
aboutMe | 自己紹介 |
|
emails | メールアドレス |
|
languagesSpoken languagesSpoken | 使用言語 | "en"もしくは"ja" |
organizations | 所属 |
|
map_IdPEntityIDs | 認証に利用するIdP(entityID) | 複数可 |
※ Required以外のフィールドは、利用者が同意したフィールドのみ送られます。また、全てのフィールドが存在しない(同意されていないもしくはSPが要求していない)場合はオブジェクトごと無くなります。
※ id には、mAPが発行する永続的な識別子のJavaScriptでの表現が入ります。SP毎に異なる値になりますが、同一SPに対しては同一ユーザについて常に同じ値を返します。
例: "https:\/\/map.gakunin.nii.ac.jp\/idp\/shibboleth!https:\/\/sp.example.ac.jp\/shibboleth-sp!S8Xi7R5Wf1pd8k8lq9eoiXyCtmw="
※ ここで送信される id と、ユーザ認証時にSimpleAggregationでmAPから送信されるeduPersonTargetedIDは一致します。
※ 特に、文字列中にUnicodeのコード表記(例:\u3042)の形式の文字を含む可能性があります。
※ 指定されたグループに下位グループが存在する場合、下位グループのメンバーも含まれます。
Groups API
リクエストURL
- SPコネクタに接続しているグループ情報の取得
https://map.gakunin.nii.ac.jp/api/groups/@me?[lang=言語]
言語 はオプション項目で、レスポンスで返す言語を指定します。
指定できるTYPEは、enとjaであり、下記の優先順位でレスポンスを返します。
リクエストURLの言語指定 > 英語入力 > 日本語入力
なお、英語、日本語ともGakuNin mAPに登録がなければ、当該属性自体が存在しない状態で返します。
下記に例を示します。
GakuNin mAPに、グループ名「日/英」、紹介文「日」で登録されていた場合、
リクエストの言語指定が「ja」であった場合は、グループ名「日」、紹介文「日」を、
リクエストの言語指定が「en」であった場合は、グループ名「英」、紹介文「日」を、
リクエストの言語指定がない場合は、グループ名「英」、紹介文「日」を返します。
項目 | 日本語の登録 | 英語の登録 | lang=ja | lang=en | 言語指定なし |
---|---|---|---|---|---|
グループ名 | 有 | 有 | 日本語 | 英語 | 英語 |
紹介文 | 有 | - | 日本語 | 日本語 | 日本語 |
...
上記リクエストのレスポンスを以下に示します。(見易くなるように整形しています)
書式設定済み |
---|
{
"totalResults" : <グループ数>,
"entry" : [
{
"id" : "<グループentityID>",
"title" : "<グループ名>",
"description" : "<グループの紹介>",
"map_totalMembers" : <グループのメンバー数>
},
...
]
}
|
※ <グループentityID> は、isMemberOfで取得することができるURL形式の値(のJavaScriptでの表現)
例: "https:\/\/map.gakunin.nii.ac.jp\/gr\/GakuNinTF"
※ このAPIで取得できるグループはSPコネクタに直接接続しているもののみです。上位グループ経由で接続している下位グループのグループ情報は含まれません。
※ <グループのメンバー数> には、管理者のみの人(管理者であるがメンバーでない人)は含まれません。また、属性送信に同意しているかどうかに関わらずカウントされますので、people APIを通して取得した数より大きい可能性があります。
※ 特に、文字列中にUnicodeのコード表記(例:\u3042)の形式の文字を含む可能性があります。
エラーレスポンス(共通)
HTTPステータス | 原因 |
---|---|
400 | APIのURL不正 |
403 | ・提示された証明書が学認参加SPのものでない場合 |
404 | 指定されたグループがない場合 |
...