文章 List Group User REST 端点

URLs

GET api/v1/groups/{groupid}/members/roles.xml (or .json)

LIST role members of a group.

GET api/v1/groups/{groupid}/members/users.xml (or .json)

LIST user members of a group.

请求参数

名称

类型

描述

必需

默认值

选项

GroupId

int?

Either GroupId or UserId is required

否

UserId

int?

Either GroupId or UserId is required

否

JoinedAfterDate

DateTime?

Used to filter the results to just members who joined after this date.

否

MembershipType

string

Used to filter the results to just members of the type specified. Options are: Owner, Manager, Member, PendingMember.

否

UsernameFilter

string

Used to filter the results to members matching the specified username filter.

否

MemberType

string

Used to filter results to users or roles. Valid options are users, roles

否

IncludeRoleMembers

bool?

When making a users request can optionally include users who are also role members instead of just direct members.

否

SortBy

string

Default SortBy is GroupName. Valid options for users list are: GroupSortOrder, GroupName, UserJoinedDate, Username, DisplayName, UserLastActiveDate, UserPosts, UserEmail, MembershipType, MembershipDate, Score:SCORE_ID. Valid options for roles list are: GroupSortOrder, GroupName, RoleAddedDate, RoleName, MembershipType.

否

SortOrder

string

Default SortOrder is Descending when sorting by scores, ascending otherwise. Ascending and Descending are the options.

否

PageSize

int?

Specify the number of results to return per page. If not set the default is 20. The max is 100.

否

PageIndex

int?

Specify the page number of paged results to return. Zero-based index. If not specified the default is 0.

否