Changes to ccn_api-ref from docs/doc-exports#1451 (CCN API 20250121 version)

Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: OpenTelekomCloud Proposal Bot <proposalbot@otc-service.com>
Co-committed-by: OpenTelekomCloud Proposal Bot <proposalbot@otc-service.com>

api-ref/source/api/central_network_capabilities/index.rst

@@ -0,0 +1,14 @@
+:original_name: topic_300000015.html
+
+.. _topic_300000015:
+
+Central Network Capabilities
+============================
+
+-  :ref:`Querying Central Network Capabilities <listcentralnetworkcapabilities>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   querying_central_network_capabilities

api-ref/source/api/central_network_connections/index.rst

@@ -0,0 +1,16 @@
+:original_name: topic_300000008.html
+
+.. _topic_300000008:
+
+Central Network Connections
+===========================
+
+-  :ref:`Querying the List of Central Network Connections <listcentralnetworkconnections>`
+-  :ref:`Modifying the Bandwidth of a Central Network Connection <updatecentralnetworkconnection>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   querying_the_list_of_central_network_connections
+   modifying_the_bandwidth_of_a_central_network_connection

api-ref/source/api/central_network_policies/deleting_a_central_network_policy.rst

@@ -0,0 +1,78 @@
+:original_name: DeleteCentralNetworkPolicy.html
+
+.. _DeleteCentralNetworkPolicy:
+
+Deleting a Central Network Policy
+=================================
+
+Function
+--------
+
+This API is used to delete a central network policy. An applied policy cannot be deleted.
+
+URI
+---
+
+DELETE /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id}
+
+.. table:: **Table 1** Path Parameters
+
+   ================== ========= ====== ==========================
+   Parameter          Mandatory Type   Description
+   ================== ========= ====== ==========================
+   domain_id          Yes       String Account ID.
+   policy_id          Yes       String Central network policy ID.
+   central_network_id Yes       String Central network ID.
+   ================== ========= ====== ==========================
+
+Request Parameters
+------------------
+
+.. table:: **Table 2** Request header parameters
+
+   ============ ========= ====== ===========
+   Parameter    Mandatory Type   Description
+   ============ ========= ====== ===========
+   X-Auth-Token No        String User token.
+   ============ ========= ====== ===========
+
+Response Parameters
+-------------------
+
+**Status code: 204**
+
+.. table:: **Table 3** Response header parameters
+
+   ============ ====== ===========
+   Parameter    Type   Description
+   ============ ====== ===========
+   x-request-id String ``-``
+   ============ ====== ===========
+
+Example Requests
+----------------
+
+Deleting a central network policy
+
+.. code-block:: text
+
+   DELETE /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id}
+
+Example Responses
+-----------------
+
+None
+
+Status Codes
+------------
+
+=========== ============================================
+Status Code Description
+=========== ============================================
+204         The central network policy has been deleted.
+=========== ============================================
+
+Error Codes
+-----------
+
+See :ref:`Error Codes <errorcode>`.

api-ref/source/api/central_network_policies/index.rst

@@ -0,0 +1,22 @@
+:original_name: topic_300000009.html
+
+.. _topic_300000009:
+
+Central Network Policies
+========================
+
+-  :ref:`Adding a Central Network Policy <createcentralnetworkpolicy>`
+-  :ref:`Querying the List of Central Network Policies <listcentralnetworkpolicies>`
+-  :ref:`Applying a Central Network Policy <applycentralnetworkpolicy>`
+-  :ref:`Deleting a Central Network Policy <deletecentralnetworkpolicy>`
+-  :ref:`Querying the Changes Between the Current Policy and an Applied Policy <listcentralnetworkpolicychangeset>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   adding_a_central_network_policy
+   querying_the_list_of_central_network_policies
+   applying_a_central_network_policy
+   deleting_a_central_network_policy
+   querying_the_changes_between_the_current_policy_and_an_applied_policy

api-ref/source/api/central_network_quotas/index.rst

@@ -0,0 +1,14 @@
+:original_name: topic_300000014.html
+
+.. _topic_300000014:
+
+Central Network Quotas
+======================
+
+-  :ref:`Querying Central Network Resource Quotas <listcentralnetworkquotas>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   querying_central_network_resource_quotas

api-ref/source/api/central_networks/index.rst

