Get role - Lucidworks documentation

Admin

Apps Manager

Async Parsing

Connectors

Indexing

Job Config

Job Launcher

Job Rest Server

ML Model Service

Proxy

Query

Templating

Get role

import requests

url = "https://{FUSION HOST}/api/roles/{id}"

response = requests.get(url)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://{FUSION HOST}/api/roles/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{FUSION HOST}/api/roles/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{FUSION HOST}/api/roles/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "e4ac80c6-8905-4eaf-9670-b541b41f732e",
  "name": "test-role",
  "createdAt": "2025-10-31T18:12:59Z",
  "desc": "For testing only",
  "permissions": [
    {
      "methods": [
        "OPTIONS",
        "GET"
      ],
      "path": "/"
    }
  ],
  "uiPermissions": []
}

GET

roles

{id}

Get role

import requests

url = "https://{FUSION HOST}/api/roles/{id}"

response = requests.get(url)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://{FUSION HOST}/api/roles/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{FUSION HOST}/api/roles/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{FUSION HOST}/api/roles/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "e4ac80c6-8905-4eaf-9670-b541b41f732e",
  "name": "test-role",
  "createdAt": "2025-10-31T18:12:59Z",
  "desc": "For testing only",
  "permissions": [
    {
      "methods": [
        "OPTIONS",
        "GET"
      ],
      "path": "/"
    }
  ],
  "uiPermissions": []
}

Path Parameters

string

required

The role ID. Note that the role ID is different than the role name. Use GET /roles to get the list of role IDs.

Response

name

string

required

string

createdAt

string<date-time>

Example:

"2025-09-23T17:48:07Z"

updatedAt

string<date-time>

Example:

"2025-10-31T12:28:04Z"

desc

string

permissions

object[]

Show child attributes

uiPermissions

string[]