Workspace Security SDK Reference

Workspace Security

List Domains

Lists domain-verification records for the workspace.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.workspace_security.list_domains(workspace_key="<value>")

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.workspaceSecurity.listDomains({
    workspaceKey: "<value>",
  });

  console.log(result);
}

run();

Show Parameters

{
    "workspace_key": str,  # required
}

{
  workspaceKey: string;  // required
}

Show Response

{
    "domains": [{
        "id": str,
        "domain": str,
        "status": Literal["DOMAIN_VERIFICATION_STATUS_UNSPECIFIED", "DOMAIN_VERIFICATION_STATUS_PENDING", "DOMAIN_VERIFICATION_STATUS_VERIFIED"],
        "txt_name": str,
        "txt_value": str,
        "created_at": str,
        "expires_at": str,  # optional
        "verified_at": str,  # optional
        "created_by_id": Optional[str],
    }],
}

{
  domains: {
    id: string;
    domain: string;
    status: "DOMAIN_VERIFICATION_STATUS_UNSPECIFIED" | "DOMAIN_VERIFICATION_STATUS_PENDING" | "DOMAIN_VERIFICATION_STATUS_VERIFIED";
    txtName: string;
    txtValue: string;
    createdAt: Date;
    expiresAt?: Date;
    verifiedAt?: Date;
    createdById?: string;
  }[];
}

Create Domain

Creates a domain-verification challenge and returns the TXT record to add to DNS.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.workspace_security.create_domain(workspace_key="<value>")

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.workspaceSecurity.createDomain({
    workspaceKey: "<value>",
    createDomainRequest: {},
  });

  console.log(result);
}

run();

Show Parameters

{
    "workspace_key": str,  # required
    "domain": Optional[str],
}

{
  workspaceKey: string;  // required
  createDomainRequest: {  // required
    domain?: string;
  };
}

Show Response

{
    "domain": {
        "id": str,
        "domain": str,
        "status": Literal["DOMAIN_VERIFICATION_STATUS_UNSPECIFIED", "DOMAIN_VERIFICATION_STATUS_PENDING", "DOMAIN_VERIFICATION_STATUS_VERIFIED"],
        "txt_name": str,
        "txt_value": str,
        "created_at": str,
        "expires_at": str,  # optional
        "verified_at": str,  # optional
        "created_by_id": Optional[str],
    },
}

{
  domain: {
    id: string;
    domain: string;
    status: "DOMAIN_VERIFICATION_STATUS_UNSPECIFIED" | "DOMAIN_VERIFICATION_STATUS_PENDING" | "DOMAIN_VERIFICATION_STATUS_VERIFIED";
    txtName: string;
    txtValue: string;
    createdAt: Date;
    expiresAt?: Date;
    verifiedAt?: Date;
    createdById?: string;
  };
}

Delete Domain

Permanently removes a domain-verification record.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    orq.workspace_security.delete_domain(workspace_key="<value>", domain_id="<id>")

    # Use the SDK ...

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  await orq.workspaceSecurity.deleteDomain({
    workspaceKey: "<value>",
    domainId: "<id>",
  });

}

run();

Show Parameters

{
    "workspace_key": str,  # required
    "domain_id": str,  # required
}

{
  workspaceKey: string;  // required
  domainId: string;  // required
}

Verify Domain

Checks DNS for the expected TXT record and marks the domain as verified when it matches.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.workspace_security.verify_domain(workspace_key="<value>", domain_id="<id>")

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.workspaceSecurity.verifyDomain({
    workspaceKey: "<value>",
    domainId: "<id>",
  });

  console.log(result);
}

run();

Show Parameters

{
    "workspace_key": str,  # required
    "domain_id": str,  # required
}

{
  workspaceKey: string;  // required
  domainId: string;  // required
}

Show Response

{
    "domain": {
        "id": str,
        "domain": str,
        "status": Literal["DOMAIN_VERIFICATION_STATUS_UNSPECIFIED", "DOMAIN_VERIFICATION_STATUS_PENDING", "DOMAIN_VERIFICATION_STATUS_VERIFIED"],
        "txt_name": str,
        "txt_value": str,
        "created_at": str,
        "expires_at": str,  # optional
        "verified_at": str,  # optional
        "created_by_id": Optional[str],
    },
}

