Reference documentation and code samples for the Google Cloud Iap V1 Client class GcipSettings.
Allows customers to configure tenant IDs for a Cloud Identity Platform (GCIP) instance for each application.
Generated from protobuf message google.cloud.iap.v1.GcipSettings
Namespace
Google \ Cloud \ Iap \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ tenant_ids |
array
Optional. GCIP tenant IDs that are linked to the IAP resource. |
↳ login_page_uri |
Google\Protobuf\StringValue
Login page URI associated with the GCIP tenants. Typically, all resources within the same project share the same login page, though it could be overridden at the sub resource level. |
getTenantIds
Optional. GCIP tenant IDs that are linked to the IAP resource. tenant_ids
could be a string beginning with a number character to indicate
authenticating with GCIP tenant flow, or in the format of
_<ProjectNumber> to indicate authenticating with GCIP agent flow. If
agent flow is used, tenant_ids should only contain one single element,
while for tenant flow, tenant_ids can contain multiple elements.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setTenantIds
Optional. GCIP tenant IDs that are linked to the IAP resource. tenant_ids
could be a string beginning with a number character to indicate
authenticating with GCIP tenant flow, or in the format of
_<ProjectNumber> to indicate authenticating with GCIP agent flow. If
agent flow is used, tenant_ids should only contain one single element,
while for tenant flow, tenant_ids can contain multiple elements.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLoginPageUri
Login page URI associated with the GCIP tenants.
Typically, all resources within the same project share the same login page, though it could be overridden at the sub resource level.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\StringValue|null |
|
hasLoginPageUri
clearLoginPageUri
getLoginPageUriUnwrapped
Returns the unboxed value from getLoginPageUri()
Login page URI associated with the GCIP tenants. Typically, all resources within the same project share the same login page, though it could be overridden at the sub resource level.
| Returns | |
|---|---|
| Type | Description |
string|null |
|
setLoginPageUri
Login page URI associated with the GCIP tenants.
Typically, all resources within the same project share the same login page, though it could be overridden at the sub resource level.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\StringValue
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
setLoginPageUriUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\StringValue object.
Login page URI associated with the GCIP tenants. Typically, all resources within the same project share the same login page, though it could be overridden at the sub resource level.
| Parameter | |
|---|---|
| Name | Description |
var |
string|null
|
| Returns | |
|---|---|
| Type | Description |
$this |
|