Class OrganizationController

Controller class for the User REST interface

Inheritance
object
ControllerBase
OrganizationController
Inherited Members
Namespace: Quantellia.WMServer.Auth
Assembly: WMServer.dll
Syntax
[Route("organization")]
[Authorize]
[ApiController]
public class OrganizationController : ControllerBase

Constructors

OrganizationController(AuthDbContext)

Declaration
public OrganizationController(AuthDbContext context)
Parameters
Type Name Description
AuthDbContext context

Methods

AssociateUser(string, string)

associate a user with an organization.

Declaration
[HttpPost("{oId}/user/{uId}/add")]
public Task<IActionResult> AssociateUser(string oId, string uId)
Parameters
Type Name Description
string oId

The Organization ID
string uId

The User ID
Returns
Type Description
Task<IActionResult>

AssociateUserRole(string, string, AssociateUserRoleArgs)

Assigns a user an organization role.

Declaration
[HttpPost("{oId}/user/{uId}/role")]
public Task<IActionResult> AssociateUserRole(string oId, string uId, OrganizationController.AssociateUserRoleArgs userRole)
Parameters
Type Name Description
string oId

The Organization ID
string uId

The User ID
OrganizationController.AssociateUserRoleArgs userRole

Object containing the role name to be associated with this Organization.
Returns
Type Description
Task<IActionResult>

Create(WMOrganizationArgs)

Adds a new organization.

Declaration
[HttpPost]
public Task<ActionResult<WMOrganization>> Create(OrganizationController.WMOrganizationArgs args)
Parameters
Type Name Description
OrganizationController.WMOrganizationArgs args

Organization details are specified as a JSON-formatted string in the request body.
Returns
Type Description
Task<ActionResult<WMOrganization>>

CreateRole(string, WMOrganizationRoleType)

Creates and organization role.

Declaration
[HttpPost("{oId}/role")]
public Task<ActionResult<WMOrganizationRoleType>> CreateRole(string oId, WMOrganizationRoleType role)
Parameters
Type Name Description
string oId

The Organization ID
WMOrganizationRoleType role

Object containing the role information to be created.
Returns
Type Description
Task<ActionResult<WMOrganizationRoleType>>

Delete(string)

Delete the organization with the specified ID.

Declaration
[HttpDelete("{id}")]
public Task<IActionResult> Delete(string id)
Parameters
Type Name Description
string id

The organization ID, specified as a URL parameter.
Returns
Type Description
Task<IActionResult>

DisassociateUser(string, string)

Disassociate a user from an organization entirely.

Declaration
[HttpDelete("{oId}/user/{uId}/remove")]
public Task<IActionResult> DisassociateUser(string oId, string uId)
Parameters
Type Name Description
string oId

The Organization ID
string uId

The User ID
Returns
Type Description
Task<IActionResult>

DisassociateUserRole(string, string, AssociateUserRoleArgs)

Removes a user's organization role.

Declaration
[HttpDelete("{oId}/user/{uId}/role")]
public Task<IActionResult> DisassociateUserRole(string oId, string uId, OrganizationController.AssociateUserRoleArgs userRole)
Parameters
Type Name Description
string oId

The Organization ID
string uId

The User ID
OrganizationController.AssociateUserRoleArgs userRole

Object containing the role name to be associated with this Organization.
Returns
Type Description
Task<IActionResult>

Get(string)

Evaluate the organization with the specified Id.

Declaration
[HttpGet("{id}")]
public Task<ActionResult<WMOrganization>> Get(string id)
Parameters
Type Name Description
string id

The ID of the organization
Returns
Type Description
Task<ActionResult<WMOrganization>>

GetAll()

Evaluate a list of all organizations that the caller is authorized to view. If caller does not have privileges to view any organizations, status code 403 (Forbidden) will be returned.

Declaration
[HttpGet]
public Task<ActionResult<IEnumerable<WMOrganizationDTO>>> GetAll()
Returns
Type Description
Task<ActionResult<IEnumerable<WMOrganizationDTO>>>

GetPermission(string, WMPermissionArg)

Gets whether the principal possesses a permission.

Declaration
[HttpPost("{oId}/permission")]
public Task<ActionResult<bool>> GetPermission(string oId, OrganizationController.WMPermissionArg arg)
Parameters
Type Name Description
string oId

The Organization ID
OrganizationController.WMPermissionArg arg

The route to a particular permission.
Returns
Type Description
Task<ActionResult<bool>>

GetRoles(string)

Gets all roles in an organization.

Declaration
[HttpGet("{oId}/role")]
public Task<ActionResult<List<WMOrganizationRoleType>>> GetRoles(string oId)
Parameters
Type Name Description
string oId

The Organization ID
Returns
Type Description
Task<ActionResult<List<WMOrganizationRoleType>>>

GetUsers()

Returns all of the OrganizationUsers the user is authorized to see.

Declaration
[HttpGet("users")]
public Task<ActionResult<List<WMOrganizationUserArgs>>> GetUsers()
Returns
Type Description
Task<ActionResult<List<WMOrganizationUserArgs>>>

ModifyPermissions(string, List<WMPermissionModificationArgs>)

Modifies permissions in bulk.

Declaration
[HttpPut("{oId}/permission")]
public Task<IActionResult> ModifyPermissions(string oId, List<WMPermissionModificationArgs> args)
Parameters
Type Name Description
string oId

The Organization ID
List<WMPermissionModificationArgs> args

List containing permission modification objects.
Returns
Type Description
Task<IActionResult>

RemoveRole(string, AssociateUserRoleArgs)

Removes an organization role.

Declaration
[HttpDelete("{oId}/role")]
public Task<IActionResult> RemoveRole(string oId, OrganizationController.AssociateUserRoleArgs userRole)
Parameters
Type Name Description
string oId

The Organization ID
OrganizationController.AssociateUserRoleArgs userRole

Object containing the role name to be removed from this Organization.
Returns
Type Description
Task<IActionResult>

Update(string, WMOrganizationArgs)

Updates an organization with the specified id.

Declaration
[HttpPut("{id}")]
public Task<ActionResult<WMOrganization>> Update(string id, OrganizationController.WMOrganizationArgs args)
Parameters
Type Name Description
string id

ID of the Organization whose properties are to be updated.
OrganizationController.WMOrganizationArgs args

Organization details are specified as a JSON-formatted string in the request body.
Returns
Type Description
Task<ActionResult<WMOrganization>>