Categorygithub.com/authlete/openapi-for-go
3.0.0-alpha3
Repository: https://github.com/authlete/openapi-for-go.git
Documentation: pkg.go.dev

# README

Go API client for authlete

Authlete API Document.

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: 3.0.0
  • Package version: 3.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 authlete "github.com/authlete/openapi-for-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(), authlete.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(), authlete.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(), authlete.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), authlete.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.authlete.com

ClassMethodHTTP requestDescription
AuthorizationEndpointApiAuthAuthorizationApiPost /api/{serviceApiKey}/auth/authorization/api/auth/authorization API
AuthorizationEndpointApiAuthAuthorizationFailApiPost /api/{serviceApiKey}/auth/authorization/fail/api/auth/authorization/fail API
AuthorizationEndpointApiAuthAuthorizationIssueApiPost /api/{serviceApiKey}/auth/authorization/issue/api/auth/authorization/issue API
CIBAApiBackchannelAuthenticationApiPost /api/{serviceApiKey}/backchannel/authentication/api/backchannel/authentication API
CIBAApiBackchannelAuthenticationCompleteApiPost /api/{serviceApiKey}/backchannel/authentication/complete/api/backchannel/authentication/complete API
CIBAApiBackchannelAuthenticationFailApiPost /api/{serviceApiKey}/backchannel/authentication/fail/api/backchannel/authentication/fail API
CIBAApiBackchannelAuthenticationIssueApiPost /api/{serviceApiKey}/backchannel/authentication/issue/api/backchannel/authentication/issue API
ClientManagementApiClientAuthorizationDeleteApiDelete /api/{serviceApiKey}/client/authorization/delete/{clientId}/{subject}/api/{serviceApiKey}/client/authorization/delete/{clientId}/{subject} API
ClientManagementApiClientAuthorizationGetListApiGet /api/{serviceApiKey}/client/authorization/get/list/{subject}/api/{serviceApiKey}/client/authorization/get/list/{subject} API
ClientManagementApiClientAuthorizationUpdateApiPost /api/{serviceApiKey}/client/authorization/update/{clientId}/api/{serviceApiKey}/client/authorization/update/{clientId} API
ClientManagementApiClientCreateApiPost /api/{serviceApiKey}/client/create/api/{serviceApiKey}/client/create API
ClientManagementApiClientDeleteApiDelete /api/{serviceApiKey}/client/delete/{clientId}/api/{serviceApiKey}/client/delete/{clientId} API
ClientManagementApiClientFlagUpdateApiPost /api/{serviceApiKey}/client/lock_flag/update/{clientIdentifier}/api/{serviceApiKey}/client/lock_flag/update/{clientIdentifier} API
ClientManagementApiClientGetApiGet /api/{serviceApiKey}/client/get/{clientId}/api/{serviceApiKey}/client/get/{clientId} API
ClientManagementApiClientGetListApiGet /api/{serviceApiKey}/client/get/list/api/{serviceApiKey}/client/get/list API
ClientManagementApiClientGrantedScopesDeleteApiDelete /api/{serviceApiKey}/client/granted_scopes/delete/{clientId}/{subject}/api/{serviceApiKey}/client/granted_scopes/delete/{clientId}/{subject} API
ClientManagementApiClientGrantedScopesGetApiGet /api/{serviceApiKey}/client/granted_scopes/get/{clientId}/{subject}/api/{serviceApiKey}/client/granted_scopes/get/{clientId}/{subject} API
ClientManagementApiClientSecretRefreshApiGet /api/{serviceApiKey}/client/secret/refresh/{clientIdentifier}/api/{serviceApiKey}/client/secret/refresh API
ClientManagementApiClientSecretUpdateApiPost /api/{serviceApiKey}/client/secret/update/{clientIdentifier}/api/{serviceApiKey}/client/secret/update API
ClientManagementApiClientUpdateApiPost /api/{serviceApiKey}/client/update/{clientId}/api/{serviceApiKey}/client/update/{clientId} API
ConfigurationEndpointApiServiceConfigurationApiGet /api/{serviceApiKey}/service/configuration/api/service/configuration API
DeviceFlowApiDeviceAuthorizationApiPost /api/{serviceApiKey}/device/authorization/api/device/authorization API
DeviceFlowApiDeviceCompleteApiPost /api/{serviceApiKey}/device/complete/api/device/complete API
DeviceFlowApiDeviceVerificationApiPost /api/{serviceApiKey}/device/verification/api/device/verification API
DynamicClientRegistrationApiClientRegistrationApiPost /api/{serviceApiKey}/client/registration/api/client/registration API
DynamicClientRegistrationApiClientRegistrationDeleteApiPost /api/{serviceApiKey}/client/registration/delete/api/client/registration/delete API
DynamicClientRegistrationApiClientRegistrationGetApiPost /api/{serviceApiKey}/client/registration/get/api/client/registration/get API
DynamicClientRegistrationApiClientRegistrationUpdateApiPost /api/{serviceApiKey}/client/registration/update/api/client/registration/update API
FederationEndpointApiFederationConfigurationApiPost /api/{serviceApiKey}/federation/configuration/api/federation/configuration API
GrantManagementEndpointApiGrantMApiPost /api/{serviceApiKey}/gm/api/gm API
IntrospectionEndpointApiAuthIntrospectionApiPost /api/{serviceApiKey}/auth/introspection/api/auth/introspection API
IntrospectionEndpointApiAuthIntrospectionStandardApiPost /api/{serviceApiKey}/auth/introspection/standard/api/auth/intraspection/standard API
JWKSetEndpointApiServiceJwksGetApiGet /api/{serviceApiKey}/service/jwks/get/api/service/jwks/get API
JoseObjectApiJoseVerifyApiPost /api/{serviceApiKey}/jose/verify/api/jose/verify API
PushedAuthorizationEndpointApiPushedAuthReqApiPost /api/{serviceApiKey}/pushed_auth_req/api/pushed_auth_req API
RevocationEndpointApiAuthRevocationApiPost /api/{serviceApiKey}/auth/revocation/api/auth/revocation API
ServerMetadataApiInfoApiGet /api/info/api/info API
ServiceManagementApiServiceCreateApiPost /api/service/create/api/service/create API
ServiceManagementApiServiceDeleteApiDelete /api/{serviceApiKey}/service/delete/api/{serviceApiKey}/service/delete API
ServiceManagementApiServiceGetApiGet /api/{serviceApiKey}/service/get/api/{serviceApiKey}/service/get/{serviceApiKey} API
ServiceManagementApiServiceGetListApiGet /api/service/get/list/api/service/get/list API
ServiceManagementApiServiceUpdateApiPost /api/{serviceApiKey}/service/update/api/{serviceApiKey}/service/update API
TokenEndpointApiAuthTokenApiPost /api/{serviceApiKey}/auth/token/api/auth/token API
TokenEndpointApiAuthTokenFailApiPost /api/{serviceApiKey}/auth/token/fail/api/auth/token/fail API
TokenEndpointApiAuthTokenIssueApiPost /api/{serviceApiKey}/auth/token/issue/api/auth/token/issue API
TokenOperationsApiAuthTokenCreateApiPost /api/{serviceApiKey}/auth/token/create/api/auth/token/create API
TokenOperationsApiAuthTokenDeleteApiDelete /api/{serviceApiKey}/auth/token/delete/{accessTokenIdentifier}/api/auth/token/delete API
TokenOperationsApiAuthTokenGetListApiGet /api/{serviceApiKey}/auth/token/get/list/api/auth/token/get/list API
TokenOperationsApiAuthTokenRevokeApiPost /api/{serviceApiKey}/auth/token/revoke/api/auth/token/revoke API
TokenOperationsApiAuthTokenUpdateApiPost /api/{serviceApiKey}/auth/token/update/api/auth/token/update API
UserInfoEndpointApiAuthUserinfoApiPost /api/{serviceApiKey}/auth/userinfo/api/auth/userinfo API
UserInfoEndpointApiAuthUserinfoIssueApiPost /api/{serviceApiKey}/auth/userinfo/issue/api/auth/userinfo/issue API

Documentation For Models

Documentation For Authorization

ServiceCredentials

  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

ServiceOwnerCredentials

  • 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

# Packages

No description provided by the author