[GET] List Available Roles

Use this request to retrieve the list of roles that can be assigned to external users when inviting them to join the current tenant or workspace.

Available Roles

GET/api/v1.0/external/tenant/availableroles

Example Request

curl -X 'GET' \
  'https://cloud.smartdocumentor.net/api/v1.0/external/tenant/availableroles' \
  --header 'Authorization: Bearer {your access token here}' \
  --header 'accept: application/json'

var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://cloud.smartdocumentor.net/api/v1.0/external/tenant/availableroles");
request.Headers.Add("Authorization", "Bearer {your access token here}");
request.Headers.Add("Accept", "application/json");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();

Console.WriteLine(await response.Content.ReadAsStringAsync());

import requests

url = "https://cloud.smartdocumentor.net/api/v1.0/external/tenant/availableroles"

headers = {
    'Authorization': 'Bearer {your access token here}',
    'Accept': 'application/json'
}

response = requests.get(url, headers=headers)

print(response.text)

const myHeaders = new Headers();
myHeaders.append("Authorization", `Bearer {your access token here}`);
myHeaders.append("Accept", "application/json");

const requestOptions = {
    method: 'GET',
    headers: myHeaders
};

fetch("https://cloud.smartdocumentor.net/api/v1.0/external/tenant/availableroles", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Responses

[
  {
    "name": "Administrator"
  },
  {
    "name": "Manager"
  },
  {
    "name": "Creator"
  },
  {
    "name": "Reviewer"
  },
  {
    "name": "Viewer"
  }
]

Response Body `List<AvailableRolesViewModel>`

Response Body `AvailableRolesViewModel`

Name

Type

Description

name

string

Name of the role. This is the value that must be used when inviting a user. Example: Administrator

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "A server error occurred while processing your request. Please try again later. Trace ID:"
}

Response Body Problem Detail JSON Object

PreviousInvite Users NextTenants

Last updated 8 months ago

hashtagAvailable Roles

hashtagExample Request

hashtagResponses

hashtagResponse Body List<AvailableRolesViewModel>

hashtagResponse Body AvailableRolesViewModel

hashtagResponse Body Problem Detail JSON Objectarrow-up-right