RouteAuthorizationPolicy¶

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

Bases: object

If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.

Attributes

`TYPE_ANONYMOUS`	A constant which can be used with the type property of a RouteAuthorizationPolicy.
`TYPE_ANY_OF`	A constant which can be used with the type property of a RouteAuthorizationPolicy.
`TYPE_AUTHENTICATION_ONLY`	A constant which can be used with the type property of a RouteAuthorizationPolicy.
`type`	Gets the type of this RouteAuthorizationPolicy.

Methods

`__init__`(**kwargs)	Initializes a new RouteAuthorizationPolicy 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_ANONYMOUS = 'ANONYMOUS'¶: A constant which can be used with the type property of a RouteAuthorizationPolicy. This constant has a value of “ANONYMOUS”

TYPE_ANY_OF = 'ANY_OF'¶: A constant which can be used with the type property of a RouteAuthorizationPolicy. This constant has a value of “ANY_OF”

TYPE_AUTHENTICATION_ONLY = 'AUTHENTICATION_ONLY'¶: A constant which can be used with the type property of a RouteAuthorizationPolicy. This constant has a value of “AUTHENTICATION_ONLY”

__init__(**kwargs)¶

Initializes a new RouteAuthorizationPolicy 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:	type (str) – The value to assign to the type property of this RouteAuthorizationPolicy. Allowed values for this property are: “ANONYMOUS”, “ANY_OF”, “AUTHENTICATION_ONLY”, ‘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.

type¶

Gets the type of this RouteAuthorizationPolicy. Indicates how authorization should be applied. For a type of ANY_OF, an “allowedScope” property must also be specified. Otherwise, only a type is required. For a type of ANONYMOUS, an authenticated API must have the “isAnonymousAccessAllowed” property set to “true” in the authentication policy.

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

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