conductorone-sdk-typescript

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

Summary

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

* conductorone-sdk-typescript
* SDK Installation
* Requirements
* SDK Example Usage
* Authentication
* Available Resources and Operations
* Standalone functions
* Pagination
* Retries
* Error Handling
* Server Selection
* Custom HTTP Client
* Debugging
* Development
* Maturity
* Contributions

SDK Installation

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

$3

``bash npm add conductorone-sdk-typescript`

`$3`

`bash pnpm add conductorone-sdk-typescript`

`$3`

`bash bun add conductorone-sdk-typescript`

`$3`

`bash 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`

`$3`

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

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

async function run() { const result = await conductoroneSDKTypescript.accessConflict.createMonitor();

console.log(result); }

run();

`Authentication`

`$3`

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 securityoptional 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:`typescript import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

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

async function run() { const result = await conductoroneSDKTypescript.accessConflict.createMonitor();

console.log(result); }

run();

`Available Resources and Operations`


Available methods
$3
* createMonitor - Create Monitor
* deleteMonitor - Delete Monitor
* getMonitor - Get Monitor
* updateMonitor - Update Monitor
$3
* test - Test
$3
* getAppAccessRequestsDefaults - Get App Access Requests Defaults
* createAppAccessRequestsDefaults - Create App Access Requests Defaults
* cancelAppAccessRequestsDefaults - Cancel App Access Requests Defaults
$3
* deleteAppEntitlementMonitorBinding - Delete App Entitlement Monitor Binding
* createAppEntitlementMonitorBinding - Create App Entitlement Monitor Binding
* getAppEntitlementMonitorBinding - Get App Entitlement Monitor Binding
$3
* listOwnerIDs - List Owner I Ds
* delete - Delete
* list - List
* add - Add
* set - Set
* remove - Remove
$3
* list - List
* create - Create
* addManuallyManagedMembers - Add Manually Managed Members
* deleteAutomation - Delete Automation
* getAutomation - Get Automation
* createAutomation - Create Automation
* removeAutomationExclusion - Remove Automation Exclusion
* listAutomationExclusions - List Automation Exclusions
* addAutomationExclusion - Add Automation Exclusion
* updateAutomation - Update Automation
* removeEntitlementMembership - Remove Entitlement Membership
* ~~listUsers~~ - List Users :warning: Deprecated
* delete - Delete
* get - Get
* update - Update
* listForAppResource - List For App Resource
* listForAppUser - List For App User
$3
* searchAppEntitlementsWithExpired - Search App Entitlements With Expired
* searchAppEntitlementsForAppUser - Search App Entitlements For App User
* search - Search
* searchGrants - Search Grants
$3
* delete - Delete
* get - Get
* create - Create
$3
* removeGrantDuration - Remove Grant Duration
* updateGrantDuration - Update Grant Duration
* listAppUsersForIdentityWithGrant - List App Users For Identity With Grant
* searchGrantFeed - Search Grant Feed
* searchPastGrants - Search Past Grants
$3
* listOwnerIDs - List Owner I Ds
* delete - Delete
* list - List
* set - Set
* remove - Remove
* add - Add
$3
* list - List
$3
* generateReport - Generate Report
$3
* list - List
* createManuallyManagedAppResource - Create Manually Managed App Resource
* deleteManuallyManagedAppResource - Delete Manually Managed App Resource
* get - Get
* update - Update
$3
* delete - Delete
* listOwnerIDs - List Owner I Ds
* remove - Remove
* list - List
* add - Add
* set - Set
$3
* searchAppResourceTypes - Search App Resource Types
* searchAppResources - Search App Resources
$3
* list - List
* createManuallyManagedResourceType - Create Manually Managed Resource Type
* deleteManuallyManagedResourceType - Delete Manually Managed Resource Type
* get - Get
* updateManuallyManagedResourceType - Update Manually Managed Resource Type
$3
* list - List
* create - Create
* delete - Delete
* get - Get
* update - Update
$3
* search - Search
$3
* get - Get
* update - Update
$3
* list - List
* listAppUserCredentials - List App User Credentials
* listAppUsersForUser - List App Users For User
* update - Update
* search - Search
$3
* deleteAttributeValue - Delete Attribute Value
* createAttributeValue - Create Attribute Value
* getAttributeValue - Get Attribute Value
* listComplianceFrameworks - List Compliance Frameworks
* createComplianceFrameworkAttributeValue - Create Compliance Framework Attribute Value
* deleteComplianceFrameworkAttributeValue - Delete Compliance Framework Attribute Value
* getComplianceFrameworkAttributeValue - Get Compliance Framework Attribute Value
* listRiskLevels - List Risk Levels
* createRiskLevelAttributeValue - Create Risk Level Attribute Value
* deleteRiskLevelAttributeValue - Delete Risk Level Attribute Value
* getRiskLevelAttributeValue - Get Risk Level Attribute Value
* listAttributeTypes - List Attribute Types
* listAttributeValues - List Attribute Values
$3
* searchAttributeValues - Search Attribute Values
$3
* introspect - Introspect
$3
* listAutomations - List Automations
* createAutomation - Create Automation
* deleteAutomation - Delete Automation
* getAutomation - Get Automation
* updateAutomation - Update Automation
* executeAutomation - Execute Automation
$3
* listAutomationExecutions - List Automation Executions
* getAutomationExecution - Get Automation Execution
$3
* terminateAutomation - Terminate Automation
$3
* searchAutomationExecutions - Search Automation Executions
$3
* searchAutomationTemplateVersions - Search Automation Template Versions
* searchAutomations - Search Automations
$3
* get - Get
$3
* list - List
* createDelegated - Create Delegated
* confirmSyncValid - Confirm Sync Valid
* getCredentials - Get Credentials
* revokeCredential - Revoke Credential
* forceSync - Force Sync
* pauseSync - Pause Sync
* resumeSync - Resume Sync
* delete - Delete
* get - Get
* update - Update
* create - Create
* updateDelegated - Update Delegated
* rotateCredential - Rotate Credential
* validateHTTPConnectorConfig - Validate Http Connector Config
$3
* configurationSchema - Configuration Schema
$3
* list - List
* create - Create
* delete - Delete
* get - Get
* update - Update
$3
* list - List
* create - Create
* delete - Delete
* get - Get
* update - Update
* listEvents - List Events
$3
* search - Search
$3
* listFunctions - List Functions
* createFunction - Create Function
* listCommits - List Commits
* commit - Commit
* getCommit - Get Commit
* invoke - Invoke
* listTags - List Tags
* createTag - Create Tag
* deleteFunction - Delete Function
* getFunction - Get Function
* updateFunction - Update Function
$3
* search - Search
$3
* list - List
* update - Update
$3
* list - NOTE: Only shows personal clients for the current user.
* create - Create
* delete - Delete
* get - Get
* update - Update
$3
* search - NOTE: Searches personal clients for all users
$3
* list - List
* create - Create
* delete - Delete
* get - Get
* update - Update
$3
* search - Search
$3
* validateCEL - Validate Cel
$3
* list - List
* create - Create
* listAllEntitlementIdsPerApp - List All Entitlement Ids Per App
* listEntitlementsPerCatalog - List Entitlements Per Catalog
* updateAppEntitlements - Update App Entitlements
* removeAppEntitlements - Remove App Entitlements
* addAppEntitlements - Add App Entitlements
* removeAccessEntitlements - Remove Access Entitlements
* addAccessEntitlements - Add Access Entitlements
* listEntitlementsForAccess - List Entitlements For Access
* delete - Delete
* get - Get
* update - Update
* deleteBundleAutomation - Delete Bundle Automation
* getBundleAutomation - Get Bundle Automation
* setBundleAutomation - Set Bundle Automation
* createBundleAutomation - Create Bundle Automation
* resumePausedBundleAutomation - Resume Paused Bundle Automation
* forceRunBundleAutomation - Force Run Bundle Automation
$3
* searchEntitlements - Search Entitlements
$3
* removeEntitlementBinding - Remove Entitlement Binding
* createEntitlementBinding - Create Entitlement Binding
* findBindingForAppEntitlement - Find Binding For App Entitlement
* create - Create
* delete - Delete
* get - Get
* update - Update
$3
* list - List
* get - Get
* update - Update
$3
* get - Get
* update - Update
* testSourceIP - Test Source Ip
$3
* search - Search
* list - List
* create - Create
* delete - Delete
* get - Get
* update - Update
* updateSecret - Update Secret
* test - Test
$3
* search - Search
* get - Get
$3
* listEvents - List Events
$3
* createGrantTask - Create Grant Task
* createOffboardingTask - Create Offboarding Task
* createRevokeTask - Create Revoke Task
* get - Get
$3
* approve - Approve
* approveWithStepUp - Approve With Step Up
* close - Close
* comment - Comment
* deny - Deny
* escalateToEmergencyAccess - Escalate To Emergency Access
* processNow - Process Now
* reassign - Reassign
* hardReset - Hard Reset
* restart - Restart
* skipStep - Skip Step
* updateGrantDuration - Update Grant Duration
* updateRequestData - Update Request Data
$3
* list - List
$3
* search - Search
$3
* list - List
* get - Get
* getUserProfileTypes - Get User Profile Types
* setExpiringUserDelegationBindingByAdmin - Set Expiring User Delegation Binding By Admin
$3
* search - Search
$3
* list - List
* create - Create
* delete - Delete
* get - Get
* update - Update
* test - Test
$3
* search - Search



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][for-await-of] syntax.

