RBAC API

واجهة برمجة تطبيقات أكثر ودية لـ RBAC. هذه الواجهة برمجة التطبيقات هي مجموعة فرعية من واجهة برمجة التطبيقات الإدارية. يمكن لمستخدمي RBAC استخدام هذه الواجهة برمجة التطبيقات لتبسيط الكود.

مرجع

المتغير العام e هو مثيل Enforcer.

Go

e, err := NewEnforcer("examples/rbac_model.conf", "examples/rbac_policy.csv")

Node.js

const e = await newEnforcer('examples/rbac_model.conf', 'examples/rbac_policy.csv')

PHP

$e = new Enforcer('examples/rbac_model.conf', 'examples/rbac_policy.csv');

Python

e = casbin.Enforcer("examples/rbac_model.conf", "examples/rbac_policy.csv")

.NET

var e = new Enforcer("path/to/model.conf", "path/to/policy.csv");

Rust

let mut e = Enforcer::new("examples/rbac_model.conf", "examples/rbac_policy.csv").await?;

Java

Enforcer e = new Enforcer("examples/rbac_model.conf", "examples/rbac_policy.csv");

GetRolesForUser()

GetRolesForUser يحصل على الأدوار التي يمتلكها المستخدم.

على سبيل المثال:

Go

res := e.GetRolesForUser("alice")

Node.js

const res = await e.getRolesForUser('alice')

PHP

$res = $e->getRolesForUser("alice");

Python

roles = e.get_roles_for_user("alice")

.NET

var res = e.GetRolesForUser("alice");

Rust

let roles = e.get_roles_for_user("alice", None); // No domain

Java

List<String> res = e.getRolesForUser("alice");

GetUsersForRole()

GetUsersForRole يحصل على المستخدمين الذين يمتلكون دورًا.

على سبيل المثال:

Go

res := e.GetUsersForRole("data1_admin")

Node.js

const res = await e.getUsersForRole('data1_admin')

PHP

$res = $e->getUsersForRole("data1_admin");

Python

users = e.get_users_for_role("data1_admin")

.NET

var res = e.GetUsersForRole("data1_admin");

Rust

let users = e.get_users_for_role("data1_admin", None); // No domain

Java

List<String> res = e.getUsersForRole("data1_admin");

HasRoleForUser()

HasRoleForUser يحدد ما إذا كان المستخدم يمتلك دورًا.

على سبيل المثال:

Go

res := e.HasRoleForUser("alice", "data1_admin")

Node.js

const res = await e.hasRoleForUser('alice', 'data1_admin')

PHP

$res = $e->hasRoleForUser("alice", "data1_admin");

Python

has = e.has_role_for_user("alice", "data1_admin")

.NET

var res = e.HasRoleForUser("alice", "data1_admin");

Rust

let has = e.has_role_for_user("alice", "data1_admin", None); // No domain

Java

boolean res = e.hasRoleForUser("alice", "data1_admin");

AddRoleForUser()

AddRoleForUser تضيف دورًا للمستخدم. ترجع خطأ إذا كان المستخدم يمتلك الدور بالفعل (أي لم يتأثر).

على سبيل المثال:

Go

e.AddRoleForUser("alice", "data2_admin")

Node.js

await e.addRoleForUser('alice', 'data2_admin')

PHP

$e->addRoleForUser("alice", "data2_admin");

Python

e.add_role_for_user("alice", "data2_admin")

.NET

var added = e.AddRoleForUser("alice", "data2_admin");
or
var added = await e.AddRoleForUserAsync("alice", "data2_admin");

Rust

let added = e.add_role_for_user("alice", "data2_admin", None).await?; // No domain

Java

boolean added = e.addRoleForUser("alice", "data2_admin");

AddRolesForUser()

AddRolesForUser تضيف أدواراً متعددة للمستخدم. ترجع خطأ إذا كان المستخدم يمتلك أحد هذه الأدوار بالفعل (أي لم يتأثر).

