conductoronesdkgo

package module
v2.1.13-0...-95ca5db Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 28, 2023 License: MIT Imports: 29 Imported by: 0

README

conductorone-api

SDK Installation

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

SDK Example Usage

Example
package main

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

func main() {
	ctx := context.Background()

	s := NewWithCredentials(ctx, &ClientCredentials{
		ClientID:     "",
		ClientSecret: "",
	} )

	res, err := s.Apps.Create(ctx, &shared.CreateAppRequest{
		Owners: []string{
			"string",
		},
	})
	if err != nil {
		log.Fatal(err)
	}

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

Available Resources and Operations

Apps
Connector
AppEntitlements
AppEntitlementUserBinding
AppEntitlementOwners
AppOwners
AppReport
AppReportAction
AppResourceType
AppResource
AppResourceOwners
AppUsageControls
AppUser
Attributes
Auth
RequestCatalogManagement
Directory
PersonalClient
Roles
Policies
PolicyValidate
AppResourceSearch
AppSearch
AttributeSearch
AppEntitlementSearch
PolicySearch
RequestCatalogSearch
TaskSearch
UserSearch
Task
TaskActions
User

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.

Error Object Status Code Content Type
sdkerrors.SDKError 400-600 /
Example
package main

import (
	"context"
	"errors"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go/v2"
	"github.com/conductorone/conductorone-sdk-go/v2/pkg/models/sdkerrors"
	"github.com/conductorone/conductorone-sdk-go/v2/pkg/models/shared"
	"log"
)

func main() {
	ctx := context.Background()

	s := NewWithCredentials(ctx, &ClientCredentials{
		ClientID:     "",
		ClientSecret: "",
	})
	res, err := s.Apps.Create(ctx, &shared.CreateAppRequest{
		Owners: []string{
			"string",
		},
	})
	if err != nil {

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

SDK Example Usage with Custom Server/Tenant

Example
package main

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

func main() {
	ctx := context.Background()

	/* Optional Override 
	* Server URL will be extracted from client, optionally, you can
	* provide a server URL or a tenant domain (will create URL https://{tenant_domain}.conductor.one) 
	*/
	opts := []sdk.CustomSDKOption{}
	opt, _ := sdk.WithTenantCustom("Server URL or Tenant Domain")
	opts = append(opts, opt)

	s := NewWithCredentials(ctx, &ClientCredentials{
		ClientID:     "",
		ClientSecret: "",
	} opts...)

	res, err := s.Apps.Create(ctx, &shared.CreateAppRequest{
		Owners: []string{
			"string",
		},
	})
	if err != nil {
		log.Fatal(err)
	}

	if res.CreateAppResponse != nil {
		// handle response
	}
}
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

Constants

View Source 
const ClientIdGolangSDK = "2RCzHlak5q7CY14SdBc8HoZEJRf"

Variables

View Source 
var (
	ErrInvalidClientSecret = errors.New("invalid client secret")
	ErrInvalidClientID     = errors.New("invalid client id")
)
View Source 
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 NewTokenSource 

func NewTokenSource(ctx context.Context, clientID string, clientSecret string, tokenHost string) (oauth2.TokenSource, error)

func String 

func String(s string) *string

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

Types

type AppEntitlementOwners 

type AppEntitlementOwners struct {
	// contains filtered or unexported fields
}

func (*AppEntitlementOwners) Add 

func (s *AppEntitlementOwners) Add(ctx context.Context, request operations.C1APIAppV1AppEntitlementOwnersAddRequest) (*operations.C1APIAppV1AppEntitlementOwnersAddResponse, error)

Add Add an owner to a given app entitlement.

func (*AppEntitlementOwners) List 

func (s *AppEntitlementOwners) List(ctx context.Context, request operations.C1APIAppV1AppEntitlementOwnersListRequest) (*operations.C1APIAppV1AppEntitlementOwnersListResponse, error)

List List owners for a given app entitlement.

func (*AppEntitlementOwners) Remove 

func (s *AppEntitlementOwners) Remove(ctx context.Context, request operations.C1APIAppV1AppEntitlementOwnersRemoveRequest) (*operations.C1APIAppV1AppEntitlementOwnersRemoveResponse, error)

Remove Remove an owner from a given app entitlement.

func (*AppEntitlementOwners) Set 

func (s *AppEntitlementOwners) Set(ctx context.Context, request operations.C1APIAppV1AppEntitlementOwnersSetRequest) (*operations.C1APIAppV1AppEntitlementOwnersSetResponse, error)

Set Sets the owners for a given app entitlement to the specified list of users.

type AppEntitlementSearch 

type AppEntitlementSearch struct {
	// contains filtered or unexported fields
}

func (*AppEntitlementSearch) Search 

func (s *AppEntitlementSearch) Search(ctx context.Context, request *shared.AppEntitlementSearchServiceSearchRequest) (*operations.C1APIAppV1AppEntitlementSearchServiceSearchResponse, error)

Search Search app entitlements based on filters specified in the request body.

type AppEntitlementUserBinding 

type AppEntitlementUserBinding struct {
	// contains filtered or unexported fields
}

func (*AppEntitlementUserBinding) ListAppUsersForIdentityWithGrant 

func (s *AppEntitlementUserBinding) ListAppUsersForIdentityWithGrant(ctx context.Context, request operations.C1APIAppV1AppEntitlementUserBindingServiceListAppUsersForIdentityWithGrantRequest) (*operations.C1APIAppV1AppEntitlementUserBindingServiceListAppUsersForIdentityWithGrantResponse, error)

ListAppUsersForIdentityWithGrant - List App Users For Identity With Grant Returns a list of app users for the identity in the app. If that app user also has a grant to the entitlement from the request, data about the grant is also returned. It will always return ALL app users for this identity, but only SOME may have grant data.

type AppEntitlements 

type AppEntitlements struct {
	// contains filtered or unexported fields
}

func (*AppEntitlements) Get 

func (s *AppEntitlements) Get(ctx context.Context, request operations.C1APIAppV1AppEntitlementsGetRequest) (*operations.C1APIAppV1AppEntitlementsGetResponse, error)

Get Get an app entitlement by ID.

func (*AppEntitlements) List 

func (s *AppEntitlements) List(ctx context.Context, request operations.C1APIAppV1AppEntitlementsListRequest) (*operations.C1APIAppV1AppEntitlementsListResponse, error)

List List app entitlements associated with an app.

func (*AppEntitlements) ListForAppResource 

func (s *AppEntitlements) ListForAppResource(ctx context.Context, request operations.C1APIAppV1AppEntitlementsListForAppResourceRequest) (*operations.C1APIAppV1AppEntitlementsListForAppResourceResponse, error)

ListForAppResource - List For App Resource List app entitlements associated with an app resource.

func (*AppEntitlements) ListForAppUser 

func (s *AppEntitlements) ListForAppUser(ctx context.Context, request operations.C1APIAppV1AppEntitlementsListForAppUserRequest) (*operations.C1APIAppV1AppEntitlementsListForAppUserResponse, error)

ListForAppUser - List For App User List app entitlements associated with an app user.

func (*AppEntitlements) ListUsers 

func (s *AppEntitlements) ListUsers(ctx context.Context, request operations.C1APIAppV1AppEntitlementsListUsersRequest) (*operations.C1APIAppV1AppEntitlementsListUsersResponse, error)

ListUsers - List Users List the users, as AppEntitlementUsers objects, of an app entitlement.

func (*AppEntitlements) Update 

func (s *AppEntitlements) Update(ctx context.Context, request operations.C1APIAppV1AppEntitlementsUpdateRequest) (*operations.C1APIAppV1AppEntitlementsUpdateResponse, error)

Update Update an app entitlement by ID.

type AppOwners 

type AppOwners struct {
	// contains filtered or unexported fields
}

func (*AppOwners) Add 

func (s *AppOwners) Add(ctx context.Context, request operations.C1APIAppV1AppOwnersAddRequest) (*operations.C1APIAppV1AppOwnersAddResponse, error)

Add Adds an owner to an app.

func (*AppOwners) List 

func (s *AppOwners) List(ctx context.Context, request operations.C1APIAppV1AppOwnersListRequest) (*operations.C1APIAppV1AppOwnersListResponse, error)

List List owners of an app.

func (*AppOwners) Remove 

func (s *AppOwners) Remove(ctx context.Context, request operations.C1APIAppV1AppOwnersRemoveRequest) (*operations.C1APIAppV1AppOwnersRemoveResponse, error)

Remove Removes an owner from an app.

func (*AppOwners) Set 

func (s *AppOwners) Set(ctx context.Context, request operations.C1APIAppV1AppOwnersSetRequest) (*operations.C1APIAppV1AppOwnersSetResponse, error)

Set Sets the owners for a given app to the specified list of users.

type AppReport 

type AppReport struct {
	// contains filtered or unexported fields
}

func (*AppReport) List 

func (s *AppReport) List(ctx context.Context, request operations.C1APIAppV1AppReportServiceListRequest) (*operations.C1APIAppV1AppReportServiceListResponse, error)

List Get a list of reports for the given app.

type AppReportAction 

type AppReportAction struct {
	// contains filtered or unexported fields
}

func (*AppReportAction) GenerateReport 

func (s *AppReportAction) GenerateReport(ctx context.Context, request operations.C1APIAppV1AppReportActionServiceGenerateReportRequest) (*operations.C1APIAppV1AppReportActionServiceGenerateReportResponse, error)

GenerateReport - Generate Report Generate a report for the given app.

type AppResource 

type AppResource struct {
	// contains filtered or unexported fields
}

func (*AppResource) Get 

func (s *AppResource) Get(ctx context.Context, request operations.C1APIAppV1AppResourceServiceGetRequest) (*operations.C1APIAppV1AppResourceServiceGetResponse, error)

Get Invokes the c1.api.app.v1.AppResourceService.Get method.

func (*AppResource) List 

func (s *AppResource) List(ctx context.Context, request operations.C1APIAppV1AppResourceServiceListRequest) (*operations.C1APIAppV1AppResourceServiceListResponse, error)

List Invokes the c1.api.app.v1.AppResourceService.List method.

type AppResourceOwners 

type AppResourceOwners struct {
	// contains filtered or unexported fields
}

func (*AppResourceOwners) List 

func (s *AppResourceOwners) List(ctx context.Context, request operations.C1APIAppV1AppResourceOwnersListRequest) (*operations.C1APIAppV1AppResourceOwnersListResponse, error)

List List all owners of an app resource.

type AppResourceSearch 

type AppResourceSearch struct {
	// contains filtered or unexported fields
}

func (*AppResourceSearch) SearchAppResourceTypes 

func (s *AppResourceSearch) SearchAppResourceTypes(ctx context.Context, request *shared.SearchAppResourceTypesRequest) (*operations.C1APIAppV1AppResourceSearchSearchAppResourceTypesResponse, error)

SearchAppResourceTypes - Search App Resource Types Search app resources based on filters specified in the request body.

type AppResourceType 

type AppResourceType struct {
	// contains filtered or unexported fields
}

func (*AppResourceType) Get 

func (s *AppResourceType) Get(ctx context.Context, request operations.C1APIAppV1AppResourceTypeServiceGetRequest) (*operations.C1APIAppV1AppResourceTypeServiceGetResponse, error)

Get Get an app resource type.

func (*AppResourceType) List 

func (s *AppResourceType) List(ctx context.Context, request operations.C1APIAppV1AppResourceTypeServiceListRequest) (*operations.C1APIAppV1AppResourceTypeServiceListResponse, error)

List List app resource types.

type AppSearch 

type AppSearch struct {
	// contains filtered or unexported fields
}

func (*AppSearch) Search 

func (s *AppSearch) Search(ctx context.Context, request *shared.SearchAppsRequest) (*operations.C1APIAppV1AppSearchSearchResponse, error)

Search Search apps based on filters specified in the request body.

type AppUsageControls 

type AppUsageControls struct {
	// contains filtered or unexported fields
}

func (*AppUsageControls) Get 

func (s *AppUsageControls) Get(ctx context.Context, request operations.C1APIAppV1AppUsageControlsServiceGetRequest) (*operations.C1APIAppV1AppUsageControlsServiceGetResponse, error)

Get Get usage controls, as an AppUsageControls object which describes some peripheral configuration, for an app.

func (*AppUsageControls) Update 

func (s *AppUsageControls) Update(ctx context.Context, request operations.C1APIAppV1AppUsageControlsServiceUpdateRequest) (*operations.C1APIAppV1AppUsageControlsServiceUpdateResponse, error)

Update Update usage controls for an app.

type AppUser 

type AppUser struct {
	// contains filtered or unexported fields
}

func (*AppUser) Update 

func (s *AppUser) Update(ctx context.Context, request operations.C1APIAppV1AppUserServiceUpdateRequest) (*operations.C1APIAppV1AppUserServiceUpdateResponse, error)

Update Update an app user by ID. Only the fields specified in the update mask are updated. 

Currently, only the appUserType, and identityUserId fields can be updated.

type Apps 

type Apps struct {
	// contains filtered or unexported fields
}

func (*Apps) Create 

func (s *Apps) Create(ctx context.Context, request *shared.CreateAppRequest) (*operations.C1APIAppV1AppsCreateResponse, error)

Create Create a new app.

func (*Apps) Delete 

func (s *Apps) Delete(ctx context.Context, request operations.C1APIAppV1AppsDeleteRequest) (*operations.C1APIAppV1AppsDeleteResponse, error)

Delete Delete an app.

func (*Apps) Get 

func (s *Apps) Get(ctx context.Context, request operations.C1APIAppV1AppsGetRequest) (*operations.C1APIAppV1AppsGetResponse, error)

Get Get an app by ID.

func (*Apps) List 

func (s *Apps) List(ctx context.Context, request operations.C1APIAppV1AppsListRequest) (*operations.C1APIAppV1AppsListResponse, error)

List List all apps.

func (*Apps) Update 

func (s *Apps) Update(ctx context.Context, request operations.C1APIAppV1AppsUpdateRequest) (*operations.C1APIAppV1AppsUpdateResponse, error)

Update Update an existing app.

type AttributeSearch 

type AttributeSearch struct {
	// contains filtered or unexported fields
}

func (*AttributeSearch) SearchAttributeValues 

func (s *AttributeSearch) SearchAttributeValues(ctx context.Context, request *shared.SearchAttributeValuesRequest) (*operations.C1APIAttributeV1AttributeSearchSearchAttributeValuesResponse, error)

SearchAttributeValues - Search Attribute Values Search attributes based on filters specified in the request body.

type Attributes 

type Attributes struct {
	// contains filtered or unexported fields
}

func (*Attributes) CreateAttributeValue 

func (s *Attributes) CreateAttributeValue(ctx context.Context, request *shared.CreateAttributeValueRequest) (*operations.C1APIAttributeV1AttributesCreateAttributeValueResponse, error)

CreateAttributeValue - Create Attribute Value Create a new attribute value.

func (*Attributes) DeleteAttributeValue 

func (s *Attributes) DeleteAttributeValue(ctx context.Context, request operations.C1APIAttributeV1AttributesDeleteAttributeValueRequest) (*operations.C1APIAttributeV1AttributesDeleteAttributeValueResponse, error)

DeleteAttributeValue - Delete Attribute Value Delete an attribute value by id.

func (*Attributes) GetAttributeValue 

func (s *Attributes) GetAttributeValue(ctx context.Context, request operations.C1APIAttributeV1AttributesGetAttributeValueRequest) (*operations.C1APIAttributeV1AttributesGetAttributeValueResponse, error)

GetAttributeValue - Get Attribute Value Get an attribute value by id.

func (*Attributes) ListAttributeTypes 

func (s *Attributes) ListAttributeTypes(ctx context.Context, request operations.C1APIAttributeV1AttributesListAttributeTypesRequest) (*operations.C1APIAttributeV1AttributesListAttributeTypesResponse, error)

ListAttributeTypes - List Attribute Types List all attribute types.

func (*Attributes) ListAttributeValues 

func (s *Attributes) ListAttributeValues(ctx context.Context, request operations.C1APIAttributeV1AttributesListAttributeValuesRequest) (*operations.C1APIAttributeV1AttributesListAttributeValuesResponse, error)

ListAttributeValues - List Attribute Values List all attribute values for a given attribute type.

type Auth 

type Auth struct {
	// contains filtered or unexported fields
}

func (*Auth) Introspect 

func (s *Auth) Introspect(ctx context.Context) (*operations.C1APIAuthV1AuthIntrospectResponse, error)

Introspect Introspect returns the current user's principle_id, user_id and a list of roles, permissions, and enabled features.

type ClientConfig 

type ClientConfig struct {
	// contains filtered or unexported fields
}

func NormalizeTenant 

func NormalizeTenant(input string) (*ClientConfig, error)

func ParseClientID 

func ParseClientID(input string) (*ClientConfig, error)

func (*ClientConfig) GetServerURL 

func (c *ClientConfig) GetServerURL() string

GetServerURL returns the server URL. If serverURL is empty (""), it constructs the server URL using the tenant. However, if the tenant is also empty, then it will return an empty string.

func (*ClientConfig) ServerURL 

func (c *ClientConfig) ServerURL() string

ServerURL returns the server URL.

func (*ClientConfig) SetServerURL 

func (c *ClientConfig) SetServerURL(serverURL string) error

func (*ClientConfig) SetTenant 

func (c *ClientConfig) SetTenant(tenant string) error

func (*ClientConfig) Tenant 

func (c *ClientConfig) Tenant() string

func (*ClientConfig) UseWithServer 

func (c *ClientConfig) UseWithServer() bool

func (*ClientConfig) UseWithTenant 

func (c *ClientConfig) UseWithTenant() bool

type ClientCredentials 

type ClientCredentials struct {
	ClientID     string
	ClientSecret string
}

func LoginFlow 

func LoginFlow(
	ctx context.Context,
	tenantName string,
	clientID string,
	personalClientCredentialDisplayName string,
	cb func(validateDetails *DeviceCodeResponse) error,
) (*ClientCredentials, error)

type ConductoroneAPI 

type ConductoroneAPI struct {
	Apps                      *Apps
	Connector                 *Connector
	AppEntitlements           *AppEntitlements
	AppEntitlementUserBinding *AppEntitlementUserBinding
	AppEntitlementOwners      *AppEntitlementOwners
	AppOwners                 *AppOwners
	AppReport                 *AppReport
	AppReportAction           *AppReportAction
	AppResourceType           *AppResourceType
	AppResource               *AppResource
	AppResourceOwners         *AppResourceOwners
	AppUsageControls          *AppUsageControls
	AppUser                   *AppUser
	Attributes                *Attributes
	Auth                      *Auth
	RequestCatalogManagement  *RequestCatalogManagement
	Directory                 *Directory
	PersonalClient            *PersonalClient
	Roles                     *Roles
	Policies                  *Policies
	PolicyValidate            *PolicyValidate
	AppResourceSearch         *AppResourceSearch
	AppSearch                 *AppSearch
	AttributeSearch           *AttributeSearch
	AppEntitlementSearch      *AppEntitlementSearch
	PolicySearch              *PolicySearch
	RequestCatalogSearch      *RequestCatalogSearch
	TaskSearch                *TaskSearch
	UserSearch                *UserSearch
	Task                      *Task
	TaskActions               *TaskActions
	User                      *User
	// 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

func NewWithCredentials 

func NewWithCredentials(ctx context.Context, cred *ClientCredentials, opts ...CustomSDKOption) (*ConductoroneAPI, error)

type Connector 

type Connector struct {
	// contains filtered or unexported fields
}

func (*Connector) Create 

func (s *Connector) Create(ctx context.Context, request operations.C1APIAppV1ConnectorServiceCreateRequest) (*operations.C1APIAppV1ConnectorServiceCreateResponse, error)

Create Create a configured connector.

func (*Connector) CreateDelegated 

func (s *Connector) CreateDelegated(ctx context.Context, request operations.C1APIAppV1ConnectorServiceCreateDelegatedRequest) (*operations.C1APIAppV1ConnectorServiceCreateDelegatedResponse, error)

CreateDelegated - Create Delegated Create a connector that is pending a connector config.

func (*Connector) Delete 

func (s *Connector) Delete(ctx context.Context, request operations.C1APIAppV1ConnectorServiceDeleteRequest) (*operations.C1APIAppV1ConnectorServiceDeleteResponse, error)

Delete Delete a connector.

func (*Connector) Get 

func (s *Connector) Get(ctx context.Context, request operations.C1APIAppV1ConnectorServiceGetRequest) (*operations.C1APIAppV1ConnectorServiceGetResponse, error)

Get Get a connector.

func (*Connector) GetCredentials 

func (s *Connector) GetCredentials(ctx context.Context, request operations.C1APIAppV1ConnectorServiceGetCredentialsRequest) (*operations.C1APIAppV1ConnectorServiceGetCredentialsResponse, error)

GetCredentials - Get Credentials Get credentials for a connector.

func (*Connector) List 

func (s *Connector) List(ctx context.Context, request operations.C1APIAppV1ConnectorServiceListRequest) (*operations.C1APIAppV1ConnectorServiceListResponse, error)

List List connectors for an app.

func (*Connector) RevokeCredential 

func (s *Connector) RevokeCredential(ctx context.Context, request operations.C1APIAppV1ConnectorServiceRevokeCredentialRequest) (*operations.C1APIAppV1ConnectorServiceRevokeCredentialResponse, error)

RevokeCredential - Revoke Credential Revoke credentials for a connector.

func (*Connector) RotateCredential 

func (s *Connector) RotateCredential(ctx context.Context, request operations.C1APIAppV1ConnectorServiceRotateCredentialRequest) (*operations.C1APIAppV1ConnectorServiceRotateCredentialResponse, error)

RotateCredential - Rotate Credential Rotate credentials for a connector.

func (*Connector) Update 

func (s *Connector) Update(ctx context.Context, request operations.C1APIAppV1ConnectorServiceUpdateRequest) (*operations.C1APIAppV1ConnectorServiceUpdateResponse, error)

Update Update a connector.

func (*Connector) UpdateDelegated 

func (s *Connector) UpdateDelegated(ctx context.Context, request operations.C1APIAppV1ConnectorServiceUpdateDelegatedRequest) (*operations.C1APIAppV1ConnectorServiceUpdateDelegatedResponse, error)

UpdateDelegated - Update Delegated Update a delegated connector.

type CustomOptions 

type CustomOptions struct {
	*ClientConfig
	// contains filtered or unexported fields
}

type CustomSDKOption 

type CustomSDKOption func(*CustomOptions)

func WithLog 

func WithLog(logger *zap.Logger) CustomSDKOption

func WithTLSConfig 

func WithTLSConfig(tlsConfig *tls.Config) CustomSDKOption

func WithTenantCustom 

func WithTenantCustom(input string) (CustomSDKOption, error)

func WithUserAgent 

func WithUserAgent(userAgent string) CustomSDKOption

type DeviceCodeResponse 

type DeviceCodeResponse struct {
	DeviceCode      string `json:"device_code"`
	UserCode        string `json:"user_code"`
	VerificationURI string `json:"verification_uri_complete"`
	ExpiresIn       int64  `json:"expires_in"`
	Interval        int64  `json:"interval"`
}

type Directory 

type Directory struct {
	// contains filtered or unexported fields
}

func (*Directory) Create 

func (s *Directory) Create(ctx context.Context, request *shared.DirectoryServiceCreateRequest) (*operations.C1APIDirectoryV1DirectoryServiceCreateResponse, error)

Create Create a directory.

func (*Directory) Delete 

func (s *Directory) Delete(ctx context.Context, request operations.C1APIDirectoryV1DirectoryServiceDeleteRequest) (*operations.C1APIDirectoryV1DirectoryServiceDeleteResponse, error)

Delete Delete a directory by app_id.

func (*Directory) Get 

func (s *Directory) Get(ctx context.Context, request operations.C1APIDirectoryV1DirectoryServiceGetRequest) (*operations.C1APIDirectoryV1DirectoryServiceGetResponse, error)

Get Get a directory by app_id.

func (*Directory) List 

func (s *Directory) List(ctx context.Context, request operations.C1APIDirectoryV1DirectoryServiceListRequest) (*operations.C1APIDirectoryV1DirectoryServiceListResponse, error)

List List directories.

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 PersonalClient 

type PersonalClient struct {
	// contains filtered or unexported fields
}

func (*PersonalClient) Create 

func (s *PersonalClient) Create(ctx context.Context, request *shared.PersonalClientServiceCreateRequest) (*operations.C1APIIamV1PersonalClientServiceCreateResponse, error)

Create Create creates a new PersonalClient object for the current User.

type Policies 

type Policies struct {
	// contains filtered or unexported fields
}

func (*Policies) Create 

func (s *Policies) Create(ctx context.Context, request *shared.CreatePolicyRequest) (*operations.C1APIPolicyV1PoliciesCreateResponse, error)

Create Create a policy.

func (*Policies) Delete 

func (s *Policies) Delete(ctx context.Context, request operations.C1APIPolicyV1PoliciesDeleteRequest) (*operations.C1APIPolicyV1PoliciesDeleteResponse, error)

Delete Delete a policy by ID.

func (*Policies) Get 

func (s *Policies) Get(ctx context.Context, request operations.C1APIPolicyV1PoliciesGetRequest) (*operations.C1APIPolicyV1PoliciesGetResponse, error)

Get Get a policy by ID.

func (*Policies) List 

func (s *Policies) List(ctx context.Context, request operations.C1APIPolicyV1PoliciesListRequest) (*operations.C1APIPolicyV1PoliciesListResponse, error)

List List policies.

func (*Policies) Update 

func (s *Policies) Update(ctx context.Context, request operations.C1APIPolicyV1PoliciesUpdateRequest) (*operations.C1APIPolicyV1PoliciesUpdateResponse, error)

Update Update a policy by providing a policy object and an update mask.

type PolicySearch 

type PolicySearch struct {
	// contains filtered or unexported fields
}

func (*PolicySearch) Search 

func (s *PolicySearch) Search(ctx context.Context, request *shared.SearchPoliciesRequest) (*operations.C1APIPolicyV1PolicySearchSearchResponse, error)

Search Search policies based on filters specified in the request body.

type PolicyValidate 

type PolicyValidate struct {
	// contains filtered or unexported fields
}

func (*PolicyValidate) ValidateCEL 

func (s *PolicyValidate) ValidateCEL(ctx context.Context, request *shared.ValidatePolicyCELRequest) (*operations.C1APIPolicyV1PolicyValidateValidateCELResponse, error)

ValidateCEL - Validate Cel Validate policies

type RequestCatalogManagement 

type RequestCatalogManagement struct {
	// contains filtered or unexported fields
}

func (*RequestCatalogManagement) AddAccessEntitlements 

func (s *RequestCatalogManagement) AddAccessEntitlements(ctx context.Context, request operations.C1APIRequestcatalogV1RequestCatalogManagementServiceAddAccessEntitlementsRequest) (*operations.C1APIRequestcatalogV1RequestCatalogManagementServiceAddAccessEntitlementsResponse, error)

AddAccessEntitlements - Add Access Entitlements Add visibility bindings (access entitlements) to a catalog.

func (*RequestCatalogManagement) AddAppEntitlements 

func (s *RequestCatalogManagement) AddAppEntitlements(ctx context.Context, request operations.C1APIRequestcatalogV1RequestCatalogManagementServiceAddAppEntitlementsRequest) (*operations.C1APIRequestcatalogV1RequestCatalogManagementServiceAddAppEntitlementsResponse, error)

AddAppEntitlements - Add App Entitlements Add requestable entitlements to a catalog.

func (*RequestCatalogManagement) Create 

func (s *RequestCatalogManagement) Create(ctx context.Context, request *shared.RequestCatalogManagementServiceCreateRequest) (*operations.C1APIRequestcatalogV1RequestCatalogManagementServiceCreateResponse, error)

Create Creates a new request catalog.

func (*RequestCatalogManagement) Delete 

func (s *RequestCatalogManagement) Delete(ctx context.Context, request operations.C1APIRequestcatalogV1RequestCatalogManagementServiceDeleteRequest) (*operations.C1APIRequestcatalogV1RequestCatalogManagementServiceDeleteResponse, error)

Delete Delete a catalog.

func (*RequestCatalogManagement) Get 

func (s *RequestCatalogManagement) Get(ctx context.Context, request operations.C1APIRequestcatalogV1RequestCatalogManagementServiceGetRequest) (*operations.C1APIRequestcatalogV1RequestCatalogManagementServiceGetResponse, error)

Get Get a catalog.

func (*RequestCatalogManagement) List 

func (s *RequestCatalogManagement) List(ctx context.Context) (*operations.C1APIRequestcatalogV1RequestCatalogManagementServiceListResponse, error)

List Get a list of request catalogs.

func (*RequestCatalogManagement) ListEntitlementsForAccess 

func (s *RequestCatalogManagement) ListEntitlementsForAccess(ctx context.Context, request operations.C1APIRequestcatalogV1RequestCatalogManagementServiceListEntitlementsForAccessRequest) (*operations.C1APIRequestcatalogV1RequestCatalogManagementServiceListEntitlementsForAccessResponse, error)

ListEntitlementsForAccess - List Entitlements For Access List visibility bindings (access entitlements) for a catalog.

func (*RequestCatalogManagement) ListEntitlementsPerCatalog 

func (s *RequestCatalogManagement) ListEntitlementsPerCatalog(ctx context.Context, request operations.C1APIRequestcatalogV1RequestCatalogManagementServiceListEntitlementsPerCatalogRequest) (*operations.C1APIRequestcatalogV1RequestCatalogManagementServiceListEntitlementsPerCatalogResponse, error)

ListEntitlementsPerCatalog - List Entitlements Per Catalog List entitlements in a catalog that are requestable.

func (*RequestCatalogManagement) RemoveAccessEntitlements 

func (s *RequestCatalogManagement) RemoveAccessEntitlements(ctx context.Context, request operations.C1APIRequestcatalogV1RequestCatalogManagementServiceRemoveAccessEntitlementsRequest) (*operations.C1APIRequestcatalogV1RequestCatalogManagementServiceRemoveAccessEntitlementsResponse, error)

RemoveAccessEntitlements - Remove Access Entitlements Remove visibility bindings (access entitlements) to a catalog.

func (*RequestCatalogManagement) RemoveAppEntitlements 

func (s *RequestCatalogManagement) RemoveAppEntitlements(ctx context.Context, request operations.C1APIRequestcatalogV1RequestCatalogManagementServiceRemoveAppEntitlementsRequest) (*operations.C1APIRequestcatalogV1RequestCatalogManagementServiceRemoveAppEntitlementsResponse, error)

RemoveAppEntitlements - Remove App Entitlements Remove requestable entitlements from a catalog.

func (*RequestCatalogManagement) Update 

func (s *RequestCatalogManagement) Update(ctx context.Context, request operations.C1APIRequestcatalogV1RequestCatalogManagementServiceUpdateRequest) (*operations.C1APIRequestcatalogV1RequestCatalogManagementServiceUpdateResponse, error)

Update Update a catalog.

type RequestCatalogSearch 

type RequestCatalogSearch struct {
	// contains filtered or unexported fields
}

func (*RequestCatalogSearch) SearchEntitlements 

func (s *RequestCatalogSearch) SearchEntitlements(ctx context.Context, request *shared.RequestCatalogSearchServiceSearchEntitlementsRequest) (*operations.C1APIRequestcatalogV1RequestCatalogSearchServiceSearchEntitlementsResponse, error)

SearchEntitlements - Search Entitlements Search request catalogs based on filters specified in the request body.

type Roles 

type Roles struct {
	// contains filtered or unexported fields
}

func (*Roles) Get 

func (s *Roles) Get(ctx context.Context, request operations.C1APIIamV1RolesGetRequest) (*operations.C1APIIamV1RolesGetResponse, error)

Get Get a role by id.

func (*Roles) List 

func (s *Roles) List(ctx context.Context, request operations.C1APIIamV1RolesListRequest) (*operations.C1APIIamV1RolesListResponse, error)

List List all roles for the current user.

func (*Roles) Update 

func (s *Roles) Update(ctx context.Context, request operations.C1APIIamV1RolesUpdateRequest) (*operations.C1APIIamV1RolesUpdateResponse, error)

Update Update a role by passing a Role object.

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 WithRetryConfig 

func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption

func WithSecurity 

func WithSecurity(security shared.Security) SDKOption

func WithSecuritySource 

func WithSecuritySource(security func(context.Context) (shared.Security, error)) SDKOption

WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication

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 WithTenant 

func WithTenant(input string) (SDKOption, error)

func WithTenantDomain 

func WithTenantDomain(tenantDomain string) SDKOption

WithTenantDomain allows setting the tenantDomain variable for url substitution

type Task 

type Task struct {
	// contains filtered or unexported fields
}

func (*Task) CreateGrantTask 

func (s *Task) CreateGrantTask(ctx context.Context, request *shared.TaskServiceCreateGrantRequest) (*operations.C1APITaskV1TaskServiceCreateGrantTaskResponse, error)

CreateGrantTask - Create Grant Task Create a grant task

func (*Task) CreateRevokeTask 

func (s *Task) CreateRevokeTask(ctx context.Context, request *shared.TaskServiceCreateRevokeRequest) (*operations.C1APITaskV1TaskServiceCreateRevokeTaskResponse, error)

CreateRevokeTask - Create Revoke Task Create a revoke task

func (*Task) Get 

func (s *Task) Get(ctx context.Context, request operations.C1APITaskV1TaskServiceGetRequest) (*operations.C1APITaskV1TaskServiceGetResponse, error)

Get Get a task by ID

type TaskActions 

type TaskActions struct {
	// contains filtered or unexported fields
}

func (*TaskActions) Approve 

func (s *TaskActions) Approve(ctx context.Context, request operations.C1APITaskV1TaskActionsServiceApproveRequest) (*operations.C1APITaskV1TaskActionsServiceApproveResponse, error)

Approve Invokes the c1.api.task.v1.TaskActionsService.Approve method.

func (*TaskActions) Comment 

func (s *TaskActions) Comment(ctx context.Context, request operations.C1APITaskV1TaskActionsServiceCommentRequest) (*operations.C1APITaskV1TaskActionsServiceCommentResponse, error)

Comment Invokes the c1.api.task.v1.TaskActionsService.Comment method.

func (*TaskActions) Deny 

func (s *TaskActions) Deny(ctx context.Context, request operations.C1APITaskV1TaskActionsServiceDenyRequest) (*operations.C1APITaskV1TaskActionsServiceDenyResponse, error)

Deny Invokes the c1.api.task.v1.TaskActionsService.Deny method.

func (*TaskActions) EscalateToEmergencyAccess 

func (s *TaskActions) EscalateToEmergencyAccess(ctx context.Context, request operations.C1APITaskV1TaskActionsServiceEscalateToEmergencyAccessRequest) (*operations.C1APITaskV1TaskActionsServiceEscalateToEmergencyAccessResponse, error)

EscalateToEmergencyAccess - Escalate To Emergency Access Invokes the c1.api.task.v1.TaskActionsService.EscalateToEmergencyAccess method.

func (*TaskActions) Restart 

func (s *TaskActions) Restart(ctx context.Context, request operations.C1APITaskV1TaskActionsServiceRestartRequest) (*operations.C1APITaskV1TaskActionsServiceRestartResponse, error)

Restart Invokes the c1.api.task.v1.TaskActionsService.Restart method.

type TaskSearch 

type TaskSearch struct {
	// contains filtered or unexported fields
}

func (*TaskSearch) Search 

func (s *TaskSearch) Search(ctx context.Context, request *shared.TaskSearchRequest) (*operations.C1APITaskV1TaskSearchServiceSearchResponse, error)

Search Search tasks based on filters specified in the request body.

type User 

type User struct {
	// contains filtered or unexported fields
}

func (*User) Get 

func (s *User) Get(ctx context.Context, request operations.C1APIUserV1UserServiceGetRequest) (*operations.C1APIUserV1UserServiceGetResponse, error)

Get Get a user by ID.

func (*User) List 

func (s *User) List(ctx context.Context, request operations.C1APIUserV1UserServiceListRequest) (*operations.C1APIUserV1UserServiceListResponse, error)

List List users.

type UserSearch 

type UserSearch struct {
	// contains filtered or unexported fields
}

func (*UserSearch) Search 

func (s *UserSearch) Search(ctx context.Context, request *shared.SearchUsersRequest) (*operations.C1APIUserV1UserSearchSearchResponse, error)

Search Search users based on filters specified in the request body.

Source Files

View all Source files

Directories

Path Synopsis
pkg
models/operations
models/sdkerrors
models/shared
types
utils

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.