{"id":10661,"library":"conductorone-sdk-typescript","title":"ConductorOne TypeScript SDK","description":"The `conductorone-sdk-typescript` package provides a developer-friendly and type-safe TypeScript SDK for interacting with the ConductorOne API. Currently at version 1.1.1 (released October 2025), this SDK is regularly updated with a frequent release cadence, often driven by the Speakeasy CLI based on changes in the underlying ConductorOne API. Key differentiators include its strong TypeScript typing, ensuring compile-time safety and improved developer experience, and its full support for both CommonJS and ES Modules environments. It encapsulates the HTTP API for managing ConductorOne resources, offering structured access to various API operations such as managing app resource owners, entitlements, and automations, as evidenced by recent additions in `v1.1.1` and `v1.0.2`.","status":"active","version":"1.1.1","language":"javascript","source_language":"en","source_url":"https://github.com/ConductorOne/conductorone-sdk-typescript","tags":["javascript","typescript"],"install":[{"cmd":"npm install conductorone-sdk-typescript","lang":"bash","label":"npm"},{"cmd":"yarn add conductorone-sdk-typescript","lang":"bash","label":"yarn"},{"cmd":"pnpm add conductorone-sdk-typescript","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Declared as a peer dependency, though its direct usage in the SDK's core functionality is not immediately apparent from the README. Often indicates a wrapper or utility intended for React environments.","package":"react","optional":true}],"imports":[{"note":"The main SDK client class. Supports both CommonJS and ES Modules environments. For CommonJS, use `const { ConductoroneSDKTypescript } = require('conductorone-sdk-typescript');`.","wrong":"const ConductoroneSDKTypescript = require(\"conductorone-sdk-typescript\");","symbol":"ConductoroneSDKTypescript","correct":"import { ConductoroneSDKTypescript } from \"conductorone-sdk-typescript\";"},{"note":"Access specific operation request and response types, e.g., `operations.CreateMonitorRequest` or `operations.CreateMonitorResponse`. The exact path might vary slightly depending on the SDK generation.","symbol":"operations (namespace)","correct":"import * as operations from \"conductorone-sdk-typescript/models/operations\";"},{"note":"Import shared data models and types used across multiple API operations, e.g., `shared.App` or `shared.Pagination`.","symbol":"shared (namespace)","correct":"import * as shared from \"conductorone-sdk-typescript/models/shared\";"}],"quickstart":{"code":"import { ConductoroneSDKTypescript } from \"conductorone-sdk-typescript\";\n\nconst conductoroneSDKTypescript = new ConductoroneSDKTypescript({\n  security: {\n    bearerAuth: process.env.CONDUCTORONE_BEARER_TOKEN ?? \"\",\n    oauth: process.env.CONDUCTORONE_OAUTH_TOKEN ?? \"\",\n  },\n});\n\nasync function run() {\n  try {\n    const result = await conductoroneSDKTypescript.accessConflict.createMonitor();\n    console.log(result);\n  } catch (error) {\n    console.error(\"Error making API call:\", error);\n  }\n}\n\nrun();","lang":"typescript","description":"This example initializes the ConductorOne SDK client with authentication and then makes an API call to create a monitor for access conflicts, logging the result."},"warnings":[{"fix":"If working in a React environment, add `react` to your project dependencies: `npm install react` or `yarn add react`.","message":"A peer dependency on `react` is declared, which might be unexpected for a backend API client. If you encounter issues in a React context or bundling errors, ensure `react` is installed in your project.","severity":"gotcha","affected_versions":">=0.0.1"},{"fix":"Consult the official changelog for `conductorone-sdk-typescript` and the ConductorOne API documentation for specific version migration guides before upgrading non-patch versions.","message":"As an SDK generated by Speakeasy CLI, minor versions (e.g., from 1.0.x to 1.1.x) may introduce breaking changes to API models, request/response structures, or method signatures if the underlying ConductorOne API contract evolves. Always review changelogs.","severity":"breaking","affected_versions":">=0.0.1"},{"fix":"Ensure the `security` object with a valid `bearerAuth` token or `oauth` token is passed to the `ConductoroneSDKTypescript` constructor during initialization.","message":"Handling of authentication (Bearer Token or OAuth2) requires providing credentials during SDK initialization. Failure to do so will result in unauthorized API calls (e.g., 401 status codes).","severity":"gotcha","affected_versions":">=0.0.1"}],"env_vars":null,"last_verified":"2026-04-19T00:00:00.000Z","next_check":"2026-07-18T00:00:00.000Z","problems":[{"fix":"Install the package: `npm install conductorone-sdk-typescript`. Verify the import statement: `import { ConductoroneSDKTypescript } from \"conductorone-sdk-typescript\";`.","cause":"The package is not installed, or the import path is incorrect, or TypeScript cannot find declaration files.","error":"Cannot find module 'conductorone-sdk-typescript' or its corresponding type declarations."},{"fix":"Ensure the `ConductoroneSDKTypescript` class is correctly instantiated with all required `security` parameters, e.g., `new ConductoroneSDKTypescript({ security: { bearerAuth: 'YOUR_TOKEN' } })`.","cause":"The SDK client instance (`conductoroneSDKTypescript`) was not properly initialized, or the `security` configuration was invalid, leading to a non-functional client object.","error":"TypeError: Cannot read properties of undefined (reading 'createMonitor') at ConductoroneSDKTypescript.accessConflict"},{"fix":"Verify that the `bearerAuth` or `oauth` token supplied during SDK initialization is correct, active, and has the necessary permissions for the API call.","cause":"The provided authentication credentials (Bearer token or OAuth token) are either missing, expired, or invalid.","error":"Error: Request failed with status code 401: Unauthorized"}],"ecosystem":"npm"}