على سبيل المثال:

Go

var roles = []string{"data2_admin", "data1_admin"}
e.AddRolesForUser("alice", roles)

Node.js

const roles = ["data1_admin", "data2_admin"];
roles.map((role) => e.addRoleForUser("alice", role));

Rust

let roles = vec!["data1_admin".to_owned(), "data2_admin".to_owned()];
let all_added = e.add_roles_for_user("alice", roles, None).await?; // No domain

DeleteRoleForUser()

DeleteRoleForUser تحذف دورًا للمستخدم. ترجع خطأ إذا لم يمتلك المستخدم الدور (أي لم يتأثر).

على سبيل المثال:

Go

e.DeleteRoleForUser("alice", "data1_admin")

Node.js

await e.deleteRoleForUser('alice', 'data1_admin')

PHP

$e->deleteRoleForUser("alice", "data1_admin");

Python

e.delete_role_for_user("alice", "data1_admin")

.NET

var deleted = e.DeleteRoleForUser("alice", "data1_admin");
or
var deleted = await e.DeleteRoleForUser("alice", "data1_admin");

Rust

let deleted = e.delete_role_for_user("alice", "data1_admin", None).await?; // No domain

Java

boolean deleted = e.deleteRoleForUser("alice", "data1_admin");

DeleteRolesForUser()

تقوم DeleteRolesForUser بحذف جميع الأدوار لمستخدم ما. تُرجع قيمة خاطئة إذا لم يكن لدى المستخدم أي أدوار (أي لم يتأثر).

على سبيل المثال:

Go

e.DeleteRolesForUser("alice")

Node.js

await e.deleteRolesForUser('alice')

PHP

$e->deleteRolesForUser("alice");

Python

e.delete_roles_for_user("alice")

.NET

var deletedAtLeastOne = e.DeleteRolesForUser("alice");
or
var deletedAtLeastOne = await e.DeleteRolesForUserAsync("alice");

Rust

let deleted_at_least_one = e.delete_roles_for_user("alice", None).await?; // No domain

Java

boolean deletedAtLeastOne = e.deleteRolesForUser("alice");

DeleteUser()

تقوم DeleteUser بحذف مستخدم. تُرجع قيمة خاطئة إذا لم يكن المستخدم موجودًا (أي لم يتأثر).

على سبيل المثال:

Go

e.DeleteUser("alice")

Node.js

await e.deleteUser('alice')

PHP

$e->deleteUser("alice");

Python

e.delete_user("alice")

.NET

var deleted = e.DeleteUser("alice");
or
var deleted = await e.DeleteUserAsync("alice");

Rust

let deleted = e.delete_user("alice").await?;

Java

boolean deleted = e.deleteUser("alice");

DeleteRole()

DeleteRole يحذف دورًا.

على سبيل المثال:

Go

e.DeleteRole("data2_admin")

Node.js

await e.deleteRole("data2_admin")

PHP

$e->deleteRole("data2_admin");

Python

e.delete_role("data2_admin")

.NET

var deleted = e.DeleteRole("data2_admin");
or
var deleted = await e.DeleteRoleAsync("data2_admin");

Rust

let deleted = e.delete_role("data2_admin").await?;

Java

e.deleteRole("data2_admin");

DeletePermission()

DeletePermission يحذف إذنًا. يعيد خطأ إذا لم يكن الإذن موجودًا (أي لم يتأثر).

على سبيل المثال:

Go

e.DeletePermission("read")

Node.js

await e.deletePermission('read')

PHP

$e->deletePermission("read");

Python

e.delete_permission("read")

.NET

var deleted = e.DeletePermission("read");
or
var deleted = await e.DeletePermissionAsync("read");

Rust

let deleted = e.delete_permission(vec!["read".to_owned()]).await?;

Java

boolean deleted = e.deletePermission("read");

