Documentation
¶
Index ¶
- func BuildApiUrl(rawWorkspace string) (string, error)
- func CredentialsSet(credentials ClientCredentials) bool
- func ParseModUri(uri string) (org, mod string)
- type ActivateGrantResponse
- type ActiveGrant
- type ApiResponse
- type Client
- func (client *Client) AssignResourceResults(responseData interface{}, properties map[string]string) (*Resource, error)
- func (client *Client) BuildPropertiesFromUpdateSchema(resourceId string, properties []interface{}) ([]interface{}, error)
- func (client *Client) CreateFolder(input map[string]interface{}) (*Folder, error)
- func (client *Client) CreateGoogleDirectory(input map[string]interface{}) (*TurbotResourceMetadata, error)
- func (client *Client) CreateGrant(input map[string]interface{}) (*TurbotGrantMetadata, error)
- func (client *Client) CreateGrantActivation(input map[string]interface{}) (*TurbotActiveGrantMetadata, error)
- func (client *Client) CreateGroupProfile(input map[string]interface{}) (*GroupProfile, error)
- func (client *Client) CreateLdapDirectory(input map[string]interface{}) (*LdapDirectory, error)
- func (client *Client) CreateLocalDirectory(input map[string]interface{}) (*LocalDirectory, error)
- func (client *Client) CreateLocalDirectoryUser(input map[string]interface{}) (*LocalDirectoryUser, error)
- func (client *Client) CreatePolicySetting(input map[string]interface{}) (*PolicySetting, error)
- func (client *Client) CreateProfile(input map[string]interface{}) (*Profile, error)
- func (client *Client) CreateResource(input map[string]interface{}) (*TurbotResourceMetadata, error)
- func (client *Client) CreateSamlDirectory(input map[string]interface{}) (*SamlDirectory, error)
- func (client *Client) CreateSmartFolder(input map[string]interface{}) (*SmartFolder, error)
- func (client *Client) CreateSmartFolderAttachment(input map[string]interface{}) (*TurbotResourceMetadata, error)
- func (client *Client) CreateTurbotDirectory(input map[string]interface{}) (*TurbotDirectory, error)
- func (client *Client) DeleteGrant(id string) error
- func (client *Client) DeleteGrantActivation(id string) error
- func (client *Client) DeleteGroupProfile(aka string) error
- func (client *Client) DeleteLdapDirectory(aka string) error
- func (client *Client) DeletePolicySetting(id string) error
- func (client *Client) DeleteResource(aka string) error
- func (client *Client) DeleteSmartFolderAttachment(input map[string]interface{}) error
- func (client *Client) DoRequest(query string, vars map[string]interface{}, responseData interface{}) error
- func (client *Client) FindPolicySetting(policyTypeUri, resourceAka string) (PolicySetting, error)
- func (client *Client) GetModVersions(org, mod string) ([]ModRegistryVersion, error)
- func (client *Client) GetResourceAkas(resourceAka string) ([]string, error)
- func (client *Client) GetTurbotWorkspaceVersion() (*semver.Version, error)
- func (client *Client) GrantActivationExists(id string) (bool, error)
- func (client *Client) GrantExists(id string) (bool, error)
- func (client *Client) InstallMod(input map[string]interface{}) (*InstallModData, error)
- func (client *Client) ReadControl(args string) (*Control, error)
- func (client *Client) ReadFolder(id string) (*Folder, error)
- func (client *Client) ReadFullResource(resourceAka string) (*Resource, error)
- func (client *Client) ReadGoogleDirectory(id string) (*GoogleDirectory, error)
- func (client *Client) ReadGrant(id string) (*Grant, error)
- func (client *Client) ReadGrantActivation(id string) (*ActiveGrant, error)
- func (client *Client) ReadGroupProfile(id string) (*GroupProfile, error)
- func (client *Client) ReadLdapDirectory(id string) (*LdapDirectory, error)
- func (client *Client) ReadLocalDirectory(id string) (*LocalDirectory, error)
- func (client *Client) ReadLocalDirectoryUser(id string) (*LocalDirectoryUser, error)
- func (client *Client) ReadMod(id string) (*Mod, error)
- func (client *Client) ReadPolicySetting(id string) (*PolicySetting, error)
- func (client *Client) ReadPolicyValue(policyTypeUri, resourceAka string) (*PolicyValue, error)
- func (client *Client) ReadProfile(id string) (*Profile, error)
- func (client *Client) ReadResource(resourceAka string, properties map[string]string) (*Resource, error)
- func (client *Client) ReadResourceList(filter string, properties map[string]string) ([]Resource, error)
- func (client *Client) ReadSamlDirectory(id string) (*SamlDirectory, error)
- func (client *Client) ReadSerializableResource(resourceAka string) (*SerializableResource, error)
- func (client *Client) ReadSmartFolder(id string) (*SmartFolder, error)
- func (client *Client) ReadTurbotDirectory(id string) (*TurbotDirectory, error)
- func (client *Client) ResourceExists(id string) (bool, error)
- func (client *Client) UninstallMod(modId string) error
- func (client *Client) UpdateFolder(input map[string]interface{}) (*Folder, error)
- func (client *Client) UpdateGoogleDirectory(input map[string]interface{}) (*TurbotResourceMetadata, error)
- func (client *Client) UpdateGroupProfile(input map[string]interface{}) (*GroupProfile, error)
- func (client *Client) UpdateLdapDirectory(input map[string]interface{}) (*LdapDirectory, error)
- func (client *Client) UpdateLocalDirectory(input map[string]interface{}) (*LocalDirectory, error)
- func (client *Client) UpdateLocalDirectoryUserResource(input map[string]interface{}) (*LocalDirectoryUser, error)
- func (client *Client) UpdatePolicySetting(input map[string]interface{}) (*PolicySetting, error)
- func (client *Client) UpdateProfile(input map[string]interface{}) (*Profile, error)
- func (client *Client) UpdateResource(input map[string]interface{}) (*TurbotResourceMetadata, error)
- func (client *Client) UpdateSamlDirectory(input map[string]interface{}) (*SamlDirectory, error)
- func (client *Client) UpdateSmartFolder(input map[string]interface{}) (*SmartFolder, error)
- func (client *Client) UpdateTurbotDirectory(input map[string]interface{}) (*TurbotDirectory, error)
- func (client *Client) Validate() error
- type ClientConfig
- type ClientCredentials
- type Control
- type CreateGrantResponse
- type CreateResourceResponse
- type CreateSmartFolderAttachResponse
- type Error
- type FindPolicySettingResponse
- type Folder
- type FolderResponse
- type GoogleDirectory
- type Grant
- type GroupProfile
- type GroupProfileResponse
- type InstallModData
- type InstallModResponse
- type LdapDirectory
- type LdapDirectoryResponse
- type LocalDirectory
- type LocalDirectoryResponse
- type LocalDirectoryUser
- type LocalDirectoryUserResponse
- type Mod
- type ModRegistryVersion
- type ModVersionResponse
- type PolicySetting
- type PolicySettingResponse
- type PolicyValue
- type PolicyValueResponse
- type Profile
- type ProfileResponse
- type ReadActiveGrantResponse
- type ReadControlResponse
- type ReadGoogleDirectoryResponse
- type ReadGrantResponse
- type ReadModResponse
- type ReadResourceListResponse
- type ReadResourceResponse
- type ReadSerializableResourceResponse
- type Resource
- type ResourceResponse
- type ResourceSchema
- type SamlDirectory
- type SamlDirectoryResponse
- type SerializableResource
- type SmartFolder
- type SmartFolderAttachment
- type SmartFolderResponse
- type TurbotActiveGrantMetadata
- type TurbotDirectory
- type TurbotDirectoryResponse
- type TurbotGrantMetadata
- type TurbotPolicyMetadata
- type TurbotResourceMetadata
- type UninstallModResponse
- type UpdateResourceResponse
- type ValidationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BuildApiUrl ¶
convert workspace into a fully formed api url
func CredentialsSet ¶
func CredentialsSet(credentials ClientCredentials) bool
func ParseModUri ¶
Types ¶
type ActivateGrantResponse ¶
type ActivateGrantResponse struct {
GrantActivate struct {
Turbot TurbotActiveGrantMetadata
}
}
Active Grant
type ActiveGrant ¶
type ActiveGrant struct {
Turbot TurbotActiveGrantMetadata
}
type ApiResponse ¶
type ApiResponse struct {
Errors []Error
}
ApiResponse used to unmarshall API error responses
type Client ¶
Turbot API Client
func CreateClient ¶
func CreateClient(config ClientConfig, opts ...graphql.ClientOption) (*Client, error)
func (*Client) AssignResourceResults ¶
func (client *Client) AssignResourceResults(responseData interface{}, properties map[string]string) (*Resource, error)
assign the ReadResource results into a Resource object, based on the 'properties' map
func (*Client) BuildPropertiesFromUpdateSchema ¶
func (*Client) CreateFolder ¶
func (*Client) CreateGoogleDirectory ¶
func (client *Client) CreateGoogleDirectory(input map[string]interface{}) (*TurbotResourceMetadata, error)
func (*Client) CreateGrant ¶
func (client *Client) CreateGrant(input map[string]interface{}) (*TurbotGrantMetadata, error)
func (*Client) CreateGrantActivation ¶
func (client *Client) CreateGrantActivation(input map[string]interface{}) (*TurbotActiveGrantMetadata, error)
func (*Client) CreateGroupProfile ¶
func (client *Client) CreateGroupProfile(input map[string]interface{}) (*GroupProfile, error)
func (*Client) CreateLdapDirectory ¶
func (client *Client) CreateLdapDirectory(input map[string]interface{}) (*LdapDirectory, error)
func (*Client) CreateLocalDirectory ¶
func (client *Client) CreateLocalDirectory(input map[string]interface{}) (*LocalDirectory, error)
func (*Client) CreateLocalDirectoryUser ¶
func (client *Client) CreateLocalDirectoryUser(input map[string]interface{}) (*LocalDirectoryUser, error)
func (*Client) CreatePolicySetting ¶
func (client *Client) CreatePolicySetting(input map[string]interface{}) (*PolicySetting, error)
func (*Client) CreateProfile ¶
func (*Client) CreateResource ¶
func (client *Client) CreateResource(input map[string]interface{}) (*TurbotResourceMetadata, error)
func (*Client) CreateSamlDirectory ¶
func (client *Client) CreateSamlDirectory(input map[string]interface{}) (*SamlDirectory, error)
func (*Client) CreateSmartFolder ¶
func (client *Client) CreateSmartFolder(input map[string]interface{}) (*SmartFolder, error)
func (*Client) CreateSmartFolderAttachment ¶
func (client *Client) CreateSmartFolderAttachment(input map[string]interface{}) (*TurbotResourceMetadata, error)
func (*Client) CreateTurbotDirectory ¶
func (client *Client) CreateTurbotDirectory(input map[string]interface{}) (*TurbotDirectory, error)
func (*Client) DeleteGrant ¶
func (*Client) DeleteGrantActivation ¶
func (*Client) DeleteGroupProfile ¶
func (*Client) DeleteLdapDirectory ¶
func (*Client) DeletePolicySetting ¶
func (*Client) DeleteResource ¶
func (*Client) DeleteSmartFolderAttachment ¶
func (*Client) DoRequest ¶
func (client *Client) DoRequest(query string, vars map[string]interface{}, responseData interface{}) error
execute graphql request
func (*Client) FindPolicySetting ¶
func (client *Client) FindPolicySetting(policyTypeUri, resourceAka string) (PolicySetting, error)
func (*Client) GetModVersions ¶
func (client *Client) GetModVersions(org, mod string) ([]ModRegistryVersion, error)
func (*Client) GetResourceAkas ¶
func (*Client) GetTurbotWorkspaceVersion ¶
get turbot workspace version
func (*Client) GrantActivationExists ¶
func (*Client) InstallMod ¶
func (client *Client) InstallMod(input map[string]interface{}) (*InstallModData, error)
func (*Client) ReadFullResource ¶
func (*Client) ReadGoogleDirectory ¶
func (client *Client) ReadGoogleDirectory(id string) (*GoogleDirectory, error)
func (*Client) ReadGrantActivation ¶
func (client *Client) ReadGrantActivation(id string) (*ActiveGrant, error)
func (*Client) ReadGroupProfile ¶
func (client *Client) ReadGroupProfile(id string) (*GroupProfile, error)
func (*Client) ReadLdapDirectory ¶
func (client *Client) ReadLdapDirectory(id string) (*LdapDirectory, error)
func (*Client) ReadLocalDirectory ¶
func (client *Client) ReadLocalDirectory(id string) (*LocalDirectory, error)
func (*Client) ReadLocalDirectoryUser ¶
func (client *Client) ReadLocalDirectoryUser(id string) (*LocalDirectoryUser, error)
func (*Client) ReadPolicySetting ¶
func (client *Client) ReadPolicySetting(id string) (*PolicySetting, error)
func (*Client) ReadPolicyValue ¶
func (client *Client) ReadPolicyValue(policyTypeUri, resourceAka string) (*PolicyValue, error)
func (*Client) ReadResource ¶
func (client *Client) ReadResource(resourceAka string, properties map[string]string) (*Resource, error)
properties is a map of terraform property name to turbot property path - it is used to add 'get' resolvers to the query
func (*Client) ReadResourceList ¶
func (*Client) ReadSamlDirectory ¶
func (client *Client) ReadSamlDirectory(id string) (*SamlDirectory, error)
func (*Client) ReadSerializableResource ¶
func (client *Client) ReadSerializableResource(resourceAka string) (*SerializableResource, error)
read a resource including all properties, then convert into a 'serializable' resource, consisting of simple types and string maps
func (*Client) ReadSmartFolder ¶
func (client *Client) ReadSmartFolder(id string) (*SmartFolder, error)
func (*Client) ReadTurbotDirectory ¶
func (client *Client) ReadTurbotDirectory(id string) (*TurbotDirectory, error)
func (*Client) UninstallMod ¶
func (*Client) UpdateFolder ¶
func (*Client) UpdateGoogleDirectory ¶
func (client *Client) UpdateGoogleDirectory(input map[string]interface{}) (*TurbotResourceMetadata, error)
func (*Client) UpdateGroupProfile ¶
func (client *Client) UpdateGroupProfile(input map[string]interface{}) (*GroupProfile, error)
func (*Client) UpdateLdapDirectory ¶
func (client *Client) UpdateLdapDirectory(input map[string]interface{}) (*LdapDirectory, error)
func (*Client) UpdateLocalDirectory ¶
func (client *Client) UpdateLocalDirectory(input map[string]interface{}) (*LocalDirectory, error)
func (*Client) UpdateLocalDirectoryUserResource ¶
func (client *Client) UpdateLocalDirectoryUserResource(input map[string]interface{}) (*LocalDirectoryUser, error)
func (*Client) UpdatePolicySetting ¶
func (client *Client) UpdatePolicySetting(input map[string]interface{}) (*PolicySetting, error)
func (*Client) UpdateProfile ¶
func (*Client) UpdateResource ¶
func (client *Client) UpdateResource(input map[string]interface{}) (*TurbotResourceMetadata, error)
func (*Client) UpdateSamlDirectory ¶
func (client *Client) UpdateSamlDirectory(input map[string]interface{}) (*SamlDirectory, error)
func (*Client) UpdateSmartFolder ¶
func (client *Client) UpdateSmartFolder(input map[string]interface{}) (*SmartFolder, error)
func (*Client) UpdateTurbotDirectory ¶
func (client *Client) UpdateTurbotDirectory(input map[string]interface{}) (*TurbotDirectory, error)
type ClientConfig ¶
type ClientConfig struct {
Credentials ClientCredentials
CredentialsPath string
Profile string
}
type ClientCredentials ¶
type ClientCredentials struct {
AccessKey string `yaml:"accessKey"`
SecretKey string `yaml:"secretKey"`
Workspace string
}
func GetCredentials ¶
func GetCredentials(config ClientConfig) (ClientCredentials, error)
type CreateGrantResponse ¶
type CreateGrantResponse struct {
Grants struct {
Turbot TurbotGrantMetadata
}
}
Grant
type CreateResourceResponse ¶
type CreateResourceResponse struct {
Resource struct {
Turbot TurbotResourceMetadata
}
}
Resource
type CreateSmartFolderAttachResponse ¶
type CreateSmartFolderAttachResponse struct {
SmartFolderAttach struct {
Turbot TurbotResourceMetadata
}
}
type FindPolicySettingResponse ¶
type FindPolicySettingResponse struct {
PolicySettings struct {
Items []PolicySetting
}
}
type Folder ¶
type Folder struct {
Turbot TurbotResourceMetadata
Title string
Description string
Parent string
}
type GoogleDirectory ¶
type Grant ¶
type Grant struct {
Turbot TurbotGrantMetadata
PermissionTypeId string
PermissionLevelId string
}
type GroupProfile ¶
type GroupProfile struct {
Turbot TurbotResourceMetadata
Directory string
Title string
Status string
GroupProfileId string
}
Group profile
type GroupProfileResponse ¶
type GroupProfileResponse struct {
Resource GroupProfile
}
type InstallModData ¶
type InstallModData struct {
Build string
Turbot TurbotResourceMetadata
}
type LdapDirectory ¶
type LdapDirectory struct {
Turbot TurbotResourceMetadata
Title string
Description string
DirectoryType string
ProfileIdTemplate string
GroupProfileIdTemplate string
Url string
Status string
DistinguishedName string
Base string
UserObjectFilter string
DisabledUserFilter string
UserMatchFilter string
UserSearchFilter string
UserSearchAttributes string
GroupObjectFilter string
GroupSearchFilter string
GroupSyncFilter string
UserCanonicalNameAttribute string
UserEmailAttribute string
UserDisplayNameAttribute string
UserGivenNameAttribute string
UserFamilyNameAttribute string
GroupCanonicalNameAttribute string
TlsEnabled bool
TlsServerCertificate string
GroupMemberOfAttribute string
GroupMembershipAttribute string
ConnectivityTestFilter string
DisabledGroupFilter string
}
Ldap directory
type LdapDirectoryResponse ¶
type LdapDirectoryResponse struct {
Resource LdapDirectory
}
type LocalDirectory ¶
type LocalDirectoryResponse ¶
type LocalDirectoryResponse struct {
Resource LocalDirectory
}
Local directory
type LocalDirectoryUser ¶
type LocalDirectoryUserResponse ¶
type LocalDirectoryUserResponse struct {
Resource LocalDirectoryUser
}
Local directory user
type ModRegistryVersion ¶
type ModVersionResponse ¶
type ModVersionResponse struct {
Versions struct {
Items []ModRegistryVersion
}
}
type PolicySetting ¶
type PolicySettingResponse ¶
type PolicySettingResponse struct {
PolicySetting PolicySetting
}
PolicySetting
type PolicyValue ¶
type PolicyValue struct {
Value interface{}
Precedence string
State string
Reason string
Details string
Setting PolicySetting
Turbot TurbotPolicyMetadata
}
type ReadActiveGrantResponse ¶
type ReadActiveGrantResponse struct {
ActiveGrant ActiveGrant
}
type ReadControlResponse ¶
type ReadControlResponse struct {
Control Control
}
type ReadGoogleDirectoryResponse ¶
type ReadGoogleDirectoryResponse struct {
Directory GoogleDirectory
}
Google directory
type ReadGrantResponse ¶
type ReadGrantResponse struct {
Grant Grant
}
type ReadModResponse ¶
type ReadModResponse struct {
Mod Mod
}
type ReadResourceListResponse ¶
type ReadResourceListResponse struct {
Resources struct {
Items []Resource
}
}
type ReadResourceResponse ¶
type ReadResourceResponse struct {
Resource interface{}
}
note: the Resource property is just an interface{} - this is mapped manually into a Resource object, rather than unmarshalled. This is to allow for dynamic data types, while always having the Turbot property
type Resource ¶
type Resource struct {
Turbot TurbotResourceMetadata
Data map[string]interface{}
Object map[string]interface{}
Metadata map[string]interface{}
Type struct {
Uri string
}
}
type ResourceResponse ¶
type ResourceResponse struct {
Resource Resource
}
type ResourceSchema ¶
type ResourceSchema struct {
Resource struct {
Turbot TurbotResourceMetadata
UpdateSchema interface{}
CreateSchema interface{}
Type struct {
Uri string
}
}
}
type SamlDirectory ¶
type SamlDirectory struct {
Turbot TurbotResourceMetadata
Title string
Description string
Parent string
Status string
DirectoryType string
ProfileIdTemplate string
EntryPoint string
Certificate string
Issuer string
GroupIdTemplate string
NameIdFormat string
SignRequests string
SignaturePrivateKey string
SignatureAlgorithm string
PoolId string
ProfileGroupsAttribute string
AllowGroupSyncing bool
AllowIdpInitiatedSso bool
GroupFilter string
}
type SamlDirectoryResponse ¶
type SamlDirectoryResponse struct {
Resource SamlDirectory
}
Saml directory
type SerializableResource ¶
type SmartFolder ¶
type SmartFolder struct {
Turbot TurbotResourceMetadata
Title string
Description string
Filters []string
Parent string
AttachedResources struct {
Items []struct {
Turbot TurbotResourceMetadata
}
}
}
type SmartFolderAttachment ¶
type SmartFolderAttachment struct {
Turbot TurbotResourceMetadata
Title string
Description string
Filters map[string]interface{}
Parent string
}
Smart folder attachment
type SmartFolderResponse ¶
type SmartFolderResponse struct {
SmartFolder SmartFolder
}
type TurbotDirectory ¶
type TurbotDirectory struct {
Turbot TurbotResourceMetadata
Title string
Description string
ProfileIdTemplate string
Status string
Server string
}
Turbot directory
type TurbotDirectoryResponse ¶
type TurbotDirectoryResponse struct {
Resource TurbotDirectory
}
type TurbotGrantMetadata ¶
type TurbotPolicyMetadata ¶
type TurbotResourceMetadata ¶
type TurbotResourceMetadata struct {
Id string
ParentId string
Akas []string
Custom map[string]interface{}
Metadata map[string]interface{}
Tags map[string]interface{}
Title string
VersionId string
ActorIdentityId string
ActorPersonaId string
ActorRoleId string
ResourceParentAka string
CreateTimestamp string
DeleteTimestamp string
UpdateTimestamp string
Path string
ResourceGroupIds []string
ResourceTypeId string
State string
Terraform map[string]interface{}
}
Metadata
type UninstallModResponse ¶
type UninstallModResponse struct {
UninstallMod struct {
Success bool
}
}
type UpdateResourceResponse ¶
type UpdateResourceResponse struct {
Resource struct {
Turbot TurbotResourceMetadata
}
}
type ValidationResponse ¶
type ValidationResponse struct {
Schema struct {
QueryType struct {
Name string
}
}
}
Validation response
Source Files
¶
- client.go
- clientConfig.go
- control.go
- folder.go
- google_directory.go
- grant.go
- grant_activation.go
- group_profile.go
- ldap_directory.go
- local_directory.go
- local_directory_user.go
- mod.go
- policy_setting.go
- policy_value.go
- profile.go
- queries.go
- resource.go
- saml_directory.go
- smart_folder.go
- smart_folder_attachment.go
- turbot_directory.go
- types.go