All Products
Search

This Product

    Identity as a Service:GetCustomPrivacyPolicy

    Document Center

    Identity as a Service:GetCustomPrivacyPolicy

    Last Updated:Jun 22, 2026

    Retrieves a custom privacy policy.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    eiam:GetCustomPrivacyPolicy

    get

    *CustomPrivacyPolicy

    acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#CustomPrivacyPolicyId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID.

    idaas_ue2jvisn35ea5lmthk267xxxxx
    CustomPrivacyPolicyId

    string

    Yes

    The custom privacy policy ID.

    pp_xxxxx

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    0441BD79-92F3-53AA-8657-F8CE4A2B912A
    CustomPrivacyPolicy

    object

    The custom privacy policy.

    CustomPrivacyPolicyId

    string

    The custom privacy policy ID.

    pp_xxxxx
    CustomPrivacyPolicyName

    string

    The custom privacy policy name.

    Custom Privacy Policy Name
    Status

    string

    The status of the custom privacy policy. Valid values:

    • enabled: Enabled.

    • disabled: Disabled.

    Valid values:

    • disabled :

      Disabled.

    • enabled :

      Enabled.

    enabled
    DefaultLanguageCode

    string

    The language of the custom privacy policy. The value is obtained from the LanguageCode parameter returned by the ListLanguages operation.

    zh-Hans-CN
    UserConsentType

    string

    The user consent type.

    Valid values:

    • explicit_consent :

      Manual consent required.

    • implied_consent :

      Consent by default.

    implied_consent
    CustomPrivacyPolicyContents

    array<object>

    The content details of the custom privacy policy.

    array<object>

    CustomPrivacyPolicyTip

    string

    The prompt for the custom privacy policy content.

    Please read and agree：
    LanguageCode

    string

    The language of the custom privacy policy. The value is the LanguageCode returned by the ListLanguages operation.

    zh-Hans-CN
    CustomPrivacyPolicyItems

    array<object>

    The items of the custom privacy policy.

    object

    CustomPrivacyPolicyItemName

    string

    The name of the custom privacy policy item.

    item name
    CustomPrivacyPolicyItemUrl

    string

    The URL of the custom privacy policy item. The URL must start with https://.

    https://example.com
    InstanceId

    string

    The instance ID.

    idaas_ue2jvisn35ea5lmthk267xxxxx

    Examples

    Success response

    JSON format

    {
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "CustomPrivacyPolicy": {
    "CustomPrivacyPolicyId": "pp_xxxxx",
    "CustomPrivacyPolicyName": "Custom Privacy Policy Name",
    "Status": "enabled",
    "DefaultLanguageCode": "zh-Hans-CN",
    "UserConsentType": "implied_consent",
    "CustomPrivacyPolicyContents": [
      {
        "CustomPrivacyPolicyTip": "Please read and agree：",
        "LanguageCode": "zh-Hans-CN",
        "CustomPrivacyPolicyItems": [
          {
            "CustomPrivacyPolicyItemName": "item name",
            "CustomPrivacyPolicyItemUrl": "https://example.com"
          }
        ]
      }
    ],
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx"
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.