conductoroneapi

README

conductorone-api

SDK Installation

go get github.com/conductorone/conductorone-sdk-go

SDK Example Usage

package main

import(
	"context"
	"log"
	"github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/operations"
)

func main() {
    s := conductoroneapi.New()

    ctx := context.Background()
    res, err := s.AppEntitlementUserBinding.ListAppUsersForIdentityWithGrant(ctx, operations.C1APIAppV1AppEntitlementUserBindingServiceListAppUsersForIdentityWithGrantRequest{
        AppEntitlementID: "corrupti",
        AppID: "provident",
        IdentityUserID: "distinctio",
    })
    if err != nil {
        log.Fatal(err)
    }

    if res.ListAppUsersForIdentityWithGrantResponse != nil {
        // handle response
    }
}

Available Resources and Operations

AppEntitlementUserBinding

• ListAppUsersForIdentityWithGrant - Invokes the c1.api.app.v1.AppEntitlementUserBindingService.ListAppUsersForIdentityWithGrant method.

AppEntitlements

• Get - Invokes the c1.api.app.v1.AppEntitlements.Get method.

AppReport

• List - Invokes the c1.api.app.v1.AppReportService.List method.

AppReportAction

• GenerateReport - Invokes the c1.api.app.v1.AppReportActionService.GenerateReport method.

AppResource

• Get - Invokes the c1.api.app.v1.AppResourceService.Get method.
• List - Invokes the c1.api.app.v1.AppResourceService.List method.

AppResourceSearch

• SearchAppResourceTypes - Invokes the c1.api.app.v1.AppResourceSearch.SearchAppResourceTypes method.

AppResourceType

• Get - Invokes the c1.api.app.v1.AppResourceTypeService.Get method.

AppSearch

• Search - Invokes the c1.api.app.v1.AppSearch.Search method.

AppUsageControls

• Get - Invokes the c1.api.app.v1.AppUsageControlsService.Get method.

Apps

• Get - Invokes the c1.api.app.v1.Apps.Get method.
• List - Invokes the c1.api.app.v1.Apps.List method.

Auth

• Introspect - Invokes the c1.api.auth.v1.Auth.Introspect method.

Directory

• Create - Invokes the c1.api.directory.v1.DirectoryService.Create method.
• Delete - Invokes the c1.api.directory.v1.DirectoryService.Delete method.
• Get - Invokes the c1.api.directory.v1.DirectoryService.Get method.
• List - Invokes the c1.api.directory.v1.DirectoryService.List method.

Policies

• Create - Invokes the c1.api.policy.v1.Policies.Create method.
• Delete - Invokes the c1.api.policy.v1.Policies.Delete method.
• Get - Invokes the c1.api.policy.v1.Policies.Get method.
• List - Invokes the c1.api.policy.v1.Policies.List method.

RequestCatalogSearch

• SearchEntitlements - Invokes the c1.api.requestcatalog.v1.RequestCatalogSearchService.SearchEntitlements method.

Roles

• Get - Invokes the c1.api.iam.v1.Roles.Get method.
• List - Invokes the c1.api.iam.v1.Roles.List method.

Task

• CreateGrantTask - Invokes the c1.api.task.v1.TaskService.CreateGrantTask method.
• CreateRevokeTask - Invokes the c1.api.task.v1.TaskService.CreateRevokeTask method.
• Get - Invokes the c1.api.task.v1.TaskService.Get method.

TaskActions

• Approve - Invokes the c1.api.task.v1.TaskActionsService.Approve method.
• Comment - Invokes the c1.api.task.v1.TaskActionsService.Comment method.
• Deny - Invokes the c1.api.task.v1.TaskActionsService.Deny method.

TaskSearch

• Search - Invokes the c1.api.task.v1.TaskSearchService.Search method.

User

• Get - Invokes the c1.api.user.v1.UserService.Get method.
• List - Invokes the c1.api.user.v1.UserService.List method.

UserSearch

• Search - Invokes the c1.api.user.v1.UserSearch.Search method.

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 !

SDK Created by Speakeasy

Documentation

Index

• Variables
• func Bool(b bool) *bool
• func Float32(f float32) *float32
• func Float64(f float64) *float64
• func Int(i int) *int
• func Int64(i int64) *int64
• func String(s string) *string
• type ConductoroneAPI
  • func New(opts ...SDKOption) *ConductoroneAPI
• type HTTPClient
• type SDKOption
  • func WithClient(client HTTPClient) SDKOption
  • func WithServerIndex(serverIndex int) SDKOption
  • func WithServerURL(serverURL string) SDKOption
  • func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption
  • func WithTenantDomain(tenantDomain string) SDKOption

Variables

var ServerList = []string{

	"https://{tenantDomain}.conductor.one",
}

ServerList contains the list of servers available to the SDK

Functions

func Bool

func Bool(b bool) *bool

Bool provides a helper function to return a pointer to a bool

func Float32

func Float32(f float32) *float32

Float32 provides a helper function to return a pointer to a float32

func Float64

func Float64(f float64) *float64

Float64 provides a helper function to return a pointer to a float64

func Int

func Int(i int) *int

Int provides a helper function to return a pointer to an int

func Int64

func Int64(i int64) *int64

Int64 provides a helper function to return a pointer to an int64

func String

func String(s string) *string

String provides a helper function to return a pointer to a string

Types

type ConductoroneAPI

type ConductoroneAPI struct {
	AppEntitlementUserBinding *appEntitlementUserBinding
	AppEntitlements           *appEntitlements
	AppReport                 *appReport
	AppReportAction           *appReportAction
	AppResource               *appResource
	AppResourceSearch         *appResourceSearch
	AppResourceType           *appResourceType
	AppSearch                 *appSearch
	AppUsageControls          *appUsageControls
	Apps                      *apps
	Auth                      *auth
	Directory                 *directory
	Policies                  *policies
	RequestCatalogSearch      *requestCatalogSearch
	Roles                     *roles
	Task                      *task
	TaskActions               *taskActions
	TaskSearch                *taskSearch
	User                      *user
	UserSearch                *userSearch
	// contains filtered or unexported fields
}

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

func New

func New(opts ...SDKOption) *ConductoroneAPI

New creates a new instance of the SDK with the provided options

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient provides an interface for suplying the SDK with a custom HTTP client

type SDKOption

type SDKOption func(*ConductoroneAPI)

func WithClient

func WithClient(client HTTPClient) SDKOption

WithClient allows the overriding of the default HTTP client used by the SDK

func WithServerIndex

func WithServerIndex(serverIndex int) SDKOption

WithServerIndex allows the overriding of the default server by index

func WithServerURL

func WithServerURL(serverURL string) SDKOption

WithServerURL allows the overriding of the default server URL

func WithTemplatedServerURL

func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters

func WithTenantDomain

func WithTenantDomain(tenantDomain string) SDKOption

WithTenantDomain allows setting the $name variable for url substitution