SharePointのRESTコマンドのまとめです。
今回は、ユーザー・グループ・ロールのREST APIのまとめです。
SharePoint REST サービスとは
SharePoint の RESTの概要は以下を参照ください。
GroupCollection
エンドポイント URI
http://＜site url＞/_api/web/sitegroups
| メソッド | HTTP method | 説明 |
|---|---|---|
| GetById | GET | グループのメンバー ID に基づいてコレクションからグループを返します。 |
| GetByName | GET | グループの名前に基づいて、コレクションからクロスサイト グループを返します。 |
| RemoveById | POST | 指定されたメンバー ID を持つグループを、コレクションから削除します。 |
| RemoveByLoginName | POST | 指定された名前を持つクロスサイト グループをコレクションから削除します。 |
RoleAssignmentCollection
エンドポイント URI
http://＜site url＞/_api/web/roleassignments
| メソッド | HTTP method | 説明 |
|---|---|---|
| AddRoleAssignment | POST | 指定されたプリンシパルとロール定義を持つ新しいロール割り当てをコレクションに追加します。 |
| GetByPrincipalId | GET | 指定されたプリンシパル ID と関連付けられているロール割り当てをコレクションから取得します。 |
| RemoveRoleAssignment | POST | 指定されたプリンシパルとロール定義を持つ新しいロール割り当てをコレクションから削除します。 |
UserCollection
エンドポイント URI
http://＜site url＞/api/web/siteusers
http://＜site url＞/api/web/sitegroups(＜group id＞)/users
| メソッド | HTTP method | 説明 |
|---|---|---|
| GetByEmail | GET | 指定された電子メール アドレスを持つユーザーを取得します。 |
| GetById | GET | 指定されたメンバー識別子 (ID) を持つユーザーを取得します。 |
| GetByLoginName | GET | 指定したログイン名を持つユーザーを取得します。 |
| RemoveById | POST | 指定された ID を持つユーザーを削除します。 |
| RemoveByLoginName | POST | 指定されたログイン名を持つユーザーを削除します。 |
UserCustomActionCollection
エンドポイント URI
http://
| メソッド | HTTP method | 説明 |
|---|---|---|
| Clear | POST | コレクション内のすべてのカスタム アクションを削除します。 |
| GetById | GET | 指定された識別子を持つカスタム アクションを返します。 |
