AnyOfRouteAuthorizationPolicy¶

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

Bases: oci.apigateway.models.route_authorization_policy.RouteAuthorizationPolicy

If authentication has been performed, validate whether the request scope (if any) applies to this route.

Attributes

`TYPE_ANONYMOUS`	str(object=’’) -> str
`TYPE_ANY_OF`	str(object=’’) -> str
`TYPE_AUTHENTICATION_ONLY`	str(object=’’) -> str
`allowed_scope`	[Required] Gets the allowed_scope of this AnyOfRouteAuthorizationPolicy.
`type`	Gets the type of this RouteAuthorizationPolicy.

Methods

`__init__`(**kwargs)	Initializes a new AnyOfRouteAuthorizationPolicy 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'¶

TYPE_ANY_OF = 'ANY_OF'¶

TYPE_AUTHENTICATION_ONLY = 'AUTHENTICATION_ONLY'¶

__init__(**kwargs)¶

Initializes a new AnyOfRouteAuthorizationPolicy object with values from keyword arguments. The default value of the type attribute of this class is ANY_OF 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 AnyOfRouteAuthorizationPolicy. Allowed values for this property are: “ANONYMOUS”, “ANY_OF”, “AUTHENTICATION_ONLY” allowed_scope (list[str]) – The value to assign to the allowed_scope property of this AnyOfRouteAuthorizationPolicy.

allowed_scope¶

[Required] Gets the allowed_scope of this AnyOfRouteAuthorizationPolicy. A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.

Returns:	The allowed_scope of this AnyOfRouteAuthorizationPolicy.
Return type:	list[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.

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