RoleService provides operations for creating and managing roles.

addRole

Add a role.

Capability required: AccountWrite
License command group: NetworkManagement

Parameters

Parameter	Data Type	Description	Restriction
role	Role	The role to add.	Req

Response

RoleResponse - The response, which indicates if the operation succeeded or failed, and the role.

addRoles

Add a list of roles.

Quota is charged for each object in the request.

Capability required: AccountWrite
License command group: NetworkManagement

Parameters

Parameter	Data Type	Description	Restriction
roles	Role[]	The list of roles to add.	Req

Response

RoleResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of roles.

deleteRole

Delete a role.

Capability required: AccountWrite
License command group: NetworkManagement

Parameters

Parameter	Data Type	Description	Restriction
roleID	long	The ID of the role to delete.	Req

Response

BasicResponse - The response, which indicates if the operation succeeded or failed.

deleteRoles

Delete a list of roles.

Quota is charged for each object in the request.

Capability required: AccountWrite
License command group: NetworkManagement

Parameters

Parameter	Data Type	Description	Restriction
roleIDs	long[]	The IDs of the roles to delete.	Req

Response

BasicResponse[] - The list of responses, which indicate if the operations succeeded or failed.

getAllPrivileges

Get all the privileges.

Capability required: AccountRead
License command group: NetworkManagement

Parameters

none

Response

Privilege[] - The list of privileges.

getCapabilitiesForPrivilege

Get the capabilities for a privilege.

Capability required: AccountRead
License command group: NetworkManagement

Parameters

Parameter	Data Type	Description	Restriction
privilegeID	long	The ID of the privilege	Req

Response

Capability[] - The capabilities associated with the specified privilege.

getCapabilitiesForRole

Get the capabilities for a role.

Capability required: AccountRead
License command group: NetworkManagement

Parameters

Parameter	Data Type	Description	Restriction
roleID	long	The ID of the role.	Req

Response

Capability[] - The capabilities associated with the privileges defined in the specified role.

getPrivilege

Get a privilege.

Capability required: AccountRead
License command group: NetworkManagement

Parameters

Parameter	Data Type	Description	Restriction
privilegeID	long	The ID of the privilege to retrieve.	Req

Response

Privilege - The privilege.

getPrivileges

Get a list of privileges.

Quota is charged for each object in the request.

Capability required: AccountRead
License command group: NetworkManagement

Parameters

Parameter	Data Type	Description	Restriction
privilegeIDs	long[]	The IDs of the privileges to retrieve.	Req

Response

Privilege[] - The list of privileges.

getRole

Get a role.

Capability required: AccountRead
License command group: NetworkManagement

Parameters

Parameter	Data Type	Description	Restriction
roleID	long	The ID of the role to retrieve.	Req

Response

Role - The role.

getRoleCountByAccountID

Get a count of the roles for an account.

Capability required: AccountRead
License command group: NetworkManagement

Parameters

none

Response

long - A count of the roles for the account (in the request).

getRoles

Get a list of roles.

Quota is charged for each object in the request.

Capability required: AccountRead
License command group: NetworkManagement

Parameters

Parameter	Data Type	Description	Restriction
roleIDs	long[]	The IDs of the roles to retrieve.	Req

Response

Role[] - The list of roles.

getRolesByAccountID

Get the roles for an account.

Capability required: AccountRead
License command group: NetworkManagement

Parameters

Parameter	Data Type	Description	Restriction
startElement	int	The first element to retrieve (0-based; if a value <= 0 is entered, it will default to 0).	Req
numElements	int	The number of elements to retrieve (1000 maximum; if a value <=0 is entered, it will default to 1000).	Req

Response

Role[] - The list of roles for the account (in the request).

getRolesByAgencyContractID

Get the roles for the agency (specified by contract ID).

Capability required: AccountRead
License command group: NetworkManagement
Method access types: Agency account

Parameters

Parameter	Data Type	Description	Restriction
agencyContractID	long	The ID of the agency contract.	Req

Response

Role[] - The list of roles for the specified agency.

getUsersForRole

Get a list of users assigned to a role.

Capability required: AccountRead
License command group: NetworkManagement

Parameters

Parameter	Data Type	Description	Restriction
roleID	long	The ID of the role.	Req

Response

User[] - The list of users who have been assigned the specified role.

setUsersForRole

Set users for a role.

Quota is charged for each object in the request.

Capability required: AccountWrite
License command group: NetworkManagement

Parameters

Parameter	Data Type	Description	Restriction
roleID	long	The ID of the role.	Req
userIDs	long[]	The IDs of the users to assign to the specified role.	Req

Response

BasicResponse - The response, which indicates if the operation succeeded or failed.

updateRole

Update a role.

Capability required: AccountWrite
License command group: NetworkManagement

Parameters

Parameter	Data Type	Description	Restriction
role	Role	The role to update.	Req

Response

RoleResponse - The response, which indicates if the operation succeeded or failed, and the role.

updateRoles

Update a list of roles.

Quota is charged for each object in the request.

Capability required: AccountWrite
License command group: NetworkManagement

Parameters

Parameter	Data Type	Description	Restriction
roles	Role[]	The list of roles to update.	Req

Response

RoleResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of roles.