mirror of
https://github.com/minio/docs.git
synced 2025-07-28 19:42:10 +03:00
34cf55934a
mc RELEASE.2023-07-18T21-05-38Z - Replaces mc replicate diff with mc replicate backlog - Adds mc support top net mc RELEASE.2023-07-07T05-25-51Z - Adds mc support perf site-replication - Deprecates mc admin replicate --sync flag in favor of new mc admihn replicate --mode flag - Updates output example of mc admin user info to show authentication info Partially addresses #930
158 lines
3.9 KiB
ReStructuredText
158 lines
3.9 KiB
ReStructuredText
.. _minio-mc-admin-user-info:
|
|
|
|
======================
|
|
``mc admin user info``
|
|
======================
|
|
|
|
.. default-domain:: minio
|
|
|
|
.. contents:: Table of Contents
|
|
:local:
|
|
:depth: 2
|
|
|
|
.. mc:: mc admin user info
|
|
|
|
Syntax
|
|
------
|
|
|
|
.. start-mc-admin-user-info-desc
|
|
|
|
The :mc:`mc admin user info` command returns detailed information of a :ref:`MinIO user <minio-internal-idp>` on the target MinIO deployment.
|
|
|
|
.. end-mc-admin-user-info-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 returns details of user ``myuser`` on the ``myminio`` MinIO deployment:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc admin user info myminio myuser
|
|
|
|
.. tab-item:: SYNTAX
|
|
|
|
The command has the following syntax:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc [GLOBALFLAGS] admin user info \
|
|
ALIAS \
|
|
USERNAME
|
|
|
|
.. include:: /includes/common-minio-mc.rst
|
|
:start-after: start-minio-syntax
|
|
:end-before: end-minio-syntax
|
|
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. mc-cmd:: ALIAS
|
|
:required:
|
|
|
|
The :mc-cmd:`alias <mc alias>` of a configured MinIO deployment to retrieve user information from.
|
|
|
|
.. mc-cmd:: USERNAME
|
|
|
|
The username to retrieve information for.
|
|
|
|
|
|
Global Flags
|
|
~~~~~~~~~~~~
|
|
|
|
.. include:: /includes/common-minio-mc.rst
|
|
:start-after: start-minio-mc-globals
|
|
:end-before: end-minio-mc-globals
|
|
|
|
.. versionchanged:: RELEASE.2023-05-26T23-31-54Z
|
|
|
|
``mc admin user info --JSON`` output includes policies inherited from a user's group memberships in ``memberOf``.
|
|
|
|
Examples
|
|
--------
|
|
|
|
View User Details
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
Use :mc-cmd:`mc admin user info` to view detailed user information for a user on a MinIO deployment:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc admin user info ALIAS USERNAME
|
|
|
|
- Replace :mc-cmd:`ALIAS <mc admin user info ALIAS>` with the :mc-cmd:`alias <mc alias>` of the MinIO deployment.
|
|
|
|
- Replace :mc-cmd:`USERNAME <mc admin user info USERNAME>` with the username of the user to display information for.
|
|
|
|
For the :ref:`MinIO internal IDentity Provider (IDP) <minio-internal-idp>`, the output resembles the following:
|
|
|
|
.. code-block:: shell
|
|
|
|
AccessKey: miniouser
|
|
Status: enabled
|
|
PolicyName:
|
|
MemberOf: []
|
|
Authentication: builtin (miniouser)
|
|
|
|
For a :ref:`third-party <minio-external-identity-management>` identity service such as LDAP, the output resembles the following:
|
|
|
|
.. code-block:: shell
|
|
|
|
AccessKey: uid=dillon,ou=people,ou=swengg,dc=min,dc=io
|
|
Status:
|
|
PolicyName: consoleAdmin
|
|
MemberOf: []
|
|
Authentication: ldap/localhost:1389 (uid=dillon,ou=people,ou=swengg,dc=min,dc=io)
|
|
|
|
View Policies from Group Membership
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Use :mc-cmd:`mc admin user info` with :std:option:`--JSON <mc.--JSON>` to view the policies inherited from a user's :ref:`group memberships <minio-groups>`:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc admin user info ALIAS USERNAME --JSON
|
|
|
|
- Replace :mc-cmd:`ALIAS <mc admin user info ALIAS>` with the :mc-cmd:`alias <mc alias>` of the MinIO deployment.
|
|
|
|
- Replace :mc-cmd:`USERNAME <mc admin user info USERNAME>` with the username of the user to display information for.
|
|
|
|
The ``memberOf`` property in the output contains a list of groups the user is a member of, with the policies attached to each group.
|
|
The output resembles the following:
|
|
|
|
.. code-block:: shell
|
|
|
|
{
|
|
"status": "success",
|
|
"accessKey": "myuser",
|
|
"userStatus": "enabled",
|
|
"memberOf": [
|
|
{
|
|
"name": "testingGroup",
|
|
"policies": [
|
|
"testingGroupPolicy"
|
|
]
|
|
"authentication": builtin (myuser)
|
|
}
|
|
]
|
|
}
|
|
|
|
|
|
Behavior
|
|
--------
|
|
|
|
S3 Compatibility
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
.. include:: /includes/common-minio-mc.rst
|
|
:start-after: start-minio-mc-s3-compatibility
|
|
:end-before: end-minio-mc-s3-compatibility
|