Skip to main content
GET
/
scenarios
/
{scenario_id}
/
access
Check scenario access
curl --request GET \
  --url https://api.exec.com/rest/v1/scenarios/{scenario_id}/access \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.exec.com/rest/v1/scenarios/{scenario_id}/access"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.exec.com/rest/v1/scenarios/{scenario_id}/access', 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.exec.com/rest/v1/scenarios/{scenario_id}/access",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$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.exec.com/rest/v1/scenarios/{scenario_id}/access"

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

req.Header.Add("Authorization", "Bearer <token>")

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.exec.com/rest/v1/scenarios/{scenario_id}/access")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.exec.com/rest/v1/scenarios/{scenario_id}/access")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "user_email": "[email protected]",
  "scenario_id": "s1c2e3n4a5r6",
  "permissions": {
    "can_view": true,
    "can_share": true,
    "can_monitor": false,
    "can_edit": false
  }
}
{
"error": {
"type": "invalid_request",
"code": "invalid_pagination",
"message": "Invalid pagination parameters"
}
}
{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "Invalid or inactive API key"
}
}
{
"error": {
"type": "not_found",
"message": "Scenario not found: abc123"
}
}

Authorizations

Authorization
string
header
required

API key created in Settings > API.

Format: exec_live_ followed by 40 alphanumeric characters.

Path Parameters

scenario_id
string
required

Scenario identifier

Query Parameters

user_email
string<email>
required

Email of the user to check access for

Response

User's permission levels for the scenario

user_email
string<email>

Email of the user checked

scenario_id
string

Scenario identifier

permissions
object