Skip to main content
GET
/
policy_metadata
cURL
curl --request GET \
  --url https://api.osohq.com/api/policy_metadata \
  --header 'Authorization: Bearer <token>'
import os
from oso_cloud import Oso

oso = Oso(api_key=os.environ.get('OSO_CLOUD_API_KEY', None))

# Get policy metadata
metadata = oso.get_policy_metadata()

# Access resource information
print(metadata.resources.keys())               # List all resources
print(metadata.resources["Repository"])        # Get specific resource metadata
import { Oso } from 'oso-cloud';

const apiKey = process.env.OSO_CLOUD_API_KEY;
const oso = new Oso("https://cloud.osohq.com", apiKey);

// Get policy metadata
const metadata = await oso.getPolicyMetadata();

// Access resource information
console.log(metadata.resources.keys());        // List all resources
console.log(metadata.resources.get("Repository")); // Get specific resource metadata
package main

import (
    "log"
    "os"
    oso "github.com/osohq/go-oso-cloud/v2"
)

func main() {
    apiKey := os.Getenv("OSO_CLOUD_API_KEY")
    osoClient := oso.NewClient("https://cloud.osohq.com", apiKey)

// Get policy metadata
    metadata, err := osoClient.GetPolicyMetadata()
    if err != nil {
        log.Fatal(err)
    }
}

// Access resource information
for resourceName := range metadata.Resources {
    fmt.Printf("Resource: %s\n", resourceName)
}
package com.mycompany;

import java.io.IOException;
import com.osohq.oso_cloud.Oso;
import com.osohq.oso_cloud.api.ApiException;

public class App {
    public static void main(String[] args) {
        String apiKey = System.getenv("OSO_CLOUD_API_KEY");
        Oso oso = new Oso(apiKey);

        // Get policy metadata
        try {
            PolicyMetadata metadata = oso.getPolicyMetadata();
            
            // Access resource information
            System.out.println(metadata.getResources().keySet());
        } catch (IOException | ApiException e) {
            System.err.println("Error getting policy metadata: " + e.getMessage());
        }
    }
}
require 'oso-cloud'

api_key = ENV.fetch('OSO_CLOUD_API_KEY', nil)
oso = OsoCloud::Oso.new(url: "https://cloud.osohq.com", api_key: api_key)

# Get policy metadata
metadata = oso.get_policy_metadata

# Access resource information
puts metadata.resources.keys
using OsoCloud;

string? apiKey = Environment.GetEnvironmentVariable("OSO_CLOUD_API_KEY");
var oso = new Oso("https://api.osohq.com", apiKey);

// Get policy metadata
var metadata = await oso.GetPolicyMetadata();

// Access resource information
Console.WriteLine(string.Join(", ", metadata.Resources.Keys));
{
  "metadata": {
    "resources": {}
  }
}
{
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

Requires an API key to access.

Query Parameters

id
integer<int64> | null

Response

metadata
object
required