conductorone-sdk-typescript

SDK Installation

NPM

npm add https://github.com/ConductorOne/conductorone-sdk-typescript

Yarn

yarn add https://github.com/ConductorOne/conductorone-sdk-typescript

SDK Example Usage

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";
import { C1ApiAppV1AppEntitlementOwnersAddResponse } from "conductorone-sdk-typescript/dist/sdk/models/operations";

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

sdk.appEntitlementOwners.add({
  addAppEntitlementOwnerRequest: {
    userId: "quibusdam",
  },
  appId: "unde",
  entitlementId: "nulla",
}).then((res: C1ApiAppV1AppEntitlementOwnersAddResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Available Resources and Operations

appEntitlementOwners

add - Add
list - List
remove - Remove
set - Set

appEntitlementUserBinding

listAppUsersForIdentityWithGrant - List App Users For Identity With Grant

appEntitlements

get - Get
list - List
listForAppResource - List For App Resource
listForAppUser - List For App User
listUsers - List Users
update - Update

appResourceSearch

searchAppResourceTypes - Search App Resource Types

apps

create - Create
delete - Delete
get - Get
list - List
update - Update

attributeSearch

searchAttributeValues - Search Attribute Values

attributes

createAttributeValue - Create Attribute Value
deleteAttributeValue - Delete Attribute Value
getAttributeValue - Get Attribute Value
listAttributeTypes - List Attribute Types
listAttributeValues - List Attribute Values

connector

create - Create
createDelegated - Create Delegated
delete - Delete
get - Get
getCredentials - Get Credentials
list - List
revokeCredential - Revoke Credential
rotateCredential - Rotate Credential
update - Update
updateDelegated - Update Delegated

policies

create - Create
delete - Delete
get - Get
list - List
update - Update

requestCatalogManagement

addAccessEntitlements - Add Access Entitlements
addAppEntitlements - Add App Entitlements
create - Create
delete - Delete
get - Get
list - List
listEntitlementsForAccess - List Entitlements For Access
listEntitlementsPerCatalog - List Entitlements Per Catalog
removeAccessEntitlements - Remove Access Entitlements
removeAppEntitlements - Remove App Entitlements
update - Update

requestCatalogSearch

searchEntitlements - Search Entitlements

task

createGrantTask - Create Grant Task
createRevokeTask - Create Revoke Task
get - Get

taskActions

approve - Approve
comment - Comment
deny - Deny
escalateToEmergencyAccess - Escalate To Emergency Access

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 have a next method that can be called to pull down the next group of results. If the return value of next is null, then there are no more pages to be fetched.

Here's an example of one such pagination call:

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. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

speakeasybot/conductorone-sdk-typescript