All Superinterfaces:: Maskable, ResultLimitable, Service

Enclosing class:: Group

@ApiService("SoftLayer_User_Permission_Group")
public static interface Group.Service
extends Service

The SoftLayer_User_Permission_Group class is one of several classes that make up the customer permission system. It is a role-based system that includes defined actions which can be "grouped" together using a SoftLayer_User_Permission_Group class. These groups of actions are then used to define roles, and the roles are assigned to users. The SoftLayer_User_Permission_Group is also used to track the resources or account devices to which a user has been granted access. The types of resources that users can be granted access is defined in [[SoftLayer_User_Permission_Resource_Type]].

When a [[SoftLayer_User_Customer]] is created, a SoftLayer_User_Permission_Group and SoftLayer_User_Permission_Role is created specifically for the user with a group type of SYSTEM. When the UI is used to alter the permissions of a customer user, the actions are added or removed from this group. The api can not be used to alter the permissions in this group. If an account wants to create their own unique permission groups and roles, the UI can not be used to manage them.

This is also true for device access. Either, the UI can be used to track the devices to which users are granted access which will use the SYSTEM group, or the api can be used, making the UI information inaccurate.

User Customers can be assigned to multiple roles but it is recommended to either use the UI for managing account users permissions or only use the api. Mixing the two will lead to confusing results as the UI will not show any permissions assigned to a user via a customer created role/group combination.

Proceed with caution.

One or more [[SoftLayer_User_Permission_Action]] are assigned to one or more SoftLayer_User_Permission_Group Objects. One ore more SoftLayer_User_Permission_Group objects can be linked to a [[SoftLayer_User_Permission_Role]]. A single SoftLayer_User_Permission_Group object can be linked to multiple SoftLayer_User_Permission_Role objects. The [[SoftLayer_User_Permission_Role]] is assigned to one or more [[SoftLayer_User_Customer]].

The [[SoftLayer_User_Permission_Action]] class defines the permissions that are required in order for a [[SoftLayer_User_Customer]] to perform certain actions within IMS.

Resources belonging to the user's account can also be linked to permission groups. See [[SoftLayer_User_Permission_Resource_Type]].

See Also:: SoftLayer_User_Permission_Group

Method Summary

Modifier and Type	Method	Description
`Void`	`addAction(Action action)`	Assigns a SoftLayer_User_Permission_Action object to the group.
`Void`	`addBulkActions(List<Action> actions)`	Assigns multiple SoftLayer_User_Permission_Action objects to the group.
`Boolean`	`addBulkResourceObjects(List<Entity> resourceObjects, String resourceTypeKeyName)`	Links multiple SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost objects to the group.
`Boolean`	`addResourceObject(Entity resourceObject, String resourceTypeKeyName)`	Links a SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost object to the group.
`Group.ServiceAsync`	`asAsync()`	Get an async version of this service
`Group`	`createObject(Group templateObject)`	Customer created permission groups must be of type NORMAL.
`Boolean`	`deleteObject()`	Customer users can only delete permission groups of type NORMAL.
`Group`	`editObject(Group templateObject)`	Allows a user to modify the name and description of an existing customer permission group.
`Account`	`getAccount()`
`List<Action>`	`getActions()`
`Group`	`getObject()`
`List<Role>`	`getRoles()`
`Type`	`getType()`	The type of the permission group.
`Void`	`linkRole(Role role)`	Links a SoftLayer_User_Permission_Role object to the group.
`Void`	`removeAction(Action action)`	Unassigns a SoftLayer_User_Permission_Action object from the group.
`Void`	`removeBulkActions(List<Action> actions)`	Unassigns multiple SoftLayer_User_Permission_Action objects from the group.
`Boolean`	`removeBulkResourceObjects(List<Entity> resourceObjects, String resourceTypeKeyName)`	Unlinks multiple SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost objects from the group.
`Boolean`	`removeResourceObject(Entity resourceObject, String resourceTypeKeyName)`	Unlinks a SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost object from the group.
`void`	`setMask(Group.Mask mask)`
`Void`	`unlinkRole(Role role)`	Removes a link from SoftLayer_User_Permission_Role object to the group.
`Group.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Group.Mask`	`withNewMask()`	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details
- asAsync
  
  Group.ServiceAsync asAsync()
  
  Description copied from interface: Service
  
  Get an async version of this service
  
  Specified by:
  
  asAsync in interface Service
- withNewMask
  
  Group.Mask withNewMask()
  
  Description copied from interface: Maskable
  
  Overwrite the existing mask on this service with a new one and return it
  
  Specified by:
  
  withNewMask in interface Maskable
- withMask
  
  Group.Mask withMask()
  
  Description copied from interface: Maskable
  
  Use the existing mask on this service or create it if not present
  
  Specified by:
  
  withMask in interface Maskable
- setMask
  
  void setMask(Group.Mask mask)
- addAction
  
  @ApiMethod(instanceRequired=true) Void addAction(Action action)
  
  Assigns a SoftLayer_User_Permission_Action object to the group.
  
  See Also:
  
  SoftLayer_User_Permission_Group::addAction
