Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Note: This is only for the MTOA Platform Team.

Description

Retrieves a user's role per service based on an application identification number.

Package Details

Interface

Code Block
IUserApplicationManagementManager

Syntax

Code Block
await UserApplicationManagementManager.GetUserRolesByApplication(int applicationId, int userId, bool isActive = true);

Returns

Code Block
ApplicationUserRole

API

GET - /api/v1/userapplications/{id}/roles?userId={userId}&isActive={true|false}

Parameters

Parameter

Description

Type

id

Required

The identification number of the application.

Must be a valid application number.

Path

userId

Required

The user’s identification number the role(s) per service(s).

Query string

isActive

Optional

Only return services where the user’s enrollment status is set to ‘ACTIVE’.

Default value is ‘true’.

Query string

Returns

HTTP 200 - OK

Example

const int applicationId = 12; await _userApplicationManagementManager.GetUsersByApplicationId(applicationId, 1, 20);