AddPermissionForUser()

AddPermissionForUser يضيف إذنًا لمستخدم أو دور. يعيد خطأ إذا كان المستخدم أو الدور يمتلكون الإذن بالفعل (أي لم يتأثر).

على سبيل المثال:

Go

e.AddPermissionForUser("bob", "read")

Node.js

await e.addPermissionForUser('bob', 'read')

PHP

$e->addPermissionForUser("bob", "read");

Python

e.add_permission_for_user("bob", "read")

.NET

var added = e.AddPermissionForUser("bob", "read");
or
var added = await e.AddPermissionForUserAsync("bob", "read");

Rust

let added = e.add_permission_for_user("bob", vec!["read".to_owned()]).await?;

Java

boolean added = e.addPermissionForUser("bob", "read");

AddPermissionsForUser()

تضيف إضافةصلاحياتللمستخدم عدة صلاحيات لمستخدم أو دور. ترجع كاذبة إذا كان المستخدم أو الدور يمتلك بالفعل إحدى الصلاحيات (أي لم يتأثر).

على سبيل المثال:

Go

var permissions = [][]string{{"data1", "read"},{"data2","write"}}
for i := 0; i < len(permissions); i++ {
    e.AddPermissionsForUser("alice", permissions[i])
}

Node.js

const permissions = [
    ["data1", "read"],
    ["data2", "write"],
];

permissions.map((permission) => e.addPermissionForUser("bob", ...permission));

Rust

let permissions = vec![
    vec!["data1".to_owned(), "read".to_owned()],
    vec!["data2".to_owned(), "write".to_owned()],
];

let all_added = e.add_permissions_for_user("bob", permissions).await?;

DeletePermissionForUser()

تحذف حذفصلاحيةللمستخدم صلاحية لمستخدم أو دور. ترجع كاذبة إذا لم يمتلك المستخدم أو الدور الصلاحية (أي لم يتأثر).

على سبيل المثال:

Go

e.DeletePermissionForUser("bob", "read")

Node.js

await e.deletePermissionForUser("bob", "read")

PHP

$e->deletePermissionForUser("bob", "read");

Python

e.delete_permission_for_user("bob", "read")

.NET

var deleted = e.DeletePermissionForUser("bob", "read");
or
var deleted = await e.DeletePermissionForUserAsync("bob", "read");

Rust

let deleted = e.delete_permission_for_user("bob", vec!["read".to_owned()]).await?;

Java

boolean deleted = e.deletePermissionForUser("bob", "read");

DeletePermissionsForUser()

تحذف حذفصلاحياتللمستخدم صلاحيات لمستخدم أو دور. يُرجع خطأ إذا لم يكن للمستخدم أو الدور أي صلاحيات (أي غير متأثر).

على سبيل المثال:

Go

e.DeletePermissionsForUser("bob")

Node.js

await e.deletePermissionsForUser('bob')

PHP

$e->deletePermissionsForUser("bob");

Python

e.delete_permissions_for_user("bob")

.NET

var deletedAtLeastOne = e.DeletePermissionsForUser("bob");
or
var deletedAtLeastOne = await e.DeletePermissionsForUserAsync("bob");

Rust

let deleted_at_least_one = e.delete_permissions_for_user("bob").await?;

Java

boolean deletedAtLeastOne = e.deletePermissionForUser("bob");

GetPermissionsForUser()

تحصل GetPermissionsForUser على الصلاحيات لمستخدم أو دور.

على سبيل المثال:

Go

e.GetPermissionsForUser("bob")

Node.js

await e.getPermissionsForUser('bob')

PHP

$e->getPermissionsForUser("bob");

Python

e.get_permissions_for_user("bob")

.NET

var permissions = e.GetPermissionsForUser("bob");

Java

List<List<String>> permissions = e.getPermissionsForUser("bob");

HasPermissionForUser()

