RoleManager API

RoleManager

RoleManager provides interface to define the operations for managing roles. Adding matching function to rolemanager allows using wildcards in role name and domain.

AddNamedMatchingFunc()

AddNamedMatchingFunc add MatchingFunc by ptype to RoleManager. MatchingFunc will work when operating role matching.

Go

    e.AddNamedMatchingFunc("g", "", util.KeyMatch)
    _, _ = e.AddGroupingPolicies([][]string{{"*", "admin", "domain1"}})
    _, _ = e.GetRoleManager().HasLink("bob", "admin", "domain1") // -> true, nil

Node.js

    await e.addNamedMatchingFunc('g', Util.keyMatchFunc);
    await e.addGroupingPolicies([['*', 'admin', 'domain1']]);
    await e.getRoleManager().hasLink('bob', 'admin', 'domain1');

For example:

Go

    e, _ := casbin.NewEnforcer("path/to/model", "path/to/policy")
    e.AddNamedMatchingFunc("g", "", util.MatchKey)

Node.js

    const e = await newEnforcer('path/to/model', 'path/to/policy');
    await e.addNamedMatchingFunc('g', Util.keyMatchFunc);

AddNamedDomainMatchingFunc()

AddNamedDomainMatchingFunc add MatchingFunc by ptype to RoleManager. DomainMatchingFunc is similar to MatchingFunc listed above.

For example:

Go

    e, _ := casbin.NewEnforcer("path/to/model", "path/to/policy")
    e.AddNamedDomainMatchingFunc("g", "", util.MatchKey)

Node.js

    const e = await newEnforcer('path/to/model', 'path/to/policy');
    await e.addNamedDomainMatchingFunc('g', Util.keyMatchFunc);

GetRoleManager()

GetRoleManager gets the current role manager for g.

For example:

Go

    rm := e.GetRoleManager()

Node.js

    const rm = await e.getRoleManager();

Python

    rm = e.get_role_manager()

GetNamedRoleManager()

GetNamedRoleManager gets the role manager by named ptype.

For example:

Go

    rm := e.GetNamedRoleManager("g2")

Node.js

    const rm = await e.getNamedRoleManager("g2");

Python

    rm = e.get_named_role_manager("g2")

SetRoleManager()

SetRoleManager sets the current role manager for g.

For example:

Go

    e.SetRoleManager(rm)

Node.js

    e.setRoleManager(rm);

Python

    rm = e.set_role_manager(rm)

SetNamedRoleManager()

SetNamedRoleManager sets the role manager by named ptype.

For example:

Go

    rm := e.SetNamedRoleManager("g2", rm)

Python

    rm = e.set_role_manager("g2", rm)

Clear()

Clear clears all stored data and resets the role manager to the initial state.

For example:

Go

    rm.Clear()

Node.js

    await rm.clear();

Python

    rm.clear()

AddLink()

AddLink adds the inheritance link between two roles. role: name1 and role: name2. Domain is a prefix to the roles (can be used for other purposes).

For example:

Go

    rm.AddLink("u1", "g1", "domain1")

Node.js

    await rm.addLink('u1', 'g1', 'domain1');

Python

    rm.add_link("u1", "g1", "domain1")

DeleteLink()

DeleteLink deletes the inheritance link between two roles. role: name1 and role: name2. Domain is a prefix to the roles (can be used for other purposes).

For example:

Go

    rm.DeleteLink("u1", "g1", "domain1")

Node.js

    await rm.deleteLink('u1', 'g1', 'domain1');

Python

    rm.delete_link("u1", "g1", "domain1")

HasLink()

HasLink determines whether a link exists between two roles. role: name1 inherits role: name2. Domain is a prefix to the roles (can be used for other purposes).

For example:

Go

    rm.HasLink("u1", "g1", "domain1")

Node.js

    await rm.hasLink('u1', 'g1', 'domain1');

Python

    rm.has_link("u1", "g1", "domain1")

GetRoles()

GetRoles gets the roles that a user inherits. Domain is a prefix to the roles (can be used for other purposes).

For example:

Go

    rm.GetRoles("u1", "domain1")

Node.js

    await rm.getRoles('u1', 'domain1');

Python

    rm.get_roles("u1", "domain")

GetUsers()

GetUsers gets the users that inherits a role. Domain is a prefix to the users (can be used for other purposes).

For example:

Go

    rm.GetUsers("g1")

Node.js

    await rm.getUsers('g1');

Python

    rm.get_users("g1")

PrintRoles()

PrintRoles prints all the roles to log.

For example:

Go

    rm.PrintRoles()

Node.js

    await rm.printRoles();

Python

    rm.print_roles()

SetLogger()

SetLogger sets role manager's logger.

For example:

Go

    logger := log.DefaultLogger{}
    logger.EnableLog(true)
    rm.SetLogger(&logger)
    _ = rm.PrintRoles()

GetDomains()

GetDomains gets domains that a user has

For example:

Go

    result, err := rm.GetDomains(name)