verifiedpermissions/aws.sdk.kotlin.services.verifiedpermissions.model/ContextDefinition

ContextDefinition

Contains additional details about the context of the request. Verified Permissions evaluates this information in an authorization request as part of the when and unless clauses in a policy.

This data type is used as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

Example: "context":{"contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}}

Inheritors

ContextMap

SdkUnknown

Types

ContextMap

data class ContextMap(val value: Map<String, AttributeValue>) : ContextDefinition

An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

SdkUnknown

object SdkUnknown : ContextDefinition

Functions

asContextMap

fun asContextMap(): Map<String, AttributeValue>

Casts this ContextDefinition as a ContextMap and retrieves its Map value. Throws an exception if the ContextDefinition is not a ContextMap.

asContextMapOrNull

fun asContextMapOrNull(): Map<String, AttributeValue>?

Casts this ContextDefinition as a ContextMap and retrieves its Map value. Returns null if the ContextDefinition is not a ContextMap.