# Team Users

The Team User module for UAPI.

## Add roles to a team user

 - [GET /Team/add_roles](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/add_roles.md): This function adds roles to a team user.

Note:

  This action may result in team users gaining access to team owner level privileges.

## Add a team user

 - [GET /Team/add_team_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/add_team_user.md): This function creates and adds a new team user.

Note:

  This action may result in team users gaining access to team owner level privileges.

## Stop a team user from expiring

 - [GET /Team/cancel_expire](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/cancel_expire.md): This function stops a team user from expiring.

## Edit a team user

 - [GET /Team/edit_team_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/edit_team_user.md): This function modifies a team user.

## Get number of team users with roles

 - [GET /Team/get_team_users_with_roles_count](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/get_team_users_with_roles_count.md): This function returns the current and maximum number of team users with roles.

## List Team Users

 - [GET /Team/list_team](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/list_team.md): This function lists the team users connected to a cPanel account.
This list is given in an array by default, but can be given in a hash.

## Sends a password reset request link to team user.

 - [GET /Team/password_reset_request](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/password_reset_request.md): This function enables a team user to reset the password by sending a password reset request link.

## Reinstate a team user

 - [GET /Team/reinstate_team_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/reinstate_team_user.md): This function reinstates a team user by removing any suspended or expired statuses. The reason field is also cleared.

## Remove roles from a team user

 - [GET /Team/remove_roles](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/remove_roles.md): This function removes roles from a team user.

## Remove a team user

 - [GET /Team/remove_team_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/remove_team_user.md): This function removes a team user.

## Set a contact email address for a team user

 - [GET /Team/set_contact_email](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/set_team_user_contact_email.md): This function sets or changes primary and secondary email addresses.

## Set a team user to expire

 - [GET /Team/set_expire](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/set_expire.md): This function expires a team user after a specified amount of time.

If the team user already has an expire date set, it's replaced with a new date and reason.

## Set locale for a team user

 - [GET /Team/set_locale](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/team::set_locale.md): This function sets locale for a team user.

## Set notes for a team user

 - [GET /Team/set_notes](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/set_team_user_notes.md): This function replaces the current notes field with new text.

## Set password for a team user

 - [GET /Team/set_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/set_team_user_password.md): This function replaces the current password with a new one.

## Set roles for a team user

 - [GET /Team/set_roles](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/set_roles.md): This function sets roles for a team user.

Note:

  This action may result in team users gaining access to team owner level privileges.

## Suspend a team user

 - [GET /Team/suspend_team_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/suspend_team_user.md): This function immediately suspends a team user.