Help Center/ Resource Access Manager/ API Reference/ APIs/ Sharing with Organizations/ Checking Whether Sharing with Organizations Is Enabled
Updated on 2025-10-30 GMT+08:00
View PDF

Checking Whether Sharing with Organizations Is Enabled

Function

This API is used to check whether sharing with Organizations is enabled.

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

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

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.

Error Codes

See Error Codes.