MobiusFlow Website

Users

Get a list of MobiusFlow Engine API users

get
Responses
200

Default Response

application/json
get
/api/engine/v3/user/
GET /api/engine/v3/user/ HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "username": "text",
    "email": "text",
    "isActive": true,
    "roles": [
      "Administrator"
    ]
  }
]

Add a new MobiusFlow Engine API user

post
Body
usernamestringRequired
passwordstringRequired
emailstring · emailOptionalPattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Responses
post
/api/engine/v3/user/
POST /api/engine/v3/user/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "username": "text",
  "password": "text",
  "roles": [
    "Administrator"
  ],
  "email": "[email protected]"
}
{
  "id": "text",
  "username": "text",
  "email": "text",
  "isActive": true,
  "roles": [
    "Administrator"
  ]
}

Delete a MobiusFlow Engine API user

delete
Path parameters
idstringRequired

The id of the user to delete

Responses
200

Default Response

application/json
delete
/api/engine/v3/user/{id}
DELETE /api/engine/v3/user/{id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "text"
}

Update the password of a MobiusFlow Engine API user

patch
Path parameters
idstringRequired

The id of the user to update

Body
passwordstringRequired

The new password of the user

Responses
200

Default Response

application/json
patch
/api/engine/v3/user/password/{id}
PATCH /api/engine/v3/user/password/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "password": "text"
}
{
  "message": "text"
}

Update the active status of a MobiusFlow Engine API user

patch
Path parameters
idstringRequired

The id of the user to update

Body
activebooleanRequired

The new active status of the user

Responses
200

Default Response

application/json
patch
/api/engine/v3/user/active/{id}
PATCH /api/engine/v3/user/active/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "active": true
}
{
  "message": "text"
}

Update the role of a MobiusFlow Engine API user

patch
Path parameters
idstringRequired

The id of the user to update

Body
rolestring · enumRequired

The new role of the user

Possible values:
Responses
200

Default Response

application/json
patch
/api/engine/v3/user/role/{id}
PATCH /api/engine/v3/user/role/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "role": "Administrator"
}
{
  "message": "text"
}
PreviousObjectsNextCommands

Last updated

Was this helpful?