Protected Optional _cedarProtected Optional _entityProtected Optional _isProtected Optional _policyProtected _policyProtected _policyProtected Optional _roleProtected schemaThe principal in the authorisation request. This is the actor and is typically a User.
The action in the authorisatiton request. This is the verb; what the principal wants to do to the resource.
The resource in the authorisation request. This is the entity being acted on.
This method is used to build the entity data object which will be sent to Verified Permissions
The complete entity data object formatted for Verified Permissions.
The Kosmos context.
The principal in the authorisation request. This is the actor and is typically a User.
The resource in the authorisation request. This is the entity being acted on.
The data included in the original request being handled.
The Kosmos connectToVertices object, which contains vertices that will be connected to.
The Kosmos DataSourceWrapper object.
This method is used to build the principal entity "attributes" object. Attributes can be "existing" (already exist in storage) or "new" (being added by the current request).
An entity attributes object.
The Kosmos context.
The principal object.
The Kosmos DataSourceWrapper object.
This method is used to build the principal's entity data object which will be sent to cedar
The principal's entity data object.
The Kosmos context.
The principal in the authorisation request. This is the actor and is typically a User.
The Kosmos DataSourceWrapper object.
This method is used to build the principal entity "parents" object.
An entity parents array.
The Kosmos context.
The principal object.
The Kosmos DataSourceWrapper object.
This method is used to build the resource entity "attributes" object. Attributes can be "existing" (already exist in storage) or "new" (being added by the current request).
An entity attributes object.
The Kosmos context.
The resource object.
The data included in the original request being handled.
The Kosmos connectToVertices object, which contains vertices that will be connected to.
The Kosmos DataSourceWrapper object.
This method is used to build the resource's entity data object which will be sent to cedar
The resource's entity data object.
The Kosmos context.
The resource in the authorisation request. This is the entity being acted on.
The data included in the original request being handled.
The Kosmos connectToVertices object, which contains vertices that will be connected to.
The Kosmos DataSourceWrapper object.
This method is used to get a principal's "existing" attributes from storage. Attributes can be "existing" (already exist in storage) or "new" (being added by the current request).
An entity attributes object containing "existing" attributes.
The Kosmos context.
The Kosmos DataSourceWrapper object.
This method is used to get a resource's "existing" attributes from storage. Attributes can be "existing" (already exist in storage) or "new" (being added by the current request).
An entity attributes object containing "existing" attributes.
The Kosmos context.
The Kosmos DataSourceWrapper object.
This method is used to get the full group hierarchy for a given entity.
an object containing a groupHierarcy array.
The Kosmos context.
The ID of the entity to get the group hierarchy for.
The Kosmos DataSourceWrapper object.
This method is used to get group memberships (including membership roles) for an entity.
an object containing group membership
The Kosmos context.
The ID of the entity to get group membership for.
The Kosmos DataSourceWrapper object.
This method is used to get a resource's "new" attributes. Attributes can be "existing" (already exist in storage) or "new" (being added by the current request).
An entity attributes object containing "new" attributes.
The Kosmos context.
The data included in the original request being handled.
The Kosmos connectToVertices object, which contains vertices that will be connected to.
The Kosmos DataSourceWrapper object.
This method is used to get global roles (not membership roles) for an entity.
an array of roles
The Kosmos context.
The ID of the entity to get roles for.
The Kosmos DataSourceWrapper object.
This method is used to run the cedar policy check.
Preloading entity data is required for cedar-agent. However, for AWS Verified permissions, entity data is included in a single authorisation request.
Cedar's authorisation result: returns true for 'ALLOW' and false for 'DENY'.
The principal in the authorisation request. This is the actor and is typically a User.
The action that the principal wants to perform on the resource.
The resource in the authorisation request. This is the entity being acted on.
The entity data object which includes additional info for the request such as principal/resource data.
This method compares the authorisation results from Cedar & Kosmos and logs a mismatch as an error.
The comparison result: either true for a match or false for a mismatch.
The decision from Cedar: true for 'Allow' and false for 'Deny'.
The decision from Kosmos: true for 'Allow' and false for 'Deny'.
Verified Permissions requires the entity data to be in a specific format which is different to cedar-agent. This function converts the cedar-agent entity data into the format required by Verified Permissions.
This method is used to authorise a create edge request using Cedar policies.
Cedar's authorisation result: returns true for 'Allow' and false for 'Deny'.
The Kosmos context.
The principal in the authorisation request. This is the actor and is typically a User.
The resource in the authorisation request. This is the edge entity being acted on.
The source vertex involved in the relationship being deleted.
The destination vertex involved in the relationship being deleted.
The edge property data included in the original request being handled.
The Kosmos DataSourceWrapper object.
This method is used to authorise a create request using Cedar policies.
Cedar's authorisation result: returns true for 'Allow' and false for 'Deny'.
The Kosmos context.
The principal in the authorisation request. This is the actor and is typically a User.
The resource in the authorisation request. This is the entity being acted on.
The data included in the original request being handled.
The Kosmos DataSourceWrapper object.
This method is used to authorise a delete edge request using Cedar policies.
Cedar's authorisation result: returns true for 'Allow' and false for 'Deny'.
The Kosmos context.
The principal in the authorisation request. This is the actor and is typically a User.
The resource in the authorisation request. This is the edge entity being acted on.
The source vertex involved in the relationship being deleted.
The destination vertex involved in the relationship being deleted.
The Kosmos DataSourceWrapper object.
The Kosmos connectToVertices array.
This method is used to authorise a delete request using Cedar policies.
Cedar's authorisation result: returns true for 'Allow' and false for 'Deny'.
The Kosmos context.
The principal in the authorisation request. This is the actor and is typically a User.
The resource in the authorisation request. This is the entity being acted on.
The Kosmos DataSourceWrapper object.
This method is used to authorise any custom actions outside of the standard CRUD on vertices and edges. E.g. the "UpdateSynonyms" action.
Cedar's authorisation result: returns true for 'Allow' and false for 'Deny'.
The Kosmos context.
The principal in the authorisation request. This is the actor and is typically a User.
The action that the principal wants to perform on the resource.
The resource in the authorisation request. This is the edge entity being acted on.
Any additional request data relevant to the authorisation decision.
The Kosmos DataSourceWrapper object.
This method is used to authorise a an update edge (properties) request using Cedar policies.
Cedar's authorisation result: returns true for 'Allow' and false for 'Deny'.
The Kosmos context.
The principal in the authorisation request. This is the actor and is typically a User.
The resource in the authorisation request. This is the edge entity being acted on.
The source vertex involved in the relationship being deleted.
The destination vertex involved in the relationship being deleted.
The edge property data included in the original request being handled.
The Kosmos DataSourceWrapper object.
This method is used to authorise an update request using Cedar policies.
Cedar's authorisation result: returns true for 'Allow' and false for 'Deny'.
The Kosmos context.
The principal in the authorisation request. This is the actor and is typically a User.
The resource in the authorisation request. This is the entity being acted on.
The data included in the original request being handled.
The Kosmos connectToVertices object, which contains vertices that will be connected to.
The Kosmos DataSourceWrapper object.
Generated using TypeDoc
This method builds and returns a Cedar query object.
Returns
a Cedar query object.