RBAC API

RBAC向けのよりフレンドリーなAPI。 このAPIはManagement APIのサブセットです。 RBACユーザーはこのAPIを使用してコードを簡素化できます。

参考資料

グローバル変数 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は、ユーザーに役割を追加します。 ユーザーが既にその役割を持っている場合はfalseを返します（つまり、影響を受けません）。

例えば：

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は、ユーザーに複数の役割を追加します。 ユーザーが既にこれらの役割のいずれかを持っている場合はfalseを返します（つまり、影響を受けません）。

例えば：

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は、ユーザーの役割を削除します。 ユーザーがその役割を持っていない場合はfalseを返します（つまり、影響を受けません）。

例えば：

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はユーザーのすべての役割を削除します。 ユーザーが役割を持っていない場合（つまり影響を受けない場合）、falseを返します。

例えば：

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はユーザーを削除します。 ユーザーが存在しない場合（つまり影響を受けない場合）、falseを返します。

例えば：

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は権限を削除します。 権限が存在しない場合はfalseを返します（つまり、影響を受けません）。

例えば：

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はユーザーまたは役割に権限を追加します。 ユーザーまたは役割が既にその権限を持っている場合はfalseを返します（つまり、影響を受けません）。

例えば：

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

AddPermissionsForUserは、ユーザーまたはロールに複数の権限を追加します。 ユーザーまたはロールが既にいずれかの権限を持っている場合、falseを返します（つまり、影響を受けません）。

例えば：

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は、ユーザーまたはロールの権限を削除します。 ユーザーまたはロールがその権限を持っていない場合、falseを返します（つまり、影響を受けません）。

例えば：

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は、ユーザーまたはロールの権限を削除します。 ユーザーまたはロールに権限がない場合（つまり、影響を受けていない場合）はfalseを返します。

例えば：

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");

GetNamedPermissionsForUser()

GetNamedPermissionsForUser gets permissions for a user or role by named policy.

例えば：

p, alice, data1, read
p, bob, data2, write
p2, admin, create
g, alice, admin

GetNamedPermissionsForUser("p", "alice") will return [["alice", "data1", "read"]]. GetNamedPermissionsForUser("p2", "alice") will return [["admin", "create"]].

Go

permissions, err := e.GetNamedPermissionsForUser("p", "alice")

Python

permissions = e.get_named_permissions_for_user("p", "alice")

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");

GetNamedImplicitRolesForUser()

GetNamedImplicitRolesForUser gets implicit roles that a user has by named policy.

例えば:

g, alice, admin
g, admin, super_admin
g2, alice, user
g2, user, guest

GetNamedImplicitRolesForUser("g", "alice") will return ["admin", "super_admin"]. GetNamedImplicitRolesForUser("g2", "alice") will return ["user", "guest"].

Go

roles, err := e.GetNamedImplicitRolesForUser("g", "alice")

Python

roles = e.get_named_implicit_roles_for_user("g", "alice")

GetImplicitUsersForRole()

GetImplicitUsersForRole はその役割を継承するすべてのユーザーを取得します。 GetUsersForRole() と比較して、この関数は間接的なユーザーを取得します。

For example:

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

GetUsersForRole("role:user") は以下のみを取得できます: ["role:admin"]。\ しかし、GetImplicitUesrsForRole("role:user")は以下を取得します: ["role:admin", "alice"]。

For example:

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")は、デフォルトのポリシー"p"によってのみ取得できます: [["admin", "data1", "read"]]

しかし、ポリシーを"p2"と指定することで、GetNamedImplicitPermissionsForUser("p2", "alice")によって[["admin", "create"]]を取得できます。

例えば:

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は、パーミッションに対する暗黙的なユーザーを取得します。

For example:

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

GetImplicitUsersForPermission("data1", "read")は以下を返します: ["alice", "bob"].

注意: ユーザーのみが返されます、ロール（"g"の2番目の引数）は除外されます。

Go

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

GetImplicitObjectPatternsForUser()

GetImplicitObjectPatternsForUser returns all object patterns (with wildcards) that a user has for a given domain and action.

For example:

p, admin, chronicle/123, location/*, read
p, user, chronicle/456, location/789, read
g, alice, admin
g, bob, user

GetImplicitObjectPatternsForUser("alice", "chronicle/123", "read") will return ["location/*"]. GetImplicitObjectPatternsForUser("bob", "chronicle/456", "read") will return ["location/789"].

Go

patterns, err := e.GetImplicitObjectPatternsForUser("alice", "chronicle/123", "read")

Node.js

const patterns = await e.getImplicitObjectPatternsForUser("alice", "chronicle/123", "read")

PHP

$patterns = $e->getImplicitObjectPatternsForUser("alice", "chronicle/123", "read");

Python

patterns = e.get_implicit_object_patterns_for_user("alice", "chronicle/123", "read")

.NET

var patterns = e.GetImplicitObjectPatternsForUser("alice", "chronicle/123", "read");

Rust

let patterns = e.get_implicit_object_patterns_for_user("alice", "chronicle/123", "read").await?;

Java

List<String> patterns = e.getImplicitObjectPatternsForUser("alice", "chronicle/123", "read");

GetAllowedObjectConditions()

GetAllowedObjectConditionsは、ユーザーがアクセスできるオブジェクト条件の文字列配列を返します。

For example:

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は、リソースに基づいて暗黙的なユーザーを返します。

For example:

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"の2番目の引数）は除外されます。

GetNamedImplicitUsersForResource()

GetNamedImplicitUsersForResource return implicit user based on resource with named policy support. This function handles resource role relationships through named policies (e.g., g2, g3, etc.).

For example:

p, admin_group, admin_data, *
g, admin, admin_group
g2, app, admin_data

GetNamedImplicitUsersForResource("g2", "app") will return users who have access to admin_data through g2 relationship.

Go

ImplicitUsers, err := e.GetNamedImplicitUsersForResource("g2", "app")