Cloud API - Users and Access Management

Updated December 31, 2025 09:36

Cloud API - Users and Access Management

Base URL: https://public-api.loadgen.cloud

This article documents user and access management endpoints (users, roles, permissions, profile, and related user-scoped services).

GetUserChatFriendsWithSettings

Method: GET

Path: /api/services/app/Chat/GetUserChatFriendsWithSettings

Operation ID: ApiServicesAppChatGetuserchatfriendswithsettingsGet

Tag: Chat

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetUserChatFriendsWithSettingsOutput

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"serverTime": "2025-01-01T00:00:00Z",

"friends": [

{

"friendUserId": 0,

"friendTenantId": 0,

"friendUserName": "string"

}

]

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Chat/GetUserChatFriendsWithSettings" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Chat/GetUserChatFriendsWithSettings"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

GetUserChatMessages

Method: GET

Path: /api/services/app/Chat/GetUserChatMessages

Operation ID: ApiServicesAppChatGetuserchatmessagesGet

Tag: Chat

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

|---|---|---|---:|---|---|

min: 1 |

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: ChatMessageDtoListResultDto

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"items": [

{

"userId": 0,

"tenantId": 0,

"targetUserId": 0

}

]

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Chat/GetUserChatMessages?TenantId=0&UserId=1&MinMessageId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Chat/GetUserChatMessages?TenantId=0&UserId=1&MinMessageId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

MarkAllUnreadMessagesOfUserAsRead

Method: POST

Path: /api/services/app/Chat/MarkAllUnreadMessagesOfUserAsRead

Operation ID: ApiServicesAppChatMarkallunreadmessagesofuserasreadPost

Tag: Chat

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: MarkAllUnreadMessagesOfUserAsReadInput

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"tenantId": 0,

"userId": 0

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Chat/MarkAllUnreadMessagesOfUserAsRead" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"tenantId":0,"userId":0}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Chat/MarkAllUnreadMessagesOfUserAsRead"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"tenantId": 0,

"userId": 0

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

AcceptFriendshipRequest

Method: POST

Path: /api/services/app/Friendship/AcceptFriendshipRequest

Operation ID: ApiServicesAppFriendshipAcceptfriendshiprequestPost

Tag: Friendship

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: AcceptFriendshipRequestInput

Request body fields

|---|---|---:|---|---|

min: 1 |

Example request body

`json

{

"userId": 1,

"tenantId": 0

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Friendship/AcceptFriendshipRequest" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"userId":1,"tenantId":0}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Friendship/AcceptFriendshipRequest"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"userId": 1,

"tenantId": 0

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

BlockUser

Method: POST

Path: /api/services/app/Friendship/BlockUser

Operation ID: ApiServicesAppFriendshipBlockuserPost

Tag: Friendship

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: BlockUserInput

Request body fields

|---|---|---:|---|---|

min: 1 |

Example request body

`json

{

"userId": 1,

"tenantId": 0

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Friendship/BlockUser" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"userId":1,"tenantId":0}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Friendship/BlockUser"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"userId": 1,

"tenantId": 0

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

CreateFriendshipForCurrentTenant

Method: POST

Path: /api/services/app/Friendship/CreateFriendshipForCurrentTenant

Operation ID: ApiServicesAppFriendshipCreatefriendshipforcurrenttenantPost

Tag: Friendship

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateFriendshipForCurrentTenantInput

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"userName": "string"

}

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: FriendDto

Response fields

|---|---|---:|---|---|

enum: 1, 2 |

Example response

`json

{

"result": {

"friendUserId": 0,

"friendTenantId": 0,

"friendUserName": "string"

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Friendship/CreateFriendshipForCurrentTenant" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"userName":"string"}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Friendship/CreateFriendshipForCurrentTenant"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"userName": "string"

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

CreateFriendshipRequest

Method: POST

Path: /api/services/app/Friendship/CreateFriendshipRequest

Operation ID: ApiServicesAppFriendshipCreatefriendshiprequestPost

Tag: Friendship

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateFriendshipRequestInput

Request body fields

|---|---|---:|---|---|

min: 1 |

Example request body

`json