@@ -0,0 +1,22 @@
+:original_name: topic_300000006.html
+
+.. _topic_300000006:
+
+Central Networks
+================
+
+-  :ref:`Creating a Central Network <createcentralnetwork>`
+-  :ref:`Querying the Central Network List <listcentralnetworks>`
+-  :ref:`Querying a Central Network <showcentralnetwork>`
+-  :ref:`Updating a Central Network <updatecentralnetwork>`
+-  :ref:`Deleting a Central Network <deletecentralnetwork>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   creating_a_central_network
+   querying_the_central_network_list
+   querying_a_central_network
+   updating_a_central_network
+   deleting_a_central_network

api-ref/source/api/global_connection_bandwidths/deleting_a_global_connection_bandwidth.rst

@@ -0,0 +1,73 @@
+:original_name: DeleteGlobalConnectionBandwidth.html
+
+.. _DeleteGlobalConnectionBandwidth:
+
+Deleting a Global Connection Bandwidth
+======================================
+
+Function
+--------
+
+This API is used to delete a global connection bandwidth.
+
+URI
+---
+
+DELETE /v3/{domain_id}/gcb/gcbandwidths/{id}
+
+.. table:: **Table 1** Path Parameters
+
+   ========= ========= ====== ============
+   Parameter Mandatory Type   Description
+   ========= ========= ====== ============
+   domain_id Yes       String Account ID.
+   id        Yes       String Instance ID.
+   ========= ========= ====== ============
+
+Request Parameters
+------------------
+
+.. table:: **Table 2** Request header parameters
+
+   ============ ========= ====== ===========
+   Parameter    Mandatory Type   Description
+   ============ ========= ====== ===========
+   X-Auth-Token No        String User token.
+   ============ ========= ====== ===========
+
+Response Parameters
+-------------------
+
+**Status code: 204**
+
+The global connection bandwidth has been deleted.
+
+None
+
+Example Requests
+----------------
+
+Deleting a global connection bandwidth
+
+.. code-block:: text
+
+   DELETE https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths/{id}
+
+Example Responses
+-----------------
+
+None
+
+Status Codes
+------------
+
+=========== =================================================
+Status Code Description
+=========== =================================================
+204         The global connection bandwidth has been deleted.
+=========== =================================================
+
+Error Codes
+-----------
+
+See :ref:`Error Codes <errorcode>`.

api-ref/source/api/global_connection_bandwidths/index.rst

@@ -0,0 +1,28 @@
+:original_name: topic_300000019.html
+
+.. _topic_300000019:
+
+Global Connection Bandwidths
+============================
+
+-  :ref:`Querying the Global Connection Bandwidth List <listglobalconnectionbandwidths>`
+-  :ref:`Creating a Global Connection Bandwidth <createglobalconnectionbandwidth>`
+-  :ref:`Querying a Global Connection Bandwidth <showglobalconnectionbandwidth>`
+-  :ref:`Updating a Global Connection Bandwidth <updateglobalconnectionbandwidth>`
+-  :ref:`Deleting a Global Connection Bandwidth <deleteglobalconnectionbandwidth>`
+-  :ref:`Querying the List of Global Connection Bandwidths That Meet the Binding Conditions <listsupportbindingconnectionbandwidths>`
+-  :ref:`Querying the Tenant Configuration of a Global Connection Bandwidth <listglobalconnectionbandwidthconfigs>`
+-  :ref:`Querying the Site List <listglobalconnectionbandwidthsites>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   querying_the_global_connection_bandwidth_list
+   creating_a_global_connection_bandwidth
+   querying_a_global_connection_bandwidth
+   updating_a_global_connection_bandwidth
+   deleting_a_global_connection_bandwidth
+   querying_the_list_of_global_connection_bandwidths_that_meet_the_binding_conditions
+   querying_the_tenant_configuration_of_a_global_connection_bandwidth
+   querying_the_site_list

api-ref/source/api/index.rst