[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of

Here's an example of one such pagination call:

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

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

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:`typescript import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

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

async function run() { const result = await conductoroneSDKTypescript.accessConflict.createMonitor({ 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:`typescript 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: "", oauth: "", }, });

async function run() { const result = await conductoroneSDKTypescript.accessConflict.createMonitor();

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 |

`$3`

typescript
import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";
import * as errors from "conductorone-sdk-typescript/sdk/models/errors";
const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "",
    oauth: "",
  },
});
async function run() {
  try {
    const result = await conductoroneSDKTypescript.accessConflict
      .createMonitor();
    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();

`$3`


Primary error:
*

ConductoroneSDKTypescriptError

: The base class for HTTP error responses.

Less common errors (6)

Network errors: *ConnectionError: HTTP client was unable to make a request to a server. *RequestTimeoutError: HTTP request timed out due to an AbortSignal signal. *RequestAbortedError: HTTP request was aborted by the client. *InvalidRequestError: Any input used to create a request is invalid. *UnexpectedClientError: Unrecognised or unexpected error.

Inherit fromConductoroneSDKTypescriptError: *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
$3

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

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

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({ tenantDomain: "", security: { bearerAuth: "", oauth: "", }, });

async function run() { const result = await conductoroneSDKTypescript.accessConflict.createMonitor();

console.log(result); }

run();

`$3`

The default server can be overridden globally by passing a URL to the serverURL: stringoptional parameter when initializing the SDK client instance. For example:`typescript import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

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

async function run() { const result = await conductoroneSDKTypescript.accessConflict.createMonitor();

console.log(result); }

run();

`Custom HTTP Client`

The TypeScript SDK makes API calls using an HTTPClientthat wraps the native Fetch API. This client is a thin wrapper aroundfetchand 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 fetcherargument 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 use the "beforeRequest"hook to to add a custom header and a timeout to requests and how to use the"requestError"hook to log errors:

`typescript import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript"; import { HTTPClient } from "conductorone-sdk-typescript/lib/http";

const httpClient = new HTTPClient({ // fetcher takes a function that has the same signature as nativefetch. fetcher: (request) => { return fetch(request); } });

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.

`typescript 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.

$3

conductorone-sdk-typescript

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

Summary

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

SDK Installation

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

$3

``bash npm add conductorone-sdk-typescript`

`$3`

`bash pnpm add conductorone-sdk-typescript`

`$3`

`bash bun add conductorone-sdk-typescript`

`$3`

`bash 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`

`$3`

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

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

async function run() { const result = await conductoroneSDKTypescript.accessConflict.createMonitor();

console.log(result); }

run();

`Authentication`

`$3`

This SDK supports the following security schemes globally:

| Name | Type | Scheme | | ------------ | ------ | ------------ | |bearerAuth| http | HTTP Bearer | |oauth | oauth2 | OAuth2 token |

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

async function run() { const result = await conductoroneSDKTypescript.accessConflict.createMonitor();

console.log(result); }

run();

`Available Resources and Operations`


Available methods
$3
* createMonitor - Create Monitor
* deleteMonitor - Delete Monitor
* getMonitor - Get Monitor
* updateMonitor - Update Monitor
$3
* test - Test
$3
* getAppAccessRequestsDefaults - Get App Access Requests Defaults
* createAppAccessRequestsDefaults - Create App Access Requests Defaults
* cancelAppAccessRequestsDefaults - Cancel App Access Requests Defaults
$3
* deleteAppEntitlementMonitorBinding - Delete App Entitlement Monitor Binding
* createAppEntitlementMonitorBinding - Create App Entitlement Monitor Binding
* getAppEntitlementMonitorBinding - Get App Entitlement Monitor Binding
$3
* listOwnerIDs - List Owner I Ds
* delete - Delete
* list - List
* add - Add
* set - Set
* remove - Remove
$3
* list - List
* create - Create
* addManuallyManagedMembers - Add Manually Managed Members
* deleteAutomation - Delete Automation
* getAutomation - Get Automation
* createAutomation - Create Automation
* removeAutomationExclusion - Remove Automation Exclusion
* listAutomationExclusions - List Automation Exclusions
* addAutomationExclusion - Add Automation Exclusion
* updateAutomation - Update Automation
* removeEntitlementMembership - Remove Entitlement Membership
* ~~listUsers~~ - List Users :warning: Deprecated
* delete - Delete
* get - Get
* update - Update
* listForAppResource - List For App Resource
* listForAppUser - List For App User
$3
* searchAppEntitlementsWithExpired - Search App Entitlements With Expired
* searchAppEntitlementsForAppUser - Search App Entitlements For App User
* search - Search
* searchGrants - Search Grants
$3
* delete - Delete
* get - Get
* create - Create
$3
* removeGrantDuration - Remove Grant Duration
* updateGrantDuration - Update Grant Duration
* listAppUsersForIdentityWithGrant - List App Users For Identity With Grant
* searchGrantFeed - Search Grant Feed
* searchPastGrants - Search Past Grants
$3
* listOwnerIDs - List Owner I Ds
* delete - Delete
* list - List
* set - Set
* remove - Remove
* add - Add
$3
* list - List
$3
* generateReport - Generate Report
$3
* list - List
* createManuallyManagedAppResource - Create Manually Managed App Resource
* deleteManuallyManagedAppResource - Delete Manually Managed App Resource
* get - Get
* update - Update
$3
* delete - Delete
* listOwnerIDs - List Owner I Ds
* remove - Remove
* list - List
* add - Add
* set - Set
$3
* searchAppResourceTypes - Search App Resource Types
* searchAppResources - Search App Resources
$3
* list - List
* createManuallyManagedResourceType - Create Manually Managed Resource Type
* deleteManuallyManagedResourceType - Delete Manually Managed Resource Type
* get - Get
* updateManuallyManagedResourceType - Update Manually Managed Resource Type
$3
* list - List
* create - Create
* delete - Delete
* get - Get
* update - Update
$3
* search - Search
$3
* get - Get
* update - Update
$3
* list - List
* listAppUserCredentials - List App User Credentials
* listAppUsersForUser - List App Users For User
* update - Update
* search - Search
$3
* deleteAttributeValue - Delete Attribute Value
* createAttributeValue - Create Attribute Value
* getAttributeValue - Get Attribute Value
* listComplianceFrameworks - List Compliance Frameworks
* createComplianceFrameworkAttributeValue - Create Compliance Framework Attribute Value
* deleteComplianceFrameworkAttributeValue - Delete Compliance Framework Attribute Value
* getComplianceFrameworkAttributeValue - Get Compliance Framework Attribute Value
* listRiskLevels - List Risk Levels
* createRiskLevelAttributeValue - Create Risk Level Attribute Value
* deleteRiskLevelAttributeValue - Delete Risk Level Attribute Value
* getRiskLevelAttributeValue - Get Risk Level Attribute Value
* listAttributeTypes - List Attribute Types
* listAttributeValues - List Attribute Values
$3
* searchAttributeValues - Search Attribute Values
$3
* introspect - Introspect
$3
* listAutomations - List Automations
* createAutomation - Create Automation
* deleteAutomation - Delete Automation
* getAutomation - Get Automation
* updateAutomation - Update Automation
* executeAutomation - Execute Automation
$3
* listAutomationExecutions - List Automation Executions
* getAutomationExecution - Get Automation Execution
$3
* terminateAutomation - Terminate Automation
$3
* searchAutomationExecutions - Search Automation Executions
$3
* searchAutomationTemplateVersions - Search Automation Template Versions
* searchAutomations - Search Automations
$3
* get - Get
$3
* list - List
* createDelegated - Create Delegated
* confirmSyncValid - Confirm Sync Valid
* getCredentials - Get Credentials
* revokeCredential - Revoke Credential
* forceSync - Force Sync
* pauseSync - Pause Sync
* resumeSync - Resume Sync
* delete - Delete
* get - Get
* update - Update
* create - Create
* updateDelegated - Update Delegated
* rotateCredential - Rotate Credential
* validateHTTPConnectorConfig - Validate Http Connector Config
$3
* configurationSchema - Configuration Schema
$3
* list - List
* create - Create
* delete - Delete
* get - Get
* update - Update
$3
* list - List
* create - Create
* delete - Delete
* get - Get
* update - Update
* listEvents - List Events
$3
* search - Search
$3
* listFunctions - List Functions
* createFunction - Create Function
* listCommits - List Commits
* commit - Commit
* getCommit - Get Commit
* invoke - Invoke
* listTags - List Tags
* createTag - Create Tag
* deleteFunction - Delete Function
* getFunction - Get Function
* updateFunction - Update Function
$3
* search - Search
$3
* list - List
* update - Update
$3
* list - NOTE: Only shows personal clients for the current user.
* create - Create
* delete - Delete
* get - Get
* update - Update
$3
* search - NOTE: Searches personal clients for all users
$3
* list - List
* create - Create
* delete - Delete
* get - Get
* update - Update
$3
* search - Search
$3
* validateCEL - Validate Cel
$3
* list - List
* create - Create
* listAllEntitlementIdsPerApp - List All Entitlement Ids Per App
* listEntitlementsPerCatalog - List Entitlements Per Catalog
* updateAppEntitlements - Update App Entitlements
* removeAppEntitlements - Remove App Entitlements
* addAppEntitlements - Add App Entitlements
* removeAccessEntitlements - Remove Access Entitlements
* addAccessEntitlements - Add Access Entitlements
* listEntitlementsForAccess - List Entitlements For Access
* delete - Delete
* get - Get
* update - Update
* deleteBundleAutomation - Delete Bundle Automation
* getBundleAutomation - Get Bundle Automation
* setBundleAutomation - Set Bundle Automation
* createBundleAutomation - Create Bundle Automation
* resumePausedBundleAutomation - Resume Paused Bundle Automation
* forceRunBundleAutomation - Force Run Bundle Automation
$3
* searchEntitlements - Search Entitlements
$3
* removeEntitlementBinding - Remove Entitlement Binding
* createEntitlementBinding - Create Entitlement Binding
* findBindingForAppEntitlement - Find Binding For App Entitlement
* create - Create
* delete - Delete
* get - Get
* update - Update
$3
* list - List
* get - Get
* update - Update
$3
* get - Get
* update - Update
* testSourceIP - Test Source Ip
$3
* search - Search
* list - List
* create - Create
* delete - Delete
* get - Get
* update - Update
* updateSecret - Update Secret
* test - Test
$3
* search - Search
* get - Get
$3
* listEvents - List Events
$3
* createGrantTask - Create Grant Task
* createOffboardingTask - Create Offboarding Task
* createRevokeTask - Create Revoke Task
* get - Get
$3
* approve - Approve
* approveWithStepUp - Approve With Step Up
* close - Close
* comment - Comment
* deny - Deny
* escalateToEmergencyAccess - Escalate To Emergency Access
* processNow - Process Now
* reassign - Reassign
* hardReset - Hard Reset
* restart - Restart
* skipStep - Skip Step
* updateGrantDuration - Update Grant Duration
* updateRequestData - Update Request Data
$3
* list - List
$3
* search - Search
$3
* list - List
* get - Get
* getUserProfileTypes - Get User Profile Types
* setExpiringUserDelegationBindingByAdmin - Set Expiring User Delegation Binding By Admin
$3
* search - Search
$3
* list - List
* create - Create
* delete - Delete
* get - Get
* update - Update
* test - Test
$3
* search - Search



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

[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of

Here's an example of one such pagination call:

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

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

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

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

run();

`Retries`

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:`typescript import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

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

console.log(result); }

run();

async function run() { const result = await conductoroneSDKTypescript.accessConflict.createMonitor();

console.log(result); }

run();

`Error Handling`

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

`$3`

typescript
import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";
import * as errors from "conductorone-sdk-typescript/sdk/models/errors";
const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "",
    oauth: "",
  },
});
async function run() {
  try {
    const result = await conductoroneSDKTypescript.accessConflict
      .createMonitor();
    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();

`$3`


Primary error:
*

ConductoroneSDKTypescriptError

: The base class for HTTP error responses.

Less common errors (6)



Server Selection
$3

#### Example

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

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({ tenantDomain: "", security: { bearerAuth: "", oauth: "", }, });

async function run() { const result = await conductoroneSDKTypescript.accessConflict.createMonitor();

console.log(result); }

run();

`$3`

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

async function run() { const result = await conductoroneSDKTypescript.accessConflict.createMonitor();

console.log(result); }

run();

`Custom HTTP Client`

The HTTPClient constructor takes an optional fetcherargument 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 use the "beforeRequest"hook to to add a custom header and a timeout to requests and how to use the"requestError"hook to log errors:

`typescript import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript"; import { HTTPClient } from "conductorone-sdk-typescript/lib/http";

const httpClient = new HTTPClient({ // fetcher takes a function that has the same signature as nativefetch. fetcher: (request) => { return fetch(request); } });

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; });

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.

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

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

conductorone-sdk-typescript

conductorone-sdk-typescript

Summary

Table of Contents

SDK Installation

$3

$3

$3

$3

Requirements

SDK Example Usage

$3

Authentication

$3

Available Resources and Operations

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

Standalone functions

Pagination

Retries

Error Handling

$3

$3

Server Selection

`$3`

`$3`

`$3`

`Requirements`

`SDK Example Usage`

`$3`

`Authentication`

`$3`

`Available Resources and Operations`

`Retries`

`Error Handling`

`$3`

`$3`

`$3`

`Custom HTTP Client`

`Debugging`

`$3`

`$3`

`$3`

`Requirements`

`SDK Example Usage`

`$3`

`Authentication`

`$3`

`Available Resources and Operations`