{

"userId": 1,

"tenantId": 0

}

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: FriendDto

Response fields

|---|---|---:|---|---|

enum: 1, 2 |

Example response

`json

{

"result": {

"friendUserId": 0,

"friendTenantId": 0,

"friendUserName": "string"

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Friendship/CreateFriendshipRequest" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"userId":1,"tenantId":0}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Friendship/CreateFriendshipRequest"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"userId": 1,

"tenantId": 0

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

CreateFriendshipWithDifferentTenant

Method: POST

Path: /api/services/app/Friendship/CreateFriendshipWithDifferentTenant

Operation ID: ApiServicesAppFriendshipCreatefriendshipwithdifferenttenantPost

Tag: Friendship

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateFriendshipWithDifferentTenantInput

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"tenancyName": "string",

"userName": "string"

}

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: FriendDto

Response fields

|---|---|---:|---|---|

enum: 1, 2 |

Example response

`json

{

"result": {

"friendUserId": 0,

"friendTenantId": 0,

"friendUserName": "string"

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Friendship/CreateFriendshipWithDifferentTenant" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"tenancyName":"string","userName":"string"}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Friendship/CreateFriendshipWithDifferentTenant"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"tenancyName": "string",

"userName": "string"

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

RemoveFriend

Method: DELETE

Path: /api/services/app/Friendship/RemoveFriend

Operation ID: ApiServicesAppFriendshipRemovefriendDelete

Tag: Friendship

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

|---|---|---|---:|---|---|

min: 1 |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/Friendship/RemoveFriend?UserId=1&TenantId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Friendship/RemoveFriend?UserId=1&TenantId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

UnblockUser

Method: POST

Path: /api/services/app/Friendship/UnblockUser

Operation ID: ApiServicesAppFriendshipUnblockuserPost

Tag: Friendship

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: UnblockUserInput

Request body fields

|---|---|---:|---|---|

min: 1 |

Example request body

`json

{

"userId": 1,

"tenantId": 0

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Friendship/UnblockUser" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"userId":1,"tenantId":0}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Friendship/UnblockUser"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"userId": 1,

"tenantId": 0

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

GetAllPermissions

Method: GET

Path: /api/services/app/Permission/GetAllPermissions

Operation ID: ApiServicesAppPermissionGetallpermissionsGet

Tag: Permission

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: FlatPermissionWithLevelDtoListResultDto

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"items": [

{

"level": 0,

"parentName": "string",

"name": "string"

}

]

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Permission/GetAllPermissions" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Permission/GetAllPermissions"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

ChangeLanguage

Method: POST

Path: /api/services/app/Profile/ChangeLanguage

Operation ID: ApiServicesAppProfileChangelanguagePost

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: ChangeUserLanguageDto

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"languageName": "string"

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Profile/ChangeLanguage" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"languageName":"string"}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/ChangeLanguage"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"languageName": "string"

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

ChangePassword

Method: POST

Path: /api/services/app/Profile/ChangePassword

Operation ID: ApiServicesAppProfileChangepasswordPost

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: ChangePasswordInput

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"currentPassword": "string",

"newPassword": "string"

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Profile/ChangePassword" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"currentPassword":"string","newPassword":"string"}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/ChangePassword"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"currentPassword": "string",

"newPassword": "string"

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

DisableGoogleAuthenticator

Method: POST

Path: /api/services/app/Profile/DisableGoogleAuthenticator

Operation ID: ApiServicesAppProfileDisablegoogleauthenticatorPost

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: VerifyAuthenticatorCodeInput

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"code": "string",

"googleAuthenticatorKey": "string"

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Profile/DisableGoogleAuthenticator" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"code":"string","googleAuthenticatorKey":"string"}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/DisableGoogleAuthenticator"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"code": "string",

"googleAuthenticatorKey": "string"

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

GenerateGoogleAuthenticatorKey

Method: POST

Path: /api/services/app/Profile/GenerateGoogleAuthenticatorKey

Operation ID: ApiServicesAppProfileGenerategoogleauthenticatorkeyPost

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GenerateGoogleAuthenticatorKeyOutput

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"qrCodeSetupImageUrl": "https://example.com",

"googleAuthenticatorKey": "string"

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Profile/GenerateGoogleAuthenticatorKey" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/GenerateGoogleAuthenticatorKey"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

GetCurrentUserProfileForEdit

Method: GET

Path: /api/services/app/Profile/GetCurrentUserProfileForEdit

Operation ID: ApiServicesAppProfileGetcurrentuserprofileforeditGet

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: CurrentUserProfileEditDto

Response fields

|---|---|---:|---|---|

maxLength: 256 |

maxLength: 64 |

maxLength: 64 |

maxLength: 256 |

maxLength: 24 |

Example response

`json

{

"result": {

"emailAddress": "user@example.com",

"name": "string",

"surname": "string",

"userName": "string"

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Profile/GetCurrentUserProfileForEdit" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/GetCurrentUserProfileForEdit"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

GetFriendProfilePicture

Method: GET

Path: /api/services/app/Profile/GetFriendProfilePicture

Operation ID: ApiServicesAppProfileGetfriendprofilepictureGet

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

|---|---|---|---:|---|---|

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetProfilePictureOutput

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"profilePicture": "string"

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Profile/GetFriendProfilePicture?UserId=0&TenantId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/GetFriendProfilePicture?UserId=0&TenantId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

GetPasswordComplexitySetting

Method: GET

Path: /api/services/app/Profile/GetPasswordComplexitySetting

Operation ID: ApiServicesAppProfileGetpasswordcomplexitysettingGet

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetPasswordComplexitySettingOutput

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"setting": {

"allowedMinimumLength": 0,

"requireDigit": false,

"requireLowercase": false

}

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Profile/GetPasswordComplexitySetting" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/GetPasswordComplexitySetting"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

GetProfilePicture

Method: GET

Path: /api/services/app/Profile/GetProfilePicture

Operation ID: ApiServicesAppProfileGetprofilepictureGet

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetProfilePictureOutput

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"profilePicture": "string"

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Profile/GetProfilePicture" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/GetProfilePicture"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

GetProfilePictureByUser

Method: GET

Path: /api/services/app/Profile/GetProfilePictureByUser

Operation ID: ApiServicesAppProfileGetprofilepicturebyuserGet

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

|---|---|---|---:|---|---|

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetProfilePictureOutput

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"profilePicture": "string"

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Profile/GetProfilePictureByUser?userId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/GetProfilePictureByUser?userId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

GetProfilePictureByUserName

Method: GET

Path: /api/services/app/Profile/GetProfilePictureByUserName

Operation ID: ApiServicesAppProfileGetprofilepicturebyusernameGet

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

|---|---|---|---:|---|---|

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetProfilePictureOutput

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"profilePicture": "string"

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Profile/GetProfilePictureByUserName?username=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/GetProfilePictureByUserName?username=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

PrepareCollectedData

Method: POST

Path: /api/services/app/Profile/PrepareCollectedData

Operation ID: ApiServicesAppProfilePreparecollecteddataPost

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Profile/PrepareCollectedData" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/PrepareCollectedData"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

SendVerificationSms

Method: POST

Path: /api/services/app/Profile/SendVerificationSms

Operation ID: ApiServicesAppProfileSendverificationsmsPost

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: SendVerificationSmsInputDto

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"phoneNumber": "string"

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Profile/SendVerificationSms" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"phoneNumber":"string"}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/SendVerificationSms"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"phoneNumber": "string"

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

UpdateCurrentUserProfile

Method: PUT

Path: /api/services/app/Profile/UpdateCurrentUserProfile

Operation ID: ApiServicesAppProfileUpdatecurrentuserprofilePut

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CurrentUserProfileEditDto

Request body fields

|---|---|---:|---|---|

maxLength: 256 |

maxLength: 64 |

maxLength: 64 |

maxLength: 256 |

maxLength: 24 |

Example request body

`json

{

"emailAddress": "user@example.com",

"name": "string",

"surname": "string",

"userName": "string"

}

Response

None

Curl

`bash

curl -X PUT "https://public-api.loadgen.cloud/api/services/app/Profile/UpdateCurrentUserProfile" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"emailAddress":"user@example.com","name":"string","surname":"string","userName":"string"}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/UpdateCurrentUserProfile"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"emailAddress": "user@example.com",

"name": "string",

"surname": "string",

"userName": "string"

}

Invoke-RestMethod -Method PUT -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

UpdateGoogleAuthenticatorKey

Method: PUT

Path: /api/services/app/Profile/UpdateGoogleAuthenticatorKey

Operation ID: ApiServicesAppProfileUpdategoogleauthenticatorkeyPut

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: UpdateGoogleAuthenticatorKeyInput

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"googleAuthenticatorKey": "string",

"authenticatorCode": "string"

}

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: UpdateGoogleAuthenticatorKeyOutput

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"recoveryCodes": [

"string"

]

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X PUT "https://public-api.loadgen.cloud/api/services/app/Profile/UpdateGoogleAuthenticatorKey" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"googleAuthenticatorKey":"string","authenticatorCode":"string"}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/UpdateGoogleAuthenticatorKey"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"googleAuthenticatorKey": "string",

