Reference documentation and code samples for the Google Cloud Iap V1 Client class AccessDeniedPageSettings.
Custom content configuration for access denied page.
IAP allows customers to define a custom URI to use as the error page when access is denied to users. If IAP prevents access to this page, the default IAP error page will be displayed instead.
Generated from protobuf message google.cloud.iap.v1.AccessDeniedPageSettings
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ access_denied_page_uri |
Google\Protobuf\StringValue
The URI to be redirected to when access is denied. |
↳ generate_troubleshooting_uri |
Google\Protobuf\BoolValue
Whether to generate a troubleshooting URL on access denied events to this application. |
↳ remediation_token_generation_enabled |
Google\Protobuf\BoolValue
Whether to generate remediation token on access denied events to this application. |
getAccessDeniedPageUri
The URI to be redirected to when access is denied.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\StringValue|null | |
hasAccessDeniedPageUri
clearAccessDeniedPageUri
getAccessDeniedPageUriValue
Returns the unboxed value from getAccessDeniedPageUri()
The URI to be redirected to when access is denied.
| Returns | |
|---|---|
| Type | Description |
string|null | |
setAccessDeniedPageUri
The URI to be redirected to when access is denied.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\StringValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setAccessDeniedPageUriValue
Sets the field by wrapping a primitive type in a Google\Protobuf\StringValue object.
The URI to be redirected to when access is denied.
| Parameter | |
|---|---|
| Name | Description |
var |
string|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGenerateTroubleshootingUri
Whether to generate a troubleshooting URL on access denied events to this application.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue|null | |
hasGenerateTroubleshootingUri
clearGenerateTroubleshootingUri
getGenerateTroubleshootingUriValue
Returns the unboxed value from getGenerateTroubleshootingUri()
Whether to generate a troubleshooting URL on access denied events to this application.
| Returns | |
|---|---|
| Type | Description |
bool|null | |
setGenerateTroubleshootingUri
Whether to generate a troubleshooting URL on access denied events to this application.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setGenerateTroubleshootingUriValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Whether to generate a troubleshooting URL on access denied events to this application.
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRemediationTokenGenerationEnabled
Whether to generate remediation token on access denied events to this application.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue|null | |
hasRemediationTokenGenerationEnabled
clearRemediationTokenGenerationEnabled
getRemediationTokenGenerationEnabledValue
Returns the unboxed value from getRemediationTokenGenerationEnabled()
Whether to generate remediation token on access denied events to this application.
| Returns | |
|---|---|
| Type | Description |
bool|null | |
setRemediationTokenGenerationEnabled
Whether to generate remediation token on access denied events to this application.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setRemediationTokenGenerationEnabledValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Whether to generate remediation token on access denied events to this application.
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |