IRoleService.AddRole Method (Role, String)

IRoleService AddRole Method (Role, String)

CelloSaaS API Documentation

Adds a new role to the system.

Namespace: CelloSaaS.ServiceContracts.AccessControlManagement
Assembly: CelloSaaS.ServiceContracts (in CelloSaaS.ServiceContracts.dll) Version: 4.3.1.0 (4.3.1.0)

Syntax

C++

Copy to Clipboard Print

string AddRole(
	Role roleDetails,
	string roleQualifierQuery
)

string AddRole(
	Role roleDetails,
	string roleQualifierQuery
)

Function AddRole ( 
	roleDetails As Role,
	roleQualifierQuery As String
) As String

Function AddRole ( 
	roleDetails As Role,
	roleQualifierQuery As String
) As String

abstract AddRole : 
        roleDetails : Role * 
        roleQualifierQuery : string -> string

abstract AddRole : 
        roleDetails : Role * 
        roleQualifierQuery : string -> string

Parameters

roleDetails: Type: CelloSaaS.Model.AccessControlManagement Role
Role Details(Mandatory - Role Name, Role Description)

roleQualifierQuery: Type: System String
Qualifier Query (Obsolete)

Return Value

Type: String
Inserted Role Identifier

Exceptions

Exception	Condition
System.Data DataException	If the role name is duplicate
CelloSaaS.ServiceContracts.AccessControlManagement RoleException	If pre or post processor was not inserted.
System ArgumentNullException	If role name or description is null or empty.
System ArgumentException	If role details is null

Examples

Copy to Clipboard Print

public void AddRole()
{  
   Role roleDetails = new Role();
   roleDetails.TenantId = "B590CD25-3093-DF11-8DEB-001EC9DAB123";
   roleDetails.RoleName = "Tenant_Admin";        
   roleDetails.Description = "Tenant Admin Role";
   string roleQualifierQuery = string.Empty;  
   IRoleService roleService = ServiceLocator.Resolve>IRoleService<();
   string roleId = roleService.AddRole(roleDetails, roleQualifierQuery);
}

public void AddRole()
{  
   Role roleDetails = new Role();
   roleDetails.TenantId = "B590CD25-3093-DF11-8DEB-001EC9DAB123";
   roleDetails.RoleName = "Tenant_Admin";        
   roleDetails.Description = "Tenant Admin Role";
   string roleQualifierQuery = string.Empty;  
   IRoleService roleService = ServiceLocator.Resolve>IRoleService<();
   string roleId = roleService.AddRole(roleDetails, roleQualifierQuery);
}