Functions/Authentication/Get-PASSession.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
function Get-PASSession {
    <#
    .SYNOPSIS
    Returns information related to the authenticated session
 
    .DESCRIPTION
    For the current session, returns data from the module scope:
    - Username relating to the session.
    - BaseURI: URL value used for sending requests to the API.
    - ExternalVersion: PAS version information.
    - Websession: Contains Authorization Header, Cookie & Certificate data related to the current session.
 
    The session information can be saved a variable accessible outside of the module scope for use in requests outside of psPAS.
 
    .EXAMPLE
    Show current session related information
 
    Get-PASSession
 
    .EXAMPLE
    Save current session related information
 
    $session = Get-PASSession
 
    .EXAMPLE
    Use session information for Invoke-RestMethod command
 
    $session = Get-PASSession
 
    Invoke-RestMethod
    Invoke-RestMethod -Method GET -Uri "$session.BaseURI/SomePath" -WebSession $session.WebSession
 
    #>

    [CmdletBinding()]
    param( )

    BEGIN { }#begin

    PROCESS {

        [PSCustomObject]@{
            User            = Get-PASLoggedOnUser -ErrorAction Stop | Select-Object -ExpandProperty Username
            BaseURI         = $Script:BaseURI
            ExternalVersion = $Script:ExternalVersion
            WebSession      = $Script:WebSession
        } | Add-ObjectDetail -typename psPAS.CyberArk.Vault.Session

    }#process

    END { }#end

}