Go API client for opal

The Opal API is a RESTful API that allows you to interact with the Opal Security platform programmatically.

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
• Generator version: 7.14.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 opal.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 opal.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 opal.ContextOperationServerIndices and opal.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
AccessRulesAPI	CreateAccessRule	Post /access-rules
AccessRulesAPI	GetAccessRule	Get /access-rules/{access_rule_id}
AccessRulesAPI	UpdateAccessRule	Put /access-rules/{access_rule_id}
AppsAPI	GetApp	Get /apps/{app_id}
AppsAPI	GetApps	Get /apps
AppsAPI	GetSyncErrors	Get /sync_errors
BundlesAPI	AddBundleGroup	Post /bundles/{bundle_id}/groups
BundlesAPI	AddBundleResource	Post /bundles/{bundle_id}/resources
BundlesAPI	CreateBundle	Post /bundles
BundlesAPI	DeleteBundle	Delete /bundles/{bundle_id}
BundlesAPI	GetBundle	Get /bundles/{bundle_id}	Get bundle by ID
BundlesAPI	GetBundleGroups	Get /bundles/{bundle_id}/groups
BundlesAPI	GetBundleResources	Get /bundles/{bundle_id}/resources
BundlesAPI	GetBundleVisibility	Get /bundles/{bundle_id}/visibility
BundlesAPI	GetBundles	Get /bundles	Get bundles
BundlesAPI	RemoveBundleGroup	Delete /bundles/{bundle_id}/groups/{group_id}
BundlesAPI	RemoveBundleResource	Delete /bundles/{bundle_id}/resources/{resource_id}
BundlesAPI	SetBundleVisibility	Put /bundles/{bundle_id}/visibility
BundlesAPI	UpdateBundle	Put /bundles/{bundle_id}
ConfigurationTemplatesAPI	CreateConfigurationTemplate	Post /configuration-templates
ConfigurationTemplatesAPI	DeleteConfigurationTemplate	Delete /configuration-templates/{configuration_template_id}
ConfigurationTemplatesAPI	GetConfigurationTemplates	Get /configuration-templates
ConfigurationTemplatesAPI	UpdateConfigurationTemplate	Put /configuration-templates
DelegationsAPI	CreateDelegation	Post /delegations
DelegationsAPI	DeleteDelegation	Delete /delegations/{delegation_id}
DelegationsAPI	GetDelegation	Get /delegations/{delegation_id}
DelegationsAPI	GetDelegations	Get /delegations
EventsAPI	Events	Get /events
GroupBindingsAPI	CreateGroupBinding	Post /group-bindings
GroupBindingsAPI	DeleteGroupBinding	Delete /group-bindings/{group_binding_id}
GroupBindingsAPI	GetGroupBinding	Get /group-bindings/{group_binding_id}	Get group binding by ID
GroupBindingsAPI	GetGroupBindings	Get /group-bindings	Get group bindings
GroupBindingsAPI	UpdateGroupBindings	Put /group-bindings
GroupsAPI	AddGroupContainingGroup	Post /groups/{group_id}/containing-groups
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	GetGroup	Get /groups/{group_id}	Get group by ID
GroupsAPI	GetGroupContainingGroup	Get /groups/{group_id}/containing-groups/{containing_group_id}	Get nested group by ID
GroupsAPI	GetGroupContainingGroups	Get /groups/{group_id}/containing-groups	Get nested groups
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	Get groups
GroupsAPI	GetUserGroups	Get /groups/users/{user_id}
GroupsAPI	RemoveGroupContainingGroup	Delete /groups/{group_id}/containing-groups/{containing_group_id}
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	UpdateGroupUser	Put /groups/{group_id}/users/{user_id}
GroupsAPI	UpdateGroups	Put /groups
IdpGroupMappingsAPI	CreateIdpGroupMapping	Post /idp-group-mappings/{app_resource_id}/groups/{group_id}
IdpGroupMappingsAPI	DeleteIdpGroupMappings	Delete /idp-group-mappings/{app_resource_id}/groups/{group_id}
IdpGroupMappingsAPI	GetIdpGroupMapping	Get /idp-group-mappings/{app_resource_id}/groups/{group_id}
IdpGroupMappingsAPI	GetIdpGroupMappings	Get /idp-group-mappings/{app_resource_id}
IdpGroupMappingsAPI	UpdateIdpGroupMappings	Put /idp-group-mappings/{app_resource_id}
MessageChannelsAPI	CreateMessageChannel	Post /message-channels
MessageChannelsAPI	GetMessageChannel	Get /message-channels/{message_channel_id}	Get message channel by ID
MessageChannelsAPI	GetMessageChannels	Get /message-channels	Get message channels
NonHumanIdentitiesAPI	GetNhis	Get /non-human-identities
OnCallSchedulesAPI	CreateOnCallSchedule	Post /on-call-schedules
OnCallSchedulesAPI	GetOnCallSchedule	Get /on-call-schedules/{on_call_schedule_id}	Get on call schedule by ID
OnCallSchedulesAPI	GetOnCallSchedules	Get /on-call-schedules	Get on call schedules
OwnersAPI	CreateOwner	Post /owners
OwnersAPI	DeleteOwner	Delete /owners/{owner_id}
OwnersAPI	GetOwner	Get /owners/{owner_id}	Get owner by ID
OwnersAPI	GetOwnerFromName	Get /owners/name/{owner_name}
OwnersAPI	GetOwnerUsers	Get /owners/{owner_id}/users
OwnersAPI	GetOwners	Get /owners	Get owners
OwnersAPI	SetOwnerUsers	Put /owners/{owner_id}/users
OwnersAPI	UpdateOwners	Put /owners
RequestsAPI	ApproveRequest	Post /requests/{id}/approve
RequestsAPI	CreateRequest	Post /requests
RequestsAPI	CreateRequestComment	Post /requests/{id}/comments
RequestsAPI	DenyRequest	Post /requests/{id}/deny
RequestsAPI	GetRequest	Get /requests/{id}	Get request by ID
RequestsAPI	GetRequestComments	Get /requests/{id}/comments
RequestsAPI	GetRequests	Get /requests	Get requests
RequestsAPI	GetRequestsRelay	Get /requests/relay	Get requests via Relay
ResourcesAPI	AddResourceNhi	Post /resources/{resource_id}/non-human-identities/{non_human_identity_id}
ResourcesAPI	AddResourceUser	Post /resources/{resource_id}/users/{user_id}
ResourcesAPI	CreateResource	Post /resources
ResourcesAPI	DeleteResource	Delete /resources/{resource_id}
ResourcesAPI	DeleteResourceNhi	Delete /resources/{resource_id}/non-human-identities/{non_human_identity_id}
ResourcesAPI	DeleteResourceUser	Delete /resources/{resource_id}/users/{user_id}
ResourcesAPI	GetResource	Get /resources/{resource_id}	Get resource by ID
ResourcesAPI	GetResourceMessageChannels	Get /resources/{resource_id}/message-channels
ResourcesAPI	GetResourceNhis	Get /resources/{resource_id}/non-human-identities
ResourcesAPI	GetResourceReviewerStages	Get /resources/{resource_id}/reviewer-stages
ResourcesAPI	GetResourceReviewers	Get /resources/{resource_id}/reviewers
ResourcesAPI	GetResourceScopedRolePermissions	Get /resources/{resource_id}/scoped-role-permissions
ResourcesAPI	GetResourceTags	Get /resources/{resource_id}/tags
ResourcesAPI	GetResourceUser	Get /resources/{resource_id}/users/{user_id}	Get resource user
ResourcesAPI	GetResourceUsers	Get /resources/{resource_id}/users	Get resource users
ResourcesAPI	GetResourceVisibility	Get /resources/{resource_id}/visibility
ResourcesAPI	GetResources	Get /resources	Get resources
ResourcesAPI	GetUserResources	Get /resources/users/{user_id}
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	SetResourceScopedRolePermissions	Put /resources/{resource_id}/scoped-role-permissions
ResourcesAPI	SetResourceVisibility	Put /resources/{resource_id}/visibility
ResourcesAPI	UpdateResourceUser	Put /resources/{resource_id}/users/{user_id}
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	DeleteTagByID	Delete /tag/{tag_id}
TagsAPI	GetTag	Get /tag
TagsAPI	GetTagByID	Get /tag/{tag_id}	Get tag by ID
TagsAPI	GetTags	Get /tags	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	GetRemoteUsers	Get /users/remote_users
UsersAPI	GetUserTags	Get /users/{user_id}/tags
UsersAPI	GetUsers	Get /users
UsersAPI	User	Get /user

