Get-SophosCommonRoleById
SYNOPSIS
Get Tenant Role by ID
SYNTAX
Get-SophosCommonRoleById [-Token] <String> [-TenantId] <String> [-ApiHost] <String> [-RoleId] <String>
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Get Tenant Role by ID
EXAMPLES
EXAMPLE 1
$ClientId = "xxxxxxxxxxxxxxxxxxxx"
PS> $ClientSecret = "xxxxxxxxxxxxxxxxxxxx"
PS> $Credential = [pscredential]::new($ClientId,$(ConvertTo-SecureString -String $ClientSecret -AsPlainText -Force))
PS> $token = Get-SophosAccessToken -Credential $Credential
PS>$partnerId = Get-SophosPartnerId -Token $token
PS>$tenant = Get-SophosPartnerTenants -PartnerId $partnerId.PartnerId -Token $token | Where-Object {$_.Name -eq 'MyTenant'}
PS>$role = Get-SophosCommonRoles -Token $token -TenantId $tenant.id -ApiHost $tenant.apiHost | Where-Object {$_.Name -eq 'MyRole'}
PS>Get-SophosCommonRoleById -Token $token -TenantId $tenant.id -ApiHost $tenant.apiHost -RoleId $role.id
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 hsot 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
-RoleId
Target role ID
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
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.