Go API client for verify

The PingOne Platform API covering the PingOne Verify service

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: 2023-07-20
• Package version: 0.7.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/net/context

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

import verify "github.com/patrickcping/pingone-go-sdk-v2/verify"

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

Documentation for API Endpoints

All URIs are relative to https://api.pingone.com/v1

Class	Method	HTTP request	Description
VerifyPoliciesApi	CreateVerifyPolicy	Post /environments/{environmentID}/verifyPolicies	CREATE Verify Policy
VerifyPoliciesApi	DeleteVerifyPolicy	Delete /environments/{environmentID}/verifyPolicies/{verifyPolicyID}	Delete Verify Policy
VerifyPoliciesApi	ReadAllVerifyPolicies	Get /environments/{environmentID}/verifyPolicies	READ All Verify Policies
VerifyPoliciesApi	ReadOneVerifyPolicy	Get /environments/{environmentID}/verifyPolicies/{verifyPolicyID}	READ One Verify Policy
VerifyPoliciesApi	UpdateVerifyPolicy	Put /environments/{environmentID}/verifyPolicies/{verifyPolicyID}	UPDATE Verify Policy
VoicePhraseContentsApi	CreateVoicePhraseContent	Post /environments/{environmentID}/voicePhrases/{voicePhraseID}/contents	CREATE Voice Phrase Content
VoicePhraseContentsApi	DeleteVoicePhraseContent	Delete /environments/{environmentID}/voicePhrases/{voicePhraseID}/contents/{voiceContentsID}	Delete Voice Phrase Content
VoicePhraseContentsApi	ReadAllVoicePhraseContents	Get /environments/{environmentID}/voicePhrases/{voicePhraseID}/contents	READ All Voice Phrase Contents
VoicePhraseContentsApi	ReadOneVoicePhraseContent	Get /environments/{environmentID}/voicePhrases/{voicePhraseID}/contents/{voiceContentsID}	READ One Voice Phrase Content
VoicePhraseContentsApi	UpdateVoicePhraseContent	Put /environments/{environmentID}/voicePhrases/{voicePhraseID}/contents/{voiceContentsID}	UPDATE Voice Phrase Content
VoicePhrasesApi	CreateVoicePhrase	Post /environments/{environmentID}/voicePhrases	CREATE Voice Phrase
VoicePhrasesApi	DeleteVoicePhrase	Delete /environments/{environmentID}/voicePhrases/{voicePhraseID}	Delete Voice Phrase
VoicePhrasesApi	ReadAllVoicePhrases	Get /environments/{environmentID}/voicePhrases	READ All Voice Phrases
VoicePhrasesApi	ReadOneVoicePhrase	Get /environments/{environmentID}/voicePhrases/{voicePhraseID}	READ One Voice Phrase
VoicePhrasesApi	UpdateVoicePhrase	Put /environments/{environmentID}/voicePhrases/{voicePhraseID}	UPDATE Voice Phrase

Documentation For Models

• EntityArray
• EntityArrayEmbedded
• EnumInspectionType
• EnumProviderAuto
• EnumProviderManual
• EnumThreshold
• EnumTimeUnit
• EnumVerify
• FacialComparisonConfiguration
• GovernmentIdConfiguration
• GovernmentIdConfigurationProvider
• LinksHATEOASValue
• LivenessConfiguration
• OTPDeviceConfiguration
• OTPDeviceConfigurationOtp
• OTPDeviceConfigurationOtpAttempts
• OTPDeviceConfigurationOtpDeliveries
• OTPDeviceConfigurationOtpDeliveriesCooldown
• OTPDeviceConfigurationOtpLifeTime
• OTPDeviceConfigurationOtpNotification
• ObjectEnvironment
• ObjectRetry
• P1Error
• P1ErrorDetailsInner
• P1ErrorDetailsInnerInnerError
• TransactionConfiguration
• TransactionConfigurationDataCollection
• TransactionConfigurationDataCollectionTimeout
• TransactionConfigurationTimeout
• VerifyPolicy
• VoiceConfiguration
• VoiceConfigurationReferenceData
• VoiceConfigurationTextDependent
• VoiceConfigurationTextDependentPhrase
• VoiceConfigurationThreshold
• VoicePhrase
• VoicePhraseContents
• VoicePhraseContentsVoicePhrase

Documentation For Authorization

Authentication schemes defined for the API:

bearer

• 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