All Products
Search

This Product

    Identity as a Service:GetCustomPrivacyPolicy

    Document Center

    Identity as a Service:GetCustomPrivacyPolicy

    Last Updated:Oct 30, 2025

    Obtaining custom terms

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID.

    idaas_ue2jvisn35ea5lmthk267xxxxx
    CustomPrivacyPolicyId

    string

    Yes

    The ID of the custom privacy policy.

    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 ID of the custom privacy policy.

    pp_xxxxx
    CustomPrivacyPolicyName

    string

    The name of the custom privacy policy.

    Custom Privacy Policy Name
    Status

    string

    The valid values for the account status are:

    • enabled: Enabled.

    • disabled: Disabled.

    Valid values:

    • disabled :

      Disabled

    • enabled :

      Enabled

    enabled
    DefaultLanguageCode

    string

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

    zh-Hans-CN
    UserConsentType

    string

    Agreement Type.

    Valid values:

    • explicit_consent :

      Manually check to consent

    • implied_consent :

      Default consent

    implied_consent
    CustomPrivacyPolicyContents

    array<object>

    The details of the custom privacy policy content.

    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.