Go API client for openapi

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: 3.0.0-alpha.1
• 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 openapi "github.com/onelogin/onelogin-go-sdk"

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

Documentation for API Endpoints

All URIs are relative to https://onelogininc.onelogin.com

Class	Method	HTTP request	Description
DefaultApi	ActivateFactor	Post /api/2/mfa/users/{user_id}/verifications
DefaultApi	AddAccessTokenClaim	Post /api/2/api_authorizations/{id}/claims
DefaultApi	AddClientApp	Post /api/2/api_authorizations/{id}/clients
DefaultApi	AddRoleAdmins	Post /api/2/roles/{role_id}/admins
DefaultApi	AddRoleUsers	Post /api/2/roles/{role_id}/users
DefaultApi	AddScope	Post /api/2/api_authorizations/{id}/scopes
DefaultApi	BulkMappingSort	Put /api/2/apps/mappings/sort
DefaultApi	BulkSort	Put /api/2/apps/{app_id}/rules/sort
DefaultApi	CreateApp	Post /api/2/apps
DefaultApi	CreateAuthorizationServer	Post /api/2/api_authorizations
DefaultApi	CreateEnvironmentVariable	Post /api/2/hooks/envs
DefaultApi	CreateHook	Post /api/2/hooks
DefaultApi	CreateMapping	Post /api/2/mappings
DefaultApi	CreateRiskRule	Post /api/2/risk/rules
DefaultApi	CreateRoles	Post /api/2/roles
DefaultApi	CreateRule	Post /api/2/apps/{app_id}/rules
DefaultApi	CreateUser	Post /api/2/users
DefaultApi	DeleteAccessTokenClaim	Delete /api/2/api_authorizations/{id}/claims/{claim_id}
DefaultApi	DeleteApp	Delete /api/2/apps/{app_id}
DefaultApi	DeleteAppParameter	Delete /api/2/apps/{app_id}/parameters/{parameter_id}
DefaultApi	DeleteAuthorizationServer	Delete /api/2/api_authorizations/{id}
DefaultApi	DeleteEnvironmentVariable	Delete /api/2/hooks/envs/{envvar_id}
DefaultApi	DeleteFactor	Delete /api/2/mfa/users/{user_id}/devices/{device_id}
DefaultApi	DeleteHook	Delete /api/2/hooks/{hook_id}
DefaultApi	DeleteMapping	Delete /api/2/mappings/{mapping_id}
DefaultApi	DeleteRiskRule	Delete /api/2/risk/rules/{risk_rule_id}
DefaultApi	DeleteRole	Delete /api/2/roles/{role_id}
DefaultApi	DeleteRule	Delete /api/2/apps/{app_id}/rules/{rule_id}
DefaultApi	DeleteScope	Delete /api/2/api_authorizations/{id}/scopes/{scope_id}
DefaultApi	DeleteUser	Delete /api/2/users/{user_id}
DefaultApi	DryRunMapping	Post /api/2/mappings/{mapping_id}/dryrun
DefaultApi	EnrollFactor	Post /api/2/mfa/users/{user_id}/registrations
DefaultApi	GenerateMfaToken	Post /api/2/mfs/users/{user_id}/mfa_token
DefaultApi	GenerateSamlAssertion	Post /api/2/saml_assertion
DefaultApi	GenerateToken	Post /auth/oauth2/v2/token
DefaultApi	GetApp	Get /api/2/apps/{app_id}
DefaultApi	GetAuthorizationServer	Get /api/2/api_authorizations/{id}
DefaultApi	GetAvailableFactors	Get /api/2/mfa/users/{user_id}/factors
DefaultApi	GetClientApps	Get /api/2/api_authorizations/{id}/clients
DefaultApi	GetEnrolledFactors	Get /api/2/mfa/users/{user_id}/devices
DefaultApi	GetEnvironmentVariable	Get /api/2/hooks/envs/{envvar_id}
DefaultApi	GetHook	Get /api/2/hooks/{hook_id}
DefaultApi	GetLogs	Get /api/2/hooks/{hook_id}/logs
DefaultApi	GetMapping	Get /api/2/mappings/{mapping_id}
DefaultApi	GetRateLimit	Get /auth/rate_limit
DefaultApi	GetRiskRule	Get /api/2/risk/rules/{risk_rule_id}
DefaultApi	GetRiskScore	Post /api/2/risk/verify
DefaultApi	GetRole	Get /api/2/roles/{role_id}
DefaultApi	GetRoleAdmins	Get /api/2/roles/{role_id}/admins
DefaultApi	GetRoleApps	Get /api/2/roles/{role_id}/apps
DefaultApi	GetRoleUsers	Get /api/2/roles/{role_id}/users
DefaultApi	GetRule	Get /api/2/apps/{app_id}/rules/{rule_id}
DefaultApi	GetScoreInsights	Get /api/2/risk/scores
DefaultApi	GetUser	Get /api/2/users/{user_id}
DefaultApi	GetUserApps	Get /api/2/users/{user_id}/apps
DefaultApi	ListAccessTokenClaims	Get /api/2/api_authorizations/{id}/claims
DefaultApi	ListActionValues	Get /api/2/apps/{app_id}/rules/actions/{actuion_value}/values
DefaultApi	ListActions	Get /api/2/apps/{app_id}/rules/actions
DefaultApi	ListAppUsers	Get /api/2/apps/{app_id}/users
DefaultApi	ListApps	Get /api/2/apps
DefaultApi	ListAuthorizationServers	Get /api/2/api_authorizations
DefaultApi	ListConditionOperators	Get /api/2/apps/{app_id}/rules/conditions/{condition_value}/operators
DefaultApi	ListConditionValues	Get /api/2/apps/{app_id}/rules/conditions/{condition_value}/values
DefaultApi	ListConditions	Get /api/2/apps/{app_id}/rules/conditions
DefaultApi	ListConnectors	Get /api/2/connectors
DefaultApi	ListEnvironmentVariables	Get /api/2/hooks/envs
DefaultApi	ListHooks	Get /api/2/hooks
DefaultApi	ListMappingActionValues	Get /api/2/apps/mappings/actions/{actuion_value}/values
DefaultApi	ListMappingActions	Get /api/2/apps/mappings/actions
DefaultApi	ListMappingConditionOperators	Get /api/2/apps/mappings/conditions/{condition_value}/operators
DefaultApi	ListMappingConditionValues	Get /api/2/apps/mappings/conditions/{condition_value}/values
DefaultApi	ListMappingConditions	Get /api/2/apps/mappings/conditions
DefaultApi	ListMappings	Get /api/2/mappings
DefaultApi	ListRiskRules	Get /api/2/risk/rules
DefaultApi	ListRoles	Get /api/2/roles
DefaultApi	ListRules	Get /api/2/apps/{app_id}/rules
DefaultApi	ListScopes	Get /api/2/api_authorizations/{id}/scopes
DefaultApi	ListUsers	Get /api/2/users
DefaultApi	RemoveClientApp	Delete /api/2/api_authorizations/{id}/clients/{client_app_id}
DefaultApi	RemoveRoleAdmins	Delete /api/2/roles/{role_id}/admins
DefaultApi	RemoveRoleUsers	Delete /api/2/roles/{role_id}/users
DefaultApi	RevokeToken	Post /auth/oauth2/revoke
DefaultApi	SetRoleApps	Put /api/2/roles/{role_id}/apps
DefaultApi	TrackEvent	Post /api/2/risk/events
DefaultApi	UpdateAccessTokenClaim	Put /api/2/api_authorizations/{id}/claims/{claim_id}
DefaultApi	UpdateApp	Put /api/2/apps/{app_id}
DefaultApi	UpdateAuthorizationServer	Put /api/2/api_authorizations/{id}
DefaultApi	UpdateClientApp	Put /api/2/api_authorizations/{id}/clients/{client_app_id}
DefaultApi	UpdateEnvironmentVariable	Put /api/2/hooks/envs/{envvar_id}
DefaultApi	UpdateHook	Put /api/2/hooks/{hook_id}
DefaultApi	UpdateMapping	Put /api/2/mappings/{mapping_id}
DefaultApi	UpdateRiskRule	Put /api/2/risk/rules/{risk_rule_id}
DefaultApi	UpdateRole	Put /api/2/roles/{role_id}
DefaultApi	UpdateRule	Put /api/2/apps/{app_id}/rules/{rule_id}
DefaultApi	UpdateScope	Put /api/2/api_authorizations/{id}/scopes/{scope_id}
DefaultApi	UpdateUser	Put /api/2/users/{user_id}
DefaultApi	VerifyEnrollment	Put /api/2/mfa/users/{user_id}/registrations/{registration_id}
DefaultApi	VerifyEnrollmentVoiceProtect	Get /api/2/mfa/users/{user_id}/registrations/{registration_id}
DefaultApi	VerifyFactor	Put /api/2/mfa/users/{user_id}/verifications/{verification_id}
DefaultApi	VerifyFactorSaml	Post /api/2/saml_assertion/verify_factor
DefaultApi	VerifyFactorVoice	Get /api/2/mfa/users/{user_id}/verifications/{verification_id}

