ListCustomPrivacyPolicies - Identity as a Service - Alibaba Cloud Documentation Center

Retrieves a list of custom privacy policies.

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
NextToken	string	No	The token that is used to retrieve the next page of results.	NTxxxxxexample
PreviousToken	string	No	The token that is used to retrieve the previous page of results.	PTxxxxxexample
MaxResults	integer	No	The number of entries to return on each page.	20
CustomPrivacyPolicyNameStartsWith	string	No	The name of the custom privacy policy. This parameter supports prefix matching.	Custom

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	The total number of entries.	100
NextToken	string	The token that is used to retrieve the next page of results.	NTxxxexample
PreviousToken	string	The token that is used to retrieve the previous page of results.	PTxxxexample
MaxResults	integer	The number of entries to return on each page.	20
CustomPrivacyPolicies	array<object>	A list of custom privacy policies.
	object
InstanceId	string	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
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 status of the custom privacy policy. Valid values: disabled : The policy is disabled. enabled : The policy is enabled.	enabled
UserConsentType	string	The user consent type for the policy. Valid values: explicit_consent : Users must manually select a checkbox to provide consent. implied_consent : Consent is implied by default.	implied_consent
DefaultLanguageCode	string	The default language of the policy. The value is the LanguageCode returned by the ListLanguages operation.	zh-Hans-CN

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample",
  "PreviousToken": "PTxxxexample",
  "MaxResults": 20,
  "CustomPrivacyPolicies": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "CustomPrivacyPolicyId": "pp_xxxxx",
      "CustomPrivacyPolicyName": "Custom Privacy Policy Name",
      "Status": "enabled",
      "UserConsentType": "implied_consent",
      "DefaultLanguageCode": "zh-Hans-CN"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.