capifcore/internal/securityapi/securityapi-types.gen.go

   1 // Package securityapi provides primitives to interact with the openapi HTTP API.
   2 //
   3 // Code generated by github.com/deepmap/oapi-codegen version v1.10.1 DO NOT EDIT.
   4 package securityapi
   5
   6 import (
   7         externalRef0 "oransc.org/nonrtric/capifcore/internal/common29122"
   8         externalRef1 "oransc.org/nonrtric/capifcore/internal/common29571"
   9 )
  10
  11 // Defines values for AccessTokenErrError.
  12 const (
  13         AccessTokenErrErrorInvalidClient AccessTokenErrError = "invalid_client"
  14
  15         AccessTokenErrErrorInvalidGrant AccessTokenErrError = "invalid_grant"
  16
  17         AccessTokenErrErrorInvalidRequest AccessTokenErrError = "invalid_request"
  18
  19         AccessTokenErrErrorInvalidScope AccessTokenErrError = "invalid_scope"
  20
  21         AccessTokenErrErrorUnauthorizedClient AccessTokenErrError = "unauthorized_client"
  22
  23         AccessTokenErrErrorUnsupportedGrantType AccessTokenErrError = "unsupported_grant_type"
  24 )
  25
  26 // Defines values for AccessTokenReqGrantType.
  27 const (
  28         AccessTokenReqGrantTypeClientCredentials AccessTokenReqGrantType = "client_credentials"
  29 )
  30
  31 // Defines values for AccessTokenRspTokenType.
  32 const (
  33         AccessTokenRspTokenTypeBearer AccessTokenRspTokenType = "Bearer"
  34 )
  35
  36 // Defines values for Cause.
  37 const (
  38         CauseOVERLIMITUSAGE Cause = "OVERLIMIT_USAGE"
  39
  40         CauseUNEXPECTEDREASON Cause = "UNEXPECTED_REASON"
  41 )
  42
  43 // Represents an error in the access token request.
  44 type AccessTokenErr struct {
  45         Error            AccessTokenErrError `json:"error"`
  46         ErrorDescription *string             `json:"error_description,omitempty"`
  47         ErrorUri         *string             `json:"error_uri,omitempty"`
  48 }
  49
  50 // AccessTokenErrError defines model for AccessTokenErr.Error.
  51 type AccessTokenErrError string
  52
  53 // Represents the access token request information.
  54 type AccessTokenReq struct {
  55         ClientId     string                  `json:"client_id"`
  56         ClientSecret *string                 `json:"client_secret,omitempty"`
  57         GrantType    AccessTokenReqGrantType `json:"grant_type"`
  58         Scope        *string                 `json:"scope,omitempty"`
  59 }
  60
  61 // AccessTokenReqGrantType defines model for AccessTokenReq.GrantType.
  62 type AccessTokenReqGrantType string
  63
  64 // Represents the access token response information.
  65 type AccessTokenRsp struct {
  66         // JWS Compact Serialized representation of JWS signed JSON object (AccessTokenClaims)
  67         AccessToken string `json:"access_token"`
  68
  69         // Unsigned integer identifying a period of time in units of seconds.
  70         ExpiresIn externalRef0.DurationSec `json:"expires_in"`
  71         Scope     *string                  `json:"scope,omitempty"`
  72         TokenType AccessTokenRspTokenType  `json:"token_type"`
  73 }
  74
  75 // AccessTokenRspTokenType defines model for AccessTokenRsp.TokenType.
  76 type AccessTokenRspTokenType string
  77
  78 // Possible values are:
  79 // - OVERLIMIT_USAGE: The revocation of the authorization of the API invoker is due to the overlimit usage of the service API
  80 // - UNEXPECTED_REASON: The revocation of the authorization of the API invoker is due to unexpected reason.
  81 type Cause string
  82
  83 // Represents the interface details and the security method.
  84 type SecurityInformation interface{}
  85
  86 // Represents revoked authorization notification details.
  87 type SecurityNotification struct {
  88         // String identifying the AEF.
  89         AefId *string `json:"aefId,omitempty"`
  90
  91         // Identifier of the service API
  92         ApiIds []string `json:"apiIds"`
  93
  94         // String identifying the API invoker assigned by the CAPIF core function.
  95         ApiInvokerId string `json:"apiInvokerId"`
  96
  97         // Possible values are:
  98         // - OVERLIMIT_USAGE: The revocation of the authorization of the API invoker is due to the overlimit usage of the service API
  99         // - UNEXPECTED_REASON: The revocation of the authorization of the API invoker is due to unexpected reason.
 100         Cause Cause `json:"cause"`
 101 }
 102
 103 // Represents the details of the security method for each service API interface. When included by the API invoker, it indicates the preferred method of security. When included by the CAPIF core function, it indicates the security method to be used for the service API interface.
 104 type ServiceSecurity struct {
 105         // string providing an URI formatted according to IETF RFC 3986.
 106         NotificationDestination externalRef0.Uri `json:"notificationDestination"`
 107
 108         // Set to true by API invoker to request the CAPIF core function to send a test notification as defined in in clause 7.6. Set to false or omitted otherwise.
 109         RequestTestNotification *bool                 `json:"requestTestNotification,omitempty"`
 110         SecurityInfo            []SecurityInformation `json:"securityInfo"`
 111
 112         // A string used to indicate the features supported by an API that is used as defined in clause  6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in  hexadecimal representation Each character in the string shall take a value of "0" to "9",  "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in  table 5.2.2-3. The most significant character representing the highest-numbered features shall  appear first in the string, and the character representing features 1 to 4 shall appear last  in the string. The list of features and their numbering (starting with 1) are defined  separately for each API. If the string contains a lower number of characters than there are  defined features for an API, all features that would be represented by characters that are not  present in the string are not supported.
 113         SupportedFeatures *externalRef1.SupportedFeatures `json:"supportedFeatures,omitempty"`
 114
 115         // Represents the configuration information for the delivery of notifications over Websockets.
 116         WebsockNotifConfig *externalRef0.WebsockNotifConfig `json:"websockNotifConfig,omitempty"`
 117 }
 118
 119 // GetTrustedInvokersApiInvokerIdParams defines parameters for GetTrustedInvokersApiInvokerId.
 120 type GetTrustedInvokersApiInvokerIdParams struct {
 121         // When set to 'true', it indicates the CAPIF core function to send the authentication information of the API invoker. Set to false or omitted otherwise.
 122         AuthenticationInfo *bool `json:"authenticationInfo,omitempty"`
 123
 124         // When set to 'true', it indicates the CAPIF core function to send the authorization information of the API invoker. Set to false or omitted otherwise.
 125         AuthorizationInfo *bool `json:"authorizationInfo,omitempty"`
 126 }
 127
 128 // PutTrustedInvokersApiInvokerIdJSONBody defines parameters for PutTrustedInvokersApiInvokerId.
 129 type PutTrustedInvokersApiInvokerIdJSONBody ServiceSecurity
 130
 131 // PostTrustedInvokersApiInvokerIdDeleteJSONBody defines parameters for PostTrustedInvokersApiInvokerIdDelete.
 132 type PostTrustedInvokersApiInvokerIdDeleteJSONBody SecurityNotification
 133
 134 // PostTrustedInvokersApiInvokerIdUpdateJSONBody defines parameters for PostTrustedInvokersApiInvokerIdUpdate.
 135 type PostTrustedInvokersApiInvokerIdUpdateJSONBody ServiceSecurity
 136
 137 // PutTrustedInvokersApiInvokerIdJSONRequestBody defines body for PutTrustedInvokersApiInvokerId for application/json ContentType.
 138 type PutTrustedInvokersApiInvokerIdJSONRequestBody PutTrustedInvokersApiInvokerIdJSONBody
 139
 140 // PostTrustedInvokersApiInvokerIdDeleteJSONRequestBody defines body for PostTrustedInvokersApiInvokerIdDelete for application/json ContentType.
 141 type PostTrustedInvokersApiInvokerIdDeleteJSONRequestBody PostTrustedInvokersApiInvokerIdDeleteJSONBody
 142
 143 // PostTrustedInvokersApiInvokerIdUpdateJSONRequestBody defines body for PostTrustedInvokersApiInvokerIdUpdate for application/json ContentType.
 144 type PostTrustedInvokersApiInvokerIdUpdateJSONRequestBody PostTrustedInvokersApiInvokerIdUpdateJSONBody