GetUsersFromGroup
≥4.6
Interface Function
Acquire user information under specified group.
Request Parameter
| Parameter | Type | Remarks |
|---|---|---|
| GroupName | String | Specify group name，case sensitive |
| PageIndex | int | Page number |
| PageSize | int | Page size |
| WithSubGroupUser | bool | Whether to include user of sub-group, true by default. |
[warning] Note
To control interface performance and return data volumn, the interface limits PageSize to a maximum of 100. The interface returns 100 pieces of data if the maximum value is exceeded.
Return Data Type
Reference return sample
Input Sample
{
"GroupName":"DemoGroup",
"PageIndex":1,
"PageSize":5,
"WithSubGroupUser":false
}
Return Sample
{
"StatusCode": 200,
"Info": "Request (or process) succeeded",
"Data": [
{
"OfficeCode": null,
"CurrOfficeCode": null,
"CountryCode": null,
"LoS": null,
"LoSCode": null,
"Location": null,
"OUCode": null,
"OU": null,
"GradeCode": null,
"Grade": null,
"EntityGroupCode": null,
"CurrGroupCode": null,
"CurrEntityCode": null,
"IsProfessional": null,
"JobTitle": null,
"NotesID": null,
"TermDate": null,
"Email": "demo@digitalmaker.com",
"FirstName": null,
"LastName": null,
"OrganizationCode": "DemoTenant",
"Phone": "888",
"UserName": "DemoUser",
"UserID": "b8859dae-aea4-4947-bc97-b5c9c59b1440",
"StaffCode": "##190111030237723",
"Avatar": null,
"ActiveFlag": "true"
},
{
"OfficeCode": null,
"CurrOfficeCode": null,
"CountryCode": null,
"LoS": null,
"LoSCode": null,
"Location": null,
"OUCode": null,
"OU": null,
"GradeCode": null,
"Grade": null,
"EntityGroupCode": null,
"CurrGroupCode": null,
"CurrEntityCode": null,
"IsProfessional": null,
"JobTitle": null,
"NotesID": null,
"TermDate": null,
"Email": "demo1@digitalmaker.com",
"FirstName": null,
"LastName": null,
"OrganizationCode": "DemoTenant",
"Phone": "888",
"UserName": "DemoUser1",
"UserID": "6c980b97-6c5f-4583-b970-f661b9069c6e",
"StaffCode": "##190111030743542",
"Avatar": null,
"ActiveFlag": "true"
},
{
"OfficeCode": null,
"CurrOfficeCode": null,
"CountryCode": null,
"LoS": null,
"LoSCode": null,
"Location": null,
"OUCode": null,
"OU": null,
"GradeCode": null,
"Grade": null,
"EntityGroupCode": null,
"CurrGroupCode": null,
"CurrEntityCode": null,
"IsProfessional": null,
"JobTitle": null,
"NotesID": null,
"TermDate": null,
"Email": "demo2@digitalmaker.com",
"FirstName": null,
"LastName": null,
"OrganizationCode": "DemoTenant",
"Phone": "888",
"UserName": "DemoUser2",
"UserID": "420e8692-814b-491a-96c3-af63ea2a3ec1",
"StaffCode": "##190111030819430",
"Avatar": null,
"ActiveFlag": "true"
},
{
"OfficeCode": null,
"CurrOfficeCode": null,
"CountryCode": null,
"LoS": null,
"LoSCode": null,
"Location": null,
"OUCode": null,
"OU": null,
"GradeCode": null,
"Grade": null,
"EntityGroupCode": null,
"CurrGroupCode": null,
"CurrEntityCode": null,
"IsProfessional": null,
"JobTitle": null,
"NotesID": null,
"TermDate": null,
"Email": "demo3@digitalmaker.com",
"FirstName": null,
"LastName": null,
"OrganizationCode": "DemoTenant",
"Phone": "888",
"UserName": "DemoUser3",
"UserID": "35b9263c-2199-45eb-8f35-885efda8557b",
"StaffCode": "##190111030859912",
"Avatar": null,
"ActiveFlag": "true"
},
{
"OfficeCode": null,
"CurrOfficeCode": null,
"CountryCode": null,
"LoS": null,
"LoSCode": null,
"Location": null,
"OUCode": null,
"OU": null,
"GradeCode": null,
"Grade": null,
"EntityGroupCode": null,
"CurrGroupCode": null,
"CurrEntityCode": null,
"IsProfessional": null,
"JobTitle": null,
"NotesID": null,
"TermDate": null,
"Email": "demo@digitalmaker.com",
"FirstName": null,
"LastName": null,
"OrganizationCode": "DemoTenant",
"Phone": "888",
"UserName": "DemoUser",
"UserID": "3a920db8-695c-4ca1-934b-ab47bd871cd8",
"StaffCode": "##190111031015539",
"Avatar": null,
"ActiveFlag": "true"
}
]
}