Documentation For Models

• Access
• AccessList
• AccessRule
• AddBundleGroupRequest
• AddBundleResourceRequest
• AddGroupResourceRequest
• AddGroupUserRequest
• AddResourceNhiRequest
• AddResourceUserRequest
• App
• AppTypeEnum
• AppValidation
• AppValidationSeverityEnum
• AppValidationStatusEnum
• ApproveRequest200Response
• ApproveRequestRequest
• AppsList
• AwsPermissionSetMetadata
• AwsPermissionSetMetadataAwsPermissionSet
• Bundle
• BundleGroup
• BundleResource
• Condition
• ConfigurationTemplate
• CreateBundleInfo
• CreateConfigurationTemplateInfo
• CreateDelegationRequest
• CreateGroupBindingInfo
• CreateGroupBindingInfoGroupsInner
• CreateGroupInfo
• CreateIdpGroupMappingRequest
• CreateMessageChannelInfo
• CreateOnCallScheduleInfo
• CreateOwnerInfo
• CreateRequest200Response
• CreateRequestCommentRequest
• CreateRequestConfigurationInfoList
• CreateRequestInfo
• CreateRequestInfoCustomMetadataInner
• CreateRequestInfoGroupsInner
• CreateRequestInfoResourcesInner
• CreateRequestInfoSupportTicket
• CreateResourceInfo
• CreateTagInfo
• CreateUARInfo
• Delegation
• DenyRequestRequest
• EntityTypeEnum
• Event
• GetResourceUser200Response
• Group
• GroupAccessLevel
• GroupBinding
• GroupBindingGroup
• GroupContainingGroup
• GroupContainingGroupList
• GroupRemoteInfo
• GroupRemoteInfoActiveDirectoryGroup
• GroupRemoteInfoAzureAdMicrosoft365Group
• GroupRemoteInfoAzureAdSecurityGroup
• GroupRemoteInfoDuoGroup
• GroupRemoteInfoGithubTeam
• GroupRemoteInfoGitlabGroup
• GroupRemoteInfoGoogleGroup
• GroupRemoteInfoLdapGroup
• GroupRemoteInfoOktaGroup
• GroupRemoteInfoOktaGroupRule
• GroupRemoteInfoSnowflakeRole
• GroupRemoteInfoWorkdayUserSecurityGroup
• GroupResource
• GroupResourceList
• GroupTypeEnum
• GroupUser
• GroupUserList
• GroupWithAccessLevel
• IdpGroupMapping
• IdpGroupMappingList
• MessageChannel
• MessageChannelIDList
• MessageChannelList
• MessageChannelProviderEnum
• OnCallSchedule
• OnCallScheduleIDList
• OnCallScheduleList
• OnCallScheduleProviderEnum
• Owner
• PageInfo
• PaginatedAssignedRequestList
• PaginatedBundleGroupList
• PaginatedBundleList
• PaginatedBundleResourceList
• PaginatedConfigurationTemplateList
• PaginatedDelegationsList
• PaginatedEventList
• PaginatedGroupBindingsList
• PaginatedGroupsList
• PaginatedOwnersList
• PaginatedRemoteUsersList
• PaginatedResourcesList
• PaginatedTagsList
• PaginatedUARsList
• PaginatedUsersList
• PropagationStatus
• PropagationStatusEnum
• RemoteUser
• Request
• RequestApprovalEnum
• RequestComment
• RequestCommentList
• RequestConfiguration
• RequestConnection
• RequestCustomFieldResponse
• RequestCustomFieldResponseFieldValue
• RequestEdge
• RequestItemStages
• RequestList
• RequestReviewer
• RequestReviewerStages
• RequestStage
• RequestStatusEnum
• RequestTemplateCustomFieldTypeEnum
• RequestedItem
• Resource
• ResourceAccessLevel
• ResourceAccessUser
• ResourceAccessUserList
• ResourceNHI
• ResourceRemoteInfo
• ResourceRemoteInfoAwsAccount
• ResourceRemoteInfoAwsEc2Instance
• ResourceRemoteInfoAwsEksCluster
• ResourceRemoteInfoAwsIamRole
• ResourceRemoteInfoAwsOrganizationalUnit
• ResourceRemoteInfoAwsPermissionSet
• ResourceRemoteInfoAwsRdsInstance
• ResourceRemoteInfoCoupaRole
• ResourceRemoteInfoCustomConnector
• ResourceRemoteInfoDatastaxAstraRole
• ResourceRemoteInfoGcpBigQueryDataset
• ResourceRemoteInfoGcpBigQueryTable
• ResourceRemoteInfoGcpBucket
• ResourceRemoteInfoGcpComputeInstance
• ResourceRemoteInfoGcpFolder
• ResourceRemoteInfoGcpGkeCluster
• ResourceRemoteInfoGcpOrganization
• ResourceRemoteInfoGcpProject
• ResourceRemoteInfoGcpServiceAccount
• ResourceRemoteInfoGcpSqlInstance
• ResourceRemoteInfoGithubOrgRole
• ResourceRemoteInfoGithubRepo
• ResourceRemoteInfoGitlabProject
• ResourceRemoteInfoGoogleWorkspaceRole
• ResourceRemoteInfoOktaApp
• ResourceRemoteInfoOktaCustomRole
• ResourceRemoteInfoOktaStandardRole
• ResourceRemoteInfoPagerdutyRole
• ResourceRemoteInfoSalesforcePermissionSet
• ResourceRemoteInfoSalesforceProfile
• ResourceRemoteInfoSalesforceRole
• ResourceRemoteInfoTeleportRole
• ResourceTypeEnum
• ResourceUser
• ResourceUserAccessStatus
• ResourceUserAccessStatusEnum
• ResourceWithAccessLevel
• ReviewStageOperator
• ReviewerIDList
• ReviewerStage
• ReviewerStageList
• RiskSensitivityEnum
• RolePermissionNameEnum
• RolePermissionTargetTypeEnum
• RuleClauses
• RuleConjunction
• RuleDisjunction
• ScopedRolePermission
• ScopedRolePermissionList
• Session
• SessionsList
• SubEvent
• SyncError
• SyncErrorList
• SyncTask
• Tag
• TagFilter
• TagSelector
• TagsList
• ThirdPartyProviderEnum
• TicketPropagationConfiguration
• TicketingProviderEnum
• UAR
• UARReviewerAssignmentPolicyEnum
• UARScope
• UpdateAccessRuleInfo
• UpdateConfigurationTemplateInfo
• UpdateGroupBindingInfo
• UpdateGroupBindingInfoList
• UpdateGroupInfo
• UpdateGroupInfoList
• UpdateGroupResourcesInfo
• UpdateGroupUserRequest
• UpdateIdpGroupMappingsRequest
• UpdateIdpGroupMappingsRequestMappingsInner
• UpdateOwnerInfo
• UpdateOwnerInfoList
• UpdateResourceInfo
• UpdateResourceInfoList
• UpdateResourceUserRequest
• User
• UserHrIdpStatusEnum
• UserIDList
• UserList
• VisibilityInfo
• VisibilityTypeEnum

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: HTTP Bearer token authentication

Example

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