mirror of
https://github.com/minio/docs.git
synced 2025-07-31 18:04:52 +03:00
Restructure the existing `mc admin user` page into separate pages for each subcommand. Also add missing details and correct errors. Staged: http://192.241.195.202:9000/staging/DOCS-785/linux/html/reference/minio-mc-admin/mc-admin-user.html Fixes https://github.com/minio/docs/issues/785
91 lines
2.0 KiB
ReStructuredText
91 lines
2.0 KiB
ReStructuredText
.. _minio-mc-admin-sts-info:
|
|
|
|
==============================
|
|
``mc admin user sts info``
|
|
==============================
|
|
|
|
.. default-domain:: minio
|
|
|
|
.. contents:: Table of Contents
|
|
:local:
|
|
:depth: 2
|
|
|
|
.. mc:: mc admin user sts info
|
|
|
|
|
|
Syntax
|
|
------
|
|
|
|
.. start-mc-admin-sts-info-desc
|
|
|
|
The :mc-cmd:`mc admin user sts info` command retrieves information on the specified STS credential, such as the parent :ref:`MinIO user <minio-internal-idp>` who generated the credentials, associated policies, and expiration.
|
|
|
|
.. end-mc-admin-sts-info-desc
|
|
|
|
:abbr:`STS (Security Token Service)` credentials provide temporary access to the MinIO deployment.
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: EXAMPLE
|
|
|
|
The following command retrieves information on the STS credentials with specified access key:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc admin user sts info myminio/ "J123C4ZXEQN8RK6ND35I"
|
|
|
|
.. tab-item:: SYNTAX
|
|
|
|
The command has the following syntax:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc [GLOBALFLAGS] admin user sts info \
|
|
[--policy] \
|
|
ALIAS \
|
|
STSACCESSKEY
|
|
|
|
.. 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 the MinIO deployment.
|
|
|
|
.. mc-cmd:: STSACCESSKEY
|
|
:required:
|
|
|
|
The access key for the STS credentials.
|
|
|
|
.. mc-cmd:: --policy
|
|
:optional:
|
|
|
|
Prints the policy attached to the specified STS credentials in JSON format.
|
|
|
|
|
|
Global Flags
|
|
~~~~~~~~~~~~
|
|
|
|
.. include:: /includes/common-minio-mc.rst
|
|
:start-after: start-minio-mc-globals
|
|
:end-before: end-minio-mc-globals
|
|
|
|
|
|
Behavior
|
|
--------
|
|
|
|
S3 Compatibility
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
.. include:: /includes/common-minio-mc.rst
|
|
:start-after: start-minio-mc-s3-compatibility
|
|
:end-before: end-minio-mc-s3-compatibility
|