Go API client for mfa

The PingOne Platform API covering the PingOne MFA 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-06-29
• Package version: 0.20.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 mfa "github.com/patrickcping/pingone-go-sdk-v2/mfa"

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(), mfa.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(), mfa.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(), mfa.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), mfa.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
ApplicationsApplicationMFAPushCredentialsApi	CreateMFAPushCredential	Post /environments/{environmentID}/applications/{applicationID}/pushCredentials	CREATE MFA Push Credential
ApplicationsApplicationMFAPushCredentialsApi	DeleteMFAPushCredential	Delete /environments/{environmentID}/applications/{applicationID}/pushCredentials/{pushCredentialID}	DELETE MFA Push Credential
ApplicationsApplicationMFAPushCredentialsApi	ReadAllMFAPushCredentials	Get /environments/{environmentID}/applications/{applicationID}/pushCredentials	READ All MFA Push Credentials
ApplicationsApplicationMFAPushCredentialsApi	ReadOneMFAPushCredential	Get /environments/{environmentID}/applications/{applicationID}/pushCredentials/{pushCredentialID}	READ One MFA Push Credential
ApplicationsApplicationMFAPushCredentialsApi	UpdateMFAPushCredential	Put /environments/{environmentID}/applications/{applicationID}/pushCredentials/{pushCredentialID}	UPDATE MFA Push Credential
DeviceAuthenticationPolicyApi	CreateDeviceAuthenticationPolicies	Post /environments/{environmentID}/deviceAuthenticationPolicies	CREATE Device Authentication Policy
DeviceAuthenticationPolicyApi	DeleteDeviceAuthenticationPolicy	Delete /environments/{environmentID}/deviceAuthenticationPolicies/{deviceAuthenticationPolicyID}	DELETE Device Authentication Policy
DeviceAuthenticationPolicyApi	ReadDeviceAuthenticationPolicies	Get /environments/{environmentID}/deviceAuthenticationPolicies	READ Device Authentication Policies
DeviceAuthenticationPolicyApi	ReadOneDeviceAuthenticationPolicy	Get /environments/{environmentID}/deviceAuthenticationPolicies/{deviceAuthenticationPolicyID}	READ One Device Authentication Policy
DeviceAuthenticationPolicyApi	UpdateDeviceAuthenticationPolicy	Put /environments/{environmentID}/deviceAuthenticationPolicies/{deviceAuthenticationPolicyID}	UPDATE Device Authentication Policy
EnableUsersMFAApi	ReadUserMFAEnabled	Get /environments/{environmentID}/users/{userID}/mfaEnabled	READ User MFA Enabled
EnableUsersMFAApi	UpdateUserMFAEnabled	Put /environments/{environmentID}/users/{userID}/mfaEnabled	UPDATE User MFA Enabled
FIDO2PolicyApi	CreateFIDO2Policy	Post /environments/{environmentID}/fido2Policies	CREATE FIDO2 Policy
FIDO2PolicyApi	DeleteFIDO2Policy	Delete /environments/{environmentID}/fido2Policies/{fido2PolicyID}	DELETE FIDO2 Policy
FIDO2PolicyApi	ReadFIDO2Policies	Get /environments/{environmentID}/fido2Policies	READ FIDO2 Policies
FIDO2PolicyApi	ReadOneFIDO2Policy	Get /environments/{environmentID}/fido2Policies/{fido2PolicyID}	READ One FIDO2 Policy
FIDO2PolicyApi	UpdateFIDO2Policy	Put /environments/{environmentID}/fido2Policies/{fido2PolicyID}	UPDATE FIDO2 Policy
FIDODeviceApi	CreateFidoDevice	Post /environments/{environmentID}/fidoDevicesMetadata	CREATE FIDO Device
FIDODeviceApi	DeleteFidoDevice	Delete /environments/{environmentID}/fidoDevicesMetadata/{fidoDeviceID}	DELETE FIDO Device
FIDODeviceApi	ReadFidoDevices	Get /environments/{environmentID}/fidoDevicesMetadata	READ All FIDO Devices
FIDODeviceApi	ReadOneFidoDevice	Get /environments/{environmentID}/fidoDevicesMetadata/{fidoDeviceID}	READ One FIDO Device
FIDOPolicyApi	CreateFidoPolicy	Post /environments/{environmentID}/fidoPolicies	CREATE FIDO Policy
FIDOPolicyApi	DeleteFidoPolicy	Delete /environments/{environmentID}/fidoPolicies/{fidoPolicyID}	DELETE FIDO Policy
FIDOPolicyApi	ReadFidoPolicies	Get /environments/{environmentID}/fidoPolicies	READ FIDO Policies
FIDOPolicyApi	ReadOneFidoPolicy	Get /environments/{environmentID}/fidoPolicies/{fidoPolicyID}	READ One FIDO Policy
FIDOPolicyApi	UpdateFIDOPolicy	Put /environments/{environmentID}/fidoPolicies/{fidoPolicyID}	UPDATE FIDO Policy
MFASettingsApi	ReadMFASettings	Get /environments/{environmentID}/mfaSettings	READ MFA Settings
MFASettingsApi	ResetMFASettings	Delete /environments/{environmentID}/mfaSettings	RESET MFA Settings
MFASettingsApi	UpdateMFASettings	Put /environments/{environmentID}/mfaSettings	UPDATE MFA Settings
UserMFADevicesApi	EnvironmentsEnvironmentIDUsersUserIDDevicesDelete	Delete /environments/{environmentID}/users/{userID}/devices	DELETE Device Order
UserMFADevicesApi	EnvironmentsEnvironmentIDUsersUserIDDevicesDeviceIDDelete	Delete /environments/{environmentID}/users/{userID}/devices/{deviceID}	DELETE MFA User Device
UserMFADevicesApi	EnvironmentsEnvironmentIDUsersUserIDDevicesDeviceIDGet	Get /environments/{environmentID}/users/{userID}/devices/{deviceID}	READ One MFA User Device
UserMFADevicesApi	EnvironmentsEnvironmentIDUsersUserIDDevicesDeviceIDLogsPut	Put /environments/{environmentID}/users/{userID}/devices/{deviceID}/logs	SEND MFA Device Logs
UserMFADevicesApi	EnvironmentsEnvironmentIDUsersUserIDDevicesDeviceIDNicknamePut	Put /environments/{environmentID}/users/{userID}/devices/{deviceID}/nickname	UPDATE Device Nickname
UserMFADevicesApi	EnvironmentsEnvironmentIDUsersUserIDDevicesDeviceIDPost	Post /environments/{environmentID}/users/{userID}/devices/{deviceID}	ACTIVATE MFA User Device
UserMFADevicesApi	EnvironmentsEnvironmentIDUsersUserIDDevicesGet	Get /environments/{environmentID}/users/{userID}/devices	READ All MFA User Devices
UserMFADevicesApi	EnvironmentsEnvironmentIDUsersUserIDDevicesPost	Post /environments/{environmentID}/users/{userID}/devices	SET Device Order
UserMFAPairingKeysApi	EnvironmentsEnvironmentIDUsersUserIDPairingKeysPairingKeyIDDelete	Delete /environments/{environmentID}/users/{userID}/pairingKeys/{pairingKeyID}	DELETE MFA Pairing Key
UserMFAPairingKeysApi	EnvironmentsEnvironmentIDUsersUserIDPairingKeysPairingKeyIDGet	Get /environments/{environmentID}/users/{userID}/pairingKeys/{pairingKeyID}	READ One MFA Pairing Key
UserMFAPairingKeysApi	EnvironmentsEnvironmentIDUsersUserIDPairingKeysPost	Post /environments/{environmentID}/users/{userID}/pairingKeys	CREATE MFA Pairing Key

