authorize

package module
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 15, 2024 License: BSD-3-Clause Imports: 20 Imported by: 0

README

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.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 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

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

Documentation

Index

Constants

View Source 
const (
	PAGINATION_HAL_LINK_INDEX_SELF = "self"
	PAGINATION_HAL_LINK_INDEX_NEXT = "next"
	PAGINATION_HAL_LINK_INDEX_PREV = "prev"
)

Variables

View Source 
var (
	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)
View Source 
var AllowedEnumAPIServerAuthorizationServerTypeEnumValues = []EnumAPIServerAuthorizationServerType{
	"PINGONE_SSO",
	"EXTERNAL",
}

All allowed values of EnumAPIServerAuthorizationServerType enum

View Source 
var AllowedEnumAPIServerOperationMatchTypeEnumValues = []EnumAPIServerOperationMatchType{
	"ANY",
	"ALL",
}

All allowed values of EnumAPIServerOperationMatchType enum

View Source 
var AllowedEnumAPIServerOperationMethodEnumValues = []EnumAPIServerOperationMethod{
	"GET",
	"POST",
	"PUT",
	"PATCH",
	"DELETE",
	"OPTIONS",
}

All allowed values of EnumAPIServerOperationMethod enum

View Source 
var AllowedEnumAPIServerOperationPathPatternTypeEnumValues = []EnumAPIServerOperationPathPatternType{
	"EXACT",
	"PARAMETER",
}

All allowed values of EnumAPIServerOperationPathPatternType enum

View Source 
var AllowedEnumAPIServerPatternTypeEnumValues = []EnumAPIServerPatternType{
	"EXACT",
	"PARAMETER",
}

All allowed values of EnumAPIServerPatternType enum

View Source 
var AllowedEnumApplicationResourceParentTypeEnumValues = []EnumApplicationResourceParentType{
	"PING_ONE_RESOURCE",
}

All allowed values of EnumApplicationResourceParentType enum

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func IsNil added in v0.1.3 

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	APIServersApi *APIServersApiService

	APIServerDeploymentApi *APIServerDeploymentApiService

	APIServerOperationsApi *APIServerOperationsApiService

	ApplicationResourcePermissionsApi *ApplicationResourcePermissionsApiService

	ApplicationResourcesApi *ApplicationResourcesApiService

	ApplicationRoleAssignmentsApi *ApplicationRoleAssignmentsApiService

	ApplicationRolePermissionsApi *ApplicationRolePermissionsApiService

	ApplicationRolesApi *ApplicationRolesApiService

	HALApi *HALApiService

	PolicyDecisionManagementApi *PolicyDecisionManagementApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the PingOne Platform API - Authorize API v2022-09-23 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type APIServer 

type APIServer struct {
	Links               *map[string]LinksHATEOASValue `json:"_links,omitempty"`
	AccessControl       *APIServerAccessControl       `json:"accessControl,omitempty"`
	AuthorizationServer APIServerAuthorizationServer  `json:"authorizationServer"`
	// An array of string that specifies the possible base URLs that an end-user will use to access the APIs hosted on the customer's API server. Multiple base URLs may be specified to support cases where the same API may be available from multiple URLs (for example, from a user-friendly domain URL and an internal domain URL). Base URLs must be valid absolute URLs with the https or http scheme. If the path component is non-empty, it must not end in a trailing slash. The path must not contain empty backslash, dot, or double-dot segments. It must not have a query or fragment present, and the host portion of the authority must be a DNS hostname or valid IP (IPv4 or IPv6). The length must be less than or equal to 256 characters.
	BaseUrls  []string            `json:"baseUrls"`
	Directory *APIServerDirectory `json:"directory,omitempty"`
	// A string that specifies the resource's unique identifier.
	Id *string `json:"id,omitempty"`
	// A string that specifies the API server resource name. The name value must be unique among all API servers, and it must be a valid resource name.
	Name   string           `json:"name"`
	Policy *APIServerPolicy `json:"policy,omitempty"`
}

APIServer struct for APIServer

func NewAPIServer 

func NewAPIServer(authorizationServer APIServerAuthorizationServer, baseUrls []string, name string) *APIServer

NewAPIServer instantiates a new APIServer object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerWithDefaults 

func NewAPIServerWithDefaults() *APIServer

NewAPIServerWithDefaults instantiates a new APIServer object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServer) GetAccessControl added in v0.5.0 

func (o *APIServer) GetAccessControl() APIServerAccessControl

GetAccessControl returns the AccessControl field value if set, zero value otherwise.

func (*APIServer) GetAccessControlOk added in v0.5.0 

func (o *APIServer) GetAccessControlOk() (*APIServerAccessControl, bool)

GetAccessControlOk returns a tuple with the AccessControl field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServer) GetAuthorizationServer 

func (o *APIServer) GetAuthorizationServer() APIServerAuthorizationServer

GetAuthorizationServer returns the AuthorizationServer field value

func (*APIServer) GetAuthorizationServerOk 

func (o *APIServer) GetAuthorizationServerOk() (*APIServerAuthorizationServer, bool)

GetAuthorizationServerOk returns a tuple with the AuthorizationServer field value and a boolean to check if the value has been set.

func (*APIServer) GetBaseUrls added in v0.5.0 

func (o *APIServer) GetBaseUrls() []string

GetBaseUrls returns the BaseUrls field value

func (*APIServer) GetBaseUrlsOk added in v0.5.0 

func (o *APIServer) GetBaseUrlsOk() ([]string, bool)

GetBaseUrlsOk returns a tuple with the BaseUrls field value and a boolean to check if the value has been set.

func (*APIServer) GetDirectory added in v0.5.0 

func (o *APIServer) GetDirectory() APIServerDirectory

GetDirectory returns the Directory field value if set, zero value otherwise.

func (*APIServer) GetDirectoryOk added in v0.5.0 

func (o *APIServer) GetDirectoryOk() (*APIServerDirectory, bool)

GetDirectoryOk returns a tuple with the Directory field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServer) GetId 

func (o *APIServer) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*APIServer) GetIdOk 

func (o *APIServer) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set. 

func (o *APIServer) GetLinks() map[string]LinksHATEOASValue

GetLinks returns the Links field value if set, zero value otherwise.

func (*APIServer) GetLinksOk added in v0.3.0 

func (o *APIServer) GetLinksOk() (*map[string]LinksHATEOASValue, bool)

GetLinksOk returns a tuple with the Links field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServer) GetName 

func (o *APIServer) GetName() string

GetName returns the Name field value

func (*APIServer) GetNameOk 

