Class: Aws::VerifiedPermissions::Types::EntitiesDefinition

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb

Overview

Note:

EntitiesDefinition is a union - when making an API calls you must set exactly one of the members.

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.

See Also:

Direct Known Subclasses

CedarJson, EntityList, Unknown

Defined Under Namespace

Classes: CedarJson, EntityList, Unknown

Constant Summary collapse

SENSITIVE = 
[:cedar_json]

Instance Attribute Summary collapse

Instance Attribute Details

#cedar_json ⇒ String

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

Example: {"cedarJson": "[{"uid":{"type":"Photo","id":"VacationPhoto94.jpg"},"attrs":{"accessLevel":"public"},"parents":[]}]"}

Returns:

  • (String) 


1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 1758

class EntitiesDefinition < Struct.new(
  :entity_list,
  :cedar_json,
  :unknown)
  SENSITIVE = [:cedar_json]
  include Aws::Structure
  include Aws::Structure::Union

  class EntityList < EntitiesDefinition; end
  class CedarJson < EntitiesDefinition; end
  class Unknown < EntitiesDefinition; end
end

#entity_list ⇒ Array<Types::EntityItem>

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.

If you include multiple entities with the same identifier, only the last one is processed in the request.

Returns:



1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 1758

class EntitiesDefinition < Struct.new(
  :entity_list,
  :cedar_json,
  :unknown)
  SENSITIVE = [:cedar_json]
  include Aws::Structure
  include Aws::Structure::Union

  class EntityList < EntitiesDefinition; end
  class CedarJson < EntitiesDefinition; end
  class Unknown < EntitiesDefinition; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



1758
1759
1760
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 1758

def unknown
  @unknown
end