Identity-Aware Proxy V1 API - Class Google::Cloud::Iap::V1::AttributePropagationSettings (v0.5.0)

Reference documentation and code samples for the Identity-Aware Proxy V1 API class Google::Cloud::Iap::V1::AttributePropagationSettings.

Configuration for propagating attributes to applications protected by IAP.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#enable

def enable() -> ::Boolean
Returns
  • (::Boolean) — 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.

#enable=

def enable=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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.

#expression

def expression() -> ::String
Returns
  • (::String) — Raw string CEL expression. Must return a list of attributes. Maximum of 45 attributes can be selected. Expressions can select different attribute types from attributes: attributes.saml_attributes, attributes.iap_attributes. Limited 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() -> ignore the x-goog-iap-attr- prefix for the provided <attribute> when propagating via the HEADER output credential, i.e. request headers.
    • append: <target_list>.append(<attribute>) OR <target_list>.append(<list>) -> append the provided <attribute> or <list> onto 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())

#expression=

def expression=(value) -> ::String
Parameter
  • value (::String) — Raw string CEL expression. Must return a list of attributes. Maximum of 45 attributes can be selected. Expressions can select different attribute types from attributes: attributes.saml_attributes, attributes.iap_attributes. Limited 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() -> ignore the x-goog-iap-attr- prefix for the provided <attribute> when propagating via the HEADER output credential, i.e. request headers.
    • append: <target_list>.append(<attribute>) OR <target_list>.append(<list>) -> append the provided <attribute> or <list> onto 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
  • (::String) — Raw string CEL expression. Must return a list of attributes. Maximum of 45 attributes can be selected. Expressions can select different attribute types from attributes: attributes.saml_attributes, attributes.iap_attributes. Limited 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() -> ignore the x-goog-iap-attr- prefix for the provided <attribute> when propagating via the HEADER output credential, i.e. request headers.
    • append: <target_list>.append(<attribute>) OR <target_list>.append(<list>) -> append the provided <attribute> or <list> onto 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

def output_credentials() -> ::Array<::Google::Cloud::Iap::V1::AttributePropagationSettings::OutputCredentials>
Returns

#output_credentials=

def output_credentials=(value) -> ::Array<::Google::Cloud::Iap::V1::AttributePropagationSettings::OutputCredentials>
Parameter
Returns