func (o *APIServer) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*APIServer) GetPolicy added in v0.5.0 

func (o *APIServer) GetPolicy() APIServerPolicy

GetPolicy returns the Policy field value if set, zero value otherwise.

func (*APIServer) GetPolicyOk added in v0.5.0 

func (o *APIServer) GetPolicyOk() (*APIServerPolicy, bool)

GetPolicyOk returns a tuple with the Policy field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServer) HasAccessControl added in v0.5.0 

func (o *APIServer) HasAccessControl() bool

HasAccessControl returns a boolean if a field has been set.

func (*APIServer) HasDirectory added in v0.5.0 

func (o *APIServer) HasDirectory() bool

HasDirectory returns a boolean if a field has been set.

func (*APIServer) HasId 

func (o *APIServer) HasId() bool

HasId returns a boolean if a field has been set. 

func (o *APIServer) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (*APIServer) HasPolicy added in v0.5.0 

func (o *APIServer) HasPolicy() bool

HasPolicy returns a boolean if a field has been set.

func (APIServer) MarshalJSON 

func (o APIServer) MarshalJSON() ([]byte, error)

func (*APIServer) SetAccessControl added in v0.5.0 

func (o *APIServer) SetAccessControl(v APIServerAccessControl)

SetAccessControl gets a reference to the given APIServerAccessControl and assigns it to the AccessControl field.

func (*APIServer) SetAuthorizationServer 

func (o *APIServer) SetAuthorizationServer(v APIServerAuthorizationServer)

SetAuthorizationServer sets field value

func (*APIServer) SetBaseUrls added in v0.5.0 

func (o *APIServer) SetBaseUrls(v []string)

SetBaseUrls sets field value

func (*APIServer) SetDirectory added in v0.5.0 

func (o *APIServer) SetDirectory(v APIServerDirectory)

SetDirectory gets a reference to the given APIServerDirectory and assigns it to the Directory field.

func (*APIServer) SetId 

func (o *APIServer) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field. 

func (o *APIServer) SetLinks(v map[string]LinksHATEOASValue)

SetLinks gets a reference to the given map[string]LinksHATEOASValue and assigns it to the Links field.

func (*APIServer) SetName 

func (o *APIServer) SetName(v string)

SetName sets field value

func (*APIServer) SetPolicy added in v0.5.0 

func (o *APIServer) SetPolicy(v APIServerPolicy)

SetPolicy gets a reference to the given APIServerPolicy and assigns it to the Policy field.

func (APIServer) ToMap added in v0.1.3 

func (o APIServer) ToMap() (map[string]interface{}, error)

type APIServerAccessControl added in v0.5.0 

type APIServerAccessControl struct {
	Custom *APIServerAccessControlCustom `json:"custom,omitempty"`
}

APIServerAccessControl struct for APIServerAccessControl

func NewAPIServerAccessControl added in v0.5.0 

func NewAPIServerAccessControl() *APIServerAccessControl

NewAPIServerAccessControl instantiates a new APIServerAccessControl object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerAccessControlWithDefaults added in v0.5.0 

func NewAPIServerAccessControlWithDefaults() *APIServerAccessControl

NewAPIServerAccessControlWithDefaults instantiates a new APIServerAccessControl object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServerAccessControl) GetCustom added in v0.5.0 

func (o *APIServerAccessControl) GetCustom() APIServerAccessControlCustom

GetCustom returns the Custom field value if set, zero value otherwise.

func (*APIServerAccessControl) GetCustomOk added in v0.5.0 

func (o *APIServerAccessControl) GetCustomOk() (*APIServerAccessControlCustom, bool)

GetCustomOk returns a tuple with the Custom field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerAccessControl) HasCustom added in v0.5.0 

func (o *APIServerAccessControl) HasCustom() bool

HasCustom returns a boolean if a field has been set.

func (APIServerAccessControl) MarshalJSON added in v0.5.0 

func (o APIServerAccessControl) MarshalJSON() ([]byte, error)

func (*APIServerAccessControl) SetCustom added in v0.5.0 

func (o *APIServerAccessControl) SetCustom(v APIServerAccessControlCustom)

SetCustom gets a reference to the given APIServerAccessControlCustom and assigns it to the Custom field.

func (APIServerAccessControl) ToMap added in v0.5.0 

func (o APIServerAccessControl) ToMap() (map[string]interface{}, error)

type APIServerAccessControlCustom added in v0.5.0 

type APIServerAccessControlCustom struct {
	// If `TRUE`, custom policy will be used for the endpoint. Defaults to `FALSE`.
	Enabled *bool `json:"enabled,omitempty"`
}

APIServerAccessControlCustom Defines if the operation will use custom policy rather than the \"Group\" or \"Scope\" `accessControl` requirement.

func NewAPIServerAccessControlCustom added in v0.5.0 

func NewAPIServerAccessControlCustom() *APIServerAccessControlCustom

NewAPIServerAccessControlCustom instantiates a new APIServerAccessControlCustom object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerAccessControlCustomWithDefaults added in v0.5.0 

func NewAPIServerAccessControlCustomWithDefaults() *APIServerAccessControlCustom

NewAPIServerAccessControlCustomWithDefaults instantiates a new APIServerAccessControlCustom object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServerAccessControlCustom) GetEnabled added in v0.5.0 

func (o *APIServerAccessControlCustom) GetEnabled() bool

GetEnabled returns the Enabled field value if set, zero value otherwise.

func (*APIServerAccessControlCustom) GetEnabledOk added in v0.5.0 

func (o *APIServerAccessControlCustom) GetEnabledOk() (*bool, bool)

GetEnabledOk returns a tuple with the Enabled field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerAccessControlCustom) HasEnabled added in v0.5.0 

func (o *APIServerAccessControlCustom) HasEnabled() bool

HasEnabled returns a boolean if a field has been set.

func (APIServerAccessControlCustom) MarshalJSON added in v0.5.0 

func (o APIServerAccessControlCustom) MarshalJSON() ([]byte, error)

func (*APIServerAccessControlCustom) SetEnabled added in v0.5.0 

func (o *APIServerAccessControlCustom) SetEnabled(v bool)

SetEnabled gets a reference to the given bool and assigns it to the Enabled field.

func (APIServerAccessControlCustom) ToMap added in v0.5.0 

func (o APIServerAccessControlCustom) ToMap() (map[string]interface{}, error)

type APIServerAuthorizationServer 

type APIServerAuthorizationServer struct {
	Resource *APIServerAuthorizationServerResource `json:"resource,omitempty"`
	Type     EnumAPIServerAuthorizationServerType  `json:"type"`
}

