¶ Get a list of department members

Update time: 2025-07-23 07:34:21

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If this document description is incorrect, please refer to V3 API.

Get a list of department members by organization code, department ID, and sorting. It supports paging and can choose to obtain custom data, identities, etc.

¶ Method name

ManagementClient.list_department_members

¶ Request parameters

Name	Type	Is it required?	Default value	Description	Sample value
organizationCode	string	yes	-	Organization code	`steamory`
departmentId	string	yes	-	Department ID, root department is `root`	`root`
sortBy	string	no	JoinDepartmentAt	Sort by	`JoinDepartmentAt`
orderBy	string	no	Desc	In ascending or descending order	`Desc`
departmentIdType	string	no	department_id	The type of department ID used in this call	`department_id`
includeChildrenDepartments	boolean	no	-	Whether to include members of child departments
page	number	no	1	Current page number, starting from 1	`1`
limit	number	no	10	Number per page, maximum cannot exceed 50, default is 10	`10`
withCustomData	boolean	no	-	Whether to get custom data	`true`
withIdentities	boolean	no	-	Whether to get identities	`true`
withDepartmentIds	boolean	no	-	Whether to get a list of department IDs	`true`
tenantId	string	no	-	Tenant ID	`623c20b2a062aaaaf41b17da`

¶ Request Response

Type: UserPaginatedRespDto

Name	Type	Description
statusCode	number	Business status code, which can be used to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segmented error code, which can be used to get the specific error type (successful request does not return). For a detailed list of error codes, please see: API Code List (opens new window)
requestId	string	Request ID. Returned when the request fails.
data	UserPagingDto	Response data

Example results:

{
  "statusCode": 200,
  "message": "Success",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "list": {
      "userId": "6229ffaxxxxxxxxcade3e3d9",
      "createdAt": "2022-07-03T03:20:30.000Z",
      "updatedAt": "2022-07-03T03:20:30.000Z",
      "status": "Activated",
      "workStatus": "Active",
      "externalId": "10010",
      "email": "test@example.com",
      "phone": "188xxxx8888",
      "phoneCountryCode": "+86",
      "username": "bob",
      "name": "xxx",
      "nickname": "xxx",
      "photo": "https://files.authing.co/authing-console/default-user-avatar.png",
      "loginsCount": 3,
      "lastLogin": "2022-07-03T03:20:30.000Z",
      "lastIp": "127.0.0.1",
      "gender": "M",
      "emailVerified": true,
      "phoneVerified": true,
      "passwordLastSetAt": "2022-07-03T03:20:30.000Z",
      "birthdate": "2022-06-03",
      "country": "CN",
      "province": "BJ",
      "city": "BJ",
      "address": "xxxxx",
      "streetAddress": "xxxxx",
      "postalCode": "438100",
      "company": "steamory",
      "browser": "Mozilla/5.0 (Linux; Android 10; V2001A; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/87.0.4280.141 Mobile Safari/537.36 VivoBrowser/10.2.10.0",
      "device": "iOS",
      "givenName": "xx",
      "familyName": "xxx",
      "middleName": "James",
      "profile": "alice",
      "preferredUsername": "alice",
      "website": "https://my-website.com",
      "zoneinfo": "GMT-08:00",
      "locale": "af",
      "formatted": "132, My Street, Kingston, New York 12401.",
      "region": "Xinjiang Uyghur Autonomous Region",
      "userSourceType": "register",
      "passwordSecurityLevel": 1,
      "departmentIds": "[\"624d930c3xxxx5c08dd4986e\",\"624d93102xxxx012f33cd2fe\"]",
      "identities": {
        "identityId": "62299d8b866d2dab79a89dc4",
        "extIdpId": "6076bacxxxxxxxxd80d993b5",
        "provider": "wechat",
        "type": "openid",
        "userIdInIdp": "oj7Nq05R-RRaqak0_YlMLnnIwsvg",
        "accessToken": "57_fK0xgSL_NwVlS-gmUwlMQ2N6AONNIOAYxxxx",
        "refreshToken": "57_IZFu91Ak1Wg6DRytZFFIOd3upNF5lH7vPxxxxx",
        "originConnIds": "[\"605492ac41xxxxe0362f0707\"]"
      },
      "identityNumber": "420421xxxxxxxx1234",
      "customData": {
        "school": "xxxxx",
        "age": 22
      },
      "statusChangedAt": "2022-07-03T03:20:30.000Z"
    }
  }
}

¶ Data Structure

¶ UserPagingDto

Name	Type	Is it required?	Description	Sample value
totalCount	number	Yes	Total number of records
list	array	Yes	Data list Nested type: UserDto.

¶ UserDto