Documentation For Models

• Action
• ActivateFactorRequest
• AddAccessTokenClaimRequest
• AddClientAppRequest
• AddRoleUsers200ResponseInner
• AddScopeRequest
• AuthMethod
• AuthServerConfiguration
• ClientApp
• Condition
• Connector
• CreateAuthorizationServerRequest
• CreateEnvironmentVariableRequest
• CreateRoles201ResponseInner
• Device
• EnrollFactorRequest
• Envvar
• ErrorStatus
• ErrorStatusErrorsInner
• FactorInner
• FactorInnerFactorData
• GenerateMfaToken200Response
• GenerateMfaToken422Response
• GenerateMfaToken422ResponseDetails
• GenerateMfaTokenRequest
• GenerateSamlAssertionRequest
• GenerateToken200Response
• GenerateToken400Response
• GenerateTokenRequest
• GetAuthorizationServer200Response
• GetAvailableFactors200ResponseInner
• GetClientApps200ResponseInner
• GetClientApps200ResponseInnerScopesInner
• GetRateLimit200Response
• GetRateLimit200ResponseData
• GetRiskScore200Response
• GetRiskScore400Response
• GetRiskScoreRequest
• GetScoreInsights200Response
• GetScoreInsights200ResponseScores
• GetUserApps200ResponseInner
• Hook
• HookConditionsInner
• HookOptions
• HookStatus
• Id
• ListAccessTokenClaims200ResponseInner
• ListActions200ResponseInner
• ListAppUsers200ResponseInner
• ListAuthorizationServers200ResponseInner
• ListAuthorizationServers200ResponseInnerConfiguration
• ListConditionOperators200ResponseInner
• ListConditionValues200ResponseInner
• ListConditions200ResponseInner
• ListMappingConditionOperators200ResponseInner
• ListMappingConditions200ResponseInner
• ListScopes200ResponseInner
• Log
• Mapping
• Registration
• RemoveRoleUsersRequest
• RevokeTokenRequest
• RiskDevice
• RiskRule
• RiskUser
• Role
• Rule
• RuleId
• Schema
• Schema1
• Schema1AddedBy
• SchemaProvisioning
• Session
• SetRoleApps200ResponseInner
• Source
• Status
• Status1
• Status2
• Status2Status
• TrackEventRequest
• UpdateAuthorizationServer400Response
• UpdateClientAppRequest
• UpdateEnvironmentVariableRequest
• UpdateRole200Response
• User
• VerifyEnrollmentRequest
• VerifyFactorRequest
• VerifyFactorSaml200Response
• VerifyFactorSamlRequest
• VerifyFactorVoice200ResponseInner

Documentation For Authorization

Endpoints do not require authorization.

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