mirror of
https://github.com/minio/docs.git
synced 2025-07-06 20:36:50 +03:00
4c735072f7
All the `mc admin idp *` commands have been renamed `mc idp *`. Deprecate everything under `mc admin idp` and create pages for their new names in the MinIO Client section. Affects the following commands and subcommands; * `mc admin idp ldap` * `mc admin idp openid` * `mc admin idp ldap policy` The new pages maintain the existing content and page structure. New pages for each subcommand are out of scope for this PR. Partly addresses https://github.com/minio/docs/issues/859 and https://github.com/minio/docs/issues/866 Staged: http://192.241.195.202:9000/staging/DOCS-859-part-2-idp/linux/html/reference/minio-mc.html http://192.241.195.202:9000/staging/DOCS-859-part-2-idp/linux/html/reference/minio-mc-admin.html http://192.241.195.202:9000/staging/DOCS-859-part-2-idp/linux/html/reference/minio-mc-deprecated.html Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
133 lines
3.6 KiB
ReStructuredText
133 lines
3.6 KiB
ReStructuredText
.. _minio-mc-admin-user-add:
|
|
|
|
=====================
|
|
``mc admin user add``
|
|
=====================
|
|
|
|
.. default-domain:: minio
|
|
|
|
.. contents:: Table of Contents
|
|
:local:
|
|
:depth: 2
|
|
|
|
.. mc:: mc admin user add
|
|
|
|
|
|
Syntax
|
|
------
|
|
|
|
.. start-mc-admin-user-add-desc
|
|
|
|
The :mc:`mc admin user add` command adds a new :ref:`MinIO user <minio-internal-idp>` to the target MinIO deployment.
|
|
|
|
.. end-mc-admin-user-add-desc
|
|
|
|
To manage external Identity Provider users, see :mc:`OIDC <mc idp openid>` or :mc:`AD/LDAP <mc idp ldap>`.
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: EXAMPLE
|
|
|
|
The following command creates a new user ``newuser`` on the ``myminio`` MinIO deployment:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc admin user add myminio newuser newusersecret
|
|
|
|
.. tab-item:: SYNTAX
|
|
|
|
The command has the following syntax:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc [GLOBALFLAGS] admin user add \
|
|
ALIAS \
|
|
ACCESSKEY \
|
|
SECRETKEY
|
|
|
|
.. include:: /includes/common-minio-mc.rst
|
|
:start-after: start-minio-syntax
|
|
:end-before: end-minio-syntax
|
|
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. mc-cmd:: ACCESSKEY
|
|
:required:
|
|
|
|
The access key that uniquely identifies the new user, similar to a username.
|
|
|
|
.. mc-cmd:: ALIAS
|
|
:required:
|
|
|
|
The :mc-cmd:`alias <mc alias>` of a configured MinIO deployment on which to create the new user.
|
|
|
|
.. mc-cmd:: 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
|
|
~~~~~~~~~~~~
|
|
|
|
.. include:: /includes/common-minio-mc.rst
|
|
:start-after: start-minio-mc-globals
|
|
:end-before: end-minio-mc-globals
|
|
|
|
|
|
Example
|
|
-------
|
|
|
|
Create a New User
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
Use :mc-cmd:`mc admin user add` to create a user on a MinIO deployment:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc admin user add ALIAS ACCESSKEY SECRETKEY
|
|
|
|
- Replace :mc-cmd:`ALIAS <mc admin user add ALIAS>` with the :mc-cmd:`alias <mc alias>` of the MinIO deployment.
|
|
|
|
- Replace :mc-cmd:`ACCESSKEY <mc admin user add ACCESSKEY>` with the access key for the user.
|
|
|
|
- Replace :mc-cmd:`SECRETKEY <mc admin user add 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
|
|
--------
|
|
|
|
New Users Have No Default Policies
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Newly created users have *no* policies by default and therefore cannot perform any operations on the MinIO deployment.
|
|
To configure a user's assigned policies, you can do either or both of the following:
|
|
|
|
- Use :mc-cmd:`mc admin policy attach` to associate one or more policies to the user.
|
|
|
|
- Use :mc-cmd:`mc admin group add` to associate the user to the group.
|
|
Users inherit any policies assigned to the group.
|
|
|
|
For more information on MinIO users and groups, see :ref:`minio-users` and :ref:`minio-groups`.
|
|
For more information on MinIO policies, see :ref:`MinIO Policy Based Access Control <minio-policy>`.
|
|
|
|
S3 Compatibility
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
.. include:: /includes/common-minio-mc.rst
|
|
:start-after: start-minio-mc-s3-compatibility
|
|
:end-before: end-minio-mc-s3-compatibility
|