APIServerAuthorizationServer A container object for properties related to the authorization server that will issue access tokens used to access the APIs.

func NewAPIServerAuthorizationServer 

func NewAPIServerAuthorizationServer(type_ EnumAPIServerAuthorizationServerType) *APIServerAuthorizationServer

NewAPIServerAuthorizationServer instantiates a new APIServerAuthorizationServer object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerAuthorizationServerWithDefaults 

func NewAPIServerAuthorizationServerWithDefaults() *APIServerAuthorizationServer

NewAPIServerAuthorizationServerWithDefaults instantiates a new APIServerAuthorizationServer object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServerAuthorizationServer) GetResource 

func (o *APIServerAuthorizationServer) GetResource() APIServerAuthorizationServerResource

GetResource returns the Resource field value if set, zero value otherwise.

func (*APIServerAuthorizationServer) GetResourceOk 

func (o *APIServerAuthorizationServer) GetResourceOk() (*APIServerAuthorizationServerResource, bool)

GetResourceOk returns a tuple with the Resource field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerAuthorizationServer) GetType added in v0.5.0 

func (o *APIServerAuthorizationServer) GetType() EnumAPIServerAuthorizationServerType

GetType returns the Type field value

func (*APIServerAuthorizationServer) GetTypeOk added in v0.5.0 

func (o *APIServerAuthorizationServer) GetTypeOk() (*EnumAPIServerAuthorizationServerType, bool)

GetTypeOk returns a tuple with the Type field value and a boolean to check if the value has been set.

func (*APIServerAuthorizationServer) HasResource added in v0.5.0 

func (o *APIServerAuthorizationServer) HasResource() bool

HasResource returns a boolean if a field has been set.

func (APIServerAuthorizationServer) MarshalJSON 

func (o APIServerAuthorizationServer) MarshalJSON() ([]byte, error)

func (*APIServerAuthorizationServer) SetResource 

func (o *APIServerAuthorizationServer) SetResource(v APIServerAuthorizationServerResource)

SetResource gets a reference to the given APIServerAuthorizationServerResource and assigns it to the Resource field.

func (*APIServerAuthorizationServer) SetType added in v0.5.0 

func (o *APIServerAuthorizationServer) SetType(v EnumAPIServerAuthorizationServerType)

SetType sets field value

func (APIServerAuthorizationServer) ToMap added in v0.1.3 

func (o APIServerAuthorizationServer) ToMap() (map[string]interface{}, error)

type APIServerAuthorizationServerResource 

type APIServerAuthorizationServerResource struct {
	// A string that specifies the UUID of the custom PingOne resource. This property must identify a PingOne resource with a type property value of CUSTOM.
	Id string `json:"id"`
}

APIServerAuthorizationServerResource The resource defines the characteristics of the OAuth 2.0 access tokens used to get access to the APIs on the API server such as the audience and scopes.

func NewAPIServerAuthorizationServerResource 

func NewAPIServerAuthorizationServerResource(id string) *APIServerAuthorizationServerResource

NewAPIServerAuthorizationServerResource instantiates a new APIServerAuthorizationServerResource object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerAuthorizationServerResourceWithDefaults 

func NewAPIServerAuthorizationServerResourceWithDefaults() *APIServerAuthorizationServerResource

NewAPIServerAuthorizationServerResourceWithDefaults instantiates a new APIServerAuthorizationServerResource object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServerAuthorizationServerResource) GetId 

func (o *APIServerAuthorizationServerResource) GetId() string

GetId returns the Id field value

func (*APIServerAuthorizationServerResource) GetIdOk 

func (o *APIServerAuthorizationServerResource) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (APIServerAuthorizationServerResource) MarshalJSON 

func (o APIServerAuthorizationServerResource) MarshalJSON() ([]byte, error)

func (*APIServerAuthorizationServerResource) SetId 

func (o *APIServerAuthorizationServerResource) SetId(v string)

SetId sets field value

func (APIServerAuthorizationServerResource) ToMap added in v0.1.3 

func (o APIServerAuthorizationServerResource) ToMap() (map[string]interface{}, error)

type APIServerDeployment added in v0.5.0 

type APIServerDeployment struct {
	Links                *map[string]LinksHATEOASValue            `json:"_links,omitempty"`
	AccessControl        *APIServerDeploymentAccessControl        `json:"accessControl,omitempty"`
	AuthorizationVersion *APIServerDeploymentAuthorizationVersion `json:"authorizationVersion,omitempty"`
	DecisionEndpoint     *APIServerDeploymentDecisionEndpoint     `json:"decisionEndpoint,omitempty"`
	// The time of most recent successful deployment. Null if the API service has never been successfully deployed.
	DeployedAt *time.Time                 `json:"deployedAt,omitempty"`
	Policy     *APIServerDeploymentPolicy `json:"policy,omitempty"`
	Status     *APIServerDeploymentStatus `json:"status,omitempty"`
}

APIServerDeployment struct for APIServerDeployment

func NewAPIServerDeployment added in v0.5.0 

func NewAPIServerDeployment() *APIServerDeployment

NewAPIServerDeployment instantiates a new APIServerDeployment object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerDeploymentWithDefaults added in v0.5.0 

func NewAPIServerDeploymentWithDefaults() *APIServerDeployment

NewAPIServerDeploymentWithDefaults instantiates a new APIServerDeployment object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServerDeployment) GetAccessControl added in v0.5.0 

func (o *APIServerDeployment) GetAccessControl() APIServerDeploymentAccessControl

GetAccessControl returns the AccessControl field value if set, zero value otherwise.

func (*APIServerDeployment) GetAccessControlOk added in v0.5.0 

func (o *APIServerDeployment) GetAccessControlOk() (*APIServerDeploymentAccessControl, bool)

GetAccessControlOk returns a tuple with the AccessControl field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeployment) GetAuthorizationVersion added in v0.5.0 

func (o *APIServerDeployment) GetAuthorizationVersion() APIServerDeploymentAuthorizationVersion

GetAuthorizationVersion returns the AuthorizationVersion field value if set, zero value otherwise.

func (*APIServerDeployment) GetAuthorizationVersionOk added in v0.5.0 

func (o *APIServerDeployment) GetAuthorizationVersionOk() (*APIServerDeploymentAuthorizationVersion, bool)

GetAuthorizationVersionOk returns a tuple with the AuthorizationVersion field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeployment) GetDecisionEndpoint added in v0.5.0 