تحدد HasPermissionForUser ما إذا كان للمستخدم صلاحية.

على سبيل المثال:

Go

e.HasPermissionForUser("alice", []string{"read"})

Node.js

await e.hasPermissionForUser('alice', 'read')

PHP

$e->hasPermissionForUser("alice", []string{"read"});

Python

has = e.has_permission_for_user("alice", "read")

.NET

var has = e.HasPermissionForUser("bob", "read");

Rust

let has = e.has_permission_for_user("alice", vec!["data1".to_owned(), "read".to_owned()]);

Java

boolean has = e.hasPermissionForUser("alice", "read");

GetImplicitRolesForUser()

تحصل GetImplicitRolesForUser على الأدوار الضمنية التي يمتلكها المستخدم. مقارنة بـ GetRolesForUser()، تسترجع هذه الوظيفة الأدوار الغير مباشرة بالإضافة إلى الأدوار المباشرة.

على سبيل المثال:

g, alice, role:admin  
g, role:admin, role:user  

GetRolesForUser("alice") يمكنه فقط الحصول على: ["role:admin"].\ لكن GetImplicitRolesForUser("alice") سيحصل على: ["role:admin", "role:user"].

على سبيل المثال:

Go

e.GetImplicitRolesForUser("alice")

Node.js

await e.getImplicitRolesForUser("alice")

PHP

$e->getImplicitRolesForUser("alice");

Python

e.get_implicit_roles_for_user("alice")

.NET

var implicitRoles = e.GetImplicitRolesForUser("alice");

Rust

e.get_implicit_roles_for_user("alice", None); // No domain

Java

List<String> implicitRoles = e.getImplicitRolesForUser("alice");

GetImplicitUsersForRole()

GetImplicitUsersForRole تحصل على جميع المستخدمين الذين يرثون الدور. مقارنة بـ GetUsersForRole()، تسترجع هذه الوظيفة المستخدمين غير المباشرين.

على سبيل المثال:

g, alice, role:admin  
g, role:admin, role:user  

GetUsersForRole("role:user") يمكنه فقط الحصول على: ["role:admin"].\ لكن GetImplicitUesrsForRole("role:user") سيحصل على: ["role:admin", "alice"].

على سبيل المثال:

Go

users := e.GetImplicitUsersForRole("role:user")

Node.js

const users = e.getImplicitUsersForRole("role:user");

Java

List<String> users = e.getImplicitUsersForRole("role:user");

GetImplicitPermissionsForUser()

GetImplicitPermissionsForUser يحصل على الصلاحيات الضمنية لمستخدم أو دور.\ مقارنة بـ GetPermissionsForUser()، تسترجع هذه الوظيفة الصلاحيات للأدوار الموروثة.

على سبيل المثال:

p, admin, data1, read  
p, alice, data2, read  
g, alice, admin 

GetPermissionsForUser("alice") يمكنه فقط الحصول على: [["alice", "data2", "read"]].\ لكن GetImplicitPermissionsForUser("alice") سيحصل على: [["admin", "data1", "read"], ["alice", "data2", "read"]].

على سبيل المثال:

Go

e.GetImplicitPermissionsForUser("alice")

Node.js

await e.getImplicitPermissionsForUser("alice")

PHP

$e->getImplicitPermissionsForUser("alice");

Python

e.get_implicit_permissions_for_user("alice")

.NET

var implicitPermissions = e.GetImplicitPermissionsForUser("alice");

Rust

e.get_implicit_permissions_for_user("alice", None); // No domain

Java

List<List<String>> implicitPermissions = e.getImplicitPermissionsForUser("alice");

GetNamedImplicitPermissionsForUser()

GetNamedImplicitPermissionsForUser تحصل على الصلاحيات الضمنية لمستخدم أو دور بواسطة سياسة مسماة

على سبيل المثال:

p, admin, data1, read
p2, admin, create
g, alice, admin

