Skip to content

Commit 80c61d3

Browse files
docs: [google-cloud-iap] Add clarifications on IAP CorsSettings behavior (googleapis#13952)
BEGIN_COMMIT_OVERRIDE docs: Add clarifications on IAP CorsSettings behavior docs: Minor updates on GcipSettings description END_COMMIT_OVERRIDE - [ ] Regenerate this pull request now. docs: Minor updates on GcipSettings description PiperOrigin-RevId: 763926233 Source-Link: googleapis/googleapis@361c494 Source-Link: https://github.com/googleapis/googleapis-gen/commit/75609aa9c1ad70c59e2b51cb0776ff61950593a4 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWlhcC8uT3dsQm90LnlhbWwiLCJoIjoiNzU2MDlhYTljMWFkNzBjNTllMmI1MWNiMDc3NmZmNjE5NTA1OTNhNCJ9 --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent ff38a2f commit 80c61d3

File tree

1 file changed

+14
-13
lines changed
  • packages/google-cloud-iap/google/cloud/iap_v1/types

1 file changed

+14
-13
lines changed

packages/google-cloud-iap/google/cloud/iap_v1/types/service.py

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -417,17 +417,19 @@ class IdentitySource(proto.Enum):
417417

418418

419419
class GcipSettings(proto.Message):
420-
r"""Allows customers to configure tenant_id for GCIP instance per-app.
420+
r"""Allows customers to configure tenant IDs for a Cloud Identity
421+
Platform (GCIP) instance for each application.
421422
422423
Attributes:
423424
tenant_ids (MutableSequence[str]):
424-
Optional. GCIP tenant ids that are linked to the IAP
425-
resource. tenant_ids could be a string beginning with a
425+
Optional. GCIP tenant IDs that are linked to the IAP
426+
resource. ``tenant_ids`` could be a string beginning with a
426427
number character to indicate authenticating with GCIP tenant
427-
flow, or in the format of \_ to indicate authenticating with
428-
GCIP agent flow. If agent flow is used, tenant_ids should
429-
only contain one single element, while for tenant flow,
430-
tenant_ids can contain multiple elements.
428+
flow, or in the format of ``_<ProjectNumber>`` to indicate
429+
authenticating with GCIP agent flow. If agent flow is used,
430+
``tenant_ids`` should only contain one single element, while
431+
for tenant flow, ``tenant_ids`` can contain multiple
432+
elements.
431433
login_page_uri (google.protobuf.wrappers_pb2.StringValue):
432434
Login page URI associated with the GCIP
433435
tenants. Typically, all resources within the
@@ -448,15 +450,14 @@ class GcipSettings(proto.Message):
448450

449451

450452
class CorsSettings(proto.Message):
451-
r"""Allows customers to configure HTTP request paths that'll
452-
allow HTTP OPTIONS call to bypass authentication and
453-
authorization.
453+
r"""Allows customers to configure HTTP request paths that'll allow HTTP
454+
``OPTIONS`` call to bypass authentication and authorization.
454455
455456
Attributes:
456457
allow_http_options (google.protobuf.wrappers_pb2.BoolValue):
457-
Configuration to allow HTTP OPTIONS calls to
458-
skip authorization. If undefined, IAP will not
459-
apply any special logic to OPTIONS requests.
458+
Configuration to allow HTTP ``OPTIONS`` calls to skip
459+
authentication and authorization. If undefined, IAP will not
460+
apply any special logic to ``OPTIONS`` requests.
460461
"""
461462

462463
allow_http_options: wrappers_pb2.BoolValue = proto.Field(

0 commit comments

Comments
 (0)