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

EntitiesDefinition

Contains the list of entities to be considered during an authorization request. This includes all principals, resources, and actions required to successfully evaluate the request.

This data type is used as a field in the response parameter for the IsAuthorized and IsAuthorizedWithToken operations.

Inheritors

CedarJson

EntityList

SdkUnknown

Types

CedarJson

data class CedarJson(val value: String) : EntitiesDefinition

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

EntityList

data class EntityList(val value: List<EntityItem>) : EntitiesDefinition

An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.

SdkUnknown

object SdkUnknown : EntitiesDefinition

Functions

asCedarJson

fun asCedarJson(): String

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

asCedarJsonOrNull

fun asCedarJsonOrNull(): String?

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

asEntityList

fun asEntityList(): List<EntityItem>

Casts this EntitiesDefinition as a EntityList and retrieves its kotlin.collections.List value. Throws an exception if the EntitiesDefinition is not a EntityList.

asEntityListOrNull

fun asEntityListOrNull(): List<EntityItem>?

Casts this EntitiesDefinition as a EntityList and retrieves its kotlin.collections.List value. Returns null if the EntitiesDefinition is not a EntityList.