User Controller

get

Authorizations

Path parameters

usernamestringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/users/{username}/default-space

GET /api/users/{username}/default-space HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "creationDate": "2025-11-01T06:30:19.390Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-11-01T06:30:19.390Z",
  "id": "text",
  "name": "text"
}

put

Authorizations

Path parameters

usernamestringRequired

Body

stringOptional

Responses

204

No Content

No content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

put

/api/users/{username}/default-space

PUT /api/users/{username}/default-space HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

No content

get

Authorizations

Path parameters

userIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/users/{userId}

GET /api/users/{userId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "creationDate": "2025-11-01T06:30:19.390Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-11-01T06:30:19.390Z",
  "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

No content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

put

/api/users/{userId}

PUT /api/users/{userId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
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

No content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/users/{userId}

DELETE /api/users/{userId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

get

Authorizations

Responses

200

OK

*/*

Responsestring

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/users/ui-configs

GET /api/users/ui-configs HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

text

put

Authorizations

Body

stringOptional

Responses

200

OK

No content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

put

/api/users/ui-configs

PUT /api/users/ui-configs HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

No content

get

Authorizations

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/users/default-space

GET /api/users/default-space HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "creationDate": "2025-11-01T06:30:19.390Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-11-01T06:30:19.390Z",
  "id": "text",
  "name": "text"
}

put

Authorizations

Body

stringOptional

Responses

204

No Content

No content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

put

/api/users/default-space

PUT /api/users/default-space HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

No content

put

Authorizations

Responses

204

No Content

No content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

put

/api/users/agree

PUT /api/users/agree HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

get

Authorizations

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/users

GET /api/users HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "creationDate": "2025-11-01T06:30:19.390Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-11-01T06:30:19.390Z",
    "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

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/users

POST /api/users HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 112

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

{
  "creationDate": "2025-11-01T06:30:19.390Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-11-01T06:30:19.390Z",
  "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

No content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/users/{username}/reset-password

POST /api/users/{username}/reset-password HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
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

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/users/{userId}/spaces

GET /api/users/{userId}/spaces HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "creationDate": "2025-11-01T06:30:19.390Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-11-01T06:30:19.390Z",
    "id": "text",
    "name": "text"
  }
]

post

Authorizations

Path parameters

userIdstringRequired

Body

stringOptional

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/users/{userId}/spaces

POST /api/users/{userId}/spaces HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

{
  "creationDate": "2025-11-01T06:30:19.390Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-11-01T06:30:19.390Z",
  "id": "text",
  "name": "text"
}

get

Authorizations

Path parameters

userIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/users/{userId}/roles

GET /api/users/{userId}/roles HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "creationDate": "2025-11-01T06:30:19.390Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-11-01T06:30:19.390Z",
    "id": "text",
    "name": "text"
  }
]

post

Authorizations

Path parameters

userIdstringRequired

Body

stringOptional

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/users/{userId}/roles

POST /api/users/{userId}/roles HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

{
  "creationDate": "2025-11-01T06:30:19.390Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-11-01T06:30:19.390Z",
  "id": "text",
  "name": "text"
}

post

Authorizations

Body

requirePasswordResetbooleanOptional

oldPasswordstringOptional

newPasswordstringRequired

newPasswordAgainstringRequired

Responses

204

No Content

No content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/users/reset-password

POST /api/users/reset-password HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
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

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/users/{userId}/spaces/{spaceId}

GET /api/users/{userId}/spaces/{spaceId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "creationDate": "2025-11-01T06:30:19.390Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-11-01T06:30:19.390Z",
  "id": "text",
  "name": "text"
}

delete

Authorizations

Path parameters

userIdstringRequired

spaceIdstringRequired

Responses

204

No Content

No content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/users/{userId}/spaces/{spaceId}

DELETE /api/users/{userId}/spaces/{spaceId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

get

Authorizations

Path parameters

userIdstringRequired

roleIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/users/{userId}/roles/{roleId}

GET /api/users/{userId}/roles/{roleId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "creationDate": "2025-11-01T06:30:19.390Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-11-01T06:30:19.390Z",
  "id": "text",
  "name": "text"
}

delete

Authorizations

Path parameters

userIdstringRequired

roleIdstringRequired

Responses

204

No Content

No content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/users/{userId}/roles/{roleId}

DELETE /api/users/{userId}/roles/{roleId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

get

Authorizations

Responses

200

OK

*/*

Responsestring[]

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/users/by-active-space

GET /api/users/by-active-space HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  "text"
]

delete

Authorizations

Query parameters

userIdsstring[]Required

Responses

204

No Content

No content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/users/multi/by-ids

DELETE /api/users/multi/by-ids?userIds=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content