cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/settings/roles/201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.roles.get_settings_role("201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d")
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.roles.getSettingsRole('201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->roles->getSettingsRole('201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d');
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.roles.roles_dto.RolesDto.SettingsRole;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<SettingsRole> response = client.roles().getSettingsRole("201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Roles.GetSettingsRoleAsync("201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.roles.getSettingsRole(
'201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Roles().GetSettingsRole(context.Background(), "201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"role": {
"created_by": "<unknown>",
"created_on": "<string>",
"description": "<unknown>",
"display_name": "<string>",
"href": "<string>",
"id": "<string>",
"is_system_role": true,
"last_updated_by": "<unknown>",
"last_updated_on": "<string>",
"name": "<string>",
"object": "<string>",
"status": "<string>"
}
}Roles
Retrieve a role
Returns one role by its id, under role.
GET
/
settings
/
roles
/
{role_id}
cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/settings/roles/201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.roles.get_settings_role("201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d")
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.roles.getSettingsRole('201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->roles->getSettingsRole('201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d');
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.roles.roles_dto.RolesDto.SettingsRole;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<SettingsRole> response = client.roles().getSettingsRole("201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Roles.GetSettingsRoleAsync("201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.roles.getSettingsRole(
'201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Roles().GetSettingsRole(context.Background(), "201b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"role": {
"created_by": "<unknown>",
"created_on": "<string>",
"description": "<unknown>",
"display_name": "<string>",
"href": "<string>",
"id": "<string>",
"is_system_role": true,
"last_updated_by": "<unknown>",
"last_updated_on": "<string>",
"name": "<string>",
"object": "<string>",
"status": "<string>"
}
}Reads the role with this
id.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set
host to your Exsited API host name and paste an access token from Get an access token.