...
項目 | 日本語の登録 | 英語の登録 | lang=ja | lang=en | 言語指定なし |
---|---|---|---|---|---|
氏名 | 有 | 有 | 日本語 | 英語 | 英語 |
自己紹介 | - | 有 | 英語 | 英語 | 英語 |
所属 | - | - | - | - | - |
レスポンス
コード ブロック | |
---|---|
書式設定済み | |
javascript | \{ "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 | メールアドレス |
|
languages Spoken | 使用言語 | "en"もしくは"ja" |
organizations | 所属 |
|
map_IdPEntityIDs | 認証に利用するIdP(entityID) | 複数可 |
※ Required以外のフィールドは、利用者が同意したフィールドのみ送られます。また、全てのフィールドが存在しない(同意されていないもしくはSPが要求していない)場合はオブジェクトごと無くなります。
※ id には、mAPが発行する永続的な識別子です。SP毎に異なる値になりますが、同一SPに対しては同一ユーザについて常に同じ値を返します。には、mAPが発行する永続的な識別子が入ります。SP毎に異なる値になりますが、同一SPに対しては同一ユーザについて常に同じ値を返します。
例: "https:\/\/map.gakunin.nii.ac.jp\/idp\/shibboleth!https:\/\/sp.example.ac.jp\/shibboleth-sp!S8Xi7R5Wf1pd8k8lq9eoiXyCtmw="
※ 特に、文字列中にUnicodeのコード表記(例:\u3042)の形式の文字を含む可能性があります。
※ 指定されたグループに下位グループが存在する場合、下位グループのメンバーも含まれます。
groups API
リクエストURL
- SPコネクタに接続しているグループ情報の取得
言語]
...
レスポンス
上記リクエストのレスポンスを以下に示します。
コード ブロック | |
---|---|
書式設定済み | |
javascript | \{ "totalResults" : <グループ数>, "entry" : \[ \{ { "id" : "<グループURL>", "title" : "<グループ名>", "description" : "<グループの紹介>", "map_totalMembers" : <グループのメンバー数> \ }, ... \]\ ] } |
※ <グループURL> は、isMemberOfで取得することができるURL形式の値のJavaScriptでの表現
例: "https:\/\/map.gakunin.nii.ac.jp\/gr\/GakuNinTF"
※ このAPIで取得できるグループはSPコネクタに直接接続しているもののみです。上位グループ経由で接続している下位グループのグループ情報は含まれません。
※ <グループのメンバー数> には、管理者のみの人(管理者であるがメンバーでない人)は含まれません。また、属性送信に同意しているかどうかに関わらずカウントされますので、people APIを通して取得した数より大きい可能性があります。
※ 特に、文字列中にUnicodeのコード表記(例:\u3042)の形式の文字を含む可能性があります。
...