Set-TSTMGMTUser
Update the details of a user within the Management Console.
Update the details of a user within the Management Console
SYNTAX
DESCRIPTION
Updates properties of an existing user in the Management Platform.
EXAMPLES
1. Add the user 'John' to the 'ReadOnly' role
2. Disable the user called 'John'
PARAMETERS
-User
User object to update
Type: | ThinScale.Management.DataObjects.User |
Required: | Yes |
Accept Pipeline Input: | Yes |
-UserName
New username for the user
Type: | String |
Required: | No |
Accept Pipeline Input: | No |
-DisplayName
A new display name for the user
Type: | String |
Required: | No |
Accept Pipeline Input: | No |
-Password
New password for the user
Type: | String |
Required: | No |
Accept Pipeline Input: | No |
-Disable
Disable the user
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-Enable
Enable the user
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-AddRoles
Comma-delimited list of roles to add the user to
Type: | String[] |
Required: | No |
Accept Pipeline Input: | No |
-AddRoleIds
Comma-delimited list of RoleId's to add the user to
Type: | Guid[] |
Required: | No |
Accept Pipeline Input: | No |
-RemoveRoles
Comma-delimited list of roles to remove the user from
Type: | String[] |
Required: | No |
Accept Pipeline Input: | No |
-RemoveRoleIds
Comma-delimited list of RoleId's to remove the user from
Type: | Guid[] |
Required: | No |
Accept Pipeline Input: | No |
-RemoveAllRoles
Removes the user from all roles
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-Interface
The interface ID returned by a previously successful call to Connect-TSTMGMTServer. This parameter is only required if you are connected to 2 or more Management Platform instances at the same time. If this parameter is not specified the connection to the last successful call to Connect-TSTMgmtServer will be used.
Type: | Guid |
Required: | No |
Accept Pipeline Input: | No |
-Timeout
The time allowed in milliseconds for the call to complete before it is deemed to have timed out and is aborted
Type: | Int32 |
Required: | No |
Accept Pipeline Input: | No |
-Force
If multiple Roles are found with the same name, the first retrieved will be used otherwise the call will fail
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
INPUTS
ThinScale.Management.DataObjects.User
OUTPUTS
ThinScale.Management.DataObjects.User