# README

Go API client for v2

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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.0.0
  • Package version: 1.0.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/oauth2
go get golang.org/x/net/context

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

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

ctx := context.WithValue(context.Background(), v2.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(), v2.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(), v2.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), v2.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://sailpoint.api.identitynow.com/v2

ClassMethodHTTP requestDescription
GovernanceGroupsApiBulkDeleteWorkGroupsPost /workgroups/bulk-deleteBulk delete work groups
GovernanceGroupsApiCreateWorkgroupPost /workgroupsCreate Work Group
GovernanceGroupsApiDeleteWorkgroupDelete /workgroups/{workgroupId}Delete Work Group By Id
GovernanceGroupsApiGetWorkgroupGet /workgroups/{workgroupId}Get Work Group By Id
GovernanceGroupsApiListWorkgroupConnectionsGet /workgroups/{workgroupId}/connectionsList Work Group Connections
GovernanceGroupsApiListWorkgroupMembersGet /workgroups/{workgroupId}/membersList Work Group Members
GovernanceGroupsApiListWorkgroupsGet /workgroupsList Work Groups
GovernanceGroupsApiModifyWorkgroupMembersPost /workgroups/{workgroupId}/membersModify Work Group Members
GovernanceGroupsApiUpdateWorkgroupPatch /workgroups/{workgroupId}Update Work Group By Id
OrgApiGetOrgSettingsGet /orgRetrieves your org settings.
OrgApiUpdateOrgSettingsPatch /orgUpdates one or more org attributes.

Documentation For Models

Documentation For Authorization

oauth2

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • sp:scopes:default: default scope
  • sp:scopes:all: access to all scopes

Example

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

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

oauth2

Example

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

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
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

# Packages

No description provided by the author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewBulkDeleteWorkGroups200Response instantiates a new BulkDeleteWorkGroups200Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBulkDeleteWorkGroups200ResponseWithDefaults instantiates a new BulkDeleteWorkGroups200Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBulkDeleteWorkGroupsRequest instantiates a new BulkDeleteWorkGroupsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBulkDeleteWorkGroupsRequestWithDefaults instantiates a new BulkDeleteWorkGroupsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewConfiguration returns a new Configuration object.
NewCreateWorkgroupRequest instantiates a new CreateWorkgroupRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCreateWorkgroupRequestOwner instantiates a new CreateWorkgroupRequestOwner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCreateWorkgroupRequestOwnerWithDefaults instantiates a new CreateWorkgroupRequestOwner object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCreateWorkgroupRequestWithDefaults instantiates a new CreateWorkgroupRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetOrgSettings200Response instantiates a new GetOrgSettings200Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetOrgSettings200ResponseApprovalConfig instantiates a new GetOrgSettings200ResponseApprovalConfig object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetOrgSettings200ResponseApprovalConfigWithDefaults instantiates a new GetOrgSettings200ResponseApprovalConfig object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetOrgSettings200ResponseSystemNotificationConfig instantiates a new GetOrgSettings200ResponseSystemNotificationConfig object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetOrgSettings200ResponseSystemNotificationConfigNotificationsInner instantiates a new GetOrgSettings200ResponseSystemNotificationConfigNotificationsInner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetOrgSettings200ResponseSystemNotificationConfigNotificationsInnerThresholds instantiates a new GetOrgSettings200ResponseSystemNotificationConfigNotificationsInnerThresholds object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetOrgSettings200ResponseSystemNotificationConfigNotificationsInnerThresholdsWithDefaults instantiates a new GetOrgSettings200ResponseSystemNotificationConfigNotificationsInnerThresholds object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetOrgSettings200ResponseSystemNotificationConfigNotificationsInnerWithDefaults instantiates a new GetOrgSettings200ResponseSystemNotificationConfigNotificationsInner object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetOrgSettings200ResponseSystemNotificationConfigWithDefaults instantiates a new GetOrgSettings200ResponseSystemNotificationConfig object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetOrgSettings200ResponseWithDefaults instantiates a new GetOrgSettings200Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListWorkgroupConnections200ResponseInner instantiates a new ListWorkgroupConnections200ResponseInner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListWorkgroupConnections200ResponseInnerWithDefaults instantiates a new ListWorkgroupConnections200ResponseInner object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListWorkgroupMembers200ResponseInner instantiates a new ListWorkgroupMembers200ResponseInner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListWorkgroupMembers200ResponseInnerWithDefaults instantiates a new ListWorkgroupMembers200ResponseInner object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListWorkgroups200ResponseInner instantiates a new ListWorkgroups200ResponseInner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListWorkgroups200ResponseInnerOwner instantiates a new ListWorkgroups200ResponseInnerOwner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListWorkgroups200ResponseInnerOwnerWithDefaults instantiates a new ListWorkgroups200ResponseInnerOwner object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListWorkgroups200ResponseInnerWithDefaults instantiates a new ListWorkgroups200ResponseInner object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModifyWorkgroupMembersRequest instantiates a new ModifyWorkgroupMembersRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModifyWorkgroupMembersRequestWithDefaults instantiates a new ModifyWorkgroupMembersRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewUpdateOrgSettingsRequest instantiates a new UpdateOrgSettingsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUpdateOrgSettingsRequestWithDefaults instantiates a new UpdateOrgSettingsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
No description provided by the author
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

No description provided by the author
No description provided by the author
APIClient manages communication with the SailPoint SaaS API API v2.0.0 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
BulkDeleteWorkGroups200Response struct for BulkDeleteWorkGroups200Response.
BulkDeleteWorkGroupsRequest struct for BulkDeleteWorkGroupsRequest.
Configuration stores the configuration of the API client.
CreateWorkgroupRequest struct for CreateWorkgroupRequest.
CreateWorkgroupRequestOwner struct for CreateWorkgroupRequestOwner.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GetOrgSettings200Response struct for GetOrgSettings200Response.
GetOrgSettings200ResponseApprovalConfig struct for GetOrgSettings200ResponseApprovalConfig.
GetOrgSettings200ResponseSystemNotificationConfig struct for GetOrgSettings200ResponseSystemNotificationConfig.
GetOrgSettings200ResponseSystemNotificationConfigNotificationsInner struct for GetOrgSettings200ResponseSystemNotificationConfigNotificationsInner.
GetOrgSettings200ResponseSystemNotificationConfigNotificationsInnerThresholds struct for GetOrgSettings200ResponseSystemNotificationConfigNotificationsInnerThresholds.
ListWorkgroupConnections200ResponseInner struct for ListWorkgroupConnections200ResponseInner.
ListWorkgroupMembers200ResponseInner struct for ListWorkgroupMembers200ResponseInner.
ListWorkgroups200ResponseInner struct for ListWorkgroups200ResponseInner.
ListWorkgroups200ResponseInnerOwner struct for ListWorkgroups200ResponseInnerOwner.
ModifyWorkgroupMembersRequest struct for ModifyWorkgroupMembersRequest.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
UpdateOrgSettingsRequest struct for UpdateOrgSettingsRequest.

# Type aliases

GovernanceGroupsApiService GovernanceGroupsApi service.
OrgApiService OrgApi service.
ServerConfigurations stores multiple ServerConfiguration items.