Get-FreeIPAAPIAuthenticationCookie

NAME Get-FreeIPAAPIAuthenticationCookie



SYNOPSIS

Get an authentication cookie from your IPA server in order to be able to use APIs





SYNTAX

Get-FreeIPAAPIAuthenticationCookie [[-URL] <String>] [[-AdminLogin] <SecureString>] [[-AdminPassword]

<SecureString>] [-CloseAllRemoteSession] [-UseCachedURLandCredentials] [<CommonParameters>]





DESCRIPTION

Get a valid authentication cookie from your IPA server based on login/password authentication. The websession is

saved to a global variable in order to be reused for API authentication. You can import your credential from an

encryoted file previously generated with Set-FreeIPAAPICrendentials and Set-FreeIPAAPIServerConfig cmdlets.





PARAMETERS

-AdminLogin <SecureString>

Your admin login



Required? false

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-AdminPassword <SecureString>

your admin password



Required? false

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-CloseAllRemoteSession [<SwitchParameter>]

use this setting to close the remote session with your FreeIPA server



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-URL <String>

URL of your FreeIPA server. https://myfreeipa.tld



Required? false

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-UseCachedURLandCredentials [<SwitchParameter>]

use this setting to import URL and credential from global variables $FreeIPAAPICredentials and

$FreeIPAAPIServerConfig



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

System.String







OUTPUTS

System.Object







NOTES









-------------------------- Example 1 --------------------------



PS C:\\> Get-FreeIPAAPIAuthenticationCookie -UseCachedURLandCredentials



Connect to your FreeIPA server based on config / credential set with Set-FreeIPAAPICrendentials cmdlet



RELATED LINKS