OpenAPI
OpenAPI Version: 3.0.0
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
3GPP TS 29.573 [27] specifies protocol for the exchange of the messages described above over N32, the format of the JOSE (see IETF RFC 7516 [25] and IETF RFC 7515 [26]) protected messages and the procedure for forwarding of the JOSE protected messages over N32.
OpenAPI Version: 3.0.0
Version: '1.0.0'
Title: 'JOSE Protected Message Forwarding API'
Description: 'N32-f Message Forwarding'
Description: 3GPP TS 29.573 V15.1.0; 5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3
URL: http://www.3gpp.org/ftp/Specs/archive/29_series/29.573/
URL: '{apiRoot}/n32f-forward/v1'
Variables:
API Root:
Default: https://example.com
Description: apiRoot as defined in subclause 4.4 of 3GPP TS 29.501.
Method: Post
Summary: N32-f Message Forwarding
Tags:
- N32-f Forward
Operation ID: PostN32fProcess
Request Body:
Description: Custom operation N32-f Message Forwarding
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/N32fReformattedReqMsg'
Responses:
'200' OK (Successful forwarding of reformatted message over N32-f)
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/N32fReformattedRspMsg'
'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'
'411': Reference 'TS29571_CommonData.yaml#/components/responses/411'
'413': Reference 'TS29571_CommonData.yaml#/components/responses/413'
'415': Reference 'TS29571_CommonData.yaml#/components/responses/415'
'429': Reference 'TS29571_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'
default:
Description: Unexpected error
Type: object
Required:
- ciphertext
Properties:
protected:
Type: string
unprotected:
Type: object
header:
Type: object
encrypted_key:
Type: string
aad:
Type: string
iv:
Type: string
ciphertext:
Type: string
tag:
Type: string
Type: object
Required:
- payload
- signature
Properties:
payload:
Type: string
protected:
Type: string
header:
Type: object
signature:
Type: string
Type: object
Required:
- reformattedData
Properties:
reformattedData:
Reference: '#/components/schemas/FlatJweJson'
modificationsBlock:
Type: array
Items:
Reference: '#/components/schemas/FlatJwsJson'
minItems: 1
Type: object
Required:
- reformattedData
Properties:
reformattedData:
Reference: '#/components/schemas/FlatJweJson'
modificationsBlock:
Type: array
Items:
Reference: '#/components/schemas/FlatJwsJson'
minItems: 1
Type: object
Required:
- dataToEncrypt
Properties:
dataToEncrypt:
Type: array
Items:
Type: object
minItems: 1
Type: object
Properties:
metaData:
Reference: '#/components/schemas/MetaData'
requestLine:
Reference: '#/components/schemas/RequestLine'
statusLine:
Type: string
headers:
Type: array
Items:
Reference: '#/components/schemas/HttpHeader'
minItems: 1
payload:
Type: array
Items:
Reference: '#/components/schemas/HttpPayload'
minItems: 1
Type: object
Required:
- method
- scheme
- authority
- path
- protocolVersion
Properties:
method:
Reference: 'TS29573_N32_Handshake.yaml#/components/schemas/HttpMethod'
scheme:
Reference: 'TS29571_CommonData.yaml#/components/schemas/UriScheme'
authority:
Type: string
path:
Type: string
protocolVersion:
Type: string
queryFragment:
Type: string
Type: object
Required:
- header
- value
Properties:
header:
Type: string
value:
Reference: '#/components/schemas/EncodedHttpHeaderValue'
Type: object
Required:
- iePath
- ieValueLocation
- value
Properties:
iePath:
Type: string
ieValueLocation:
Reference: 'TS29573_N32_Handshake.yaml#/components/schemas/IeLocation'
value:
Type: object
Type: object
Required:
- n32fContextId
- messageId
- authorizedIpxId
Properties:
n32fContextId:
Type: string
messageId:
Type: string
authorizedIpxId:
Type: string
Type: object
Required:
- identity
Properties:
identity:
Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/Fqdn'
operations:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PatchItem'
minItems: 1
Type: object
Required:
- encBlockIndex
Properties:
encBlockIndex:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
oneOf:
- type: string
- $ref: '#/components/schemas/IndexToEncryptedValue'