@@ -0,0 +1,24 @@
+:original_name: cc_01_0014.html
+
+.. _cc_01_0014:
+
+API
+===
+
+-  :ref:`Central Networks <topic_300000006>`
+-  :ref:`Central Network Connections <topic_300000008>`
+-  :ref:`Central Network Policies <topic_300000009>`
+-  :ref:`Central Network Quotas <topic_300000014>`
+-  :ref:`Central Network Capabilities <topic_300000015>`
+-  :ref:`Global Connection Bandwidths <topic_300000019>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   central_networks/index
+   central_network_connections/index
+   central_network_policies/index
+   central_network_quotas/index
+   central_network_capabilities/index
+   global_connection_bandwidths/index

api-ref/source/api_usage_guidelines.rst

@@ -0,0 +1,12 @@
+:original_name: cc_01_0013.html
+
+.. _cc_01_0013:
+
+API Usage Guidelines
+====================
+
+Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://*Endpoint/uri*. In the URL, *uri* indicates the resource path, that is, the API access path.
+
+Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted using JSON messages, with the media type represented by **Application/json**.
+
+For details about how to use APIs, see `API Usage Guidelines <https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API%20Documents>`__.

api-ref/source/appendix/index.rst

@@ -0,0 +1,18 @@
+:original_name: cc_01_0024.html
+
+.. _cc_01_0024:
+
+Appendix
+========
+
+-  :ref:`Status Codes <cc_01_0025>`
+-  :ref:`Error Codes <errorcode>`
+-  :ref:`Obtaining a Project ID <cc_01_0027>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   status_codes
+   error_codes
+   obtaining_a_project_id

api-ref/source/appendix/obtaining_a_project_id.rst

@@ -0,0 +1,72 @@
+:original_name: cc_01_0027.html
+
+.. _cc_01_0027:
+
+Obtaining a Project ID
+======================
+
+Scenarios
+---------
+
+A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:
+
+-  :ref:`Obtain the Project ID by Calling an API <cc_01_0027__en-us_topic_0121673684_section86806471133>`
+-  :ref:`Obtain the Project ID from the Console <cc_01_0027__en-us_topic_0121673684_section32975495318>`
+
+.. _cc_01_0027__en-us_topic_0121673684_section86806471133:
+
+Obtain the Project ID by Calling an API
+---------------------------------------
+
+You can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.
+
+The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from `Regions and Endpoints <https://docs.otc.t-systems.com/regions-and-endpoints/index.html>`__.
+
+The following is an example response. The value of **id** is the project ID.
+
+.. code-block::
+
+   {
+       "projects": [
+           {
+               "domain_id": "65ewtrgaggshhk1223245sghjlse684b",
+               "is_domain": false,
+               "parent_id": "65ewtrgaggshhk1223245sghjlse684b",
+               "name": "project_name",
+               "description": "",
+               "links": {
+                   "next": null,
+                   "previous": null,
+                   "self": "https://www.example.com/v3/projects/a4adasfjljaaaakla12334jklga9sasfg"
+               },
+               "id": "a4adasfjljaaaakla12334jklga9sasfg",
+               "enabled": true
+           }
+       ],
+       "links": {
+           "next": null,
+           "previous": null,
+           "self": "https://www.example.com/v3/projects"
+       }
+   }
+
+.. _cc_01_0027__en-us_topic_0121673684_section32975495318:
+
+Obtain a Project ID from the Console
+------------------------------------
+
+A project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to obtain a project ID:
+
+#. Log in to the management console.
+
+#. Click the username and select **My Credentials** from the drop-down list.
+
+   On the **My Credentials** page, view project IDs in the project list.
+
+
+   .. figure:: /_static/images/en-us_image_0000001508295281.png
+      :alt: **Figure 1** Viewing project IDs
+
+      **Figure 1** Viewing project IDs
+
+   In multi-project scenarios, expand the region, and obtain your sub-project ID from the **Project ID** column.

api-ref/source/appendix/status_codes.rst