{
  domain: {
    id: string;
    domain: string;
    status: "DOMAIN_VERIFICATION_STATUS_UNSPECIFIED" | "DOMAIN_VERIFICATION_STATUS_PENDING" | "DOMAIN_VERIFICATION_STATUS_VERIFIED";
    txtName: string;
    txtValue: string;
    createdAt: Date;
    expiresAt?: Date;
    verifiedAt?: Date;
    createdById?: string;
  };
}

Get Ip Allowlist

Returns the workspace IP allowlist and the current caller IP when available.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.workspace_security.get_ip_allowlist(workspace_key="<value>")

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.workspaceSecurity.getIPAllowlist({
    workspaceKey: "<value>",
  });

  console.log(result);
}

run();

Show Parameters

{
    "workspace_key": str,  # required
}

{
  workspaceKey: string;  // required
}

Show Response

{
    "ip_allowlist": {
        "enabled": bool,
        "ranges": [{
            "id": str,
            "cidr": str,
            "description": str,
            "created_at": str,
            "created_by_id": Optional[str],
        }],
    },
    "current_ip": str,
}

{
  ipAllowlist: {
    enabled: boolean;
    ranges: {
      id: string;
      cidr: string;
      description: string;
      createdAt: Date;
      createdById?: string;
    }[];
  };
  currentIp: string;
}

Update Ip Allowlist

Updates the workspace-level allowlist switch. Every listed range applies while the allowlist is enabled.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.workspace_security.update_ip_allowlist(workspace_key="<value>")

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.workspaceSecurity.updateIPAllowlist({
    workspaceKey: "<value>",
    updateIPAllowlistRequest: {},
  });

  console.log(result);
}

run();

Show Parameters

{
    "workspace_key": str,  # required
    "enabled": Optional[bool],
}

{
  workspaceKey: string;  // required
  updateIPAllowlistRequest: {  // required
    enabled?: boolean;
  };
}

Show Response

{
    "ip_allowlist": {
        "enabled": bool,
        "ranges": [{
            "id": str,
            "cidr": str,
            "description": str,
            "created_at": str,
            "created_by_id": Optional[str],
        }],
    },
}

{
  ipAllowlist: {
    enabled: boolean;
    ranges: {
      id: string;
      cidr: string;
      description: string;
      createdAt: Date;
      createdById?: string;
    }[];
  };
}

Add Ip Range

Adds an IPv4 or IPv6 CIDR range to the workspace allowlist.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.workspace_security.add_ip_range(workspace_key="<value>")

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.workspaceSecurity.addIPRange({
    workspaceKey: "<value>",
    addIPRangeRequest: {},
  });

  console.log(result);
}

run();

Show Parameters

{
    "workspace_key": str,  # required
    "cidr": Optional[str],
    "description": Optional[str],
}

{
  workspaceKey: string;  // required
  addIPRangeRequest: {  // required
    cidr?: string;
    description?: string;
  };
}

Show Response

{
    "range": {
        "id": str,
        "cidr": str,
        "description": str,
        "created_at": str,
        "created_by_id": Optional[str],
    },
}

{
  range: {
    id: string;
    cidr: string;
    description: string;
    createdAt: Date;
    createdById?: string;
  };
}

Delete Ip Range

Permanently removes a CIDR range from the workspace allowlist.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    orq.workspace_security.delete_ip_range(workspace_key="<value>", range_id="<id>")

    # Use the SDK ...

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  await orq.workspaceSecurity.deleteIPRange({
    workspaceKey: "<value>",
    rangeId: "<id>",
  });

}

run();

Show Parameters

{
    "workspace_key": str,  # required
    "range_id": str,  # required
}

{
  workspaceKey: string;  // required
  rangeId: string;  // required
}

Orq SDK

Terminal & Agents

Terraform

Platform APIs

Management APIs