AuthorizationModelService (api-interfaces 11.0.3 API)

public interface AuthorizationModelService

Provides authorization services

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addGroupsToUsersGroup(UsersGroupId usersGroupId, Collection<UsersGroupId> groupIds)` Adds a collection of user groups identified by `groupIds` to a users group identified by `usersGroupId`
`void`	`addUsersToUsersGroup(UsersGroupId usersGroupId, Collection<UserId> userIds)` Adds a collection of users identified by `userIds` to a users group identified by `usersGroupId`.
`void`	`assignRolesToUser(UserId userId, Collection<RoleId> roleIds)` Assigns a collection of roles identified by `roleIds` to a user identified by `userId`.
`void`	`assignRolesToUserForAllTenants(UserId userId, Collection<RoleId> roleIds)` Assigns a collection of roles identified by `roleIds` to a user identified by `userId` in the context of all tenants.
`void`	`assignRolesToUserForTenants(UserId userId, Collection<RoleId> roleIds, Collection<TenantId> tenantIds)` Assigns a collection of roles identified by `roleIds` to a user identified by `userId` in the context of tenants identified by `tenantIds`.
`void`	`assignRolesToUsersGroup(UsersGroupId usersGroupId, Collection<RoleId> roleIds)` Assigns a collection of roles identified by `roleIds` to a users group identified by `usersGroupId`.
`void`	`assignRolesToUsersGroupForAllTenants(UsersGroupId usersGroupId, Collection<RoleId> roleIds)` Assigns a collection of roles identified by `roleIds` to a users group identified by `usersGroupId` in the context of all tenants.
`void`	`assignRolesToUsersGroupForTenants(UsersGroupId usersGroupId, Collection<RoleId> roleIds, Collection<TenantId> tenantIds)` Assigns a collection of roles identified by `roleIds` to a users group identified by `usersGroupId` in the context of specific tenants identified by `tenantIds`.
`User`	`createUser(BasicUserData userData)` Creates a new user based on the user information in the UCMDB
`UsersGroup`	`createUsersGroup(BasicUsersGroupData usersGroupData)` Creates a new users group based on the users group information
`void`	`deleteUser(UserId userId)` Deletes a user identified by `userId` from the UCMDB
`void`	`deleteUsersGroup(UsersGroupId usersGroupId)` Deletes a users group identified by `usersGroupId` from the UCMDB
`Collection<RoleId>`	`getAllRoleIds()` Returns a collection of all the roles defined inside UCMDB.
`AuthorizationDataFactory`	`getAuthorizationDataFactory()` Retrieves the factory for creating client side representations of the authorization structures
`BasicUserData`	`getBasicUserData(UserId userId)` Returns the basic user information of the user identified by `userId`
`BasicUsersGroupData`	`getBasicUsersGroupData(UsersGroupId usersGroupId)` Returns the basic users group information of the users group identified by `usersGroupId`
`Collection<UsersGroupId>`	`getGroupsWithRole(RoleId roleId)` Returns a collection of user groups that have been assigned a specific role identified by `roleId`
`Collection<RoleId>`	`getRoleIdsForUser(UserId userId)` Returns a collection of roles which are assigned to a specific user identified by `userId`.
`Collection<RoleId>`	`getRoleIdsForUsersGroup(UsersGroupId usersGroupId)` Returns a collection of roles which are assigned to a specific users group identified by `usersGroupId`.
`User`	`getUser(UserId userId)` Returns a user identified by `userId` from the UCMDB
`UsersGroup`	`getUsersGroup(UsersGroupId usersGroupId)` Returns a users group identified by `usersGroupId`
`Collection<UserId>`	`getUsersWithRole(RoleId roleId)` Returns a collection of users that have been assigned a specific role identified by `roleId`
`void`	`removeGroupsFromUsersGroup(UsersGroupId usersGroupId, Collection<UsersGroupId> groupIds)` Removes a collection of user groups identified by `groupIds`, from a users group identified by `usersGroupId`.
`void`	`removeUsersFromUsersGroup(UsersGroupId usersGroupId, Collection<UserId> userIds)` Removes a collection of users identified by `userIds` from a users group identified by `usersGroupId`
`void`	`revokeRolesFromUser(UserId userId, Collection<RoleId> roleIds)` Revokes a collection of roles identified by `roleIds` from a user identified by `userId`
`void`	`revokeRolesFromUsersGroup(UsersGroupId usersGroupId, Collection<RoleId> roleIds)` Revokes a collection of roles identified by `roleIds` from a users group identified by `usersGroupId`
`void`	`updateUser(BasicUserData userData)` Updates a user based on the user information
`void`	`updateUsersGroup(BasicUsersGroupData usersGroupData)` Updates an existing users group based on the users group information

- Method Detail
  - getAuthorizationDataFactory
```
AuthorizationDataFactory getAuthorizationDataFactory()
```
    Retrieves the factory for creating client side representations of the authorization structures
    
    Returns:
    
    AuthorizationDataFactory
  - createUser
```
User createUser(BasicUserData userData)
```
    Creates a new user based on the user information in the UCMDB
    
    Parameters:
    
    userData - describes the User to create
    
    Returns:
    
    User
  - updateUser
```
void updateUser(BasicUserData userData)
```
    Updates a user based on the user information
    
    Parameters:
    
    userData - describes the updated user information
  - deleteUser
```
void deleteUser(UserId userId)
```
    Deletes a user identified by userId from the UCMDB
    
    Parameters:
    
    userId - the user to be deleted
  - getUser
```
User getUser(UserId userId)
```
    Returns a user identified by userId from the UCMDB
    
    Returns:
    
    User
  - getBasicUserData
```
BasicUserData getBasicUserData(UserId userId)
```
    Returns the basic user information of the user identified by userId
    
    Returns:
    
    BasicUserData describes the user information of the user
  - assignRolesToUser
```
void assignRolesToUser(UserId userId,
                       Collection<RoleId> roleIds)
