Policies
"Policies" in our accelerator product refers to the predefined rules and guidelines that govern the behavior and access control of users, objects, and resources within the system. These policies define the permissions, restrictions, and conditions that determine how users can interact with the platform and its components.
Policies Data Model
_id
ObjectId
System-generated unique identifier assigned to each role.
_createdAt
Date
System-generated timestamp that denotes the date and time when a policy was created.
_createdBy
String
System-generated field that indicates the account who created.
_modifiedAt
Date
System-generated generated timestamp that denotes the date and time when a policy was modified.
_modifiedBy
String
System-generated field that indicates the account who modified.
name
String
Represents the name of the policy in the system.
label
String
Represents the label of the policy in the system.
description
String
Represents the description of the policy in the system.
version
String
Represents the version of the policy in the system.
type
String
Represents the type of the policy in the system. Currently we have a "ObjectControl" type in the system.
org
String
Represents the organization associated with the policy in the system.
object
String
Represents the role/object associated with the policy in the system.
fields
ObjectArray
Represents the definition of all the columns associated with the policy in the system.
fields.read
Array
Represents the list of readable columns associated with the policy in the system.
fields.write
Array
Represents the list of writeable columns associated with the policy in the system.
condition
Object
Represents the list conditions associated with the policy in the system.
condition.stringEquals
Object
Represents the condition which will be applied to the policy in the system.
Example Policies
{
"_id":
{
"$oid":"64392c1d862be321e3598f63"
},
"_createdAt":
{
"$date":
{
"$numberLong":"1681468445347"
}
},
"_createdBy":"[email protected]",
"_modifiedAt":
{
"$date":
{
"$numberLong":"1681468445347"
}
},
"_modifiedBy":"[email protected]",
"name":"providerDataAccess",
"label":"Provider Data Access",
"description":null,
"version":"2023-01",
"type":"ObjectControl",
"org":"64392b37862be321e3598f58",
"object":"Providers",
"fields":
{
"read":"*",
"write":
[
"name",
"email"
]
},
"condition":
{
"stringEquals":
{
"email":"{{user.email}}"
}
}
}Sample request:
POST api/v1/CreatePolicy
{
"name": "PatientDataAccess",
"label": "Patient Data Access",
"description": "Policy to allow access to patient data",
"version": "2023-01",
"type": "ObjectControl",
"object": "Patient",
"fields": {
"read": "*",
"write": ["name", "address", "phone"]
},
"condition": {
"stringEquals": {
"email": "{{user.email}}"
}
}
}
^[a-zA-Z0-9_]*$POST //api/v1/CreatePolicy HTTP/1.1
Host: api-qa.accelerator-platform.com
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 197
{
"name": "text",
"label": "text",
"description": "text",
"version": "text",
"type": "text",
"object": "text",
"fields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"condition": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}No content
Last updated