"authenticatorCode": "string"

}

Invoke-RestMethod -Method PUT -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

UpdateProfilePicture

Method: PUT

Path: /api/services/app/Profile/UpdateProfilePicture

Operation ID: ApiServicesAppProfileUpdateprofilepicturePut

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: UpdateProfilePictureInput

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"fileToken": "string",

"useGravatarProfilePicture": false,

"userId": 0

}

Response

None

Curl

`bash

curl -X PUT "https://public-api.loadgen.cloud/api/services/app/Profile/UpdateProfilePicture" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"fileToken":"string","useGravatarProfilePicture":false,"userId":0}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/UpdateProfilePicture"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"fileToken": "string",

"useGravatarProfilePicture": false,

"userId": 0

}

Invoke-RestMethod -Method PUT -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

VerifyAuthenticatorCode

Method: POST

Path: /api/services/app/Profile/VerifyAuthenticatorCode

Operation ID: ApiServicesAppProfileVerifyauthenticatorcodePost

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: VerifyAuthenticatorCodeInput

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"code": "string",

"googleAuthenticatorKey": "string"

}

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: boolean

Response fields

None

Example response

`json

{

"result": false,

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Profile/VerifyAuthenticatorCode" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"code":"string","googleAuthenticatorKey":"string"}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/VerifyAuthenticatorCode"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"code": "string",

"googleAuthenticatorKey": "string"

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

VerifySmsCode

Method: POST

Path: /api/services/app/Profile/VerifySmsCode

Operation ID: ApiServicesAppProfileVerifysmscodePost

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: VerifySmsCodeInputDto

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"code": "string",

"phoneNumber": "string"

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Profile/VerifySmsCode" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"code":"string","phoneNumber":"string"}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/VerifySmsCode"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"code": "string",

"phoneNumber": "string"

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

ViewRecoveryCodes

Method: POST

Path: /api/services/app/Profile/ViewRecoveryCodes

Operation ID: ApiServicesAppProfileViewrecoverycodesPost

Tag: Profile

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: VerifyAuthenticatorCodeInput

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"code": "string",

"googleAuthenticatorKey": "string"

}

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: UpdateGoogleAuthenticatorKeyOutput

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"recoveryCodes": [

"string"

]

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Profile/ViewRecoveryCodes" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"code":"string","googleAuthenticatorKey":"string"}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Profile/ViewRecoveryCodes"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"code": "string",

