Categorygithub.com/atricore/josso-api-go
repositorypackage
0.5.2
Repository: https://github.com/atricore/josso-api-go.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# README

Go API client for jossoappi

Atricore Console API

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: 1.5.1-SNAPSHOT
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.atricore.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

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

import jossoappi "github.com/atricore/josso-api-go"

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

Documentation for API Endpoints

All URIs are relative to http://localhost:8081/atricore-res/services

ClassMethodHTTP requestDescription
DefaultApiActivateExecEnvGet /iam-deploy/execenv/activate
DefaultApiBuildApplianceGet /iam-deploy/appliance/build
DefaultApiCreateAppliancePost /iam-deploy/appliance
DefaultApiCreateBrandingPost /iam-branding/branding
DefaultApiCreateDbIdVaultPost /iam-deploy/dbidvault
DefaultApiCreateExtSaml2SpPost /iam-deploy/extsaml2sp
DefaultApiCreateIdPPost /iam-deploy/idp
DefaultApiCreateIdSourceDbPost /iam-deploy/idsourcedb
DefaultApiCreateIdSourceLdapPost /iam-deploy/idsourceldap
DefaultApiCreateIdVaultPost /iam-deploy/idvault
DefaultApiCreateIdpAzurePost /iam-deploy/idp_azure
DefaultApiCreateIdpFacebookPost /iam-deploy/idp_fb
DefaultApiCreateIdpGooglePost /iam-deploy/idp_google
DefaultApiCreateIdpSaml2Post /iam-deploy/idp_saml2
DefaultApiCreateIisExecEnvPost /iam-deploy/iisexecenv
DefaultApiCreateIntSaml2SpPost /iam-deploy/intsaml2sp
DefaultApiCreateJossoRsPost /iam-deploy/jossors
DefaultApiCreateOidcRpPost /iam-deploy/oidcrp
DefaultApiCreatePhpExecEnvPost /iam-deploy/phpexecenv
DefaultApiCreateSelfSvcsPost /iam-deploy/selfsvc
DefaultApiCreateSharepointRsPost /iam-deploy/sharepointrs
DefaultApiCreateTomcatExecEnvPost /iam-deploy/tomcatexecenv
DefaultApiCreateVirtSaml2SpPost /iam-deploy/virtsaml2sp
DefaultApiCreateWeblogicExecEnvPost /iam-deploy/weblogicexecenv
DefaultApiDeleteApplianceDelete /iam-deploy/appliance
DefaultApiDeleteBrandingDelete /iam-branding/branding
DefaultApiDeleteDbIdVaultDelete /iam-deploy/dbidvault
DefaultApiDeleteExtSaml2SpDelete /iam-deploy/extsaml2sp
DefaultApiDeleteIdPDelete /iam-deploy/idp
DefaultApiDeleteIdSourceDbDelete /iam-deploy/idsourcedb
DefaultApiDeleteIdSourceLdapDelete /iam-deploy/idsourceldap
DefaultApiDeleteIdVaultDelete /iam-deploy/idvault
DefaultApiDeleteIdpAzureDelete /iam-deploy/idp_azure
DefaultApiDeleteIdpFacebookDelete /iam-deploy/idp_fb
DefaultApiDeleteIdpGoogleDelete /iam-deploy/idp_google
DefaultApiDeleteIdpSaml2Delete /iam-deploy/idp_saml2
DefaultApiDeleteIisExecEnvDelete /iam-deploy/iisexecenv
DefaultApiDeleteIntSaml2SpDelete /iam-deploy/intsaml2sp
DefaultApiDeleteJossoRsDelete /iam-deploy/jossors
DefaultApiDeleteOidcRpDelete /iam-deploy/oidcrp
DefaultApiDeletePhpExecEnvDelete /iam-deploy/phpexecenv
DefaultApiDeleteSelfSvcsDelete /iam-deploy/selfsvc
DefaultApiDeleteSharepointRsDelete /iam-deploy/sharepointrs
DefaultApiDeleteTomcatExecEnvDelete /iam-deploy/tomcatexecenv
DefaultApiDeleteVirtSaml2SpDelete /iam-deploy/virtsaml2sp
DefaultApiDeleteWeblogicExecEnvDelete /iam-deploy/weblogicexecenv
DefaultApiExportApplianceGet /iam-deploy/appliance/export
DefaultApiExportExecEnvCfgGet /iam-deploy/execenv/cfg
DefaultApiGetAllBrandingsGet /iam-branding/brandings
DefaultApiGetApplianceGet /iam-deploy/appliance
DefaultApiGetApplianceContainerGet /iam-deploy/appliance-container
DefaultApiGetApplianceContainersGet /iam-deploy/appliance-containers
DefaultApiGetApplianceStateGet /iam-deploy/appliance/state
DefaultApiGetAppliancesGet /iam-deploy/appliances
DefaultApiGetBrandingGet /iam-branding/branding
DefaultApiGetBundlesGet /iam-deploy/server/bundles
DefaultApiGetDbIdVaultGet /iam-deploy/dbidvault
DefaultApiGetDbIdVaultsGet /iam-deploy/dbidvaults
DefaultApiGetExecEnvGet /iam-deploy/execenv
DefaultApiGetExecEnvsGet /iam-deploy/execenvs
DefaultApiGetExtSaml2SpGet /iam-deploy/extsaml2sp
DefaultApiGetExtSaml2SpsGet /iam-deploy/extsaml2sps
DefaultApiGetIdPGet /iam-deploy/idp
DefaultApiGetIdPsGet /iam-deploy/idps
DefaultApiGetIdSourceGet /iam-deploy/idsource
DefaultApiGetIdSourceDbGet /iam-deploy/idsourcedb
DefaultApiGetIdSourceDbsGet /iam-deploy/idsourcedbs
DefaultApiGetIdSourceLdapGet /iam-deploy/idsourceldap
DefaultApiGetIdSourceLdapsGet /iam-deploy/idsourceldaps
DefaultApiGetIdSourcesGet /iam-deploy/idsources
DefaultApiGetIdVaultGet /iam-deploy/idvault
DefaultApiGetIdVaultsGet /iam-deploy/idvaults
DefaultApiGetIdpAzureGet /iam-deploy/idp_azure
DefaultApiGetIdpAzuresGet /iam-deploy/idp_azures
DefaultApiGetIdpFacebookGet /iam-deploy/idp_fb
DefaultApiGetIdpFacebooksGet /iam-deploy/idp_fbs
DefaultApiGetIdpGoogleGet /iam-deploy/idp_google
DefaultApiGetIdpGooglesGet /iam-deploy/idp_googles
DefaultApiGetIdpSaml2Get /iam-deploy/idp_saml2
DefaultApiGetIdpSaml2sGet /iam-deploy/idp_saml2s
DefaultApiGetIisExecEnvGet /iam-deploy/iisexecenv
DefaultApiGetIisExecEnvsGet /iam-deploy/iisexecenvs
DefaultApiGetInfoGet /iam-deploy/server/info
DefaultApiGetIntSaml2SpGet /iam-deploy/intsaml2sp
DefaultApiGetIntSaml2SpsGet /iam-deploy/intsaml2sps
DefaultApiGetJossoRsGet /iam-deploy/jossors
DefaultApiGetJossoRssGet /iam-deploy/jossorss
DefaultApiGetOidcRpGet /iam-deploy/oidcrp
DefaultApiGetOidcRpsGet /iam-deploy/oidcrps
DefaultApiGetPhpExecEnvGet /iam-deploy/phpexecenv
DefaultApiGetPhpExecEnvsGet /iam-deploy/phpexecenvs
DefaultApiGetProviderGet /iam-deploy/provider
DefaultApiGetProvidersGet /iam-deploy/providers
DefaultApiGetSelfSvcsGet /iam-deploy/selfsvc
DefaultApiGetSelfSvcssGet /iam-deploy/selfsvcs
DefaultApiGetSharepointRsGet /iam-deploy/sharepointrs
DefaultApiGetSharepointRssGet /iam-deploy/sharepointrss
DefaultApiGetTomcatExecEnvGet /iam-deploy/tomcatexecenv
DefaultApiGetTomcatExecEnvsGet /iam-deploy/tomcatexecenvs
DefaultApiGetTypesGet /iam-deploy/noop/types
DefaultApiGetVirtSaml2SpGet /iam-deploy/virtsaml2sp
DefaultApiGetVirtSaml2SpsGet /iam-deploy/virtsaml2sps
DefaultApiGetWeblogicExecEnvGet /iam-deploy/weblogicexecenv
DefaultApiGetWeblogicExecEnvsGet /iam-deploy/weblogicexecenvs
DefaultApiImportAppliancePost /iam-deploy/appliance/import
DefaultApiLayoutApplianceGet /iam-deploy/appliance/layout
DefaultApiRefreshBrandingsGet /iam-branding/brandings/refresh
DefaultApiSignOnPost /iam-authn/sign-on
DefaultApiStartApplianceGet /iam-deploy/appliance/start
DefaultApiStopApplianceGet /iam-deploy/appliance/stop
DefaultApiUpdateAppliancePut /iam-deploy/appliance
DefaultApiUpdateBrandingPut /iam-branding/branding
DefaultApiUpdateDbIdVaultPut /iam-deploy/dbidvault
DefaultApiUpdateExtSaml2SpPut /iam-deploy/extsaml2sp
DefaultApiUpdateIdPPut /iam-deploy/idp
DefaultApiUpdateIdSourceDbPut /iam-deploy/idsourcedb
DefaultApiUpdateIdSourceLdapPut /iam-deploy/idsourceldap
DefaultApiUpdateIdVaultPut /iam-deploy/idvault
DefaultApiUpdateIdpAzurePut /iam-deploy/idp_azure
DefaultApiUpdateIdpFacebookPut /iam-deploy/idp_fb
DefaultApiUpdateIdpGooglePut /iam-deploy/idp_google
DefaultApiUpdateIdpSaml2Put /iam-deploy/idp_saml2
DefaultApiUpdateIisExecEnvPut /iam-deploy/iisexecenv
DefaultApiUpdateIntSaml2SpPut /iam-deploy/intsaml2sp
DefaultApiUpdateJossoRsPut /iam-deploy/jossors
DefaultApiUpdateOidcRpPut /iam-deploy/oidcrp
DefaultApiUpdatePhpExecEnvPut /iam-deploy/phpexecenv
DefaultApiUpdateSelfSvcsPut /iam-deploy/selfsvc
DefaultApiUpdateSharepointRsPut /iam-deploy/sharepointrs
DefaultApiUpdateTomcatExecEnvPut /iam-deploy/tomcatexecenv
DefaultApiUpdateVirtSaml2SpPut /iam-deploy/virtsaml2sp
DefaultApiUpdateWeblogicExecEnvPut /iam-deploy/weblogicexecenv
DefaultApiValidateApplianceGet /iam-deploy/appliance/validate
DefaultApiVersionGet /iam-authn/version

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

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

[email protected]