Users

post__users_create

Code samples

POST /users/create HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /users/create

Creating another user that can view and manage S1.

Body parameter

{
  "Name": "string",
  "Password": "string",
  "Role": "string",
  "Email": "string"
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	UserElementCreate	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

delete__users_delete

Code samples

DELETE /users/delete HTTP/1.1

Accept: application/json

DELETE /users/delete

Delete user.

Parameters

Name	In	Type	Required	Description
name	query	string	false	The user name to delete.
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__users_edit

Code samples

PUT /users/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /users/edit

Edit a user.

Body parameter

{
  "Role": "string",
  "Password": "string",
  "Email": "string"
}

Parameters

Name	In	Type	Required	Description
name	query	string	false	none
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	UserElementEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__users_list

Code samples

GET /users/list HTTP/1.1

Accept: application/json

GET /users/list

List all available users.

Parameters

Name	In	Type	Required	Description
name	query	string	false	Filter users by name.
role	query	string	false	Filter by permissions.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "Password": "string",
      "Email": "string",
      "TwoStepAuthenticationEnabled": true,
      "Role": "string"
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	UserElementApiResult
400	Bad Request	Bad Request	string