@@ -0,0 +1,56 @@
+:original_name: cc_01_0025.html
+
+.. _cc_01_0025:
+
+Status Codes
+============
+
+-  Normal
+
+   .. table:: **Table 1** Status codes for successful requests
+
+      +-------------+----------------+-------------------------------------------------------+
+      | Status Code | Returned Value | Description                                           |
+      +=============+================+=======================================================+
+      | 200         | OK             | Normal response for the POST, GET, and PUT operations |
+      +-------------+----------------+-------------------------------------------------------+
+      | 201         | Created        | Normal response code for POST operations              |
+      +-------------+----------------+-------------------------------------------------------+
+      | 204         | No Content     | Normal response code for DELETE operations            |
+      +-------------+----------------+-------------------------------------------------------+
+
+-  Abnormal
+
+   .. table:: **Table 2** Status codes for failed requests
+
+      +-------------+-------------------------------+--------------------------------------------------------------------------------------------+
+      | Status Code | Returned Value                | Description                                                                                |
+      +=============+===============================+============================================================================================+
+      | 400         | Bad Request                   | The server failed to process the request.                                                  |
+      +-------------+-------------------------------+--------------------------------------------------------------------------------------------+
+      | 401         | Unauthorized                  | You must enter a username and password to access the requested page.                       |
+      +-------------+-------------------------------+--------------------------------------------------------------------------------------------+
+      | 403         | Forbidden                     | You are forbidden to access the requested page.                                            |
+      +-------------+-------------------------------+--------------------------------------------------------------------------------------------+
+      | 404         | Not Found                     | The server could not find the requested page.                                              |
+      +-------------+-------------------------------+--------------------------------------------------------------------------------------------+
+      | 405         | Method Not Allowed            | You are not allowed to use the method specified in the request.                            |
+      +-------------+-------------------------------+--------------------------------------------------------------------------------------------+
+      | 406         | Not Acceptable                | The response generated by the server could not be accepted by the client.                  |
+      +-------------+-------------------------------+--------------------------------------------------------------------------------------------+
+      | 407         | Proxy Authentication Required | You must use the proxy server for authentication so that the request can be processed.     |
+      +-------------+-------------------------------+--------------------------------------------------------------------------------------------+
+      | 408         | Request Timeout               | The request timed out.                                                                     |
+      +-------------+-------------------------------+--------------------------------------------------------------------------------------------+
+      | 409         | Conflict                      | The request could not be processed due to a conflict.                                      |
+      +-------------+-------------------------------+--------------------------------------------------------------------------------------------+
+      | 500         | Internal Server Error         | Failed to complete the request because of an internal service error.                       |
+      +-------------+-------------------------------+--------------------------------------------------------------------------------------------+
+      | 501         | Not Implemented               | Failed to complete the request because the server does not support the requested function. |
+      +-------------+-------------------------------+--------------------------------------------------------------------------------------------+
+      | 502         | Bad Gateway                   | Failed to complete the request because the server has received an invalid response.        |
+      +-------------+-------------------------------+--------------------------------------------------------------------------------------------+
+      | 503         | Service Unavailable           | Failed to complete the request because the service is unavailable.                         |
+      +-------------+-------------------------------+--------------------------------------------------------------------------------------------+
+      | 504         | Gateway Timeout               | A gateway timeout error occurred.                                                          |
+      +-------------+-------------------------------+--------------------------------------------------------------------------------------------+

api-ref/source/change_history.rst

@@ -0,0 +1,20 @@
+:original_name: cc_01_0029.html
+
+.. _cc_01_0029:
+
+Change History
+==============
+
++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
+| Released On                       | Description                                                                                                                             |
++===================================+=========================================================================================================================================+
+| 2025-01-29                        | This release incorporates the following changes:                                                                                        |
+|                                   |                                                                                                                                         |
+|                                   | Deleted sections "Binding a Global Connection Bandwidth to an Instance" and "Unbinding a Global Connection Bandwidth from an Instance." |
++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
+| 2025-01-22                        | This release incorporates the following changes:                                                                                        |
+|                                   |                                                                                                                                         |
+|                                   | Resolved the issue that there were two titles for querying the details about a global connection bandwidth.                             |
++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
+| 2024-11-26                        | This issue is the first official release.                                                                                               |
++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+

api-ref/source/docutils.conf

@@ -0,0 +1,2 @@
+[html writers]
+table-style: table, caption-top

api-ref/source/index.rst

@@ -1,3 +1,12 @@
-=============================================
+=============================
-Welcome to the documentation of cloud-connect
+Cloud Connect - API Reference
-=============================================
+=============================
+
+.. toctree::
+   :maxdepth: 1
+
+   api_usage_guidelines
+   api/index
+   permissions_and_supported_actions/index
+   appendix/index
+   change_history

api-ref/source/permissions_and_supported_actions/actions_supported_by_policy-based_authorization.rst

