Overview

A policy is a set of privileges designed for a specific user role, often encompassing multiple privileges and other policies. Effective policy design and usage enable role-based access control.

Showing Policies

To list all policies of the database:

show().policy()

Or retrieves a specific policy, such as the one named manager:

show().policy("manager")

It returns a table _policy with the following fields:

Creating a Policy

The create().policy().params() statement creates a policy for the database.

Syntax

create().policy("<name>").params({
  graph_privileges: {
    "<graph>": ["<graphPriv>", "<graphPriv>", ...],
    ...
  }, 
  system_privileges: ["<systemPriv>", "<systemPriv>", ...], 
  property_privileges: {
    "node": {
      "<propertyPriv>": [
        ["<graph>", "<schema>", "<property>"],
        ...
      ],
      ...
    },
    "edge": {
      "<propertyPriv>": [
        ["<graph>", "<schema>", "<property>"],
        ...
      ],
      ...
    }
  },
  policies: ["<policyName>", "<policyName>", ...]
})

Examples

To create a policy called superADM, including all graph and system privileges, and write privilege for all properties, it doesn't include any other policies:

create().policy("superADM").params({
  graph_privileges: {"*":["READ","INSERT","UPSERT","UPDATE","DELETE","CREATE_SCHEMA","DROP_SCHEMA","ALTER_SCHEMA","SHOW_SCHEMA","RELOAD_SCHEMA","CREATE_PROPERTY","DROP_PROPERTY","ALTER_PROPERTY","SHOW_PROPERTY","CREATE_FULLTEXT","DROP_FULLTEXT","SHOW_FULLTEXT","CREATE_INDEX","DROP_INDEX","SHOW_INDEX","LTE","UFE","CLEAR_JOB","STOP_JOB","SHOW_JOB","ALGO","CREATE_PROJECT","SHOW_PROJECT","DROP_PROJECT","CREATE_HDC_GRAPH","SHOW_HDC_GRAPH","DROP_HDC_GRAPH","COMPACT_HDC_GRAPH","SHOW_VECTOR_INDEX","CREATE_VECTOR_INDEX","DROP_VECTOR_INDEX","SHOW_CONSTRAINT","CREATE_CONSTRAINT","DROP_CONSTRAINT"]},
  system_privileges: ["TRUNCATE","COMPACT","CREATE_GRAPH","SHOW_GRAPH","DROP_GRAPH","ALTER_GRAPH","TOP","KILL","STAT","SHOW_POLICY","CREATE_POLICY","DROP_POLICY","ALTER_POLICY","SHOW_USER","CREATE_USER","DROP_USER","ALTER_USER","SHOW_PRIVILEGE","SHOW_META","SHOW_SHARD","ADD_SHARD","DELETE_SHARD","REPLACE_SHARD","SHOW_HDC_SERVER","ADD_HDC_SERVER","DELETE_HDC_SERVER","LICENSE_UPDATE","LICENSE_DUMP","GRANT","REVOKE","SHOW_BACKUP","CREATE_BACKUP","SHOW_VECTOR_SERVER","ADD_VECTOR_SERVER","DELETE_VECTOR_SERVER"],
  property_privileges: {
    "node": {"write": [["*", "*", "*"]]},
    "edge": {"write": [["*", "*", "*"]]}
  }
})

To create a policy called Tester that includes:

• Graph privileges: UPDATE for all graphsets
• System privileges: SHOW_POLICY, ALTER_GRAPH
• Property privileges:
  • Node properties: read all node properties
  • Edge properties:
    • write edge properties value and time in the graphset Tax
    • deny (Do not allow read and write) edge property score of the schema rate in the graphset miniCircle
• Policies: manager

create().policy("Tester").params({
  graph_privileges: {"*": ["UPDATE"]}, 
  system_privileges: ["SHOW_POLICY", "ALTER_GRAPH"],
  property_privileges: {
    "node": {
      "read": [
        ["*", "*", "*"]
      ]
    },
    "edge": {
      "write": [
        ["Tax", "*", "value"],
        ["Tax", "*", "time"]
      ],
      "deny": [
        ["miniCircle", "rates", "score"]
      ]
    }
  },
  policies: ["manager"]
})

