sdk

package
v3.2.1 Latest Latest
Warning

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

 Go to latest Published: Sep 11, 2025 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// Production
	ServerProd string = "prod"
)

Variables

View Source 
var ServerList = map[string]string{
	ServerProd: "https://api.opal.dev/v1",
}

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 Pointer 

func Pointer[T any](v T) *T

Pointer provides a helper function to return a pointer to a type

func String 

func String(s string) *string

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

Types

type AccessRules 

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

AccessRules - Operations related to access rules

func (*AccessRules) CreateAccessRule 

func (s *AccessRules) CreateAccessRule(ctx context.Context, request shared.UpdateAccessRuleInfo, opts ...operations.Option) (*operations.CreateAccessRuleResponse, error)

CreateAccessRule - Creates a new access rule config for the given group_id.

func (*AccessRules) GetAccessRule 

func (s *AccessRules) GetAccessRule(ctx context.Context, request operations.GetAccessRuleRequest, opts ...operations.Option) (*operations.GetAccessRuleResponse, error)

GetAccessRule - Returns a list of access rule config given the group_id of the access rule.

func (*AccessRules) UpdateAccessRule 

func (s *AccessRules) UpdateAccessRule(ctx context.Context, request operations.UpdateAccessRuleRequest, opts ...operations.Option) (*operations.UpdateAccessRuleResponse, error)

UpdateAccessRule - Updates the access rule config for the given group_id.

type Apps 

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

Apps - Operations related to apps

func (*Apps) Get 

func (s *Apps) Get(ctx context.Context, request operations.GetAppsRequest, opts ...operations.Option) (*operations.GetAppsResponse, error)

Get - Returns a list of `App` objects.

func (*Apps) GetID 

func (s *Apps) GetID(ctx context.Context, request operations.GetAppIDRequest, opts ...operations.Option) (*operations.GetAppIDResponse, error)

GetID - Returns an `App` object.

func (*Apps) GetSyncErrors 

func (s *Apps) GetSyncErrors(ctx context.Context, request operations.GetSyncErrorsRequest, opts ...operations.Option) (*operations.GetSyncErrorsResponse, error)

GetSyncErrors - Returns a list of recent sync errors that have occurred since the last successful sync.

type Bundles 

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

Bundles - Operations related to bundles

func (*Bundles) AddBundleGroup 

func (s *Bundles) AddBundleGroup(ctx context.Context, request operations.AddBundleGroupRequest, opts ...operations.Option) (*operations.AddBundleGroupResponse, error)

AddBundleGroup - Adds a group to a bundle.

func (*Bundles) AddBundleResource 

func (s *Bundles) AddBundleResource(ctx context.Context, request operations.AddBundleResourceRequest, opts ...operations.Option) (*operations.AddBundleResourceResponse, error)

AddBundleResource - Adds a resource to a bundle.

func (*Bundles) CreateBundle 

func (s *Bundles) CreateBundle(ctx context.Context, request shared.CreateBundleInfo, opts ...operations.Option) (*operations.CreateBundleResponse, error)

CreateBundle - Creates a bundle.

func (*Bundles) DeleteBundle 

func (s *Bundles) DeleteBundle(ctx context.Context, request operations.DeleteBundleRequest, opts ...operations.Option) (*operations.DeleteBundleResponse, error)

DeleteBundle - Deletes a bundle.

func (*Bundles) GetBundle 

func (s *Bundles) GetBundle(ctx context.Context, request operations.GetBundleRequest, opts ...operations.Option) (*operations.GetBundleResponse, error)

GetBundle - Returns a `Bundle` object.

func (*Bundles) GetBundleGroups 

func (s *Bundles) GetBundleGroups(ctx context.Context, request operations.GetBundleGroupsRequest, opts ...operations.Option) (*operations.GetBundleGroupsResponse, error)

GetBundleGroups - Returns a list of `Group` objects in a given bundle.

func (*Bundles) GetBundleResources 

func (s *Bundles) GetBundleResources(ctx context.Context, request operations.GetBundleResourcesRequest, opts ...operations.Option) (*operations.GetBundleResourcesResponse, error)

GetBundleResources - Returns a list of `Resource` objects in a given bundle.

func (*Bundles) GetBundleVisibility 

func (s *Bundles) GetBundleVisibility(ctx context.Context, request operations.GetBundleVisibilityRequest, opts ...operations.Option) (*operations.GetBundleVisibilityResponse, error)

GetBundleVisibility - Gets the visibility of the bundle.

func (*Bundles) GetBundles 

func (s *Bundles) GetBundles(ctx context.Context, request operations.GetBundlesRequest, opts ...operations.Option) (*operations.GetBundlesResponse, error)

GetBundles - Returns a list of `Bundle` objects.

func (*Bundles) RemoveBundleGroup 

func (s *Bundles) RemoveBundleGroup(ctx context.Context, request operations.RemoveBundleGroupRequest, opts ...operations.Option) (*operations.RemoveBundleGroupResponse, error)

RemoveBundleGroup - Removes a group from a bundle.

func (*Bundles) RemoveBundleResource 

func (s *Bundles) RemoveBundleResource(ctx context.Context, request operations.RemoveBundleResourceRequest, opts ...operations.Option) (*operations.RemoveBundleResourceResponse, error)

RemoveBundleResource - Removes a resource from a bundle.

func (*Bundles) SetBundleVisibility 

func (s *Bundles) SetBundleVisibility(ctx context.Context, request operations.SetBundleVisibilityRequest, opts ...operations.Option) (*operations.SetBundleVisibilityResponse, error)

SetBundleVisibility - Sets the visibility of the bundle.

func (*Bundles) UpdateBundle 

func (s *Bundles) UpdateBundle(ctx context.Context, request operations.UpdateBundleRequest, opts ...operations.Option) (*operations.UpdateBundleResponse, error)

UpdateBundle - Updates a bundle.

type ConfigurationTemplates 

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

ConfigurationTemplates - Operations related to configuration templates

func (*ConfigurationTemplates) Create 

func (s *ConfigurationTemplates) Create(ctx context.Context, request shared.CreateConfigurationTemplateInfo, opts ...operations.Option) (*operations.CreateConfigurationTemplateResponse, error)

Create - Creates a configuration template.

func (*ConfigurationTemplates) Delete 

func (s *ConfigurationTemplates) Delete(ctx context.Context, request operations.DeleteConfigurationTemplateRequest, opts ...operations.Option) (*operations.DeleteConfigurationTemplateResponse, error)

Delete - Deletes a configuration template.

func (*ConfigurationTemplates) Get 

func (s *ConfigurationTemplates) Get(ctx context.Context, opts ...operations.Option) (*operations.GetConfigurationTemplatesResponse, error)

Get - Returns a list of `ConfigurationTemplate` objects.

func (*ConfigurationTemplates) Update 

func (s *ConfigurationTemplates) Update(ctx context.Context, request shared.UpdateConfigurationTemplateInfo, opts ...operations.Option) (*operations.UpdateConfigurationTemplateResponse, error)

Update a configuration template.

type Events 

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

Events - Operations related to events

func (*Events) Get 

func (s *Events) Get(ctx context.Context, request operations.GetEventsRequest, opts ...operations.Option) (*operations.GetEventsResponse, error)

Get - Returns a list of `Event` objects.

type GroupBindings 

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

GroupBindings - Operations related to group bindings

func (*GroupBindings) CreateGroupBinding 

func (s *GroupBindings) CreateGroupBinding(ctx context.Context, request shared.CreateGroupBindingInfo, opts ...operations.Option) (*operations.CreateGroupBindingResponse, error)

CreateGroupBinding - Creates a group binding.

func (*GroupBindings) DeleteGroupBinding 

func (s *GroupBindings) DeleteGroupBinding(ctx context.Context, request operations.DeleteGroupBindingRequest, opts ...operations.Option) (*operations.DeleteGroupBindingResponse, error)

DeleteGroupBinding - Deletes a group binding.

func (*GroupBindings) GetGroupBinding 

func (s *GroupBindings) GetGroupBinding(ctx context.Context, request operations.GetGroupBindingRequest, opts ...operations.Option) (*operations.GetGroupBindingResponse, error)

GetGroupBinding - Returns a `GroupBinding` object.

func (*GroupBindings) GetGroupBindings 

func (s *GroupBindings) GetGroupBindings(ctx context.Context, request operations.GetGroupBindingsRequest, opts ...operations.Option) (*operations.GetGroupBindingsResponse, error)

GetGroupBindings - Returns a list of `GroupBinding` objects.

func (*GroupBindings) UpdateGroupBindings 

func (s *GroupBindings) UpdateGroupBindings(ctx context.Context, request shared.UpdateGroupBindingInfoList, opts ...operations.Option) (*operations.UpdateGroupBindingsResponse, error)

