RBAC API

API yang lebih mesra untuk RBAC. API ini adalah subset dari API Pengurusan. Pengguna RBAC boleh menggunakan API ini untuk memudahkan kod.

Rujukan

pemboleh ubah global e adalah contoh 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 mendapat peranan yang dimiliki oleh pengguna.

Contohnya:

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 mendapat pengguna yang memiliki peranan.

Contohnya:

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 menentukan sama ada pengguna mempunyai peranan.

Contohnya:

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 menambah peranan untuk pengguna. Mengembalikan salah jika pengguna sudah mempunyai peranan tersebut (iaitu tidak terjejas).

Contohnya:

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 menambah pelbagai peranan untuk pengguna. Mengembalikan salah jika pengguna sudah memiliki salah satu peranan ini (alias tidak terpengaruh).

Contohnya:

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 menghapus peranan untuk pengguna. Mengembalikan salah jika pengguna tidak memiliki peranan tersebut (alias tidak terpengaruh).

Contohnya:

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 menghapus semua peranan untuk pengguna. Mengembalikan salah jika pengguna tidak memiliki peranan apa pun (alias tidak terpengaruh).

Contohnya:

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()

PadamPengguna memadamkan seorang pengguna. Mengembalikan salah jika pengguna tidak wujud (atau tidak terjejas).

Contohnya:

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()

PadamPeranan memadamkan peranan.

Contohnya:

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()

PadamKebenaran memadamkan kebenaran. Mengembalikan salah jika kebenaran tidak wujud (atau tidak terjejas).

Contohnya:

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()

TambahKebenaranUntukPengguna menambahkan kebenaran untuk pengguna atau peranan. Mengembalikan salah jika pengguna atau peranan sudah mempunyai kebenaran tersebut (iaitu tidak terjejas).

Contohnya:

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()

TambahKebenaranBanyakUntukPengguna menambahkan beberapa kebenaran untuk pengguna atau peranan. Mengembalikan salah jika pengguna atau peranan sudah mempunyai salah satu daripada kebenaran tersebut (iaitu tidak terjejas).

Contohnya:

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()

DeletePermissionForUser memadamkan kebenaran untuk pengguna atau peranan. Mengembalikan salah jika pengguna atau peranan tidak mempunyai kebenaran (aka tidak terjejas).

Contohnya:

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()

DeletePermissionsForUser memadamkan kebenaran untuk pengguna atau peranan. Mengembalikan salah jika pengguna atau peranan tidak mempunyai sebarang kebenaran (aka tidak terjejas).

Contohnya:

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 mendapatkan kebenaran untuk pengguna atau peranan.

Contohnya:

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 menentukan sama ada pengguna mempunyai kebenaran.

Contohnya:

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 mendapatkan peranan tersirat yang dimiliki oleh pengguna. Berbanding dengan GetRolesForUser(), fungsi ini mengambil peranan tidak langsung selain peranan langsung.

Contohnya:

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

GetRolesForUser("alice") hanya boleh mendapatkan: ["role:admin"].\ Tetapi GetImplicitRolesForUser("alice") akan mendapat: ["role:admin", "role:user"].

Contohnya:

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()

DapatkanPenggunaTersiratUntukPeranan mendapat semua pengguna yang mewarisi peranan tersebut. Berbanding dengan DapatkanPenggunaUntukPeranan(), fungsi ini mengambil pengguna tidak langsung.

Contohnya:

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

DapatkanPenggunaUntukPeranan("peranan:pengguna") hanya boleh mendapat: ["peranan:admin"].\ Tetapi DapatkanPenggunaTersiratUntukPeranan("peranan:pengguna") akan mendapat: ["peranan:admin", "alice"].

Contohnya:

Go

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

Node.js

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

Java

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

GetImplicitPermissionsForUser()

DapatkanKebenaranTersiratUntukPengguna mendapat kebenaran tersirat untuk pengguna atau peranan.\ Berbanding dengan DapatkanKebenaranUntukPengguna(), fungsi ini mengambil kebenaran untuk peranan yang diwarisi.

Contohnya:

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

GetPermissionsForUser("alice") hanya boleh mendapatkan: [["alice", "data2", "read"]].\ Tetapi GetImplicitPermissionsForUser("alice") akan mendapat: [["admin", "data1", "read"], ["alice", "data2", "read"]].

Contohnya:

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 mendapatkan kebenaran tersirat untuk pengguna atau peranan berdasarkan dasar bernama

Contohnya:

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

GetImplicitPermissionsForUser("alice") hanya mendapat: [["admin", "data1", "read"]], yang dasarnya adalah lalai "p"

Tetapi anda boleh menentukan dasar sebagai "p2" untuk mendapatkan: [["admin", "create"]] melalui GetNamedImplicitPermissionsForUser("p2","alice")

Contohnya:

Go

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

Python

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

GetDomainsForUser()

GetDomainsForUser mendapatkan semua domain yang dimiliki oleh pengguna.

Contohnya:

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") boleh mendapatkan ["domain1", "domain2"]

Contohnya:

Go

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

GetImplicitResourcesForUser()

GetImplicitResourcesForUser mengembalikan semua polisi yang sepatutnya benar untuk pengguna.

Contohnya:

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

g, alice, data2_admin

GetImplicitResourcesForUser("alice") akan mengembalikan

Go

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

GetImplicitUsersForPermission()

GetImplicitUsersForPermission mendapatkan pengguna tidak langsung untuk suatu kebenaran.

Contohnya:

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

GetImplicitUsersForPermission("data1", "read") akan mengembalikan: ["alice", "bob"].

Perhatian: hanya pengguna yang akan dikembalikan, peranan (argumen ke-2 dalam "g") akan dikecualikan.

Go

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

GetAllowedObjectConditions()

GetAllowedObjectConditions mengembalikan susunan rentetan syarat objek yang boleh diakses oleh pengguna.

Contohnya:

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.") akan mengembalikan ["price < 25", "category_id = 2"], nil

Perhatian:

0. awalan: Anda boleh menyesuaikan awalan syarat objek, dan "r.obj." biasanya digunakan sebagai awalan. Selepas mengalih keluar awalan, bahagian yang tinggal ialah syarat objek. Jika terdapat dasar obj yang tidak memenuhi keperluan awalan, errors.ERR_OBJ_CONDITION akan dikembalikan.

1. Jika tatasusunan 'objectConditions' kosong, kembalikan errors.ERR_EMPTY_CONDITION

Go

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

GetImplicitUsersForResource()

GetImplicitUsersForResource()

GetImplicitUsersForResource mengembalikan pengguna tersirat berdasarkan sumber.

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

Contohnya:

GetImplicitUsersForResource("data2") akan mengembalikan [["bob", "data2", "write"], ["alice", "data2", "read"] ["alice", "data2", "write"]], nil.

Go

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

nota

GetImplicitUsersForResource("data1") akan mengembalikan [["alice", "data1", "read"]], nil.