List Roles

GET/lokta-lms/api/v1/roles

Example Requests:

roles

roles?fields=name

Responses

200OK

Response fields

descriptionstring · optional

idinteger · int64 · optional

namestring · 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.

Request

curl -X GET \
  'http://localhost:8080/lokta-lms/api/v1/roles' \
  -u '{username}:{password}' \
  -H 'Tenant-Identifier: default'

import requests

response = requests.get(
    "http://localhost:8080/lokta-lms/api/v1/roles",
    auth=("{username}", "{password}"),
    headers={"Tenant-Identifier": "default"},
)
print(response.json())

const response = await fetch("http://localhost:8080/lokta-lms/api/v1/roles", {
  method: "GET",
  headers: {
    Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"),
    "Tenant-Identifier": "default",
  },
});
console.log(await response.json());

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("http://localhost:8080/lokta-lms/api/v1/roles"))
    .header("Authorization", "Basic "
        + Base64.getEncoder().encodeToString("{username}:{password}".getBytes()))
    .header("Tenant-Identifier", "default")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

req, _ := http.NewRequest("GET", "http://localhost:8080/lokta-lms/api/v1/roles", nil)
req.SetBasicAuth("{username}", "{password}")
req.Header.Set("Tenant-Identifier", "default")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
data, _ := io.ReadAll(res.Body)
fmt.Println(string(data))

Response200

[
  {
    "description": "This role provides all application permissions.",
    "id": 1,
    "name": "Super Users"
  }
]