func (o *APIServerDeployment) GetDecisionEndpoint() APIServerDeploymentDecisionEndpoint

GetDecisionEndpoint returns the DecisionEndpoint field value if set, zero value otherwise.

func (*APIServerDeployment) GetDecisionEndpointOk added in v0.5.0 

func (o *APIServerDeployment) GetDecisionEndpointOk() (*APIServerDeploymentDecisionEndpoint, bool)

GetDecisionEndpointOk returns a tuple with the DecisionEndpoint field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeployment) GetDeployedAt added in v0.5.0 

func (o *APIServerDeployment) GetDeployedAt() time.Time

GetDeployedAt returns the DeployedAt field value if set, zero value otherwise.

func (*APIServerDeployment) GetDeployedAtOk added in v0.5.0 

func (o *APIServerDeployment) GetDeployedAtOk() (*time.Time, bool)

GetDeployedAtOk returns a tuple with the DeployedAt field value if set, nil otherwise and a boolean to check if the value has been set. 

func (o *APIServerDeployment) GetLinks() map[string]LinksHATEOASValue

GetLinks returns the Links field value if set, zero value otherwise.

func (*APIServerDeployment) GetLinksOk added in v0.5.0 

func (o *APIServerDeployment) GetLinksOk() (*map[string]LinksHATEOASValue, bool)

GetLinksOk returns a tuple with the Links field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeployment) GetPolicy added in v0.5.0 

func (o *APIServerDeployment) GetPolicy() APIServerDeploymentPolicy

GetPolicy returns the Policy field value if set, zero value otherwise.

func (*APIServerDeployment) GetPolicyOk added in v0.5.0 

func (o *APIServerDeployment) GetPolicyOk() (*APIServerDeploymentPolicy, bool)

GetPolicyOk returns a tuple with the Policy field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeployment) GetStatus added in v0.5.0 

func (o *APIServerDeployment) GetStatus() APIServerDeploymentStatus

GetStatus returns the Status field value if set, zero value otherwise.

func (*APIServerDeployment) GetStatusOk added in v0.5.0 

func (o *APIServerDeployment) GetStatusOk() (*APIServerDeploymentStatus, bool)

GetStatusOk returns a tuple with the Status field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeployment) HasAccessControl added in v0.5.0 

func (o *APIServerDeployment) HasAccessControl() bool

HasAccessControl returns a boolean if a field has been set.

func (*APIServerDeployment) HasAuthorizationVersion added in v0.5.0 

func (o *APIServerDeployment) HasAuthorizationVersion() bool

HasAuthorizationVersion returns a boolean if a field has been set.

func (*APIServerDeployment) HasDecisionEndpoint added in v0.5.0 

func (o *APIServerDeployment) HasDecisionEndpoint() bool

HasDecisionEndpoint returns a boolean if a field has been set.

func (*APIServerDeployment) HasDeployedAt added in v0.5.0 

func (o *APIServerDeployment) HasDeployedAt() bool

HasDeployedAt returns a boolean if a field has been set. 

func (o *APIServerDeployment) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (*APIServerDeployment) HasPolicy added in v0.5.0 

func (o *APIServerDeployment) HasPolicy() bool

HasPolicy returns a boolean if a field has been set.

func (*APIServerDeployment) HasStatus added in v0.5.0 

func (o *APIServerDeployment) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (APIServerDeployment) MarshalJSON added in v0.5.0 

func (o APIServerDeployment) MarshalJSON() ([]byte, error)

func (*APIServerDeployment) SetAccessControl added in v0.5.0 

func (o *APIServerDeployment) SetAccessControl(v APIServerDeploymentAccessControl)

SetAccessControl gets a reference to the given APIServerDeploymentAccessControl and assigns it to the AccessControl field.

func (*APIServerDeployment) SetAuthorizationVersion added in v0.5.0 

func (o *APIServerDeployment) SetAuthorizationVersion(v APIServerDeploymentAuthorizationVersion)

SetAuthorizationVersion gets a reference to the given APIServerDeploymentAuthorizationVersion and assigns it to the AuthorizationVersion field.

func (*APIServerDeployment) SetDecisionEndpoint added in v0.5.0 

func (o *APIServerDeployment) SetDecisionEndpoint(v APIServerDeploymentDecisionEndpoint)

SetDecisionEndpoint gets a reference to the given APIServerDeploymentDecisionEndpoint and assigns it to the DecisionEndpoint field.

func (*APIServerDeployment) SetDeployedAt added in v0.5.0 

func (o *APIServerDeployment) SetDeployedAt(v time.Time)

SetDeployedAt gets a reference to the given time.Time and assigns it to the DeployedAt field. 

func (o *APIServerDeployment) SetLinks(v map[string]LinksHATEOASValue)

SetLinks gets a reference to the given map[string]LinksHATEOASValue and assigns it to the Links field.

func (*APIServerDeployment) SetPolicy added in v0.5.0 

func (o *APIServerDeployment) SetPolicy(v APIServerDeploymentPolicy)

SetPolicy gets a reference to the given APIServerDeploymentPolicy and assigns it to the Policy field.

func (*APIServerDeployment) SetStatus added in v0.5.0 

func (o *APIServerDeployment) SetStatus(v APIServerDeploymentStatus)

SetStatus gets a reference to the given APIServerDeploymentStatus and assigns it to the Status field.

func (APIServerDeployment) ToMap added in v0.5.0 

func (o APIServerDeployment) ToMap() (map[string]interface{}, error)

type APIServerDeploymentAccessControl added in v0.5.0 

type APIServerDeploymentAccessControl struct {
	Custom *APIServerDeploymentAccessControlCustom `json:"custom,omitempty"`
}

APIServerDeploymentAccessControl struct for APIServerDeploymentAccessControl

func NewAPIServerDeploymentAccessControl added in v0.5.0 

func NewAPIServerDeploymentAccessControl() *APIServerDeploymentAccessControl

NewAPIServerDeploymentAccessControl instantiates a new APIServerDeploymentAccessControl object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerDeploymentAccessControlWithDefaults added in v0.5.0 

func NewAPIServerDeploymentAccessControlWithDefaults() *APIServerDeploymentAccessControl

NewAPIServerDeploymentAccessControlWithDefaults instantiates a new APIServerDeploymentAccessControl object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServerDeploymentAccessControl) GetCustom added in v0.5.0 

func (o *APIServerDeploymentAccessControl) GetCustom() APIServerDeploymentAccessControlCustom

GetCustom returns the Custom field value if set, zero value otherwise.

func (*APIServerDeploymentAccessControl) GetCustomOk added in v0.5.0 

func (o *APIServerDeploymentAccessControl) GetCustomOk() (*APIServerDeploymentAccessControlCustom, bool)

GetCustomOk returns a tuple with the Custom field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeploymentAccessControl) HasCustom added in v0.5.0 

func (o *APIServerDeploymentAccessControl) HasCustom() bool

HasCustom returns a boolean if a field has been set.

func (APIServerDeploymentAccessControl) MarshalJSON added in v0.5.0 

func (o APIServerDeploymentAccessControl) MarshalJSON() ([]byte, error)

func (*APIServerDeploymentAccessControl) SetCustom added in v0.5.0 

func (o *APIServerDeploymentAccessControl) SetCustom(v APIServerDeploymentAccessControlCustom)

SetCustom gets a reference to the given APIServerDeploymentAccessControlCustom and assigns it to the Custom field.

func (APIServerDeploymentAccessControl) ToMap added in v0.5.0 

func (o APIServerDeploymentAccessControl) ToMap() (map[string]interface{}, error)

type APIServerDeploymentAccessControlCustom added in v0.5.0 

type APIServerDeploymentAccessControlCustom struct {
	// If `TRUE`, custom policy will be used for the endpoint. Defaults to `FALSE`.
	Enabled *bool `json:"enabled,omitempty"`
}

APIServerDeploymentAccessControlCustom Defines if the operation will use custom policy rather than the \"Group\" or \"Scope\" `accessControl` requirement.

func NewAPIServerDeploymentAccessControlCustom added in v0.5.0 

func NewAPIServerDeploymentAccessControlCustom() *APIServerDeploymentAccessControlCustom

NewAPIServerDeploymentAccessControlCustom instantiates a new APIServerDeploymentAccessControlCustom object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerDeploymentAccessControlCustomWithDefaults added in v0.5.0 

func NewAPIServerDeploymentAccessControlCustomWithDefaults() *APIServerDeploymentAccessControlCustom

NewAPIServerDeploymentAccessControlCustomWithDefaults instantiates a new APIServerDeploymentAccessControlCustom object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServerDeploymentAccessControlCustom) GetEnabled added in v0.5.0 

func (o *APIServerDeploymentAccessControlCustom) GetEnabled() bool

GetEnabled returns the Enabled field value if set, zero value otherwise.

func (*APIServerDeploymentAccessControlCustom) GetEnabledOk added in v0.5.0 

func (o *APIServerDeploymentAccessControlCustom) GetEnabledOk() (*bool, bool)

GetEnabledOk returns a tuple with the Enabled field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeploymentAccessControlCustom) HasEnabled added in v0.5.0 

func (o *APIServerDeploymentAccessControlCustom) HasEnabled() bool

HasEnabled returns a boolean if a field has been set.

func (APIServerDeploymentAccessControlCustom) MarshalJSON added in v0.5.0 

func (o APIServerDeploymentAccessControlCustom) MarshalJSON() ([]byte, error)

func (*APIServerDeploymentAccessControlCustom) SetEnabled added in v0.5.0 

func (o *APIServerDeploymentAccessControlCustom) SetEnabled(v bool)

SetEnabled gets a reference to the given bool and assigns it to the Enabled field.

func (APIServerDeploymentAccessControlCustom) ToMap added in v0.5.0 

func (o APIServerDeploymentAccessControlCustom) ToMap() (map[string]interface{}, error)

type APIServerDeploymentApiService added in v0.5.0 

type APIServerDeploymentApiService service

APIServerDeploymentApiService APIServerDeploymentApi service

func (*APIServerDeploymentApiService) DeployAPIServer added in v0.5.0 

func (a *APIServerDeploymentApiService) DeployAPIServer(ctx context.Context, environmentID string, apiServerID string) ApiDeployAPIServerRequest

DeployAPIServer Deploy API Server 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param environmentID
@param apiServerID
@return ApiDeployAPIServerRequest

func (*APIServerDeploymentApiService) DeployAPIServerExecute added in v0.5.0 

func (a *APIServerDeploymentApiService) DeployAPIServerExecute(r ApiDeployAPIServerRequest) (*APIServerDeployment, *http.Response, error)

Execute executes the request 

@return APIServerDeployment

func (*APIServerDeploymentApiService) ReadDeploymentStatus added in v0.5.0 

func (a *APIServerDeploymentApiService) ReadDeploymentStatus(ctx context.Context, environmentID string, apiServerID string) ApiReadDeploymentStatusRequest

ReadDeploymentStatus READ API Server Deployment Status 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param environmentID
@param apiServerID
@return ApiReadDeploymentStatusRequest

func (*APIServerDeploymentApiService) ReadDeploymentStatusExecute added in v0.5.0 

func (a *APIServerDeploymentApiService) ReadDeploymentStatusExecute(r ApiReadDeploymentStatusRequest) (*APIServerDeployment, *http.Response, error)

Execute executes the request 

@return APIServerDeployment

type APIServerDeploymentAuthorizationVersion added in v0.5.0 

type APIServerDeploymentAuthorizationVersion struct {
	// The UUID of the last deployed policy authorization version. This is present only if custom polcies are enabled and the API service has been deployed at least once.
	Id *string `json:"id,omitempty"`
}

APIServerDeploymentAuthorizationVersion struct for APIServerDeploymentAuthorizationVersion

func NewAPIServerDeploymentAuthorizationVersion added in v0.5.0 

func NewAPIServerDeploymentAuthorizationVersion() *APIServerDeploymentAuthorizationVersion

NewAPIServerDeploymentAuthorizationVersion instantiates a new APIServerDeploymentAuthorizationVersion object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerDeploymentAuthorizationVersionWithDefaults added in v0.5.0 

func NewAPIServerDeploymentAuthorizationVersionWithDefaults() *APIServerDeploymentAuthorizationVersion

NewAPIServerDeploymentAuthorizationVersionWithDefaults instantiates a new APIServerDeploymentAuthorizationVersion object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServerDeploymentAuthorizationVersion) GetId added in v0.5.0 

func (o *APIServerDeploymentAuthorizationVersion) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*APIServerDeploymentAuthorizationVersion) GetIdOk added in v0.5.0 

func (o *APIServerDeploymentAuthorizationVersion) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeploymentAuthorizationVersion) HasId added in v0.5.0 

func (o *APIServerDeploymentAuthorizationVersion) HasId() bool

HasId returns a boolean if a field has been set.

func (APIServerDeploymentAuthorizationVersion) MarshalJSON added in v0.5.0 

