NetAppDocs PowerShell Module

Invoke-SsoLogin


NAME
    Invoke-SsoLogin

SYNOPSIS
    Queries the user for SSO login credentials and caches the results (required for ASUP access).


SYNTAX
    Invoke-SsoLogin [-PassThru] [<CommonParameters>]

    Invoke-SsoLogin -MsalTokenTuple <Tuple`2> [-PassThru] [<CommonParameters>]

    Invoke-SsoLogin -OAuthToken <OAuthToken> [-PassThru] [<CommonParameters>]

    Invoke-SsoLogin -IdToken <String> -AccessToken <String> -RefreshToken <String> -ExpiresOn <String> -Scopes <String>
    [-Application <String>] [-PassThru] [<CommonParameters>]


DESCRIPTION
    Queries the user for SSO login credentials and caches the results. SSO login is required for ASUP access.
    This function can be called by itself or it will be called once by any of the ASUP related functions. The
    results are cached for use so this will only be called once per session.


PARAMETERS
    -MsalTokenTuple <Tuple`2>
        Input ClientApplication and AuthToken tuple

        Required?                    true
        Position?                    named
        Default value
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

    -OAuthToken <OAuthToken>
        Input OAuth token

        Required?                    true
        Position?                    named
        Default value
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

    -IdToken <String>
        OAuthToken ID token string

        Required?                    true
        Position?                    named
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -AccessToken <String>
        OAuthToken access token string

        Required?                    true
        Position?                    named
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -RefreshToken <String>
        OAuthToken refresh token string

        Required?                    true
        Position?                    named
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -ExpiresOn <String>
        OAuth token expiration timestamp

        Required?                    true
        Position?                    named
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -Scopes <String>
        OAuth token scope string

        Required?                    true
        Position?                    named
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -Application <String>
        Application that generated the token.

        Required?                    false
        Position?                    named
        Default value                NetAppDocs
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -PassThru [<SwitchParameter>]
        Writes the token to the pipeline

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS
    None


OUTPUTS
    None


NOTES


        AUTHOR : Jason Cole
        REQUIRES : Internal connection to NetApp

    -------------------------- EXAMPLE 1 --------------------------

    PS>Invoke-SsoLogin

    The user will be prompted for SSO login credentials.





RELATED LINKS
    https://community.netapp.com/t5/NetAppDocs/bd-p/netappdocs