Name	Type	Is this field required?	Description	Sample value
userId	string	Yes	The unique identifier of the user, which can be user ID, user name, email, phone number, externalId, or ID in an external identity source. For details, see the description of the userIdType field. The default is user id.	`6229ffaxxxxxxxxcade3e3d9`
createdAt	string	yes	creation time	`2022-07-03T03:20:30.000Z`
updatedAt	string	yes	update time	`2022-07-03T03:20:30.000Z`
status	string	yes	current status of the account: - Activated: normal status - Suspended: deactivated - Deactivated: disabled - Resigned: resigned - Archived: archived	Suspended
workStatus	string	yes	current work status of the account	Closed
externalId	string	no	third-party external ID	`10010`
email	string	no	email address, case insensitive	`test@example.com`
phone	string	No	Phone number without area code. If it is an international phone number, please specify the area code in the phoneCountryCode parameter.	`188xxxx8888`
phoneCountryCode	string	No	Phone area code. This parameter is optional for phone numbers in mainland China. The GenAuth SMS service does not yet support international phone numbers. You need to configure the corresponding international SMS service in the GenAuth console. For a complete list of phone area codes, please refer to https://en.wikipedia.org/wiki/List_of_country_calling_codes.	`+86`
username	string	No	User name, unique in the user pool	`bob`
name	string	No	User's real name, not unique	`xxx`
nickname	string	no	nickname	`xxx`
photo	string	no	avatar link	`https://files.authing.co/authing-console/default-user-avatar.png`
loginsCount	number	no	total number of historical logins	`3`
lastLogin	string	no	last login time	`2022-07-03T03:20:30.000Z`
lastIp	string	no	last login IP	`127.0.0.1`
gender	string	yes	gender: - `M`: male, `male` - `F`: female, `female` - `U`: unknown, `unknown`	M
emailVerified	boolean	yes	email verified	`true`
phoneVerified	boolean	Yes	Is the phone number verified?	`true`
passwordLastSetAt	string	No	The time when the user last changed his password	`2022-07-03T03:20:30.000Z`
birthdate	string	No	Date of birth	`2022-06-03`
country	string	No	Country	`CN`
province	string	No	Province	`BJ`
city	string	No	City	`BJ`
address	string	No	Address	`xxxxx`
streetAddress	string	No	Street Address	`xxxxx`
postalCode	string	No	Postal Code	`438100`
company	string	No	Company	`steamory`
browser	string	No	Last browser used UA	`Mozilla/5.0 (Linux; Android 10; V2001A; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/87.0.4280.141 Mobile Safari/537.36 VivoBrowser/10.2.10.0`
device	string	no	The device used to log in last	`iOS`
givenName	string	no	givenName	`xx`
familyName	string	no	Last name	`xxx`
middleName	string	no	Middle name	`James`
profile	string	no	Preferred Username	`alice`
preferredUsername	string	no	Preferred Username	`alice`
website	string	no	User personal website	`https://my-website.com`
zoneinfo	string	no	User time zone information	`GMT-08:00`
locale	string	no	Locale	`af`
formatted	string	no	Full standard address	`132, My Street, Kingston, New York 12401.`
region	string	no	User region	`Xinjiang Uyghur Autonomous Region`
userSourceType	string	yes	Source type: - `excel`: Import via excel - `register`: User self-registration - `adminCreated`: Manual creation by the administrator (including creating users using the management API) - `syncTask`: Synchronization task of the sync center	excel
userSourceId	string	No	Application ID or synchronization task ID
lastLoginApp	string	no	ID of the application where the user last logged in
mainDepartmentId	string	no	ID of the user's main department
lastMfaTime	string	no	Time when the user last performed MFA authentication
passwordSecurityLevel	number	no	User password security strength level	`1`
resetPasswordOnNextLogin	boolean	no	Require password reset on next login
registerSource	array	no	Registration method
departmentIds	array	no	List of department IDs to which the user belongs	`["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]`
identities	array	no	External identity source Nested type: IdentityDto.
identityNumber	string	No	User ID number	`420421xxxxxxxx1234`
customData	object	No	User's extended field data	`{"school":"xxxxx","age":22}`
postIdList	array	No	User-associated department ID
statusChangedAt	string	No	User status last modified time	`2022-07-03T03:20:30.000Z`
tenantId	string	No	User tenant ID

¶ IdentityDto

Name	Type	Is it required	Description	Sample value
identityId	string	yes	Identity source ID	`62299d8b866d2dab79a89dc4`
extIdpId	string	yes	Identity source connection ID	`6076bacxxxxxxxxd80d993b5`
provider	string	yes	External identity source type: - `wechat`: WeChat - `qq`: QQ - `wechatwork`: WeChat for Business - `dingtalk`: DingTalk - `weibo`: Weibo - `github`: GitHub - `alipay`: Alipay - `baidu`: Baidu - `lark`: Feishu - `welink`: Welink - `yidun`: NetEase Yidun - `qingcloud`: Qingyun - `google`: Google - `gitlab`: GitLab - `gitee`: Gitee - `twitter`: Twitter - `facebook`: Facebook - `slack`: Slack - `linkedin`: Linkedin - `instagram`: Instagram - `oidc`: OIDC-type enterprise identity source - `oauth2`: OAuth2-type enterprise identity source - `saml`: SAML-type enterprise identity source - `ldap`: LDAP-type enterprise identity source - `ad`: AD-type enterprise identity source - `cas`: CAS-type enterprise identity source - `azure-ad`: Azure AD-type enterprise identity source	oidc
type	string	yes	Identity type, such as unionid, openid, primary	`openid`
userIdInIdp	string	yes	ID in the external identity source	`oj7Nq05R-RRaqak0_YlMLnnIwsvg`
userInfoInIdp	object	yes	User's identity information in idp
accessToken	string	no	Access Token in the external identity source (this parameter is only returned when the user actively obtains it, and the management side interface will not return it).	`57_fK0xgSL_NwVlS-gmUwlMQ2N6AONNIOAYxxxx`
refreshToken	string	no	Refresh Token in the external identity source (this parameter is only returned when the user actively obtains it, and the management side interface will not return it).	`57_IZFu91Ak1Wg6DRytZFFIOd3upNF5lH7vPxxxxx`
originConnIds	array	yes	List of identity origin connection IDs that the identity came from	`["605492ac41xxxxe0362f0707"]`

Previous article: Get Child Department List Next article: Get Department Direct Member ID List