RBAC API

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

参考資料

グローバル変数 e はEnforcerインスタンスです。

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

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

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

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

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

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

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

`GetRolesForUser()`

GetRolesForUserは、ユーザーが持っている役割を取得します。

例えば：

res := e.GetRolesForUser("alice")

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

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

roles = e.get_roles_for_user("alice")

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

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

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

`GetUsersForRole()`

GetUsersForRoleは、役割を持っているユーザーを取得します。

例えば：

res := e.GetUsersForRole("data1_admin")

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

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

users = e.get_users_for_role("data1_admin")

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

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

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

`HasRoleForUser()`

HasRoleForUserは、ユーザーが役割を持っているかどうかを判定します。

例えば：

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

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

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

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

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

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

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

`AddRoleForUser()`

AddRoleForUserは、ユーザーに役割を追加します。ユーザーが既にその役割を持っている場合はfalseを返します（つまり、影響を受けません）。

例えば：

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

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

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

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

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

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

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

`AddRolesForUser()`

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

例えば：

Go
Node.js
Rust

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

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

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を返します（つまり、影響を受けません）。

例えば：

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

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

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

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

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

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

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

`DeleteRolesForUser()`

DeleteRolesForUserはユーザーのすべての役割を削除します。ユーザーが役割を持っていない場合（つまり影響を受けない場合）、falseを返します。

例えば：

e.DeleteRolesForUser("alice")

await e.deleteRolesForUser('alice')

$e->deleteRolesForUser("alice");

e.delete_roles_for_user("alice")

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

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

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

`DeleteUser()`

DeleteUserはユーザーを削除します。ユーザーが存在しない場合（つまり影響を受けない場合）、falseを返します。

例えば：

e.DeleteUser("alice")

await e.deleteUser('alice')

$e->deleteUser("alice");

e.delete_user("alice")

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

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

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

`DeleteRole()`

DeleteRoleは役割を削除します。

例えば：

e.DeleteRole("data2_admin")

await e.deleteRole("data2_admin")

$e->deleteRole("data2_admin");

e.delete_role("data2_admin")

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

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

e.deleteRole("data2_admin");

`DeletePermission()`

DeletePermissionは権限を削除します。権限が存在しない場合はfalseを返します（つまり、影響を受けません）。

例えば：

e.DeletePermission("read")

await e.deletePermission('read')

$e->deletePermission("read");

e.delete_permission("read")

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

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

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

`AddPermissionForUser()`

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

例えば：

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

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

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

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

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

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

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

`AddPermissionsForUser()`

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

例えば：

Go
Node.js
Rust

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

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

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

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を返します（つまり、影響を受けません）。

例えば：

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

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

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

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

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

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

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

`DeletePermissionsForUser()`

DeletePermissionsForUserは、ユーザーまたはロールの権限を削除します。ユーザーまたはロールに権限がない場合（つまり、影響を受けていない場合）はfalseを返します。

例えば：

e.DeletePermissionsForUser("bob")

await e.deletePermissionsForUser('bob')

$e->deletePermissionsForUser("bob");

e.delete_permissions_for_user("bob")

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

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

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

`GetPermissionsForUser()`

GetPermissionsForUserは、ユーザーまたはロールの権限を取得します。

例えば：

e.GetPermissionsForUser("bob")

await e.getPermissionsForUser('bob')

$e->getPermissionsForUser("bob");

e.get_permissions_for_user("bob")

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

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

`HasPermissionForUser()`

HasPermissionForUserは、ユーザーが権限を持っているかどうかを判断します。

例えば：

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

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

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

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

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

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

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"]。

例えば:

e.GetImplicitRolesForUser("alice")

await e.getImplicitRolesForUser("alice")

$e->getImplicitRolesForUser("alice");

e.get_implicit_roles_for_user("alice")

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

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

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
Node.js
Java

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

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

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"]]。

例えば:

e.GetImplicitPermissionsForUser("alice")

await e.getImplicitPermissionsForUser("alice")

$e->getImplicitPermissionsForUser("alice");

e.get_implicit_permissions_for_user("alice")

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

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

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
Python

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

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"]を取得できます。

例えば:

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")は以下を返します

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

`GetImplicitUsersForPermission()`

GetImplicitUsersForPermissionは、パーミッションに対する暗黙的なユーザーを取得します。

例えば：

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

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

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

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 を返します。

注意：

プレフィックス：オブジェクト条件のプレフィックスをカスタマイズできます。"r.obj." は一般的にプレフィックスとして使用されます。プレフィックスを削除した後の残りの部分がオブジェクトの条件です。プレフィックス要件を満たさないオブジェクトポリシーがある場合、errors.ERR_OBJ_CONDITION が返されます。
'objectConditions' 配列が空の場合、errors.ERR_EMPTY_CONDITION が返されます。

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を返します。

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

メモ

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

参考資料​

GetRolesForUser()​

GetUsersForRole()​

HasRoleForUser()​

AddRoleForUser()​

AddRolesForUser()​

DeleteRoleForUser()​

DeleteRolesForUser()​

DeleteUser()​

DeleteRole()​

DeletePermission()​

AddPermissionForUser()​

AddPermissionsForUser()​

DeletePermissionForUser()​

DeletePermissionsForUser()​

GetPermissionsForUser()​

HasPermissionForUser()​

GetImplicitRolesForUser()​

GetImplicitUsersForRole()​

GetImplicitPermissionsForUser()​

GetNamedImplicitPermissionsForUser()​

GetDomainsForUser()​

GetImplicitResourcesForUser()​

GetImplicitUsersForPermission()​

GetAllowedObjectConditions()​

GetImplicitUsersForResource()​

参考資料

`GetRolesForUser()`

`GetUsersForRole()`

`HasRoleForUser()`

`AddRoleForUser()`

`AddRolesForUser()`

`DeleteRoleForUser()`

`DeleteRolesForUser()`

`DeleteUser()`

`DeleteRole()`

`DeletePermission()`

`AddPermissionForUser()`

`AddPermissionsForUser()`

`DeletePermissionForUser()`

`DeletePermissionsForUser()`

`GetPermissionsForUser()`

`HasPermissionForUser()`

`GetImplicitRolesForUser()`

`GetImplicitUsersForRole()`

`GetImplicitPermissionsForUser()`

`GetNamedImplicitPermissionsForUser()`

`GetDomainsForUser()`

`GetImplicitResourcesForUser()`

`GetImplicitUsersForPermission()`

`GetAllowedObjectConditions()`

`GetImplicitUsersForResource()`