func (o APIServerDeploymentAuthorizationVersion) MarshalJSON() ([]byte, error)

func (*APIServerDeploymentAuthorizationVersion) SetId added in v0.5.0 

func (o *APIServerDeploymentAuthorizationVersion) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (APIServerDeploymentAuthorizationVersion) ToMap added in v0.5.0 

func (o APIServerDeploymentAuthorizationVersion) ToMap() (map[string]interface{}, error)

type APIServerDeploymentDecisionEndpoint added in v0.5.0 

type APIServerDeploymentDecisionEndpoint struct {
	// The UUID of the decision endpoint.
	Id *string `json:"id,omitempty"`
}

APIServerDeploymentDecisionEndpoint struct for APIServerDeploymentDecisionEndpoint

func NewAPIServerDeploymentDecisionEndpoint added in v0.5.0 

func NewAPIServerDeploymentDecisionEndpoint() *APIServerDeploymentDecisionEndpoint

NewAPIServerDeploymentDecisionEndpoint instantiates a new APIServerDeploymentDecisionEndpoint object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerDeploymentDecisionEndpointWithDefaults added in v0.5.0 

func NewAPIServerDeploymentDecisionEndpointWithDefaults() *APIServerDeploymentDecisionEndpoint

NewAPIServerDeploymentDecisionEndpointWithDefaults instantiates a new APIServerDeploymentDecisionEndpoint object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServerDeploymentDecisionEndpoint) GetId added in v0.5.0 

func (o *APIServerDeploymentDecisionEndpoint) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*APIServerDeploymentDecisionEndpoint) GetIdOk added in v0.5.0 

func (o *APIServerDeploymentDecisionEndpoint) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeploymentDecisionEndpoint) HasId added in v0.5.0 

func (o *APIServerDeploymentDecisionEndpoint) HasId() bool

HasId returns a boolean if a field has been set.

func (APIServerDeploymentDecisionEndpoint) MarshalJSON added in v0.5.0 

func (o APIServerDeploymentDecisionEndpoint) MarshalJSON() ([]byte, error)

func (*APIServerDeploymentDecisionEndpoint) SetId added in v0.5.0 

func (o *APIServerDeploymentDecisionEndpoint) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (APIServerDeploymentDecisionEndpoint) ToMap added in v0.5.0 

func (o APIServerDeploymentDecisionEndpoint) ToMap() (map[string]interface{}, error)

type APIServerDeploymentPolicy added in v0.5.0 

type APIServerDeploymentPolicy struct {
	// The ID of the root policy.
	Id *string `json:"id,omitempty"`
}

APIServerDeploymentPolicy struct for APIServerDeploymentPolicy

func NewAPIServerDeploymentPolicy added in v0.5.0 

func NewAPIServerDeploymentPolicy() *APIServerDeploymentPolicy

NewAPIServerDeploymentPolicy instantiates a new APIServerDeploymentPolicy object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerDeploymentPolicyWithDefaults added in v0.5.0 

func NewAPIServerDeploymentPolicyWithDefaults() *APIServerDeploymentPolicy

NewAPIServerDeploymentPolicyWithDefaults instantiates a new APIServerDeploymentPolicy object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServerDeploymentPolicy) GetId added in v0.5.0 

func (o *APIServerDeploymentPolicy) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*APIServerDeploymentPolicy) GetIdOk added in v0.5.0 

func (o *APIServerDeploymentPolicy) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeploymentPolicy) HasId added in v0.5.0 

func (o *APIServerDeploymentPolicy) HasId() bool

HasId returns a boolean if a field has been set.

func (APIServerDeploymentPolicy) MarshalJSON added in v0.5.0 

func (o APIServerDeploymentPolicy) MarshalJSON() ([]byte, error)

func (*APIServerDeploymentPolicy) SetId added in v0.5.0 

func (o *APIServerDeploymentPolicy) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (APIServerDeploymentPolicy) ToMap added in v0.5.0 

func (o APIServerDeploymentPolicy) ToMap() (map[string]interface{}, error)

type APIServerDeploymentStatus added in v0.5.0 

type APIServerDeploymentStatus struct {
	// The deployment status code. - `POLICIES_CREATE_IN_PROGRESS` The policy bundle for the API service's managed policies is being created. - `DECISION_ENDPOINT_CREATE_IN_PROGRESS` A decision endpoint is being created for the API service. - `DECISION_ENDPOINT_UPDATE_IN_PROGRESS` The API service's decision endpoint is being updated. - `DEPLOYMENT_SUCCESSFUL` The API service's policies have been successfully deployed. - `DEPLOYMENT_FAILED` HAP-MGMT was unable to deploy the API service's policies. - `DEPLOYMENT_UNINITIALIZED` A deployment has not yet been attempted.
	Code  *string                         `json:"code,omitempty"`
	Error *APIServerDeploymentStatusError `json:"error,omitempty"`
}

APIServerDeploymentStatus struct for APIServerDeploymentStatus

func NewAPIServerDeploymentStatus added in v0.5.0 

func NewAPIServerDeploymentStatus() *APIServerDeploymentStatus

NewAPIServerDeploymentStatus instantiates a new APIServerDeploymentStatus object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerDeploymentStatusWithDefaults added in v0.5.0 

func NewAPIServerDeploymentStatusWithDefaults() *APIServerDeploymentStatus

NewAPIServerDeploymentStatusWithDefaults instantiates a new APIServerDeploymentStatus object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServerDeploymentStatus) GetCode added in v0.5.0 

func (o *APIServerDeploymentStatus) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*APIServerDeploymentStatus) GetCodeOk added in v0.5.0 

func (o *APIServerDeploymentStatus) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeploymentStatus) GetError added in v0.5.0 

func (o *APIServerDeploymentStatus) GetError() APIServerDeploymentStatusError

GetError returns the Error field value if set, zero value otherwise.

func (*APIServerDeploymentStatus) GetErrorOk added in v0.5.0 

func (o *APIServerDeploymentStatus) GetErrorOk() (*APIServerDeploymentStatusError, bool)

GetErrorOk returns a tuple with the Error field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeploymentStatus) HasCode added in v0.5.0 

func (o *APIServerDeploymentStatus) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*APIServerDeploymentStatus) HasError added in v0.5.0 

func (o *APIServerDeploymentStatus) HasError() bool

HasError returns a boolean if a field has been set.

func (APIServerDeploymentStatus) MarshalJSON added in v0.5.0 

func (o APIServerDeploymentStatus) MarshalJSON() ([]byte, error)

func (*APIServerDeploymentStatus) SetCode added in v0.5.0 

