public class RolesEntity
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
apiToken |
protected okhttp3.HttpUrl |
baseUrl |
protected okhttp3.OkHttpClient |
client |
Modifier and Type | Method and Description |
---|---|
Request |
addPermissions(java.lang.String roleId,
java.util.List<Permission> permissions)
Associate permissions with a role.
|
Request |
assignUsers(java.lang.String roleId,
java.util.List<java.lang.String> userIds)
Assign users to a role.
|
Request<Role> |
create(Role role)
Create a Role.
|
Request |
delete(java.lang.String roleId)
Delete an existing Role.
|
Request<Role> |
get(java.lang.String roleId)
Get a single role created by this tenant that can be assigned to a given user or user group.
|
Request<RolesPage> |
list(RolesFilter filter)
Request all Roles created by this tenant that can be assigned to a given user or user group.
|
Request<PermissionsPage> |
listPermissions(java.lang.String roleId,
PageFilter filter)
Get the permissions associated to the role.
|
Request<UsersPage> |
listUsers(java.lang.String roleId,
PageFilter filter)
Lists the users that have been associated with a given role.
|
Request |
removePermissions(java.lang.String roleId,
java.util.List<Permission> permissions)
Un-associate permissions from a role.
|
Request<Role> |
update(java.lang.String roleId,
Role role)
Update an existing Role.
|
protected final okhttp3.OkHttpClient client
protected final okhttp3.HttpUrl baseUrl
protected final java.lang.String apiToken
public Request<RolesPage> list(RolesFilter filter)
filter
- optional filtering and pagination criteriapublic Request<Role> get(java.lang.String roleId)
roleId
- the id of the user to retrieve.public Request<Role> create(Role role)
role
- the role data to setpublic Request delete(java.lang.String roleId)
roleId
- The id of the role to delete.public Request<Role> update(java.lang.String roleId, Role role)
roleId
- the role idrole
- the role data to set. It can't include id.public Request<UsersPage> listUsers(java.lang.String roleId, PageFilter filter)
roleId
- the role idfilter
- an optional pagination filterpublic Request assignUsers(java.lang.String roleId, java.util.List<java.lang.String> userIds)
roleId
- the role iduserIds
- a list of user ids to assign to the rolepublic Request<PermissionsPage> listPermissions(java.lang.String roleId, PageFilter filter)
roleId
- the role idfilter
- an optional pagination filterpublic Request removePermissions(java.lang.String roleId, java.util.List<Permission> permissions)
roleId
- the role idpermissions
- a list of permission objects to un-associate from the rolepublic Request addPermissions(java.lang.String roleId, java.util.List<Permission> permissions)
roleId
- the role idpermissions
- a list of permission objects to associate to the role