Queries information for multiple users by user id or username.
|
Supported editions |
Enterprise Dedicated Edition |
Service endpoints
Get the service endpoint and replace {domain}
in the API request syntax with your
endpoint
.
Authorization information
Product | Resource | Required permission |
Organization Management | User | Read-only |
Request syntax
POST https://{domain}/oapi/v1/platform/users:batchReadRequest | By userIdsBy usernames |
Request headers | |
The access token. See Access token for details. Example: pt-0fh3****0fbG_35af****0484. | |
Request parameters | |
userIds A list of user IDs. You must specify either userIds or usernames, but not both. | |
usernames A list of usernames. You must specify either userIds or usernames, but not both. |
Response parameters | Sample response |
email The user's email address. | |
createdAt The time the account was created. | |
id The user ID. | |
lastOrganization The ID of the organization that the user last accessed. | |
name The display name of the user. | |
staffId The employee ID. | |
sysDeptIds The IDs of the departments to which the user belongs. | |
username The user's login name. |
Error codes
For more information, see Error codes.