```
    Assigns a collection of roles identified by roleIds to a user identified by userId. This method should not be used in a Multi Tenancy enabled UCMDB.
  - assignRolesToUserForTenants
```
void assignRolesToUserForTenants(UserId userId,
                                 Collection<RoleId> roleIds,
                                 Collection<TenantId> tenantIds)
```
    Assigns a collection of roles identified by roleIds to a user identified by userId in the context of tenants identified by tenantIds. This method requires Multi Tenancy to be enabled.
  - assignRolesToUserForAllTenants
```
void assignRolesToUserForAllTenants(UserId userId,
                                    Collection<RoleId> roleIds)
```
    Assigns a collection of roles identified by roleIds to a user identified by userId in the context of all tenants. This method requires Multi Tenancy to be enabled.
  - revokeRolesFromUser
```
void revokeRolesFromUser(UserId userId,
                         Collection<RoleId> roleIds)
```
    Revokes a collection of roles identified by roleIds from a user identified by userId
  - createUsersGroup
```
UsersGroup createUsersGroup(BasicUsersGroupData usersGroupData)
```
    Creates a new users group based on the users group information
    
    Parameters:
    
    usersGroupData - describes the users group information
    
    Returns:
    
    UsersGroup
  - updateUsersGroup
```
void updateUsersGroup(BasicUsersGroupData usersGroupData)
```
    Updates an existing users group based on the users group information
    
    Parameters:
    
    usersGroupData - describes the updated users group information
  - deleteUsersGroup
```
void deleteUsersGroup(UsersGroupId usersGroupId)
```
    Deletes a users group identified by usersGroupId from the UCMDB
  - getUsersGroup
```
UsersGroup getUsersGroup(UsersGroupId usersGroupId)
```
    Returns a users group identified by usersGroupId
    
    Returns:
    
    UsersGroup
  - getBasicUsersGroupData
```
BasicUsersGroupData getBasicUsersGroupData(UsersGroupId usersGroupId)
```
    Returns the basic users group information of the users group identified by usersGroupId
    
    Returns:
    
    BasicUsersGroupData describes the users group information
  - addUsersToUsersGroup
```
void addUsersToUsersGroup(UsersGroupId usersGroupId,
                          Collection<UserId> userIds)
