Go API client for openapi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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: v0
Package version: 1.0.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/oauth2
go get golang.org/x/net/context

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

import openapi "github.com/authlete/idp-api"

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

Documentation for API Endpoints

All URIs are relative to https://devidp.authlete.net

Class	Method	HTTP request
AccessApiApi	AcceptInvitation	Post /api/access/invite/{id}
AccessApiApi	DeclineInvitation	Delete /api/access/invite/{id}
AccessApiApi	GetInvitation	Get /api/access/invite/{id}
AccessApiApi	GetReceivedInvitations	Get /api/access/invite/received
AccessApiApi	GetSentInvitations	Get /api/access/invite/sent
AccessApiApi	InviteByEmail	Post /api/access/invite
AccessApiApi	RemoveApiServerPrivileges	Post /api/access/apiserver/remove
AccessApiApi	RemoveClientPrivileges	Post /api/access/client/remove
AccessApiApi	RemoveOrganizationPrivileges	Post /api/access/organization/remove
AccessApiApi	RemoveServicePrivileges	Post /api/access/service/remove
AccessApiApi	UpdateApiServerPrivileges	Post /api/access/apiserver
AccessApiApi	UpdateClientPrivileges	Post /api/access/client
AccessApiApi	UpdateOrganizationPrivileges	Post /api/access/organization
AccessApiApi	UpdateServicePrivileges	Post /api/access/service
AccessMapApiApi	GetAccessMap	Get /api/accessmap
ApiServerApiApi	CreateApiServer	Post /api/apiserver
ApiServerApiApi	DeleteApiServer	Delete /api/apiserver/{id}
ApiServerApiApi	GetAll1	Get /api/apiserver
ApiServerApiApi	GetApiServer	Get /api/apiserver/{id}
ApiServerApiApi	UpdateApiServer	Post /api/apiserver/{id}
AuthorizationEndpointApi	Get	Get /authorize
AuthorizeApiApi	GetCurrentAuthorizationResponse	Get /api/authorize
AuthorizeApiApi	SubmitUserDecision	Post /api/authorize
DiscoveryEndpointApi	GetConfiguration	Get /.well-known/openid-configuration
IntrospectionEndpointApi	Introspect	Post /introspect
JsonWebKeySetEndpointApi	GetJsonWebKeySet	Get /jwks
OrganizationApiApi	CreateOrganization	Post /api/organization
OrganizationApiApi	DeleteOrganization	Delete /api/organization/{id}
OrganizationApiApi	GetAll	Get /api/organization
OrganizationApiApi	GetOrganization	Get /api/organization/{id}
OrganizationApiApi	UpdateOrganization	Post /api/organization/{id}
OrganizationTokenApiApi	CreateTokenForOrganization	Post /api/organizationtoken/create
OrganizationTokenApiApi	DeleteOrganizationToken	Post /api/organizationtoken/revoke
OrganizationTokenApiApi	GetTokensForService1	Post /api/organizationtoken/all
OrganizationTokenApiApi	RenameTokenForService	Post /api/organizationtoken/update
OrganizationTokenApiApi	RotateTokenForOrganization	Post /api/organizationtoken/rotate
ServiceApiApi	AdoptService	Post /api/service/adopt
ServiceApiApi	CreateService	Post /api/service
ServiceApiApi	DeleteService	Post /api/service/remove
ServiceApiApi	FindService	Get /api/service/find/{id}
ServiceApiApi	GetOrphans	Get /api/service/orphans
ServiceApiApi	MoveService	Post /api/service/move
ServiceApiApi	RemoveOrphanService	Post /api/service/orphans/remove
ServiceTokenApiApi	CreateTokenForService	Post /api/servicetoken/create
ServiceTokenApiApi	GetTokensForService	Post /api/servicetoken/all
ServiceTokenApiApi	RenameServiceToken	Post /api/servicetoken/update
ServiceTokenApiApi	RevokeServiceToken	Post /api/servicetoken/revoke
ServiceTokenApiApi	RotateServiceToken	Post /api/servicetoken/rotate
SessionApiApi	AccountCheck	Get /session/{email}
SessionApiApi	GetCurrentUser	Get /session/current
SessionApiApi	LogIn	Post /session/login
SessionApiApi	LogOut	Delete /session/logout
TokenEndpointApi	TokenEndpoint	Post /token
UserApiApi	BindTotpCredentials	Post /api/user/{id}/totp
UserApiApi	BindWebAuthnChallenge	Post /api/user/{id}/webauthn
UserApiApi	CreateTotpCredentials	Get /api/user/{id}/totp
UserApiApi	CreateUser	Post /api/user
UserApiApi	CreateWebAuthnChallenge	Get /api/user/{id}/webauthn
UserApiApi	DeleteUser	Delete /api/user/{id}
UserApiApi	SetAdmin	Post /api/user/{id}/admin
UserApiApi	UnsetAdmin	Delete /api/user/{id}/admin
UserApiApi	UpdateUser	Post /api/user/{id}
UserInfoEndpointApi	UserInfo	Get /userinfo

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

authlete / idp-api