Remove-CouchDBUser

NAME Remove-CouchDBUser



SYNOPSIS

Remove an user.





SYNTAX

Remove-CouchDBUser [[-Server] <String>] [[-Port] <Int32>] [-Userid] <String> [-Revision] <String>

[[-Authorization] <String>] [-Force] [-Ssl] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Remove a CouchDB user with roles.





PARAMETERS

-Server <String>

The CouchDB server name. Default is localhost.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

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? false

Accept wildcard characters? false



-Revision <String>

The revision document of user_id.



Required? true

Position? 4

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? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Force [<SwitchParameter>]

No confirmation prompt.



Required? false

Position? named

Default value False

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



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

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:

DELETE /_users



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



PS C:\\>Remove-CouchDBUser -Userid test_user -Revision "2-4705a219cdcca7c72aac4f623f5c46a8" -Authorization

"admin:password"



The example removes test_user standard user.











RELATED LINKS

https://pscouchdb.readthedocs.io/en/lat ... ove-a-user