User Controller

get
Authorizations
Path parameters
usernamestringRequired
Responses
200
OK
*/*
get
GET /api/users/{username}/default-space HTTP/1.1
Host: inscada.cloud
Accept: */*
{
  "creationDate": "2025-07-05T18:19:47.031Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:19:47.031Z",
  "id": "text",
  "name": "text"
}
put
Authorizations
Path parameters
usernamestringRequired
Body
stringOptional
Responses
204
No Content
put
PUT /api/users/{username}/default-space HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

No content

get
Authorizations
Path parameters
userIdstringRequired
Responses
200
OK
*/*
get
GET /api/users/{userId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
  "creationDate": "2025-07-05T18:19:47.031Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:19:47.031Z",
  "id": "text",
  "phone": "text",
  "username": "text",
  "requirePasswordReset": true,
  "otpType": "none",
  "eulaAccepted": true,
  "email": "text"
}
put
Authorizations
Path parameters
userIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
phonestring · max: 15Optional
usernamestring · max: 50Required
passwordstring · max: 60Write-onlyOptional
requirePasswordResetbooleanRequired
otpTypestring · enumOptionalPossible values:
eulaAcceptedbooleanOptional
emailstring · max: 255Optional
Responses
204
No Content
put
PUT /api/users/{userId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "id": "text",
  "phone": "text",
  "username": "text",
  "password": "text",
  "requirePasswordReset": true,
  "otpType": "none",
  "eulaAccepted": true,
  "email": "text"
}

No content

delete
Authorizations
Path parameters
userIdstringRequired
Responses
204
No Content
delete
DELETE /api/users/{userId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content

get
Authorizations
Responses
200
OK
*/*
Responsestring
get
GET /api/users/ui-configs HTTP/1.1
Host: inscada.cloud
Accept: */*
text
put
Authorizations
Body
stringOptional
Responses
200
OK
put
PUT /api/users/ui-configs HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

No content

get
Authorizations
Responses
200
OK
*/*
get
GET /api/users/default-space HTTP/1.1
Host: inscada.cloud
Accept: */*
{
  "creationDate": "2025-07-05T18:19:47.031Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:19:47.031Z",
  "id": "text",
  "name": "text"
}
put
Authorizations
Body
stringOptional
Responses
204
No Content
put
PUT /api/users/default-space HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

No content

put
Authorizations
Responses
204
No Content
put
PUT /api/users/agree HTTP/1.1
Host: inscada.cloud
Accept: */*

No content

get
Authorizations
Responses
200
OK
*/*
get
GET /api/users HTTP/1.1
Host: inscada.cloud
Accept: */*
[
  {
    "creationDate": "2025-07-05T18:19:47.031Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T18:19:47.031Z",
    "id": "text",
    "phone": "text",
    "username": "text",
    "requirePasswordReset": true,
    "otpType": "none",
    "eulaAccepted": true,
    "email": "text"
  }
]
post
Authorizations
Body
emailstring · max: 255Optional
requirePasswordResetbooleanRequired
phonestring · max: 15Optional
usernamestring · max: 50Required
passwordstring · max: 60Write-onlyOptional
otpTypestring · enumOptionalPossible values:
Responses
200
OK
*/*
post
POST /api/users HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "email": "text",
  "requirePasswordReset": true,
  "phone": "text",
  "username": "text",
  "password": "text",
  "otpType": "none"
}
{
  "creationDate": "2025-07-05T18:19:47.031Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:19:47.031Z",
  "id": "text",
  "phone": "text",
  "username": "text",
  "requirePasswordReset": true,
  "otpType": "none",
  "eulaAccepted": true,
  "email": "text"
}
post
Authorizations
Path parameters
usernamestringRequired
Body
requirePasswordResetbooleanOptional
oldPasswordstringOptional
newPasswordstringRequired
newPasswordAgainstringRequired
Responses
204
No Content
post
POST /api/users/{username}/reset-password HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "requirePasswordReset": true,
  "oldPassword": "text",
  "newPassword": "text",
  "newPasswordAgain": "text"
}

No content

get
Authorizations
Path parameters
userIdstringRequired
Responses
200
OK
*/*
get
GET /api/users/{userId}/spaces HTTP/1.1
Host: inscada.cloud
Accept: */*
[
  {
    "creationDate": "2025-07-05T18:19:47.031Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T18:19:47.031Z",
    "id": "text",
    "name": "text"
  }
]
post
Authorizations
Path parameters
userIdstringRequired
Body
stringOptional
Responses
200
OK
*/*
post
POST /api/users/{userId}/spaces HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
{
  "creationDate": "2025-07-05T18:19:47.031Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:19:47.031Z",
  "id": "text",
  "name": "text"
}
get
Authorizations
Path parameters
userIdstringRequired
Responses
200
OK
*/*
get
GET /api/users/{userId}/roles HTTP/1.1
Host: inscada.cloud
Accept: */*
[
  {
    "creationDate": "2025-07-05T18:19:47.031Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T18:19:47.031Z",
    "id": "text",
    "name": "text"
  }
]
post
Authorizations
Path parameters
userIdstringRequired
Body
stringOptional
Responses
200
OK
*/*
post
POST /api/users/{userId}/roles HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
{
  "creationDate": "2025-07-05T18:19:47.031Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:19:47.031Z",
  "id": "text",
  "name": "text"
}
post
Authorizations
Body
requirePasswordResetbooleanOptional
oldPasswordstringOptional
newPasswordstringRequired
newPasswordAgainstringRequired
Responses
204
No Content
post
POST /api/users/reset-password HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "requirePasswordReset": true,
  "oldPassword": "text",
  "newPassword": "text",
  "newPasswordAgain": "text"
}

No content

get
Authorizations
Path parameters
userIdstringRequired
spaceIdstringRequired
Responses
200
OK
*/*
get
GET /api/users/{userId}/spaces/{spaceId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
  "creationDate": "2025-07-05T18:19:47.031Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:19:47.031Z",
  "id": "text",
  "name": "text"
}
delete
Authorizations
Path parameters
userIdstringRequired
spaceIdstringRequired
Responses
204
No Content
delete
DELETE /api/users/{userId}/spaces/{spaceId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content

get
Authorizations
Path parameters
userIdstringRequired
roleIdstringRequired
Responses
200
OK
*/*
get
GET /api/users/{userId}/roles/{roleId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
  "creationDate": "2025-07-05T18:19:47.031Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:19:47.031Z",
  "id": "text",
  "name": "text"
}
delete
Authorizations
Path parameters
userIdstringRequired
roleIdstringRequired
Responses
204
No Content
delete
DELETE /api/users/{userId}/roles/{roleId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content

get
Authorizations
Responses
200
OK
*/*
Responsestring[]
get
GET /api/users/by-active-space HTTP/1.1
Host: inscada.cloud
Accept: */*
[
  "text"
]
delete
Authorizations
Query parameters
userIdsstring[]Required
Responses
204
No Content
delete
DELETE /api/users/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

No content