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.

If you're passing context as part of the request, exactly one instance of context must be passed. If you don't want to pass context, omit the context parameter from your request rather than sending context {}.

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

Inheritors

CedarJson

ContextMap

SdkUnknown

Types

CedarJson

data class CedarJson(val value: String) : ContextDefinition

A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.

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

asCedarJson

fun asCedarJson(): String

Casts this ContextDefinition as a CedarJson and retrieves its kotlin.String value. Throws an exception if the ContextDefinition is not a CedarJson.

asCedarJsonOrNull

fun asCedarJsonOrNull(): String?

Casts this ContextDefinition as a CedarJson and retrieves its kotlin.String value. Returns null if the ContextDefinition is not a CedarJson.

asContextMap

fun asContextMap(): Map<String, AttributeValue>

Casts this ContextDefinition as a ContextMap and retrieves its kotlin.collections.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 kotlin.collections.Map value. Returns null if the ContextDefinition is not a ContextMap.