Go API client for credentials

The PingOne Platform API covering the PingOne Credentials 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.9.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 credentials "github.com/patrickcping/pingone-go-sdk-v2/credentials"

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(), credentials.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(), credentials.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(), credentials.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), credentials.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
CredentialIssuanceRulesApi	ApplyCredentialIssuanceRuleStagedChanges	Post /environments/{environmentID}/credentialTypes/{credentialTypeID}/issuanceRules/{credentialIssuanceRuleID}/stagedChanges	Apply Credential Issuance Rule Staged Changes
CredentialIssuanceRulesApi	CreateCredentialIssuanceRule	Post /environments/{environmentID}/credentialTypes/{credentialTypeID}/issuanceRules	Create Credential Issuance Rule
CredentialIssuanceRulesApi	DeleteCredentialIssuanceRule	Delete /environments/{environmentID}/credentialTypes/{credentialTypeID}/issuanceRules/{credentialIssuanceRuleID}	Delete Credential Issuance Rule
CredentialIssuanceRulesApi	ReadAllCredentialIssuanceRules	Get /environments/{environmentID}/credentialTypes/{credentialTypeID}/issuanceRules	Read All Credential Issuance Rules
CredentialIssuanceRulesApi	ReadCredentialIssuanceRuleStagedChanges	Get /environments/{environmentID}/credentialTypes/{credentialTypeID}/issuanceRules/{credentialIssuanceRuleID}/stagedChanges	Read Credential Issuance Rule Staged Changes
CredentialIssuanceRulesApi	ReadCredentialIssuanceRuleUsageCounts	Get /environments/{environmentID}/credentialTypes/{credentialTypeID}/issuanceRules/{credentialIssuanceRuleID}/usageCounts	Read Credential Issuance Rule Usage Counts
CredentialIssuanceRulesApi	ReadCredentialIssuanceRuleUsageDetails	Get /environments/{environmentID}/credentialTypes/{credentialTypeID}/issuanceRules/{credentialIssuanceRuleID}/usageDetails	Read Credential Issuance Rule Usage Details
CredentialIssuanceRulesApi	ReadOneCredentialIssuanceRule	Get /environments/{environmentID}/credentialTypes/{credentialTypeID}/issuanceRules/{credentialIssuanceRuleID}	Read One Credential Issuance Rule
CredentialIssuanceRulesApi	UpdateCredentialIssuanceRule	Put /environments/{environmentID}/credentialTypes/{credentialTypeID}/issuanceRules/{credentialIssuanceRuleID}	Update Credential Issuance Rule
CredentialIssuersApi	CreateCredentialIssuerProfile	Post /environments/{environmentID}/credentialIssuerProfile	Create Credential Issuer Profile
CredentialIssuersApi	ReadCredentialIssuerProfile	Get /environments/{environmentID}/credentialIssuerProfile	Read Credential Issuer Profile
CredentialIssuersApi	UpdateCredentialIssuerProfile	Put /environments/{environmentID}/credentialIssuerProfile	Update Credential Issuer Profile
CredentialTypesApi	CreateCredentialType	Post /environments/{environmentID}/credentialTypes	Create Credential Type
CredentialTypesApi	DeleteCredentialType	Delete /environments/{environmentID}/credentialTypes/{credentialTypeID}	Delete a Credential Type
CredentialTypesApi	ReadAllCredentialTypes	Get /environments/{environmentID}/credentialTypes	Read All Credential Types
CredentialTypesApi	ReadOneCredentialType	Get /environments/{environmentID}/credentialTypes/{credentialTypeID}	Read One Credential Type
CredentialTypesApi	UpdateCredentialType	Put /environments/{environmentID}/credentialTypes/{credentialTypeID}	Update a Credential Type
DigitalWalletAppsApi	CreateDigitalWalletApp	Post /environments/{environmentID}/digitalWalletApplications	Create Digital Wallet App
DigitalWalletAppsApi	DeleteDigitalWalletApp	Delete /environments/{environmentID}/digitalWalletApplications/{digitalWalletApplicationID}	Delete Digital Wallet App
DigitalWalletAppsApi	ReadAllDigitalWalletApps	Get /environments/{environmentID}/digitalWalletApplications	Read All Digital Wallet Apps
DigitalWalletAppsApi	ReadOneDigitalWalletApp	Get /environments/{environmentID}/digitalWalletApplications/{digitalWalletApplicationID}	Read One Digital Wallet App
DigitalWalletAppsApi	UpdateDigitalWalletApp	Put /environments/{environmentID}/digitalWalletApplications/{digitalWalletApplicationID}	Update Digital Wallet App
DigitalWalletsApi	CreateDigitalWallet	Post /environments/{environmentID}/users/{userID}/digitalWallets	Create Digital Wallet
DigitalWalletsApi	DeleteDigitalWallet	Delete /environments/{environmentID}/users/{userID}/digitalWallets/{digitalWalletID}	Delete Digital Wallet
DigitalWalletsApi	ReadAllDigitalWallets	Get /environments/{environmentID}/users/{userID}/digitalWallets	Read All Digital Wallets
DigitalWalletsApi	ReadOneDigitalWallet	Get /environments/{environmentID}/users/{userID}/digitalWallets/{digitalWalletID}	Read One Digital Wallet
DigitalWalletsApi	ReadOneDigitalWalletCredential	Get /environments/{environmentID}/users/{userID}/digitalWallets/{digitalWalletID}/provisionedCredentials	Read One Digital Wallet Credential
DigitalWalletsApi	UpdateDigitalWallet	Put /environments/{environmentID}/users/{userID}/digitalWallets/{digitalWalletID}	Update Digital Wallet
UserCredentialsApi	CreateAUserCredential	Post /environments/{environmentID}/users/{userID}/credentials	Create a User Credential
UserCredentialsApi	ReadAllUserCredentials	Get /environments/{environmentID}/users/{userID}/credentials	Read All User Credentials
UserCredentialsApi	ReadOneUserCredential	Get /environments/{environmentID}/users/{userID}/credentials/{credentialID}	Read One User Credential
UserCredentialsApi	ReadOneUserCredentialWallet	Get /environments/{environmentID}/users/{userID}/credentials/{credentialID}/provisionedCredentials	Read One User Credential Wallet
UserCredentialsApi	UpdateUserCredential	Put /environments/{environmentID}/users/{userID}/credentials/{credentialID}	Update a User Credential

