Get Role

curl --request GET \
  --url https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}

import requests

url = "https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}",
  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;
}

package main

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

func main() {

	url := "https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}"

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}")

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

GET

app

organizations

{organizationId}

roles

{roleId}

Get Role

curl --request GET \
  --url https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}

import requests

url = "https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}",
  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;
}

package main

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

func main() {

	url := "https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}"

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}")

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

Path Parameters

organizationId

string

required

Organization ID

roleId

string

required

Role ID

Response

Returns the Role object.

{
  "id": "role123",
  "name": "editor",
  "description": "Content management with publishing rights",
  "permissions": {
    "organizations": {
      "read": true,
      "update": false,
      "delete": false
    },
    "projects": {
      "create": false,
      "read": true,
      "update": false,
      "delete": false
    },
    "users": {
      "create": false,
      "read": false,
      "update": false,
      "delete": false
    },
    "roles": {
      "create": false,
      "read": false,
      "update": false,
      "delete": false
    },
    "apiKeys": {
      "create": false,
      "read": false,
      "update": false,
      "delete": false
    },
    "components": {
      "create": false,
      "read": true,
      "update": false,
      "delete": false
    },
    "packages": {
      "create": false,
      "read": true,
      "update": false,
      "delete": false
    },
    "contentTypes": {
      "create": false,
      "read": true,
      "update": false,
      "publish": false,
      "delete": false
    },
    "content": {
      "create": true,
      "read": true,
      "update": true,
      "publish": true,
      "delete": true
    },
    "assets": {
      "create": true,
      "read": true,
      "update": true,
      "delete": true
    }
  },
  "createdAt": "2024-03-20T10:00:00Z",
  "updatedAt": "2024-03-20T10:00:00Z"
}

Error Responses

Role Not Found

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Role not found"
  }
}

Code Examples

curl -X GET "https://api.metabind.ai/app/v1/organizations/org123/roles/role123" \
  -H "Authorization: Bearer YOUR_JWT"

const response = await fetch(
  'https://api.metabind.ai/app/v1/organizations/org123/roles/role123',
  {
    headers: {
      'Authorization': 'Bearer YOUR_JWT'
    }
  }
);

const role = await response.json();
console.log(`Role: ${role.name}`);

let url = URL(string: "https://api.metabind.ai/app/v1/organizations/org123/roles/role123")!
var request = URLRequest(url: url)
request.setValue("Bearer YOUR_JWT", forHTTPHeaderField: "Authorization")

let (data, _) = try await URLSession.shared.data(for: request)
let role = try JSONDecoder().decode(Role.self, from: data)

val response = client.get("https://api.metabind.ai/app/v1/organizations/org123/roles/role123") {
    header("Authorization", "Bearer YOUR_JWT")
}

val role = response.body<Role>()
println("Role: ${role.name}")

Create Role Update Role

​Path Parameters

​Response

​Error Responses

​Role Not Found

​Code Examples

Path Parameters

Response

Error Responses

Role Not Found

Code Examples