Skip to content

Commit 361c494

Browse files
Google APIscopybara-github
authored andcommitted
docs: Add clarifications on IAP CorsSettings behavior
docs: Minor updates on GcipSettings description PiperOrigin-RevId: 763926233
1 parent 07ab54b commit 361c494

1 file changed

Lines changed: 13 additions & 11 deletions

File tree

google/cloud/iap/v1/service.proto

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -448,14 +448,15 @@ message AccessSettings {
448448
[(google.api.field_behavior) = OPTIONAL];
449449
}
450450

451-
// Allows customers to configure tenant_id for GCIP instance per-app.
451+
// Allows customers to configure tenant IDs for a Cloud Identity Platform (GCIP)
452+
// instance for each application.
452453
message GcipSettings {
453-
// Optional. GCIP tenant ids that are linked to the IAP resource.
454-
// tenant_ids could be a string beginning with a number character to indicate
455-
// authenticating with GCIP tenant flow, or in the format of _<ProjectNumber>
456-
// to indicate authenticating with GCIP agent flow.
457-
// If agent flow is used, tenant_ids should only contain one single element,
458-
// while for tenant flow, tenant_ids can contain multiple elements.
454+
// Optional. GCIP tenant IDs that are linked to the IAP resource. `tenant_ids`
455+
// could be a string beginning with a number character to indicate
456+
// authenticating with GCIP tenant flow, or in the format of
457+
// `_<ProjectNumber>` to indicate authenticating with GCIP agent flow. If
458+
// agent flow is used, `tenant_ids` should only contain one single element,
459+
// while for tenant flow, `tenant_ids` can contain multiple elements.
459460
repeated string tenant_ids = 1 [(google.api.field_behavior) = OPTIONAL];
460461

461462
// Login page URI associated with the GCIP tenants.
@@ -464,11 +465,12 @@ message GcipSettings {
464465
google.protobuf.StringValue login_page_uri = 2;
465466
}
466467

467-
// Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS
468-
// call to bypass authentication and authorization.
468+
// Allows customers to configure HTTP request paths that'll allow HTTP
469+
// `OPTIONS` call to bypass authentication and authorization.
469470
message CorsSettings {
470-
// Configuration to allow HTTP OPTIONS calls to skip authorization. If
471-
// undefined, IAP will not apply any special logic to OPTIONS requests.
471+
// Configuration to allow HTTP `OPTIONS` calls to skip
472+
// authentication and authorization. If undefined, IAP will not apply any
473+
// special logic to `OPTIONS` requests.
472474
google.protobuf.BoolValue allow_http_options = 1;
473475
}
474476

0 commit comments

Comments
 (0)