OAuth2ResponseValidationFailurePolicy¶

class oci.apigateway.models.OAuth2ResponseValidationFailurePolicy(**kwargs)¶

Bases: oci.apigateway.models.validation_failure_policy.ValidationFailurePolicy

Policy to specify OAuth2 flow configuration.

Attributes

`RESPONSE_TYPE_CODE`	A constant which can be used with the response_type property of a OAuth2ResponseValidationFailurePolicy.
`TYPE_MODIFY_RESPONSE`	str(object=’’) -> str
`TYPE_OAUTH2`	str(object=’’) -> str
`client_details`	[Required] Gets the client_details of this OAuth2ResponseValidationFailurePolicy.
`fallback_redirect_path`	Gets the fallback_redirect_path of this OAuth2ResponseValidationFailurePolicy.
`logout_path`	Gets the logout_path of this OAuth2ResponseValidationFailurePolicy.
`max_expiry_duration_in_hours`	Gets the max_expiry_duration_in_hours of this OAuth2ResponseValidationFailurePolicy.
`response_type`	[Required] Gets the response_type of this OAuth2ResponseValidationFailurePolicy.
`scopes`	[Required] Gets the scopes of this OAuth2ResponseValidationFailurePolicy.
`source_uri_details`	[Required] Gets the source_uri_details of this OAuth2ResponseValidationFailurePolicy.
`type`	[Required] Gets the type of this ValidationFailurePolicy.
`use_cookies_for_intermediate_steps`	Gets the use_cookies_for_intermediate_steps of this OAuth2ResponseValidationFailurePolicy.
`use_cookies_for_session`	Gets the use_cookies_for_session of this OAuth2ResponseValidationFailurePolicy.
`use_pkce`	Gets the use_pkce of this OAuth2ResponseValidationFailurePolicy.

Methods

`__init__`(**kwargs)	Initializes a new OAuth2ResponseValidationFailurePolicy object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

RESPONSE_TYPE_CODE = 'CODE'¶: A constant which can be used with the response_type property of a OAuth2ResponseValidationFailurePolicy. This constant has a value of “CODE”

TYPE_MODIFY_RESPONSE = 'MODIFY_RESPONSE'¶

TYPE_OAUTH2 = 'OAUTH2'¶

__init__(**kwargs)¶

Initializes a new OAuth2ResponseValidationFailurePolicy object with values from keyword arguments. The default value of the type attribute of this class is OAUTH2 and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

type (str) – The value to assign to the type property of this OAuth2ResponseValidationFailurePolicy. Allowed values for this property are: “MODIFY_RESPONSE”, “OAUTH2”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
client_details (oci.apigateway.models.ClientAppDetails) – The value to assign to the client_details property of this OAuth2ResponseValidationFailurePolicy.
source_uri_details (oci.apigateway.models.SourceUriDetails) – The value to assign to the source_uri_details property of this OAuth2ResponseValidationFailurePolicy.
scopes (list[str]) – The value to assign to the scopes property of this OAuth2ResponseValidationFailurePolicy.
max_expiry_duration_in_hours (int) – The value to assign to the max_expiry_duration_in_hours property of this OAuth2ResponseValidationFailurePolicy.
use_cookies_for_session (bool) – The value to assign to the use_cookies_for_session property of this OAuth2ResponseValidationFailurePolicy.
use_cookies_for_intermediate_steps (bool) – The value to assign to the use_cookies_for_intermediate_steps property of this OAuth2ResponseValidationFailurePolicy.
use_pkce (bool) – The value to assign to the use_pkce property of this OAuth2ResponseValidationFailurePolicy.
response_type (str) – The value to assign to the response_type property of this OAuth2ResponseValidationFailurePolicy. Allowed values for this property are: “CODE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
fallback_redirect_path (str) – The value to assign to the fallback_redirect_path property of this OAuth2ResponseValidationFailurePolicy.
logout_path (str) – The value to assign to the logout_path property of this OAuth2ResponseValidationFailurePolicy.

client_details¶

[Required] Gets the client_details of this OAuth2ResponseValidationFailurePolicy.

Returns:	The client_details of this OAuth2ResponseValidationFailurePolicy.
Return type:	oci.apigateway.models.ClientAppDetails

fallback_redirect_path¶

Gets the fallback_redirect_path of this OAuth2ResponseValidationFailurePolicy. The path to be used as fallback after OAuth2.

Returns:	The fallback_redirect_path of this OAuth2ResponseValidationFailurePolicy.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

logout_path¶

Gets the logout_path of this OAuth2ResponseValidationFailurePolicy. The path to be used as logout.

Returns:	The logout_path of this OAuth2ResponseValidationFailurePolicy.
Return type:	str

max_expiry_duration_in_hours¶

Gets the max_expiry_duration_in_hours of this OAuth2ResponseValidationFailurePolicy. The duration for which the OAuth2 success token should be cached before it is fetched again.

Returns:	The max_expiry_duration_in_hours of this OAuth2ResponseValidationFailurePolicy.
Return type:	int

response_type¶

[Required] Gets the response_type of this OAuth2ResponseValidationFailurePolicy. Response Type.

Allowed values for this property are: “CODE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The response_type of this OAuth2ResponseValidationFailurePolicy.
Return type:	str

scopes¶

[Required] Gets the scopes of this OAuth2ResponseValidationFailurePolicy. List of scopes.

Returns:	The scopes of this OAuth2ResponseValidationFailurePolicy.
Return type:	list[str]

source_uri_details¶

[Required] Gets the source_uri_details of this OAuth2ResponseValidationFailurePolicy.

Returns:	The source_uri_details of this OAuth2ResponseValidationFailurePolicy.
Return type:	oci.apigateway.models.SourceUriDetails

type¶

[Required] Gets the type of this ValidationFailurePolicy. Type of the Validation failure Policy.

Allowed values for this property are: “MODIFY_RESPONSE”, “OAUTH2”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type of this ValidationFailurePolicy.
Return type:	str

use_cookies_for_intermediate_steps¶

Gets the use_cookies_for_intermediate_steps of this OAuth2ResponseValidationFailurePolicy. Defines whether or not to use cookies for OAuth2 intermediate steps.

Returns:	The use_cookies_for_intermediate_steps of this OAuth2ResponseValidationFailurePolicy.
Return type:	bool

use_cookies_for_session¶

Gets the use_cookies_for_session of this OAuth2ResponseValidationFailurePolicy. Defines whether or not to use cookies for session maintenance.

Returns:	The use_cookies_for_session of this OAuth2ResponseValidationFailurePolicy.
Return type:	bool

use_pkce¶

Gets the use_pkce of this OAuth2ResponseValidationFailurePolicy. Defines whether or not to support PKCE.

Returns:	The use_pkce of this OAuth2ResponseValidationFailurePolicy.
Return type:	bool