Documentation For Models

• CredentialDigitalWallet
• CredentialDigitalWalletApplication
• CredentialDigitalWalletDigitalWalletApplication
• CredentialDigitalWalletNotification
• CredentialDigitalWalletNotificationResultsInner
• CredentialDigitalWalletNotificationResultsInnerError
• CredentialDigitalWalletNotificationResultsInnerErrorDetailsInner
• CredentialDigitalWalletNotificationResultsInnerNotification
• CredentialDigitalWalletNotificationTemplate
• CredentialDigitalWalletPairingSession
• CredentialDigitalWalletUser
• CredentialIssuanceRule
• CredentialIssuanceRuleAutomation
• CredentialIssuanceRuleCredentialType
• CredentialIssuanceRuleDigitalWalletApplication
• CredentialIssuanceRuleFilter
• CredentialIssuanceRuleNotification
• CredentialIssuanceRuleNotificationTemplate
• CredentialIssuanceRuleStagedChange
• CredentialIssuanceRuleStagedChangeStagedChanges
• CredentialIssuanceRuleStagedChangeStagedChangesCredentialType
• CredentialIssuanceRuleStagedChangeStagedChangesIssuanceRule
• CredentialIssuanceRuleStagedChangeStagedChangesUser
• CredentialIssuanceRuleUsageCounts
• CredentialIssuanceRuleUsageDetails
• CredentialIssuanceRuleUsageInner
• CredentialIssuanceRuleUsageInnerCredential
• CredentialIssuanceRuleUsageInnerUser
• CredentialIssuerProfile
• CredentialIssuerProfileApplicationInstance
• CredentialType
• CredentialTypeManagement
• CredentialTypeMetaData
• CredentialTypeMetaDataFieldsInner
• CredentialTypeMultiple
• CredentialTypeOnDelete
• DigitalWalletApplication
• EntityArray
• EntityArrayEmbedded
• EntityArrayEmbeddedItemsInner
• EnumCDigitalWalletProvisionedCredentialWalletAction
• EnumCredentialIssuanceRuleAutomationMethod
• EnumCredentialIssuanceRuleNotificationMethod
• EnumCredentialIssuanceRuleStagedChangeAction
• EnumCredentialIssuanceRuleStatus
• EnumCredentialTypeManagementMode
• EnumCredentialTypeMetaDataFieldsFileSupport
• EnumCredentialTypeMetaDataFieldsType
• LinksHATEOASValue
• ObjectApplication
• ObjectEnvironment
• ObjectIssuer
• ObjectOrganization
• ObjectPopulation
• P1Error
• P1ErrorDetailsInner
• P1ErrorDetailsInnerInnerError
• ProvisionedCredential
• ProvisionedCredentialClaimReference
• ProvisionedCredentialCredential
• ProvisionedCredentialUser
• ProvisionedCredentialWalletActionsInner
• UserCredential
• UserCredentialUserdata

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