Create a User

POST/lokta-lms/api/v1/users

Adds new application user.

Note: Password information is not required (or processed). Password details at present are auto-generated and then sent to the email account given (which is why it can take a few seconds to complete).

Mandatory Fields:
username, firstname, lastname, email, officeId, roles, sendPasswordToEmail

Optional Fields:
staffId,passwordNeverExpires,isLoginRetriesEnabled

Request body application/json

clientsarray · optional

emailstring · optional

firstnamestring · optional

isLoginRetriesEnabledboolean · optional

isPasswordResetAllowedboolean · optional

lastnamestring · optional

officeIdinteger · int64 · optional

passwordstring · optional

passwordNeverExpiresboolean · optional

repeatPasswordstring · optional

rolesarray · optional

sendPasswordToEmailboolean · optional

staffIdinteger · int64 · optional

usernamestring · optional

Responses

200OK

Response fields

officeIdinteger · int64 · optional

resourceIdinteger · int64 · optional

Every request authenticates with HTTP Basic and carries a Tenant-Identifier header. See the conventions for dates, commands, pagination and errors. Open this operation in the interactive explorer, or read it as Markdown.

curl -X POST \ 'http://localhost:8080/lokta-lms/api/v1/users' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default' \ -H 'Content-Type: application/json' \ -d '{ "clients": [ 2, 3 ], "email": "[email protected]", "firstname": "Test", "isLoginRetriesEnabled": true, "isPasswordResetAllowed": true, "lastname": "User", "officeId": 1, "password": "password", "passwordNeverExpires": true, "repeatPassword": "repeatPassword" }'

import requests response = requests.post( "http://localhost:8080/lokta-lms/api/v1/users", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, json={ "clients": [ 2, 3 ], "email": "[email protected]", "firstname": "Test", "isLoginRetriesEnabled": True, "isPasswordResetAllowed": True, "lastname": "User", "officeId": 1, "password": "password", "passwordNeverExpires": True, "repeatPassword": "repeatPassword" }, ) print(response.json())

const response = await fetch("http://localhost:8080/lokta-lms/api/v1/users", { method: "POST", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", "Content-Type": "application/json", }, body: JSON.stringify({ "clients": [ 2, 3 ], "email": "[email protected]", "firstname": "Test", "isLoginRetriesEnabled": true, "isPasswordResetAllowed": true, "lastname": "User", "officeId": 1, "password": "password", "passwordNeverExpires": true, "repeatPassword": "repeatPassword" }), }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("http://localhost:8080/lokta-lms/api/v1/users")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(""" { "clients": [ 2, 3 ], "email": "[email protected]", "firstname": "Test", "isLoginRetriesEnabled": true, "isPasswordResetAllowed": true, "lastname": "User", "officeId": 1, "password": "password", "passwordNeverExpires": true, "repeatPassword": "repeatPassword" } """)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

payload := strings.NewReader(`{ "clients": [ 2, 3 ], "email": "[email protected]", "firstname": "Test", "isLoginRetriesEnabled": true, "isPasswordResetAllowed": true, "lastname": "User", "officeId": 1, "password": "password", "passwordNeverExpires": true, "repeatPassword": "repeatPassword" }`) req, _ := http.NewRequest("POST", "http://localhost:8080/lokta-lms/api/v1/users", payload) req.SetBasicAuth("{username}", "{password}") req.Header.Set("Tenant-Identifier", "default") req.Header.Set("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(string(data))