GetImplicitPermissionsForUser("alice") يحصل فقط على: [["admin", "data1", "read"]]، والتي تكون سياستها الافتراضية "p"

لكن يمكنك تحديد السياسة على أنها "p2" للحصول على: [["admin", "create"]] بواسطة GetNamedImplicitPermissionsForUser("p2","alice")

على سبيل المثال:

Go

e.GetNamedImplicitPermissionsForUser("p2","alice")

Python

e.get_named_implicit_permissions_for_user("p2", "alice")

GetDomainsForUser()

GetDomainsForUser تحصل على جميع المجالات التي يمتلكها المستخدم.

على سبيل المثال:

p, admin, domain1, data1, read
p, admin, domain2, data2, read
p, admin, domain2, data2, write
g, alice, admin, domain1
g, alice, admin, domain2

GetDomainsForUser("alice") يمكن أن يحصل على ["domain1", "domain2"]

على سبيل المثال:

Go

result, err := e.GetDomainsForUser("alice")

GetImplicitResourcesForUser()

تُرجع GetImplicitResourcesForUser جميع السياسات التي يجب أن تكون صحيحة للمستخدم.

على سبيل المثال:

p, alice, data1, read
p, bob, data2, write
p, data2_admin, data2, read
p, data2_admin, data2, write

g, alice, data2_admin

GetImplicitResourcesForUser("alice") ستُرجع

Go

resources, err := e.GetImplicitResourcesForUser("alice")

GetImplicitUsersForPermission()

تحصل GetImplicitUsersForPermission على المستخدمين الضمنيين لإذن معين.

على سبيل المثال:

p, admin, data1, read
p, bob, data1, read
g, alice, admin

GetImplicitUsersForPermission("data1", "read") ستُرجع: ["alice", "bob"].

ملاحظة: سيتم إرجاع المستخدمين فقط، والأدوار (الوسيط الثاني في "g") سيتم استبعادها.

Go

users, err := e.GetImplicitUsersForPermission("data1", "read")

GetAllowedObjectConditions()

GetAllowedObjectConditions تُرجع مصفوفة نصية من شروط الكائنات التي يمكن للمستخدم الوصول إليها.

على سبيل المثال:

p, alice, r.obj.price < 25, read
p, admin, r.obj.category_id = 2, read
p, bob, r.obj.author = bob, write

g, alice, admin

e.GetAllowedObjectConditions("alice", "read", "r.obj.") سيُرجع ["price < 25", "category_id = 2"], nil

ملاحظة:

0. البادئة: يمكنك تخصيص البادئة لشروط الكائنات، و"r.obj." يُستخدم بشكل شائع كبادئة. بعد إزالة البادئة، الجزء المتبقي هو شرط الكائن. إذا كان هناك سياسة كائن لا تلبي متطلبات البادئة، سيتم إرجاع errors.ERR_OBJ_CONDITION.

1. إذا كانت مصفوفة 'objectConditions' فارغة، أرجع errors.ERR_EMPTY_CONDITION

Go

conditions, err := e.GetAllowedObjectConditions("alice", "read", "r.obj.")

GetImplicitUsersForResource()

تُرجع GetImplicitUsersForResource المستخدمين الضمنيين بناءً على المورد.

على سبيل المثال:

p, alice, data1, read
p, bob, data2, write
p, data2_admin, data2, read
p, data2_admin, data2, write
g, alice, data2_admin

ستُرجع GetImplicitUsersForResource("data2") [["bob", "data2", "write"], ["alice", "data2", "read"] ["alice", "data2", "write"]], nil.

ستُرجع GetImplicitUsersForResource("data1") [["alice", "data1", "read"]], nil.

Go

ImplicitUsers, err := e.GetImplicitUsersForResource("data2")

ملاحظة

سيتم إرجاع المستخدمين فقط، وسيتم استبعاد الأدوار (الوسيط الثاني في "g").