7d60484cce7179a3bf4c62579e466c2a72d802ce
[nonrtric/plt/sme.git] / internal / aefsecurityapi / aefsecurityapi-types.gen.go
1 // Package aefsecurityapi 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 aefsecurityapi
5
6 import (
7         externalRef1 "oransc.org/nonrtric/sme/internal/common29571"
8         externalRef2 "oransc.org/nonrtric/sme/internal/securityapi"
9 )
10
11 // Represents authentication check request data.
12 type CheckAuthenticationReq struct {
13         // API invoker ID assigned by the CAPIF core function to the API invoker while on-boarding the API invoker.
14         ApiInvokerId string `json:"apiInvokerId"`
15
16         // 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.
17         SupportedFeatures externalRef1.SupportedFeatures `json:"supportedFeatures"`
18 }
19
20 // Represents authentication check response data.
21 type CheckAuthenticationRsp struct {
22         // 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.
23         SupportedFeatures externalRef1.SupportedFeatures `json:"supportedFeatures"`
24 }
25
26 // Represents authorization revocation request data.
27 type RevokeAuthorizationReq struct {
28         // Represents revoked authorization notification details.
29         RevokeInfo externalRef2.SecurityNotification `json:"revokeInfo"`
30
31         // 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.
32         SupportedFeatures externalRef1.SupportedFeatures `json:"supportedFeatures"`
33 }
34
35 // Represents authorization revocation response data.
36 type RevokeAuthorizationRsp struct {
37         // 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.
38         SupportedFeatures externalRef1.SupportedFeatures `json:"supportedFeatures"`
39 }
40
41 // PostCheckAuthenticationJSONBody defines parameters for PostCheckAuthentication.
42 type PostCheckAuthenticationJSONBody CheckAuthenticationReq
43
44 // PostRevokeAuthorizationJSONBody defines parameters for PostRevokeAuthorization.
45 type PostRevokeAuthorizationJSONBody RevokeAuthorizationReq
46
47 // PostCheckAuthenticationJSONRequestBody defines body for PostCheckAuthentication for application/json ContentType.
48 type PostCheckAuthenticationJSONRequestBody PostCheckAuthenticationJSONBody
49
50 // PostRevokeAuthorizationJSONRequestBody defines body for PostRevokeAuthorization for application/json ContentType.
51 type PostRevokeAuthorizationJSONRequestBody PostRevokeAuthorizationJSONBody