1
0
mirror of https://github.com/minio/docs.git synced 2025-04-22 19:02:57 +03:00
docs/source/reference/minio-mc/mc-anonymous-set-json.rst
Harshavardhana 4e391920ba
rename 'mc policy' -> 'mc anonymous' deprecated command (#597)
Co-authored-by: Ravind Kumar <ravind@min.io>
2022-10-04 15:13:37 -04:00

130 lines
3.2 KiB
ReStructuredText

.. _minio-mc-policy-set-json:
=========================
``mc anonymous set-json``
=========================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc anonymous set-json
Syntax
------
.. start-mc-policy-set-json-desc
The :mc:`mc anonymous set-json` command sets anonymous (i.e. unauthenticated or
public) access :ref:`policies <minio-policy>` for a bucket using using an IAM
:s3-docs:`JSON policy document <using-iam-policies>`.
.. end-mc-policy-set-json-desc
Buckets with anonymous policies allow clients to access the bucket contents
and perform actions consistent with the specified policy without
:ref:`authentication <minio-authentication-and-identity-management>`.
.. tab-set::
.. tab-item:: EXAMPLE
The following command applies the JSON-formatted anonymous policy
to the ``mydata`` bucket on the ``myminio`` MinIO deployment:
.. code-block:: shell
:class: copyable
mc anonymous set-json ~/mydata-anonymous.json myminio/mydata
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc [GLOBALFLAGS] set-json POLICY ALIAS
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Parameters
~~~~~~~~~~
.. mc-cmd:: POLICY
*Required* The path to the JSON-formatted policy to assign to the specified
``ALIAS``.
.. mc-cmd:: ALIAS
*Required* The full path to the bucket or bucket prefix to which the
command applies the specified :mc-cmd:`~mc anonymous set-json POLICY`.
Specify the :ref:`alias <alias>` of the MinIO or other
S3-compatible service *and* the full path to the bucket or bucket
prefix. For example:
.. code-block:: shell
mc set-json public play/mybucket
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals
Examples
--------
Set Anonymous Policy for Bucket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc anonymous set-json` to set the anonymous policy for a
bucket:
.. code-block:: shell
:class: copyable
mc anonymous set-json POLICY ALIAS/PATH
- Replace :mc-cmd:`POLICY <mc anonymous set-json POLICY>` with a supported
:mc-cmd:`POLICY <mc anonymous set-json POLICY>`.
- Replace :mc-cmd:`ALIAS <mc anonymous set-json ALIAS>` with the
:mc-cmd:`alias <mc alias>` of a configured S3-compatible host.
- Replace :mc-cmd:`PATH <mc anonymous set-json ALIAS>` with the destination bucket.
Remove Anonymous Policy for Bucket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc:`mc anonymous set` to clear the anonymous policy for a
bucket:
.. code-block:: shell
:class: copyable
mc anonymous set none ALIAS/PATH
- Replace :mc-cmd:`ALIAS <mc anonymous set ALIAS>` with the
:mc-cmd:`alias <mc alias>` of a configured S3-compatible host.
- Replace :mc-cmd:`PATH <mc anonymous set ALIAS>` with the destination bucket.
Behavior
--------
S3 Compatibility
~~~~~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-s3-compatibility
:end-before: end-minio-mc-s3-compatibility