monkey365

0.95.1

collectors/microsoft365/SharePointOnline/Get-MonkeySharePointOnlineTenantAdminInfo.ps1

# Monkey365 - the PowerShell Cloud Security Tool for Azure and Microsoft 365 (copyright 2022) by Juan Garrido
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


function Get-MonkeySharePointOnlineTenantAdminInfo {
<#
        .SYNOPSIS
        Collector to get information about SPS Tenant information
 
        .DESCRIPTION
        Collector to get information about SPS Tenant information
 
        .INPUTS
 
        .OUTPUTS
 
        .EXAMPLE
 
        .NOTES
            Author : Juan Garrido
            Twitter : @tr1ana
            File Name : Get-MonkeySharePointOnlineTenantAdminInfo
            Version : 1.0
 
        .LINK
            https://github.com/silverhack/monkey365
    #>

    [CmdletBinding()]
    param(
        [Parameter(Mandatory = $false,HelpMessage = "Background Collector ID")]
        [string]$collectorId
    )
    Begin {
        $sps_tenant_admin_details = $null
        #Collector metadata
        $monkey_metadata = @{
            Id = "sps0008";
            Provider = "Microsoft365";
            Resource = "SharePointOnline";
            ResourceType = $null;
            resourceName = $null;
            collectorName = "Get-MonkeySharePointOnlineTenantAdminInfo";
            ApiType = "CSOM";
            description = "Collector to get information about SPS Tenant information";
            Group = @(
                "SharePointOnline"
            );
            Tags = @(

            );
            references = @(
                "https://silverhack.github.io/monkey365/"
            );
            ruleSuffixes = @(
                "o365_spo_tenant_admin_details"
            );
            dependsOn = @(

            );
            enabled = $true;
            supportClientCredential = $true
        }
        $sps_tenant_admin_details = $null;
    }
    Process {
        $msg = @{
            MessageData = ($message.MonkeyGenericTaskMessage -f $collectorId,"Sharepoint Online Tenant Admin Info",$O365Object.TenantID);
            callStack = (Get-PSCallStack | Select-Object -First 1);
            logLevel = 'info';
            InformationAction = $O365Object.InformationAction;
            Tags = @('SPSTenantInfo');
        }
        Write-Information @msg
        if ($O365Object.isSharePointAdministrator) {
            $p = @{
                InformationAction = $O365Object.InformationAction;
                Verbose = $O365Object.Verbose;
                Debug = $O365Object.Debug;
            }
            $sps_tenant_admin_details = Get-MonkeyCSOMTenant @p
        }
    }
    End {
        If ($sps_tenant_admin_details) {
            $sps_tenant_admin_details.PSObject.TypeNames.Insert(0,'Monkey365.SharePoint.TenantDetails')
            [pscustomobject]$obj = @{
                Data = $sps_tenant_admin_details;
                Metadata = $monkey_metadata;
            }
            $returnData.o365_spo_tenant_admin_details = $obj
        }
        Else {
            $msg = @{
                MessageData = ($message.MonkeyEmptyResponseMessage -f "Sharepoint Online Tenant Admin details",$O365Object.TenantID);
                callStack = (Get-PSCallStack | Select-Object -First 1);
                logLevel = "verbose";
                InformationAction = $O365Object.InformationAction;
                Verbose = $O365Object.Verbose;
                Tags = @('SPSTenantDetailsEmptyResponse');
            }
            Write-Verbose @msg
        }
    }
}