"googleAuthenticatorKey": "string"

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

CreateOrUpdateRole

Method: POST

Path: /api/services/app/Role/CreateOrUpdateRole

Operation ID: ApiServicesAppRoleCreateorupdaterolePost

Tag: Role

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrUpdateRoleInput

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"grantedPermissionNames": [

"string"

"role": {

"displayName": "string",

"id": 0,

"isDefault": false

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Role/CreateOrUpdateRole" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"grantedPermissionNames":["string"],"role":{"displayName":"string","id":0,"isDefault":false}}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Role/CreateOrUpdateRole"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"grantedPermissionNames": [

"string"

"role": {

"displayName": "string",

"id": 0,

"isDefault": false

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

DeleteRole

Method: DELETE

Path: /api/services/app/Role/DeleteRole

Operation ID: ApiServicesAppRoleDeleteroleDelete

Tag: Role

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

|---|---|---|---:|---|---|

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/Role/DeleteRole?Id=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Role/DeleteRole?Id=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

GetRoleForEdit

Method: GET

Path: /api/services/app/Role/GetRoleForEdit

Operation ID: ApiServicesAppRoleGetroleforeditGet

Tag: Role

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

|---|---|---|---:|---|---|

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetRoleForEditOutput

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"role": {

"displayName": "string",

"id": 0,

"isDefault": false

"permissions": [

{

"parentName": "string",

"name": "string",

"displayName": "string"

}

"grantedPermissionNames": [

"string"

]

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Role/GetRoleForEdit?Id=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Role/GetRoleForEdit?Id=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

GetRoles

Method: POST

Path: /api/services/app/Role/GetRoles

Operation ID: ApiServicesAppRoleGetrolesPost

Tag: Role

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: GetRolesInput

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"permissions": [

"string"

]

}

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: RoleListDtoListResultDto

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"items": [

{

"name": "string",

"displayName": "string",

"isStatic": false

}

]

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Role/GetRoles" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"permissions":["string"]}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Role/GetRoles"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"permissions": [

"string"

]

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

CreateOrUpdateUser

Method: POST

Path: /api/services/app/User/CreateOrUpdateUser

Operation ID: ApiServicesAppUserCreateorupdateuserPost

Tag: User

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrUpdateUserInput

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"assignedRoleNames": [

"string"

"user": {

"emailAddress": "user@example.com",

"name": "string",

"surname": "string"

"sendActivationEmail": false

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/User/CreateOrUpdateUser" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"assignedRoleNames":["string"],"user":{"emailAddress":"user@example.com","name":"string","surname":"string"},"sendActivationEmail":false}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/User/CreateOrUpdateUser"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"assignedRoleNames": [

"string"

"user": {

"emailAddress": "user@example.com",

"name": "string",

"surname": "string"

"sendActivationEmail": false

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

DeleteUser

Method: DELETE

Path: /api/services/app/User/DeleteUser

Operation ID: ApiServicesAppUserDeleteuserDelete

Tag: User

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

|---|---|---|---:|---|---|

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/User/DeleteUser?Id=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/User/DeleteUser?Id=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

GetUserForEdit

Method: GET

Path: /api/services/app/User/GetUserForEdit

Operation ID: ApiServicesAppUserGetuserforeditGet

Tag: User

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

|---|---|---|---:|---|---|

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetUserForEditOutput

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"profilePictureId": "00000000-0000-0000-0000-000000000000",

"user": {

"emailAddress": "user@example.com",

"name": "string",

"surname": "string"

"roles": [

{

"roleId": 0,

"roleName": "string",

"roleDisplayName": "string"

}

]

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/User/GetUserForEdit?Id=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/User/GetUserForEdit?Id=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

GetUserPermissionsForEdit

Method: GET

Path: /api/services/app/User/GetUserPermissionsForEdit

Operation ID: ApiServicesAppUserGetuserpermissionsforeditGet

Tag: User

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

|---|---|---|---:|---|---|

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetUserPermissionsForEditOutput

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"permissions": [

{

"parentName": "string",

"name": "string",

"displayName": "string"

}

"grantedPermissionNames": [

"string"

]

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/User/GetUserPermissionsForEdit?Id=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/User/GetUserPermissionsForEdit?Id=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

GetUsers

Method: POST

Path: /api/services/app/User/GetUsers

Operation ID: ApiServicesAppUserGetusersPost

Tag: User

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: GetUsersInput

Request body fields

|---|---|---:|---|---|

min: 1

max: 1000 |

min: 0

max: 2147483647 |

Example request body

`json

{

"filter": "string",

"permissions": [

"string"

"role": 0

}

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: UserListDtoPagedResultDto

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"name": "string",

"surname": "string",

"userName": "string"

}

]

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/User/GetUsers" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"filter":"string","permissions":["string"],"role":0}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/User/GetUsers"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"filter": "string",

"permissions": [

"string"

"role": 0

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

GetUsersToExcel

Method: GET

Path: /api/services/app/User/GetUsersToExcel

Operation ID: ApiServicesAppUserGetuserstoexcelGet

Tag: User

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

|---|---|---|---:|---|---|

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: FileDto

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"fileName": "string",

"fileToken": "string",

"fileType": "string"

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/User/GetUsersToExcel?Filter=string&Permissions=string&Role=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/User/GetUsersToExcel?Filter=string&Permissions=string&Role=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

ResetUserSpecificPermissions

Method: POST

Path: /api/services/app/User/ResetUserSpecificPermissions

Operation ID: ApiServicesAppUserResetuserspecificpermissionsPost

Tag: User

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: Int64EntityDto

Request body fields

|---|---|---:|---|---|

| id | integer (int64) | No | | format: int64 |

Example request body

`json

{

"id": 0

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/User/ResetUserSpecificPermissions" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"id":0}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/User/ResetUserSpecificPermissions"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"id": 0

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

UnlockUser

Method: POST

Path: /api/services/app/User/UnlockUser

Operation ID: ApiServicesAppUserUnlockuserPost

Tag: User

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: Int64EntityDto

Request body fields

|---|---|---:|---|---|

| id | integer (int64) | No | | format: int64 |

Example request body

`json

{

"id": 0

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/User/UnlockUser" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"id":0}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/User/UnlockUser"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"id": 0

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

UpdateUserPermissions

Method: PUT

Path: /api/services/app/User/UpdateUserPermissions

Operation ID: ApiServicesAppUserUpdateuserpermissionsPut

Tag: User

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: UpdateUserPermissionsInput

Request body fields

|---|---|---:|---|---|

| id | integer (int64) | No | | format: int64

min: 1

max: 2147483647 |

Example request body

`json

{

"grantedPermissionNames": [

"string"

"id": 1

}

Response

None

Curl

`bash

curl -X PUT "https://public-api.loadgen.cloud/api/services/app/User/UpdateUserPermissions" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"grantedPermissionNames":["string"],"id":1}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/User/UpdateUserPermissions"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"grantedPermissionNames": [

"string"

"id": 1

}

Invoke-RestMethod -Method PUT -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

DelegateNewUser

Method: POST

Path: /api/services/app/UserDelegation/DelegateNewUser

Operation ID: ApiServicesAppUserdelegationDelegatenewuserPost

Tag: UserDelegation

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateUserDelegationDto

Request body fields

|---|---|---:|---|---|

min: 1 |

Example request body

`json

{

"endTime": "2025-01-01T00:00:00Z",

"startTime": "2025-01-01T00:00:00Z",

"targetUserId": 1

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/UserDelegation/DelegateNewUser" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"endTime":"2025-01-01T00:00:00Z","startTime":"2025-01-01T00:00:00Z","targetUserId":1}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/UserDelegation/DelegateNewUser"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"endTime": "2025-01-01T00:00:00Z",

"startTime": "2025-01-01T00:00:00Z",

"targetUserId": 1

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

GetActiveUserDelegations

Method: GET

Path: /api/services/app/UserDelegation/GetActiveUserDelegations

Operation ID: ApiServicesAppUserdelegationGetactiveuserdelegationsGet

Tag: UserDelegation

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: array

Response fields

None

Example response

`json

{

"result": [

{

"username": "string",

"startTime": "2025-01-01T00:00:00Z",

"endTime": "2025-01-01T00:00:00Z"

}

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/UserDelegation/GetActiveUserDelegations" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/UserDelegation/GetActiveUserDelegations"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

GetDelegatedUsers

Method: GET

Path: /api/services/app/UserDelegation/GetDelegatedUsers

Operation ID: ApiServicesAppUserdelegationGetdelegatedusersGet

Tag: UserDelegation

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

|---|---|---|---:|---|---|

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: UserDelegationDtoPagedResultDto

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"username": "string",

"startTime": "2025-01-01T00:00:00Z",

"endTime": "2025-01-01T00:00:00Z"

}

]

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/UserDelegation/GetDelegatedUsers?MaxResultCount=0&SkipCount=0&Sorting=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/UserDelegation/GetDelegatedUsers?MaxResultCount=0&SkipCount=0&Sorting=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

RemoveDelegation

Method: DELETE

Path: /api/services/app/UserDelegation/RemoveDelegation

Operation ID: ApiServicesAppUserdelegationRemovedelegationDelete

Tag: UserDelegation

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

|---|---|---|---:|---|---|

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/UserDelegation/RemoveDelegation?Id=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/UserDelegation/RemoveDelegation?Id=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

GetLinkedUsers

Method: GET

Path: /api/services/app/UserLink/GetLinkedUsers

Operation ID: ApiServicesAppUserlinkGetlinkedusersGet

Tag: UserLink

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

|---|---|---|---:|---|---|

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: LinkedUserDtoPagedResultDto

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"tenantId": 0,

"tenancyName": "string",

"username": "string"

}

]

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/UserLink/GetLinkedUsers?MaxResultCount=0&SkipCount=0&Sorting=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/UserLink/GetLinkedUsers?MaxResultCount=0&SkipCount=0&Sorting=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

GetRecentlyUsedLinkedUsers

Method: GET

Path: /api/services/app/UserLink/GetRecentlyUsedLinkedUsers

Operation ID: ApiServicesAppUserlinkGetrecentlyusedlinkedusersGet

Tag: UserLink

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: LinkedUserDtoListResultDto

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"items": [

{

"tenantId": 0,

"tenancyName": "string",

"username": "string"

}

]

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/UserLink/GetRecentlyUsedLinkedUsers" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/UserLink/GetRecentlyUsedLinkedUsers"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

LinkToUser

Method: POST

Path: /api/services/app/UserLink/LinkToUser

Operation ID: ApiServicesAppUserlinkLinktouserPost

Tag: UserLink

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: LinkToUserInput

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"password": "string",

"usernameOrEmailAddress": "user@example.com",

"tenancyName": "string"

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/UserLink/LinkToUser" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"password":"string","usernameOrEmailAddress":"user@example.com","tenancyName":"string"}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/UserLink/LinkToUser"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"password": "string",

"usernameOrEmailAddress": "user@example.com",

"tenancyName": "string"

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

UnlinkUser

Method: POST

Path: /api/services/app/UserLink/UnlinkUser

Operation ID: ApiServicesAppUserlinkUnlinkuserPost

Tag: UserLink

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: UnlinkUserInput

Request body fields

|---|---|---:|---|---|

Example request body

`json

{

"tenantId": 0,

"userId": 0

}

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/UserLink/UnlinkUser" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"tenantId":0,"userId":0}'

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/UserLink/UnlinkUser"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"tenantId": 0,

"userId": 0

}

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

GetUserLoginAttempts

Method: GET

Path: /api/services/app/UserLogin/GetUserLoginAttempts

Operation ID: ApiServicesAppUserloginGetuserloginattemptsGet

Tag: UserLogin

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

|---|---|---|---:|---|---|

| Result | query | enum(1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11) | No | | format: int32

enum: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 |

min: 1

max: 1000 |

min: 0

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

The actual payload is usually under the result property.
Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: UserLoginAttemptDtoPagedResultDto

Response fields

|---|---|---:|---|---|

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"tenancyName": "string",

"userNameOrEmail": "user@example.com",

"clientIpAddress": "string"

}

]

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/UserLogin/GetUserLoginAttempts?Filter=string&StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/UserLogin/GetUserLoginAttempts?Filter=string&StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers