Go API client for api

Go to Settings > API to get started. Once you generate an API token, use bearer token authentication to make requests.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

API version: 2.4.0
Package version: 1.0.0
Generator version: 7.6.0
Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import api "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value api.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), api.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value api.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), api.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using api.ContextOperationServerIndices and api.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), api.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), api.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://.

Class	Method	HTTP request	Description
AccessRequestAPI	AccessRequestsAccessRequestIdGet	Get /access_requests/{accessRequestId}	Get access request
AccessRequestAPI	AccessRequestsAccessRequestIdPatch	Patch /access_requests/{accessRequestId}	Approve or deny an access request
AccessRequestAPI	AccessRequestsGet	Get /access_requests	Get organization access requests
AppThemesAPI	AppThemesIdDelete	Delete /app_themes/{id}	Delete app theme
AppThemesAPI	AppThemesIdGet	Get /app_themes/{id}	Get app theme
AppThemesAPI	AppThemesPost	Post /app_themes	Create app theme
AppThemesAPI	AppThemesPut	Put /app_themes	Update app theme
AppsAPI	AppsAppIdDelete	Delete /apps/{appId}	Delete app
AppsAPI	AppsAppIdGet	Get /apps/{appId}	Get app
AppsAPI	AppsGet	Get /apps	List apps
ConfigurationVariablesAPI	ConfigurationVariablesGet	Get /configuration_variables	List configuration variables and their values
ConfigurationVariablesAPI	ConfigurationVariablesIdDelete	Delete /configuration_variables/{id}	Delete configuration variable
ConfigurationVariablesAPI	ConfigurationVariablesIdGet	Get /configuration_variables/{id}	Retreive a single configuration variable and its values
ConfigurationVariablesAPI	ConfigurationVariablesIdPut	Put /configuration_variables/{id}	Update a configuration variable
ConfigurationVariablesAPI	ConfigurationVariablesPost	Post /configuration_variables	Create a configuration variable
CustomComponentLibraryAPI	CustomComponentLibrariesGet	Get /custom_component_libraries	Get a list of all custom component libraries
CustomComponentLibraryAPI	CustomComponentLibrariesLibraryIdGet	Get /custom_component_libraries/{libraryId}	Get a single custom component libraries
CustomComponentLibraryAPI	CustomComponentLibrariesLibraryIdRevisionsGet	Get /custom_component_libraries/{libraryId}/revisions	Gets a list of all the revisions of a custom component library
CustomComponentLibraryAPI	CustomComponentLibrariesLibraryIdRevisionsPost	Post /custom_component_libraries/{libraryId}/revisions	Create a new custom component library revision
CustomComponentLibraryAPI	CustomComponentLibrariesLibraryIdRevisionsRevisionIdFilesGet	Get /custom_component_libraries/{libraryId}/revisions/{revisionId}/files	Gets all files associated with a custom component library revision.
CustomComponentLibraryAPI	CustomComponentLibrariesPost	Post /custom_component_libraries	Create a new custom component library
EnvironmentAPI	EnvironmentsEnvironmentIdGet	Get /environments/{environmentId}	Get an environment by id
EnvironmentAPI	EnvironmentsGet	Get /environments	Get organization environments
FoldersAPI	FoldersFolderIdDelete	Delete /folders/{folderId}	Delete folder
FoldersAPI	FoldersFolderIdGet	Get /folders/{folderId}	Get a folder
FoldersAPI	FoldersFolderIdPatch	Patch /folders/{folderId}	Update folder
FoldersAPI	FoldersGet	Get /folders	List folders
FoldersAPI	FoldersPost	Post /folders	Create folder
GroupsAPI	GroupsGet	Get /groups	List groups
GroupsAPI	GroupsGroupIdDelete	Delete /groups/{groupId}	Delete group
GroupsAPI	GroupsGroupIdGet	Get /groups/{groupId}	Get group
GroupsAPI	GroupsGroupIdMembersPost	Post /groups/{groupId}/members	Add users to group
GroupsAPI	GroupsGroupIdMembersUserSidDelete	Delete /groups/{groupId}/members/{userSid}	Remove user from group
GroupsAPI	GroupsGroupIdPatch	Patch /groups/{groupId}	Update group
GroupsAPI	GroupsGroupIdPut	Put /groups/{groupId}	Update group
GroupsAPI	GroupsGroupIdUserInvitesPost	Post /groups/{groupId}/user_invites	Add user invites to group
GroupsAPI	GroupsGroupIdUserInvitesUserInviteIdDelete	Delete /groups/{groupId}/user_invites/{userInviteId}	Remove user invite from group
GroupsAPI	GroupsPost	Post /groups	Create group
ObservabilityAPI	ObservabilityConfigConfigIdDelete	Delete /observability/config/{configId}	Delete an observability provider configuration
ObservabilityAPI	ObservabilityConfigConfigIdPut	Put /observability/config/{configId}	Update an observability provider configuration
ObservabilityAPI	ObservabilityConfigGet	Get /observability/config	Get observability provider configurations
ObservabilityAPI	ObservabilityConfigPost	Post /observability/config	Create a new observability provider configuration
ObservabilityAPI	ObservabilityProviderProviderTestPost	Post /observability/provider/{provider}/test	Send a test error event to the observability provider
PermissionsAPI	PermissionsGrantPost	Post /permissions/grant	Grant permissions
PermissionsAPI	PermissionsListObjectsPost	Post /permissions/listObjects	List objects a group can access
PermissionsAPI	PermissionsRevokePost	Post /permissions/revoke	Revoke permissions
ResourceConfigurationsAPI	ResourceConfigurationsConfigurationIdDelete	Delete /resource_configurations/{configurationId}	Delete resource configuration
ResourceConfigurationsAPI	ResourceConfigurationsConfigurationIdGet	Get /resource_configurations/{configurationId}	Get resource configuration by id
ResourceConfigurationsAPI	ResourceConfigurationsGet	Get /resource_configurations	Get resource configurations
ResourcesAPI	ResourcesGet	Get /resources	Get resources
ResourcesAPI	ResourcesPost	Post /resources	Create a resource
ResourcesAPI	ResourcesResourceIdDelete	Delete /resources/{resourceId}	Delete resource
ResourcesAPI	ResourcesResourceIdGet	Get /resources/{resourceId}	Get resource by id
SSOAPI	SsoConfigDelete	Delete /sso/config	Remove SSO configuration
SSOAPI	SsoConfigGet	Get /sso/config	Get SSO configuration
SSOAPI	SsoConfigPost	Post /sso/config	Set SSO configuration
SourceControlAPI	SourceControlConfigDelete	Delete /source_control/config	Delete source control provider configuration
SourceControlAPI	SourceControlConfigGet	Get /source_control/config	Get source control configuration
SourceControlAPI	SourceControlConfigPost	Post /source_control/config	Create source control configuration
SourceControlAPI	SourceControlConfigPut	Put /source_control/config	Set source control configuration
SourceControlAPI	SourceControlDeployPost	Post /source_control/deploy	Trigger deployment of latest changes
SourceControlAPI	SourceControlDeploymentIdGet	Get /source_control/deployment/{id}	Get deployment by id
SourceControlAPI	SourceControlSettingsGet	Get /source_control/settings	Get source control settings
SourceControlAPI	SourceControlSettingsPut	Put /source_control/settings	Set source control settings
SourceControlAPI	SourceControlTestConnectionGet	Get /source_control/test_connection	Tests source control connection
SourceControlAPI	SourceControlTestDeployPost	Post /source_control/test_deploy	Test source control changes
SpacesAPI	SpacesCopyElementsPost	Post /spaces/copyElements	Copies apps, queries, resources, and workflows from one space to another
SpacesAPI	SpacesGet	Get /spaces	List spaces
SpacesAPI	SpacesPost	Post /spaces	Create a space
SpacesAPI	SpacesSpaceIdDelete	Delete /spaces/{spaceId}	Delete a space
SpacesAPI	SpacesSpaceIdGet	Get /spaces/{spaceId}	Get space
SpacesAPI	SpacesSpaceIdPut	Put /spaces/{spaceId}	Update space
UsageAPI	UsageAppDetailsGet	Get /usage/app_details	The app details for the selected app and organizations
UsageAPI	UsageAppSummaryGet	Get /usage/app_summary	The app summaries for the selected organizations
UsageAPI	UsageGet	Get /usage	The usage summary for the selected organizations
UsageAPI	UsageOrganizationsGet	Get /usage/organizations	List organizations
UsageAPI	UsageUserDetailsGet	Get /usage/user_details	The user details for the selected user and organizations
UsageAPI	UsageUserSummaryGet	Get /usage/user_summary	The summaries of user usage for the selected organizations
UserAttributesAPI	UserAttributesGet	Get /user_attributes	Get organization user attributes.
UserInviteAPI	UserInvitesGet	Get /user_invites	Get organization user invites
UserInviteAPI	UserInvitesPost	Post /user_invites	Create a new user invite
UserInviteAPI	UserInvitesUserInviteIdDelete	Delete /user_invites/{userInviteId}	Delete user invite
UserInviteAPI	UserInvitesUserInviteIdGet	Get /user_invites/{userInviteId}	Get user invite
UserInviteAPI	UserInvitesUserInviteIdUserAttributesAttributeNameDelete	Delete /user_invites/{userInviteId}/user_attributes/{attributeName}	Delete a user attribute on a user invite
UserInviteAPI	UserInvitesUserInviteIdUserAttributesPost	Post /user_invites/{userInviteId}/user_attributes	Add or update user attributes on a user invite
UsersAPI	UsersGet	Get /users	List users
UsersAPI	UsersPost	Post /users	Create user
UsersAPI	UsersUserIdDelete	Delete /users/{userId}	Delete a user
UsersAPI	UsersUserIdGet	Get /users/{userId}	Get user
UsersAPI	UsersUserIdPatch	Patch /users/{userId}	Update a user
UsersAPI	UsersUserIdUserAttributesAttributeNameDelete	Delete /users/{userId}/user_attributes/{attributeName}	Delete a user attribute.
UsersAPI	UsersUserIdUserAttributesPost	Post /users/{userId}/user_attributes	Add or update a user attribute

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), api.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime

# README