Skip to content

Get-SophosOrganizationTenantById

SYNOPSIS

Gets information from individual tenant in an Organization

SYNTAX

Get-SophosOrganizationTenantById [-Token] <String> [-OrganizationId] <String> [-TenantId] <String>
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Gets information from individual tenant in an Organization

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>$MyTenant = Get-SophosOrganizationTenants -Token $token -OrganizationId "xxxxx-xxxxxx-xxxxxx-xxxxxx" | Where-Object {$_.Name -ieq 'MyTenant'}
PS>Get-SophosOrganizationTenantById -Token $token -OrganizationId "xxxx-xxxx-xxxx-xxxx" -TenantId $MyTenant.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

-OrganizationId

Parent Organization ID

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TenantId

ID of the target tenant

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
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.

INPUTS

OUTPUTS

NOTES