Go API client for opal

Your Home For Developer Resources.

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: 1.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.opal.dev/

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 opal "github.com/opalsecurity/opal-go"

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 sw.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), opal.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 sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to https://api.opal.dev/v1

Class	Method	HTTP request	Description
AppsApi	GetApp	Get /apps/{app_id}
AppsApi	GetApps	Get /apps
ConfigurationTemplatesApi	CreateConfigurationTemplate	Post /configuration-templates
ConfigurationTemplatesApi	GetConfigurationTemplates	Get /configuration-templates
ConfigurationTemplatesApi	UpdateConfigurationTemplate	Put /configuration-templates
EventsApi	Events	Get /events
GroupsApi	AddGroupResource	Post /groups/{group_id}/resources/{resource_id}
GroupsApi	AddGroupUser	Post /groups/{group_id}/users/{user_id}
GroupsApi	CreateGroup	Post /groups
GroupsApi	DeleteGroup	Delete /groups/{group_id}
GroupsApi	DeleteGroupUser	Delete /groups/{group_id}/users/{user_id}
GroupsApi	GetGroupMessageChannels	Get /groups/{group_id}/message-channels
GroupsApi	GetGroupOnCallSchedules	Get /groups/{group_id}/on-call-schedules
GroupsApi	GetGroupResources	Get /groups/{group_id}/resources
GroupsApi	GetGroupReviewerStages	Get /groups/{group_id}/reviewer-stages
GroupsApi	GetGroupReviewers	Get /groups/{group_id}/reviewers
GroupsApi	GetGroupTags	Get /groups/{group_id}/tags
GroupsApi	GetGroupUsers	Get /groups/{group_id}/users
GroupsApi	GetGroupVisibility	Get /groups/{group_id}/visibility
GroupsApi	GetGroups	Get /groups
GroupsApi	SetGroupMessageChannels	Put /groups/{group_id}/message-channels
GroupsApi	SetGroupOnCallSchedules	Put /groups/{group_id}/on-call-schedules
GroupsApi	SetGroupResources	Put /groups/{group_id}/resources
GroupsApi	SetGroupReviewerStages	Put /groups/{group_id}/reviewer-stages
GroupsApi	SetGroupReviewers	Put /groups/{group_id}/reviewers
GroupsApi	SetGroupVisibility	Put /groups/{group_id}/visibility
GroupsApi	UpdateGroups	Put /groups
MessageChannelsApi	CreateMessageChannel	Post /message-channels
MessageChannelsApi	GetMessageChannel	Get /message-channels/{message_channel_id}
MessageChannelsApi	GetMessageChannels	Get /message-channels
OnCallSchedulesApi	CreateOnCallSchedule	Post /on-call-schedules
OnCallSchedulesApi	GetOnCallSchedule	Get /on-call-schedules/{on_call_schedule_id}
OnCallSchedulesApi	GetOnCallSchedules	Get /on-call-schedules
OwnersApi	CreateOwner	Post /owners
OwnersApi	DeleteOwner	Delete /owners/{owner_id}
OwnersApi	GetOwner	Get /owners/{owner_id}
OwnersApi	GetOwnerFromName	Get /owners/name/{owner_name}
OwnersApi	GetOwnerUsers	Get /owners/{owner_id}/users
OwnersApi	GetOwners	Get /owners
OwnersApi	SetOwnerUsers	Put /owners/{owner_id}/users
OwnersApi	UpdateOwners	Put /owners
RequestsApi	GetRequests	Get /requests
ResourcesApi	AddResourceUser	Post /resources/{resource_id}/users/{user_id}
ResourcesApi	CreateResource	Post /resources
ResourcesApi	DeleteResource	Delete /resources/{resource_id}
ResourcesApi	DeleteResourceUser	Delete /resources/{resource_id}/users/{user_id}
ResourcesApi	GetResource	Get /resources/{resource_id}
ResourcesApi	GetResourceMessageChannels	Get /resources/{resource_id}/message-channels
ResourcesApi	GetResourceReviewerStages	Get /resources/{resource_id}/reviewer-stages
ResourcesApi	GetResourceReviewers	Get /resources/{resource_id}/reviewers
ResourcesApi	GetResourceTags	Get /resources/{resource_id}/tags
ResourcesApi	GetResourceUsers	Get /resources/{resource_id}/users
ResourcesApi	GetResourceVisibility	Get /resources/{resource_id}/visibility
ResourcesApi	GetResources	Get /resources
ResourcesApi	ResourceUserAccessStatusRetrieve	Get /resource-user-access-status/{resource_id}/{user_id}
ResourcesApi	SetResourceMessageChannels	Put /resources/{resource_id}/message-channels
ResourcesApi	SetResourceReviewerStages	Put /resources/{resource_id}/reviewer-stages
ResourcesApi	SetResourceReviewers	Put /resources/{resource_id}/reviewers
ResourcesApi	SetResourceVisibility	Put /resources/{resource_id}/visibility
ResourcesApi	UpdateResources	Put /resources
SessionsApi	Sessions	Get /sessions
TagsApi	AddGroupTag	Post /tags/{tag_id}/groups/{group_id}
TagsApi	AddResourceTag	Post /tags/{tag_id}/resources/{resource_id}
TagsApi	AddUserTag	Post /tags/{tag_id}/users/{user_id}
TagsApi	CreateTag	Post /tag
TagsApi	GetTag	Get /tag
TagsApi	GetTags	Get /tags
TagsApi	RemoveGroupTag	Delete /tags/{tag_id}/groups/{group_id}
TagsApi	RemoveResourceTag	Delete /tags/{tag_id}/resources/{resource_id}
TagsApi	RemoveUserTag	Delete /tags/{tag_id}/users/{user_id}
UarsApi	CreateUar	Post /uar
UarsApi	GetUARs	Get /uars
UarsApi	GetUar	Get /uar/{uar_id}
UsersApi	GetUserTags	Get /users/{user_id}/tags
UsersApi	GetUsers	Get /users
UsersApi	User	Get /user

Documentation For Models

• App
• AppTypeEnum
• AppsList
• AwsPermissionSetMetadata
• AwsPermissionSetMetadataAwsPermissionSet
• Condition
• ConfigurationTemplate
• CreateConfigurationTemplateInfo
• CreateGroupInfo
• CreateMessageChannelInfo
• CreateOnCallScheduleInfo
• CreateOwnerInfo
• CreateRequestConfigurationInfoList
• CreateResourceInfo
• CreateUARInfo
• EntityTypeEnum
• Event
• Group
• GroupAccessLevel
• GroupRemoteInfo
• GroupRemoteInfoActiveDirectoryGroup
• GroupRemoteInfoAzureAdMicrosoft365Group
• GroupRemoteInfoAzureAdSecurityGroup
• GroupRemoteInfoDuoGroup
• GroupRemoteInfoGithubTeam
• GroupRemoteInfoGitlabGroup
• GroupRemoteInfoGoogleGroup
• GroupRemoteInfoLdapGroup
• GroupRemoteInfoOktaGroup
• GroupResource
• GroupResourceList
• GroupTypeEnum
• GroupUser
• GroupUserList
• MessageChannel
• MessageChannelIDList
• MessageChannelList
• MessageChannelProviderEnum
• OnCallSchedule
• OnCallScheduleIDList
• OnCallScheduleList
• OnCallScheduleProviderEnum
• Owner
• PaginatedConfigurationTemplateList
• PaginatedEventList
• PaginatedGroupsList
• PaginatedOwnersList
• PaginatedResourcesList
• PaginatedTagsList
• PaginatedUARsList
• PaginatedUsersList
• Request
• RequestConfiguration
• RequestList
• RequestStatusEnum
• Resource
• ResourceAccessLevel
• ResourceAccessUser
• ResourceAccessUserList
• ResourceRemoteInfo
• ResourceRemoteInfoAwsAccount
• ResourceRemoteInfoAwsEc2Instance
• ResourceRemoteInfoAwsEksCluster
• ResourceRemoteInfoAwsIamRole
• ResourceRemoteInfoAwsPermissionSet
• ResourceRemoteInfoAwsRdsInstance
• ResourceRemoteInfoGcpBucket
• ResourceRemoteInfoGcpComputeInstance
• ResourceRemoteInfoGcpFolder
• ResourceRemoteInfoGcpGkeCluster
• ResourceRemoteInfoGcpProject
• ResourceRemoteInfoGcpSqlInstance
• ResourceRemoteInfoGithubRepo
• ResourceRemoteInfoGitlabProject
• ResourceRemoteInfoOktaApp
• ResourceRemoteInfoOktaCustomRole
• ResourceRemoteInfoOktaStandardRole
• ResourceRemoteInfoPagerdutyRole
• ResourceRemoteInfoSalesforcePermissionSet
• ResourceRemoteInfoSalesforceProfile
• ResourceRemoteInfoSalesforceRole
• ResourceRemoteInfoTeleportRole
• ResourceTypeEnum
• ResourceUser
• ResourceUserAccessStatus
• ResourceUserAccessStatusEnum
• ResourceWithAccessLevel
• ReviewerIDList
• ReviewerStage
• ReviewerStageList
• Session
• SessionsList
• SubEvent
• Tag
• TagFilter
• TagsList
• UAR
• UARReviewerAssignmentPolicyEnum
• UARScope
• UpdateConfigurationTemplateInfo
• UpdateGroupInfo
• UpdateGroupInfoList
• UpdateGroupResourcesInfo
• UpdateOwnerInfo
• UpdateOwnerInfoList
• UpdateResourceInfo
• UpdateResourceInfoList
• User
• UserIDList
• UserList
• VisibilityInfo
• VisibilityTypeEnum

Documentation For Authorization

BearerAuth

• Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), sw.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

Author

hello@opal.dev