- addBulkActions
  
  @ApiMethod(instanceRequired=true) Void addBulkActions(List<Action> actions)
  
  Assigns multiple SoftLayer_User_Permission_Action objects to the group.
  
  See Also:
  
  SoftLayer_User_Permission_Group::addBulkActions
- addBulkResourceObjects
  
  @ApiMethod(instanceRequired=true) Boolean addBulkResourceObjects(List<Entity> resourceObjects, String resourceTypeKeyName)
  
  Links multiple SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost objects to the group. All objects must be of the same type.
  
  See Also:
  
  SoftLayer_User_Permission_Group::addBulkResourceObjects
- addResourceObject
  
  @ApiMethod(instanceRequired=true) Boolean addResourceObject(Entity resourceObject, String resourceTypeKeyName)
  
  Links a SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost object to the group.
  
  See Also:
  
  SoftLayer_User_Permission_Group::addResourceObject
- createObject
  
  @ApiMethod Group createObject(Group templateObject)
  
  Customer created permission groups must be of type NORMAL. The SYSTEM type is reserved for internal use. The account id supplied in the template permission group must match account id of the user who is creating the permission group. The user who is creating the permission group must have the permission to manage users.
  
  See Also:
  
  SoftLayer_User_Permission_Group::createObject
- deleteObject
  
  @ApiMethod(instanceRequired=true) Boolean deleteObject()
  
  Customer users can only delete permission groups of type NORMAL. The SYSTEM type is reserved for internal use. The user who is creating the permission group must have the permission to manage users.
  
  See Also:
  
  SoftLayer_User_Permission_Group::deleteObject
- editObject
  
  @ApiMethod(instanceRequired=true) Group editObject(Group templateObject)
  
  Allows a user to modify the name and description of an existing customer permission group. Customer permission groups must be of type NORMAL. The SYSTEM type is reserved for internal use. The account id supplied in the template permission group must match account id of the user who is creating the permission group. The user who is creating the permission group must have the permission to manage users.
  
  See Also:
  
  SoftLayer_User_Permission_Group::editObject
- getObject
  
  @ApiMethod(instanceRequired=true) Group getObject()
  
  See Also:
  
  SoftLayer_User_Permission_Group::getObject
- linkRole
  
  @ApiMethod(instanceRequired=true) Void linkRole(Role role)
  
  Links a SoftLayer_User_Permission_Role object to the group.
  
  See Also:
  
  SoftLayer_User_Permission_Group::linkRole
- removeAction
  
  @ApiMethod(instanceRequired=true) Void removeAction(Action action)
  
  Unassigns a SoftLayer_User_Permission_Action object from the group.
  
  See Also:
  
  SoftLayer_User_Permission_Group::removeAction
- removeBulkActions
  
  @ApiMethod(instanceRequired=true) Void removeBulkActions(List<Action> actions)
  
  Unassigns multiple SoftLayer_User_Permission_Action objects from the group.
  
  See Also:
  
  SoftLayer_User_Permission_Group::removeBulkActions
- removeBulkResourceObjects
  
  @ApiMethod(instanceRequired=true) Boolean removeBulkResourceObjects(List<Entity> resourceObjects, String resourceTypeKeyName)
  
  Unlinks multiple SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost objects from the group. All objects must be of the same type.
  
  See Also:
  
  SoftLayer_User_Permission_Group::removeBulkResourceObjects
- removeResourceObject
  
  @ApiMethod(instanceRequired=true) Boolean removeResourceObject(Entity resourceObject, String resourceTypeKeyName)
  
  Unlinks a SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost object from the group.
  
  See Also:
  
  SoftLayer_User_Permission_Group::removeResourceObject
- unlinkRole
  
  @ApiMethod(instanceRequired=true) Void unlinkRole(Role role)
  
  Removes a link from SoftLayer_User_Permission_Role object to the group.
  
  See Also:
  
  SoftLayer_User_Permission_Group::unlinkRole
- getAccount
  
  @ApiMethod(instanceRequired=true) Account getAccount()
  
  See Also:
  
  SoftLayer_User_Permission_Group::getAccount
- getActions
  
  @ApiMethod(instanceRequired=true) List<Action> getActions()
  
  See Also:
  
  SoftLayer_User_Permission_Group::getActions
- getRoles
  
  @ApiMethod(instanceRequired=true) List<Role> getRoles()
  
  See Also:
  
  SoftLayer_User_Permission_Group::getRoles
- getType
  
  @ApiMethod(instanceRequired=true) Type getType()
  
  The type of the permission group.
  
  See Also:
  
  SoftLayer_User_Permission_Group::getType

Interface Group.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Details

asAsync

withNewMask

withMask

setMask

addAction

addBulkActions

addBulkResourceObjects

addResourceObject

createObject

deleteObject

editObject

getObject

linkRole

removeAction

removeBulkActions

removeBulkResourceObjects

removeResourceObject

unlinkRole

getAccount

getActions

getRoles

getType