profile property

String? profile
getter/setter pair

Specifies the default server behavior when the header is empty.

If not specified, the ScopeProfile.PERMIT_EMPTY_SCOPE option is used.

Optional. Possible string values are:

  • "SCOPE_PROFILE_UNSPECIFIED" : If not specified, the default value PERMIT_EMPTY_SCOPE is used.
  • "PERMIT_EMPTY_SCOPE" : When no consent scopes are provided (for example, if there's an empty or missing header), then consent check is disabled, similar to when access_enforced is false. You can use audit logs to differentiate these two cases by looking at the value of protopayload.metadata.consentMode. If consents scopes are present, they must be valid and within the allowed limits, otherwise the request will be rejected with a 4xx code.
  • "REQUIRED_ON_READ" : The consent header must be non-empty when performing read and search operations, otherwise the request is rejected with a 4xx code. Additionally, invalid consent scopes or scopes exceeding the allowed limits are rejected.

Implementation

core.String? profile;