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 \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ expression |
string
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 |
↳ output_credentials |
array
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
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
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 thex-goog-iap-attr-
prefix for the provided<attribute>
when propagating with theHEADER
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())
- selectByName
Returns | |
---|---|
Type | Description |
string |
hasExpression
clearExpression
setExpression
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 thex-goog-iap-attr-
prefix for the provided<attribute>
when propagating with theHEADER
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())
- selectByName
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getOutputCredentials
Which output credentials attributes selected by the CEL expression should be propagated in. All attributes will be fully duplicated in each selected output credential.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setOutputCredentials
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
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
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.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |