メインコンテンツまでスキップ

GetUsersInGroup

指定したグループのユーザー一覧を取得する

Description​

指定したグループのユーザー一覧を取得します。

Method​

GET

Request URL Format​

/api/v0/groups/:group-id/users

URL Params​

group-id :  グループID

Query Param​

recursive        : bool  //グループ階層の下をたどって、所属するすべてのユーザーを取得します。
username         : 検索したいユーザーのユーザー名を指定します。
email            : 検索したいユーザーのメールアドレスを指定します。
user_code        : 検索したいユーザーのユーザーコードを指定します。
limit            : デフォルト100。100以下が指定可能。100より上を指定された場合はエラーを返す
page             : デフォルト1。limitで区切られたページネーションを指定
total            : デフォルトfalse。true指定でtotal_members（グループに所属する全ユーザー数）がレスポンスに含まれる
role             : デフォルトtrue。false指定でユーザーごとのrole情報を省略し処理が高速化される

username, email, user_codeは指定された値の完全一致、AND検索を行います。

Request URL Sample​

GET https://api.xxx.com/api/v0/groups/5df9d7d7aeae8e2fa894e324/users?email="ユーザーのemail"&total=true

Response Sample​

{
    "members": [
        {
            "u_id": "ユーザーID",
            "username": "ユーザー名",
            "email": "ユーザーのemail",
            "profile_pic": "https://storage.googleapis.com/linker/pub/default.png", //("画像のストレージ領域")
            "confirmed": true, //("bool, このユーザーが確認済みかどうか")
            "email_sent": true,//("bool, このユーザーにemailが送られたかどうか")
            "is_sv": true //("bool, このユーザーがスーパバイザー型かどうか、true=supervisorである")
            "user_roles": [],
            "user_code": "ユーザーコード"
        } //("ユーザー毎にオブジェクトが返される")
    ],
    "count": 1, //("membersに返却されたユーザー数")
    "total_members": 10 //("指定されたグループに所属する全ユーザー数、total=trueでレスポンスに含まれる")
}