Add-SophosCommonRole
SYNOPSIS
Create a new tenant role
SYNTAX
Add-SophosCommonRole [-Token] <String> [-TenantId] <String> [-ApiHost] <String> [-RoleName] <String>
[-RolePrincipalType] <String> [-RolePermissionSets] <Array> [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
Create a new tenant role
EXAMPLES
EXAMPLE 1
$token = Get-SophosAccessToken -ClientID "xxxxxxxxxxxxxxxx" -ClientS "xxxxxxxxxxxxxxxxx"
PS>$partnerId = Get-SophosPartnerId -Token $token
PS>$tenant = Get-SophosPartnerTenants -PartnerId $partnerId.PartnerId -Token $token | Where-Object {$_.Name -eq 'MyTenant'}
PS>$Roles = @(
"central_admin"
"endpoint_product_admin"
)
PS>Add-SophosCommonRole -Token $token -TenantId $tenant.id -ApiHost $tenant.apiHost -RoleName "Admin" -RolePrincipalType "user" -RolePermissionSets $roles
PARAMETERS
-Token
JWT token from oauth API
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TenantId
Tenant ID
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ApiHost
API host location URL of the tenant
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RoleName
Name of the new role
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RolePrincipalType
Type of the new role
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RolePermissionSets
Array of Permission sets of the new role
Type: Array
Parameter Sets: (All)
Aliases:
Required: True
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
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.