@@ -0,0 +1,82 @@
+:original_name: cc_02_0003.html
+
+.. _cc_02_0003:
+
+Actions Supported by Policy-based Authorization
+===============================================
+
+This topic describes the actions supported by Cloud Connect in policy-based authorization.
+
+Supported Actions
+-----------------
+
+Cloud Connect provides system-defined policies that can be directly used in IAM. You can also create custom policies to supplement system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:
+
+-  Permissions: allow or deny operations on specified resources under specific conditions.
+-  APIs: REST APIs that can be called by a user who has been granted specific permissions.
+-  Actions: specific operations that are allowed or denied.
+-  Related actions: actions on which a specific action depends to take effect. When assigning permissions for the action to a user, you also need to assign permissions for the related actions.
+-  IAM or enterprise projects: type of projects for which an action will take effect. Policies that contain actions for both IAM and enterprise projects can be used and take effect for both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM. Administrators can check whether an action supports IAM projects or enterprise projects in the action list. "Y" indicates that the action supports the project and "x" indicates that the action does not support the project.
+
+Cloud Connect supports the following actions in custom policies:
+
+-  :ref:`Central Networks <cc_02_0003__section1554071374415>`: actions supported by all central network APIs, such as the APIs for creating, updating, and deleting a central network, querying central network details, and querying the central network list
+-  :ref:`Central Network Policies <cc_02_0003__section1096015764615>`: actions supported by all central network policy APIs, such as the APIs for adding, applying, deleting a central network policy, querying central network policy details, querying the central network policy list, and querying policy changes
+-  :ref:`Central Network Connections <cc_02_0003__section13988959134617>`: actions supported by all central network connection APIs, such as the APIs for querying the central network connection list and updating a central network connection
+
+.. _cc_02_0003__section1554071374415:
+
+Central Networks
+----------------
+
+.. table:: **Table 1** Actions supported for central networks
+
+   +-----------------------------------+------------------------------------------------------------------+--------------------------+----------------+-------------+--------------------+
+   | Permission                        | API                                                              | Action                   | Related Action | IAM Project | Enterprise Project |
+   +===================================+==================================================================+==========================+================+=============+====================+
+   | Creating a central network        | POST /v3/{domain_id}/gcn/central-networks                        | cc:centralNetwork:create | ``-``          | Y           | Y                  |
+   +-----------------------------------+------------------------------------------------------------------+--------------------------+----------------+-------------+--------------------+
+   | Updating a central network        | PUT /v3/{domain_id}/gcn/central-networks/{central_network_id}    | cc:centralNetwork:update | ``-``          | Y           | Y                  |
+   +-----------------------------------+------------------------------------------------------------------+--------------------------+----------------+-------------+--------------------+
+   | Deleting a central network        | DELETE /v3/{domain_id}/gcn/central-networks/{central_network_id} | cc:centralNetwork:delete | ``-``          | Y           | Y                  |
+   +-----------------------------------+------------------------------------------------------------------+--------------------------+----------------+-------------+--------------------+
+   | Querying central network details  | GET /v3/{domain_id}/gcn/central-networks/{central_network_id}    | cc:centralNetwork:get    | ``-``          | Y           | Y                  |
+   +-----------------------------------+------------------------------------------------------------------+--------------------------+----------------+-------------+--------------------+
+   | Querying the central network list | GET /v3/{domain_id}/gcn/central-networks                         | cc:centralNetwork:list   | ``-``          | Y           | Y                  |
+   +-----------------------------------+------------------------------------------------------------------+--------------------------+----------------+-------------+--------------------+
+
+.. _cc_02_0003__section1096015764615:
+
+Central Network Policies
+------------------------
+
+.. table:: **Table 2** Actions supported for central network policies
+
+   +-----------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+----------------+-------------+--------------------+
+   | Permission                        | API                                                                                          | Action                          | Related Action | IAM Project | Enterprise Project |
+   +===================================+==============================================================================================+=================================+================+=============+====================+
+   | Adding a central network policy   | POST /v3/{domain_id}/gcn/central-network/{central_network_id}/policies                       | cc:centralNetwork:createPolicy  | ``-``          | Y           | Y                  |
+   +-----------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+----------------+-------------+--------------------+
+   | Applying a central network policy | POST /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id}/apply     | cc:centralNetwork:applyPolicy   | ``-``          | Y           | Y                  |
+   +-----------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+----------------+-------------+--------------------+
+   | Deleting a central network policy | DELETE /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id}         | cc:centralNetwork:deletePolicy  | ``-``          | Y           | Y                  |
+   +-----------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+----------------+-------------+--------------------+
+   | Querying the central network list | GET /v3/{domain_id}/gcn/central-network/{central_network_id}/policies                        | cc:centralNetwork:listPolicies  | ``-``          | Y           | Y                  |
+   +-----------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+----------------+-------------+--------------------+
+   | Querying policy changes           | GET /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id}/change-set | cc:centralNetwork:listChangeSet | ``-``          | Y           | Y                  |
+   +-----------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+----------------+-------------+--------------------+
+
+.. _cc_02_0003__section13988959134617:
+
+Central Network Connections
+---------------------------
+
+.. table:: **Table 3** Actions supported for central network connections
+
+   +----------------------------------------------+------------------------------------------------------------------------------------------+------------------------------------+----------------+-------------+--------------------+
+   | Permission                                   | API                                                                                      | Action                             | Related Action | IAM Project | Enterprise Project |
+   +==============================================+==========================================================================================+====================================+================+=============+====================+
+   | Querying the central network connection list | GET /v3/{domain_id}/gcn/central-network/{central_network_id}/connections                 | cc:centralNetwork:listConnections  | ``-``          | Y           | Y                  |
+   +----------------------------------------------+------------------------------------------------------------------------------------------+------------------------------------+----------------+-------------+--------------------+
+   | Updating a central network connection        | PUT /v3/{domain_id}/gcn/central-network/{central_network_id}/connections/{connection_id} | cc:centralNetwork:updateConnection | ``-``          | Y           | Y                  |
+   +----------------------------------------------+------------------------------------------------------------------------------------------+------------------------------------+----------------+-------------+--------------------+

