Function
This API is used to check whether sharing with Organizations is enabled.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
| Action | Access Level | Resource Type (*: required) | Condition Key | Alias | Dependencies |
| ram:resourceShares:searchEnableSharingWithOrganization | Read | - | - | - | - |
URI
GET /v1/organization-share
Response Parameters
Status code: 200
Table 2 Response body parameters | Parameter | Type | Description |
| enabled | Boolean | Whether sharing with Organizations is enabled. If the value is true, sharing with Organizations is enabled. The default value is false. |
Example Requests
Checking whether sharing with Organizations is enabled
GET /v1/organization-share
Example Responses
Status code: 200
Request succeeded.
{
"enabled" : true
} Status Codes
| Status Code | Description |
| 200 | Request succeeded. |