mirror of
https://github.com/minio/docs.git
synced 2025-08-08 01:43:18 +03:00
c840f368f4
Remaining item from https://github.com/minio/docs/issues/866: `mc admin user info --JSON` includes the policies the user inherited from their group membership in the `memberOf` property. Staged: http://192.241.195.202:9000/staging/DOCS-866-mc-admin-user-info/linux/html/reference/minio-mc-admin/mc-admin-user-info.html Fixes https://github.com/minio/docs/issues/866 --------- Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
146 lines
3.4 KiB
ReStructuredText
146 lines
3.4 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.
|
|
|
|
The output resembles the following:
|
|
|
|
.. code-block:: shell
|
|
|
|
AccessKey: myuser
|
|
Status: enabled
|
|
PolicyName: readwrite
|
|
MemberOf:
|
|
|
|
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"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
|
|
|
|
Behavior
|
|
--------
|
|
|
|
S3 Compatibility
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
.. include:: /includes/common-minio-mc.rst
|
|
:start-after: start-minio-mc-s3-compatibility
|
|
:end-before: end-minio-mc-s3-compatibility
|