1
0
mirror of https://github.com/minio/docs.git synced 2025-07-31 18:04:52 +03:00
Files
docs/source/reference/minio-mc-admin/mc-admin-policy.rst
Andrea Longo 4c735072f7 Move reference docs for mc admin idp commands to mc idp (#873)
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>
2023-06-08 11:58:22 -06:00

97 lines
3.3 KiB
ReStructuredText

===================
``mc admin policy``
===================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc admin policy
.. versionchanged:: mc RELEASE.2023-03-20T17-17-53Z
The following commands are deprecated:
- ``mc admin policy add`` use :mc:`mc admin policy create` instead
- ``mc admin policy set`` use :mc:`mc admin policy attach` instead
- ``mc admin policy unset`` use :mc:`mc admin policy detach` instead
- ``mc admin policy update`` use :mc:`~mc admin policy attach` or :mc:`~mc admin policy detach` instead
The following command is added:
- :mc-cmd:`mc admin policy entities`
Description
-----------
.. start-mc-admin-policy-desc
The :mc:`mc admin policy` commands manage policies for use with :ref:`MinIO Policy-Based Access Control <minio-policy>` (PBAC).
MinIO PBAC uses IAM-compatible policy JSON documents to define rules for accessing resources on a MinIO server.
.. end-mc-admin-policy-desc
For complete documentation on MinIO PBAC, including policy document JSON structure and syntax, see :ref:`minio-policy`. To manage policies for deployments that use LDAP authentication, see :mc:`mc idp ldap policy`.
Subcommands
-----------
:mc:`mc admin policy` includes the following subcommands:
.. list-table::
:header-rows: 1
:widths: 30 70
:width: 100%
* - Subcommand
- Description
* - :mc:`~mc admin policy attach`
- .. include:: /reference/minio-mc-admin/mc-admin-policy-attach.rst
:start-after: start-mc-admin-policy-attach-desc
:end-before: end-mc-admin-policy-attach-desc
* - :mc:`~mc admin policy create`
- .. include:: /reference/minio-mc-admin/mc-admin-policy-create.rst
:start-after: start-mc-admin-policy-create-desc
:end-before: end-mc-admin-policy-create-desc
* - :mc:`~mc admin policy detach`
- .. include:: /reference/minio-mc-admin/mc-admin-policy-detach.rst
:start-after: start-mc-admin-policy-detach-desc
:end-before: end-mc-admin-policy-detach-desc
* - :mc:`~mc admin policy entities`
- .. include:: /reference/minio-mc-admin/mc-admin-policy-entities.rst
:start-after: start-mc-admin-policy-entities-desc
:end-before: end-mc-admin-policy-entities-desc
* - :mc:`~mc admin policy info`
- .. include:: /reference/minio-mc-admin/mc-admin-policy-info.rst
:start-after: start-mc-admin-policy-info-desc
:end-before: end-mc-admin-policy-info-desc
* - :mc:`~mc admin policy ls`
- .. include:: /reference/minio-mc-admin/mc-admin-policy-list.rst
:start-after: start-mc-admin-policy-list-desc
:end-before: end-mc-admin-policy-list-desc
* - :mc:`~mc admin policy rm`
- .. include:: /reference/minio-mc-admin/mc-admin-policy-remove.rst
:start-after: start-mc-admin-policy-remove-desc
:end-before: end-mc-admin-policy-remove-desc
.. toctree::
:titlesonly:
:hidden:
/reference/minio-mc-admin/mc-admin-policy-attach
/reference/minio-mc-admin/mc-admin-policy-create
/reference/minio-mc-admin/mc-admin-policy-detach
/reference/minio-mc-admin/mc-admin-policy-entities
/reference/minio-mc-admin/mc-admin-policy-info
/reference/minio-mc-admin/mc-admin-policy-list
/reference/minio-mc-admin/mc-admin-policy-remove