Server : Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.4.20 System : Linux st2.domain.com 3.10.0-1127.10.1.el7.x86_64 #1 SMP Wed Jun 3 14:28:03 UTC 2020 x86_64 User : apache ( 48) PHP Version : 7.4.20 Disable Function : NONE Directory : /proc/self/root/usr/share/mysqlsh/oci_sdk/oci/apigateway/models/ |
# coding: utf-8
# Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
from .authentication_policy import AuthenticationPolicy
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class CustomAuthenticationPolicy(AuthenticationPolicy):
"""
Use a function to validate a custom header or query parameter sent with the request authentication.
A valid policy must specify either tokenHeader or tokenQueryParam.
"""
def __init__(self, **kwargs):
"""
Initializes a new CustomAuthenticationPolicy object with values from keyword arguments. The default value of the :py:attr:`~oci.apigateway.models.CustomAuthenticationPolicy.type` attribute
of this class is ``CUSTOM_AUTHENTICATION`` and it should not be changed.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param is_anonymous_access_allowed:
The value to assign to the is_anonymous_access_allowed property of this CustomAuthenticationPolicy.
:type is_anonymous_access_allowed: bool
:param type:
The value to assign to the type property of this CustomAuthenticationPolicy.
Allowed values for this property are: "CUSTOM_AUTHENTICATION"
:type type: str
:param function_id:
The value to assign to the function_id property of this CustomAuthenticationPolicy.
:type function_id: str
:param token_header:
The value to assign to the token_header property of this CustomAuthenticationPolicy.
:type token_header: str
:param token_query_param:
The value to assign to the token_query_param property of this CustomAuthenticationPolicy.
:type token_query_param: str
"""
self.swagger_types = {
'is_anonymous_access_allowed': 'bool',
'type': 'str',
'function_id': 'str',
'token_header': 'str',
'token_query_param': 'str'
}
self.attribute_map = {
'is_anonymous_access_allowed': 'isAnonymousAccessAllowed',
'type': 'type',
'function_id': 'functionId',
'token_header': 'tokenHeader',
'token_query_param': 'tokenQueryParam'
}
self._is_anonymous_access_allowed = None
self._type = None
self._function_id = None
self._token_header = None
self._token_query_param = None
self._type = 'CUSTOM_AUTHENTICATION'
@property
def function_id(self):
"""
**[Required]** Gets the function_id of this CustomAuthenticationPolicy.
The `OCID`__ of the Oracle Functions function resource.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The function_id of this CustomAuthenticationPolicy.
:rtype: str
"""
return self._function_id
@function_id.setter
def function_id(self, function_id):
"""
Sets the function_id of this CustomAuthenticationPolicy.
The `OCID`__ of the Oracle Functions function resource.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param function_id: The function_id of this CustomAuthenticationPolicy.
:type: str
"""
self._function_id = function_id
@property
def token_header(self):
"""
Gets the token_header of this CustomAuthenticationPolicy.
The name of the header containing the authentication token.
:return: The token_header of this CustomAuthenticationPolicy.
:rtype: str
"""
return self._token_header
@token_header.setter
def token_header(self, token_header):
"""
Sets the token_header of this CustomAuthenticationPolicy.
The name of the header containing the authentication token.
:param token_header: The token_header of this CustomAuthenticationPolicy.
:type: str
"""
self._token_header = token_header
@property
def token_query_param(self):
"""
Gets the token_query_param of this CustomAuthenticationPolicy.
The name of the query parameter containing the authentication token.
:return: The token_query_param of this CustomAuthenticationPolicy.
:rtype: str
"""
return self._token_query_param
@token_query_param.setter
def token_query_param(self, token_query_param):
"""
Sets the token_query_param of this CustomAuthenticationPolicy.
The name of the query parameter containing the authentication token.
:param token_query_param: The token_query_param of this CustomAuthenticationPolicy.
:type: str
"""
self._token_query_param = token_query_param
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other