Go API client for authorize

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

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(), authorize.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(), authorize.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(), authorize.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), authorize.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
APIServerDeploymentApi	DeployAPIServer	Post /environments/{environmentID}/apiServers/{apiServerID}/deployment	Deploy API Server
APIServerDeploymentApi	ReadDeploymentStatus	Get /environments/{environmentID}/apiServers/{apiServerID}/deployment	READ API Server Deployment Status
APIServerOperationsApi	CreateAPIServerOperation	Post /environments/{environmentID}/apiServers/{apiServerID}/operations	CREATE API Server Operation
APIServerOperationsApi	DeleteAPIServerOperation	Delete /environments/{environmentID}/apiServers/{apiServerID}/operations/{apiServerOperationID}	DELETE API Server Operation
APIServerOperationsApi	ReadAllAPIServerOperations	Get /environments/{environmentID}/apiServers/{apiServerID}/operations	READ All API Server Operations
APIServerOperationsApi	ReadOneAPIServerOperation	Get /environments/{environmentID}/apiServers/{apiServerID}/operations/{apiServerOperationID}	READ One API Server Operation
APIServerOperationsApi	UpdateAPIServerOperation	Put /environments/{environmentID}/apiServers/{apiServerID}/operations/{apiServerOperationID}	UPDATE API Server Operation
APIServersApi	CreateAPIServer	Post /environments/{environmentID}/apiServers	CREATE API Server
APIServersApi	DeleteAPIServer	Delete /environments/{environmentID}/apiServers/{apiServerID}	DELETE API Server
APIServersApi	ReadAllAPIServers	Get /environments/{environmentID}/apiServers	READ All API Servers
APIServersApi	ReadOneAPIServer	Get /environments/{environmentID}/apiServers/{apiServerID}	READ One API Server
APIServersApi	UpdateAPIServer	Put /environments/{environmentID}/apiServers/{apiServerID}	UPDATE API Server
ApplicationResourcePermissionsApi	CreateApplicationPermission	Post /environments/{environmentID}/applicationResources/{applicationResourceID}/permissions	CREATE Application Permission
ApplicationResourcePermissionsApi	DeleteApplicationPermission	Delete /environments/{environmentID}/applicationResources/{applicationResourceID}/permissions/{applicationResourcePermissionID}	DELETE Application Permission
ApplicationResourcePermissionsApi	ReadApplicationPermissions	Get /environments/{environmentID}/applicationResources/{applicationResourceID}/permissions	READ Application Permissions
ApplicationResourcePermissionsApi	ReadOneApplicationPermission	Get /environments/{environmentID}/applicationResources/{applicationResourceID}/permissions/{applicationResourcePermissionID}	READ One Application Permission
ApplicationResourcePermissionsApi	UpdateApplicationPermission	Put /environments/{environmentID}/applicationResources/{applicationResourceID}/permissions/{applicationResourcePermissionID}	UPDATE Application Permission
ApplicationResourcesApi	ReadApplicationResources	Get /environments/{environmentID}/applicationResources	READ Application Resources
ApplicationResourcesApi	ReadOneApplicationResource	Get /environments/{environmentID}/applicationResources/{applicationResourceID}	READ One Application Resource
ApplicationRoleAssignmentsApi	ReadApplicationRoleAssignments	Get /environments/{environmentID}/applicationRoles/{applicationRoleID}/assignments	READ Application Role Assignments
ApplicationRolePermissionsApi	CreateApplicationRolePermission	Post /environments/{environmentID}/applicationRoles/{applicationRoleID}/permissions	CREATE Application Role Permission
ApplicationRolePermissionsApi	DeleteApplicationRolePermission	Delete /environments/{environmentID}/applicationRoles/{applicationRoleID}/permissions/{applicationRolePermissionID}	DELETE Application Role Permission
ApplicationRolePermissionsApi	ReadApplicationRolePermissions	Get /environments/{environmentID}/applicationRoles/{applicationRoleID}/permissions	READ Application Role Permissions
ApplicationRolesApi	CreateApplicationRoles	Post /environments/{environmentID}/applicationRoles	CREATE Application Roles
ApplicationRolesApi	DeleteApplicationRole	Delete /environments/{environmentID}/applicationRoles/{applicationRoleID}	DELETE Application Role
ApplicationRolesApi	ReadApplicationRoles	Get /environments/{environmentID}/applicationRoles	READ Application Roles
ApplicationRolesApi	ReadOneApplicationRole	Get /environments/{environmentID}/applicationRoles/{applicationRoleID}	READ One Application Role
ApplicationRolesApi	UpdateApplicationRole	Put /environments/{environmentID}/applicationRoles/{applicationRoleID}	UPDATE Application Role
PolicyDecisionManagementApi	CreateDecisionEndpoint	Post /environments/{environmentID}/decisionEndpoints	CREATE Decision Endpoint
PolicyDecisionManagementApi	DeleteDecisionEndpoint	Delete /environments/{environmentID}/decisionEndpoints/{decisionEndpointID}	DELETE Decision Endpoint
PolicyDecisionManagementApi	ReadAllDecisionEndpoints	Get /environments/{environmentID}/decisionEndpoints	READ All Decision Endpoints
PolicyDecisionManagementApi	ReadOneDecisionEndpoint	Get /environments/{environmentID}/decisionEndpoints/{decisionEndpointID}	READ One Decision Endpoint
PolicyDecisionManagementApi	UpdateDecisionEndpoint	Put /environments/{environmentID}/decisionEndpoints/{decisionEndpointID}	UPDATE Decision Endpoint

Documentation For Models

• APIServer
• APIServerAccessControl
• APIServerAccessControlCustom
• APIServerAuthorizationServer
• APIServerAuthorizationServerResource
• APIServerDeployment
• APIServerDeploymentAccessControl
• APIServerDeploymentAccessControlCustom
• APIServerDeploymentAuthorizationVersion
• APIServerDeploymentDecisionEndpoint
• APIServerDeploymentPolicy
• APIServerDeploymentStatus
• APIServerDeploymentStatusError
• APIServerDirectory
• APIServerOperation
• APIServerOperationAccessControl
• APIServerOperationAccessControlGroup
• APIServerOperationAccessControlGroupGroupsInner
• APIServerOperationAccessControlPermission
• APIServerOperationAccessControlScope
• APIServerOperationAccessControlScopeScopesInner
• APIServerOperationPathsInner
• APIServerPolicy
• ApplicationResource
• ApplicationResourceParent
• ApplicationResourcePermission
• ApplicationResourcePermissionResource
• ApplicationRole
• ApplicationRoleAssignment
• ApplicationRolePermission
• ApplicationRolePermissionResource
• DecisionEndpoint
• DecisionEndpointAuthorizationVersion
• DecisionEndpointRecentDecisions
• EntityArray
• EntityArrayEmbedded
• EntityArrayEmbeddedPermissionsInner
• EnumAPIServerAuthorizationServerType
• EnumAPIServerOperationMatchType
• EnumAPIServerOperationMethod
• EnumAPIServerOperationPathPatternType
• EnumAPIServerPatternType
• EnumApplicationResourceParentType
• LinksHATEOASValue
• ObjectApplication
• ObjectEnvironment
• ObjectOrganization
• ObjectPopulation
• P1Error
• P1ErrorDetailsInner
• P1ErrorDetailsInnerInnerError

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