Skip to content

Commit 87cc6d8

Browse files
Google APIscopybara-github
authored andcommitted
docs: few minor changes on doc description came out of cl/512701532
PiperOrigin-RevId: 521002986
1 parent 53d620a commit 87cc6d8

1 file changed

Lines changed: 21 additions & 16 deletions

File tree

google/cloud/iap/v1/service.proto

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -456,7 +456,6 @@ message ReauthSettings {
456456
// Prompts the user to log in again.
457457
LOGIN = 1;
458458

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

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

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

569-
// Raw string CEL expression. Must return a list of attributes. Maximum of 45
570-
// attributes can be selected. Expressions can select different attribute
568+
// Raw string CEL expression. Must return a list of attributes. A maximum of
569+
// 45 attributes can be selected. Expressions can select different attribute
571570
// types from `attributes`: `attributes.saml_attributes`,
572-
// `attributes.iap_attributes`. Limited functions are supported:
573-
// - `filter: <list>.filter(<iter_var>, <predicate>)` -> returns a subset of
571+
// `attributes.iap_attributes`. The following functions are supported:
572+
//
573+
// - filter `<list>.filter(<iter_var>, <predicate>)`: Returns a subset of
574574
// `<list>` where `<predicate>` is true for every item.
575-
// - `in: <var> in <list>` -> returns true if `<list>` contains `<var>`
576-
// - `selectByName: <list>.selectByName(<string>)` -> returns the attribute
575+
//
576+
// - in `<var> in <list>`: Returns true if `<list>` contains `<var>`.
577+
//
578+
// - selectByName `<list>.selectByName(<string>)`: Returns the attribute
577579
// in
578580
// `<list>` with the given `<string>` name, otherwise returns empty.
579-
// - `emitAs: <attribute>.emitAs(<string>)` -> sets the `<attribute>` name
581+
//
582+
// - emitAs `<attribute>.emitAs(<string>)`: Sets the `<attribute>` name
580583
// field to the given `<string>` for propagation in selected output
581584
// credentials.
582-
// - `strict: <attribute>.strict()` -> ignore the `x-goog-iap-attr-` prefix
583-
// for the provided `<attribute>` when propagating via the `HEADER` output
584-
// credential, i.e. request headers.
585-
// - `append: <target_list>.append(<attribute>)` OR
586-
// `<target_list>.append(<list>)` -> append the provided `<attribute>` or
587-
// `<list>` onto the end of `<target_list>`.
585+
//
586+
// - strict `<attribute>.strict()`: Ignores the `x-goog-iap-attr-` prefix
587+
// for the provided `<attribute>` when propagating with the `HEADER` output
588+
// credential, such as request headers.
589+
//
590+
// - append `<target_list>.append(<attribute>)` OR
591+
// `<target_list>.append(<list>)`: Appends the provided `<attribute>` or
592+
// `<list>` to the end of `<target_list>`.
588593
//
589594
// Example expression: `attributes.saml_attributes.filter(x, x.name in
590595
// ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())`

0 commit comments

Comments
 (0)