Skip to content

Commit

Permalink
docs: few minor changes on doc description came out of cl/512701532
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 521002986
  • Loading branch information
Google APIs authored and Copybara-Service committed Mar 31, 2023
1 parent 53d620a commit 87cc6d8
Showing 1 changed file with 21 additions and 16 deletions.
37 changes: 21 additions & 16 deletions google/cloud/iap/v1/service.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2022 Google LLC
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -456,7 +456,6 @@ message ReauthSettings {
// Prompts the user to log in again.
LOGIN = 1;

// Deprecated, no longer accepted by IAP APIs.
PASSWORD = 2 [deprecated = true];

// User must use their secure key 2nd factor device.
Expand Down Expand Up @@ -551,7 +550,7 @@ message AttributePropagationSettings {
// credential maps to a "field" in the response. For example, selecting JWT
// will propagate all attributes in the IAP JWT, header in the headers, etc.
enum OutputCredentials {
// No output credential. This is an unsupported default.
// An output credential is required.
OUTPUT_CREDENTIALS_UNSPECIFIED = 0;

// Propagate attributes in the headers with "x-goog-iap-attr-" prefix.
Expand All @@ -566,25 +565,31 @@ message AttributePropagationSettings {
RCTOKEN = 3;
}

// Raw string CEL expression. Must return a list of attributes. Maximum of 45
// attributes can be selected. Expressions can select different attribute
// 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`. Limited functions are supported:
// - `filter: <list>.filter(<iter_var>, <predicate>)` -> returns a subset of
// `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 `<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
//
// - 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>`.
//
// - 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())`
Expand Down

0 comments on commit 87cc6d8

Please sign in to comment.