Altering a Policy

You can alter the privileges and policies included in a policy using the alter().policy().set() statement. Note that only the mentioned items will be updated, others remain unchanged.

Syntax

alter().policy("<name>").set({
  graph_privileges: {
    "<graph>": ["<graphPriv>", "<graphPriv>", ...],
    ...
  }, 
  system_privileges: ["<systemPriv>", "<systemPriv>", ...], 
  property_privileges: {
    "node": {
      "<propertyPriv>": [
        ["<graph>", "<schema>", "<property>"],
        ...
      ],
      ...
    },
    "edge": {
      "<propertyPriv>": [
        ["<graph>", "<schema>", "<property>"],
        ...
      ],
      ...
    }
  },
  policies: ["<policyName>", "<policyName>", ...]
})

Examples

To modify graph privileges included in the policy sales while keeping privilege types and policies unchanged:

alter().policy("Tester").set({graph_privileges: {"Tax": ["UPDATE"]}})

To modify the graph and property privileges, and policies included in the policy manager while keeping the system privileges unchanged:

alter().policy("manager").set({
  graph_privileges: {"*": ["UPDATE", "DELETE"]},
  property_privileges: {
    "node": {
      "write": [["miniCircle","*","*"]]
    },
    "edge": {
      "write": [["miniCircle","*","*"]]
    }
  },
  policies: ["sales"]
})

Granting to a Policy

You can grant additional privileges and policies to a policy using the grant().policy().params() statement. Note that the existing privileges and policies involved in the policy remain unchanged.

Syntax

grant().policy("<policyName>").params({
  graph_privileges: {
    "<graph>": ["<graphPriv>", "<graphPriv>", ...],
    ...
  }, 
  system_privileges: ["<systemPriv>", "<systemPriv>", ...], 
  property_privileges: {
    "node": {
      "<propertyPriv>": [
        ["<graph>", "<schema>", "<property>"],
        ...
      ],
      ...
    },
    "edge": {
      "<propertyPriv>": [
        ["<graph>", "<schema>", "<property>"],
        ...
      ],
      ...
    }
  },
  policies: ["<policyName>", "<policyName>", ...]
})

Examples

To grant the graph privileges CREATE_SCHEMA and DROP_SCHEMA of the graphset Tax, and system privilege ADD_HDC_SERVER to the policy manager:

grant().policy("manager").params({
  graph_privileges: {"Tax": ["CREATE_SCHEMA", "DROP_SCHEMA"]}, 
  system_privileges: ["ADD_HDC_SERVER"]
})

Revoking from a Policy

You can revoke specified privileges and policies from a policy using the revoke().policy().params() statement.

Syntax

revoke().policy("<policyName>").params({
  graph_privileges: {
    "<graph>": ["<graphPriv>", "<graphPriv>", ...],
    ...
  }, 
  system_privileges: ["<systemPriv>", "<systemPriv>", ...], 
  property_privileges: {
    "node": {
      "<propertyPriv>": [
        ["<graph>", "<schema>", "<property>"],
        ...
      ],
      ...
    },
    "edge": {
      "<propertyPriv>": [
        ["<graph>", "<schema>", "<property>"],
        ...
      ],
      ...
    }
  },
  policies: ["<policyName>", "<policyName>", ...]
})

Examples

To revoke the graph privileges CREATE_SCHEMA and DROP_SCHEMA of the graphset Tax, and system privilege ADD_HDC_SERVER from the policy manager:

revoke().policy("manager").params({
  graph_privileges: {"Tax": ["CREATE_SCHEMA", "DROP_SCHEMA"]}, 
  system_privileges: ["ADD_HDC_SERVER"]
})

Dropping a Policy

You can drop a policy using the drop().policy() statement.

To drop the policy manager:

drop().policy("manager")