func (o *APIServerDeploymentStatus) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*APIServerDeploymentStatus) SetError added in v0.5.0 

func (o *APIServerDeploymentStatus) SetError(v APIServerDeploymentStatusError)

SetError gets a reference to the given APIServerDeploymentStatusError and assigns it to the Error field.

func (APIServerDeploymentStatus) ToMap added in v0.5.0 

func (o APIServerDeploymentStatus) ToMap() (map[string]interface{}, error)

type APIServerDeploymentStatusError added in v0.5.0 

type APIServerDeploymentStatusError struct {
	// A unique identifier for the error.
	Id *string `json:"id,omitempty"`
	// A general fault code that identifies the the type of error. See [Error codes](https://apidocs.pingidentity.com/pingone/platform/v1/api/#error-codes).
	Code *string `json:"code,omitempty"`
	// A short human-readable description of the error.
	Message *string `json:"message,omitempty"`
}

APIServerDeploymentStatusError Error details returned if the last deployment request failed.

func NewAPIServerDeploymentStatusError added in v0.5.0 

func NewAPIServerDeploymentStatusError() *APIServerDeploymentStatusError

NewAPIServerDeploymentStatusError instantiates a new APIServerDeploymentStatusError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerDeploymentStatusErrorWithDefaults added in v0.5.0 

func NewAPIServerDeploymentStatusErrorWithDefaults() *APIServerDeploymentStatusError

NewAPIServerDeploymentStatusErrorWithDefaults instantiates a new APIServerDeploymentStatusError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServerDeploymentStatusError) GetCode added in v0.5.0 

func (o *APIServerDeploymentStatusError) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*APIServerDeploymentStatusError) GetCodeOk added in v0.5.0 

func (o *APIServerDeploymentStatusError) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeploymentStatusError) GetId added in v0.5.0 

func (o *APIServerDeploymentStatusError) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*APIServerDeploymentStatusError) GetIdOk added in v0.5.0 

func (o *APIServerDeploymentStatusError) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeploymentStatusError) GetMessage added in v0.5.0 

func (o *APIServerDeploymentStatusError) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*APIServerDeploymentStatusError) GetMessageOk added in v0.5.0 

func (o *APIServerDeploymentStatusError) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerDeploymentStatusError) HasCode added in v0.5.0 

func (o *APIServerDeploymentStatusError) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*APIServerDeploymentStatusError) HasId added in v0.5.0 

func (o *APIServerDeploymentStatusError) HasId() bool

HasId returns a boolean if a field has been set.

func (*APIServerDeploymentStatusError) HasMessage added in v0.5.0 

func (o *APIServerDeploymentStatusError) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (APIServerDeploymentStatusError) MarshalJSON added in v0.5.0 

func (o APIServerDeploymentStatusError) MarshalJSON() ([]byte, error)

func (*APIServerDeploymentStatusError) SetCode added in v0.5.0 

func (o *APIServerDeploymentStatusError) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*APIServerDeploymentStatusError) SetId added in v0.5.0 

func (o *APIServerDeploymentStatusError) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*APIServerDeploymentStatusError) SetMessage added in v0.5.0 

func (o *APIServerDeploymentStatusError) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

func (APIServerDeploymentStatusError) ToMap added in v0.5.0 

func (o APIServerDeploymentStatusError) ToMap() (map[string]interface{}, error)

type APIServerDirectory added in v0.5.0 

type APIServerDirectory struct {
	Type EnumAPIServerAuthorizationServerType `json:"type"`
}

APIServerDirectory A container object for fields related to the user directory used to issue access tokens for accessing the APIs. If not provided, the `directory.type` will default to `PINGONE_SSO`.

func NewAPIServerDirectory added in v0.5.0 

func NewAPIServerDirectory(type_ EnumAPIServerAuthorizationServerType) *APIServerDirectory

NewAPIServerDirectory instantiates a new APIServerDirectory object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerDirectoryWithDefaults added in v0.5.0 

func NewAPIServerDirectoryWithDefaults() *APIServerDirectory

NewAPIServerDirectoryWithDefaults instantiates a new APIServerDirectory object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServerDirectory) GetType added in v0.5.0 

func (o *APIServerDirectory) GetType() EnumAPIServerAuthorizationServerType

GetType returns the Type field value

func (*APIServerDirectory) GetTypeOk added in v0.5.0 

func (o *APIServerDirectory) GetTypeOk() (*EnumAPIServerAuthorizationServerType, bool)

GetTypeOk returns a tuple with the Type field value and a boolean to check if the value has been set.

func (APIServerDirectory) MarshalJSON added in v0.5.0 

func (o APIServerDirectory) MarshalJSON() ([]byte, error)

func (*APIServerDirectory) SetType added in v0.5.0 

func (o *APIServerDirectory) SetType(v EnumAPIServerAuthorizationServerType)

SetType sets field value

func (APIServerDirectory) ToMap added in v0.5.0 

func (o APIServerDirectory) ToMap() (map[string]interface{}, error)

type APIServerOperation added in v0.5.0 

type APIServerOperation struct {
	Links *map[string]LinksHATEOASValue `json:"_links,omitempty"`
	// The ID of the API service operation. This is randomly generated when the operation is created.
	Id *string `json:"id,omitempty"`
	// The name of the API service operation.
	Name          string                           `json:"name"`
	AccessControl *APIServerOperationAccessControl `json:"accessControl,omitempty"`
	// The methods that define the operation. No duplicates are allowed. Each element must be a valid HTTP token, according to [RFC 7230](https://datatracker.ietf.org/doc/html/rfc7230), and cannot exceed 64 characters. An empty array is not valid. To indicate that an operation is defined for every method, the `methods` array should be set to null. The `methods` array is limited to 10 entries.
	Methods []EnumAPIServerOperationMethod `json:"methods,omitempty"`
	// The paths that define the operation. The same literal pattern is not allowed within the same operation (the pattern of a `paths` element must be unique as compared to all other patterns in the same `paths` array). However, the same literal pattern is allowed in different operations (for example, OperationA, `/path1`, OperationB, `/path1` is valid). The `paths` array is limited to 10 entries.
	Paths  []APIServerOperationPathsInner `json:"paths"`
	Policy *APIServerPolicy               `json:"policy,omitempty"`
}

APIServerOperation struct for APIServerOperation

func NewAPIServerOperation added in v0.5.0 

func NewAPIServerOperation(name string, paths []APIServerOperationPathsInner) *APIServerOperation

NewAPIServerOperation instantiates a new APIServerOperation object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerOperationWithDefaults added in v0.5.0 