api-ref/source/permissions_and_supported_actions/index.rst

@@ -0,0 +1,16 @@
+:original_name: cc_02_0001.html
+
+.. _cc_02_0001:
+
+Permissions and Supported Actions
+=================================
+
+-  :ref:`Introduction <cc_02_0002>`
+-  :ref:`Actions Supported by Policy-based Authorization <cc_02_0003>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   introduction
+   actions_supported_by_policy-based_authorization

api-ref/source/permissions_and_supported_actions/introduction.rst

@@ -0,0 +1,31 @@
+:original_name: cc_02_0002.html
+
+.. _cc_02_0002:
+
+Introduction
+============
+
+You can use Identity and Access Management (IAM) for fine-grained permissions management of your Cloud Connect resources. If your account does not need individual IAM users, you can skip this topic.
+
+With IAM, you can control access to specific cloud resources. IAM supports role/policy-based authorization and identity policy-based authorization.
+
+The following table describes the differences between the two authorization models.
+
+.. table:: **Table 1** Differences between role/policy-based and identity policy-based authorization
+
+   +---------------------+-------------------------------------+-------------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | Authorization Model | Authorization Using                 | Permissions                         | Authorization Method                         | Scenario                                                                                                                                                                                                                                                                                                                   |
+   +=====================+=====================================+=====================================+==============================================+============================================================================================================================================================================================================================================================================================================================+
+   | Role/Policy         | User-permission-authorization scope | -  System-defined roles             | Assigning roles or policies to principals    | To authorize a user, you need to add it to a user group first and then specify the scope of authorization. It is hard to provide fine-grained permissions control using authorization by user groups and a limited number of condition keys. This method is suitable for small- and medium-sized enterprises.              |
+   |                     |                                     | -  System-defined policies          |                                              |                                                                                                                                                                                                                                                                                                                            |
+   |                     |                                     | -  Custom policies                  |                                              |                                                                                                                                                                                                                                                                                                                            |
+   +---------------------+-------------------------------------+-------------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | Identity policy     | User-policy                         | -  System-defined identity policies | -  Assigning identity policies to principals | You can authorize a user by attaching an identity policy to it. User-specific authorization and a variety of key conditions allow for more fine-grained permissions control. However, this model can be hard to set up. It requires a certain amount of expertise and is suitable for medium- and large-sized enterprises. |
+   |                     |                                     | -  Custom identity policies         | -  Attaching identity policies to principals |                                                                                                                                                                                                                                                                                                                            |
+   +---------------------+-------------------------------------+-------------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+Policies and actions in the two authorization models are not interoperable. You are advised to use the identity policy-based authorization model.
+
+If you use IAM users in your account to call an API, the IAM users must be granted the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully.
+
+Assume that an IAM user wants to call an API to query central networks. With role/policy-based authorization, the IAM user must be granted the permissions allowing for action **cc:centralNetwork:list**. With identity policy-based authorization, the IAM user must be granted the permissions allowing for action **cc:centralNetwork:list**.