Skip to content

ConductorOne/conductorone-sdk-typescript

BranchesTags

Repository files navigation

conductorone-sdk-typescript

Developer-friendly & type-safe Typescript SDK specifically catered to leverage conductorone-sdk-typescript API.

Summary

C1 API: The C1 API is a HTTP API for managing C1 resources.

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add conductorone-sdk-typescript

PNPM

pnpm add conductorone-sdk-typescript

Bun

bun add conductorone-sdk-typescript

Yarn

yarn add conductorone-sdk-typescript

Note

This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.a2Ui.listSurfaces({
    conversationId: "<id>",
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name Type Scheme
bearerAuth http HTTP Bearer
oauth oauth2 OAuth2 token

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.a2Ui.listSurfaces({
    conversationId: "<id>",
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

A2Ui

AccessConflict

AccessReview

AccessReviewSetupEntitlement

AccessReviewTemplate

AccessReviewTemplateSetupEntitlement

AccountProvisionPolicyTest

AppAccessRequestsDefaults

AppEntitlementMonitorBinding

AppEntitlementOwners

AppEntitlementOwnersV2

AppEntitlements

AppEntitlementSearch

AppEntitlementsProxy

AppEntitlementUserBinding

AppOwners

AppOwnersV2

AppReport

AppReportAction

AppResource

AppResourceOwners

AppResourceSearch

AppResourceType

Apps

AppSearch

AppUsageControls

AppUser

Attributes

AttributeSearch

Auth

Automation

AutomationExecution

AutomationExecutionActions

AutomationExecutionSearch

AutomationSearch

AWSExternalIDSettings

Connector

ConnectorCatalog

ConnectorOwnersV2

Contacts

Directory

Export

ExportsSearch

ExternalClientSearch

  • search - NOTE: Searches external client grants for all users

Finding

FindingRoutingRule

FindingSearch

Functions

FunctionsInvocation

FunctionsInvocationSearch

FunctionsSearch

Hooks

HooksSearch

LocalDirectoryConfig

LocalUserInvitation

OnboardingSettings

OrgDomain

OrgNotificationSettings

PaperSecret

PaperSecretAdmin

PersonalClient

PersonalClientSearch

  • search - NOTE: Searches personal clients for all users

Policies

PolicySearch

PolicyValidate

Principal

RequestCatalogManagement

RequestCatalogSearch

RequestSchema

RoleMiningManagement

RoleMiningManagementSearch

Roles

SessionSettings

SSFReceiverEvent

SSFReceiverEventSearch

SSFReceiverStream

StepUpProvider

StepUpTransaction

SystemLog

Task

TaskActions

TaskAudit

TaskSearch

TenantAuthConfig

TenantEmailProvider

User

UserNotificationSettings

UserSearch

Vault

Webhooks

WebhooksSearch

WorkloadFederation

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.appEntitlementSearch.search();

  for await (const page of result) {
    console.log(page);
  }
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.a2Ui.listSurfaces({
    conversationId: "<id>",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.a2Ui.listSurfaces({
    conversationId: "<id>",
  });

  console.log(result);
}

run();

Error Handling

ConductoroneSDKTypescriptError is the base class for all HTTP error responses. It has the following properties:

Property Type Description
error.message string Error message
error.statusCode number HTTP response status code eg 404
error.headers Headers HTTP response headers
error.body string HTTP body. Can be empty string if no body is returned.
error.rawResponse Response Raw HTTP response

Example

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";
import * as errors from "conductorone-sdk-typescript/sdk/models/errors";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  try {
    const result = await conductoroneSDKTypescript.a2Ui.listSurfaces({
      conversationId: "<id>",
    });

    console.log(result);
  } catch (error) {
    if (error instanceof errors.ConductoroneSDKTypescriptError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

Less common errors (6)

Network errors:

Inherit from ConductoroneSDKTypescriptError:

  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Server Variables

The default server https://{tenantDomain}.conductor.one contains variables and is set to https://example.conductor.one by default. To override default values, the following parameters are available when initializing the SDK client instance:

Variable Parameter Default Description
tenantDomain tenantDomain: string "example" The domain of the tenant to use for this request.

Example

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  serverIdx: 0,
  tenantDomain: "example",
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.a2Ui.listSurfaces({
    conversationId: "<id>",
  });

  console.log(result);
}

run();

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  serverURL: "https://example.conductor.one",
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.a2Ui.listSurfaces({
    conversationId: "<id>",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";
import { ProxyAgent } from "undici";
import { HTTPClient } from "conductorone-sdk-typescript/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new ConductoroneSDKTypescript({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const sdk = new ConductoroneSDKTypescript({ debugLogger: console });

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

About

No description, website, or topics provided.

Resources

Readme

License

MIT license

Contributing

Contributing
Activity
Custom properties

Stars

2 stars

Watchers

10 watching

Forks

4 forks
Report repository

Releases 5

typescript - v1.2.0 - 2026-05-05 23:57:23 Latest
May 5, 2026
+ 4 releases

Packages

 
 
 

Contributors

Languages