User

Overview

Data type for storing information about individual TestRail users that are registered to a particular TestRail environment.

Fields

Name	Type	Description	Request Methods
email	String	The email address of the user as configured in TestRail	getUser, getUserByEmail, getUsers
id	Int	The unique ID of the user	getUser, getUserByEmail, getUsers
isActive	Boolean	True if the user is active and false otherwise	getUser, getUserByEmail, getUsers
name	String	The full name of the user	getUser, getUserByEmail, getUsers

Methods

GET Requests:

---

1. getUser

Description:

Returns an existing user.

Parameters:

Name	Type	Description	Required
userId	Int	The ID of the user	Yes

Returns:

• User

Example:

val someUser = User().getUser(userId = 1)

 

2. getUserByEmail

Description:

Returns an existing user by his/her email address.

Parameters:

Name	Type	Description	Required
email	String	The email address to get the user for	Yes

Returns:

• User

Example:

val someUser = User().getUserByEmail(email = "somename@somedomain.com")

 

3. getUsers

Description:

Returns a list of users.

Returns:

• List<User>

Example:

val someUsersList = User().getUsers()