Documentation For Models

• DeviceAuthenticationPolicy
• DeviceAuthenticationPolicyAuthentication
• DeviceAuthenticationPolicyFIDODevice
• DeviceAuthenticationPolicyFido2
• DeviceAuthenticationPolicyMigrate
• DeviceAuthenticationPolicyMigrateData
• DeviceAuthenticationPolicyMobile
• DeviceAuthenticationPolicyMobileApplicationsInner
• DeviceAuthenticationPolicyMobileApplicationsInnerAutoEnrollment
• DeviceAuthenticationPolicyMobileApplicationsInnerDeviceAuthorization
• DeviceAuthenticationPolicyMobileApplicationsInnerOtp
• DeviceAuthenticationPolicyMobileApplicationsInnerPairingKeyLifetime
• DeviceAuthenticationPolicyMobileApplicationsInnerPush
• DeviceAuthenticationPolicyMobileApplicationsInnerPushLimit
• DeviceAuthenticationPolicyMobileApplicationsInnerPushLimitLockDuration
• DeviceAuthenticationPolicyMobileApplicationsInnerPushLimitTimePeriod
• DeviceAuthenticationPolicyMobileApplicationsInnerPushTimeout
• DeviceAuthenticationPolicyMobileOtp
• DeviceAuthenticationPolicyMobileOtpWindow
• DeviceAuthenticationPolicyMobileOtpWindowStepSize
• DeviceAuthenticationPolicyOfflineDevice
• DeviceAuthenticationPolicyOfflineDeviceOtp
• DeviceAuthenticationPolicyOfflineDeviceOtpFailure
• DeviceAuthenticationPolicyOfflineDeviceOtpFailureCoolDown
• DeviceAuthenticationPolicyOfflineDeviceOtpLifeTime
• DeviceAuthenticationPolicyPost
• DeviceAuthenticationPolicyPostResponse
• DeviceAuthenticationPolicyTotp
• DeviceAuthenticationPolicyTotpOtp
• EntityArray
• EntityArrayEmbedded
• EnumDeviceAuthenticationPolicyPostContentType
• EnumFIDO2PolicyAttestationRequirements
• EnumFIDO2PolicyAuthenticatorAttachment
• EnumFIDO2PolicyDiscoverableCredentials
• EnumFIDO2PolicyMDSAuthenticatorOption
• EnumFIDO2PolicyUserVerificationOption
• EnumFIDOAttestationRequirements
• EnumFIDOResidentKeyRequirement
• EnumMFADevicePolicyMobileExtraVerification
• EnumMFADevicePolicyMobileIntegrityDetection
• EnumMFADevicePolicyNewDeviceNotification
• EnumMFADevicePolicySelection
• EnumMFAPushCredentialAttrType
• EnumMFASettingsDeviceSelection
• EnumMFASettingsPairingKeyFormat
• EnumTimeUnit
• EnumTimeUnitPairingKeyLifetime
• EnumTimeUnitPushTimeout
• FIDO2Policy
• FIDO2PolicyBackupEligibility
• FIDO2PolicyMdsAuthenticatorsRequirements
• FIDO2PolicyMdsAuthenticatorsRequirementsAllowedAuthenticatorsInner
• FIDO2PolicyUserDisplayNameAttributes
• FIDO2PolicyUserDisplayNameAttributesAttributesInner
• FIDO2PolicyUserDisplayNameAttributesAttributesInnerSubAttributesInner
• FIDO2PolicyUserVerification
• FIDOPolicy
• FIDOPolicyAllowedAuthenticatorsInner
• LinksHATEOASValue
• MFAPushCredential
• MFAPushCredentialAPNS
• MFAPushCredentialFCM
• MFAPushCredentialFCMHTTPV1
• MFAPushCredentialHMS
• MFAPushCredentialRequest
• MFAPushCredentialResponse
• MFASettings
• MFASettingsAuthentication
• MFASettingsLockout
• MFASettingsPairing
• MFASettingsPhoneExtensions
• MFASettingsUsers
• ObjectEnvironment
• P1Error
• P1ErrorDetailsInner
• P1ErrorDetailsInnerInnerError
• UserMFAEnabled

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