Go API client for openapi_Nudm_UEAU

UDM UE Authentication Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

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.3.0-alpha.1
• 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_Nudm_UEAU "github.com/GIT_USER_ID/GIT_REPO_ID/openapi_Nudm_UEAU"

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

Documentation for API Endpoints

All URIs are relative to https://example.com/nudm-ueau/v1

Class	Method	HTTP request	Description
ConfirmAuthApi	ConfirmAuth	Post /{supi}/auth-events	Create a new confirmation event
DeleteAuthApi	DeleteAuth	Put /{supi}/auth-events/{authEventId}	Deletes the authentication result in the UDM
GenerateAuthDataApi	GenerateAuthData	Post /{supiOrSuci}/security-information/generate-auth-data	Generate authentication data for the UE
GenerateGBAAuthenticationVectorsApi	GenerateGbaAv	Post /{supi}/gba-security-information/generate-av	Generate authentication data for the UE in GBA domain
GenerateHSSAuthenticationVectorsApi	GenerateAv	Post /{supi}/hss-security-information/{hssAuthType}/generate-av	Generate authentication data for the UE in EPS or IMS domain
GenerateProSeAuthenticationVectorsApi	GenerateProseAV	Post /{supiOrSuci}/prose-security-information/generate-av	Generate authentication data for ProSe
GetAuthDataForFNRGApi	GetRgAuthData	Get /{supiOrSuci}/security-information-rg	Get authentication data for the FN-RG

Documentation For Models

• AccessNetworkId
• AccessTokenErr
• AccessTokenReq
• AuthEvent
• AuthType
• AuthenticationInfoRequest
• AuthenticationInfoResult
• AuthenticationVector
• Av5GHeAka
• AvEapAkaPrime
• AvEpsAka
• AvImsGbaEapAka
• AvType
• GbaAuthType
• GbaAuthenticationInfoRequest
• GbaAuthenticationInfoResult
• HssAuthType
• HssAuthTypeInUri
• HssAuthenticationInfoRequest
• HssAuthenticationInfoResult
• HssAuthenticationVectors
• HssAvType
• InvalidParam
• Ipv6Addr
• Model3GAkaAv
• NFType
• NodeType
• PlmnId
• PlmnIdNid
• ProSeAuthenticationInfoRequest
• ProSeAuthenticationInfoResult
• ProSeAuthenticationVectors
• ProblemDetails
• ResynchronizationInfo
• ResynchronizationInfo1
• RgAuthCtx
• ServerAddressingInfo
• Snssai

Documentation For Authorization

oAuth2ClientCredentials

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• nudm-ueau: Access to the nudm-ueau API
• nudm-ueau:security-information:generate-auth-data:invoke: Acess to invoke the "generate-auth-data" custom operation on the "security-information" resource
• nudm-ueau:security-information-rg:read: Access to read the "security-information-rg" resource
• nudm-ueau:auth-events:create: Access to create a new child resource on the "auth-events" collection resource
• nudm-ueau:auth-event-id:modify: Access to modify (delete) an "auth-event-id" individual resource
• nudm-ueau:hss-security-information:generate-av:invoke: Acess to invoke the "generate-av" custom operation on the "hss-security-information" resource
• nudm-ueau:gba-security-information:generate-av:invoke: Acess to invoke the "generate-av" custom operation on the "gba-security-information" resource

Example

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

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
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