curl --request GET \
--url https://api.opal.dev/v1/resources \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.opal.dev/v1/resources"
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', 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",
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"
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")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opal.dev/v1/resources")
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{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"resource_id": "f454d283-ca67-4a8a-bdbb-df212eca5353",
"description": "This resource represents AWS IAM role \"SupportUser\".",
"admin_owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
"remote_id": "arn:aws:iam::490306337630:role/SupportUser",
"remote_name": "SupportUser",
"max_duration": 120,
"require_manager_approval": false,
"require_support_ticket": false,
"parent_resource_id": "f454d283-ca67-4a8a-bdbb-df212eca5345"
},
{
"resource_id": "99d0b81d-14be-4cf6-bd27-348b4af1d11b",
"description": "This resource represents GCP project \"app-demo\".",
"remote_id": "app-demo-307223",
"remote_name": "app-demo",
"admin_owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
"max_duration": 360,
"require_manager_approval": false,
"require_support_ticket": true
}
]
}Get resources
Returns a list of resources for your organization.
curl --request GET \
--url https://api.opal.dev/v1/resources \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.opal.dev/v1/resources"
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', 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",
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"
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")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opal.dev/v1/resources")
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{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"resource_id": "f454d283-ca67-4a8a-bdbb-df212eca5353",
"description": "This resource represents AWS IAM role \"SupportUser\".",
"admin_owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
"remote_id": "arn:aws:iam::490306337630:role/SupportUser",
"remote_name": "SupportUser",
"max_duration": 120,
"require_manager_approval": false,
"require_support_ticket": false,
"parent_resource_id": "f454d283-ca67-4a8a-bdbb-df212eca5345"
},
{
"resource_id": "99d0b81d-14be-4cf6-bd27-348b4af1d11b",
"description": "This resource represents GCP project \"app-demo\".",
"remote_id": "app-demo-307223",
"remote_name": "app-demo",
"admin_owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
"max_duration": 360,
"require_manager_approval": false,
"require_support_ticket": true
}
]
}Authorizations
Query Parameters
The resource type to filter by. Required when remote_id is provided. The type of the resource.
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 "AWS_IAM_ROLE"
How to apply resource_name. Requires resource_name to be set. Defaults to CONTAINS when resource_name is provided without this parameter. EQUALS, STARTS_WITH, and ENDS_WITH match only the resource's own name and remote_name, not parent-name combinations or remote_id.
How to match a free-text name filter on list endpoints. All match types are case-insensitive. When omitted, CONTAINS is used. REGEX is not supported here — use POST /queries/run for regular-expression matching.
CONTAINS, EQUALS, STARTS_WITH, ENDS_WITH Only return resources this user can request at one or more access levels, using the same
evaluation as GET /resources/{resource_id}/requestable/users/{user_id}. Filtering for
another user requires an Opal admin or a custom role with the CHECK_REQUESTABILITY
permission. The response is always filtered by the caller's own READ visibility, so a
non-admin CHECK_REQUESTABILITY holder sees the intersection of items they can read and
items the target user can request. Filtering for yourself needs no permission.
Response
One page worth resources associated with your organization.
Was this page helpful?