bm admin user disable

Syntax

The bm admin user disable command disables a Buckit user on the target Buckit deployment.

Clients cannot use the user credentials to authenticate to the Buckit deployment. Disabling a user does not remove that user from the deployment. Use bm admin user enable to enable a disabled user on a Buckit deployment.

To manage external Identity Provider users, see OIDC or AD/LDAP.

The following command disables user myuser on the mybuckit Buckit deployment:

bm admin user disable mybuckit myuser

The command has the following syntax:

bm [GLOBALFLAGS] admin user disable   \
                            ALIAS     \
                            USERNAME
  • Brackets [] indicate optional parameters.

  • Parameters sharing a line are mutually dependent.

  • Parameters separated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

ALIAS
Required

The alias of the Buckit deployment with the user to disable.

USERNAME
Required

The username of the user to disable.

Global Flags

This command supports any of the global flags.

Example

Disable a User

Use bm admin user disable to disable a user on a Buckit deployment.

bm admin user disable ALIAS USERNAME
  • Replace ALIAS with the alias of the Buckit deployment.

  • Replace USERNAME with the username of the user to disable.

Behavior

S3 Compatibility

The bm commandline tool is built for compatibility with the AWS S3 API and is tested with Buckit and AWS S3 for expected functionality and behavior.

Buckit provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported. While bm commands may work as documented, any such usage is at your own risk.