Remove-ZrUser
Deletes a Zaris login user from the cluster, dropping the identity from every connected manager.
Syntax
Remove-ZrUser
-Name <string>
[-Managers <string[]>] [-Port <int>] [-Token <string>] [-TimeoutSec <int>]
[-WhatIf] [-Confirm]
Description
Remove-ZrUser deletes an existing local user, fanning the deletion out to every connected manager so the identity is dropped cluster-wide. Requires a connected manager (an active workspace or explicit -Managers) and an admin token. See Authorization & RBAC for how a deleted user's grants relate to its identity.
This operation is destructive. Deleting a user removes its login identity from every manager; any application or person relying on that identity to authenticate will lose access. Verify the target with Get-ZrUser first, and use -WhatIf to preview.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
-Name | string | Yes | The username of the login identity to delete. Position 0. |
-Managers | string[] | No | Management Service endpoints to target; when omitted the active workspace's managers are used. |
-Port | int | No | Management Service port for bare-host managers. Default 7801. |
-Token | string | No | Admin bearer token for authenticated control-plane calls. |
-TimeoutSec | int | No | Per-request timeout in seconds. Default 30. |
Supports -WhatIf and -Confirm.
Examples
Preview the deletion of alice without making any change.
Remove-ZrUser -Name alice -WhatIf
Delete the login user alice from every manager.
Remove-ZrUser -Name alice