# RBAC API
一個更友好的RBAC API。 這個API是Management API的子集。 RBAC用戶可以使用這個API來簡化代碼。
## 參考
全局變量`e`是實施者實例。
Go
```go
e := NewEnforcer("examples/rbac_model.conf", "examples/rbac_policy.csv")
```
Node.js
```javascript
const e = await newEnforcer('examples/rbac_model.conf', 'examples/rbac_policy.csv')
```
PHP
```php
$e = new Enforcer('examples/rbac_model.conf', 'examples/rbac_policy.csv');
```
### `GetRolesForUser()`
GetRolesForUser 獲取用戶具有的角色。
例如:
Go
```go
res := e.GetRolesForUser("alice")
```
Node.js
```javascript
const res = e.getRolesForUser('alice')
```
PHP
```php
$res = $e->getRolesForUser("alice");
```
### `GetUsersForRole()`
GetUsersForRole 獲取具有角色的用戶。
例如:
Go
```go
res := e.GetUsersForRole("data1_admin")
```
Node.js
```javascript
const res = e.getUsersForRole('data1_admin')
```
PHP
```php
$res = $e->getUsersForRole("data1_admin");
```
### `HasRoleForUser()`
HasRoleForUser 確定用戶是否具有角色。
例如:
Go
```go
res := e.HasRoleForUser("alice", "data1_admin")
```
Node.js
```javascript
const res = e.hasRoleForUser('alice', 'data1_admin')
```
PHP
```php
$res = $e->hasRoleForUser("alice", "data1_admin");
```
### `AddRoleForUser()`
AddRoleForUser 為用戶添加角色。 如果用戶已經擁有該角色(aka不受影響),則返回false。
例如:
Go
```go
e.AddRoleForUser("alice", "data2_admin")
```
Node.js
```javascript
await e.addRoleForUser('alice', 'data2_admin')
```
PHP
```php
$e->addRoleForUser("alice", "data2_admin");
```
### `DeleteRoleForUser()`
DeleteRoleForUser 刪除用戶的角色。 如果用戶沒有該角色(aka不受影響),則返回false。
For example:
Go
```go
e.DeleteRoleForUser("alice", "data1_admin")
```
Node.js
```javascript
await e.deleteRoleForUser('alice', 'data1_admin')
```
PHP
```php
$e->deleteRoleForUser("alice", "data1_admin");
```
### `DeleteRolesForUser()`
DeleteRolesForUser 刪除用戶的所有角色。 如果用戶沒有任何角色(aka不受影響),則返回false。
例如:
Go
```go
e.DeleteRolesForUser("alice")
```
Node.js
```javascript
await e.deleteRolesForUser('alice')
```
PHP
```php
$e->deleteRolesForUser("alice");
```
### `DeleteUser()`
DeleteUser 刪除一個用戶。 如果用戶不存在,則返回false(也就是說不受影響)。
例如:
Go
```go
e.DeleteUser("alice")
```
Node.js
```javascript
await e.deleteUser('alice')
```
PHP
```php
$e->deleteUser("alice");
```
### `DeleteRole()`
DeleteRole 刪除一個角色。
例如:
Go
```go
e.DeleteRole("data2_admin")
```
Node.js
```javascript
await e.deleteRole("data2_admin")
```
PHP
```php
$e->deleteRole("data2_admin");
```
### `DeletePermission()`
DeletePermission 刪除權限。 如果權限不存在,則返回false(aka不受影響)。
例如:
Go
```go
e.DeletePermission("read")
```
Node.js
```javascript
await e.deletePermission('read')
```
PHP
```php
$e->deletePermission("read");
```
### `AddPermissionForUser()`
AddPermissionForUser 為用戶或角色添加權限。 如果用戶或角色已經擁有該權限(aka不受影響),則返回false。
例如:
Go
```go
e.AddPermissionForUser("bob", "read")
```
Node.js
```javascript
await e.addPermissionForUser('bob', 'read')
```
PHP
```php
$e->addPermissionForUser("bob", "read");
```
### `DeletePermissionForUser()`
DeletePermissionForUser 刪除用戶或角色的權限。 如果用戶或角色沒有權限(aka不受影響),則返回false。
例如:
Go
```go
e.DeletePermissionForUser("bob", "read")
```
Node.js
```javascript
await e.deletePermissionForUser("bob", "read")
```
PHP
```php
$e->deletePermissionForUser("bob", "read");
```
### `DeletePermissionsForUser()`
DeletePermissionsForUser 刪除用戶或角色的權限。 如果用戶或角色沒有任何權限(aka不受影響),則返回false。
例如:
Go
```go
e.DeletePermissionsForUser("bob")
```
Node.js
```javascript
await e.deletePermissionsForUser('bob')
```
PHP
```php
$e->deletePermissionsForUser("bob");
```
### `GetPermissionsForUser()`
GetPermissionsForUser 獲取用戶或角色的權限。
例如:
Go
```go
e.GetPermissionsForUser("bob")
```
Node.js
```javascript
e.getPermissionsForUser('bob')
```
PHP
```php
$e->getPermissionsForUser("bob");
```
### `HasPermissionForUser()`
HasPermissionForUser 確定用戶是否具有權限。
例如:
Go
```go
e.HasPermissionForUser("alice", []string{"read"})
```
Node.js
```javascript
e.hasPermissionForUser('alice', 'read')
```
PHP
```php
$e->hasPermissionForUser("alice", []string{"read"});
```
### `GetImplicitRolesForUser()`
GetImplicitRolesForUser 獲取用戶具有的隱式角色。 與GetRolesForUser() 相比,該函數除了直接角色外還檢索間接角色。
For example:
g, alice, role:admin
g, role:admin, role:user
GetRolesForUser("alice") can only get: \["role:admin"\].
But GetImplicitRolesForUser("alice") will get: \["role:admin", "role:user"\].
例如:
Go
```go
e.GetImplicitRolesForUser("alice")
```
Node.js
```javascript
Method is not implemented
```
PHP
```php
$e->getImplicitRolesForUser("alice");
```
### `GetImplicitPermissionsForUser()`
GetImplicitPermissionsForUser gets implicit permissions for a user or role.
Compared to GetPermissionsForUser(), this function retrieves permissions for inherited roles.
For example:
p, admin, data1, read
p, alice, data2, read
g, alice, admin
GetPermissionsForUser("alice") can only get: \[\["alice", "data2", "read"\]\].
But GetImplicitPermissionsForUser("alice") will get: \[\["admin", "data1", "read"\], \["alice", "data2", "read"\]\].
For example:
Go
```go
e.GetImplicitPermissionsForUser("alice")
```
Node.js
```javascript
Method is not implemented
```
PHP
```php
$e->getImplicitPermissionsForUser("alice");
```