New-TSTMGMTUser

Add a new user within the Management Platform.

Written by David

Last published at: August 20th, 2020

Add a new user within the Management Platform 


SYNTAX

New-TSTMGMTUser

-UserName <string> -DisplayName <string> -Password <string> [-ParentId <guid>] [-Force] [-Disabled] [-Roles <string[]>] [-RoleIds <guid[]>] [-Interface <guid>] [-Timeout <int>]

New-TSTMGMTUser

-UserName <string> -DisplayName <string> -Password <string> -ParentFolder <Folder> [-ParentId <guid>] [-Disabled] [-Roles <string[]>] [-RoleIds <guid[]>] [-Interface <guid>] [-Timeout <int>]


DESCRIPTION

Adds a new user to the Management Platform. You can specify a fully qualified path to the new user or a relative one supplying a ParentFolder or ParentId.


EXAMPLES

1. Add a user called 'John' to the root Users node using a fully qualified name

        New-TSTMgmtUser -UserName '\Users\John' -DisplayName 'John Smith' -Password 'password'

2. Add a user called 'John' and make him a member of the 'ThinScale Administrators' role                

        New-TSTMgmtUser -UserName '\Users\John' -DisplayName 'John Smith' -Password 'password' -Roles '\Roles\ThinScale         Administrators'


PARAMETERS


-UserName

Fully qualified or relative name of the user to create

Type: String
Required: Yes
Accept Pipeline Input: No


-ParentId

The GUID of the folder in which the user is to be created (only required if UserName is a relative path)

Type: Guid
Required: No
Accept Pipeline Input: No


-ParentFolder

A folder object in which the user is to be created (only required if UserName is a relative path)

Type: ThinScale.Management.DataObjects.Folder
Required: Yes
Accept Pipeline Input: Yes


-DisplayName

The display name for the user

Type: String
Required: Yes
Accept Pipeline Input: No


-Password

Password for the user

Type: String
Required: Yes
Accept Pipeline Input: No


-Disabled

Sets the user to disabled when created

Type: SwitchParameter
Required: No
Accept Pipeline Input: No


-Roles

Comma-delimited list of roles to add the user to

Type: String[]
Required: No
Accept Pipeline Input: No


-RoleIds

Comma-delimited list of RoleId's to add the user to

Type: Guid[]
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 the path for the new user does not exist then it will be created

Type: SwitchParameter
Required: No
Accept Pipeline Input: No


INPUTS

ThinScale.Management.DataObjects.Folder


OUTPUTS

ThinScale.Management.DataObjects.User