UpdateGroupBindings - Bulk updates a list of group bindings.

type Groups 

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

Groups - Operations related to groups

func (*Groups) AddGroupContainingGroup 

func (s *Groups) AddGroupContainingGroup(ctx context.Context, request operations.AddGroupContainingGroupRequest, opts ...operations.Option) (*operations.AddGroupContainingGroupResponse, error)

AddGroupContainingGroup - Creates a new containing group.

func (*Groups) Create 

func (s *Groups) Create(ctx context.Context, request shared.CreateGroupInfo, opts ...operations.Option) (*operations.CreateGroupResponse, error)

Create - Creates a group. See [here](https://docs.opal.dev/reference/end-system-objects) for details about importing groups.

func (*Groups) CreateResources 

func (s *Groups) CreateResources(ctx context.Context, request operations.CreateGroupResourcesRequest, opts ...operations.Option) (*operations.CreateGroupResourcesResponse, error)

CreateResources - Adds a resource to a group.

func (*Groups) CreateUser 

func (s *Groups) CreateUser(ctx context.Context, request operations.CreateGroupUserRequest, opts ...operations.Option) (*operations.CreateGroupUserResponse, error)

CreateUser - Adds a user to this group.

func (*Groups) Delete 

func (s *Groups) Delete(ctx context.Context, request operations.DeleteGroupRequest, opts ...operations.Option) (*operations.DeleteGroupResponse, error)

Delete - Deletes a group.

func (*Groups) DeleteUser 

func (s *Groups) DeleteUser(ctx context.Context, request operations.DeleteGroupUserRequest, opts ...operations.Option) (*operations.DeleteGroupUserResponse, error)

DeleteUser - Removes a user's access from this group.

func (*Groups) GetGroup 

func (s *Groups) GetGroup(ctx context.Context, request operations.GetGroupRequest, opts ...operations.Option) (*operations.GetGroupResponse, error)

GetGroup - Returns a `Group` object.

func (*Groups) GetGroupContainingGroup 

func (s *Groups) GetGroupContainingGroup(ctx context.Context, request operations.GetGroupContainingGroupRequest, opts ...operations.Option) (*operations.GetGroupContainingGroupResponse, error)

GetGroupContainingGroup - Gets a specific containing group for a group.

func (*Groups) GetMessageChannels 

func (s *Groups) GetMessageChannels(ctx context.Context, request operations.GetGroupMessageChannelsRequest, opts ...operations.Option) (*operations.GetGroupMessageChannelsResponse, error)

GetMessageChannels - Gets the list of audit and reviewer message channels attached to a group.

func (*Groups) GetOnCallSchedules added in v3.2.0 

func (s *Groups) GetOnCallSchedules(ctx context.Context, request operations.GetGroupOnCallSchedulesRequest, opts ...operations.Option) (*operations.GetGroupOnCallSchedulesResponse, error)

GetOnCallSchedules - Gets the list of on call schedules attached to a group.

func (*Groups) GetResources 

func (s *Groups) GetResources(ctx context.Context, request operations.GetGroupResourcesRequest, opts ...operations.Option) (*operations.GetGroupResourcesResponse, error)

GetResources - Gets the list of resources that the group gives access to.

func (*Groups) GetReviewersStages deprecated 

func (s *Groups) GetReviewersStages(ctx context.Context, request operations.GetGroupReviewersStagesRequest, opts ...operations.Option) (*operations.GetGroupReviewersStagesResponse, error)

GetReviewersStages - Gets the list of reviewer stages for a group.

Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.

func (*Groups) GetTags 

func (s *Groups) GetTags(ctx context.Context, request operations.GetGroupTagsRequest, opts ...operations.Option) (*operations.GetGroupTagsResponse, error)

GetTags - Returns all tags applied to the group.

func (*Groups) GetUsers 

func (s *Groups) GetUsers(ctx context.Context, request operations.GetGroupUsersRequest, opts ...operations.Option) (*operations.GetGroupUsersResponse, error)

GetUsers - Gets the list of users for this group.

func (*Groups) GetVisibility 

func (s *Groups) GetVisibility(ctx context.Context, request operations.GetGroupVisibilityRequest, opts ...operations.Option) (*operations.GetGroupVisibilityResponse, error)

GetVisibility - Gets the visibility of this group.

func (*Groups) List 

func (s *Groups) List(ctx context.Context, request operations.GetGroupsRequest, opts ...operations.Option) (*operations.GetGroupsResponse, error)

List - Returns a list of groups for your organization.

func (*Groups) RemoveGroupContainingGroup 

func (s *Groups) RemoveGroupContainingGroup(ctx context.Context, request operations.RemoveGroupContainingGroupRequest, opts ...operations.Option) (*operations.RemoveGroupContainingGroupResponse, error)

RemoveGroupContainingGroup - Removes a containing group from a group.

func (*Groups) Update 

func (s *Groups) Update(ctx context.Context, request shared.UpdateGroupInfoList, opts ...operations.Option) (*operations.UpdateGroupsResponse, error)

Update - Bulk updates a list of groups.

func (*Groups) UpdateGroupUser 

func (s *Groups) UpdateGroupUser(ctx context.Context, request operations.UpdateGroupUserRequest, opts ...operations.Option) (*operations.UpdateGroupUserResponse, error)

UpdateGroupUser - Updates a user's access level or duration in this group.

func (*Groups) UpdateMessageChannels 

func (s *Groups) UpdateMessageChannels(ctx context.Context, request operations.UpdateGroupMessageChannelsRequest, opts ...operations.Option) (*operations.UpdateGroupMessageChannelsResponse, error)

UpdateMessageChannels - Sets the list of audit message channels attached to a group.

func (*Groups) UpdateOnCallSchedules added in v3.2.0 

func (s *Groups) UpdateOnCallSchedules(ctx context.Context, request operations.UpdateGroupOnCallSchedulesRequest, opts ...operations.Option) (*operations.UpdateGroupOnCallSchedulesResponse, error)

UpdateOnCallSchedules - Sets the list of on call schedules attached to a group.

func (*Groups) UpdateResources 

func (s *Groups) UpdateResources(ctx context.Context, request operations.UpdateGroupResourcesRequest, opts ...operations.Option) (*operations.UpdateGroupResourcesResponse, error)

UpdateResources - Sets the list of resources that the group gives access to.

func (*Groups) UpdateReviewersStages deprecated 

func (s *Groups) UpdateReviewersStages(ctx context.Context, request operations.UpdateGroupReviewersStagesRequest, opts ...operations.Option) (*operations.UpdateGroupReviewersStagesResponse, error)

UpdateReviewersStages - Sets the list of reviewer stages for a group.

Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.

func (*Groups) UpdateVisibility 

func (s *Groups) UpdateVisibility(ctx context.Context, request operations.UpdateGroupVisibilityRequest, opts ...operations.Option) (*operations.UpdateGroupVisibilityResponse, error)

UpdateVisibility - Sets the visibility of this group.

type HTTPClient 

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient provides an interface for supplying the SDK with a custom HTTP client

type IdpGroupMappings 

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

IdpGroupMappings - Operations related to IDP group mappings

func (*IdpGroupMappings) CreateIdpGroupMapping added in v3.2.0 

func (s *IdpGroupMappings) CreateIdpGroupMapping(ctx context.Context, request operations.CreateIdpGroupMappingRequest, opts ...operations.Option) (*operations.CreateIdpGroupMappingResponse, error)

CreateIdpGroupMapping - Creates or updates an individual `IdpGroupMapping` object (upsert operation).

**Behavior:** - If the mapping doesn't exist, it will be created with the provided values - If the mapping exists, only the fields provided in the request will be updated

func (*IdpGroupMappings) DeleteIdpGroupMappings 

func (s *IdpGroupMappings) DeleteIdpGroupMappings(ctx context.Context, request operations.DeleteIdpGroupMappingsRequest, opts ...operations.Option) (*operations.DeleteIdpGroupMappingsResponse, error)

DeleteIdpGroupMappings - Deletes an `IdpGroupMapping` object.

func (*IdpGroupMappings) GetIdpGroupMappings 

func (s *IdpGroupMappings) GetIdpGroupMappings(ctx context.Context, request operations.GetIdpGroupMappingsRequest, opts ...operations.Option) (*operations.GetIdpGroupMappingsResponse, error)

GetIdpGroupMappings - Returns the configured set of available `IdpGroupMapping` objects for an Okta app.

func (*IdpGroupMappings) UpdateIdpGroupMappings 

func (s *IdpGroupMappings) UpdateIdpGroupMappings(ctx context.Context, request operations.UpdateIdpGroupMappingsRequest, opts ...operations.Option) (*operations.UpdateIdpGroupMappingsResponse, error)

UpdateIdpGroupMappings - Updates the list of available `IdpGroupMapping` objects for an Okta app.

type MessageChannels 

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

MessageChannels - Operations related to message channels

func (*MessageChannels) Create 

func (s *MessageChannels) Create(ctx context.Context, request shared.CreateMessageChannelInfo, opts ...operations.Option) (*operations.CreateMessageChannelResponse, error)

Create - Creates a `MessageChannel` objects.

func (*MessageChannels) Get 

func (s *MessageChannels) Get(ctx context.Context, opts ...operations.Option) (*operations.GetMessageChannelsResponse, error)

Get - Returns a list of `MessageChannel` objects.

func (*MessageChannels) GetID 

func (s *MessageChannels) GetID(ctx context.Context, request operations.GetMessageChannelIDRequest, opts ...operations.Option) (*operations.GetMessageChannelIDResponse, error)

GetID - Gets a `MessageChannel` object.

type NonHumanIdentities 

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

NonHumanIdentities - Operations related to non-human identities

func (*NonHumanIdentities) GetNhis 

func (s *NonHumanIdentities) GetNhis(ctx context.Context, request operations.GetNhisRequest, opts ...operations.Option) (*operations.GetNhisResponse, error)

GetNhis - Returns a list of non-human identities for your organization.

type OnCallSchedules 

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

OnCallSchedules - Operations related to on-call schedules

func (*OnCallSchedules) Create 

func (s *OnCallSchedules) Create(ctx context.Context, request shared.CreateOnCallScheduleInfo, opts ...operations.Option) (*operations.CreateOnCallScheduleResponse, error)

Create - Creates a `OnCallSchedule` objects.

func (*OnCallSchedules) Get 

func (s *OnCallSchedules) Get(ctx context.Context, opts ...operations.Option) (*operations.GetOnCallScheduleResponse, error)

Get - Returns a list of `OnCallSchedule` objects.

func (*OnCallSchedules) GetID 

func (s *OnCallSchedules) GetID(ctx context.Context, request operations.GetOnCallScheduleIDRequest, opts ...operations.Option) (*operations.GetOnCallScheduleIDResponse, error)

GetID - Gets a `OnCallSchedule` object.

type OpalAPI 

type OpalAPI struct {
	SDKVersion string
	// Operations related to access rules
	AccessRules *AccessRules
	// Operations related to apps
	Apps *Apps
	// Operations related to bundles
	Bundles *Bundles
	// Operations related to configuration templates
	ConfigurationTemplates *ConfigurationTemplates
	// Operations related to events
	Events *Events
	// Operations related to group bindings
	GroupBindings *GroupBindings
	// Operations related to groups
	Groups *Groups
	// Operations related to IDP group mappings
	IdpGroupMappings *IdpGroupMappings
	// Operations related to message channels
	MessageChannels *MessageChannels
	// Operations related to non-human identities
	NonHumanIdentities *NonHumanIdentities
	// Operations related to on-call schedules
	OnCallSchedules *OnCallSchedules
	// Operations related to owners
	Owners *Owners
	// Operations related to requests
	Requests *Requests
	// Operations related to resources
	Resources *Resources
	// Operations related to sessions
	Sessions *Sessions
	// Operations related to tags
	Tags *Tags
	// Operations related to UARs
	Uars *Uars
	// Operations related to users
	Users *Users
	// contains filtered or unexported fields
}

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

func New 

func New(opts ...SDKOption) *OpalAPI

New creates a new instance of the SDK with the provided options

type Owners 

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

Owners - Operations related to owners

func (*Owners) Create 

func (s *Owners) Create(ctx context.Context, request shared.CreateOwnerInfo, opts ...operations.Option) (*operations.CreateOwnerResponse, error)

Create - Creates an owner.

func (*Owners) Delete 

func (s *Owners) Delete(ctx context.Context, request operations.DeleteOwnerRequest, opts ...operations.Option) (*operations.DeleteOwnerResponse, error)

Delete - Deletes an owner.

func (*Owners) Get 

func (s *Owners) Get(ctx context.Context, request operations.GetOwnersRequest, opts ...operations.Option) (*operations.GetOwnersResponse, error)

Get - Returns a list of `Owner` objects.

func (*Owners) GetFromName 

func (s *Owners) GetFromName(ctx context.Context, request operations.GetOwnerFromNameRequest, opts ...operations.Option) (*operations.GetOwnerFromNameResponse, error)

GetFromName - Returns an `Owner` object. Does not support owners with `/` in their name, use /owners?name=... instead.

func (*Owners) GetID 

func (s *Owners) GetID(ctx context.Context, request operations.GetOwnerIDRequest, opts ...operations.Option) (*operations.GetOwnerIDResponse, error)

GetID - Returns an `Owner` object.

func (*Owners) Update 

func (s *Owners) Update(ctx context.Context, request shared.UpdateOwnerInfoList, opts ...operations.Option) (*operations.UpdateOwnersResponse, error)

Update - Bulk updates a list of owners.

func (*Owners) UpdateUsers 

func (s *Owners) UpdateUsers(ctx context.Context, request operations.UpdateOwnerUsersRequest, opts ...operations.Option) (*operations.UpdateOwnerUsersResponse, error)

UpdateUsers - Sets the list of users for this owner. If escalation is enabled, the order of this list is the escalation priority order of the users. If the owner has a source group, adding or removing users from this list won't be possible.

type Requests 

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

Requests - Operations related to requests

func (*Requests) ApproveRequest 

func (s *Requests) ApproveRequest(ctx context.Context, request operations.ApproveRequestRequest, opts ...operations.Option) (*operations.ApproveRequestResponse, error)

ApproveRequest - Approve an access request

func (*Requests) CreateRequest 

func (s *Requests) CreateRequest(ctx context.Context, request shared.CreateRequestInfo, opts ...operations.Option) (*operations.CreateRequestResponse, error)

CreateRequest - Create an access request

func (*Requests) Get 

func (s *Requests) Get(ctx context.Context, request operations.GetRequestsRequest, opts ...operations.Option) (*operations.GetRequestsResponse, error)

Get - Returns a list of requests for your organization that is visible by the admin.

func (*Requests) GetRequest 

func (s *Requests) GetRequest(ctx context.Context, request operations.GetRequestRequest, opts ...operations.Option) (*operations.GetRequestResponse, error)

GetRequest - Returns a request by ID.

func (*Requests) GetRequestsRelay deprecated 

func (s *Requests) GetRequestsRelay(ctx context.Context, request operations.GetRequestsRelayRequest, opts ...operations.Option) (*operations.GetRequestsRelayResponse, error)

GetRequestsRelay - Returns a paginated list of requests using Relay-style cursor pagination.

Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.

type Resources 

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

Resources - Operations related to resources

func (*Resources) AddResourceNhi 

func (s *Resources) AddResourceNhi(ctx context.Context, request operations.AddResourceNhiRequest, opts ...operations.Option) (*operations.AddResourceNhiResponse, error)

AddResourceNhi - Gives a non-human identity access to this resource.

func (*Resources) Create 

func (s *Resources) Create(ctx context.Context, request shared.CreateResourceInfo, opts ...operations.Option) (*operations.CreateResourceResponse, error)

Create - Creates a resource. See [here](https://docs.opal.dev/reference/end-system-objects) for details about importing resources.

func (*Resources) Delete 

func (s *Resources) Delete(ctx context.Context, request operations.DeleteResourceRequest, opts ...operations.Option) (*operations.DeleteResourceResponse, error)

Delete - Deletes a resource.

func (*Resources) DeleteResourceNhi 

func (s *Resources) DeleteResourceNhi(ctx context.Context, request operations.DeleteResourceNhiRequest, opts ...operations.Option) (*operations.DeleteResourceNhiResponse, error)

DeleteResourceNhi - Removes a non-human identity's direct access from this resource.

func (*Resources) Get 

func (s *Resources) Get(ctx context.Context, request operations.GetResourcesRequest, opts ...operations.Option) (*operations.GetResourcesResponse, error)

Get - Returns a list of resources for your organization.

func (*Resources) GetAccessStatus deprecated 

func (s *Resources) GetAccessStatus(ctx context.Context, request operations.GetResourceUserAccessStatusRequest, opts ...operations.Option) (*operations.GetResourceUserAccessStatusResponse, error)

GetAccessStatus - Get user's access status to a resource.

Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.

func (*Resources) GetID 

func (s *Resources) GetID(ctx context.Context, request operations.GetResourceIDRequest, opts ...operations.Option) (*operations.GetResourceIDResponse, error)

GetID - Retrieves a resource.

func (*Resources) GetMessageChannels 

func (s *Resources) GetMessageChannels(ctx context.Context, request operations.GetResourceMessageChannelsRequest, opts ...operations.Option) (*operations.GetResourceMessageChannelsResponse, error)

GetMessageChannels - Gets the list of audit message channels attached to a resource.

func (*Resources) GetResourceNhis 

func (s *Resources) GetResourceNhis(ctx context.Context, request operations.GetResourceNhisRequest, opts ...operations.Option) (*operations.GetResourceNhisResponse, error)

GetResourceNhis - Gets the list of non-human identities with access to this resource.

func (*Resources) GetReviewers 

func (s *Resources) GetReviewers(ctx context.Context, request operations.GetResourceReviewersRequest, opts ...operations.Option) (*operations.GetResourceReviewersResponse, error)

GetReviewers - Gets the list of owner IDs of the reviewers for a resource.

func (*Resources) GetScopedRolePermissions 

func (s *Resources) GetScopedRolePermissions(ctx context.Context, request operations.GetResourceScopedRolePermissionsRequest, opts ...operations.Option) (*operations.GetResourceScopedRolePermissionsResponse, error)

GetScopedRolePermissions - Returns all the scoped role permissions that apply to the given resource. Only OPAL_SCOPED_ROLE resource type supports this field.

func (*Resources) GetTags 

func (s *Resources) GetTags(ctx context.Context, request operations.GetResourceTagsRequest, opts ...operations.Option) (*operations.GetResourceTagsResponse, error)

GetTags - Returns all tags applied to the resource.

func (*Resources) GetUserResources added in v3.1.2 

func (s *Resources) GetUserResources(ctx context.Context, request operations.GetUserResourcesRequest, opts ...operations.Option) (*operations.GetUserResourcesResponse, error)

GetUserResources - Gets the list of resources for this user.

func (*Resources) GetUsers 

func (s *Resources) GetUsers(ctx context.Context, request operations.GetResourceUsersRequest, opts ...operations.Option) (*operations.GetResourceUsersResponse, error)

GetUsers - Gets the list of users for this resource.

func (*Resources) GetVisibility 

func (s *Resources) GetVisibility(ctx context.Context, request operations.GetResourceVisibilityRequest, opts ...operations.Option) (*operations.GetResourceVisibilityResponse, error)

GetVisibility - Gets the visibility of this resource.

func (*Resources) Update 

func (s *Resources) Update(ctx context.Context, request shared.UpdateResourceInfoList, opts ...operations.Option) (*operations.UpdateResourcesResponse, error)

Update - Bulk updates a list of resources.

func (*Resources) UpdateMessageChannels 

func (s *Resources) UpdateMessageChannels(ctx context.Context, request operations.UpdateResourceMessageChannelsRequest, opts ...operations.Option) (*operations.UpdateResourceMessageChannelsResponse, error)

UpdateMessageChannels - Sets the list of audit message channels attached to a resource.

func (*Resources) UpdateReviewers 

func (s *Resources) UpdateReviewers(ctx context.Context, request operations.UpdateResourceReviewersRequest, opts ...operations.Option) (*operations.UpdateResourceReviewersResponse, error)

UpdateReviewers - Sets the list of reviewers for a resource.

func (*Resources) UpdateScopedRolePermissions 

func (s *Resources) UpdateScopedRolePermissions(ctx context.Context, request operations.SetResourceScopedRolePermissionsRequest, opts ...operations.Option) (*operations.SetResourceScopedRolePermissionsResponse, error)

UpdateScopedRolePermissions - Sets all the scoped role permissions on an OPAL_SCOPED_ROLE resource.

func (*Resources) UpdateVisibility 

func (s *Resources) UpdateVisibility(ctx context.Context, request operations.UpdateResourceVisibilityRequest, opts ...operations.Option) (*operations.UpdateResourceVisibilityResponse, error)

UpdateVisibility - Sets the visibility of this resource.

type SDKOption 

type SDKOption func(*OpalAPI)

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 retry.Config) SDKOption

func WithSecurity 

func WithSecurity(security shared.Security) SDKOption

WithSecurity configures the SDK to use the provided security details

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 WithServer 

func WithServer(server string) SDKOption

WithServer allows the overriding of the default server by name

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 WithTimeout 

func WithTimeout(timeout time.Duration) SDKOption

WithTimeout Optional request timeout applied to each operation

type Sessions 

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

Sessions - Operations related to sessions

func (*Sessions) Get 

func (s *Sessions) Get(ctx context.Context, request operations.GetSessionsRequest, opts ...operations.Option) (*operations.GetSessionsResponse, error)

Get - Returns a list of `Session` objects.

type Tags 

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

Tags - Operations related to tags

func (*Tags) CreateGroup 

func (s *Tags) CreateGroup(ctx context.Context, request operations.CreateGroupTagRequest, opts ...operations.Option) (*operations.CreateGroupTagResponse, error)

CreateGroup - Applies a tag to a group.

func (*Tags) CreateResource 

func (s *Tags) CreateResource(ctx context.Context, request operations.CreateResourceTagRequest, opts ...operations.Option) (*operations.CreateResourceTagResponse, error)

CreateResource - Applies a tag to a resource.

func (*Tags) CreateTag 

func (s *Tags) CreateTag(ctx context.Context, request shared.CreateTagInfo, opts ...operations.Option) (*operations.CreateTagResponse, error)

CreateTag - Creates a tag with the given key and value.

func (*Tags) CreateUser 

func (s *Tags) CreateUser(ctx context.Context, request operations.CreateUserTagRequest, opts ...operations.Option) (*operations.CreateUserTagResponse, error)

CreateUser - Applies a tag to a user.

func (*Tags) Delete 

func (s *Tags) Delete(ctx context.Context, request operations.DeleteUserTagRequest, opts ...operations.Option) (*operations.DeleteUserTagResponse, error)

Delete - Removes a tag from a user.

func (*Tags) DeleteGroup 

func (s *Tags) DeleteGroup(ctx context.Context, request operations.DeleteGroupTagRequest, opts ...operations.Option) (*operations.DeleteGroupTagResponse, error)

DeleteGroup - Removes a tag from a group.

func (*Tags) DeleteResource 

func (s *Tags) DeleteResource(ctx context.Context, request operations.DeleteResourceTagRequest, opts ...operations.Option) (*operations.DeleteResourceTagResponse, error)

DeleteResource - Removes a tag from a resource.

func (*Tags) DeleteTagByID 

func (s *Tags) DeleteTagByID(ctx context.Context, request operations.DeleteTagByIDRequest, opts ...operations.Option) (*operations.DeleteTagByIDResponse, error)

DeleteTagByID - UNSTABLE. May be removed at any time. Deletes a tag with the given id.

func (*Tags) GetTagByID 

func (s *Tags) GetTagByID(ctx context.Context, request operations.GetTagByIDRequest, opts ...operations.Option) (*operations.GetTagByIDResponse, error)

GetTagByID - UNSTABLE. May be removed at any time. Gets a tag with the given id.

func (*Tags) GetTags 

func (s *Tags) GetTags(ctx context.Context, request operations.GetTagsRequest, opts ...operations.Option) (*operations.GetTagsResponse, error)

GetTags - Returns a list of tags created by your organization.

type Uars 

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

Uars - Operations related to UARs

func (*Uars) Create 

func (s *Uars) Create(ctx context.Context, request shared.CreateUARInfo, opts ...operations.Option) (*operations.CreateUARResponse, error)

Create - Starts a User Access Review.

func (*Uars) Get 

func (s *Uars) Get(ctx context.Context, request operations.GetUARsRequest, opts ...operations.Option) (*operations.GetUARsResponse, error)

Get - Returns a list of `UAR` objects.

func (*Uars) GetID 

func (s *Uars) GetID(ctx context.Context, request operations.GetUARIDRequest, opts ...operations.Option) (*operations.GetUARIDResponse, error)

GetID - Retrieves a specific UAR.

type Users 

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

Users - Operations related to users

func (*Users) Get 

func (s *Users) Get(ctx context.Context, request operations.GetUserRequest, opts ...operations.Option) (*operations.GetUserResponse, error)

Get - Returns a `User` object.

func (*Users) GetRemoteUsers added in v3.1.1 

func (s *Users) GetRemoteUsers(ctx context.Context, request operations.GetRemoteUsersRequest, opts ...operations.Option) (*operations.GetRemoteUsersResponse, error)

GetRemoteUsers - Returns a list of remote users for your organization.

func (*Users) GetUserTags 

func (s *Users) GetUserTags(ctx context.Context, request operations.GetUserTagsRequest, opts ...operations.Option) (*operations.GetUserTagsResponse, error)

GetUserTags - Returns all tags applied to the user.

func (*Users) GetUsers 

func (s *Users) GetUsers(ctx context.Context, request operations.GetUsersRequest, opts ...operations.Option) (*operations.GetUsersResponse, error)

GetUsers - Returns a list of users for your organization.

Source Files

View all Source files

Directories

Path Synopsis
internal
config
hooks
utils
models
errors
operations
shared

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.