New-UAIdentity
SYNOPSIS
Creates a new identity within UA.
SYNTAX
New-UAIdentity -Name <String> [-Role <Role>] [-ComputerName <String>] [-AppToken <String>]
[-UseDefaultCredentials] [<CommonParameters>]
DESCRIPTION
Creates a new identity within UA. An identity is either a user or an application that needs to interact with UA. Identities are created automatically from git commits. You should create a new identity for users accessing UA if you wish to audit the system or provide authentication and authorization.
EXAMPLES
Example 1
PS C:\> $Role = Get-UARole -Name 'Administrator'
PS C:\> New-UAIdentity -Name 'Adam'
Creates the identity 'Adam' and assigns the role of administrator.
PARAMETERS
-AppToken
An app token to access the UA API.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ComputerName
The HTTP address of the UA REST API server.
Type: System.String
Parameter Sets: (All)
Aliases: Uri
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
The name of the identity.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Role
The role of the identity. Use Get-UARole to receive a Role object.
Type: PowerShellUniversal.Role
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UseDefaultCredentials
Use default credentials when connecting to the management API
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.