func NewAPIServerOperationWithDefaults() *APIServerOperation

NewAPIServerOperationWithDefaults instantiates a new APIServerOperation object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServerOperation) GetAccessControl added in v0.5.0 

func (o *APIServerOperation) GetAccessControl() APIServerOperationAccessControl

GetAccessControl returns the AccessControl field value if set, zero value otherwise.

func (*APIServerOperation) GetAccessControlOk added in v0.5.0 

func (o *APIServerOperation) GetAccessControlOk() (*APIServerOperationAccessControl, bool)

GetAccessControlOk returns a tuple with the AccessControl field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerOperation) GetId added in v0.5.0 

func (o *APIServerOperation) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*APIServerOperation) GetIdOk added in v0.5.0 

func (o *APIServerOperation) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set. 

func (o *APIServerOperation) GetLinks() map[string]LinksHATEOASValue

GetLinks returns the Links field value if set, zero value otherwise.

func (*APIServerOperation) GetLinksOk added in v0.5.0 

func (o *APIServerOperation) GetLinksOk() (*map[string]LinksHATEOASValue, bool)

GetLinksOk returns a tuple with the Links field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerOperation) GetMethods added in v0.5.0 

func (o *APIServerOperation) GetMethods() []EnumAPIServerOperationMethod

GetMethods returns the Methods field value if set, zero value otherwise.

func (*APIServerOperation) GetMethodsOk added in v0.5.0 

func (o *APIServerOperation) GetMethodsOk() ([]EnumAPIServerOperationMethod, bool)

GetMethodsOk returns a tuple with the Methods field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerOperation) GetName added in v0.5.0 

func (o *APIServerOperation) GetName() string

GetName returns the Name field value

func (*APIServerOperation) GetNameOk added in v0.5.0 

func (o *APIServerOperation) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*APIServerOperation) GetPaths added in v0.5.0 

func (o *APIServerOperation) GetPaths() []APIServerOperationPathsInner

GetPaths returns the Paths field value

func (*APIServerOperation) GetPathsOk added in v0.5.0 

func (o *APIServerOperation) GetPathsOk() ([]APIServerOperationPathsInner, bool)

GetPathsOk returns a tuple with the Paths field value and a boolean to check if the value has been set.

func (*APIServerOperation) GetPolicy added in v0.5.0 

func (o *APIServerOperation) GetPolicy() APIServerPolicy

GetPolicy returns the Policy field value if set, zero value otherwise.

func (*APIServerOperation) GetPolicyOk added in v0.5.0 

func (o *APIServerOperation) GetPolicyOk() (*APIServerPolicy, bool)

GetPolicyOk returns a tuple with the Policy field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerOperation) HasAccessControl added in v0.5.0 

func (o *APIServerOperation) HasAccessControl() bool

HasAccessControl returns a boolean if a field has been set.

func (*APIServerOperation) HasId added in v0.5.0 

func (o *APIServerOperation) HasId() bool

HasId returns a boolean if a field has been set. 

func (o *APIServerOperation) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (*APIServerOperation) HasMethods added in v0.5.0 

func (o *APIServerOperation) HasMethods() bool

HasMethods returns a boolean if a field has been set.

func (*APIServerOperation) HasPolicy added in v0.5.0 

func (o *APIServerOperation) HasPolicy() bool

HasPolicy returns a boolean if a field has been set.

func (APIServerOperation) MarshalJSON added in v0.5.0 

func (o APIServerOperation) MarshalJSON() ([]byte, error)

func (*APIServerOperation) SetAccessControl added in v0.5.0 

func (o *APIServerOperation) SetAccessControl(v APIServerOperationAccessControl)

SetAccessControl gets a reference to the given APIServerOperationAccessControl and assigns it to the AccessControl field.

func (*APIServerOperation) SetId added in v0.5.0 

func (o *APIServerOperation) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field. 

func (o *APIServerOperation) SetLinks(v map[string]LinksHATEOASValue)

SetLinks gets a reference to the given map[string]LinksHATEOASValue and assigns it to the Links field.

func (*APIServerOperation) SetMethods added in v0.5.0 

func (o *APIServerOperation) SetMethods(v []EnumAPIServerOperationMethod)

SetMethods gets a reference to the given []EnumAPIServerOperationMethod and assigns it to the Methods field.

func (*APIServerOperation) SetName added in v0.5.0 

func (o *APIServerOperation) SetName(v string)

SetName sets field value

func (*APIServerOperation) SetPaths added in v0.5.0 

func (o *APIServerOperation) SetPaths(v []APIServerOperationPathsInner)

SetPaths sets field value

func (*APIServerOperation) SetPolicy added in v0.5.0 

func (o *APIServerOperation) SetPolicy(v APIServerPolicy)

SetPolicy gets a reference to the given APIServerPolicy and assigns it to the Policy field.

func (APIServerOperation) ToMap added in v0.5.0 

func (o APIServerOperation) ToMap() (map[string]interface{}, error)

type APIServerOperationAccessControl added in v0.5.0 

type APIServerOperationAccessControl struct {
	Group      *APIServerOperationAccessControlGroup      `json:"group,omitempty"`
	Permission *APIServerOperationAccessControlPermission `json:"permission,omitempty"`
	Scope      *APIServerOperationAccessControlScope      `json:"scope,omitempty"`
}

APIServerOperationAccessControl The access control configuration for the operation.

func NewAPIServerOperationAccessControl added in v0.5.0 

func NewAPIServerOperationAccessControl() *APIServerOperationAccessControl

NewAPIServerOperationAccessControl instantiates a new APIServerOperationAccessControl object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAPIServerOperationAccessControlWithDefaults added in v0.5.0 

func NewAPIServerOperationAccessControlWithDefaults() *APIServerOperationAccessControl

NewAPIServerOperationAccessControlWithDefaults instantiates a new APIServerOperationAccessControl object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*APIServerOperationAccessControl) GetGroup added in v0.5.0 

func (o *APIServerOperationAccessControl) GetGroup() APIServerOperationAccessControlGroup

GetGroup returns the Group field value if set, zero value otherwise.

func (*APIServerOperationAccessControl) GetGroupOk added in v0.5.0 

func (o *APIServerOperationAccessControl) GetGroupOk() (*APIServerOperationAccessControlGroup, bool)

GetGroupOk returns a tuple with the Group field value if set, nil otherwise and a boolean to check if the value has been set.

func (*APIServerOperationAccessControl) GetPermission added in v0.5.0 

func (o *APIServerOperationAccessControl) GetPermission()