Public/Test-SlackAuth.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
54
55
56
57
58
59
60
61
62
63
function Test-SlackAuth {
    <#
    .SYNOPSIS
        Checks if you're authenticated.

    .DESCRIPTION
        Checks if you're authenticated.

    .PARAMETER Token
        Token to use for the Slack API.

        Default value is the value set by Set-PSSlackConfig.

    .PARAMETER Raw
        Return raw output.

    .EXAMPLE
        Test-SlackAuth

        # Checks if the default user specified by Get-PSSlackConfig is authenticated.

    .EXAMPLE
        Test-SlackAuth -Token $Token

        # Checks if the user specified by $Token is authenticated.
    .EXAMPLE
        Test-SlackAuth -Raw

        # Checks if the default user specified by Get-PSSlackConfig is authenticated.
        # Returns raw output.

    .EXAMPLE
        Test-SlackAuth -Raw -Token $Token

        # Checks if the default user specified by $Token is authenticated.
        # Returns raw output.

    .FUNCTIONALITY
        Slack

    .LINK
        https://api.slack.com/methods/auth.test
    #>


    [CmdletBinding()]
    param (
        [string]$Token = $Script:PSSlack.Token,
        [switch]$Raw
    )
    end
    {
        $RawAuth = Get-SlackAuth @PSBoundParameters

        if($Raw)
        {
            $RawAuth
        }
        else
        {
            $RawAuth.IsAuthenticated
        }
    }
}