Set-CouchDBUser

NAME Set-CouchDBUser



SYNOPSIS

Set an user properties.





SYNTAX

Set-CouchDBUser [[-Server] <String>] [[-Port] <Int32>] [-Userid] <String> [-Password] <SecureString> [[-Roles]

<Array>] [-Revision] <String> [[-Authorization] <String>] [-Ssl] [<CommonParameters>]





DESCRIPTION

Set a CouchDB user properties with roles. Reset password user.





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 user_id than exists in _users database.



Required? true

Position? 3

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Password <SecureString>

The password in SecureString.



Required? true

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Roles <Array>

Array of roles.



Required? false

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Revision <String>

The revision document of user_id.



Required? true

Position? 6

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Authorization <String>

The CouchDB authorization form; user and password.

Authorization format like this: user:password

ATTENTION: if the password is not specified, it will be prompted.



Required? false

Position? 7

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:

PUT /_users



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



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



Set-CouchDBUser -Userid test_user -Password $password -Revision "2-4705a219cdcca7c72aac4f623f5c46a8"

-Authorization "admin:password"

This example reset password of user "test_user".











RELATED LINKS

https://pscouchdb.readthedocs.io/en/lat ... r-password