Set-CouchDBSession

NAME Set-CouchDBSession



SYNOPSIS

Set cookie authentication.





SYNTAX

Set-CouchDBSession [[-Server] <String>] [[-Port] <Int32>] [-UserId] <String> [-Password] <SecureString> [-Ssl]

[<CommonParameters>]





DESCRIPTION

Set cookie authentication (RFC 2109) CouchDB generates a token that the client can use for the next few requests

to CouchDB.

Tokens are valid until a timeout.





PARAMETERS

-Server <String>

The CouchDB server name. Default is localhost.



Required? false

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Port <Int32>

The CouchDB server port. Default is 5984.



Required? false

Position? 2

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-UserId <String>

The CouchDB user_id.



Required? true

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Password <SecureString>

The password of user_id in SecureString.



Required? true

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Ssl [<SwitchParameter>]

Set ssl connection on CouchDB server.

This modify protocol to https and port to 6984.



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



OUTPUTS



NOTES





CouchDB API:

POST /_session



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



PS C:\\>$password = "password" | ConvertTo-SecureString -AsPlainText -Force



Set-CouchDBSession -UserId admin -Password $password

This example manually set the web session on CouchDB server.











RELATED LINKS

https://pscouchdb.readthedocs.io/en/latest/auth.html