Get resource by ID
curl --request GET \
--url https://api.opal.dev/v1/resources/{resource_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.opal.dev/v1/resources/{resource_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.opal.dev/v1/resources/{resource_id}', 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.opal.dev/v1/resources/{resource_id}",
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.opal.dev/v1/resources/{resource_id}"
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.opal.dev/v1/resources/{resource_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opal.dev/v1/resources/{resource_id}")
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{
"resource_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
"app_id": "b5a5ca27-0ea3-4d86-9199-2126d57d1fbd",
"description": "This resource represents AWS IAM role \"SupportUser\".",
"admin_owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
"remote_id": 318038399,
"remote_name": "repo-name",
"max_duration": 120,
"require_manager_approval": false,
"require_support_ticket": false,
"parent_resource_id": "f454d283-ca67-4a8a-bdbb-df212eca5345",
"ancestor_resource_ids": [
"f454d283-ca67-4a8a-bdbb-df212eca5345"
],
"descendant_resource_ids": [
"f454d283-ca67-4a8a-bdbb-df212eca5345"
]
}Get resource by ID
Retrieves a resource.
GET
/
resources
/
{resource_id}
Get resource by ID
curl --request GET \
--url https://api.opal.dev/v1/resources/{resource_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.opal.dev/v1/resources/{resource_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.opal.dev/v1/resources/{resource_id}', 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.opal.dev/v1/resources/{resource_id}",
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.opal.dev/v1/resources/{resource_id}"
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.opal.dev/v1/resources/{resource_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opal.dev/v1/resources/{resource_id}")
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{
"resource_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
"app_id": "b5a5ca27-0ea3-4d86-9199-2126d57d1fbd",
"description": "This resource represents AWS IAM role \"SupportUser\".",
"admin_owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
"remote_id": 318038399,
"remote_name": "repo-name",
"max_duration": 120,
"require_manager_approval": false,
"require_support_ticket": false,
"parent_resource_id": "f454d283-ca67-4a8a-bdbb-df212eca5345",
"ancestor_resource_ids": [
"f454d283-ca67-4a8a-bdbb-df212eca5345"
],
"descendant_resource_ids": [
"f454d283-ca67-4a8a-bdbb-df212eca5345"
]
}Authorizations
Response
200 - application/json
The requested resource.
Resource Object
Description
The Resource object is used to represent a resource.
Usage Example
Update from the UPDATE Resources endpoint.
The type of the resource.
Available options:
AWS_IAM_ROLE, AWS_EC2_INSTANCE, AWS_EKS_CLUSTER, AWS_RDS_POSTGRES_CLUSTER, AWS_RDS_POSTGRES_INSTANCE, AWS_RDS_MYSQL_CLUSTER, AWS_RDS_MYSQL_INSTANCE, AWS_ACCOUNT, AWS_SSO_PERMISSION_SET, AWS_ORGANIZATIONAL_UNIT, AWS_AGENTCORE_GATEWAY, AWS_AGENTCORE_GATEWAY_TARGET, AWS_AGENTCORE_GATEWAY_TOOL, MCP_SERVER, MCP_TOOL, AZURE_MANAGEMENT_GROUP, AZURE_RESOURCE_GROUP, AZURE_SUBSCRIPTION, AZURE_VIRTUAL_MACHINE, AZURE_STORAGE_ACCOUNT, AZURE_STORAGE_CONTAINER, AZURE_SQL_SERVER, AZURE_SQL_MANAGED_INSTANCE, AZURE_SQL_DATABASE, AZURE_SQL_MANAGED_DATABASE, AZURE_USER_ASSIGNED_MANAGED_Identity, AZURE_ENTRA_ID_ROLE, AZURE_ENTERPRISE_APP, CUSTOM, CUSTOM_CONNECTOR, DATABRICKS_ACCOUNT_SERVICE_PRINCIPAL, GCP_ORGANIZATION, GCP_BUCKET, GCP_COMPUTE_INSTANCE, GCP_FOLDER, GCP_GKE_CLUSTER, GCP_PROJECT, GCP_CLOUD_SQL_POSTGRES_INSTANCE, GCP_CLOUD_SQL_MYSQL_INSTANCE, GCP_BIG_QUERY_DATASET, GCP_BIG_QUERY_TABLE, GCP_SERVICE_ACCOUNT, GCP_BILLING_ACCOUNT, GIT_HUB_REPO, GIT_HUB_ORG_ROLE, GIT_LAB_PROJECT, GOOGLE_WORKSPACE_ROLE, MONGO_INSTANCE, MONGO_ATLAS_INSTANCE, NETSUITE_ROLE, DATADOG_ROLE, OKTA_APP, OKTA_ROLE, OKTA_WORKLOAD_PRINCIPAL, OPAL_ROLE, OPAL_SCOPED_ROLE, PAGERDUTY_ROLE, TAILSCALE_SSH, SALESFORCE_PERMISSION_SET, SALESFORCE_PROFILE, SALESFORCE_ROLE, SNOWFLAKE_DATABASE, SNOWFLAKE_SCHEMA, SNOWFLAKE_TABLE, WORKDAY_ROLE, MYSQL_INSTANCE, MARIADB_INSTANCE, POSTGRES_INSTANCE, TELEPORT_ROLE, ILEVEL_ADVANCED_ROLE, DATASTAX_ASTRA_ROLE, COUPA_ROLE, CURSOR_ORGANIZATION, CURSOR_ORIGIN_REPOSITORY, CURSOR_USER, CURSOR_BOT, OPENAI_PLATFORM_PROJECT, OPENAI_PLATFORM_SERVICE_ACCOUNT, OPENAI_USER, ANTHROPIC_WORKSPACE, ANTHROPIC_USER, ANTHROPIC_SERVICE_ACCOUNT, GIT_HUB_ORG, ORACLE_FUSION_ROLE, DEVIN_ORGANIZATION, DEVIN_ROLE, VAULT_SECRET, VAULT_POLICY, VAULT_OIDC_ROLE, GIT_HUB_ENTERPRISE_ROLE, GRAFANA_FOLDER, GRAFANA_DASHBOARD, GRAFANA_BASIC_ROLE, GRAFANA_ROLE, CLICKHOUSE_DATABASE, CLICKHOUSE_TABLE, CLICKHOUSE_CONSOLE_ROLE, TWINGATE_RESOURCE, ZENDESK_ROLE, HUBSPOT_ROLE, ALICLOUD_RAM_ROLE, ALICLOUD_ECS_INSTANCE, DOCUSIGN_PERMISSION_PROFILE, ZOOM_ROLE, ZOOM_LICENSE, LINEAR_ORGANIZATION, LINEAR_PROJECT, RAMP_FUND, RAMP_ROLE, WRIKE_USER_TYPE, DATABRICKS_CATALOG, DATABRICKS_SCHEMA, DATABRICKS_VOLUME, DATABRICKS_FUNCTION, DATABRICKS_MODEL, DATABRICKS_SERVICE, DATABRICKS_MCP_SERVER, VERCEL_ROLE, VERCEL_PROJECT, AXIOM_ROLE, AXIOM_CUSTOM_ROLE, RIPPLING_DEPARTMENT, BOX_ENTERPRISE, BOX_FOLDER, SLACK_WORKSPACE, SLACK_ORGANIZATION, ASANA_WORKSPACE, ASANA_WORKSPACE_GUEST, BITWARDEN_ORGANIZATION, CALENDLY_ROLE, CALENDLY_EVENT_TYPE, MIRO_ORGANIZATION, MIRO_BOARD, ONELOGIN_APP, SUPABASE_ORGANIZATION, SUPABASE_PROJECT, SUPABASE_PROJECT_AUTH, TRAY_WORKSPACE, TRAY_ORGANIZATION Example:
"AWS_IAM_ROLE"
JSON metadata about the remote resource. Only set for items linked to remote systems. See this guide for details.
Example:
"{\n \"okta_directory_role\":\n {\n \"role_id\": \"SUPER_ADMIN-b52aa037-4a35-4ac3-9350-f6260fd12345\",\n \"role_type\": \"SUPER_ADMIN\",\n },\n}"
Was this page helpful?