Skip to content
This repository has been archived by the owner on Sep 5, 2023. It is now read-only.

docs: minor changes in AttributePropagationSettings #168

Merged
merged 2 commits into from
Apr 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 23 additions & 19 deletions google/cloud/iap_v1/types/service.py
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@ class Method(proto.Enum):
LOGIN (1):
Prompts the user to log in again.
PASSWORD (2):
Deprecated, no longer accepted by IAP APIs.
No description available.
SECURE_KEY (3):
User must use their secure key 2nd factor
device.
Expand Down Expand Up @@ -659,30 +659,35 @@ class AttributePropagationSettings(proto.Message):
Attributes:
expression (str):
Raw string CEL expression. Must return a list of attributes.
Maximum of 45 attributes can be selected. Expressions can
A maximum of 45 attributes can be selected. Expressions can
select different attribute types from ``attributes``:
``attributes.saml_attributes``,
``attributes.iap_attributes``. Limited functions are
``attributes.iap_attributes``. The following functions are
supported:

- ``filter: <list>.filter(<iter_var>, <predicate>)`` ->
returns a subset of ``<list>`` where ``<predicate>`` is
- 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

- 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

- strict ``<attribute>.strict()``: Ignores 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
``<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:
Expand Down Expand Up @@ -712,8 +717,7 @@ class OutputCredentials(proto.Enum):

Values:
OUTPUT_CREDENTIALS_UNSPECIFIED (0):
No output credential. This is an unsupported
default.
An output credential is required.
HEADER (1):
Propagate attributes in the headers with
"x-goog-iap-attr-" prefix.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-iap",
"version": "1.10.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down