Account Service
Produces: Auditable Event Occurred [event]
Consumes: None
Overview
The Account service is responsible for maintaining roles and permissions for Link Cloud users.
flowchart LR
nAccountService_9DE0178["Service: Account Service"]
nAccountService_9DE0178 -->|produces| nAuditableEventOccurred_2E7ED8D7["Event: AuditableEventOccurred"]
subgraph nCompliance_DBAE25D_domain["Domain: Compliance"]
nAccountService_9DE0178
nAuditableEventOccurred_2E7ED8D7
end
Configuration
| Property | Type | Description |
|---|---|---|
Redis:Enabled |
boolean | If enabled, Redis will be used to cache account information associated with authenticated users. |
- Image Name: link-account
Common Configurations
- Swagger
- Azure App Configuration
- Kafka Configuration
- Kafka Consumer Retry Configuration
- Service Registry Configuration
- CORS Configuration
- Token Service Configuration
- Service Authentication
- SQL Server Database Configuration
Database Schema
| Name | Type | Required? | Length |
|---|---|---|---|
| MigrationId | string | Yes | 150 |
| ProductVersion | string | Yes | 32 |
| Name | Type | Required? | Length |
|---|---|---|---|
| Id | integer | Yes | |
| RoleId | string | Yes | |
| ClaimType | string | No | |
| ClaimValue | string | No |
| Name | Type | Required? | Length |
|---|---|---|---|
| Id | string | Yes | |
| Name | string | No | 128 |
| Description | string | No | |
| CreatedOn | string (date-time) | Yes | |
| CreatedBy | string | No | |
| LastModifiedOn | string (date-time) | No | |
| LastModifiedBy | string | No |
| Name | Type | Required? | Length |
|---|---|---|---|
| Id | integer | Yes | |
| UserId | string | Yes | |
| ClaimType | string | No | |
| ClaimValue | string | No |
| Name | Type | Required? | Length |
|---|---|---|---|
| UserId | string | Yes | |
| RoleId | string | Yes |
| Name | Type | Required? | Length |
|---|---|---|---|
| Id | string | Yes | |
| UserName | string | No | 128 |
| string | Yes | 256 | |
| FirstName | string | Yes | 128 |
| MiddleName | string | No | 128 |
| LastName | string | Yes | 128 |
| LastSeen | string (date-time) | No | |
| CreatedOn | string (date-time) | Yes | |
| CreatedBy | string | No | |
| LastModifiedOn | string (date-time) | No | |
| LastModifiedBy | string | No | |
| IsActive | boolean | Yes | |
| IsDeleted | boolean | Yes |
OpenAPI Operations
Route Parameters
None
Query Parameters
None
Activate a user
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | Yes |
Query Parameters
None
Create user
Route Parameters
None
Query Parameters
None
Get all roles
Route Parameters
None
Query Parameters
None
Create user
Route Parameters
None
Query Parameters
None
Deactivate a user
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | Yes |
Query Parameters
None
Delete role
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | Yes |
Query Parameters
None
Get role by id
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | Yes |
Query Parameters
None
Update role
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | Yes |
Query Parameters
None
Delete user
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | Yes |
Query Parameters
None
Get user by id
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | Yes |
Query Parameters
None
Update user
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | Yes |
Query Parameters
None
Get all claims
Route Parameters
None
Query Parameters
None
Get role by name
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| name | Yes |
Query Parameters
None
Get user by id
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| Yes |
Query Parameters
None
Get facility users
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | Yes |
Query Parameters
None
Get users in role
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | Yes |
Query Parameters
None
Recover a deleted user
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | Yes |
Query Parameters
None
Search for users
Route Parameters
None
Query Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| searchText | No | ||
| filterFacilityBy | No | ||
| filterRoleBy | No | ||
| filterClaimBy | No | ||
| includeDeactivatedUsers | No | ||
| includeDeletedUsers | No | ||
| sortBy | No | ||
| sortOrder | No | ||
| pageSize | No | ||
| pageNumber | No |
Update role claims
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | Yes |
Query Parameters
None
Update user claims
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | Yes |
Query Parameters
None
Health check endpoint
Route Parameters
None
Query Parameters
None
Relationships
flowchart LR
nAccountService_9DE0178["Service: Account Service"]
nAccountService_9DE0178 -->|produces| nAuditableEventOccurred_2E7ED8D7["Event: AuditableEventOccurred"]
subgraph nCompliance_DBAE25D_domain["Domain: Compliance"]
nAccountService_9DE0178
nAuditableEventOccurred_2E7ED8D7
end