```
    Adds a collection of users identified by userIds to a users group identified by usersGroupId.
  - removeUsersFromUsersGroup
```
void removeUsersFromUsersGroup(UsersGroupId usersGroupId,
                               Collection<UserId> userIds)
```
    Removes a collection of users identified by userIds from a users group identified by usersGroupId
  - addGroupsToUsersGroup
```
void addGroupsToUsersGroup(UsersGroupId usersGroupId,
                           Collection<UsersGroupId> groupIds)
```
    Adds a collection of user groups identified by groupIds to a users group identified by usersGroupId
  - removeGroupsFromUsersGroup
```
void removeGroupsFromUsersGroup(UsersGroupId usersGroupId,
                                Collection<UsersGroupId> groupIds)
```
    Removes a collection of user groups identified by groupIds, from a users group identified by usersGroupId.
  - assignRolesToUsersGroup
```
void assignRolesToUsersGroup(UsersGroupId usersGroupId,
                             Collection<RoleId> roleIds)
```
    Assigns a collection of roles identified by roleIds to a users group identified by usersGroupId. This method should not be used in a Multi Tenancy enabled UCMDB.
  - assignRolesToUsersGroupForTenants
```
void assignRolesToUsersGroupForTenants(UsersGroupId usersGroupId,
                                       Collection<RoleId> roleIds,
                                       Collection<TenantId> tenantIds)
```
    Assigns a collection of roles identified by roleIds to a users group identified by usersGroupId in the context of specific tenants identified by tenantIds. This method requires Multi Tenancy to be enabled.
  - assignRolesToUsersGroupForAllTenants
```
void assignRolesToUsersGroupForAllTenants(UsersGroupId usersGroupId,
                                          Collection<RoleId> roleIds)
```
    Assigns a collection of roles identified by roleIds to a users group identified by usersGroupId in the context of all tenants. This method requires Multi Tenancy to be enabled.
  - revokeRolesFromUsersGroup
```
void revokeRolesFromUsersGroup(UsersGroupId usersGroupId,
                               Collection<RoleId> roleIds)
```
    Revokes a collection of roles identified by roleIds from a users group identified by usersGroupId
  - getAllRoleIds
```
Collection<RoleId> getAllRoleIds()
```
    Returns a collection of all the roles defined inside UCMDB.
    
    Returns:
    
    Collection
  - getRoleIdsForUser
```
Collection<RoleId> getRoleIdsForUser(UserId userId)
```
    Returns a collection of roles which are assigned to a specific user identified by userId.
    
    Returns:
    
    Collection
  - getRoleIdsForUsersGroup
```
Collection<RoleId> getRoleIdsForUsersGroup(UsersGroupId usersGroupId)
```
    Returns a collection of roles which are assigned to a specific users group identified by usersGroupId.
    
    Returns:
    
    Collection
  - getUsersWithRole
```
Collection<UserId> getUsersWithRole(RoleId roleId)
```
    Returns a collection of users that have been assigned a specific role identified by roleId
    
    Parameters:
    
    roleId -
    
    Returns:
    
    Collection
  - getGroupsWithRole
```
Collection<UsersGroupId> getGroupsWithRole(RoleId roleId)
```
    Returns a collection of user groups that have been assigned a specific role identified by roleId
    
    Parameters:
    
    roleId -
    
    Returns:
    
    Collection

Interface AuthorizationModelService

Method Summary

Method Detail

getAuthorizationDataFactory

createUser

updateUser

deleteUser

getUser

getBasicUserData

assignRolesToUser

assignRolesToUserForTenants

assignRolesToUserForAllTenants

revokeRolesFromUser

createUsersGroup

updateUsersGroup

deleteUsersGroup

getUsersGroup

getBasicUsersGroupData

addUsersToUsersGroup

removeUsersFromUsersGroup

addGroupsToUsersGroup

removeGroupsFromUsersGroup

assignRolesToUsersGroup

assignRolesToUsersGroupForTenants

assignRolesToUsersGroupForAllTenants

revokeRolesFromUsersGroup

getAllRoleIds

getRoleIdsForUser

getRoleIdsForUsersGroup

getUsersWithRole

getGroupsWithRole