AuthenticationPolicy¶
- class oci.apigateway.models.AuthenticationPolicy(**kwargs)¶
Bases:
objectInformation on how to authenticate incoming requests.
Attributes:
A constant which can be used with the type property of a AuthenticationPolicy.
A constant which can be used with the type property of a AuthenticationPolicy.
A constant which can be used with the type property of a AuthenticationPolicy.
Gets the is_anonymous_access_allowed of this AuthenticationPolicy.
[Required] Gets the type of this AuthenticationPolicy.
Methods:
__init__(**kwargs)Initializes a new AuthenticationPolicy 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.
- TYPE_CUSTOM_AUTHENTICATION = 'CUSTOM_AUTHENTICATION'¶
A constant which can be used with the type property of a AuthenticationPolicy. This constant has a value of “CUSTOM_AUTHENTICATION”
- TYPE_JWT_AUTHENTICATION = 'JWT_AUTHENTICATION'¶
A constant which can be used with the type property of a AuthenticationPolicy. This constant has a value of “JWT_AUTHENTICATION”
- TYPE_TOKEN_AUTHENTICATION = 'TOKEN_AUTHENTICATION'¶
A constant which can be used with the type property of a AuthenticationPolicy. This constant has a value of “TOKEN_AUTHENTICATION”
- __init__(**kwargs)¶
Initializes a new AuthenticationPolicy object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
is_anonymous_access_allowed (bool) – The value to assign to the is_anonymous_access_allowed property of this AuthenticationPolicy.
type (str) – The value to assign to the type property of this AuthenticationPolicy. Allowed values for this property are: “CUSTOM_AUTHENTICATION”, “JWT_AUTHENTICATION”, “TOKEN_AUTHENTICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- 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.
- property is_anonymous_access_allowed¶
Gets the is_anonymous_access_allowed of this AuthenticationPolicy. Whether an unauthenticated user may access the API. Must be “true” to enable ANONYMOUS route authorization.
- Returns
The is_anonymous_access_allowed of this AuthenticationPolicy.
- Return type
bool
- property type¶
[Required] Gets the type of this AuthenticationPolicy. Type of the authentication policy to use.
Allowed values for this property are: “CUSTOM_AUTHENTICATION”, “JWT_AUTHENTICATION”, “TOKEN_AUTHENTICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The type of this AuthenticationPolicy.
- Return type
str