Reference documentation and code samples for the Google Cloud Iap V1 Client class AttributePropagationSettings.
Configuration for propagating attributes to applications protected
by IAP.
Generated from protobuf message google.cloud.iap.v1.AttributePropagationSettings
Namespace
Google \ Cloud \ Iap \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ expression
string
Optional. Raw string CEL expression. Must return a list of attributes. A maximum of 45 attributes can be selected. Expressions can select different attribute types from attributes: attributes.saml_attributes, attributes.iap_attributes. The following functions are supported: - filter <list>.filter(<iter_var>, <predicate>): Returns a subset of <list> where <predicate> is true for every item. - in <var> in <list>: Returns true if <list> contains <var>. - selectByName <list>.selectByName(<string>): Returns the attribute in <list> with the given <string> name, otherwise returns empty. - emitAs <attribute>.emitAs(<string>): Sets the <attribute> name field to the given <string> for propagation in selected output credentials. - strict <attribute>.strict(): Ignores the x-goog-iap-attr- prefix for the provided <attribute> when propagating with the HEADER output credential, such as request headers. - append <target_list>.append(<attribute>) OR <target_list>.append(<list>): Appends the provided <attribute> or <list> to the end of <target_list>. Example expression: attributes.saml_attributes.filter(x, x.name in ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())
↳ output_credentials
array
Optional. Which output credentials attributes selected by the CEL expression should be propagated in. All attributes will be fully duplicated in each selected output credential.
↳ enable
bool
Optional. Whether the provided attribute propagation settings should be evaluated on user requests. If set to true, attributes returned from the expression will be propagated in the set output credentials.
getExpression
Optional. Raw string CEL expression. Must return a list of attributes. A
maximum of 45 attributes can be selected. Expressions can select different
attribute types from attributes: attributes.saml_attributes,
attributes.iap_attributes. The following functions are supported:
filter <list>.filter(<iter_var>, <predicate>): Returns a subset of
<list> where <predicate> is true for every item.
in <var> in <list>: Returns true if <list> contains <var>.
selectByName <list>.selectByName(<string>): Returns the attribute
in
<list> with the given <string> name, otherwise returns empty.
emitAs <attribute>.emitAs(<string>): Sets the <attribute> name
field to the given <string> for propagation in selected output
credentials.
strict <attribute>.strict(): Ignores the x-goog-iap-attr- prefix
for the provided <attribute> when propagating with the HEADER output
credential, such as request headers.
append <target_list>.append(<attribute>) OR
<target_list>.append(<list>): Appends the provided <attribute> or
<list> to the end of <target_list>.
Example expression: attributes.saml_attributes.filter(x, x.name in
['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())
Returns
Type
Description
string
hasExpression
clearExpression
setExpression
Optional. Raw string CEL expression. Must return a list of attributes. A
maximum of 45 attributes can be selected. Expressions can select different
attribute types from attributes: attributes.saml_attributes,
attributes.iap_attributes. The following functions are supported:
filter <list>.filter(<iter_var>, <predicate>): Returns a subset of
<list> where <predicate> is true for every item.
in <var> in <list>: Returns true if <list> contains <var>.
selectByName <list>.selectByName(<string>): Returns the attribute
in
<list> with the given <string> name, otherwise returns empty.
emitAs <attribute>.emitAs(<string>): Sets the <attribute> name
field to the given <string> for propagation in selected output
credentials.
strict <attribute>.strict(): Ignores the x-goog-iap-attr- prefix
for the provided <attribute> when propagating with the HEADER output
credential, such as request headers.
append <target_list>.append(<attribute>) OR
<target_list>.append(<list>): Appends the provided <attribute> or
<list> to the end of <target_list>.
Example expression: attributes.saml_attributes.filter(x, x.name in
['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOutputCredentials
Optional. Which output credentials attributes selected by the CEL
expression should be propagated in. All attributes will be fully duplicated
in each selected output credential.
Optional. Which output credentials attributes selected by the CEL
expression should be propagated in. All attributes will be fully duplicated
in each selected output credential.
Parameter
Name
Description
var
int[]
Returns
Type
Description
$this
getEnable
Optional. Whether the provided attribute propagation settings should be
evaluated on user requests. If set to true, attributes returned from the
expression will be propagated in the set output credentials.
Returns
Type
Description
bool
hasEnable
clearEnable
setEnable
Optional. Whether the provided attribute propagation settings should be
evaluated on user requests. If set to true, attributes returned from the
expression will be propagated in the set output credentials.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Iap V1 Client - Class AttributePropagationSettings (2.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.2 (latest)](/php/docs/reference/cloud-iap/latest/V1.AttributePropagationSettings)\n- [2.1.1](/php/docs/reference/cloud-iap/2.1.1/V1.AttributePropagationSettings)\n- [2.0.3](/php/docs/reference/cloud-iap/2.0.3/V1.AttributePropagationSettings)\n- [1.4.5](/php/docs/reference/cloud-iap/1.4.5/V1.AttributePropagationSettings)\n- [1.3.4](/php/docs/reference/cloud-iap/1.3.4/V1.AttributePropagationSettings)\n- [1.2.3](/php/docs/reference/cloud-iap/1.2.3/V1.AttributePropagationSettings)\n- [1.1.1](/php/docs/reference/cloud-iap/1.1.1/V1.AttributePropagationSettings)\n- [1.0.1](/php/docs/reference/cloud-iap/1.0.1/V1.AttributePropagationSettings) \nReference documentation and code samples for the Google Cloud Iap V1 Client class AttributePropagationSettings.\n\nConfiguration for propagating attributes to applications protected\nby IAP.\n\nGenerated from protobuf message `google.cloud.iap.v1.AttributePropagationSettings`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Iap \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getExpression\n\nOptional. Raw string CEL expression. Must return a list of attributes. A\nmaximum of 45 attributes can be selected. Expressions can select different\nattribute types from `attributes`: `attributes.saml_attributes`,\n`attributes.iap_attributes`. The following functions are supported:\n\n- filter `\u003clist\u003e.filter(\u003citer_var\u003e, \u003cpredicate\u003e)`: Returns a subset of `\u003clist\u003e` where `\u003cpredicate\u003e` is true for every item.\n\n\u003c!-- --\u003e\n\n- in `\u003cvar\u003e in \u003clist\u003e`: Returns true if `\u003clist\u003e` contains `\u003cvar\u003e`.\n - selectByName `\u003clist\u003e.selectByName(\u003cstring\u003e)`: Returns the attribute in `\u003clist\u003e` with the given `\u003cstring\u003e` name, otherwise returns empty.\n - emitAs `\u003cattribute\u003e.emitAs(\u003cstring\u003e)`: Sets the `\u003cattribute\u003e` name field to the given `\u003cstring\u003e` for propagation in selected output credentials.\n - strict `\u003cattribute\u003e.strict()`: Ignores the `x-goog-iap-attr-` prefix for the provided `\u003cattribute\u003e` when propagating with the `HEADER` output credential, such as request headers.\n - append `\u003ctarget_list\u003e.append(\u003cattribute\u003e)` OR `\u003ctarget_list\u003e.append(\u003clist\u003e)`: Appends the provided `\u003cattribute\u003e` or `\u003clist\u003e` to the end of `\u003ctarget_list\u003e`. Example expression: `attributes.saml_attributes.filter(x, x.name in\n ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())`\n\n### hasExpression\n\n### clearExpression\n\n### setExpression\n\nOptional. Raw string CEL expression. Must return a list of attributes. A\nmaximum of 45 attributes can be selected. Expressions can select different\nattribute types from `attributes`: `attributes.saml_attributes`,\n`attributes.iap_attributes`. The following functions are supported:\n\n- filter `\u003clist\u003e.filter(\u003citer_var\u003e, \u003cpredicate\u003e)`: Returns a subset of `\u003clist\u003e` where `\u003cpredicate\u003e` is true for every item.\n\n\u003c!-- --\u003e\n\n- in `\u003cvar\u003e in \u003clist\u003e`: Returns true if `\u003clist\u003e` contains `\u003cvar\u003e`.\n - selectByName `\u003clist\u003e.selectByName(\u003cstring\u003e)`: Returns the attribute in `\u003clist\u003e` with the given `\u003cstring\u003e` name, otherwise returns empty.\n - emitAs `\u003cattribute\u003e.emitAs(\u003cstring\u003e)`: Sets the `\u003cattribute\u003e` name field to the given `\u003cstring\u003e` for propagation in selected output credentials.\n - strict `\u003cattribute\u003e.strict()`: Ignores the `x-goog-iap-attr-` prefix for the provided `\u003cattribute\u003e` when propagating with the `HEADER` output credential, such as request headers.\n - append `\u003ctarget_list\u003e.append(\u003cattribute\u003e)` OR `\u003ctarget_list\u003e.append(\u003clist\u003e)`: Appends the provided `\u003cattribute\u003e` or `\u003clist\u003e` to the end of `\u003ctarget_list\u003e`. Example expression: `attributes.saml_attributes.filter(x, x.name in\n ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())`\n\n### getOutputCredentials\n\nOptional. Which output credentials attributes selected by the CEL\nexpression should be propagated in. All attributes will be fully duplicated\nin each selected output credential.\n\n### setOutputCredentials\n\nOptional. Which output credentials attributes selected by the CEL\nexpression should be propagated in. All attributes will be fully duplicated\nin each selected output credential.\n\n### getEnable\n\nOptional. Whether the provided attribute propagation settings should be\nevaluated on user requests. If set to true, attributes returned from the\nexpression will be propagated in the set output credentials.\n\n### hasEnable\n\n### clearEnable\n\n### setEnable\n\nOptional. Whether the provided attribute propagation settings should be\nevaluated on user requests. If set to true, attributes returned from the\nexpression will be propagated in the set output credentials."]]
