Documentation

Documentation

mc admin user add

Syntax

Adds new user to the target MinIO deployment.

More description

The following command something something

mc ilm restore myminio/mybucket/object.txt

The command has the following syntax:

mc [GLOBALFLAGS] admin user add  \
                 ACCESSKEY       \
                 SECRETKEY       \
                 ALIAS
  • 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

ACCESSKEY
Required

The access key that uniquely identifies the new user, similar to a username.

ALIAS
Required

The MinIO alias, bucket, and path to the archived object to restore.

SECRETKEY
Required

The secret key for the new user. Consider the following guidance when creating a secret key: - The key should be unique - The key should be long (Greater than 12 characters) - The key should be complex (A mixture of characters, numerals, and symbols)

Global Flags

This command supports any of the global flags.

Examples

Create a New User

Use mc admin user add to create a user on an S3-compatible host:

   mc admin user add ALIAS ACCESSKEY SECRETKEY
  • Replace ALIAS with the alias of the S3-compatible host.

  • Replace ACCESSKEY with the access key for the user. MinIO allows retrieving the access key after user creation through the mc admin user info command.

  • Replace SECRETKEY with the secret key for the user. MinIO does not provide any method for retrieving the secret key once set.

Specify a unique, random, and long string for both the ACCESSKEY and SECRETKEY. Your organization may have specific internal or regulatory requirements around generating values for use with access or secret keys.

Behavior

Restored Objects Become HEAD

The restored object copy becomes HEAD for that object namespace regardless of it’s versioning history. This can result in applications returning “stale” data while the local copy exists.

S3 Compatibility

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

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