emolero commited on
Commit
2ff91ef
·
verified ·
1 Parent(s): 0356ea6

Add files using upload-large-folder tool

Browse files
This view is limited to 50 files because it contains too many changes.   See raw diff
Files changed (50) hide show
  1. .gitattributes +12 -0
  2. gsma/29_series/29002/raw.md +0 -0
  3. gsma/29_series/29061/raw.md +0 -0
  4. gsma/29_series/29122/raw.md +0 -0
  5. gsma/29_series/29176/raw.md +1328 -0
  6. gsma/29_series/29213/raw.md +0 -0
  7. gsma/29_series/29214/raw.md +0 -0
  8. gsma/29_series/29222/raw.md +0 -0
  9. gsma/29_series/29230/raw.md +0 -0
  10. gsma/29_series/29255/raw.md +1229 -0
  11. gsma/29_series/29380/raw.md +0 -0
  12. gsma/29_series/29509/raw.md +0 -0
  13. gsma/29_series/29512/raw.md +0 -0
  14. gsma/29_series/29513/raw.md +0 -0
  15. gsma/29_series/29514/raw.md +0 -0
  16. gsma/29_series/29515/raw.md +0 -0
  17. gsma/29_series/29523/raw.md +0 -0
  18. gsma/29_series/29524/raw.md +555 -0
  19. gsma/29_series/29525/raw.md +0 -0
  20. gsma/29_series/29531/raw.md +0 -0
  21. gsma/29_series/29536/raw.md +0 -0
  22. gsma/29_series/29540/raw.md +0 -0
  23. gsma/29_series/29549/raw.md +0 -0
  24. gsma/29_series/29571/raw.md +0 -0
  25. gsma/29_series/29576/raw.md +0 -0
  26. gsma/29_series/29578/raw.md +702 -0
  27. gsma/29_series/29579/raw.md +878 -0
  28. gsma/29_series/29641/raw.md +204 -0
  29. gsma/29_series/29831/raw.md +0 -0
  30. gsma/37_series/37145-2/04c2b0e015697b9fd54da23916a850d6_img.jpg +3 -0
  31. gsma/37_series/37145-2/07b81106e8525814c458f262000c54a9_img.jpg +3 -0
  32. gsma/37_series/37145-2/09955ff8214ffb6947951fc0f60eb6ab_img.jpg +3 -0
  33. gsma/37_series/37145-2/315bdbeafb39026e19b77c26b19d9d1f_img.jpg +3 -0
  34. gsma/37_series/37145-2/36cc7cc6626dc09bfcc888a4f8e2e9e4_img.jpg +3 -0
  35. gsma/37_series/37145-2/3c8ed97dd81b363f7919bb50f8410baa_img.jpg +3 -0
  36. gsma/37_series/37145-2/51923f79574a4c945d05c5ad3ff8dda5_img.jpg +3 -0
  37. gsma/37_series/37145-2/5fb340ad68b0c71df0b56698b137e35b_img.jpg +3 -0
  38. gsma/37_series/37145-2/71440aab73c3d21521dba3a413e3a7ca_img.jpg +3 -0
  39. gsma/37_series/37145-2/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg +3 -0
  40. gsma/37_series/37145-2/854a7aa42ede8d319880a076c262338e_img.jpg +3 -0
  41. gsma/37_series/37145-2/87661c01f79c13b3ea49e7d3e9782c48_img.jpg +3 -0
  42. gsma/37_series/37145-2/8b6f7b51bc160aa80e286e818baa7998_img.jpg +3 -0
  43. gsma/37_series/37145-2/8be5d9cba2614c3e06e06525a14c5a3b_img.jpg +3 -0
  44. gsma/37_series/37145-2/8bffff22941e018add90bd8d04b6798c_img.jpg +3 -0
  45. gsma/37_series/37145-2/acb90ab4b1096f13fbf453251ca3ffd2_img.jpg +3 -0
  46. gsma/37_series/37145-2/b664da64b7121b86310de02c98642405_img.jpg +3 -0
  47. gsma/37_series/37145-2/b81d1613e285a9353171cdc5ef97a1f0_img.jpg +3 -0
  48. gsma/37_series/37145-2/c0e1c8d37f9cd96595cb6370b1b5a8c7_img.jpg +3 -0
  49. gsma/37_series/37145-2/dc5554f3d97c390f2e7467a86598b98e_img.jpg +3 -0
  50. gsma/37_series/37145-2/e9baf350bd23410e8a6df8dc5c68c16b_img.jpg +3 -0
.gitattributes CHANGED
@@ -58,3 +58,15 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
58
  # Video files - compressed
59
  *.mp4 filter=lfs diff=lfs merge=lfs -text
60
  *.webm filter=lfs diff=lfs merge=lfs -text
 
 
 
 
 
 
 
 
 
 
 
 
 
58
  # Video files - compressed
59
  *.mp4 filter=lfs diff=lfs merge=lfs -text
60
  *.webm filter=lfs diff=lfs merge=lfs -text
61
+ original/38865-i00.docx filter=lfs diff=lfs merge=lfs -text
62
+ original/23700-97-i10.docx filter=lfs diff=lfs merge=lfs -text
63
+ original/23436-i20.docx filter=lfs diff=lfs merge=lfs -text
64
+ original/33898-i01.docx filter=lfs diff=lfs merge=lfs -text
65
+ original/36305-i00.docx filter=lfs diff=lfs merge=lfs -text
66
+ original/36304-i00.docx filter=lfs diff=lfs merge=lfs -text
67
+ original/22261-ic0.docx filter=lfs diff=lfs merge=lfs -text
68
+ original/29558-i40.docx filter=lfs diff=lfs merge=lfs -text
69
+ original/24257-i20.docx filter=lfs diff=lfs merge=lfs -text
70
+ original/23288-i40.docx filter=lfs diff=lfs merge=lfs -text
71
+ original/38101-5-i40.docx filter=lfs diff=lfs merge=lfs -text
72
+ original/38741-i00.docx filter=lfs diff=lfs merge=lfs -text
gsma/29_series/29002/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29061/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29122/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29176/raw.md ADDED
@@ -0,0 +1,1328 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # 3GPP TS 29.176 V18.0.0 (2023-12)
4
+
5
+ *Technical Specification*
6
+
7
+ ## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; IP Multimedia Subsystems (IMS); Media Function (MF) Services; Stage 3 (Release 18)**
8
+
9
+ ![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg)
10
+
11
+ The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right.
12
+
13
+ 5G Advanced logo
14
+
15
+ ![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg)
16
+
17
+ The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font.
18
+
19
+ 3GPP logo
20
+
21
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
22
+
23
+ ## **3GPP**
24
+
25
+ ---
26
+
27
+ Postal address
28
+
29
+ ---
30
+
31
+ 3GPP support office address
32
+
33
+ ---
34
+
35
+ 650 Route des Lucioles - Sophia Antipolis
36
+
37
+ Valbonne - FRANCE
38
+
39
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
40
+
41
+ ---
42
+
43
+ Internet
44
+
45
+ ---
46
+
47
+ <http://www.3gpp.org>
48
+
49
+ ## --- **Copyright Notification** ---
50
+
51
+ No part may be reproduced except as authorized by written permission.
52
+ The copyright and the foregoing restriction extend to reproduction in all media.
53
+
54
+ © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
55
+ All rights reserved.
56
+
57
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
58
+
59
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
60
+
61
+ LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
62
+
63
+ GSM® and the GSM logo are registered and owned by the GSM Association
64
+
65
+ # Contents
66
+
67
+ | | |
68
+ |------------------------------------------------------------|----|
69
+ | Foreword ..... | 5 |
70
+ | 1 Scope..... | 7 |
71
+ | 2 References..... | 7 |
72
+ | 3 Definitions, symbols and abbreviations ..... | 8 |
73
+ | 3.1 Definitions..... | 8 |
74
+ | 3.2 Symbols..... | 8 |
75
+ | 3.3 Abbreviations ..... | 8 |
76
+ | 4 Overview..... | 8 |
77
+ | 5 Services offered by the MF..... | 9 |
78
+ | 5.1 Introduction ..... | 9 |
79
+ | 5.2 Nmf_MediaResourceManagement (MRM) Service ..... | 9 |
80
+ | 5.2.1 Service Description ..... | 9 |
81
+ | 5.2.2 Service Operations..... | 9 |
82
+ | 5.2.2.1 Introduction..... | 9 |
83
+ | 5.2.2.2 Nmf_MRM_Create Service Operation..... | 9 |
84
+ | 5.2.2.2.1 General ..... | 9 |
85
+ | 5.2.2.2.2 Creation of a new media context..... | 10 |
86
+ | 5.2.2.3 Nmf_MRM_Update Service Operation..... | 11 |
87
+ | 5.2.2.3.1 General ..... | 11 |
88
+ | 5.2.2.3.2 Updating an existing media context..... | 11 |
89
+ | 5.2.2.4 Nmf_MRM_Delete Service Operation..... | 12 |
90
+ | 5.2.2.4.1 General ..... | 12 |
91
+ | 5.2.2.4.2 Deleting an existing media context..... | 12 |
92
+ | 6 API Definitions ..... | 13 |
93
+ | 6.1 Nmf_MRM Service API ..... | 13 |
94
+ | 6.1.1 Introduction ..... | 13 |
95
+ | 6.1.2 Usage of HTTP..... | 13 |
96
+ | 6.1.2.1 General..... | 13 |
97
+ | 6.1.2.2 HTTP standard headers..... | 13 |
98
+ | 6.1.2.2.1 General ..... | 13 |
99
+ | 6.1.2.2.2 Content type ..... | 13 |
100
+ | 6.1.2.3 HTTP custom headers..... | 13 |
101
+ | 6.1.3 Resources..... | 14 |
102
+ | 6.1.3.1 Overview..... | 14 |
103
+ | 6.1.3.2 Resource: Contexts Collection..... | 14 |
104
+ | 6.1.3.2.1 Description ..... | 14 |
105
+ | 6.1.3.2.2 Resource Definition..... | 14 |
106
+ | 6.1.3.2.3 Resource Standard Methods..... | 15 |
107
+ | 6.1.3.2.4 Resource Custom Operations..... | 16 |
108
+ | 6.1.3.3 Resource: Individual Context ..... | 16 |
109
+ | 6.1.3.3.1 Description ..... | 16 |
110
+ | 6.1.3.3.2 Resource Definition..... | 16 |
111
+ | 6.1.3.3.3 Resource Standard Methods..... | 16 |
112
+ | 6.1.3.3.4 Resource Custom Operations..... | 18 |
113
+ | 6.1.4 Custom Operations without associated resources ..... | 18 |
114
+ | 6.1.5 Notifications ..... | 19 |
115
+ | 6.1.6 Data Model ..... | 19 |
116
+ | 6.1.6.1 General..... | 19 |
117
+ | 6.1.6.2 Structured data types..... | 19 |
118
+ | 6.1.6.2.1 Introduction ..... | 19 |
119
+ | 6.1.6.2.2 Type: MediaContext..... | 20 |
120
+ | 6.1.6.2.3 Type: TerminationInfo ..... | 20 |
121
+ | 6.1.6.2.4 Type: MediaInfo..... | 21 |
122
+
123
+ | | | |
124
+ |-------------------------------|-----------------------------------------|-----------|
125
+ | 6.1.6.2.5 | Type: DcMedia..... | 22 |
126
+ | 6.1.6.2.6 | Type: ArMedia..... | 24 |
127
+ | 6.1.6.3 | Simple data types and enumerations..... | 24 |
128
+ | 6.1.6.3.1 | Introduction ..... | 24 |
129
+ | 6.1.6.3.2 | Simple data types ..... | 24 |
130
+ | 6.1.7 | Error Handling ..... | 24 |
131
+ | 6.1.7.1 | General ..... | 24 |
132
+ | 6.1.7.2 | Protocol Errors ..... | 24 |
133
+ | 6.1.7.3 | Application Errors..... | 25 |
134
+ | 6.1.8 | Feature negotiation ..... | 25 |
135
+ | 6.1.9 | Security ..... | 25 |
136
+ | 6.1.10 | HTTP redirection..... | 25 |
137
+ | <b>Annex A (normative):</b> | <b>OpenAPI specification .....</b> | <b>26</b> |
138
+ | A.1 | General..... | 26 |
139
+ | A.2 | Ndcmf_MRM API ..... | 26 |
140
+ | <b>Annex B (informative):</b> | <b>Change history.....</b> | <b>31</b> |
141
+
142
+ # Foreword
143
+
144
+ This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).
145
+
146
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
147
+
148
+ Version x.y.z
149
+
150
+ where:
151
+
152
+ - x the first digit:
153
+ - 1 presented to TSG for information;
154
+ - 2 presented to TSG for approval;
155
+ - 3 or greater indicates TSG approved document under change control.
156
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
157
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
158
+
159
+ In the present document, modal verbs have the following meanings:
160
+
161
+ - shall** indicates a mandatory requirement to do something
162
+ - shall not** indicates an interdiction (prohibition) to do something
163
+
164
+ The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports.
165
+
166
+ The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document.
167
+
168
+ - should** indicates a recommendation to do something
169
+ - should not** indicates a recommendation not to do something
170
+ - may** indicates permission to do something
171
+ - need not** indicates permission not to do something
172
+
173
+ The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended.
174
+
175
+ - can** indicates that something is possible
176
+ - cannot** indicates that something is impossible
177
+
178
+ The constructions "can" and "cannot" are not substitutes for "may" and "need not".
179
+
180
+ - will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
181
+ - will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
182
+ - might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
183
+
184
+ **might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
185
+
186
+ In addition:
187
+
188
+ **is** (or any other verb in the indicative mood) indicates a statement of fact
189
+
190
+ **is not** (or any other negative verb in the indicative mood) indicates a statement of fact
191
+
192
+ The constructions "is" and "is not" do not indicate requirements.
193
+
194
+ # --- 1 Scope
195
+
196
+ The present document specifies the stage 3 protocol and data model for the Nmf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the Media Function (MF).
197
+
198
+ The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3].
199
+
200
+ The IP Multimedia Subsystem (IMS) Data Channel (DC) architecture and procedures are specified in annex AC of 3GPP TS 23.228 [14].
201
+
202
+ The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5].
203
+
204
+ # --- 2 References
205
+
206
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
207
+
208
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
209
+ - For a specific reference, subsequent revisions do not apply.
210
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
211
+
212
+ - [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
213
+ - [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2".
214
+ - [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2".
215
+ - [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3".
216
+ - [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3".
217
+ - [6] OpenAPI: "OpenAPI Specification Version 3.0.0", <https://spec.openapis.org/oas/v3.0.0>.
218
+ - [7] 3GPP TR 21.900: "Technical Specification Group working methods".
219
+ - [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system".
220
+ - [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework".
221
+ - [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3".
222
+ - [11] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)".
223
+ - [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format".
224
+ - [13] IETF RFC 7807: "Problem Details for HTTP APIs".
225
+ - [14] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2".
226
+ - [15] IETF RFC 6902: " JavaScript Object Notation (JSON) Patch".
227
+ - [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3".
228
+
229
+ # 3 Definitions, symbols and abbreviations
230
+
231
+ ## 3.1 Definitions
232
+
233
+ For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1].
234
+
235
+ *Definition format (Normal)*
236
+
237
+ **<defined term>**: <definition>.
238
+
239
+ **example:** text used to clarify abstract rules by applying them literally.
240
+
241
+ ## 3.2 Symbols
242
+
243
+ For the purposes of the present document, the following symbols apply:
244
+
245
+ | | |
246
+ |-----|---------------------------------------|
247
+ | DC2 | Reference point between MF and IMS AS |
248
+ |-----|---------------------------------------|
249
+
250
+ ## 3.3 Abbreviations
251
+
252
+ For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1].
253
+
254
+ | | |
255
+ |--------|--------------------------------------------|
256
+ | AR | Augmented Reality |
257
+ | DC | Data Channel |
258
+ | MF | Media Function |
259
+ | IMS AS | IP Multimedia Subsystem Application Server |
260
+
261
+ # 4 Overview
262
+
263
+ Within the IMS DC architecture, the MF offers services to the IMS AS via the Nmf service based interface (see 3GPP TS 23.228 [14]).
264
+
265
+ Figure 4.1-1 provides the reference model (in service-based interface representation and in reference point representation), with focus on the MF services.
266
+
267
+ ![Diagram of the reference model showing the IMS AS connected to the MF via the DC2 reference point and the Nmf service-based interface.](98a45dd7d474e067b7533cc966c11e95_img.jpg)
268
+
269
+ The diagram illustrates the reference model for the Media Function (MF). On the left, a white rectangular box is labeled 'IMS AS'. A horizontal line connects this box to a green rectangular box on the right, which is labeled 'MF'. The connection line is labeled 'DC2' near the IMS AS and 'Nmf' near the MF. The 'Nmf' label is positioned next to a small circle on the left side of the MF box, indicating a service-based interface.
270
+
271
+ Diagram of the reference model showing the IMS AS connected to the MF via the DC2 reference point and the Nmf service-based interface.
272
+
273
+ **Figure 4.1-1: Reference model – MF**
274
+
275
+ DC2 is the reference point between MF and IMS AS.
276
+
277
+ # 5 Services offered by the MF
278
+
279
+ ## 5.1 Introduction
280
+
281
+ The MF offers the following services via the Nmf interface:
282
+
283
+ - Nmf\_MediaResourceManagement (MRM) Service
284
+
285
+ Table 5.1-1 summarizes the corresponding APIs defined for this specification.
286
+
287
+ **Table 5.1-1: API Descriptions**
288
+
289
+ | Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex |
290
+ |--------------|--------|---------------------------------------|----------------------------|---------|-------|
291
+ | Nmf_MRM | 6.1 | Nmf Media Resource Management Service | TS29176_Nmf_MRM.yaml | nmf-mrm | A.2 |
292
+
293
+ ## 5.2 Nmf\_MediaResourceManagement (MRM) Service
294
+
295
+ ### 5.2.1 Service Description
296
+
297
+ The Nmf\_MRM service as defined in 3GPP TS 23.228 [14] is provided by the Media Function (MF). This service enables the consumer to create, update and delete media resources. Data Channel (DC) and Augmented Reality (AR) are two capabilities supported by MF.
298
+
299
+ The media resource represents a media context including one or multiple media terminations. A media termination includes media resources for one or multiple medias on the Mb interface. When a media pass through the MF, there is one termination for the input stream and one termination for the output stream.
300
+
301
+ ### 5.2.2 Service Operations
302
+
303
+ #### 5.2.2.1 Introduction
304
+
305
+ The Nmf\_MRM service supports the following service operation.
306
+
307
+ **Table 5.2.2.1-1: Service operations supported by the Nmf\_MRM service**
308
+
309
+ | Service Operations | Description | Operation Semantics | Example Consumer(s) |
310
+ |--------------------|--------------------------------------------------------------------------------------|---------------------|---------------------|
311
+ | Create | Create a new media context including one or multiple media terminations. | Request/Response | IMS AS |
312
+ | Update | Update the one or multiple existing media resources within a specific media context. | Request/Response | IMS AS |
313
+ | Delete | Delete a specific media context including all the existing terminations and medias. | Request/Response | IMS AS |
314
+
315
+ #### 5.2.2.2 Nmf\_MRM\_Create Service Operation
316
+
317
+ ##### 5.2.2.2.1 General
318
+
319
+ The Nmf\_MRM\_Create service operation is used by an NF service consumer to create a media context including one or multiple terminations and reserve media resources for anchoring one or multiple medias of Mb interface in each
320
+
321
+ termination on MF. The consumer NF may also include application function (e.g. DCSF, DC AS) specification information requested by the application layer to be applied on the media by the MF.
322
+
323
+ ##### 5.2.2.2.2 Creation of a new media context
324
+
325
+ The NF service consumer shall request a new context by using HTTP method POST with "{apiRoot}/nmf/<apiVersion>/contexts" as resource URI representing the "Contexts Collection", see clause 6.1.3.2.
326
+
327
+ ![Sequence diagram showing the creation of a media context. The NF Service Consumer sends a POST request to the MF. The MF responds with either a 201 Created (MediaContext) or a 4xx/5xx (ProblemDetails) or 3xx response.](053f1077d592e6622cd21dc4bb4cb366_img.jpg)
328
+
329
+ ```
330
+
331
+ sequenceDiagram
332
+ participant NF Service Consumer
333
+ participant MF
334
+ Note left of NF Service Consumer: POST ../contexts (MediaContext)
335
+ NF Service Consumer->>MF: 1. POST ../contexts (MediaContext)
336
+ Note right of MF: -2a. 201 Created (MediaContext)
337
+ MF-->>NF Service Consumer: -2a. 201 Created (MediaContext)
338
+ Note right of MF: -2b. 4xx/5xx (ProblemDetails) or 3xx
339
+ MF-->>NF Service Consumer: -2b. 4xx/5xx (ProblemDetails) or 3xx
340
+
341
+ ```
342
+
343
+ Sequence diagram showing the creation of a media context. The NF Service Consumer sends a POST request to the MF. The MF responds with either a 201 Created (MediaContext) or a 4xx/5xx (ProblemDetails) or 3xx response.
344
+
345
+ Figure 5.2.2.2.2-1 Creation of a media context
346
+
347
+ 1. The NF Service Consumer shall send a POST request to create an "Individual Context" resource in the MF. The payload body of the POST request shall contain a representation of the individual context resource to be created.
348
+
349
+ The NF service consumer shall include list of termination descriptors in the HTTP message body. Each termination descriptor shall include list of media stream descriptors. Each media stream descriptor shall include:
350
+
351
+ - Media ID, i.e. a unique identity of the media stream within the media context instance;
352
+ - Remote Mb specifications, i.e. the media stream IP address and port allocated at the remote endpoint, i.e. remote UE, remote network.
353
+ - Media resource description, which includes
354
+ - 1) Media resource type, e.g. DC, AR.
355
+ - 2) If media resource type is set to "DC", the DC media specification shall be included. The DC media specification shall include:
356
+ - a) Data Channel Mapping and Configuration information when originating/terminating data channel media flows on the Mb interface. It shall include the SCTP stream Id for the DC, and may include subprotocol, order, maxRetry, maxTime and priority may be included.
357
+ - b) Maximum Message Size, which represents the maximum size to be expected.
358
+ - c) Data Channel Port, which represents the port of SCTP port for the Data Channel.
359
+ - d) Security Setup, which identifies the security setup of the DTLS connection.
360
+ - e) Security Certificate Fingerprint, which identifies the security certificate fingerprint.
361
+ - f) Security Transport Identity, which identifies transport layer identity.
362
+
363
+ For establishing bootstrap data channel or P2A/A2P application data channel, the following parameters shall be included:
364
+
365
+ - a) media proxy configuration applicable to the media flow;
366
+ - b) remote MDC1/MDC2 media specification information to be applied on the media by the MF;
367
+ - c) Replacement HTTP URL for each streamId allocated by the application layer representing the application list (e.g. graphical user interface) offered to the IMS subscriber via the MDC1 interface.
368
+
369
+ 3) If media resource type is set to "AR", the AR media resource description shall be included, which includes:
370
+
371
+ a) Media processing specification.
372
+
373
+ 2a. Upon the reception of the HTTP POST request, if the request is accepted and no error occur, the MF shall:
374
+
375
+ - create a new media context;
376
+ - assign a media contextId;
377
+ - assign a terminationId for each termination descriptor; and
378
+ - reserve media resources for each mediaId.
379
+
380
+ The MF shall include a HTTP Location header to provide the location of a newly created resource (MediaContext) together with the status code 201 indicating the requested resource is created in the response message.
381
+
382
+ 2b. On failure, one of the HTTP status code listed in Table 6.1.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.2.3.1-3.
383
+
384
+ On redirection, the MF shall include 3xx status code, which shall contain a Location header with an URI pointing to the endpoint to another MF (service) instance.
385
+
386
+ #### 5.2.2.3 Nmf\_MRM\_Update Service Operation
387
+
388
+ ##### 5.2.2.3.1 General
389
+
390
+ The Nmf\_MRM\_Update service operation is used by an NF service consumer to update one or multiple existing media resources within a specific media context on MF. Terminations and/or Medias can be added, modified, or deleted within an Update request.
391
+
392
+ ##### 5.2.2.3.2 Updating an existing media context
393
+
394
+ The NF Service Consumer shall modify the context by using HTTP method PATCH with the URI "{apiRoot}/nmf/<apiVersion>/contexts/{contextId}" as resource URI representing the "Individual Context ", see clause 6.1.3.3.
395
+
396
+ ![Sequence diagram showing the interaction between an NF Service Consumer and an MF for updating a media context. The consumer sends a PATCH request to the MF. The MF responds with one of three options: 2a. 204 No Content, 2b. 200 OK (MediaContext), or 2c. 4xx/5xx (ProblemDetails) or 3xx.](ec98c4d2d93f28dfc8eb9d5e5730f62d_img.jpg)
397
+
398
+ ```
399
+
400
+ sequenceDiagram
401
+ participant NF Service Consumer
402
+ participant MF
403
+ Note left of NF Service Consumer: Update a media context
404
+ NF Service Consumer->>MF: 1. PATCH .../contexts/{contextId} (PatchData)
405
+ MF-->>NF Service Consumer: 2a. 204 No Content
406
+ MF-->>NF Service Consumer: 2b. 200 OK (MediaContext)
407
+ MF-->>NF Service Consumer: 2c. 4xx/5xx (ProblemDetails) or 3xx
408
+
409
+ ```
410
+
411
+ Sequence diagram showing the interaction between an NF Service Consumer and an MF for updating a media context. The consumer sends a PATCH request to the MF. The MF responds with one of three options: 2a. 204 No Content, 2b. 200 OK (MediaContext), or 2c. 4xx/5xx (ProblemDetails) or 3xx.
412
+
413
+ Figure 5.2.2.3.2-1 Update a media context
414
+
415
+ 1. The NF Service Consumer shall send a PATCH request to modify a context resource in the MF. The modification may be for adding, updating or deleting terminations of the existing media context.
416
+
417
+ For adding, removing or updating a termination in an existing MediaContext, the payload body of the PATCH request shall contain an "add", "remove" or "replace" PATCH operation respectively, with one item of the attribute "terminations" of the MediaContext.
418
+
419
+ - 2a. On success, if the change is to delete the existing termination and MF accepts the request change, the MF shall return the status code 204 No Content.
420
+ - 2b. On success, if the change is to add a new termination or to update the existing termination and DCMF accepts the request change, the MF shall return the status code 200 OK. The response shall contain the new resource representation of the resource Individual Context, which includes the added and modified resource or its sub-resource.
421
+ - 2c On failure, one of the HTTP status code listed in Table 6.1.3.3.3.1-3 indicating the error shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.3.1-3.
422
+
423
+ On redirection, the MF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint to another MF (service) instance.
424
+
425
+ #### 5.2.2.4 Nmf\_MRM\_Delete Service Operation
426
+
427
+ ##### 5.2.2.4.1 General
428
+
429
+ The Nmf\_MRM\_Delete service operation is used by an NF service consumer to delete an existing media context including all existing terminations and medias on MF previously created by itself.
430
+
431
+ ##### 5.2.2.4.2 Deleting an existing media context
432
+
433
+ The NF Service Consumer shall delete an existing context by using HTTP method DELETE with the URI "{apiRoot}/nmf/<apiVersion>/contexts/{contextId}" as resource URI representing the "Individual Context ", see clause 6.1.3.3.
434
+
435
+ ![Sequence diagram showing the interaction between an NF Service Consumer and an MF for deleting a media context. The consumer sends a DELETE request to the MF. The MF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (redirection) response.](af6be343f0c0a8f155f965dcf337b8af_img.jpg)
436
+
437
+ ```
438
+
439
+ sequenceDiagram
440
+ participant NF Service Consumer
441
+ participant MF
442
+ Note left of NF Service Consumer: 1. DELETE .../contexts/{contextId}
443
+ NF Service Consumer->>MF: 1. DELETE .../contexts/{contextId}
444
+ Note right of MF: -2a. 204 No Content
445
+ MF-->>NF Service Consumer: -2a. 204 No Content
446
+ Note right of MF: 2b. 4xx/5xx (ProblemDetails) or 3xx
447
+ MF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx
448
+
449
+ ```
450
+
451
+ Sequence diagram showing the interaction between an NF Service Consumer and an MF for deleting a media context. The consumer sends a DELETE request to the MF. The MF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (redirection) response.
452
+
453
+ Figure 5.2.2.4.2-1 Delete a media context
454
+
455
+ - 1. The NF Service Consumer shall send a DELETE request to delete an existing context resource in the MF.
456
+ - 2a. On success, the request is accepted, the MF shall reply with the status code 204 No Content indicating the resource identified by context ID is successfully deleted in the response message.
457
+ - 2b. On failure, one of the HTTP status code listed in Table 6.1.3.3.3.2-3 indicating the error shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.3.2-3.
458
+
459
+ On redirection, the MF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint to another MF (service) instance.
460
+
461
+ # 6 API Definitions
462
+
463
+ ## 6.1 Nmf\_MRM Service API
464
+
465
+ ### 6.1.1 Introduction
466
+
467
+ The Nmf\_MRM service shall use the Ndcmf\_MRM API.
468
+
469
+ The API URI of the Nmf\_MRM API shall be:
470
+
471
+ **{apiRoot}</apiName></apiVersion>**
472
+
473
+ The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
474
+
475
+ **{apiRoot}</apiName></apiVersion></apiSpecificResourceUriPart>**
476
+
477
+ with the following components:
478
+
479
+ - The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
480
+ - The <apiName> shall be " nmf\_mrm".
481
+ - The <apiVersion> shall be "v1".
482
+ - The <apiSpecificResourceUriPart> shall be set as described in clause 6.1.3.
483
+
484
+ ### 6.1.2 Usage of HTTP
485
+
486
+ #### 6.1.2.1 General
487
+
488
+ HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
489
+
490
+ HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
491
+
492
+ The OpenAPI [6] specification of HTTP messages and content bodies for the Nmf\_MRM API is contained in Annex A.
493
+
494
+ #### 6.1.2.2 HTTP standard headers
495
+
496
+ ##### 6.1.2.2.1 General
497
+
498
+ See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers.
499
+
500
+ ##### 6.1.2.2.2 Content type
501
+
502
+ JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json".
503
+
504
+ "Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13].
505
+
506
+ The use of JSON Patch (IETF RFC 6902 [15]) format in a HTTP request body shall be signaled by the content type "application/json-patch+json".
507
+
508
+ #### 6.1.2.3 HTTP custom headers
509
+
510
+ The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported.
511
+
512
+ ### 6.1.3 Resources
513
+
514
+ #### 6.1.3.1 Overview
515
+
516
+ This clause describes the structure for the Resource URIs and the resources and methods used for the service.
517
+
518
+ Figure 6.1.3.1-1 depicts the resource URIs structure for the Nmf\_MRM API.
519
+
520
+ ![Diagram showing the resource URI structure for the Nmf_MRM API. The root is {apiRoot}/nmf-mrm/<apiVersion>. It branches to /contexts, which then branches to /{contextId}.](16c1175b5f05a4b55e6d396fc51b15b3_img.jpg)
521
+
522
+ ```
523
+
524
+ graph TD
525
+ Root["{apiRoot}/nmf-mrm/<apiVersion>"] --> Contexts["/contexts"]
526
+ Contexts --> ContextId["/{contextId}"]
527
+
528
+ ```
529
+
530
+ Diagram showing the resource URI structure for the Nmf\_MRM API. The root is {apiRoot}/nmf-mrm/. It branches to /contexts, which then branches to /{contextId}.
531
+
532
+ **Figure 6.1.3.1-1: Resource URI structure of the Nmf\_MRM API**
533
+
534
+ Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.
535
+
536
+ **Table 6.1.3.1-1: Resources and methods overview**
537
+
538
+ | Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) |
539
+ |-----------------------|--------------------------------------------|---------------------------------|----------------------------------------------------------------------------|
540
+ | Contexts Collection | /contexts | POST | Creates a new Individual Context resource. |
541
+ | Individual Context | /contexts/{contextId} | PATCH | Updates an existing Individual Context resource identified by {contextId} |
542
+ | | | DELETE | Deletes an existing Individual Context resource identified by {contextId}. |
543
+
544
+ #### 6.1.3.2 Resource: Contexts Collection
545
+
546
+ ##### 6.1.3.2.1 Description
547
+
548
+ The Contexts Collection resource represents a collection of contexts created by NF service consumers of Nmf\_MRM service at a given MF. The resource is modelled as Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [2]).
549
+
550
+ ##### 6.1.3.2.2 Resource Definition
551
+
552
+ Resource URI: {apiRoot}/ nmf\_mrm/<apiVersion>/contexts
553
+
554
+ This resource shall support the resource URI variables defined in table 6.1.3.2.2-1.
555
+
556
+ **Table 6.1.3.2.2-1: Resource URI variables for this resource**
557
+
558
+ | Name | Data type | Definition |
559
+ |---------|-----------|------------------|
560
+ | apiRoot | string | See clause 6.1.1 |
561
+
562
+ ##### 6.1.3.2.3 Resource Standard Methods
563
+
564
+ ###### 6.1.3.2.3.1 POST
565
+
566
+ This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1.
567
+
568
+ **Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource**
569
+
570
+ | Name | Data type | P | Cardinality | Description | Applicability |
571
+ |------|-----------|---|-------------|-------------|---------------|
572
+ | n/a | | | | | |
573
+
574
+ This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3.
575
+
576
+ **Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource**
577
+
578
+ | Data type | P | Cardinality | Description |
579
+ |--------------|---|-------------|-------------------------------------------|
580
+ | MediaContext | M | 1 | Creates a new Individual Context resource |
581
+
582
+ **Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource**
583
+
584
+ | Data type | P | Cardinality | Response codes | Description |
585
+ |------------------|---|-------------|---------------------------|----------------------------------------------------------------------------------------------------------------------|
586
+ | MediaContext | M | 1 | 201<br>Created | The creation of an Individual Media Context resource is confirmed and a representation of that resource is returned. |
587
+ | RedirectResponse | O | 0..1 | 307<br>Temporary Redirect | Temporary redirection. (NOTE 2) |
588
+ | RedirectResponse | O | 0..1 | 308<br>Permanent Redirect | Permanent redirection. (NOTE 2) |
589
+
590
+ NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.
591
+ NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].
592
+
593
+ **Table 6.1.3.2.3.1-4: Headers supported by the 201 response code on this resource**
594
+
595
+ | Name | Data type | P | Cardinality | Description |
596
+ |----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------|
597
+ | Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nfmf-mrm/<apiVersion>/contexts/{contextId}. |
598
+
599
+ **Table 6.1.3.2.3.1-5: Headers supported by the 307 Response Code on this resource**
600
+
601
+ | Name | Data type | P | Cardinality | Description |
602
+ |-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
603
+ | Location | string | M | 1 | An alternative URI of the resource located on an alternative MF (service) instance.<br>Or the same URI, if a request is redirected to the same target resource via a different SCP. |
604
+ | 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MF instance ID towards which the request is redirected. |
605
+
606
+ **Table 6.1.3.2.3.1-6: Headers supported by the 308 Response Code on this resource**
607
+
608
+ | Name | Data type | P | Cardinality | Description |
609
+ |-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
610
+ | Location | string | M | 1 | An alternative URI of the resource located on an alternative MF (service) instance.<br>Or the same URI, if a request is redirected to the same target resource via a different SCP. |
611
+ | 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MF instance ID towards which the request is redirected. |
612
+
613
+ ##### 6.1.3.2.4 Resource Custom Operations
614
+
615
+ None in the release of this specification.
616
+
617
+ #### 6.1.3.3 Resource: Individual Context
618
+
619
+ ##### 6.1.3.3.1 Description
620
+
621
+ The Individual Context resource represents an individual context created by the NF service consumers of Nmf\_MRM service at a given MF. This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [2]).
622
+
623
+ ##### 6.1.3.3.2 Resource Definition
624
+
625
+ Resource URI: {apiRoot}/nmf\_mrm/<apiVersion>/contexts/{contextId}
626
+
627
+ The <apiVersion> shall be set as described in clause 6.3.1.
628
+
629
+ This resource shall support the resource URI variables defined in table 6.1.3.3.2-1.
630
+
631
+ **Table 6.1.3.3.2-1: Resource URI variables for this resource**
632
+
633
+ | Name | Data type | Definition |
634
+ |-----------|-----------|----------------------------------------------------------|
635
+ | apiRoot | string | See clause 6.1.1 |
636
+ | contextId | string | Identifies an individual context to the Nmf_MRM service. |
637
+
638
+ ##### 6.1.3.3.3 Resource Standard Methods
639
+
640
+ ###### 6.1.3.3.3.1 PATCH
641
+
642
+ This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1.
643
+
644
+ **Table 6.1.3.3.3.1-1: URI query parameters supported by the PATCH method on this resource**
645
+
646
+ | Name | Data type | P | Cardinality | Description | Applicability |
647
+ |------|-----------|---|-------------|-------------|---------------|
648
+ | n/a | | | | | |
649
+
650
+ This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3.
651
+
652
+ **Table 6.1.3.3.3.1-2: Data structures supported by the PATCH Request Body on this resource**
653
+
654
+ | Data type | P | Cardinality | Description |
655
+ |------------------|---|-------------|---------------------------------------------------------------------------|
656
+ | array(PatchItem) | M | 1..N | Document describes the modification(s) to an Individual Context resource. |
657
+
658
+ **Table 6.1.3.3.3.1-3: Data structures supported by the PATCH Response Body on this resource**
659
+
660
+ | Data type | P | Cardinality | Response codes | Description |
661
+ |------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
662
+ | MediaContext | M | 1..N | 200 OK | Represents a successful update on the media context. |
663
+ | n/a | | | 204 No Content | |
664
+ | RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) |
665
+ | RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) |
666
+ | ProblemDetails | O | 0..1 | 403 Forbidden | Indicates the modification of media context has failed due to application error.<br><br>The "cause" attribute may be used to indicate one of the following application errors:<br>- MEDIA_ID_CONFLICT<br>- MEDIA_CONNECTION_CHANGED |
667
+ | ProblemDetails | O | 0..1 | 404 Not Found | Indicates the modification of media context has failed due to application error.<br><br>The "cause" attribute may be used to indicate one of the following application errors:<br>- CONTEXT_NOT_FOUND |
668
+
669
+ NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.
670
+ NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].
671
+
672
+ **Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource**
673
+
674
+ | Name | Data type | P | Cardinality | Description |
675
+ |-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
676
+ | Location | string | M | 1 | An alternative URI of the resource located on an alternative MF (service) instance.<br>Or the same URI, if a request is redirected to the same target resource via a different SCP. |
677
+ | 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MF instance ID towards which the request is redirected. |
678
+
679
+ **Table 6.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource**
680
+
681
+ | Name | Data type | P | Cardinality | Description |
682
+ |-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
683
+ | Location | string | M | 1 | An alternative URI of the resource located on an alternative MF (service) instance.<br>Or the same URI, if a request is redirected to the same target resource via a different SCP. |
684
+ | 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MF instance ID towards which the request is redirected. |
685
+
686
+ ###### 6.1.3.3.3.2 DELETE
687
+
688
+ This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1.
689
+
690
+ **Table 6.1.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource**
691
+
692
+ | Name | Data type | P | Cardinality | Description | Applicability |
693
+ |------|-----------|---|-------------|-------------|---------------|
694
+ | n/a | | | | | |
695
+
696
+ This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3.
697
+
698
+ **Table 6.1.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource**
699
+
700
+ | Data type | P | Cardinality | Description |
701
+ |-----------|---|-------------|-------------|
702
+ | n/a | | | |
703
+
704
+ **Table 6.1.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource**
705
+
706
+ | Data type | P | Cardinality | Response codes | Description |
707
+ |------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
708
+ | n/a | | | 204 No content | |
709
+ | RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) |
710
+ | RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) |
711
+ | Problem Details | O | 0..1 | 404 Not Found | Indicates the deletion of the context has failed due to application error.<br><br>The "cause" attribute may be used to indicate one of the following application errors:<br>- CONTEXT NOT FOUND |
712
+
713
+ NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.
714
+ NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].
715
+
716
+ **Table 6.1.3.3.3.2-4: Headers supported by the 307 Response Code on this resource**
717
+
718
+ | Name | Data type | P | Cardinality | Description |
719
+ |-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
720
+ | Location | string | M | 1 | An alternative URI of the resource located on an alternative MF (service) instance.<br>Or the same URI, if a request is redirected to the same target resource via a different SCP. |
721
+ | 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MF instance ID towards which the request is redirected. |
722
+
723
+ **Table 6.1.3.3.3.2-5: Headers supported by the 308 Response Code on this resource**
724
+
725
+ | Name | Data type | P | Cardinality | Description |
726
+ |-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
727
+ | Location | string | M | 1 | An alternative URI of the resource located on an alternative MF (service) instance.<br>Or the same URI, if a request is redirected to the same target resource via a different SCP. |
728
+ | 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MF instance ID towards which the request is redirected. |
729
+
730
+ ##### 6.1.3.3.4 Resource Custom Operations
731
+
732
+ None in the release of specification.
733
+
734
+ ### 6.1.4 Custom Operations without associated resources
735
+
736
+ None in this release of specification.
737
+
738
+ ### 6.1.5 Notifications
739
+
740
+ None in this release of specification.
741
+
742
+ ### 6.1.6 Data Model
743
+
744
+ #### 6.1.6.1 General
745
+
746
+ This clause specifies the application data model supported by the API.
747
+
748
+ Table 6.1.6.1-1 specifies the data types defined for the Nmf\_MRM service based interface protocol.
749
+
750
+ **Table 6.1.6.1-1: Nmf\_MRM specific Data Types**
751
+
752
+ | Data type | Clause defined | Description | Applicability |
753
+ |-----------------|----------------|--------------------------------------------------|---------------|
754
+ | MediaContext | 6.1.6.2.2 | Represents an individual context resource on MF. | |
755
+ | TerminationInfo | 6.1.6.2.3 | Represents the termination information. | |
756
+ | MediaInfo | 6.1.6.2.4 | Represents the media Information. | |
757
+ | DcMedia | 6.1.6.2.5 | Represents the DC media descriptor. | |
758
+ | ArMedia | 6.1.6.2.6 | Represents the AR media descriptor. | |
759
+
760
+ Table 6.1.6.1-2 specifies data types re-used by the Nmf\_MRM service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nmf\_MRM service based interface.
761
+
762
+ **Table 6.1.6.1-2: Nmf\_MRM re-used Data Types**
763
+
764
+ | Data type | Reference | Comments | Applicability |
765
+ |-------------------|---------------------|-----------------------------------------------------------|---------------|
766
+ | ProblemDetails | 3GPP TS 29.571 [16] | Problem Details | |
767
+ | MediaId | 3GPP TS 29.571 [16] | Uniquely identifies one media flow within an IMS session. | |
768
+ | MaxMessageSize | 3GPP TS 29.571 [16] | Max SCTP user message size. | |
769
+ | MediaResourceType | 3GPP TS 29.571 [16] | Media resource types. | |
770
+ | MediaProxy | 3GPP TS 29.571 [16] | Media proxy configuration applicable to the media flow | |
771
+ | SecuritySetup | 3GPP TS 29.571 [16] | Security setup of the DTLS association. | |
772
+ | DcEndpoint | 3GPP TS 29.571 [16] | DC endpoint | |
773
+ | DcStream | 3GPP TS 29.571 [16] | Data channel stream information. | |
774
+ | ReplaceHttpUrl | 3GPP TS 29.571 [16] | Replacement HTTP URL allocated by the application layer. | |
775
+ | Uri | 3GPP TS 29.571 [16] | Uri | |
776
+ | Endpoint | 3GPP TS 29.571 [16] | Represents the IP endpoint. | Endpoint |
777
+
778
+ #### 6.1.6.2 Structured data types
779
+
780
+ ##### 6.1.6.2.1 Introduction
781
+
782
+ This clause defines the structures to be used in resource representations.
783
+
784
+ ##### 6.1.6.2.2 Type: MediaContext
785
+
786
+ Table 6.1.6.2.2-1: Definition of type MediaContext
787
+
788
+ | Attribute name | Data type | P | Cardinality | Description | Applicability |
789
+ |----------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------|---------------|
790
+ | contextId | string | C | 0..1 | Identifies a specific context. It is assigned by the MF when creating a new context, i.e. Nmf_MRM_Create operation. | |
791
+ | terminations | array(TerminationInfo) | M | 1..N | Represents the media terminations | |
792
+
793
+ ##### 6.1.6.2.3 Type: TerminationInfo
794
+
795
+ Table 6.1.6.2.3-1: Definition of type TerminationInfo
796
+
797
+ | Attribute name | Data type | P | Cardinality | Description | Applicability |
798
+ |----------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
799
+ | terminationId | string | C | 0..1 | Identifies a specific media termination. It is assigned by the MF when creating a new termination. It shall be included in the response of adding a new media termination, i.e., the Nmf_MRM_Create operation and in the Nmf_MRM_Update operation with adding a new termination. | |
800
+ | medias | array(MediaInfo) | M | 1..N | Represent the list of media resources for one or multiple medias on the Mb interface. | |
801
+
802
+ ##### 6.1.6.2.4 Type: MediaInfo
803
+
804
+ Table 6.1.6.2.4-1: Definition of type MediaInfo
805
+
806
+ | Attribute name | Data type | P | Cardinality | Description | Applicability |
807
+ |--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
808
+ | mediaId | string | M | 1 | Identifies a media stream, e.g. data channel. | |
809
+ | mediaResourceType | MediaResourceType | M | 1 | Represents the media resource type, e.g. DC, AR. | |
810
+ | localMbEndpoint | Endpoint | C | 0..1 | Represents the local IP address and port number of the local endpoint of MF on the Mb interface.<br>It will be allocated by MF.<br>It shall be contained in the response when creating a new media stream, i.e. Nmf_MRM_Create operation or Nmf_MRM_Update operation with adding a new termination or adding a media in an existing termination. (NOTE 1, NOTE 2) | |
811
+ | remoteMbEndpoint | Endpoint | C | 0..1 | Represents the IP address and port number of the remote endpoint on the Mb interface, e.g. remote UE.<br>It shall be contained in the request of creating a new media stream, i.e. Nmf_MRM_Create operation or Nmf_MRM_Update operation with adding a new termination or adding a media in an existing termination. It can be Null when originating a new media. (NOTE 1, NOTE 2) | |
812
+ | dcMedia | DcMedia | C | 0..1 | Represents the data channel media descriptors. It shall be contained if the mediaResourceType is set to "DC". | |
813
+ | arMedia | ArMedia | C | 0..1 | Represents the AR media descriptors. It shall be contained if the mediaResourceType is set to "AR". | |
814
+ | mediaProcessingURL | Uri | C | 0..1 | The mediaProcessingURL indicates the address where MF receive service-related media instructions. It shall be contained in the response when creating a new media stream, i.e. Nmf_MRM_Create operation or Nmf_MRM_Update operation with adding a new termination or adding a media in an existing termination. (NOTE 1) | |
815
+
816
+ NOTE 1: The IE cannot be changed once the media has been established.
817
+
818
+ NOTE 2: The attribute "transport" inside Endpoint data type shall be set to value only "UDP".
819
+
820
+ ##### 6.1.6.2.5 Type: DcMedia
821
+
822
+ **Table 6.1.6.2.5-1: Definition of type DcMedia**
823
+
824
+ | Attribute name | Data type | P | Cardinality | Description | Applicability |
825
+ |--------------------|-------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
826
+ | mediaProxyConfig | MediaProxy | C | 0..1 | Represents the media proxy configuration. It shall be included if the mediald represents bootstrap or P2A/A2P application data channels. | |
827
+ | replaceHttpUrl | Map(ReplacementHttpUrl) | C | 0..1 | A map (list of key-value pairs where streamId is used as key of the map) of ReplacementHttpUrl.<br>Represents URL for the specific IMS subscriber when requesting the application list (e.g. graphical user interface) via the MDC1 interface. It shall be included if the mediald represents bootstrap data channel and streamId is 0 and 100. | |
828
+ | remoteMdc1Endpoint | Endpoint | C | 0..1 | Represents the remote MDC1 media endpoint information, i.e. the IP address and port number of DCSF. It shall be included if the mediald represents a bootstrap data channel. | |
829
+ | remoteMdc2Endpoint | Endpoint | C | 0..1 | Represents the remote MDC2 media endpoint address, i.e. the IP address and port number of DC AS. It shall be included if the mediald represents a P2A/A2P application data channel and the mediaProxyConfig is set to "HTTP". | |
830
+ | localMdc1Endpoint | Endpoint | C | 0..1 | Represents the local MF MDC1 media endpoint information. It will be allocated by MF and contained in the response when the mediald represents a bootstrap data channel. | |
831
+ | localMdc2Endpoint | Endpoint | C | 0..1 | Represents the local MF MDC2 media endpoint information. It will be allocated by MF and contained in the response when the mediald represents a P2A/A2P application data channel. | |
832
+ | mdc2Protocol | string | O | 0..1 | Represents the transport layer protocols for MDC2 interface. It may be included when mediaProxyConfig is set "HTTP" and remoteMdc2Endpoint is present. This IE is formatted as the following pattern, for example:<br>'UDP/DTLS/SCTP' | |
833
+ | streams | map(DcStream) | M | 1..N | A map (list of key-value pairs where streamId is used as key of the map) of DcStream.<br>Represents the data channel mapping and configuration information when originating/terminating data channel media flows on the Mb interface. | |
834
+ | maxMessageSize | MaxMessageSize | O | 0..1 | Represents the maximum size of to be expected. | |
835
+ | localDcEndpoint | DcEndpoint | C | 0..1 | Represents the DC endpoint for the Data Channel.<br>It will be allocated by MF.<br>It shall be contained in the response when creating a new media stream, i.e. Nmf_MRM_Create operation or Nmf_MRM_Update operation with adding a new termination or adding a media in an existing termination. (NOTE) | |
836
+
837
+ | | | | | | |
838
+ |---------------------------------------------------------------------|---------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|
839
+ | remoteDcEndpoint | DcEndpoint | C | 0..1 | Represents the DC Endpoint for the Data Channel on the Mb interface. It shall be contained in the request of creating a new media stream, i.e. Nmf_MRM_Create operation or Nmf_MRM_Update operation with adding a new termination or adding a media in an existing termination. It can be NULL when originating a data channel media. (NOTE) | |
840
+ | securitySetup | SecuritySetup | O | 0..1 | Represents the security set up of the DTLS association. | |
841
+ | NOTE: The IE cannot be changed once the media has been established. | | | | | |
842
+
843
+ ##### 6.1.6.2.6 Type: ArMedia
844
+
845
+ **Table 6.1.6.2.6-1: Definition of type ArMedia**
846
+
847
+ | Attribute name | Data type | P | Cardinality | Description | Applicability |
848
+ |----------------|-----------|---|-------------|-------------|---------------|
849
+ | | | | | | |
850
+
851
+ Editor's note: The definition of ArMedia is FFS.
852
+
853
+ #### 6.1.6.3 Simple data types and enumerations
854
+
855
+ ##### 6.1.6.3.1 Introduction
856
+
857
+ This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
858
+
859
+ ##### 6.1.6.3.2 Simple data types
860
+
861
+ The simple data types defined in table 6.1.6.3.2-1 shall be supported.
862
+
863
+ **Table 6.1.6.3.2-1: Simple data types**
864
+
865
+ | Type Name | Type Definition | Description | Applicability |
866
+ |-----------|-----------------|-------------|---------------|
867
+ | | | | |
868
+
869
+ ### 6.1.7 Error Handling
870
+
871
+ #### 6.1.7.1 General
872
+
873
+ For the Nmf\_MRM API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4].
874
+
875
+ In addition, the requirements in the following clauses are applicable for the Nmf\_MRM API.
876
+
877
+ #### 6.1.7.2 Protocol Errors
878
+
879
+ No specific procedures for the Nmf\_MRM service are specified.
880
+
881
+ #### 6.1.7.3 Application Errors
882
+
883
+ The application errors defined for the Nmf\_MRM service are listed in Table 6.1.7.3-1.
884
+
885
+ **Table 6.1.7.3-1: Application errors**
886
+
887
+ | Application Error | HTTP status code | Description |
888
+ |--------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
889
+ | CONTEXT_NOT_FOUND | 404 Not Found | Indicates that the requested context is not found in the MF. |
890
+ | MEDIA_ID_CONFLICT | 403 Forbidden | Indicates that mediald which identifies the newly added media has existed within the specific termination. |
891
+ | MEDIA_CONNECTION_CHANGED | 403 Forbidden | Indicates that the connection information which has been marked that cannot be changed once the media has established is changed in the request. including the remoteMbEndpoint, localMbEndpoint etc. |
892
+
893
+ ### 6.1.8 Feature negotiation
894
+
895
+ The optional features in table 6.1.8-1 are defined for the Nmf\_MRM API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4].
896
+
897
+ **Table 6.1.8-1: Supported Features**
898
+
899
+ | Feature number | Feature Name | Description |
900
+ |----------------|--------------|-------------|
901
+ | | | |
902
+
903
+ ### 6.1.9 Security
904
+
905
+ As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nmf\_MRM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server.
906
+
907
+ If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nmf\_MRM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2.
908
+
909
+ NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nmf\_MRM service.
910
+
911
+ The Nmf\_MRM API defines a single scope "nmf-mrm" for the entire service, and it does not define any additional scopes at resource or operation level.
912
+
913
+ ### 6.1.10 HTTP redirection
914
+
915
+ An HTTP request may be redirected to a different MF service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]).
916
+
917
+ An SCP that reselects a different MF producer instance will return the NF Instance ID of the new MF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4].
918
+
919
+ If an MF redirects a service request to a different MF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new MF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4].
920
+
921
+ # Annex A (normative): OpenAPI specification
922
+
923
+ ## A.1 General
924
+
925
+ This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format.
926
+
927
+ This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s).
928
+
929
+ NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply.
930
+
931
+ Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [5] and clause 5B of 3GPP TR 21.900 [7]).
932
+
933
+ ## A.2 Ndcnf\_MRM API
934
+
935
+ ```
936
+ openapi: 3.0.0
937
+
938
+ info:
939
+ title: 'MF Media Resource Management (MRM) Service'
940
+ version: 1.0.0-alpha.1
941
+ description: |
942
+ MF Media Resource Management (MRM) Service.
943
+ © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
944
+ All rights reserved.
945
+
946
+ externalDocs:
947
+ description: >
948
+ 3GPP TS 29.176 V18.0.0; IP Multimedia Subsystem (IMS); Media Function (MF) Services; Stage 3.
949
+ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.176/
950
+
951
+ servers:
952
+ - url: '{apiRoot}/nmf-mrm/v1'
953
+ variables:
954
+ apiRoot:
955
+ default: https://example.com
956
+ description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
957
+
958
+ security:
959
+ - {}
960
+ - oAuth2ClientCredentials:
961
+ - nmf-mrm
962
+
963
+ paths:
964
+
965
+ /contexts:
966
+ post:
967
+ summary: Create a new media context.
968
+ operationId: CreateMediaContext
969
+ tags:
970
+ - MediaContext(Collection)
971
+ requestBody:
972
+ required: true
973
+ content:
974
+ application/json:
975
+ schema:
976
+ $ref: '#/components/schemas/MediaContext'
977
+ responses:
978
+ '201':
979
+ description: Success
980
+ content:
981
+ ```
982
+
983
+ ```
984
+
985
+ application/json:
986
+ schema:
987
+ $ref: '#/components/schemas/MediaContext'
988
+ headers:
989
+ Location:
990
+ description: >
991
+ Contains the URI of the newly created resource, according to the structure:
992
+ {apiRoot}/nmf-mrm/<version>/contexts/{contextId}
993
+ required: true
994
+ schema:
995
+ type: string
996
+ '307':
997
+ description: Temporary Redirect
998
+ content:
999
+ application/json:
1000
+ schema:
1001
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
1002
+ headers:
1003
+ Location:
1004
+ description: The URI pointing to the resource located on the redirect target MF.
1005
+ required: true
1006
+ schema:
1007
+ type: string
1008
+ '308':
1009
+ description: Permanent Redirect
1010
+ content:
1011
+ application/json:
1012
+ schema:
1013
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
1014
+ headers:
1015
+ Location:
1016
+ description: The URI pointing to the resource located on the redirect target MF.
1017
+ required: true
1018
+ schema:
1019
+ type: string
1020
+ '400':
1021
+ $ref: 'TS29571_CommonData.yaml#/components/responses/400'
1022
+ '401':
1023
+ $ref: 'TS29571_CommonData.yaml#/components/responses/401'
1024
+ '403':
1025
+ $ref: 'TS29571_CommonData.yaml#/components/responses/403'
1026
+ '404':
1027
+ $ref: 'TS29571_CommonData.yaml#/components/responses/404'
1028
+ '411':
1029
+ $ref: 'TS29571_CommonData.yaml#/components/responses/411'
1030
+ '413':
1031
+ $ref: 'TS29571_CommonData.yaml#/components/responses/413'
1032
+ '415':
1033
+ $ref: 'TS29571_CommonData.yaml#/components/responses/415'
1034
+ '429':
1035
+ $ref: 'TS29571_CommonData.yaml#/components/responses/429'
1036
+ '500':
1037
+ $ref: 'TS29571_CommonData.yaml#/components/responses/500'
1038
+ '503':
1039
+ $ref: 'TS29571_CommonData.yaml#/components/responses/503'
1040
+ default:
1041
+ $ref: 'TS29571_CommonData.yaml#/components/responses/default'
1042
+
1043
+ /contexts/{contextId}:
1044
+
1045
+ patch:
1046
+ summary: Update Media Context
1047
+ operationId: UpdateMediaContext
1048
+ tags:
1049
+ - Media Context ID (Document)
1050
+ parameters:
1051
+ - name: contextId
1052
+ in: path
1053
+ required: true
1054
+ description: Unique ID of the Media Context to update.
1055
+ schema:
1056
+ type: string
1057
+ requestBody:
1058
+ content:
1059
+ application/json-patch+json:
1060
+ schema:
1061
+ type: array
1062
+ items:
1063
+
1064
+ ```
1065
+
1066
+ ```
1067
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem'
1068
+ minItems: 1
1069
+ required: true
1070
+ responses:
1071
+ '200':
1072
+ description: Expected response to a valid request.
1073
+ content:
1074
+ application/json:
1075
+ schema:
1076
+ $ref: '#/components/schemas/MediaContext'
1077
+ '204':
1078
+ description: Expected response with empty body
1079
+ '307':
1080
+ description: Temporary Redirect
1081
+ content:
1082
+ application/json:
1083
+ schema:
1084
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
1085
+ headers:
1086
+ Location:
1087
+ description: The URI pointing to the resource located on the redirect target MF.
1088
+ required: true
1089
+ schema:
1090
+ type: string
1091
+ '308':
1092
+ description: Permanent Redirect
1093
+ content:
1094
+ application/json:
1095
+ schema:
1096
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
1097
+ headers:
1098
+ Location:
1099
+ description: The URI pointing to the resource located on the redirect target MF.
1100
+ required: true
1101
+ schema:
1102
+ type: string
1103
+ '400':
1104
+ $ref: 'TS29571_CommonData.yaml#/components/responses/400'
1105
+ '403':
1106
+ $ref: 'TS29571_CommonData.yaml#/components/responses/403'
1107
+ '404':
1108
+ $ref: 'TS29571_CommonData.yaml#/components/responses/404'
1109
+ '409':
1110
+ $ref: 'TS29571_CommonData.yaml#/components/responses/409'
1111
+ '411':
1112
+ $ref: 'TS29571_CommonData.yaml#/components/responses/411'
1113
+ '412':
1114
+ $ref: 'TS29571_CommonData.yaml#/components/responses/412'
1115
+ '413':
1116
+ $ref: 'TS29571_CommonData.yaml#/components/responses/413'
1117
+ '415':
1118
+ $ref: 'TS29571_CommonData.yaml#/components/responses/415'
1119
+ '429':
1120
+ $ref: 'TS29571_CommonData.yaml#/components/responses/429'
1121
+ '500':
1122
+ $ref: 'TS29571_CommonData.yaml#/components/responses/500'
1123
+ '501':
1124
+ $ref: 'TS29571_CommonData.yaml#/components/responses/501'
1125
+ '503':
1126
+ $ref: 'TS29571_CommonData.yaml#/components/responses/503'
1127
+ default:
1128
+ $ref: 'TS29571_CommonData.yaml#/components/responses/default'
1129
+
1130
+ delete:
1131
+ summary: Deletes a given Media Context
1132
+ operationId: DeleteMediaContext
1133
+ tags:
1134
+ - Media Context ID (Document)
1135
+ parameters:
1136
+ - name: contextId
1137
+ in: path
1138
+ required: true
1139
+ description: Unique ID of the Media Context to delete.
1140
+ schema:
1141
+ type: string
1142
+ responses:
1143
+ '204':
1144
+ description: Expected response to a successful deletion.
1145
+ ```
1146
+
1147
+ ```
1148
+ '307':
1149
+ description: Temporary Redirect
1150
+ content:
1151
+ application/json:
1152
+ schema:
1153
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
1154
+ headers:
1155
+ Location:
1156
+ description: The URI pointing to the resource located on the redirect target NRF.
1157
+ required: true
1158
+ schema:
1159
+ type: string
1160
+ '308':
1161
+ description: Permanent Redirect
1162
+ content:
1163
+ application/json:
1164
+ schema:
1165
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
1166
+ headers:
1167
+ Location:
1168
+ description: The URI pointing to the resource located on the redirect target NRF.
1169
+ required: true
1170
+ schema:
1171
+ type: string
1172
+ '400':
1173
+ $ref: 'TS29571_CommonData.yaml#/components/responses/400'
1174
+ '401':
1175
+ $ref: 'TS29571_CommonData.yaml#/components/responses/401'
1176
+ '403':
1177
+ $ref: 'TS29571_CommonData.yaml#/components/responses/403'
1178
+ '404':
1179
+ $ref: 'TS29571_CommonData.yaml#/components/responses/404'
1180
+ '411':
1181
+ $ref: 'TS29571_CommonData.yaml#/components/responses/411'
1182
+ '429':
1183
+ $ref: 'TS29571_CommonData.yaml#/components/responses/429'
1184
+ '500':
1185
+ $ref: 'TS29571_CommonData.yaml#/components/responses/500'
1186
+ '501':
1187
+ $ref: 'TS29571_CommonData.yaml#/components/responses/501'
1188
+ '503':
1189
+ $ref: 'TS29571_CommonData.yaml#/components/responses/503'
1190
+ default:
1191
+ $ref: 'TS29571_CommonData.yaml#/components/responses/default'
1192
+ ```
1193
+
1194
+ ### components:
1195
+
1196
+ ```
1197
+ securitySchemes:
1198
+ oAuth2ClientCredentials:
1199
+ type: oauth2
1200
+ flows:
1201
+ clientCredentials:
1202
+ tokenUrl: '{nrfApiRoot}/oauth2/token'
1203
+ scopes:
1204
+ nmf-mrm: Access to the Nmf_MRM API.
1205
+ ```
1206
+
1207
+ ### schemas:
1208
+
1209
+ ```
1210
+ MediaContext:
1211
+ description: Information of a Media Context in a MF.
1212
+ type: object
1213
+ required:
1214
+ - terminations
1215
+ properties:
1216
+ contextId:
1217
+ type: string
1218
+ terminations:
1219
+ type: array
1220
+ items:
1221
+ $ref: '#/components/schemas/TerminationInfo'
1222
+ minItems: 1
1223
+
1224
+ TerminationInfo:
1225
+ description: Represents the termination information.
1226
+ type: object
1227
+ required:
1228
+ - medias
1229
+ properties:
1230
+ ```
1231
+
1232
+ ```
1233
+ terminationId:
1234
+ type: string
1235
+ medias:
1236
+ type: array
1237
+ items:
1238
+ $ref: '#/components/schemas/MediaInfo'
1239
+ minItems: 1
1240
+
1241
+ MediaInfo:
1242
+ description: Represents the media information.
1243
+ type: object
1244
+ required:
1245
+ - mediaId
1246
+ - mediaResourceType
1247
+ properties:
1248
+ mediaId:
1249
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/MediaId'
1250
+ mediaResourceType:
1251
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/MediaResourceType'
1252
+ localMbEndpoint:
1253
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint'
1254
+ remoteMbEndpoint:
1255
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint'
1256
+ dcMedia:
1257
+ $ref: '#/components/schemas/DcMedia'
1258
+ mediaProcessingUri:
1259
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
1260
+
1261
+ DcMedia:
1262
+ description: Represents the DC media descriptor.
1263
+ type: object
1264
+ required:
1265
+ - streams
1266
+ properties:
1267
+ mediaProxyConfig:
1268
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/MediaProxy'
1269
+ replaceHttpUrl:
1270
+ type: object
1271
+ description: >
1272
+ Contains a list of replacement HTTP URLs. The streamId attribute
1273
+ within the ReplaceHttpUrl data type is the key of the map.
1274
+ additionalProperties:
1275
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/ReplaceHttpUrl'
1276
+ minProperties: 1
1277
+ remoteMdc1Endpoint:
1278
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint'
1279
+ remoteMdc2Endpoint:
1280
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint'
1281
+ localMdc1Endpoint:
1282
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint'
1283
+ localMdc2Endpoint:
1284
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint'
1285
+ mdc2Protocol:
1286
+ type: string
1287
+ streams:
1288
+ type: object
1289
+ description: >
1290
+ Contains a data channel mapping and configuration information. The streamId
1291
+ attribute within the DcStream data type is the key of the map.
1292
+ additionalProperties:
1293
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/DcStream'
1294
+ minProperties: 1
1295
+ maxMessageSize:
1296
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/MaxMessageSize'
1297
+ localDcEndpoint:
1298
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/DcEndpoint'
1299
+ remoteDcEndpoint:
1300
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/DcEndpoint'
1301
+ securitySetup:
1302
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/SecuritySetup'
1303
+ ```
1304
+
1305
+ # Annex B (informative): Change history
1306
+
1307
+ | Change history | | | | | | | | |
1308
+ |----------------|--------------|-----------|----|-----|-----|-----------------------------------------------------------------------|--|-------------|
1309
+ | Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version |
1310
+ | 2023-04 | CT4#115<br>e | C4-231552 | | | | Version 0.1.0 | | 0.1.0 |
1311
+ | 2023-05 | CT4#116 | C4-232178 | | | | Clause 4 Overview | | 0.2.0 |
1312
+ | 2023-05 | CT4#116 | C4-232224 | | | | Clause 5.1 Introduction of DCMF services | | 0.2.0 |
1313
+ | 2023-05 | CT4#116 | C4-232506 | | | | Service description and service operation introduction of MRM service | | 0.2.0 |
1314
+ | 2023-05 | CT4#116 | C4-232607 | | | | MRM API definition | | 0.2.0 |
1315
+ | 2023-05 | CT4#116 | C4-232637 | | | | MRM service operations | | 0.2.0 |
1316
+ | 2023-08 | CT4#117 | C4-233707 | | | | Change DCMF to MF | | 0.3.0 |
1317
+ | 2023-08 | CT4#117 | C4-233307 | | | | Update the data channel related data types | | 0.3.0 |
1318
+ | 2023-08 | CT4#117 | C4-233306 | | | | Update MF service to support AR | | 0.3.0 |
1319
+ | 2023-10 | CT4#118 | C4-234539 | | | | Update the scope | | 0.4.0 |
1320
+ | 2023-10 | CT4#118 | C4-234540 | | | | Support of Redirection | | 0.4.0 |
1321
+ | 2023-10 | CT4#118 | C4-234575 | | | | Clarification on the DC media | | 0.4.0 |
1322
+ | 2023-10 | CT4#118 | C4-234543 | | | | Editorial Corrections | | 0.4.0 |
1323
+ | 2023-10 | CT4#118 | C4-234544 | | | | Update the data model for AR remote cooperation | | 0.4.0 |
1324
+ | 2023-10 | CT4#118 | C4-234341 | | | | Usage of the apiVersion placeholder | | 0.4.0 |
1325
+ | 2023-11 | CT4#119 | C4-235576 | | | | Move the Endpoint to Common Data | | 0.5.0 |
1326
+ | 2023-11 | CT4#119 | C4-235473 | | | | OpenAPI of Nmf_MRM Service | | 0.5.0 |
1327
+ | 2023-12 | CT#102 | CP-233022 | | | | Presented for information and approval | | 1.0.0 |
1328
+ | 2023-12 | CT#102 | CP-233022 | | | | Approved in TSC CT#102 | | 18.0.0 |
gsma/29_series/29213/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29214/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29222/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29230/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29255/raw.md ADDED
@@ -0,0 +1,1229 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # 3GPP TS 29.255 V18.2.0 (2023-12)
4
+
5
+ *Technical Specification*
6
+
7
+ **3rd Generation Partnership Project;
8
+ Technical Specification Group Core Network and Terminals;
9
+ 5G System;
10
+ Uncrewed Aerial System Service Supplier (USS) Services;
11
+ Stage 3
12
+ (Release 18)**
13
+
14
+ ![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg)
15
+
16
+ The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green, curved lines representing signal waves.
17
+
18
+ 5G logo
19
+
20
+ ![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg)
21
+
22
+ The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. The "G" has a red signal wave icon below it. To the right of the "P" is a small "TM" symbol.
23
+
24
+ 3GPP logo
25
+
26
+ A GLOBAL INITIATIVE
27
+
28
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
29
+
30
+ ## **3GPP**
31
+
32
+ ---
33
+
34
+ Postal address
35
+
36
+ ---
37
+
38
+ 3GPP support office address
39
+
40
+ ---
41
+
42
+ 650 Route des Lucioles - Sophia Antipolis
43
+ Valbonne - FRANCE
44
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
45
+
46
+ Internet
47
+
48
+ ---
49
+
50
+ <http://www.3gpp.org>
51
+
52
+ # --- **Copyright Notification** ---
53
+
54
+ No part may be reproduced except as authorized by written permission.
55
+ The copyright and the foregoing restriction extend to reproduction in all media.
56
+
57
+ © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
58
+ All rights reserved.
59
+
60
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
61
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
62
+ LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
63
+ GSM® and the GSM logo are registered and owned by the GSM Association
64
+
65
+ # Contents
66
+
67
+ | | |
68
+ |---------------------------------------------------------------------------------|----|
69
+ | Foreword ..... | 5 |
70
+ | 1 Scope..... | 7 |
71
+ | 2 References..... | 7 |
72
+ | 3 Definitions of terms, symbols and abbreviations..... | 8 |
73
+ | 3.1 Terms..... | 8 |
74
+ | 3.2 Symbols..... | 8 |
75
+ | 3.3 Abbreviations ..... | 8 |
76
+ | 4 Services offered by the USS ..... | 8 |
77
+ | 4.1 Introduction ..... | 8 |
78
+ | 4.2 Naf_Authentication Service ..... | 8 |
79
+ | 4.2.1 Service Description ..... | 8 |
80
+ | 4.2.1.1 Overview..... | 8 |
81
+ | 4.2.1.2 Service Architecture ..... | 9 |
82
+ | 4.2.1.3 Network Functions..... | 9 |
83
+ | 4.2.1.3.1 Uncrewed Aerial System Service Supplier (USS) ..... | 9 |
84
+ | 4.2.1.3.2 NF Service Consumers..... | 9 |
85
+ | 4.2.2 Service Operations..... | 10 |
86
+ | 4.2.2.1 Introduction..... | 10 |
87
+ | 4.2.2.2 Naf_Authentication_AuthenticateAuthorize Service operation ..... | 10 |
88
+ | 4.2.2.2.1 General ..... | 10 |
89
+ | 4.2.2.2.2 Authentication and Authorization of the UAV ..... | 10 |
90
+ | 4.2.2.3 Naf_Authentication_Notification Service operation ..... | 11 |
91
+ | 4.2.2.3.1 General ..... | 11 |
92
+ | 4.2.2.3.2 Notification for Reauthentication, Reauthorization or Revocation..... | 12 |
93
+ | 5 API Definitions ..... | 13 |
94
+ | 5.1 Naf_Authentication Service API..... | 13 |
95
+ | 5.1.1 Introduction ..... | 13 |
96
+ | 5.1.2 Usage of HTTP..... | 13 |
97
+ | 5.1.2.1 General..... | 13 |
98
+ | 5.1.2.2 HTTP standard headers..... | 13 |
99
+ | 5.1.2.2.1 General ..... | 13 |
100
+ | 5.1.2.2.2 Content type ..... | 13 |
101
+ | 5.1.2.3 HTTP custom headers..... | 13 |
102
+ | 5.1.3 Resources..... | 14 |
103
+ | 5.1.4 Custom Operations without associated resources ..... | 14 |
104
+ | 5.1.4.1 Overview..... | 14 |
105
+ | 5.1.4.2 Operation: request-auth..... | 14 |
106
+ | 5.1.4.2.1 Description ..... | 14 |
107
+ | 5.1.4.2.2 Operation Definition ..... | 14 |
108
+ | 5.1.5 Notifications ..... | 15 |
109
+ | 5.1.5.1 General..... | 15 |
110
+ | 5.1.5.2 UAV Notification ..... | 16 |
111
+ | 5.1.5.2.1 Description ..... | 16 |
112
+ | 5.1.5.2.2 Target URI..... | 16 |
113
+ | 5.1.5.2.3 Standard Methods..... | 16 |
114
+ | 5.1.5.2.3.1 POST ..... | 16 |
115
+ | 5.1.6 Data Model ..... | 17 |
116
+ | 5.1.6.1 General..... | 17 |
117
+ | 5.1.6.2 Structured data types..... | 17 |
118
+ | 5.1.6.2.1 Introduction ..... | 17 |
119
+ | 5.1.6.2.2 Type: UAVAuthInfo ..... | 18 |
120
+ | 5.1.6.2.3 Type: ReauthRevokeNotify..... | 19 |
121
+ | 5.1.6.2.4 Type: UAVAuthResponse..... | 20 |
122
+ | 5.1.6.2.5 Type: AdditionInfoAuthenticateAuthorize ..... | 20 |
123
+
124
+ | | | |
125
+ |--------------------------------------------------------|----------------------------------------------------------------------------------|-----------|
126
+ | 5.1.6.2.6 | Type: AuthContainer..... | 21 |
127
+ | 5.1.6.3 | Simple data types and enumerations..... | 21 |
128
+ | 5.1.6.3.1 | Introduction ..... | 21 |
129
+ | 5.1.6.3.2 | Simple data types ..... | 21 |
130
+ | 5.1.6.3.3 | Enumeration: AuthResult..... | 21 |
131
+ | 5.1.6.3.4 | Enumeration: NotifyType ..... | 21 |
132
+ | 5.1.6.3.5 | Void..... | 22 |
133
+ | 5.1.6.3.6 | Enumeration: AuthMsgType..... | 22 |
134
+ | 5.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 22 |
135
+ | 5.1.6.4.1 | Type: ProblemDetailsAuthenticateAuthorize ..... | 22 |
136
+ | 5.1.7 | Error Handling ..... | 22 |
137
+ | 5.1.7.1 | General..... | 22 |
138
+ | 5.1.7.2 | Protocol Errors ..... | 22 |
139
+ | 5.1.7.3 | Application Errors..... | 22 |
140
+ | 5.1.8 | Feature negotiation ..... | 22 |
141
+ | 5.1.9 | Security..... | 23 |
142
+ | <b>Annex A (normative): OpenAPI specification.....</b> | | <b>24</b> |
143
+ | A.1 | General..... | 24 |
144
+ | A.2 | Naf_Authentication API ..... | 24 |
145
+ | <b>Annex B (informative): Change history .....</b> | | <b>29</b> |
146
+
147
+ # Foreword
148
+
149
+ This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).
150
+
151
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
152
+
153
+ Version x.y.z
154
+
155
+ where:
156
+
157
+ - x the first digit:
158
+ - 1 presented to TSG for information;
159
+ - 2 presented to TSG for approval;
160
+ - 3 or greater indicates TSG approved document under change control.
161
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
162
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
163
+
164
+ In the present document, modal verbs have the following meanings:
165
+
166
+ - shall** indicates a mandatory requirement to do something
167
+ - shall not** indicates an interdiction (prohibition) to do something
168
+
169
+ The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports.
170
+
171
+ The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document.
172
+
173
+ - should** indicates a recommendation to do something
174
+ - should not** indicates a recommendation not to do something
175
+ - may** indicates permission to do something
176
+ - need not** indicates permission not to do something
177
+
178
+ The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended.
179
+
180
+ - can** indicates that something is possible
181
+ - cannot** indicates that something is impossible
182
+
183
+ The constructions "can" and "cannot" are not substitutes for "may" and "need not".
184
+
185
+ - will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
186
+ - will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
187
+ - might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
188
+
189
+ **might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
190
+
191
+ In addition:
192
+
193
+ **is** (or any other verb in the indicative mood) indicates a statement of fact
194
+
195
+ **is not** (or any other negative verb in the indicative mood) indicates a statement of fact
196
+
197
+ The constructions "is" and "is not" do not indicate requirements.
198
+
199
+ # --- 1 Scope
200
+
201
+ The present document specifies the stage 3 protocol and data model for the UAS-specific Naf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the UAS-specific AF.
202
+
203
+ The 5G System stage 2 architecture and procedures are specified in TS 23.501 [2], TS 23.502 [3], and TS 23.256 [14].
204
+
205
+ The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in TS 29.500 [4], and TS 29.122 [16].
206
+
207
+ The UAS Service Supplier (USS) provides the UAS-specific AF services to NF service consumers (e.g. NEF (UAS-NF)). The USS is functionality within the AF.
208
+
209
+ # --- 2 References
210
+
211
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
212
+
213
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
214
+ - For a specific reference, subsequent revisions do not apply.
215
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
216
+
217
+ - [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
218
+ - [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2".
219
+ - [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2".
220
+ - [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3".
221
+ - [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3".
222
+ - [6] OpenAPI: "OpenAPI Specification Version 3.0.0", <https://spec.openapis.org/oas/v3.0.0>.
223
+ - [7] 3GPP TR 21.900: "Technical Specification Group working methods".
224
+ - [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system".
225
+ - [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework".
226
+ - [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3".
227
+ - [11] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)".
228
+ - [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format".
229
+ - [13] IETF RFC 7807: "Problem Details for HTTP APIs".
230
+ - [14] 3GPP TS 23.256: "Support of Uncrewed Aerial Systems (UAS) connectivity, identification and tracking; Stage 2".
231
+ - [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3".
232
+ - [16] 3GPP TS 29.122: "T8 reference point for Northbound APIs".
233
+
234
+ # 3 Definitions of terms, symbols and abbreviations
235
+
236
+ ## 3.1 Terms
237
+
238
+ For the purposes of the present document, the terms given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. For the purposes of the present document, the terms and definitions given in TS 23.256 [14] shall apply.
239
+
240
+ ## 3.2 Symbols
241
+
242
+ For the purposes of the present document, the following symbols apply:
243
+
244
+ ## 3.3 Abbreviations
245
+
246
+ For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1].
247
+
248
+ | | |
249
+ |--------|-----------------------------------------|
250
+ | AA | Authorization/Authentication |
251
+ | AF | Application Function |
252
+ | NEF | Network Exposure Function |
253
+ | UAS | Uncrewed Aerial System |
254
+ | UAS-NF | Uncrewed Aerial System Network Function |
255
+ | UAV | Uncrewed Aerial Vehicle |
256
+ | USS | UAS Service Supplier |
257
+ | UUAA | USS UAV Authorization/Authentication |
258
+
259
+ # 4 Services offered by the USS
260
+
261
+ ## 4.1 Introduction
262
+
263
+ Table 4.1-1 summarizes the corresponding APIs defined for this specification.
264
+
265
+ **Table 4.1-1: API Descriptions**
266
+
267
+ | Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex |
268
+ |--------------------|--------|----------------------------------------------|---------------------------------|----------|-------|
269
+ | Naf_Authentication | 5.1 | USS Authentication and Authorization Service | TS29255_Naf_Authentication.yaml | naf-auth | A.2 |
270
+
271
+ ## 4.2 Naf\_Authentication Service
272
+
273
+ ### 4.2.1 Service Description
274
+
275
+ #### 4.2.1.1 Overview
276
+
277
+ The Naf\_Authentication service as defined in TS 23.256 [14] is provided by the USS via the Naf service-based interface (see TS 23.256 [14]).
278
+
279
+ This service:
280
+
281
+ - allows NF consumers to authentication and authorization of the UAV with the USS; and
282
+ - notifies NF consumers about reauthentication, reauthorization and revocation.
283
+
284
+ #### 4.2.1.2 Service Architecture
285
+
286
+ The Application Function Authentication Service (Naf\_Authentication) is part of the Naf service-based interface exhibited by the Application Function (AF) which owns the functionality of USS.
287
+
288
+ The known NF service consumers of the Naf\_Authentication are the Network Exposure Function (NEF) which owns the functionality of UAS-NF.
289
+
290
+ Figures 4.2.1.2-1 and 4.2.1.2-2 provide the reference model (in service-based interface representation and in reference point representation), with focus on the USS and the scope of the present specification.
291
+
292
+ ![Figure 4.2.1.2-1: Reference architecture for Naf_Authentication service: SBI representation. The diagram shows an Application Function (AF) box containing a USS box and a Naf circle. Below the AF box is a UAS-NF box, which is inside a larger NEF box. A vertical line labeled 'Naf_Authentication' connects the Naf circle to the UAS-NF box.](a234352dfaccdc24745c88eef7724cc6_img.jpg)
293
+
294
+ Figure 4.2.1.2-1: Reference architecture for Naf\_Authentication service: SBI representation. The diagram shows an Application Function (AF) box containing a USS box and a Naf circle. Below the AF box is a UAS-NF box, which is inside a larger NEF box. A vertical line labeled 'Naf\_Authentication' connects the Naf circle to the UAS-NF box.
295
+
296
+ **Figure 4.2.1.2-1: Reference architecture for Naf\_Authentication service: SBI representation**
297
+
298
+ ![Figure 4.2.1.2-2: Reference architecture for Naf_Authentication service: reference point representation. The diagram shows a NEF box containing a UAS-NF box on the left, connected by a horizontal line labeled 'N33' to a box on the right. The right box contains a USS box and an AF box.](99bae07626f60f9ede10e2e387ef7051_img.jpg)
299
+
300
+ Figure 4.2.1.2-2: Reference architecture for Naf\_Authentication service: reference point representation. The diagram shows a NEF box containing a UAS-NF box on the left, connected by a horizontal line labeled 'N33' to a box on the right. The right box contains a USS box and an AF box.
301
+
302
+ **Figure 4.2.1.2-2: Reference architecture for Naf\_Authentication service: reference point representation**
303
+
304
+ The functionalities supported by the USS are listed in clause 4.3.2 of TS 23.256 [14].
305
+
306
+ #### 4.2.1.3 Network Functions
307
+
308
+ ##### 4.2.1.3.1 Uncrewed Aerial System Service Supplier (USS)
309
+
310
+ The UAS service supplier (USS) application provides authentication and authorization for the UAV.
311
+
312
+ The UAS service supplier (USS) allows NF consumers to exchange communication messages needed for authentication and authorization procedure. It also notifies NF consumers about reauthentication, reauthorization or revocation of the UAV.
313
+
314
+ ##### 4.2.1.3.2 NF Service Consumers
315
+
316
+ The Uncrewed Aerial System network function (UAS NF):
317
+
318
+ - supports authentication and authorization of the UAV with the USS;
319
+ - supports subscription for notification of reauthentication, reauthorization and revocation of the UAV from the USS.
320
+
321
+ ### 4.2.2 Service Operations
322
+
323
+ #### 4.2.2.1 Introduction
324
+
325
+ #### 4.2.2.2 Naf\_Authentication\_AuthenticateAuthorize Service operation
326
+
327
+ ##### 4.2.2.2.1 General
328
+
329
+ The Naf\_Authentication\_AuthenticateAuthorize service operation is used by the NF consumers during following procedure:
330
+
331
+ - UUAA-MM and UUAA-SM procedures (see TS 23.256 [14], clause 5.2.2 and clause 5.2.3, respectively)
332
+ - C2 authorization (see TS 23.256 [14], clause 5.2.5.2 and clause 5.4.3)
333
+
334
+ ##### 4.2.2.2.2 Authentication and Authorization of the UAV
335
+
336
+ The Naf\_Authentication\_AuthenticateAuthorize service operation is invoked by an NF Service Consumer (e.g. an NEF (UAS-NF)) towards the USS, when UUAA-MM is done during 5GS registration, UUAA-SM is done during PDU session establishment, or for authorization for C2 communication over Uu interface or Direct C2 communication over PC5 interface (see TS 23.256 [14]).
337
+
338
+ The NF Service Consumer (e.g. the NEF (UAS-NF)) shall send the authentication message to USS by sending the HTTP POST request towards the "request-auth" resource as shown in Figure 4.2.2.2.2-1.
339
+
340
+ ![Sequence diagram showing the AuthenticateAuthorize Service Operation between an NF Service Consumer and a USS. The NF Service Consumer sends a POST request to the USS. The USS responds with either a 200 OK or a 4xx/5xx or 3xx status code.](fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg)
341
+
342
+ ```
343
+
344
+ sequenceDiagram
345
+ participant NF Service Consumer
346
+ participant USS
347
+ Note left of NF Service Consumer:
348
+ NF Service Consumer->>USS: 1. POST.../request-auth
349
+ Note right of USS:
350
+ USS-->>NF Service Consumer: 2a. 200 OK
351
+ Note right of USS:
352
+ USS-->>NF Service Consumer: 2b. 4xx/5xx or 3xx
353
+
354
+ ```
355
+
356
+ Sequence diagram showing the AuthenticateAuthorize Service Operation between an NF Service Consumer and a USS. The NF Service Consumer sends a POST request to the USS. The USS responds with either a 200 OK or a 4xx/5xx or 3xx status code.
357
+
358
+ **Figure 4.2.2.2.2-1: AuthenticateAuthorize Service Operation**
359
+
360
+ 1. The NF Service Consumer shall send a POST request to the resource with a UAVAuthInfo object in the request body. The UAVAuthInfo data type shall include:
361
+
362
+ - "gpsi" attribute that carries the GPSI (in the format of External Identifier) of the UAV;
363
+ - "serviceLevelId" attribute that carries the Service Level Device Identity of the UAV;
364
+
365
+ The UAVAuthInfo data type may include
366
+
367
+ - "uavLocInfo" attribute that provides the UAV location;
368
+ - "notifyUri" attribute that provides the notification URI to receive notifications related to reauthentication, reauthorization or revocation triggered by the USS, which shall be present in the initial request;
369
+ - "notifyCorrId" attribute that represents the notification correlation ID and this attribute shall be present when the "notifyUri" attribute is provided;
370
+ - "authMsg" attribute that contains the authentication message based on the authentication method used, which is present in the intermediate round-trip messages and not in initial request. This attribute is deprecated; the attribute "authContainer" should be used instead.
371
+
372
+ - "AuthContainer" data type that contains the AA related data provided by the UE (see TS 23.256 [14]). This attribute deprecates "authMsg" attribute and may contain:
373
+ - "authMsgType" attribute that indicates the type of the AA message payload;
374
+ - "authMsgPayload" attribute that carries the AA message payload;
375
+
376
+ NOTE 1: The "authResult" attribute will not be present within the AuthContainer data type, when included within the request sent to USS.
377
+
378
+ In case of UUAA-SM procedure, the UAVAuthInfo data type may also include:
379
+
380
+ - "ipAddr" attribute that carries the IP Address associated with the PDU session; and
381
+ - "pei" attribute that carries the PEI of the UAV.
382
+
383
+ - 2a. If the HTTP request message from the NF service consumer is accepted, the USS shall respond with "200 OK" status code with the message body containing the UAVAuthResponse data type in the response body, which shall include "gpsi" attribute.
384
+
385
+ If the USS triggers more intermediate round-trip messages, the UAVAuthResponse data shall include a "authMsg" attribute that contains the authentication message or authorization data.
386
+
387
+ Otherwise, the UAVAuthResponse data type shall contain the "authResult" attribute. If the UAV is authenticated successfully, the USS shall set the "authResult" attribute to "AUTH\_SUCCESS". The "authMsg" and "authResult" attributes are deprecated; the "authContainer" attribute should be used instead. The UAVAuthResponse data type shall include the "authContainer" data type that may include:
388
+
389
+ - AA message payload type within "authMsgType" attribute;
390
+ - AA message payload containing the configuration information within "authMsgPayload" attribute;
391
+ - AA result within "authResult" attribute, which is set to either "AUTH\_SUCCESS" in case of successful AA procedure or to "AUTH\_FAIL" in case of failed AA procedure in the final response of the AA procedure.
392
+
393
+ NOTE 2: The absence of "authResult" attribute within "AuthContainer" data type indicates that the AA procedure is ongoing.
394
+
395
+ - The "serviceLevelId" attribute containing a new Service Level Device Identity as the authorized Service Level Device Identity to the UAV.
396
+
397
+ The UAVAuthResponse data type may also include:
398
+
399
+ - the DN authorization profile index within the "authProfIndex" attribute;
400
+ - the DN authorized Session-AMBR within the "authSessAmbr" attribute.
401
+
402
+ - 2b. If the USS cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the USS shall send the HTTP error response as specified in clause 5.1.7.
403
+
404
+ If the UAV authentication is failed, the USS shall reject the request with an HTTP "403 Forbidden" response message including the "cause" attribute of the ProblemDetailsAuthenticateAuthorize data structure set to "FAILED\_AUTH". The USS shall also include an indication of "uasResRelInd" attribute in the ProblemDetailsAuthenticateAuthorize data type to indicate if an UAS service related network resource can be released or not, during re-authentication failure, when the service operation is used during Re-authentication procedure.
405
+
406
+ If the USS determines the received HTTP POST request needs to be redirected, the USS shall send an HTTP redirect response as specified in clause 5.2.10 of TS 29.122 [16].
407
+
408
+ #### 4.2.2.3 Naf\_Authentication\_Notification Service operation
409
+
410
+ ##### 4.2.2.3.1 General
411
+
412
+ The Naf\_Authentication\_Notification service operation is used by the NF consumers during the following procedure:
413
+
414
+ - USS Initiated Re-authentication and Re-authorization (see TS 23.256 [14], clause 5.2.4)
415
+ - USS Initiated Revocation (see TS 23.256 [14], clause 5.2.7)
416
+
417
+ ##### 4.2.2.3.2 Notification for Reauthentication, Reauthorization or Revocation
418
+
419
+ The Naf\_Authentication\_Notification service operation is invoked by the USS to inform a NF Service Consumer (e.g. NEF (UAS-NF)), when USS triggers reauthentication, update authorization data or revoke authorization of the UAV.
420
+
421
+ The USS shall send the request by sending the HTTP POST method towards the Notification URI as shown in Figure 4.2.2.3.2-1.
422
+
423
+ ![Sequence diagram showing the UAV Notification Service Operation between an NF Service Consumer and a USS. The USS sends a POST {notifyUri} request to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content or 2b. 4xx/5xx or 3xx.](853f59c89931a666c07903b31d098277_img.jpg)
424
+
425
+ ```
426
+
427
+ sequenceDiagram
428
+ participant NF Service Consumer
429
+ participant USS
430
+ Note left of NF Service Consumer:
431
+ USS->>NF Service Consumer: 1. POST {notifyUri}
432
+ NF Service Consumer-->>USS: 2a. 204 No Content
433
+ NF Service Consumer-->>USS: 2b. 4xx/5xx or 3xx
434
+
435
+ ```
436
+
437
+ Sequence diagram showing the UAV Notification Service Operation between an NF Service Consumer and a USS. The USS sends a POST {notifyUri} request to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content or 2b. 4xx/5xx or 3xx.
438
+
439
+ Figure 4.2.2.3.2-1: UAV Notification Service Operation
440
+
441
+ 1. The USS shall send a POST request towards the Notification URI received in the Authenticate service operation request (See clause 4.2.2.1). The request body shall contain a ReauthRevokeNotify object containing the reauthentication information, update authorization information or revoke authorization indication. The ReauthRevokeNotify data type shall include:
442
+ - the "gpsi" attribute is set to the GPSI (in the format of External Identifier) of the given UAV required to be reauthenticated, reauthorized or revoked;
443
+ - the "serviceLevelId" attribute is set to the Service Level Device Identity of the UAV;
444
+ - the "notifyCorrId" attribute is set to the same value as the "notifyCorrId" attribute of UAVAuthInfo data type received in the request;
445
+ - the "notifyType" attribute is set to REAUTHENTICATE for reauthentication or set to REAUTHORIZE for authorization data update or set to REVOKE for revocation of authorization. In addition, if "notifyType" attribute is set to REAUTHORIZE, then attribute "authMsg" containing the authorization data shall be included. "authMsg" attribute is deprecated; the "authContainer" attribute should be used instead, which carries the authorization data.
446
+
447
+ NOTE: The "authResult" attribute will not be present within the AuthContainer data type, when included within the Notification request sent by the USS.
448
+
449
+ The ReauthRevokeNotify may also include:
450
+
451
+ - the "ipAddr" attribute carries the IP Address associated with the PDU session;
452
+ - 2a. On success, "204 No content" shall be returned without response body. If the "notifyType" attribute in the request indicated REVOKE, then UAS service related network resources are released.
453
+ - 2b. If the NF service consumer cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.1.7.
454
+
455
+ If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 5.2.10 of TS 29.122 [16].
456
+
457
+ # 5 API Definitions
458
+
459
+ ## 5.1 Naf\_Authentication Service API
460
+
461
+ ### 5.1.1 Introduction
462
+
463
+ The Naf\_Authentication shall use the Naf\_Authentication API.
464
+
465
+ The API URI of the Naf\_Authentication API shall be:
466
+
467
+ **{apiRoot}/<apiName>/<apiVersion>**
468
+
469
+ The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 5.2.4 of TS 29.122 [16], i.e.:
470
+
471
+ **{apiRoot}/<apiName>/<apiVersion>/<apiSpecificSuffixes>**
472
+
473
+ with the following components:
474
+
475
+ - The {apiRoot} shall be set as described in clause 5.2.4 in 3GPP TS 29.122 [16].
476
+ - The <apiName> shall be "naf-auth".
477
+ - The <apiVersion> shall be "v1".
478
+ - The <apiSpecificSuffixes> shall be set as described in clause 5.1.3.
479
+
480
+ ### 5.1.2 Usage of HTTP
481
+
482
+ #### 5.1.2.1 General
483
+
484
+ HTTP/2, IETF RFC 7540 [11], shall be used as specified in of TS 29.122 [16].
485
+
486
+ HTTP/2 shall be transported as specified in TS 29.122 [16].
487
+
488
+ The OpenAPI [6] specification of HTTP messages and content bodies for the Naf\_Authentication API is contained in Annex A.
489
+
490
+ #### 5.1.2.2 HTTP standard headers
491
+
492
+ ##### 5.1.2.2.1 General
493
+
494
+ See TS 29.122 [16] for the usage of HTTP standard headers.
495
+
496
+ ##### 5.1.2.2.2 Content type
497
+
498
+ JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in TS 29.122 [16]. The use of the JSON format shall be signalled by the content type "application/json".
499
+
500
+ "Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13].
501
+
502
+ NOTE: This release only supports the content type JSON.
503
+
504
+ #### 5.1.2.3 HTTP custom headers
505
+
506
+ The mandatory HTTP custom header fields specified in clause 5.2.3.2 of TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of TS 29.500 [4] may be supported.
507
+
508
+ ### 5.1.3 Resources
509
+
510
+ None
511
+
512
+ ### 5.1.4 Custom Operations without associated resources
513
+
514
+ #### 5.1.4.1 Overview
515
+
516
+ The structure of the custom operation URIs of the Naf\_Authentication service is shown in Figure 5.1.4.1-1.
517
+
518
+ ![Diagram showing the URI structure {apiRoot}/naf-auth/v1 with a callout pointing to /request-auth.](f6e8acf9f931452d01688d311b5c0364_img.jpg)
519
+
520
+ The diagram shows the URI structure `{apiRoot}/naf-auth/v1`. A line extends from the bottom of the URI to a dashed rectangular box containing the text `/request-auth`, indicating that this path is appended to the base URI for the custom operation.
521
+
522
+ Diagram showing the URI structure {apiRoot}/naf-auth/v1 with a callout pointing to /request-auth.
523
+
524
+ **Figure 5.1.4.1-1: Custom operation URI structure of the Naf\_Authentication API**
525
+
526
+ Table 5.1.4.1-1 provides an overview of the custom operations and applicable HTTP methods.
527
+
528
+ **Table 5.1.4.1-1: Custom operations without associated resources**
529
+
530
+ | Custom operation URI | Mapped HTTP method | Description |
531
+ |-----------------------------------------------------------------|--------------------|--------------------------------------------------------------------------------------------------|
532
+ | <code>{apiRoot}/naf-auth/&lt;apiVersion&gt;/request-auth</code> | POST | Request UAV authentication and authorization and subscribe to notifications triggered by the USS |
533
+
534
+ #### 5.1.4.2 Operation: request-auth
535
+
536
+ ##### 5.1.4.2.1 Description
537
+
538
+ The operation is used by the NF service consumer to request UAV authentication and authorization and subscribe to notifications triggered by the USS.
539
+
540
+ ##### 5.1.4.2.2 Operation Definition
541
+
542
+ This operation shall support the response data structures and response codes specified in tables 5.1.4.2.2-1 and 5.1.4.2.2-2.
543
+
544
+ **Table 5.1.4.2.2-1: Data structures supported by the POST Request Body on this resource**
545
+
546
+ | Data type | P | Cardinality | Description |
547
+ |-------------|---|-------------|-------------------------------------------------------------------------|
548
+ | UAVAuthInfo | M | 1 | Represents the data to be used for UAV authentication and authorization |
549
+
550
+ **Table 5.1.4.2.2-2: Data structures supported by the POST Response Body on this resource**
551
+
552
+ | Data type | P | Cardinality | Response codes | Description |
553
+ |-------------------------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
554
+ | UAVAuthResponse | M | 1 | 200 OK | Successful request of UAV authentication and authorization and subscription to notification of re-authentication and revocation triggered by the USS. If C2 authorization request is sent during UUAA-SM, the final response indicates that at least UUAA has succeeded. |
555
+ | N/A | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative AF. |
556
+ | N/A | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative AF. |
557
+ | ProblemDetailsAuthenticateAuthorize | O | 0..1 | 403 Forbidden | (NOTE 2) |
558
+
559
+ NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of TS 29.122 [16] also apply.
560
+
561
+ NOTE 2: Failure cases are described in clause 5.1.7.3.
562
+
563
+ **Table 5.1.4.2.2-3: Headers supported by the 307 Response Code on this resource**
564
+
565
+ | Name | Data type | P | Cardinality | Description |
566
+ |----------|-----------|---|-------------|---------------------------------------------------------------------|
567
+ | Location | String | M | 1 | An alternative URI representing the end point of an alternative AF. |
568
+
569
+ **Table 5.1.4.2.2-4: Headers supported by the 308 Response Code on this resource**
570
+
571
+ | Name | Data type | P | Cardinality | Description |
572
+ |----------|-----------|---|-------------|---------------------------------------------------------------------|
573
+ | Location | string | M | 1 | An alternative URI representing the end point of an alternative AF. |
574
+
575
+ ### 5.1.5 Notifications
576
+
577
+ #### 5.1.5.1 General
578
+
579
+ This clause specifies the notifications provided by the Naf\_Authentication service.
580
+
581
+ Notifications shall comply to clause 5.2.5 of 3GPP TS 29.122 [16].
582
+
583
+ **Table 5.1.5.1-1: Notifications overview**
584
+
585
+ | Notification | Callback URI | HTTP method or custom operation | Description (service operation) |
586
+ |------------------|--------------|---------------------------------|--------------------------------------------------------------|
587
+ | UAV Notification | {notifyUri} | notify (POST) | Reauthentication, Reauthorization or Revocation notification |
588
+
589
+ #### 5.1.5.2 UAV Notification
590
+
591
+ ##### 5.1.5.2.1 Description
592
+
593
+ The UAV Notification is used by the USS to trigger reauthentication, reauthorization or revocation notification to a NF service consumer that has subscribed to such notifications. The USS shall notify the NF Service Consumer when reauthentication is required.
594
+
595
+ ##### 5.1.5.2.2 Target URI
596
+
597
+ The Callback URI "{notifyUri}" shall be used with the callback URI variables defined in table 5.1.5.2.2-1.
598
+
599
+ **Table 5.1.5.2.2-1: Callback URI variables**
600
+
601
+ | Name | Definition |
602
+ |-----------|-----------------------------------------------|
603
+ | notifyUri | String formatted as URI with the Callback Uri |
604
+
605
+ ##### 5.1.5.2.3 Standard Methods
606
+
607
+ ###### 5.1.5.2.3.1 POST
608
+
609
+ This method shall support the request data structures specified in table 5.1.5.2.3.1-1 and the response data structures and response codes specified in table 5.1.5.2.3.2-1.
610
+
611
+ **Table 5.1.5.2.3.1-1: Data structures supported by the POST Request Body**
612
+
613
+ | Data type | P | Cardinality | Description |
614
+ |--------------------|---|-------------|---------------------------------------------------------------------------|
615
+ | ReauthRevokeNotify | M | 1 | Contains the reauthentication, reauthorization or revocation information. |
616
+
617
+ **Table 5.1.5.2.3.1-2: Data structures supported by the POST Response Body**
618
+
619
+ | Data type | P | Cardinality | Response codes | Description |
620
+ |-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
621
+ | n/a | | | 204 No Content | Successful notification of reauthentication or reauthorization or revocation. |
622
+ | N/A | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative NEF. |
623
+ | N/A | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative NEF. |
624
+
625
+ NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.6-1 of TS 29.122 [16] also apply.
626
+
627
+ **Table 5.1.5.2.3.1-3: Headers supported by the 307 Response Code on this resource**
628
+
629
+ | Name | Data type | P | Cardinality | Description |
630
+ |----------|-----------|---|-------------|----------------------------------------------------------------------|
631
+ | Location | string | M | 1 | An alternative URI representing the end point of an alternative NEF. |
632
+
633
+ **Table 5.1.5.2.3.1-4: Headers supported by the 308 Response Code on this resource**
634
+
635
+ | Name | Data type | P | Cardinality | Description |
636
+ |----------|-----------|---|-------------|----------------------------------------------------------------------|
637
+ | Location | string | M | 1 | An alternative URI representing the end point of an alternative NEF. |
638
+
639
+ ### 5.1.6 Data Model
640
+
641
+ #### 5.1.6.1 General
642
+
643
+ This clause specifies the application data model supported by the Naf\_Authentication API.
644
+
645
+ Table 5.1.6.1-1 specifies the data types defined for the Naf\_Authentication service based interface protocol.
646
+
647
+ **Table 5.1.6.1-1: Naf\_Authentication specific Data Types**
648
+
649
+ | Data type | Clause defined | Description | Applicability |
650
+ |-------------------------------------|----------------|--------------------------------------------------------------------------------------------------------|---------------|
651
+ | UAVAuthInfo | 5.1.6.2.2 | Information within Authenticate Request | |
652
+ | UAVAuthResponse | 5.1.6.2.4 | Information within Authenticate Response | |
653
+ | AuthResult | 5.1.6.3.3 | Enumeration indicating authentication result | |
654
+ | ReauthRevokeNotify | 5.1.6.2.3 | Information within notification | |
655
+ | NotifyType | 5.1.6.3.4 | Enumeration Notification type | |
656
+ | ProblemDetailsAuthenticateAuthorize | 5.1.6.4.1 | Data type that extends ProblemDetails. | |
657
+ | AdditionInfoAuthenticateAuthorize | 5.1.6.2.5 | Contains more details (not only the ProblemDetails) in case an UAV authentication request is rejected. | |
658
+ | AuthContainer | 5.1.6.2.6 | Carries the AA related data | |
659
+
660
+ Table 5.1.6.1-2 specifies data types re-used by the Naf\_Authentication service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Naf\_Authentication service based interface.
661
+
662
+ **Table 5.1.6.1-2: Naf\_Authentication re-used Data Types**
663
+
664
+ | Data type | Reference | Comments | Applicability |
665
+ |-------------------|----------------|----------------------------------------------------------------------------------------|---------------|
666
+ | BitRate | TS 29.571 [15] | Bit Rate | |
667
+ | Pei | TS 29.571 [15] | Permanent Equipment Identifier | |
668
+ | Uri | TS 29.571 [15] | Uri | |
669
+ | Gpsi | TS 29.571 [15] | GPSI | |
670
+ | IpAddr | TS 29.571 [15] | IP address | |
671
+ | LocationArea5G | TS 29.122 [16] | User location | |
672
+ | ProblemDetails | TS 29.122 [16] | Represents additional information and details on an error response. | |
673
+ | SupportedFeatures | TS 29.571 [15] | Used to negotiate the applicability of the optional features defined in table 5.1.8-1. | |
674
+ | RefToBinaryData | TS 29.571 [15] | AA message payload data | |
675
+
676
+ #### 5.1.6.2 Structured data types
677
+
678
+ ##### 5.1.6.2.1 Introduction
679
+
680
+ This clause defines the structures to be used in resource representations.
681
+
682
+ ##### 5.1.6.2.2 Type: UAVAuthInfo
683
+
684
+ Table 5.1.6.2.2-1: Definition of type UAVAuthInfo
685
+
686
+ | Attribute name | Data type | P | Cardinality | Description | Applicability |
687
+ |----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
688
+ | gpsi | Gpsi | M | 1 | GPSI of the UAV | |
689
+ | serviceLevelId | string | M | 1 | Service Level Device Identity of the UAV | |
690
+ | ipAddr | IpAddr | O | 0..1 | When present, this attribute indicates the IP address associated with the PDU session. | |
691
+ | authMsg | string | O | 0..1 | Contains the authentication message or authorization data (which is not present in the initial request) used in the subsequent request messages during multiple round trip message exchanges. This attribute is deprecated; the attribute "authContainer" should be used instead. | |
692
+ | authContainer | array(AuthContainer) | O | 1..N | Contains the AA related data without the "authResult" attribute. This attribute deprecates "authMsg" attribute. | |
693
+ | pei | Pei | O | 0..1 | PEI associated with the UAV. | |
694
+ | notifyUri | Uri | C | 0..1 | This attribute shall be present in the initial authentication message.<br><br>It carries the notification URI to receive reauthentication, reauthorization or revocation related notifications | |
695
+ | notifyCorrId | string | C | 0..1 | Notification correlation ID assigned by the NF service consumer. Shall be present when the "notifyUri" attribute is provided. | |
696
+ | uavLocInfo | LocationArea5G | O | 0..1 | This attribute shall contain the UE location information if it is available. | |
697
+ | suppFeat | SupportedFeatures | C | 0..1 | This IE shall be present during the initial authentication and authorization request if at least one optional feature defined in clause 5.1.8 is supported. | |
698
+
699
+ ##### 5.1.6.2.3 Type: ReauthRevokeNotify
700
+
701
+ Table 5.1.6.2.3-1: Definition of type ReauthRevokeNotify
702
+
703
+ | Attribute name | Data type | P | Cardinality | Description | Applicability |
704
+ |----------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
705
+ | gpsi | Gpsi | M | 1 | GPSI of the UAV | |
706
+ | serviceLevelId | string | M | 1 | Service Level Device Identity of the UAV | |
707
+ | authMsg | string | C | 0..1 | Contains the authentication message or authorization data.<br>This attribute shall be present when "notifyType" attribute is set to REAUTHORIZE. This attribute is deprecated; the attribute "authContainer" should be used instead. | |
708
+ | authContainer | array(AuthContainer) | C | 1..N | Contains the AA related data. This attribute shall be present when "notifyType" attribute is set to REAUTHORIZE. This attribute deprecates "authMsg" attribute. | |
709
+ | ipAddr | IpAddr | O | 0..1 | When present, this IE indicates the IP address associated with the PDU session. | |
710
+ | notifyCorrId | string | C | 0..1 | Notification correlation ID used to identify the request to which the notification relates.<br>It shall be present if the "notifyCorrId" attribute is provided in the request and set to the same value as the "notifyCorrId" attribute of UAVAuthInfo data type. | |
711
+ | notifyType | NotifyType | M | 1 | This attribute shall contain the notification type. | |
712
+
713
+ ##### 5.1.6.2.4 Type: UAVAuthResponse
714
+
715
+ Table 5.1.6.2.4-1: Definition of type UAVAuthResponse
716
+
717
+ | Attribute name | Data type | P | Cardinality | Description | Applicability |
718
+ |----------------|----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
719
+ | gpsi | Gpsi | C | 0..1 | GPSI of the UAV.<br>Shall be present except during PDU Session Modification for C2 Communication procedure. | |
720
+ | authResult | AuthResult | C | 0..1 | Conveys the UAV authentication result (success) .<br>Shall be present if there is no intermediate round-trip messages. This attribute is deprecated; the attribute "authContainer" should be used instead. | |
721
+ | authMsg | string | C | 0..1 | Contains the authentication message or authorization data.<br>Shall be present if the USS triggers intermediate round-trip messages. This attribute is deprecated; the attribute "authContainer" should be used instead. | |
722
+ | authContainer | array(AuthContainer) | C | 1..N | Contains the AA related data. | |
723
+ | serviceLevelId | string | O | 0..1 | Contains a new Service Level Device Identity of the UAV | |
724
+ | authSessAmbr | BitRate | O | 0..1 | The DN Authorized Session-AMBR. | |
725
+ | authProfIndex | string | O | 0..1 | DN authorization profile index. | |
726
+ | suppFeat | SupportedFeatures | C | 0..1 | This IE shall be present during the initial authentication and authorization response if at least one optional feature defined in clause 5.1.8 is supported. | |
727
+
728
+ ##### 5.1.6.2.5 Type: AdditionInfoAuthenticateAuthorize
729
+
730
+ Table 5.1.6.2.5-1: Definition of type AdditionInfoAuthenticateAuthorize
731
+
732
+ | Attribute name | Data type | P | Cardinality | Description | Applicability |
733
+ |----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
734
+ | uasResRelInd | boolean | C | 0..1 | This attribute is used to indicate if an UAS service related network resource can be released or not, during re-authentication failure.<br>It shall be included if the "cause" attribute within the ProblemDetails data type is set to "FAILED_AUTH".<br>When present, it shall be set as follows:<br>- true: UAS resource release is requested;<br>- false (default): UAS resource release is not requested. | |
735
+
736
+ ##### 5.1.6.2.6 Type: AuthContainer
737
+
738
+ Table 5.1.6.2.6-1: Definition of type AuthContainer
739
+
740
+ | Attribute name | Data type | P | Cardinality | Description | Applicability |
741
+ |----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------|---------------|
742
+ | authMsgType | AuthMsgType | C | 0..1 | Type of AA message.<br>Shall be present if more than one AuthContainer's are carried in the UAVAuthResponse. | |
743
+ | authMsgPayload | RefToBinaryData | O | 0..1 | AA message payload data. | |
744
+ | authResult | AuthResult | C | 0..1 | Shall be present for the final AA response conveying the AA result. | |
745
+
746
+ #### 5.1.6.3 Simple data types and enumerations
747
+
748
+ ##### 5.1.6.3.1 Introduction
749
+
750
+ This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
751
+
752
+ ##### 5.1.6.3.2 Simple data types
753
+
754
+ The simple data types defined in table 5.1.6.3.2-1 shall be supported.
755
+
756
+ Table 5.1.6.3.2-1: Simple data types
757
+
758
+ | Type Name | Type Definition | Description | Applicability |
759
+ |-----------|-----------------|-------------|---------------|
760
+ | | | | |
761
+
762
+ ##### 5.1.6.3.3 Enumeration: AuthResult
763
+
764
+ The enumeration AuthResult represents the result of authentication and/or authorization. It shall comply with the provisions defined in table 5.1.6.3.3-1.
765
+
766
+ Table 5.1.6.3.3-1: Enumeration AuthResult
767
+
768
+ | Enumeration value | Description | Applicability |
769
+ |-------------------|---------------------------------------------|---------------|
770
+ | AUTH_SUCCESS | The UUAA or C2 authorization has succeeded. | |
771
+ | AUTH_FAIL | The UUAA or C2 authorization has failed. | |
772
+
773
+ ##### 5.1.6.3.4 Enumeration: NotifyType
774
+
775
+ The enumeration NotifyType represents the type of notification. It shall comply with the provisions defined in table 5.1.6.3.4-1.
776
+
777
+ Table 5.1.6.3.4-1: Enumeration NotifyType
778
+
779
+ | Enumeration value | Description | Applicability |
780
+ |-------------------|------------------------------------------------|---------------|
781
+ | REAUTHENTICATE | The UAV needs to be reauthenticated. | |
782
+ | REAUTHORIZE | Authorization data needs to be updated to UAV. | |
783
+ | REVOKE | Revoke UAV authentication and authorization | |
784
+
785
+ ##### 5.1.6.3.5 Void
786
+
787
+ ##### 5.1.6.3.6 Enumeration: AuthMsgType
788
+
789
+ The enumeration AuthMsgType represents the type of AA message. It shall comply with the provisions defined in table 5.1.6.3.6-1.
790
+
791
+ **Table 5.1.6.3.6-1: Enumeration AuthMsgType**
792
+
793
+ | Enumeration value | Description | Applicability |
794
+ |-------------------|---------------------------|---------------|
795
+ | UUAA | UUAA payload. | |
796
+ | C2AUTH | C2 authorization payload. | |
797
+
798
+ #### 5.1.6.4 Data types describing alternative data types or combinations of data types
799
+
800
+ ##### 5.1.6.4.1 Type: ProblemDetailsAuthenticateAuthorize
801
+
802
+ **Table 5.1.6.4.1-1: Definition of type ProblemDetailsAuthenticateAuthorize as a list of to be combined data types**
803
+
804
+ | Data type | Cardinality | Description | Applicability |
805
+ |-------------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------|---------------|
806
+ | ProblemDetails | 1 | Details of the problem as defined in TS 29.122 [16]. | |
807
+ | AdditionalInfoAuthenticateAuthorize | 1 | Contains additional information to indicate the handling of the UAS service related network resource, during re-authentication failure. | |
808
+
809
+ ### 5.1.7 Error Handling
810
+
811
+ #### 5.1.7.1 General
812
+
813
+ Response bodies for error handling, as described in 3GPP TS 29.122 [16], are applicable to the APIs in the present specification unless specified otherwise, with the following clarifications:
814
+
815
+ - the SCEF is the AF; and
816
+ - the SCS/AS is the NEF invoking an API.
817
+
818
+ In addition, the requirements in the following clauses are applicable for the Naf\_Authentication API.
819
+
820
+ #### 5.1.7.2 Protocol Errors
821
+
822
+ No specific procedures for the Naf\_Authentication service are specified.
823
+
824
+ #### 5.1.7.3 Application Errors
825
+
826
+ The application errors defined for the Naf\_Authentication service are listed in Table 5.1.7.3-1.
827
+
828
+ **Table 5.1.7.3-1: Application errors**
829
+
830
+ | Application Error | HTTP status code | Description |
831
+ |-------------------|------------------|-----------------------------------------------------------------------------------|
832
+ | FAILED_AUTH | 403 Forbidden | The HTTP request is rejected because the UAV authentication is failed by the USS. |
833
+
834
+ ### 5.1.8 Feature negotiation
835
+
836
+ The optional features in table 5.1.8-1 are defined for the Naf\_Authentication API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of TS 29.122 [16].
837
+
838
+ **Table 5.1.8-1: Supported Features**
839
+
840
+ | Feature number | Feature Name | Description |
841
+ |----------------|--------------|-------------|
842
+ | | | |
843
+
844
+ ### 5.1.9 Security
845
+
846
+ TLS shall be used to support the security communication between the NEF and the AF over N33 interface. The access to the Naf\_Authentication API shall be authorized by means of OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant. If OAuth2 is used, a client, prior to consuming services offered by the Naf\_Authentication API, shall obtain a "token" from the authorization server.
847
+
848
+ # Annex A (normative): OpenAPI specification
849
+
850
+ ## A.1 General
851
+
852
+ This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format.
853
+
854
+ This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s).
855
+
856
+ NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply.
857
+
858
+ Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see TS 29.501 [5] clause 5.3.1 and TR 21.900 [7] clause 5B).
859
+
860
+ ## A.2 Naf\_Authentication API
861
+
862
+ ```
863
+ openapi: 3.0.0
864
+
865
+ info:
866
+ title: Naf_Authentication
867
+ version: 1.1.0-alpha.1
868
+ description: |
869
+ AF Authentication Service.
870
+ © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
871
+ All rights reserved.
872
+
873
+ externalDocs:
874
+ description: >
875
+ 3GPP TS 29.255 V18.0.0; 5G System;Uncrewed Aerial System Service Supplier (USS) Services; Stage
876
+ 3.
877
+ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.255/
878
+
879
+ servers:
880
+ - url: '{apiRoot}/naf-auth/v1'
881
+ variables:
882
+ apiRoot:
883
+ default: https://example.com
884
+ description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122
885
+
886
+ security:
887
+ - {}
888
+ - oAuth2ClientCredentials: []
889
+
890
+ paths:
891
+ /request-auth:
892
+ post:
893
+ operationId: UAVAuthRequest
894
+ summary: UAV authentication
895
+ tags:
896
+ - UAV authentication
897
+ requestBody:
898
+ description: UAV authentication
899
+ required: true
900
+ content:
901
+ application/json:
902
+ schema:
903
+ $ref: '#/components/schemas/UAVAuthInfo'
904
+ responses:
905
+ '200':
906
+ description: UAV Auth response or message exchange
907
+ content:
908
+ ```
909
+
910
+ ```
911
+ application/json:
912
+ schema:
913
+ $ref: '#/components/schemas/UAVAuthResponse'
914
+ '307':
915
+ $ref: 'TS29122_CommonData.yaml#/components/responses/307'
916
+ '308':
917
+ $ref: 'TS29122_CommonData.yaml#/components/responses/308'
918
+ '400':
919
+ $ref: 'TS29122_CommonData.yaml#/components/responses/400'
920
+ '401':
921
+ $ref: 'TS29122_CommonData.yaml#/components/responses/401'
922
+ '403':
923
+ description: >
924
+ The request is rejected by the USS and more details (not only the ProblemDetails) are
925
+ returned.
926
+ content:
927
+ application/problem+json:
928
+ schema:
929
+ $ref: '#/components/schemas/ProblemDetailsAuthenticateAuthorize'
930
+ '404':
931
+ $ref: 'TS29122_CommonData.yaml#/components/responses/404'
932
+ '411':
933
+ $ref: 'TS29122_CommonData.yaml#/components/responses/411'
934
+ '413':
935
+ $ref: 'TS29122_CommonData.yaml#/components/responses/413'
936
+ '415':
937
+ $ref: 'TS29122_CommonData.yaml#/components/responses/415'
938
+ '429':
939
+ $ref: 'TS29122_CommonData.yaml#/components/responses/429'
940
+ '500':
941
+ $ref: 'TS29122_CommonData.yaml#/components/responses/500'
942
+ '503':
943
+ $ref: 'TS29122_CommonData.yaml#/components/responses/503'
944
+ default:
945
+ $ref: 'TS29122_CommonData.yaml#/components/responses/default'
946
+ callbacks:
947
+ reauthRevokeNotification:
948
+ '{request.body#/notifyUri}':
949
+ post:
950
+ requestBody:
951
+ required: true
952
+ content:
953
+ application/json:
954
+ schema:
955
+ $ref: '#/components/schemas/ReauthRevokeNotify'
956
+ responses:
957
+ '204':
958
+ description: Successful Notification response
959
+ '307':
960
+ $ref: 'TS29122_CommonData.yaml#/components/responses/307'
961
+ '308':
962
+ $ref: 'TS29122_CommonData.yaml#/components/responses/308'
963
+ '400':
964
+ $ref: 'TS29122_CommonData.yaml#/components/responses/400'
965
+ '401':
966
+ $ref: 'TS29122_CommonData.yaml#/components/responses/401'
967
+ '403':
968
+ $ref: 'TS29122_CommonData.yaml#/components/responses/403'
969
+ '404':
970
+ $ref: 'TS29122_CommonData.yaml#/components/responses/404'
971
+ '411':
972
+ $ref: 'TS29122_CommonData.yaml#/components/responses/411'
973
+ '413':
974
+ $ref: 'TS29122_CommonData.yaml#/components/responses/413'
975
+ '415':
976
+ $ref: 'TS29122_CommonData.yaml#/components/responses/415'
977
+ '429':
978
+ $ref: 'TS29122_CommonData.yaml#/components/responses/429'
979
+ '500':
980
+ $ref: 'TS29122_CommonData.yaml#/components/responses/500'
981
+ '503':
982
+ $ref: 'TS29122_CommonData.yaml#/components/responses/503'
983
+ default:
984
+ $ref: 'TS29122_CommonData.yaml#/components/responses/default'
985
+
986
+ components:
987
+
988
+ securitySchemes:
989
+ ```
990
+
991
+ ```
992
+ oAuth2ClientCredentials:
993
+ type: oauth2
994
+ flows:
995
+ clientCredentials:
996
+ tokenUrl: '{tokenUrl}'
997
+ scopes: {}
998
+
999
+ schemas:
1000
+
1001
+ #
1002
+ # STRUCTURED DATA TYPES
1003
+ #
1004
+
1005
+ UAVAuthInfo:
1006
+ description: UAV auth data
1007
+ type: object
1008
+ required:
1009
+ - gpsi
1010
+ - serviceLevelId
1011
+ properties:
1012
+ gpsi:
1013
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
1014
+ serviceLevelId:
1015
+ type: string
1016
+ notifyUri:
1017
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
1018
+ notifyCorrId:
1019
+ type: string
1020
+ ipAddr:
1021
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
1022
+ pei:
1023
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei'
1024
+ authMsg:
1025
+ type: string
1026
+ deprecated: true
1027
+ authContainer:
1028
+ type: array
1029
+ items:
1030
+ $ref: '#/components/schemas/AuthContainer'
1031
+ minItems: 1
1032
+ uavLocInfo:
1033
+ $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
1034
+ suppFeat:
1035
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
1036
+
1037
+ UAVAuthResponse:
1038
+ description: UAV auth response data
1039
+ type: object
1040
+ properties:
1041
+ gpsi:
1042
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
1043
+ authContainer:
1044
+ type: array
1045
+ items:
1046
+ $ref: '#/components/schemas/AuthContainer'
1047
+ minItems: 1
1048
+ authMsg:
1049
+ type: string
1050
+ deprecated: true
1051
+ authResult:
1052
+ allOf:
1053
+ - $ref: '#/components/schemas/AuthResult'
1054
+ deprecated: true
1055
+ serviceLevelId:
1056
+ type: string
1057
+ authSessAmbr:
1058
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
1059
+ authProfIndex:
1060
+ type: string
1061
+ suppFeat:
1062
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
1063
+
1064
+ ReauthRevokeNotify:
1065
+ description: UAV related notification
1066
+ type: object
1067
+ ```
1068
+
1069
+ ```
1070
+ required:
1071
+ - gpsi
1072
+ - serviceLevelId
1073
+ - notifyType
1074
+ properties:
1075
+ gpsi:
1076
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
1077
+ serviceLevelId:
1078
+ type: string
1079
+ notifyCorrId:
1080
+ type: string
1081
+ authContainer:
1082
+ type: array
1083
+ items:
1084
+ $ref: '#/components/schemas/AuthContainer'
1085
+ minItems: 1
1086
+ authMsg:
1087
+ type: string
1088
+ deprecated: true
1089
+ notifyType:
1090
+ $ref: '#/components/schemas/NotifyType'
1091
+ ipAddr:
1092
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
1093
+
1094
+ AuthContainer:
1095
+ description: Authentication/Authorization data
1096
+ type: object
1097
+ properties:
1098
+ authMsgType:
1099
+ $ref: '#/components/schemas/AuthMsgType'
1100
+ authMsgPayload:
1101
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
1102
+ authResult:
1103
+ $ref: '#/components/schemas/AuthResult'
1104
+
1105
+ ProblemDetailsAuthenticateAuthorize:
1106
+ description: Extends ProblemDetails to indicate more details during Authentication failure
1107
+ allOf:
1108
+ - $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
1109
+ - $ref: '#/components/schemas/AdditionInfoAuthenticateAuthorize'
1110
+
1111
+ AdditionInfoAuthenticateAuthorize:
1112
+ description: Indicates additional information during authentication failure
1113
+ type: object
1114
+ properties:
1115
+ uasResRelInd:
1116
+ type: boolean
1117
+ description: >
1118
+ Indicates to release the UAV resources during authentication failure, when set to
1119
+ "true". Default is set to "false".
1120
+ ```
1121
+
1122
+ #
1123
+
1124
+ # SIMPLE DATA TYPES
1125
+
1126
+ #
1127
+
1128
+ #
1129
+
1130
+ # ENUMERATIONS
1131
+
1132
+ #
1133
+
1134
+ ```
1135
+ AuthResult:
1136
+ anyOf:
1137
+ - type: string
1138
+ enum:
1139
+ - AUTH_SUCCESS
1140
+ - AUTH_FAIL
1141
+ - type: string
1142
+ description: >
1143
+ This string provides forward-compatibility with future extensions to the enumeration but
1144
+ is not used to encode content defined in the present version of this API.
1145
+ description: |
1146
+ Represents the result of authentication and/or authorization.
1147
+ Possible values are:
1148
+ - AUTH_SUCCESS: The UUAA or C2 authorization has succeeded.
1149
+ - AUTH_FAIL: The UUAA or C2 authorization has failed.
1150
+ ```
1151
+
1152
+ ```
1153
+ NotifyType:
1154
+ anyOf:
1155
+ - type: string
1156
+ enum:
1157
+ ```
1158
+
1159
+ - REAUTHENTICATE
1160
+ - REAUTHORIZE
1161
+ - REVOKE
1162
+ - type: string
1163
+ description: >
1164
+ This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
1165
+
1166
+ description: |
1167
+ Represents the type of notification.
1168
+ Possible values are:
1169
+
1170
+ - REAUTHENTICATE: The UAV needs to be reauthenticated.
1171
+ - REAUTHORIZE: Authorization data needs to be updated to UAV.
1172
+ - REVOKE: Revoke UAV authentication and authorization.
1173
+
1174
+ AuthMsgType:
1175
+ anyOf:
1176
+
1177
+ - type: string
1178
+ enum:
1179
+ - UUAA
1180
+ - C2AUTH
1181
+ - type: string
1182
+ description: >
1183
+ This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
1184
+
1185
+ description: |
1186
+ Represents the type of AA message.
1187
+ Possible values are:
1188
+
1189
+ - UUAA: Indicates that the type of the AA message is UUAA payload.
1190
+ - C2AUTH: Indicates that the type of the AA message is C2 authorization payload.
1191
+
1192
+ # Annex B (informative): Change history
1193
+
1194
+ | Change history | | | | | | | | |
1195
+ |----------------|---------------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------------------------------|--|-------------|
1196
+ | Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version |
1197
+ | 2021-08 | CT3#117-e | C3-214483 | - | - | - | TS skeleton | | 0.0.0 |
1198
+ | 2021-08 | CT3#117-e | C3-214588 | | | | Added scope, introduction, references, and abbreviations. | | 0.1.0 |
1199
+ | 2021-10 | CT3#118-e | C3-215474 | | | | Added service description, operations for Naf_Authentication Service and Naf_Authentication_ReauthNotify, also added resources and data model. | | 0.2.0 |
1200
+ | 2021-11 | CT3#119-e | C3-215474 | | | | Added specification related to reauthentication and revocation. Removed resource and added custom operation. | | 0.3.0 |
1201
+ | 2021-12 | CT#94-e | CP-213207 | | | | Presented for information | | 1.0.0 |
1202
+ | 2022-01 | CT3#119 bis-e | C3-220450 | | | | Inclusion of C3-220494, C3-220265, C3-220362, C3-220340, C3-220268, C3-220279, and C3-220280 | | 1.1.0 |
1203
+ | 2022-02 | CT3#120 | C3-221513 | | | | Inclusion of C3-221241, C3-221242, C3-221686, and C3-221302 | | 1.2.0 |
1204
+ | 2022-03 | CT#95e | CP-220156 | | | | Presentation to TSG CT for approval | | 2.0.0 |
1205
+ | 2022-03 | CT#95e | CP-220156 | | | | Approved by TSG CT | | 17.0.0 |
1206
+ | 2022-06 | CT#96 | CP-221143 | 0001 | | | EN resolution | | 17.1.0 |
1207
+ | 2022-06 | CT#96 | CP-221143 | 0002 | | | Updates to Naf_Authentication_Notification | | 17.1.0 |
1208
+ | 2022-06 | CT#96 | CP-221143 | 0003 | 1 | | Updates to Naf_Authentication_AuthenticateAuthorize service | | 17.1.0 |
1209
+ | 2022-06 | CT#96 | CP-221143 | 0004 | 2 | | Correction to remove revocation cause | | 17.1.0 |
1210
+ | 2022-06 | CT#96 | CP-221143 | 0005 | 1 | | Corrections to open API | | 17.1.0 |
1211
+ | 2022-06 | CT#96 | CP-221143 | 0007 | | | Update the data structures and OpenAPI for Naf_Authentication service | | 17.1.0 |
1212
+ | 2022-06 | CT#96 | CP-221143 | 0008 | | | Correction on data types for UAV Authentication and Authorization | | 17.1.0 |
1213
+ | 2022-06 | CT#96 | CP-221143 | 0009 | | | Correction on Security | | 17.1.0 |
1214
+ | 2022-06 | CT#96 | CP-221143 | 0010 | | | Correction on status codes | | 17.1.0 |
1215
+ | 2022-06 | CT#96 | CP-221151 | 0011 | | | Update of info and externalDocs fields | | 17.1.0 |
1216
+ | 2022-09 | CT#97e | CP-222112 | 0013 | 2 | | Application errors reference update in the tables defining methods on the resources for Naf_Authentication API | | 17.2.0 |
1217
+ | 2022-09 | CT#97e | CP-222112 | 0014 | 1 | | Incomplete implementation of CR #0007 | | 17.2.0 |
1218
+ | 2022-09 | CT#97e | CP-222112 | 0016 | 1 | | Add CAA-Level UAV ID to the authorization response | | 17.2.0 |
1219
+ | 2022-09 | CT#97e | CP-222112 | 0017 | 1 | | Missing description field for enumeration data types | | 17.2.0 |
1220
+ | 2022-09 | CT#97e | CP-222112 | 0018 | 1 | | Operation identifier for Naf_Authentication API | | 17.2.0 |
1221
+ | 2022-09 | CT#97e | CP-222112 | 0019 | 1 | | Update the presence condition of the attributes | | 17.2.0 |
1222
+ | 2022-09 | CT#97e | CP-222121 | 0020 | | | Update of info and externalDocs fields | | 17.2.0 |
1223
+ | 2022-12 | CT#98e | CP-223180 | 0012 | 4 | | Corrections for Auth message type | | 17.3.0 |
1224
+ | 2022-12 | CT#98e | CP-223180 | 0021 | 1 | | Adding missing attributes DN Authorization Profile Index and DN authorized Session AMBR | | 17.3.0 |
1225
+ | 2022-12 | CT#98e | CP-223188 | 0023 | | | Update of info and externalDocs fields | | 17.3.0 |
1226
+ | 2023-03 | CT#99 | CP-230156 | 0024 | 1 | F | Correction of the description fields in enumerations | | 18.0.0 |
1227
+ | 2023-03 | CT#99 | CP-230161 | 0026 | | F | Update of info and externalDocs fields | | 18.0.0 |
1228
+ | 2023-06 | CT#100 | CP-231156 | 0028 | 1 | B | Support for A2X communications | | 18.1.0 |
1229
+ | 2023-12 | CT#102 | CP-233279 | 0029 | 1 | B | Include support for authorization of direct C2 communication over PC5 | | 18.2.0 |
gsma/29_series/29380/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29509/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29512/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29513/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29514/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29515/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29523/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29524/raw.md ADDED
@@ -0,0 +1,555 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # 3GPP TS 29.524 V18.0.0 (2023-12)
4
+
5
+ *Technical Specification*
6
+
7
+ ## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Cause codes mapping between 5GC interfaces; Stage3 (Release 18)**
8
+
9
+ ![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg)
10
+
11
+ The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller text to the right.
12
+
13
+ 5G Advanced logo
14
+
15
+ ![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg)
16
+
17
+ The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a small red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font.
18
+
19
+ 3GPP logo
20
+
21
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
22
+
23
+ ## **3GPP**
24
+
25
+ ---
26
+
27
+ Postal address
28
+
29
+ ---
30
+
31
+ 3GPP support office address
32
+
33
+ ---
34
+
35
+ 650 Route des Lucioles - Sophia Antipolis
36
+ Valbonne - FRANCE
37
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
38
+
39
+ Internet
40
+
41
+ ---
42
+
43
+ <http://www.3gpp.org>
44
+
45
+ ## --- **Copyright Notification** ---
46
+
47
+ No part may be reproduced except as authorized by written permission.
48
+ The copyright and the foregoing restriction extend to reproduction in all media.
49
+
50
+ © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
51
+ All rights reserved.
52
+
53
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
54
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
55
+ LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
56
+ GSM® and the GSM logo are registered and owned by the GSM Association
57
+
58
+ # Contents
59
+
60
+ | | |
61
+ |---------------------------------------------------------------------------------------------------|----|
62
+ | Foreword ..... | 5 |
63
+ | 1 Scope..... | 6 |
64
+ | 2 References..... | 6 |
65
+ | 3 Definitions, symbols and abbreviations ..... | 7 |
66
+ | 3.1 Abbreviations ..... | 7 |
67
+ | 4 Mapping between 5GC interfaces causes and 5GMM Cause Codes by AMF ..... | 7 |
68
+ | 4.1 General ..... | 7 |
69
+ | 4.2 Mapping between Nausf services causes and 5GMM causes ..... | 7 |
70
+ | 4.2.1 General ..... | 7 |
71
+ | 4.2.2 Mapping between Nausf_UEAuthentication service causes on N12 and 5GMM causes ..... | 8 |
72
+ | 4.2.2.1 General ..... | 8 |
73
+ | 4.2.2.2 Mapping from HTTP to 5GMM causes values – Request rejected by AUSF..... | 8 |
74
+ | 4.2.2.3 Mapping from HTTP to 5GMM cause values – Request accepted by AUSF ..... | 8 |
75
+ | 4.3 Mapping between Nsmf services causes and 5GMM causes..... | 9 |
76
+ | 4.3.1 General ..... | 9 |
77
+ | 4.3.2 Mapping between Nsmf_PDUSession service causes on N11 and 5GMM causes ..... | 9 |
78
+ | 4.3.2.1 General ..... | 9 |
79
+ | 4.3.2.2 Mapping from HTTP to 5GMM Cause Values ..... | 9 |
80
+ | 4.4 Mapping between Nudm services causes and 5GMM causes..... | 11 |
81
+ | 4.4.1 General ..... | 11 |
82
+ | 4.4.2 Mapping between Nudm_UEContextManagement service causes on N8 and 5GMM causes..... | 11 |
83
+ | 4.4.2.1 General ..... | 11 |
84
+ | 4.4.2.1 Mapping from HTTP to NAS cause values – Request rejected by UDM..... | 11 |
85
+ | 4.4.3 Mapping between Nudm_SubscriberDataManagement service causes on N8 and 5GMM causes ..... | 11 |
86
+ | 4.4.3.1 General ..... | 11 |
87
+ | 4.4.3.2 Mapping from HTTP to NAS cause values – Request rejected by UDM due to N8 failure ..... | 12 |
88
+ | 4.5 Mapping between Neir services causes and 5GMM causes ..... | 12 |
89
+ | 4.5.1 General ..... | 12 |
90
+ | 4.5.2 Mapping between N5g-eir_EquipmentIdentityCheck Service causes on N17 and 5GMM causes ..... | 12 |
91
+ | 4.5.2.1 General ..... | 12 |
92
+ | 4.5.2.2 Mapping from HTTP to NAS cause values – Request accepted by EIR..... | 12 |
93
+ | 4.6 Mapping between Nnssf services causes and 5GMM causes ..... | 12 |
94
+ | 4.6.1 General ..... | 12 |
95
+ | 4.6.2 Mapping between Nnssf_NSSelection service causes on N22 and 5GMM causes ..... | 12 |
96
+ | 4.6.2.1 General ..... | 12 |
97
+ | 4.6.2.2 Mapping from HTTP to 5GMM Cause Values ..... | 13 |
98
+ | 5 Mapping between 5GC interfaces causes and 5GSM Cause Codes by SMF ..... | 13 |
99
+ | 5.1 General ..... | 13 |
100
+ | 5.2 Mapping between Npcf service causes on N7 and 5GSM causes..... | 13 |
101
+ | 5.2.1 General ..... | 13 |
102
+ | 5.2.2 Mapping between Npcf_SMSPolicyControl Service causes on N7 and 5GSM causes ..... | 13 |
103
+ | 5.2.2.1 General ..... | 13 |
104
+ | 5.2.2.2 Mapping from HTTP to 5GSM cause values – Request rejected by PCF..... | 14 |
105
+ | 5.3 Mapping between Nudm service causes on N10 and 5GSM causes..... | 14 |
106
+ | 5.3.1 General ..... | 14 |
107
+ | 5.3.2 Mapping between Nudm_UEContextManagement service causes on N10 and 5GSM causes ..... | 14 |
108
+ | 5.3.2.1 General ..... | 14 |
109
+ | 5.3.2.2 Mapping from HTTP to 5GSM cause values – Request rejected by UDM due to N10 failures..... | 14 |
110
+ | 5.3.3 Mapping between Nudm_SubscriberDataManagement service causes on N10 and 5GSM causes ..... | 15 |
111
+ | 5.3.3.1 General ..... | 15 |
112
+ | 5.3.3.2 Mapping from HTTP to 5GSM cause values – Request rejected by UDM due to N10 failures..... | 15 |
113
+ | 5.4 Mapping between N4 causes and 5GSM causes..... | 15 |
114
+ | 5.4.1 General ..... | 15 |
115
+ | 5.4.2 Mapping from N4 to 5GSM cause values ..... | 16 |
116
+
117
+ 5.5 Mapping between Nnsacf services causes and 5GSM causes..... 17
118
+ 5.5.1 General ..... 17
119
+ 5.5.2 Mapping between Nnsacf\_NSAC service causes on N81 and 5GSM causes..... 17
120
+ 5.5.2.1 General..... 17
121
+ 5.5.2.2 Mapping from HTTP to 5GSM Cause Values..... 17
122
+ **Annex A (informative): Change history..... 18**
123
+
124
+ # Foreword
125
+
126
+ This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).
127
+
128
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
129
+
130
+ Version x.y.z
131
+
132
+ where:
133
+
134
+ - x the first digit:
135
+ - 1 presented to TSG for information;
136
+ - 2 presented to TSG for approval;
137
+ - 3 or greater indicates TSG approved document under change control.
138
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
139
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
140
+
141
+ In the present document, modal verbs have the following meanings:
142
+
143
+ - shall** indicates a mandatory requirement to do something
144
+ - shall not** indicates an interdiction (prohibition) to do something
145
+
146
+ The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports.
147
+
148
+ The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document.
149
+
150
+ - should** indicates a recommendation to do something
151
+ - should not** indicates a recommendation not to do something
152
+ - may** indicates permission to do something
153
+ - need not** indicates permission not to do something
154
+
155
+ The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended.
156
+
157
+ - can** indicates that something is possible
158
+ - cannot** indicates that something is impossible
159
+
160
+ The constructions "can" and "cannot" are not substitutes for "may" and "need not".
161
+
162
+ - will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
163
+ - will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
164
+ - might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
165
+
166
+ **might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
167
+
168
+ In addition:
169
+
170
+ **is** (or any other verb in the indicative mood) indicates a statement of fact
171
+
172
+ **is not** (or any other negative verb in the indicative mood) indicates a statement of fact
173
+
174
+ The constructions "is" and "is not" do not indicate requirements.
175
+
176
+ # --- 1 Scope
177
+
178
+ The present document specifies the mapping:
179
+
180
+ - performed by the AMF between HTTP responses (Status Codes and Protocol or Application Errors) returned by 5GC NFs to the AMF and 5GMM Cause values sent to UEs;
181
+ - performed by the SMF between HTTP responses (Status Codes and Protocol or Application Errors) returned by 5GC NFs to SMF and 5GSM Cause values sent to UEs;
182
+ - performed by the SMF between N4 errors returned by the UPF and 5GSM Cause values sent to UEs.
183
+
184
+ # --- 2 References
185
+
186
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
187
+
188
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
189
+ - For a specific reference, subsequent revisions do not apply.
190
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
191
+
192
+ - [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
193
+ - [2] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane Nodes".
194
+ - [3] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3".
195
+ - [4] 3GPP TS 29.531: "5G System; Network Slice Selection Services; Stage 3".
196
+ - [5] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3".
197
+ - [6] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3".
198
+ - [7] 3GPP TS 29.509: "5G System; Authentication Server Services; Stage 3".
199
+ - [8] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3".
200
+ - [9] 3GPP TS 29.508: "5G System, Session Management Event Exposure Service; Stage 3".
201
+ - [10] 3GPP TS 29.540: "5G System; SMS Services; Stage3 ".
202
+ - [11] 3GPP TS 29.511: "5G System; Equipment Identity Register Services; Stage 3".
203
+ - [12] 3GPP TS 29.507: "5G System; Access and Mobility Policy Control Service; Stage 3".
204
+ - [13] 3GPP TS 29.525: "5G System; UE Policy Control Service; Stage 3".
205
+
206
+ [xx] 3GPP TS 29.536: "5G System; Network Slice Admission Control Services; Stage 3".
207
+
208
+ # --- 3 Definitions, symbols and abbreviations
209
+
210
+ ## 3.1 Abbreviations
211
+
212
+ For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1].
213
+
214
+ | | |
215
+ |------|-----------------------------------------|
216
+ | 5GC | 5G Core Network |
217
+ | AMF | Access and Mobility Management Function |
218
+ | HTTP | Hypertext Transfer Protocol |
219
+ | NF | Network Function |
220
+ | NSSF | Network Slice Selection Function |
221
+ | PCF | Policy Control Function |
222
+ | SMF | Session Management Function |
223
+ | UDM | Unified Data Management |
224
+
225
+ # --- 4 Mapping between 5GC interfaces causes and 5GMM Cause Codes by AMF
226
+
227
+ ## 4.1 General
228
+
229
+ This clause defines the mapping performed by the AMF between HTTP responses (status codes and Protocol or Application Errors) returned by NF services contacted by the AMF and the 5GMM cause values sent to UEs.
230
+
231
+ No mapping is required for:
232
+
233
+ - the Nsmf\_SMService\_Activate, Nsmf\_SMService\_Deactivate and Nsmf\_SMService\_UplinkSMS operations described in 3GPP TS 29.540 [10].
234
+ - the Npcf\_AMPolicyControl service operations described in 3GPP TS 29.507 [12].
235
+ - the Npcf\_UEPolicyControl service operations described in 3GPP TS 29.525 [13].
236
+
237
+ ## 4.2 Mapping between Nausf services causes and 5GMM causes
238
+
239
+ ### 4.2.1 General
240
+
241
+ This clause defines the mapping performed by the AMF between HTTP responses (status codes and Protocol or Application Errors) returned by AUSF services to the AMF and the 5GMM cause values sent to UEs.
242
+
243
+ ### 4.2.2 Mapping between Nausf\_UEAuthentication service causes on N12 and 5GMM causes
244
+
245
+ #### 4.2.2.1 General
246
+
247
+ This clause defines the mapping for the Nausf\_UEAuthentication service (see 3GPP TS 29.509 [7]). It also contains the mapping in case of a 200 OK is returned but the Authentication has failed.
248
+
249
+ #### 4.2.2.2 Mapping from HTTP to 5GMM causes values – Request rejected by AUSF
250
+
251
+ **Table .4.2.2-1: Mapping from HTTP to 5GMM cause values – Request rejected by AUSF**
252
+
253
+ | HTTP status code on N12 | Protocol or Application Error | 5GMM cause to UE |
254
+ |---------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
255
+ | 403 Forbidden | SERVING_NETWORK_NOT_AUTHORIZED | Cause #11 – PLMN not allowed<br>Cause #73 – Serving network not authorized<br>Cause #12 – Tracking area not allowed<br>Cause #15 – No suitable cells in tracking area<br>(NOTE1) |
256
+ | | AUTHENTICATION_REJECTED | N/A (NOTE 2) |
257
+ | | INVALID_HN_PUBLIC_KEY_IDENTIFIER | N/A (NOTE 2) |
258
+ | | INVALID_HN_PUBLIC_KEY_IDENTIFIER | N/A (NOTE 2) |
259
+ | 404 Not Found | CONTEXT_NOT_FOUND | N/A (NOTE 2) |
260
+ | | USER_NOT_FOUND | |
261
+ | 504 Gateway Timeout | UPSTREAM_SERVER_ERROR | N/A (NOTE 2) |
262
+ | | NETWORK_FAILURE | N/A (NOTE 2) |
263
+ | 500 Internal Server Error | AV_GENERATION_PROBLEM | N/A (NOTE 2) |
264
+ | 501 Not Implemented | UNSUPPORTED_PROTECTION_SCHEME | N/A (NOTE 2) |
265
+
266
+ NOTE 1: One of these 5GMM causes may be used.
267
+ NOTE 2: There is no corresponding mapping since the Authentication is rejected and the Authentication Reject message does not have a 5GMM cause.
268
+
269
+ #### 4.2.2.3 Mapping from HTTP to 5GMM cause values – Request accepted by AUSF
270
+
271
+ **Table .4.2.2.3-1: Mapping from HTTP to 5GMM cause values – Request accepted by AUSF**
272
+
273
+ | HTTP status code on N12 | Protocol or Application Error | 5GMM cause to UE |
274
+ |-------------------------|---------------------------------------------------------------------------------------------------------------------------------|-----------------------|
275
+ | 200 OK | The "authResult" in "ConfirmationDataResponse" is set to "AUTHENTICATION_FAILURE" (see clause 6.1.6.2.8 of 3GPP TS 29.509 [7]). | Cause #3 – Illegal UE |
276
+ | | The "authResult" in "EapSession" is set to "AUTHENTICATION_FAILURE" (see clause 6.1.6.2.8 of 3GPP TS 29.509 [7]). | Cause #3 – Illegal UE |
277
+
278
+ ## 4.3 Mapping between Nsmf services causes and 5GMM causes
279
+
280
+ ### 4.3.1 General
281
+
282
+ This clause defines the mapping performed by the AMF between HTTP responses (status codes and Protocol or Application Errors) returned by SMF services to the AMF and the 5GMM cause values sent to UEs.
283
+
284
+ The AMF may invoke SMF service operations upon receipt of:
285
+
286
+ - 5GSM messages (e.g. PDU Session establishment request) piggybacked in 5GMM UL NAS TRANSPORT message;
287
+ - 5GMM Service Request or Registration Request messages, to establish the user-plane resources of a PDU session.
288
+
289
+ A 5GMM cause is defined in:
290
+
291
+ - the DL NAS TRANSPORT message;
292
+ - the PDU session reactivation result error cause IE of a REGISTRATION ACCEPT or SERVICE ACCEPT message;
293
+ - the REGISTRATION REJECT or SERVICE REJECT message.
294
+
295
+ The AMF shall support mapping the status code and/or Protocol or Application Error received from the SMF to a 5GMM cause code, where 3GPP TS 24.501 [3] requires a 5GMM Cause to be included in the 5GMM message sent to the UE.
296
+
297
+ NOTE: REGISTRATION REJECT and SERVICE REJECT messages are rejected only due to 5GMM-specific reasons, i.e. not for problems specific to session management.
298
+
299
+ ### 4.3.2 Mapping between Nsmf\_PDUSession service causes on N11 and 5GMM causes
300
+
301
+ #### 4.3.2.1 General
302
+
303
+ This clause defines the mapping for the Nsmf\_PDUSession service (see 3GPP TS 29.502 [8]).
304
+
305
+ #### 4.3.2.2 Mapping from HTTP to 5GMM Cause Values
306
+
307
+ Table 4.3.2.2-1: Mapping from HTTP to 5GMM cause values – Request rejected by SMF
308
+
309
+ | HTTP status code on N11 | Protocol or Application Error | 5GMM cause to UE |
310
+ |-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
311
+ | 200 OK | The upCnxState IE is set to DEACTIVATED and the Cause IE set to "INSUFFICIENT_UP_RESOURCES" (see clause 5.2.2.3.2.2 of 3GPP TS 29.502 [8]) (NOTE 2) | #92 - Insufficient user-plane resources for the PDU session |
312
+ | 403 Forbidden | OUT_OF_LADN_SERVICE_AREA | #43 - LADN not available |
313
+ | 403 Forbidden | PRIORITIZED_SERVICES_ONLY | #28 - Restricted service area |
314
+ | 404 Not Found | CONTEXT_NOT_FOUND | N/A (NOTE 1) |
315
+ | | | |
316
+ | | | |
317
+ | | | |
318
+ | 504 Gateway Timeout | NETWORK_FAILURE | N/A (NOTE 1) |
319
+
320
+ NOTE 1: An N1 SM cause is included by the SMF in the HTTP error response in this case.
321
+
322
+ NOTE 2: This corresponds to the scenario where NG-RAN cannot establish user plane resources during the activation of the User Plane connection of a PDU session.
323
+
324
+ ## 4.4 Mapping between Nudm services causes and 5GMM causes
325
+
326
+ ### 4.4.1 General
327
+
328
+ This clause defines the mapping performed by the AMF between HTTP responses (status codes and Protocol or Application Errors) returned by UDM services to AMF and the 5GMM cause values sent to UEs.
329
+
330
+ ### 4.4.2 Mapping between Nudm\_UEContextManagement service causes on N8 and 5GMM causes
331
+
332
+ #### 4.4.2.1 General
333
+
334
+ This clause defines the mapping for the Nudm\_UEContextManagement service is described in 3GPP TS 29.503 [5]).
335
+
336
+ #### 4.4.2.1 Mapping from HTTP to NAS cause values – Request rejected by UDM
337
+
338
+ **Table 4.4.2.1-1: Mapping from HTTP to 5GMM cause values – Request rejected by UDM**
339
+
340
+ | HTTP status code on N8 | Protocol or Application Error | 5GMM cause to UE |
341
+ |-------------------------------------------------------------------------------------------------|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
342
+ | 403 Forbidden | UNKNOWN_5GS_SUBSCRIPTION | #27 – N1 mode not allowed |
343
+ | | ACCESS_NOT_ALLOWED | #15 "No suitable cells in tracking area", or<br>#12 "Tracking area not allowed"<br>or<br>#72 – Non-3GPP access to 5GCN not allowed (NOTE) |
344
+ | | RAT_NOT_ALLOWED | #15 "No suitable cells in tracking area", or<br>#13 "Roaming not allowed in this tracking area", or<br>#12 "Tracking area not allowed" (NOTE) |
345
+ | | NO_PS_SUBSCRIPTION | #7 – 5GS services not allowed |
346
+ | | ROAMING_NOT_ALLOWED | #11 "PLMN not allowed" or<br>#13 "Roaming not allowed in this tracking area", (NOTE) |
347
+ | 404 Not Found | CONTEXT_NOT_FOUND | #9 "UE identity cannot be derived by the network" |
348
+ | 404 Not Found | USER_NOT_FOUND | #3 "Illegal UE" |
349
+ | 422 Unprocessable Entity | UNPROCESSABLE_REQUEST | #111 protocol error unspecified |
350
+ | NOTE: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice. | | |
351
+
352
+ ### 4.4.3 Mapping between Nudm\_SubscriberDataManagement service causes on N8 and 5GMM causes
353
+
354
+ #### 4.4.3.1 General
355
+
356
+ This clause defines the mapping for the Nudm\_SubscriberDataManagement service is described in 3GPP TS 29.503 [5]).
357
+
358
+ #### 4.4.3.2 Mapping from HTTP to NAS cause values – Request rejected by UDM due to N8 failure
359
+
360
+ **Table 4.4.x.2-1: Mapping from HTTP to 5GMM cause values – Request rejected by UDM due to N8 failures when consuming Nudm\_SubscriberDataManagement service**
361
+
362
+ | HTTP status code on N8 | Protocol or Application Error | 5GMM cause to UE |
363
+ |-------------------------------------------------------------------------------------------------|----------------------------------|----------------------------------------------|
364
+ | 404 Not Found | USER_NOT_FOUND<br>DATA_NOT_FOUND | #3 "Illegal UE"<br>#27 "N1 mode not allowed" |
365
+ | NOTE: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice. | | |
366
+
367
+ ## 4.5 Mapping between Neir services causes and 5GMM causes
368
+
369
+ ### 4.5.1 General
370
+
371
+ This clause defines the mapping performed by the AMF between HTTP responses (status code and Protocol or Application Errors) returned by the EIR to the AMF and the 5GMM cause values sent to UEs.
372
+
373
+ ### 4.5.2 Mapping between N5g-eir\_EquipmentIdentityCheck Service causes on N17 and 5GMM causes
374
+
375
+ #### 4.5.2.1 General
376
+
377
+ This clause defines the mapping for the N5g-eir\_EquipmentIdentityCheck service (see 3GPP TS 29.511 [11]).
378
+
379
+ #### 4.5.2.2 Mapping from HTTP to NAS cause values – Request accepted by EIR
380
+
381
+ **Table 4.5.2.2-1: Mapping from HTTP to 5GMM cause values – Request accepted by EIR**
382
+
383
+ | HTTP Status on N17 | Protocol or Application information | 5GMM cause to UE |
384
+ |--------------------|---------------------------------------------------------------------------------------------------------|------------------|
385
+ | 200 OK | Equipment Status is set to "BLACKLISTED", which indicates that the equipment is in the prohibited list. | #6 "Illegal ME" |
386
+
387
+ ## 4.6 Mapping between Nnssf services causes and 5GMM causes
388
+
389
+ ### 4.6.1 General
390
+
391
+ This clause defines the mapping performed by the AMF between HTTP responses (Status Code and Protocol or Application Errors) returned by the NSSF to the AMF and the 5GMM cause values sent to UEs.
392
+
393
+ ### 4.6.2 Mapping between Nnssf\_NSSelection service causes on N22 and 5GMM causes
394
+
395
+ #### 4.6.2.1 General
396
+
397
+ This clause defines the mapping for the Nnssf\_NSSelection service (see 3GPP TS 29.531 [4]).
398
+
399
+ #### 4.6.2.2 Mapping from HTTP to 5GMM Cause Values
400
+
401
+ **Table 4.6.2.2-1: Mapping from HTTP to 5GMM cause values – Request rejected by NSSF**
402
+
403
+ | HTTP status code on N22 | Protocol or Application Error | 5GMM cause to UE |
404
+ |-------------------------|-------------------------------|-----------------------------------|
405
+ | 403 Forbidden | SNSSAI NOT SUPPORTED | #62 – No Network Slices available |
406
+
407
+ # --- 5 Mapping between 5GC interfaces causes and 5GSM Cause Codes by SMF
408
+
409
+ ## 5.1 General
410
+
411
+ This clause describes the mapping performed by the SMF between HTTP responses (status Code and Protocol or Application Errors) returned by NF services contacted by the SMF and the corresponding 5GSM cause values sent to UEs (in5GSMmessages).
412
+
413
+ No mapping is required for the Nsmf\_PDUSession service over N11 since the SMF includes the 5GSM cause in 5GSM messages sent in N1 SM Information (see 3GPP TS 29.502 [5]).
414
+
415
+ No mapping is required for the Nsmf\_PDUSession service over N16 since the 5GSM cause is generated at the H-SMF and provided to the V-SMF in N1 SM Information (see 3GPP TS 29.502 [9]).
416
+
417
+ No mapping is required for the Nsmf\_EventExposure service specified in 3GPP TS 29.508 [9]
418
+
419
+ ## 5.2 Mapping between Npcf service causes on N7 and 5GSM causes
420
+
421
+ ### 5.2.1 General
422
+
423
+ This clause defines the mapping performed by the SMF between HTTP responses (status code and Protocol or Application Errors) returned by the PCF to the SMF and the 5GSM causes sent to UEs.
424
+
425
+ ### 5.2.2 Mapping between Npcf\_SMPolicyControl Service causes on N7 and 5GSM causes
426
+
427
+ #### 5.2.2.1 General
428
+
429
+ This clause defines the mapping for the Npcf\_SMPolicyControl service (see 3GPPTS 29.512 [6]).
430
+
431
+ #### 5.2.2.2 Mapping from HTTP to 5GSM cause values – Request rejected by PCF
432
+
433
+ **Table 5.2.2.2-1: Mapping from HTTP to 5GSM cause values – Request rejected by PCF**
434
+
435
+ | HTTP status code on N7 | Protocol or Application Error | 5GSM cause to UE |
436
+ |------------------------|-------------------------------------|----------------------------------------------------------------|
437
+ | 400 Bad Request | USER_UNKNOWN | Cause #29 - User authentication or authorization failed |
438
+ | | ERROR_INITIAL_PARAMETERS | Cause #31 - Request rejected, unspecified |
439
+ | | ERROR_TRIGGER_EVENT | Cause #31 - Request rejected, unspecified |
440
+ | 403 Forbidden | ERROR_TRAFFIC_MAPPING_INFO_REJECTED | Cause #29 - User authentication or authorization failed |
441
+ | | POLICY_CONTEXT_DENIED | Cause #29 - User authentication or authorization failed (NOTE) |
442
+ | | VALIDATION_CONDITION_NOT_MET | Cause #29 - User authentication or authorization failed |
443
+ | | EXCEEDED_UE_SLICE_DATA_RATE | Cause #69 - Insufficient resources for specific slice |
444
+ | | EXCEEDED_SLICE_DATA_RATE | Cause #69 - Insufficient resources for specific slice |
445
+ | | EXCEEDED_GROUP_DATA_RATE | Cause #69 - Insufficient resources for specific slice |
446
+
447
+ NOTE: Upon receiving the cause POLICY CONTEXT DENIED, the SMF may reject the request, or it may accept the request based on the local policy.
448
+
449
+ ## 5.3 Mapping between Nudm service causes on N10 and 5GSM causes
450
+
451
+ ### 5.3.1 General
452
+
453
+ This clause defines the mapping performed by the SMF between HTTP responses (status codes and Protocol or Application Errors) returned by the UDM to the SMF and the 5GSM causes sent to UEs.
454
+
455
+ ### 5.3.2 Mapping between Nudm\_UEContextManagement service causes on N10 and 5GSM causes
456
+
457
+ #### 5.3.2.1 General
458
+
459
+ This clause defines the mapping for the Nudm\_UEContextManagement service (see 3GPP TS 29.503 [5]).
460
+
461
+ #### 5.3.2.2 Mapping from HTTP to 5GSM cause values – Request rejected by UDM due to N10 failures
462
+
463
+ **Table 5.3.2.2-1: Mapping from HTTP to 5GSM cause values – Request rejected by UDM due to N10 failures**
464
+
465
+ | HTTP status code on N10 | Protocol or Application Error | 5GSM cause to UE |
466
+ |-------------------------|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
467
+ | 403 Forbidden | ROAMING_NOT_ALLOWED | #29 "User authentication or authorization failed" |
468
+ | | DNN_NOT_ALLOWED | #27 "Missing or unknown DNN" or<br>#67 "Insufficient resources for specific slice and DNN"<br>#70 "Missing or unknown DNN in a slice"<br>(NOTE) |
469
+ | 404 Not Found | USER NOT FOUND | #29 "User authentication or authorization failed" |
470
+
471
+ NOTE: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice.
472
+
473
+ ### 5.3.3 Mapping between Nudm\_SubscriberDataManagement service causes on N10 and 5GSM causes
474
+
475
+ #### 5.3.3.1 General
476
+
477
+ This clause defines the mapping for the Nudm\_SubscriberDataManagement service (see 3GPP TS 29.503 [5]).
478
+
479
+ #### 5.3.3.2 Mapping from HTTP to 5GSM cause values – Request rejected by UDM due to N10 failures
480
+
481
+ **Table 5.3.3.2-1: Mapping from HTTP to 5GSM cause values – Request rejected by UDM due to N10 failures when consuming Nudm\_SubscriberDataManagement service**
482
+
483
+ | HTTP status code on N10 | Protocol or Application Error | 5GSM cause to UE |
484
+ |-------------------------|----------------------------------|----------------------------------------------------------------------------------------------------|
485
+ | 404 Not Found | USER NOT FOUND<br>DATA_NOT_FOUND | #29 "User authentication or authorization failed"<br>#33 "Requested service option not subscribed" |
486
+
487
+ NOTE: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice.
488
+
489
+ ## 5.4 Mapping between N4 causes and 5GSM causes
490
+
491
+ ### 5.4.1 General
492
+
493
+ N4 error handling and cause codes are defined in 3GPP TS 29.244 [2].
494
+
495
+ The receipt of an N4 error may trigger error handling in SMF. This clause defines the mapping performed by the SMF between when an error received on N4 interface cannot be resolved by SMF and results in the SMF sending a 5GSM message to the UE.
496
+
497
+ ### 5.4.2 Mapping from N4 to 5GSM cause values
498
+
499
+ **Table 5.4.2-1: Mapping from N4 to 5GSM cause values – Request rejected by SMF due to N4 failures**
500
+
501
+ | <b>N4 Cause Code</b> | | <b>5GSM cause to UE</b> | |
502
+ |------------------------|-----------------------------------------------|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
503
+ | Cause value<br>Decimal | Error description | Cause value | Error description |
504
+ | 64 | Request rejected<br>(reason not<br>specified) | #31 | Request rejected,<br>unspecified |
505
+ | 74 | PFCP entity in<br>congestion | #26<br>#38<br>#69<br>#67 | Insufficient resources<br>Network Failure<br>Insufficient resources<br>for specific slice<br>Insufficient resources<br>for specific slice and<br>DNN |
506
+ | 77 | System failure | #31 | Request rejected,<br>unspecified |
507
+
508
+ ## 5.5 Mapping between Nnsacf services causes and 5GSM causes
509
+
510
+ ### 5.5.1 General
511
+
512
+ This clause defines the mapping performed by the SMF between HTTP responses (Status Code and Protocol or Application Errors) returned by the NSACF to the SMF and the 5GSM cause values sent to UEs.
513
+
514
+ ### 5.5.2 Mapping between Nnsacf\_NSAC service causes on N81 and 5GSM causes
515
+
516
+ #### 5.5.2.1 General
517
+
518
+ This clause defines the mapping for the Nnsacf\_NSAC service (see 3GPP TS 29.536 [14]).
519
+
520
+ #### 5.5.2.2 Mapping from HTTP to 5GSM Cause Values
521
+
522
+ **Table 5.X.2.2-1: Mapping from HTTP to 5GSM cause values – Request rejected by NSACF**
523
+
524
+ | HTTP status code on N81 | Protocol or Application Error | 5GSM cause to UE |
525
+ |-------------------------|-------------------------------|------------------------------------------------|
526
+ | 403 Forbidden | ALL_SLICE_FAILED | #69 –Insufficient resources for specific slice |
527
+
528
+ # Annex A (informative): Change history
529
+
530
+ | Change history | | | | | | | |
531
+ |----------------|-----------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
532
+ | Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version |
533
+ | 2018-10 | CT4#86Bis | | | | | First version of this new TS including:<br>C4-187375 (Skeleton)<br>C4-187378 (N11 – 5GMM)<br>C4-187391 (N8 – 5GMM – Request rejected)<br>C4-187589 (Scope)<br>C4-187390 (N4 – 5GMM) | 0.1.0 |
534
+ | 2018-12 | CT4#87 | | | | | The following agreed documents are included:<br>C4-188418 (NSSF)<br>C4-188484 (Nsmf_PDUSession N11 and N16)<br>C4-188486 (Cause 5GMM)<br>C4-188609 (N4)<br>C4-188637 (N8 and 5GMM)<br>C4-188638 (EIR)<br>C4-188640 (N10 and 5GSM)<br>C4-188641 (N7)<br>C4-188642 (Nausf)<br>C4-188643 (N11 5GMM)<br>C4-188647 (Clean-up) (Conclusion from C4-188384 was wrongly reported to be included in 5GSM General Clause while it applied to 5GMM – corrected by Rapporteur).<br>C4-188648 (General 5GSM) | 0.2.0 |
535
+ | 2018-12 | CT#82 | CP-183104 | | | | Sent for information and approval | 1.0.0 |
536
+ | 2018-12 | CT#82 | CP-183104 | | | | Approved in CT#82 | 15.0.0 |
537
+ | 2019-03 | CT#83 | CP-190031 | 0001 | 2 | F | Corrections on cause mapping in clause 4 | 15.1.0 |
538
+ | 2019-03 | CT#83 | CP-190031 | 003 | 1 | F | Mapping between N11 causes and 5GMM causes | 15.1.0 |
539
+ | 2019-03 | CT#83 | CP-190031 | 0008 | 1 | F | Remove EN's in 5.2.2.2 | 15.1.0 |
540
+ | 2019-03 | CT#83 | CP-190031 | 0004 | 2 | F | Corrections to 5GMM and 5GSM causes mappings | 15.1.0 |
541
+ | 2019-06 | CT#84 | CP-191037 | 0012 | - | F | Cause mapping updates | 15.2.0 |
542
+ | 2019-06 | CT#84 | CP-191037 | 0013 | 1 | F | Correction on cause mapping regarding no subscription | 15.2.0 |
543
+ | 2019-06 | CT#84 | CP-191037 | 0014 | 2 | F | Essential Correction on Error mapping for NSSF Services | 15.2.0 |
544
+ | 2019-06 | CT#84 | CP-191037 | 0015 | 1 | F | Essential Correction on mapping for N4 to SBI | 15.2.0 |
545
+ | 2019-06 | CT#84 | CP-191037 | 0016 | 1 | F | Cause mapping corrections | 15.2.0 |
546
+ | 2019-06 | CT#84 | CP-191037 | 0017 | 1 | F | Add a mapping for N10 | 15.2.0 |
547
+ | 2019-12 | CT#86 | CP-193036 | 0019 | 2 | F | Add new mapping towards Cause #62 (No Network Slices available) | 16.0.0 |
548
+ | 2020-06 | CT#88e | CP-201034 | 0020 | 1 | F | Correction of the mapping between PCF service causes and 5GSM causes | 16.1.0 |
549
+ | 2021-03 | CT#91e | CP-210027 | 0022 | 1 | D | Use of inclusive terminology | 17.0.0 |
550
+ | 2021-03 | CT#91e | CP-210028 | 0023 | 1 | F | ERROR CONFLICTING REQUEST | 17.0.0 |
551
+ | 2021-06 | CT#92e | CP-211146 | 0024 | | F | Editorial Correction | 17.1.0 |
552
+ | 2021-09 | CT#93e | CP-212230 | 0025 | 1 | B | Cause Mapping for NSAC | 17.2.0 |
553
+ | 2021-12 | CT#94e | CP-213086 | 0026 | - | F | Mapping for the cause from Nudm_SubscriberDataManagement | 17.3.0 |
554
+ | 2023-12 | CT#102 | CP-233064 | 0028 | 1 | F | Cause mapping for EXCEEDED_UE_SLICE_DATA_RATE and EXCEEDED_SLICE_DATA_RATE | 17.4.0 |
555
+ | 2023-12 | CT#102 | CP-233047 | 0027 | - | B | Cause mapping for EXCEEDED_GROUP_DATA_RATE | 18.0.0 |
gsma/29_series/29525/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29531/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29536/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29540/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29549/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29571/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29576/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/29_series/29578/raw.md ADDED
@@ -0,0 +1,702 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # 3GPP TS 29.578 V18.1.0 (2023-12)
4
+
5
+ *Technical Specification*
6
+
7
+ ## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Mobile Number Portability Services; Stage 3 (Release 18)**
8
+
9
+ ![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg)
10
+
11
+ The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller text to the right.
12
+
13
+ 5G Advanced logo
14
+
15
+ ![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg)
16
+
17
+ The 3GPP logo, consisting of the letters '3GPP' in a stylized font with a red signal wave icon below the 'G', and the text 'A GLOBAL INITIATIVE' underneath.
18
+
19
+ 3GPP logo
20
+
21
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
22
+
23
+
24
+
25
+ ## **3GPP**
26
+
27
+ ---
28
+
29
+ Postal address
30
+
31
+ ---
32
+
33
+ 3GPP support office address
34
+
35
+ ---
36
+
37
+ 650 Route des Lucioles - Sophia Antipolis
38
+ Valbonne - FRANCE
39
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
40
+
41
+ Internet
42
+
43
+ ---
44
+
45
+ <http://www.3gpp.org>
46
+
47
+ ## --- **Copyright Notification** ---
48
+
49
+ No part may be reproduced except as authorized by written permission.
50
+ The copyright and the foregoing restriction extend to reproduction in all media.
51
+
52
+ © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
53
+ All rights reserved.
54
+
55
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
56
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
57
+ LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
58
+ GSM® and the GSM logo are registered and owned by the GSM Association
59
+
60
+ # Contents
61
+
62
+ | | |
63
+ |------------------------------------------------------------------------------------------|----|
64
+ | Foreword ..... | 6 |
65
+ | 1 Scope..... | 8 |
66
+ | 2 References..... | 8 |
67
+ | 3 Definitions, symbols and abbreviations ..... | 9 |
68
+ | 3.1 Definitions..... | 9 |
69
+ | 3.2 Symbols..... | 9 |
70
+ | 3.3 Abbreviations ..... | 9 |
71
+ | 4 Overview..... | 9 |
72
+ | 4.1 Introduction ..... | 9 |
73
+ | 5 Services offered by the MNPF..... | 10 |
74
+ | 5.1 Introduction ..... | 10 |
75
+ | 5.2 Nmpf_NPStatus Service..... | 10 |
76
+ | 5.2.1 Service Description ..... | 10 |
77
+ | 5.2.2 Service Operations..... | 10 |
78
+ | 5.2.2.1 Introduction..... | 10 |
79
+ | 5.2.2.2 Get..... | 10 |
80
+ | 5.2.2.2.1 General ..... | 10 |
81
+ | 5.2.2.2.2 MNPF Status information retrieval ..... | 10 |
82
+ | 6 API Definitions ..... | 11 |
83
+ | 6.1 Nmpf_NPStatus Service API ..... | 11 |
84
+ | 6.1.1 Introduction ..... | 11 |
85
+ | 6.1.2 Usage of HTTP..... | 11 |
86
+ | 6.1.2.1 General..... | 11 |
87
+ | 6.1.2.2 HTTP standard headers..... | 12 |
88
+ | 6.1.2.2.1 General ..... | 12 |
89
+ | 6.1.2.2.2 Content type ..... | 12 |
90
+ | 6.1.2.3 HTTP custom headers..... | 12 |
91
+ | 6.1.3 Resources..... | 12 |
92
+ | 6.1.3.1 Overview..... | 12 |
93
+ | 6.1.3.2 Resource: NPstatus ..... | 13 |
94
+ | 6.1.3.2.1 Description ..... | 13 |
95
+ | 6.1.3.2.2 Resource Definition..... | 13 |
96
+ | 6.1.3.2.3 Resource Standard Methods..... | 13 |
97
+ | 6.1.4 Custom Operations without associated resources ..... | 13 |
98
+ | 6.1.5 Notifications ..... | 13 |
99
+ | 6.1.6 Data Model ..... | 14 |
100
+ | 6.1.6.1 General..... | 14 |
101
+ | 6.1.6.2 Structured data types..... | 14 |
102
+ | 6.1.6.2.1 Introduction ..... | 14 |
103
+ | 6.1.6.2.2 Type: NpStatusInfo ..... | 14 |
104
+ | 6.1.6.3 Simple data types and enumerations..... | 14 |
105
+ | 6.1.6.3.1 Introduction ..... | 14 |
106
+ | 6.1.6.3.2 Simple data types ..... | 14 |
107
+ | 6.1.6.4 Data types describing alternative data types or combinations of data types ..... | 15 |
108
+ | 6.1.6.5 Binary data..... | 15 |
109
+ | 6.1.7 Error Handling..... | 15 |
110
+ | 6.1.7.1 General..... | 15 |
111
+ | 6.1.7.2 Protocol Errors..... | 15 |
112
+ | 6.1.7.3 Application Errors..... | 15 |
113
+ | 6.1.8 Feature negotiation ..... | 15 |
114
+ | 6.1.9 Security..... | 15 |
115
+
116
+ **Annex A (normative): OpenAPI specification ..... 16**
117
+ A.1 General..... 16
118
+ A.2 Nmnpf\_NPStatus API..... 16
119
+ **Annex B (informative): Withdrawn API versions ..... 17**
120
+ B.1 General..... 17
121
+ B.2 Nmnpf\_NPstatus API..... 17
122
+ **Annex C (informative): Change history..... 19**
123
+
124
+ # Foreword
125
+
126
+ This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).
127
+
128
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
129
+
130
+ Version x.y.z
131
+
132
+ where:
133
+
134
+ - x the first digit:
135
+ - 1 presented to TSG for information;
136
+ - 2 presented to TSG for approval;
137
+ - 3 or greater indicates TSG approved document under change control.
138
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
139
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
140
+
141
+ In the present document, modal verbs have the following meanings:
142
+
143
+ - shall** indicates a mandatory requirement to do something
144
+ - shall not** indicates an interdiction (prohibition) to do something
145
+
146
+ The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports.
147
+
148
+ The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document.
149
+
150
+ - should** indicates a recommendation to do something
151
+ - should not** indicates a recommendation not to do something
152
+ - may** indicates permission to do something
153
+ - need not** indicates permission not to do something
154
+
155
+ The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended.
156
+
157
+ - can** indicates that something is possible
158
+ - cannot** indicates that something is impossible
159
+
160
+ The constructions "can" and "cannot" are not substitutes for "may" and "need not".
161
+
162
+ - will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
163
+ - will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
164
+ - might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
165
+
166
+ **might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
167
+
168
+ In addition:
169
+
170
+ **is** (or any other verb in the indicative mood) indicates a statement of fact
171
+
172
+ **is not** (or any other negative verb in the indicative mood) indicates a statement of fact
173
+
174
+ The constructions "is" and "is not" do not indicate requirements.
175
+
176
+ # --- 1 Scope
177
+
178
+ The present document specifies the stage 3 protocol and data model for the Nnmpf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the MNPF.
179
+
180
+ The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3].
181
+
182
+ The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5].
183
+
184
+ Stage 2 requirements for the Nnmpf services are specified in 3GPP TS 23.540 [14].
185
+
186
+ # --- 2 References
187
+
188
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
189
+
190
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
191
+ - For a specific reference, subsequent revisions do not apply.
192
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
193
+
194
+ - [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
195
+ - [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2".
196
+ - [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2".
197
+ - [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3".
198
+ - [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3".
199
+ - [6] OpenAPI: "OpenAPI Specification Version 3.0.0", <https://spec.openapis.org/oas/v3.0.0>.
200
+ - [7] 3GPP TR 21.900: "Technical Specification Group working methods".
201
+ - [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system".
202
+ - [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework".
203
+ - [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3".
204
+ - [11] IETF RFC 9113: "HTTP/2".
205
+ - [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format".
206
+ - [13] IETF RFC 9457: "Problem Details for HTTP APIs".
207
+ - [14] 3GPP TS 23.540: " Technical realization of Service Based Short Message Service; Stage 2".
208
+ - [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3".
209
+
210
+ # 3 Definitions, symbols and abbreviations
211
+
212
+ ## 3.1 Definitions
213
+
214
+ For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1].
215
+
216
+ **Nmnpf:** Service-based interface exhibited by the MNPF server
217
+
218
+ ## 3.2 Symbols
219
+
220
+ For the purposes of the present document, the following symbols apply:
221
+
222
+ <symbol>            <Explanation>
223
+
224
+ ## 3.3 Abbreviations
225
+
226
+ For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1].
227
+
228
+ | | |
229
+ |------|------------------------------------|
230
+ | MNPF | Mobile Number Portability Function |
231
+ |------|------------------------------------|
232
+
233
+ # 4 Overview
234
+
235
+ ## 4.1 Introduction
236
+
237
+ Within the 5GC, the MNPF offers services to the SMS-GMSC, NRF and SCP via the Nmnpf service based interface (see 3GPP TS 23.501 [2], 3GPP TS 23.502 [3], and 3GPP TS 23.540 [14]).
238
+
239
+ Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the MNPF.
240
+
241
+ ![Reference model diagram for MNPF showing NRF, SMS-GMSC, and SCP connected to the MNPF via the Nmnpf interface.](2a0f333f04f8e672bebf288c511c1db5_img.jpg)
242
+
243
+ The diagram illustrates the reference model for the MNPF. On the left, three functional blocks are shown: NRF, SMS-GMSC, and SCP. Each block is connected to a central interface point labeled 'Nmnpf' via a line representing a service based interface. The connections are labeled SM14 (NRF to Nmnpf), SM12 (SMS-GMSC to Nmnpf), and SM13 (SCP to Nmnpf). The 'Nmnpf' interface is represented by a circle on the left side of a large green rectangular block labeled 'MNPF'.
244
+
245
+ Reference model diagram for MNPF showing NRF, SMS-GMSC, and SCP connected to the MNPF via the Nmnpf interface.
246
+
247
+ **Figure 4.1-1: Reference model – MNPF**
248
+
249
+ The functionalities supported by the MNPF are listed in clause 6.7 of 3GPP TS 23.540 [14].
250
+
251
+ # 5 Services offered by the MNPF
252
+
253
+ ## 5.1 Introduction
254
+
255
+ The MNPF offers the following services via the Nmnpf interface:
256
+
257
+ - Nmnpf\_NPStatus Service
258
+
259
+ Table 5.1-1 summarizes the corresponding APIs defined for this specification.
260
+
261
+ **Table 5.1-1: API Descriptions**
262
+
263
+ | Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex |
264
+ |----------------|--------|----------------------------------------|-----------------------------|----------------|-------|
265
+ | Nmnpf_NPStatus | 6.1 | MNPF Number portability Status Service | TS29578_Nmnpf_NPStatus.yaml | nmnpf-npstatus | A.2 |
266
+
267
+ ## 5.2 Nmnpf\_NPStatus Service
268
+
269
+ ### 5.2.1 Service Description
270
+
271
+ See 3GPP TS 23.540 [14] clause 6.7.1.
272
+
273
+ ### 5.2.2 Service Operations
274
+
275
+ #### 5.2.2.1 Introduction
276
+
277
+ For the Nmnpf\_NPStatus service the following service operations are defined:
278
+
279
+ - Get
280
+
281
+ The Nmnpf\_NPStatus Service is used by Consumer NFs (SMS-GMSC, NRF, SCP) to retrieve the UE's subscription network by means of the Get service operation.
282
+
283
+ #### 5.2.2.2 Get
284
+
285
+ ##### 5.2.2.2.1 General
286
+
287
+ This clause provides a general description of the Get service operation.
288
+
289
+ ##### 5.2.2.2.2 MNPF Status information retrieval
290
+
291
+ Figure 5.2.2.2.2-1 shows a scenario where the NF service consumer (e.g. SMS-GMSC, NRF, SCP) sends a request to the MNPF to receive the UE's Subscription Network (see also clause 5.1.7.2, clause 5.1.7.3 and clause 5.1.7.4 of 3GPP TS 23.540 [14]). The request contains the UE's identity (/{}gpsi{}).
292
+
293
+ ![Sequence diagram showing the interaction between an NF service consumer and an MNPF to request a UE's NP status. The consumer sends a GET request to the MNPF. The MNPF responds with either a 200 OK (NpStatusInfo) or a 404 Not Found.](5a4e62bead259c258d069fd3663ea670_img.jpg)
294
+
295
+ ```
296
+
297
+ sequenceDiagram
298
+ participant NF service consumer
299
+ participant MNPF
300
+ Note left of NF service consumer: Requesting a UE's NP status
301
+ NF service consumer->>MNPF: 1. GET .../{gpsi}
302
+ MNPF-->>NF service consumer: 2a. 200 OK (NpStatusInfo)
303
+ MNPF-->>NF service consumer: 2b. 404 Not Found
304
+
305
+ ```
306
+
307
+ Sequence diagram showing the interaction between an NF service consumer and an MNPF to request a UE's NP status. The consumer sends a GET request to the MNPF. The MNPF responds with either a 200 OK (NpStatusInfo) or a 404 Not Found.
308
+
309
+ **Figure 5.2.2.2.2-1: Requesting a UE's NP statusI**
310
+
311
+ 1. The NF service consumer (e.g. SMS-GMSC, NRF, SCP) sends a GET request to the resource representing the UE's number portability status.
312
+ - 2a. On success, the MNPF responds with "200 OK" with the message body containing the UE's Number Portability Status Information.
313
+ - 2b. If there is no valid information for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element).
314
+
315
+ On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.
316
+
317
+ # 6 API Definitions
318
+
319
+ ## 6.1 Nmnpf\_NPStatus Service API
320
+
321
+ ### 6.1.1 Introduction
322
+
323
+ The Nmnpf\_NPStatus service shall use the Nmnpf\_NPStatus API.
324
+
325
+ The API URI of the Nmnpf\_NPStatus API shall be:
326
+
327
+ **{apiRoot}</apiName>/<apiVersion>**
328
+
329
+ The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
330
+
331
+ **{apiRoot}</apiName>/<apiVersion>/<apiSpecificResourceUriPart>**
332
+
333
+ with the following components:
334
+
335
+ - The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
336
+ - The <apiName> shall be "nmnpf-npstatus".
337
+ - The <apiVersion> shall be "v1".
338
+ - The <apiSpecificResourceUriPart> shall be set as described in clause 6.1.3.
339
+
340
+ ### 6.1.2 Usage of HTTP
341
+
342
+ #### 6.1.2.1 General
343
+
344
+ HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
345
+
346
+ HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
347
+
348
+ The OpenAPI [6] specification of HTTP messages and content bodies for the Nmnpf\_NPStatus API is contained in Annex A.
349
+
350
+ #### 6.1.2.2 HTTP standard headers
351
+
352
+ ##### 6.1.2.2.1 General
353
+
354
+ See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers.
355
+
356
+ ##### 6.1.2.2.2 Content type
357
+
358
+ JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json".
359
+
360
+ "Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13].
361
+
362
+ #### 6.1.2.3 HTTP custom headers
363
+
364
+ The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported.
365
+
366
+ ### 6.1.3 Resources
367
+
368
+ #### 6.1.3.1 Overview
369
+
370
+ This clause describes the structure for the Resource URIs and the resources and methods used for the service.
371
+
372
+ Figure 6.1.3.1-1 depicts the resource URIs structure for the Nmnpf\_NPStatus API.
373
+
374
+ ![Diagram showing the resource URI structure for the Nmnpf_NPStatus API. The root path is {apiRoot}/nmnpf_npstatus/{apiVersion}. A line branches from this root to a box containing the relative path /{gpsi}.](e787e02d9214556476d95941bda1d350_img.jpg)
375
+
376
+ ```
377
+
378
+ {apiRoot}/nmnpf_npstatus/{apiVersion}
379
+ |
380
+ +--> /{gpsi}
381
+
382
+ ```
383
+
384
+ Diagram showing the resource URI structure for the Nmnpf\_NPStatus API. The root path is {apiRoot}/nmnpf\_npstatus/{apiVersion}. A line branches from this root to a box containing the relative path /{gpsi}.
385
+
386
+ **Figure 6.1.3.1-1: Resource URI structure of the Nmnpf\_NPStatus API**
387
+
388
+ Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.
389
+
390
+ **Table 6.1.3.1-1: Resources and methods overview**
391
+
392
+ | Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) |
393
+ |-----------------------|--------------------------------------------|---------------------------------|------------------------------------|
394
+ | NPstatus | /{gpsi} | GET | Retrieve the NP status of the GPSI |
395
+ | | | | |
396
+
397
+ #### 6.1.3.2 Resource: NPstatus
398
+
399
+ ##### 6.1.3.2.1 Description
400
+
401
+ This resource represents the Number Portability status for a GPSI.
402
+
403
+ ##### 6.1.3.2.2 Resource Definition
404
+
405
+ Resource URI: {apiRoot}/nmnpf-npstatus/<apiVersion>/{gpsI}
406
+
407
+ This resource shall support the resource URI variables defined in table 6.1.3.2.2-1.
408
+
409
+ **Table 6.1.3.2.2-1: Resource URI variables for this resource**
410
+
411
+ | Name | Data type | Definition |
412
+ |---------|-----------|----------------------------------------------------------|
413
+ | apiRoot | string | See clause 6.1.1 |
414
+ | gpsI | Gpsi | See 3GPP TS 29.571 [15]; the only valid format is MSISDN |
415
+
416
+ ##### 6.1.3.2.3 Resource Standard Methods
417
+
418
+ ###### 6.1.3.2.3.1 GET
419
+
420
+ This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1.
421
+
422
+ **Table 6.1.3.2.3.1-1: URI query parameters supported by the GET method on this resource**
423
+
424
+ | Name | Data type | P | Cardinality | Description | Applicability |
425
+ |------|-----------|---|-------------|-------------|---------------|
426
+ | n/a | | | | | |
427
+
428
+ This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3.
429
+
430
+ **Table 6.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource**
431
+
432
+ | Data type | P | Cardinality | Description |
433
+ |-----------|---|-------------|-------------|
434
+ | n/a | | | |
435
+
436
+ **Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource**
437
+
438
+ | Data type | P | Cardinality | Response codes | Description |
439
+ |---------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------|
440
+ | NpStatusInfo | M | 1 | 200 OK | Upon success, the response body contains the Number Portability Status information. |
441
+ | ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:<br>- GPSI NOT_FOUND |
442
+ | NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | |
443
+
444
+ ### 6.1.4 Custom Operations without associated resources
445
+
446
+ None.
447
+
448
+ ### 6.1.5 Notifications
449
+
450
+ None.
451
+
452
+ ### 6.1.6 Data Model
453
+
454
+ #### 6.1.6.1 General
455
+
456
+ This clause specifies the application data model supported by the API.
457
+
458
+ Table 6.1.6.1-1 specifies the data types defined for the Nmnpf\_NPStatus service based interface protocol.
459
+
460
+ **Table 6.1.6.1-1: Nmnpf\_NPStatus specific Data Types**
461
+
462
+ | Data type | Clause defined | Description | Applicability |
463
+ |--------------|----------------|---------------------------------------|---------------|
464
+ | NpStatusInfo | 6.1.6.2.2 | Number Portability Status Information | |
465
+
466
+ Table 6.1.6.1-2 specifies data types re-used by the Nmnpf\_NPStatus service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nmnpf\_NPStatus service based interface.
467
+
468
+ **Table 6.1.6.1-2: Nmnpf\_NPStatus re-used Data Types**
469
+
470
+ | Data type | Reference | Comments | Applicability |
471
+ |----------------|---------------------|----------------------------------------|---------------|
472
+ | Gpsi | 3GPP TS 29.571 [15] | General Public Subscription Identifier | |
473
+ | ProblemDetails | 3GPP TS 29.571 [15] | Error description | |
474
+ | PlmnId | 3GPP TS 29.571 [15] | PLMN Identity | |
475
+
476
+ #### 6.1.6.2 Structured data types
477
+
478
+ ##### 6.1.6.2.1 Introduction
479
+
480
+ This clause defines the structures to be used in resource representations.
481
+
482
+ ##### 6.1.6.2.2 Type: NpStatusInfo
483
+
484
+ **Table 6.1.6.2.2-1: Definition of type NpStatusInfo**
485
+
486
+ | Attribute name | Data type | P | Cardinality | Description | Applicability |
487
+ |---------------------|-----------|---|-------------|-------------------------------------------|---------------|
488
+ | subscriptionNetwork | PlmnId | M | 1 | Identifies the GPSI's subscriptionNetwork | |
489
+ | tbc | | | | | |
490
+
491
+ #### 6.1.6.3 Simple data types and enumerations
492
+
493
+ ##### 6.1.6.3.1 Introduction
494
+
495
+ This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
496
+
497
+ ##### 6.1.6.3.2 Simple data types
498
+
499
+ The simple data types defined in table 6.1.6.3.2-1 shall be supported.
500
+
501
+ **Table 6.1.6.3.2-1: Simple data types**
502
+
503
+ | Type Name | Type Definition | Description | Applicability |
504
+ |-----------|-----------------|-------------|---------------|
505
+ | | | | |
506
+
507
+ #### 6.1.6.4 Data types describing alternative data types or combinations of data types
508
+
509
+ None.
510
+
511
+ #### 6.1.6.5 Binary data
512
+
513
+ None.
514
+
515
+ ### 6.1.7 Error Handling
516
+
517
+ #### 6.1.7.1 General
518
+
519
+ For the Nnmpf\_NPStatus API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4].
520
+
521
+ In addition, the requirements in the following clauses are applicable for the Nnmpf\_NPStatus API.
522
+
523
+ #### 6.1.7.2 Protocol Errors
524
+
525
+ Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4].
526
+
527
+ #### 6.1.7.3 Application Errors
528
+
529
+ The application errors defined for the Nnmpf\_NPStatus service are listed in Table 6.1.7.3-1.
530
+
531
+ **Table 6.1.7.3-1: Application errors**
532
+
533
+ | Application Error | HTTP status code | Description |
534
+ |-------------------|------------------|-------------|
535
+ | | | |
536
+
537
+ ### 6.1.8 Feature negotiation
538
+
539
+ The optional features in table 6.1.8-1 are defined for the Nnmpf\_NPStatus API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4].
540
+
541
+ **Table 6.1.8-1: Supported Features**
542
+
543
+ | Feature number | Feature Name | Description |
544
+ |----------------|--------------|-------------|
545
+ | | | |
546
+
547
+ ### 6.1.9 Security
548
+
549
+ As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nnmpf\_NPStatus API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server.
550
+
551
+ If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnmpf\_NPStatus API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2.
552
+
553
+ NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnmpf\_NPStatus service.
554
+
555
+ The Nnmpf\_NPStatus API defines a single scope "nnmpf-npstatus" for the entire service, and it does not define any additional scopes at resource or operation level.
556
+
557
+ # Annex A (normative): OpenAPI specification
558
+
559
+ ## A.1 General
560
+
561
+ This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format.
562
+
563
+ This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s).
564
+
565
+ NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply.
566
+
567
+ Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [5] and clause 5B of 3GPP TR 21.900 [7]).
568
+
569
+ ## A.2 Nmnpf\_NPStatus API
570
+
571
+ ```
572
+ openapi: 3.0.0
573
+ info:
574
+ title: 'Nmnpf_NPStatus'
575
+ version: '1.1.0-alpha.1'
576
+ description: |
577
+ Nmnpf Number Portability Status Service.
578
+ © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
579
+ All rights reserved.
580
+ externalDocs:
581
+ description: 3GPP TS 29.578 V18.0.0; Mobile Number Portability Services.
582
+ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.578/
583
+ servers:
584
+ - url: '{apiRoot}/nmnpf-npstatus/v1'
585
+ variables:
586
+ apiRoot:
587
+ default: https://example.com
588
+ description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
589
+ security:
590
+ - {}
591
+ - oAuth2ClientCredentials:
592
+ - nmnpf-npstatus
593
+ paths:
594
+ /{gpsi}:
595
+ get:
596
+ summary: Retrieves the Number Portability status of the UE
597
+ operationId: GetNumberPortabilityStatus
598
+ tags:
599
+ - Number Portability Status (Document)
600
+ parameters:
601
+ - name: gpsi
602
+ in: path
603
+ description: GPSI of the UE
604
+ required: true
605
+ schema:
606
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
607
+ responses:
608
+ '200':
609
+ description: Expected response to a valid request
610
+ content:
611
+ application/json:
612
+ schema:
613
+ $ref: '#/components/schemas/NpStatusInfo'
614
+ '400':
615
+ $ref: 'TS29571_CommonData.yaml#/components/responses/400'
616
+ ```
617
+
618
+ ```
619
+ '401':
620
+ $ref: 'TS29571_CommonData.yaml#/components/responses/401'
621
+ '403':
622
+ $ref: 'TS29571_CommonData.yaml#/components/responses/403'
623
+ '404':
624
+ description: GPSI Not Found
625
+ content:
626
+ application/problem+json:
627
+ schema:
628
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
629
+ '406':
630
+ $ref: 'TS29571_CommonData.yaml#/components/responses/406'
631
+ '429':
632
+ $ref: 'TS29571_CommonData.yaml#/components/responses/429'
633
+ '500':
634
+ $ref: 'TS29571_CommonData.yaml#/components/responses/500'
635
+ '502':
636
+ $ref: 'TS29571_CommonData.yaml#/components/responses/502'
637
+ '503':
638
+ $ref: 'TS29571_CommonData.yaml#/components/responses/503'
639
+ default:
640
+ description: Unexpected error
641
+
642
+ components:
643
+ securitySchemes:
644
+ oAuth2ClientCredentials:
645
+ type: oauth2
646
+ flows:
647
+ clientCredentials:
648
+ tokenUrl: '{nrfApiRoot}/oauth2/token'
649
+ scopes:
650
+ nmnpf-npstatus: Access to the nmnpf-npstatus API
651
+ schemas:
652
+
653
+ # COMPLEX TYPES:
654
+
655
+ NpStatusInfo:
656
+ description: Contains the Subscription Network
657
+ type: object
658
+ required:
659
+ - subscriptionNetwork
660
+ properties:
661
+ subscriptionNetwork:
662
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
663
+
664
+ # SIMPLE TYPES:
665
+
666
+ # ENUMS:
667
+ ```
668
+
669
+ # --- Annex B (informative): Withdrawn API versions
670
+
671
+ ## B.1 General
672
+
673
+ This Annex lists withdrawn API versions of the APIs defined in the present specification. 3GPP TS 29.501 [5] clause 4.3.1.6 describes the withdrawal of API versions.
674
+
675
+ ## --- B.2 Nmnpf\_NPstatus API
676
+
677
+ The API versions listed in table B.2-1 are withdrawn for the Nmnpf\_NPStatus API.
678
+
679
+ **Table B.2-1: Withdrawn API versions of the Nmnpf\_NPStatus service**
680
+
681
+ | API version number | Remarks |
682
+ |--------------------|---------|
683
+ | | |
684
+
685
+ # Annex C (informative): Change history
686
+
687
+ | Change history | | | | | | | |
688
+ |----------------|----------|-----------|------|------|-----|--------------------------------------------------------------------------------------|-------------|
689
+ | Date | Meeting | TDoc | CR | Re v | Cat | Subject/Comment | New version |
690
+ | 2022-02 | CT4#108e | C4-221536 | | | | Initial draft | 0.1.0 |
691
+ | 2022-04 | CT4#109e | C4-222270 | | | | Pseudo-CR on SCP and NRF supported | 0.2.0 |
692
+ | 2022-05 | CT4#110e | C4-223092 | | | | Pseudo-CR on MNPF name | 0.3.0 |
693
+ | 2022-05 | CT4#110e | C4-223093 | | | | Pseudo-CR on Document Clean Up | 0.3.0 |
694
+ | 2022-05 | CT4#110e | C4-223354 | | | | Pseudo-CR on Remove the apiVersion placeholder from the resource URI variables table | 0.3.0 |
695
+ | 2022-06 | CT#96 | CP-221079 | | | | TS presented for information and approval | 1.0.0 |
696
+ | 2022-06 | CT#96 | CP-221079 | | | | TS approved at CT#95 | 17.0.0 |
697
+ | 2022-09 | CT#97e | CP-222027 | 0003 | | F | Alignment on the service name used with template | 17.1.0 |
698
+ | 2022-09 | CT#97e | CP-222027 | 0004 | 1 | F | Update the reference model | 17.1.0 |
699
+ | 2022-12 | CT#98e | CP-223027 | 0006 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 |
700
+ | 2022-12 | CT#98e | CP-223033 | 0007 | | F | 29.578 Rel-18 API version and External doc update | 18.0.0 |
701
+ | 2023-12 | CT#102 | CP-233028 | 0008 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.1.0 |
702
+ | 2023-12 | CT#102 | CP-233029 | 0009 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.1.0 |
gsma/29_series/29579/raw.md ADDED
@@ -0,0 +1,878 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # 3GPP TS 29.579 V18.3.0 (2023-12)
4
+
5
+ *Technical Specification*
6
+
7
+ ## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Interworking MSC For Short Message Services; Stage 3 (Release 18)**
8
+
9
+ ![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg)
10
+
11
+ The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right.
12
+
13
+ 5G Advanced logo
14
+
15
+ ![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg)
16
+
17
+ The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'G' has a red signal wave icon below it.
18
+
19
+ 3GPP logo
20
+
21
+ A GLOBAL INITIATIVE
22
+
23
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
24
+
25
+ ## **3GPP**
26
+
27
+ ---
28
+
29
+ Postal address
30
+
31
+ ---
32
+
33
+ 3GPP support office address
34
+
35
+ ---
36
+
37
+ 650 Route des Lucioles - Sophia Antipolis
38
+ Valbonne - FRANCE
39
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
40
+
41
+ ---
42
+
43
+ Internet
44
+
45
+ ---
46
+
47
+ <http://www.3gpp.org>
48
+
49
+ ## --- **Copyright Notification** ---
50
+
51
+ No part may be reproduced except as authorized by written permission.
52
+ The copyright and the foregoing restriction extend to reproduction in all media.
53
+
54
+ © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
55
+ All rights reserved.
56
+
57
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
58
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
59
+ LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
60
+ GSM® and the GSM logo are registered and owned by the GSM Association
61
+
62
+ # Contents
63
+
64
+ | | |
65
+ |------------------------------------------------------------------------------------------|----|
66
+ | Foreword ..... | 5 |
67
+ | 1 Scope..... | 7 |
68
+ | 2 References..... | 7 |
69
+ | 3 Definitions and abbreviations ..... | 8 |
70
+ | 3.1 Definitions..... | 8 |
71
+ | 3.2 Abbreviations ..... | 8 |
72
+ | 4 Overview..... | 8 |
73
+ | 4.1 Introduction ..... | 8 |
74
+ | 5 Services offered by the SMS-IWMSC..... | 8 |
75
+ | 5.1 Introduction ..... | 8 |
76
+ | 5.2 Niwmsc_SMService Service..... | 9 |
77
+ | 5.2.1 Service Description ..... | 9 |
78
+ | 5.2.2 Service Operations..... | 9 |
79
+ | 5.2.2.1 Introduction..... | 9 |
80
+ | 5.2.2.2 MoForwardSm ..... | 9 |
81
+ | 5.2.2.2.1 General ..... | 9 |
82
+ | 5.2.2.2.2 SBI-based MO SM transfer..... | 9 |
83
+ | 6 API Definitions ..... | 10 |
84
+ | 6.1 Niwmsc_SMService Service API ..... | 10 |
85
+ | 6.1.1 Introduction ..... | 10 |
86
+ | 6.1.2 Usage of HTTP..... | 10 |
87
+ | 6.1.2.1 General..... | 10 |
88
+ | 6.1.2.2 HTTP standard headers..... | 10 |
89
+ | 6.1.2.2.1 General ..... | 10 |
90
+ | 6.1.2.2.2 Content type ..... | 10 |
91
+ | 6.1.2.3 HTTP custom headers..... | 11 |
92
+ | 6.1.2.4 HTTP multipart messages..... | 11 |
93
+ | 6.1.3 Resources..... | 11 |
94
+ | 6.1.3.1 Overview..... | 11 |
95
+ | 6.1.3.2 Resource: MoSmInfo..... | 12 |
96
+ | 6.1.3.2.1 Description ..... | 12 |
97
+ | 6.1.3.2.2 Resource Definition..... | 12 |
98
+ | 6.1.3.2.3 Resource Standard Methods..... | 12 |
99
+ | 6.1.3.2.4 Resource Custom Operations..... | 13 |
100
+ | 6.1.4 Custom Operations without associated resources ..... | 15 |
101
+ | 6.1.5 Notifications ..... | 15 |
102
+ | 6.1.6 Data Model ..... | 15 |
103
+ | 6.1.6.1 General..... | 15 |
104
+ | 6.1.6.2 Structured data types..... | 15 |
105
+ | 6.1.6.3 Simple data types and enumerations..... | 16 |
106
+ | 6.1.6.3.1 Introduction ..... | 16 |
107
+ | 6.1.6.3.2 Simple data types ..... | 16 |
108
+ | 6.1.6.4 Data types describing alternative data types or combinations of data types ..... | 16 |
109
+ | 6.1.6.5 Binary data..... | 16 |
110
+ | 6.1.6.5.1 Binary Data Types..... | 16 |
111
+ | 6.1.6.5.2 SMS Payload Information..... | 16 |
112
+ | 6.1.7 Error Handling..... | 16 |
113
+ | 6.1.7.1 General..... | 16 |
114
+ | 6.1.7.2 Protocol Errors ..... | 16 |
115
+ | 6.1.7.3 Application Errors..... | 16 |
116
+ | 6.1.8 Feature negotiation ..... | 17 |
117
+ | 6.1.9 Security..... | 17 |
118
+ | 6.1.10 HTTP redirection..... | 17 |
119
+
120
+ **Annex A (normative): OpenAPI specification ..... 18**
121
+ A.1 General..... 18
122
+ A.2 Niwmsc\_SMService API..... 18
123
+ **Annex B (informative): Withdrawn API versions ..... 20**
124
+ B.1 General..... 20
125
+ B.2 Niwmsc\_SMService API..... 20
126
+ **Annex C (informative): Change history..... 21**
127
+
128
+ # Foreword
129
+
130
+ This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).
131
+
132
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
133
+
134
+ Version x.y.z
135
+
136
+ where:
137
+
138
+ - x the first digit:
139
+ - 1 presented to TSG for information;
140
+ - 2 presented to TSG for approval;
141
+ - 3 or greater indicates TSG approved document under change control.
142
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
143
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
144
+
145
+ In the present document, modal verbs have the following meanings:
146
+
147
+ - shall** indicates a mandatory requirement to do something
148
+ - shall not** indicates an interdiction (prohibition) to do something
149
+
150
+ The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports.
151
+
152
+ The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document.
153
+
154
+ - should** indicates a recommendation to do something
155
+ - should not** indicates a recommendation not to do something
156
+ - may** indicates permission to do something
157
+ - need not** indicates permission not to do something
158
+
159
+ The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended.
160
+
161
+ - can** indicates that something is possible
162
+ - cannot** indicates that something is impossible
163
+
164
+ The constructions "can" and "cannot" are not substitutes for "may" and "need not".
165
+
166
+ - will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
167
+ - will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
168
+ - might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
169
+
170
+ **might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
171
+
172
+ In addition:
173
+
174
+ **is** (or any other verb in the indicative mood) indicates a statement of fact
175
+
176
+ **is not** (or any other negative verb in the indicative mood) indicates a statement of fact
177
+
178
+ The constructions "is" and "is not" do not indicate requirements.
179
+
180
+ # 1 Scope
181
+
182
+ The present document specifies the stage 3 protocol and data model for the Niwmsc Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the SMS-IWMSC.
183
+
184
+ The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3].
185
+
186
+ The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5].
187
+
188
+ Stage 2 requirements for the Niwmsc services are specified in 3GPP TS 23.540 [14].
189
+
190
+ # 2 References
191
+
192
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
193
+
194
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
195
+ - For a specific reference, subsequent revisions do not apply.
196
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
197
+
198
+ - [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
199
+ - [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2".
200
+ - [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2".
201
+ - [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3".
202
+ - [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3".
203
+ - [6] OpenAPI: "OpenAPI Specification Version 3.0.0", <https://spec.openapis.org/oas/v3.0.0>.
204
+ - [7] 3GPP TR 21.900: "Technical Specification Group working methods".
205
+ - [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system".
206
+ - [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework".
207
+ - [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3".
208
+ - [11] IETF RFC 9113: "HTTP/2".
209
+ - [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format".
210
+ - [13] IETF RFC 9457: "Problem Details for HTTP APIs".
211
+ - [14] 3GPP TS 23.540: "Technical realization of Service Based Short Message Service; Stage 2".
212
+ - [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3".
213
+ - [16] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)".
214
+ - [17] 3GPP TS 29.577: "5G System; IP Short Message Gateway and SMS Router For Short Message Service; Stage 3".
215
+ - [18] 3GPP TS 24.011: " Point-to-Point (PP) Short Message Service (SMS) support on mobile radio interface".
216
+
217
+ # 3 Definitions and abbreviations
218
+
219
+ ## 3.1 Definitions
220
+
221
+ For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1].
222
+
223
+ **Niwmsc:** Service-based interface exhibited by the SMS-IWMSC
224
+
225
+ ## 3.2 Abbreviations
226
+
227
+ For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1].
228
+
229
+ | | |
230
+ |-------|---------------------------------|
231
+ | SM MO | Short Message Mobile Originated |
232
+ |-------|---------------------------------|
233
+
234
+ # 4 Overview
235
+
236
+ ## 4.1 Introduction
237
+
238
+ The SMS-IWMSC offers services to the SMSF via the Niwmsc service based interface (see 3GPP TS 23.501 [2], 3GPP TS 23.502 [3], and 3GPP TS 23.540 [14]).
239
+
240
+ Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the SMS-IWMSC.
241
+
242
+ ![Reference model diagram showing SMSF connected to SMS-IWMSC via SM10 interface and Niwmsc service-based interface.](18f841ac4f2ef28f34a026f1bdc5af9a_img.jpg)
243
+
244
+ The diagram illustrates the reference model for the SMS-IWMSC. On the left, a white rectangular box is labeled 'SMSF'. A horizontal line, representing the SM10 interface, connects this box to a green rectangular box on the right labeled 'SMS-IWMSC'. The connection point on the SMS-IWMSC side is marked with a small circle and labeled 'Niwmsc', indicating the service-based interface.
245
+
246
+ Reference model diagram showing SMSF connected to SMS-IWMSC via SM10 interface and Niwmsc service-based interface.
247
+
248
+ **Figure 4.1-1: Reference model – SMS-IWMSC**
249
+
250
+ The functionalities supported by the SMS-IWMSC are listed in clause 6.3 of 3GPP TS 23.540 [14].
251
+
252
+ # 5 Services offered by the SMS-IWMSC
253
+
254
+ ## 5.1 Introduction
255
+
256
+ The SMS-IWMSC offers the following services via the Niwmsc interface:
257
+
258
+ - Niwmsc\_SMService Service
259
+
260
+ Table 5.1-1 summarizes the corresponding APIs defined for this specification.
261
+
262
+ **Table 5.1-1: API Descriptions**
263
+
264
+ | Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex |
265
+ |------------------|--------|---------------------------------|-------------------------------|-------------------|-------|
266
+ | Niwmsc_SMService | 6.1 | SMS-IWMSC short message service | TS29579_Niwmsc_SMService.yaml | niwmsc-smbservice | A.2 |
267
+
268
+ ## 5.2 Niwmsc\_SMService Service
269
+
270
+ ### 5.2.1 Service Description
271
+
272
+ See 3GPP TS 23.540 [14] clause 6.3.1
273
+
274
+ ### 5.2.2 Service Operations
275
+
276
+ #### 5.2.2.1 Introduction
277
+
278
+ For the Niwmsc\_SMService service the following service operations are defined:
279
+
280
+ - MoForwardSm
281
+
282
+ The Niwmsc\_SMService Service is used by Consumer NFs (SMSF) to transfer MO short message by means of the MoForwardSm service operation.
283
+
284
+ #### 5.2.2.2 MoForwardSm
285
+
286
+ ##### 5.2.2.2.1 General
287
+
288
+ This clause provides a general description of the MoForwardSm service operation.
289
+
290
+ ##### 5.2.2.2.2 SBI-based MO SM transfer
291
+
292
+ The MoForwardSm service operation shall be used to transmit uplink SMS message via SMS-IWMSC.
293
+
294
+ It is used in the following procedures:
295
+
296
+ - Successful Mobile Originated short message transfer via SMS-IWMSC (see clause 5.2.2 of 3GPP TS 23.540 [14]).
297
+ - Unsuccessful Mobile Originated short message transfer via SMS-IWMSC (see clause 5.2.3 of 3GPP TS 23.540 [14]).
298
+
299
+ The NF Service Consumer (e.g. SMSF) shall transmit uplink SMS message to the SMS-IWMSC by using the HTTP POST method as shown in Figure 5.2.2.2.1-1.
300
+
301
+ ![Sequence diagram showing SBI-based MO SM transfer between NF Service Consumer and SMS-IWMSC.](97a08abb8a43f3f8c6ce347199cd909a_img.jpg)
302
+
303
+ ```
304
+
305
+ sequenceDiagram
306
+ participant NF Service Consumer
307
+ participant SMS-IWMSC
308
+ Note right of NF Service Consumer: (SMS Data)
309
+ NF Service Consumer->>SMS-IWMSC: 1. POST ../mo-sm-info/{supi}/sendsms
310
+ SMS-IWMSC-->>NF Service Consumer: 2a. 200 OK (Delivery Report)
311
+ SMS-IWMSC-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx
312
+
313
+ ```
314
+
315
+ The diagram illustrates the interaction between an NF Service Consumer and an SMS-IWMSC. The consumer sends a POST request (step 1) to the SMS-IWMSC, including SMS data. The SMS-IWMSC responds with either a 200 OK (Delivery Report) (step 2a) or a 4xx/5xx (ProblemDetails) or 3xx (step 2b).
316
+
317
+ Sequence diagram showing SBI-based MO SM transfer between NF Service Consumer and SMS-IWMSC.
318
+
319
+ **Figure 5.2.2.2.2.1-1: SBI-based MO SM transfer**
320
+
321
+ 1. The NF Service Consumer shall send a POST request to the resource representing the UE's Mobile Originated Short Message Information resource (i.e. .../mo-sm-info/{supi}/sendsmss) of the SMS-IWMSC. The content of the POST request shall contain the SMS message to be sent.
322
+ - 2a. On success, "200 OK" shall be returned with "SmsDeliveryData" object contains the MO SMS Delivery Report in the response body.
323
+ - 2b. On failure, or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.2.2-2 shall be returned.
324
+
325
+ # --- 6 API Definitions
326
+
327
+ ## 6.1 Niwmsc\_SMService Service API
328
+
329
+ ### 6.1.1 Introduction
330
+
331
+ The Niwmsc\_SMService shall use the Niwmsc\_SMService API.
332
+
333
+ The API URI of the Niwmsc\_SMService API shall be:
334
+
335
+ **{apiRoot}</apiName></apiVersion>**
336
+
337
+ The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
338
+
339
+ **{apiRoot}</apiName></apiVersion></apiSpecificResourceUriPart>**
340
+
341
+ with the following components:
342
+
343
+ - The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
344
+ - The <apiName> shall be "niwmsc-smbservice".
345
+ - The <apiVersion> shall be "v1".
346
+ - The <apiSpecificResourceUriPart> shall be set as described in clause 6.1.3.
347
+
348
+ ### 6.1.2 Usage of HTTP
349
+
350
+ #### 6.1.2.1 General
351
+
352
+ HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
353
+
354
+ HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
355
+
356
+ The OpenAPI [6] specification of HTTP messages and content bodies for the Niwmsc\_SMService API is contained in Annex A.
357
+
358
+ #### 6.1.2.2 HTTP standard headers
359
+
360
+ ##### 6.1.2.2.1 General
361
+
362
+ See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers.
363
+
364
+ ##### 6.1.2.2.2 Content type
365
+
366
+ JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json".
367
+
368
+ "Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13].
369
+
370
+ Multipart messages shall also be supported (see clause 6.1.2.4) using the content type "multipart/related", comprising:
371
+
372
+ - one JSON body part with the "application/json" content type; and
373
+ - one binary body part with 3gpp vendor specific content subtypes.
374
+
375
+ The 3gpp vendor specific content subtypes defined in Table 6.1.2.2.2-1 shall be supported.
376
+
377
+ **Table 6.1.2.2.2-1: 3GPP vendor specific content subtypes**
378
+
379
+ | content subtype | Description |
380
+ |-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
381
+ | vnd.3gpp.sms | Binary encoded payload, encoding SMS payload, as specified in 3GPP TS 23.040 [16] and 3GPP TS 24.011 [17]. |
382
+ | NOTE: | Using 3GPP vendor content subtypes allows to describe the nature of the opaque payload (e.g. SMS payload) without having to rely on metadata in the JSON content. |
383
+
384
+ See clause 6.1.2.4 for the binary payloads supported in the binary body part of multipart messages.
385
+
386
+ #### 6.1.2.3 HTTP custom headers
387
+
388
+ The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported.
389
+
390
+ #### 6.1.2.4 HTTP multipart messages
391
+
392
+ HTTP multipart messages shall be supported, to transfer opaque SMS payload (e.g. SMS message, CP Ack, etc.), in the following service operations (and HTTP messages):
393
+
394
+ - MoForwardSm service operation;
395
+
396
+ HTTP multipart messages shall include one JSON body part and one binary body part comprising content of SMS payload content (see clause 6.1.6.5).
397
+
398
+ The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of the multipart message. The "Start" parameter does not need to be included.
399
+
400
+ The multipart message shall include a "type" parameter (see IETF RFC 2387 [18]) specifying the media type of the root body part, i.e. "application/json".
401
+
402
+ NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a multipart/related message, see IETF RFC 2387 [18]. The default root is the first body within the multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the first body part in the message.
403
+
404
+ A binary body part shall include a Content-ID header (see IETF RFC 2045 [19]), and the JSON body part shall make a reference to the binary body part using the Content-ID header field.
405
+
406
+ Examples of multipart/related messages can be found in Annex B.
407
+
408
+ ### 6.1.3 Resources
409
+
410
+ #### 6.1.3.1 Overview
411
+
412
+ This clause describes the structure for the Resource URIs and the resources and methods used for the service.
413
+
414
+ Figure 6.1.3.1-1 depicts the resource URIs structure for the Niwmse\_SMSService API.
415
+
416
+ ![Diagram showing the hierarchical structure of the Niwmsc_SMSService API URI. The root is {apiRoot}/niwmsc_smbservice/<apiVersion>. It branches to /mo-sm-info, which branches to /{supi}, which branches to /send sms (dashed box).](27b06ec9f42b5d727a2630f61a5f1861_img.jpg)
417
+
418
+ {apiRoot}/niwmsc\_smbservice/<apiVersion>
419
+
420
+ ```
421
+
422
+ graph TD
423
+ Root["{apiRoot}/niwmsc_smbservice/<apiVersion>"] --> MoSmInfo["/mo-sm-info"]
424
+ MoSmInfo --> Supi["/{supi}"]
425
+ Supi --> SendSms["/send sms"]
426
+ style SendSms stroke-dasharray: 5 5
427
+
428
+ ```
429
+
430
+ Diagram showing the hierarchical structure of the Niwmsc\_SMSService API URI. The root is {apiRoot}/niwmsc\_smbservice/. It branches to /mo-sm-info, which branches to /{supi}, which branches to /send sms (dashed box).
431
+
432
+ **Figure 6.1.3.1-1: Resource URI structure of the Niwmsc\_SMSService API**
433
+
434
+ Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.
435
+
436
+ **Table 6.1.3.1-1: Resources and methods overview**
437
+
438
+ | Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) |
439
+ |-----------------------|--------------------------------------------|---------------------------------|---------------------------------|
440
+ | SMSService | /mo-sm-info/{supi}/send sms | send sms (POST) | MO short message transfer |
441
+ | | | | |
442
+ | | | | |
443
+ | | | | |
444
+ | | | | |
445
+
446
+ #### 6.1.3.2 Resource: MoSmInfo
447
+
448
+ ##### 6.1.3.2.1 Description
449
+
450
+ This resource represents the collection of Mobile Originated Short Message Information in SMS-IWMSC.
451
+
452
+ This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]).
453
+
454
+ ##### 6.1.3.2.2 Resource Definition
455
+
456
+ Resource URI: {apiRoot}/<apiName>/<apiVersion>/mo-sm-info{supi}
457
+
458
+ This resource shall support the resource URI variables defined in table 6.1.3.2.2-1.
459
+
460
+ **Table 6.1.3.2.2-1: Resource URI variables for this resource**
461
+
462
+ | Name | Data type | Definition |
463
+ |---------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------|
464
+ | apiRoot | string | See clause 6.1.1 |
465
+ | supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)<br>pattern: See pattern of type Supi in 3GPP TS 29.571 [15] |
466
+
467
+ ##### 6.1.3.2.3 Resource Standard Methods
468
+
469
+ No HTTP method has been defined for the Mobile Originated Short Message Information collection resource.
470
+
471
+ ##### 6.1.3.2.4 Resource Custom Operations
472
+
473
+ ###### 6.1.3.2.4.1 Overview
474
+
475
+ **Table 6.1.3.2.4.1-1: Custom operations**
476
+
477
+ | Operation name | Custom operation URI | Mapped HTTP method | Description |
478
+ |----------------|-----------------------------|--------------------|-----------------------------------------------------|
479
+ | sendsms | /mo-sm-infos/{supi}/sendsms | POST | Send MO SMS message or the related Delivery Report. |
480
+
481
+ ###### 6.1.3.2.4.2 Operation: sendsms
482
+
483
+ ###### 6.1.3.2.4.2.1 Description
484
+
485
+ This custom operation is used for NF Service Consumers to send SMS message in uplink direction.
486
+
487
+ ###### 6.1.3.2.4.2.2 Operation Definition
488
+
489
+ This custom operation is used to send a SMS payload to an UE's Mobile Originated Short Message Information resource in the SMS-IWMSC.
490
+
491
+ This operation shall support the request data structures specified in table 6.1.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.2.2-2.
492
+
493
+ **Table 6.1.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource**
494
+
495
+ | Data type | P | Cardinality | Description |
496
+ |-----------|---|-------------|--------------------------------------------------|
497
+ | SmsData | M | 1 | Representation of the MO SMS message to be sent. |
498
+
499
+ **Table 6.1.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource**
500
+
501
+ | Data type | P | Cardinality | Response codes | Description |
502
+ |------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
503
+ | SmsDeliveryData | M | 1 | 200 OK | This case represents the successful of sending SMS message in uplink direction, with necessary response data on the received delivery report. |
504
+ | RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) |
505
+ | RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) |
506
+ | ProblemDetails | O | 0..1 | 400 Bad Request | This case represents an unsuccessful delivery of SMS message.<br>The "cause" attribute may be used to indicate one of the following application errors: <ul style="list-style-type: none"> <li>- SMS_PAYLOAD_MISSING, if the expected SMS payload content is missing;</li> <li>- SMS_PAYLOAD_ERROR, if error exists in the SMS payload content.</li> </ul> |
507
+ | ProblemDetails | O | 0..1 | 403 Forbidden | This case represents an unsuccessful delivery of SMS message.<br>The "cause" attribute may be used to indicate one of the following application errors: <ul style="list-style-type: none"> <li>- UNKNOWN_SERVICE_CENTRE_ADDRESS, if the SMS-SC was unknown;</li> <li>- SERVICE_CENTRE_CONGESTION, if the SMS-SC was in congestion;</li> <li>- USER_NOT_SERVICE_CENTER, if the user didn't belongs to the SMS-SC;</li> <li>- FACILITY_NOT_SUPPORTED, if the facility not supported;</li> <li>- INVALID_SME_ADDRESS, if the SME address is invalid..</li> </ul> |
508
+ | ProblemDetails | O | 0..1 | 504 Gateway Timeout | This case represents an unsuccessful delivery of SMS message.<br>The "cause" attribute may be used to indicate one of the following application errors: <ul style="list-style-type: none"> <li>- UNREACHABLE_SMS_SC, if the response is timeout.</li> </ul> |
509
+
510
+ NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.
511
+
512
+ **Table 6.1.3.2.4.2.2-3: Headers supported by the 307 Response Code on this resource**
513
+
514
+ | Name | Data type | P | Cardinality | Description |
515
+ |-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
516
+ | Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMS-IWMSC or SMS-IWMSC (service) set.<br>For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. |
517
+ | 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected |
518
+
519
+ **Table 6.1.3.2.4.2.2-4: Headers supported by the 308 Response Code on this resource**
520
+
521
+ | Name | Data type | P | Cardinality | Description |
522
+ |-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
523
+ | Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMS-IWMSC or SMS-IWMSC (service) set.<br>For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. |
524
+ | 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected |
525
+
526
+ ### 6.1.4 Custom Operations without associated resources
527
+
528
+ In this release of this specification, no custom operations without associated resources are defined.
529
+
530
+ ### 6.1.5 Notifications
531
+
532
+ In this release of this specification, no notification procedures are defined.
533
+
534
+ ### 6.1.6 Data Model
535
+
536
+ #### 6.1.6.1 General
537
+
538
+ This clause specifies the application data model supported by the API.
539
+
540
+ Table 6.1.6.1-1 specifies the data types defined for the Niwmsc\_SMSService service based interface protocol.
541
+
542
+ **Table 6.1.6.1-1: Niwmsc\_SMSService specific Data Types**
543
+
544
+ | Data type | Clause defined | Description | Applicability |
545
+ |-----------|----------------|-------------|---------------|
546
+ | N/A | | | |
547
+
548
+ Table 6.1.6.1-2 specifies data types re-used by the Niwmsc\_SMSService service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Niwmsc\_SMSService service based interface.
549
+
550
+ **Table 6.1.6.1-2: Niwmsc\_SMSService re-used Data Types**
551
+
552
+ | Data type | Reference | Comments | Applicability |
553
+ |-------------------|---------------------|--------------------------------------------------------------------------------------------------------------------|---------------|
554
+ | ProblemDetails | 3GPP TS 29.571 [15] | Common Data Type used in response bodies | |
555
+ | RedirectResponse | 3GPP TS 29.571 [15] | Redirect Response | |
556
+ | Supi | 3GPP TS 29.571 [15] | Subscription Permanent Identifier | |
557
+ | RefToBinaryData | 3GPP TS 29.571 [15] | Information for indicating the binary content of SMS payload. | |
558
+ | Ipv4Addr | 3GPP TS 29.571 [15] | IPv4 address | |
559
+ | Ipv6Addr | 3GPP TS 29.571 [15] | IPv6 address | |
560
+ | SupportedFeatures | 3GPP TS 29.571 [15] | Supported Features | |
561
+ | SmsData | 3GPP TS 29.577 [17] | Information within request message invoking MoForwardSm service operation, for delivering MO SMS. | |
562
+ | SmsDeliveryData | 3GPP TS 29.571 [17] | Information within response message invoking MoForwardSm service operation, for delivering MO SMS Delivery Report. | |
563
+
564
+ #### 6.1.6.2 Structured data types
565
+
566
+ In this release of this specification, no structure to be used in resource representations is defined.
567
+
568
+ #### 6.1.6.3 Simple data types and enumerations
569
+
570
+ ##### 6.1.6.3.1 Introduction
571
+
572
+ This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
573
+
574
+ ##### 6.1.6.3.2 Simple data types
575
+
576
+ The simple data types defined in table 6.1.6.3.2-1 shall be supported.
577
+
578
+ **Table 6.1.6.3.2-1: Simple data types**
579
+
580
+ | Type Name | Type Definition | Description | Applicability |
581
+ |-----------|-----------------|-------------|---------------|
582
+ | N/A | | | |
583
+
584
+ #### 6.1.6.4 Data types describing alternative data types or combinations of data types
585
+
586
+ None.
587
+
588
+ #### 6.1.6.5 Binary data
589
+
590
+ ##### 6.1.6.5.1 Binary Data Types
591
+
592
+ **Table 6.1.6.5.1-1: Binary Data Types**
593
+
594
+ | Name | Clause defined | Content type |
595
+ |-------------------------|----------------|--------------|
596
+ | SMS Payload Information | 6.1.6.4.2 | vnd.3gpp.sms |
597
+
598
+ ##### 6.1.6.5.2 SMS Payload Information
599
+
600
+ SMS Payload Information shall encode a SMS payload as specified in 3GPP TS 23.040 [16] and 3GPP TS 24.011 [18], using the vnd.3gpp.sms content-type.
601
+
602
+ SMS Payload Information may encode e.g. the following content:
603
+
604
+ - CP-DATA, CP-ACK, CP-ERROR as specified in 3GPP TS 23.040 [16] and 3GPP TS 24.011 [18].
605
+
606
+ ### 6.1.7 Error Handling
607
+
608
+ #### 6.1.7.1 General
609
+
610
+ For the Niwmsc\_SMService API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4].
611
+
612
+ In addition, the requirements in the following clauses are applicable for the Niwmsc\_SMService API.
613
+
614
+ #### 6.1.7.2 Protocol Errors
615
+
616
+ No specific procedures for the Niwmsc\_SMService service are specified.
617
+
618
+ #### 6.1.7.3 Application Errors
619
+
620
+ The application errors defined for the Niwmsc\_SMService service are listed in Table 6.1.7.3-1.
621
+
622
+ **Table 6.1.7.3-1: Application errors**
623
+
624
+ | Application Error | HTTP status code | Description |
625
+ |---------------------------|---------------------|-----------------------------------------------------------------------------------------|
626
+ | SMS_PAYLOAD_MISSING | 400 Bad Request | The expected SMS payload content is missing. |
627
+ | SMS_PAYLOAD_ERROR | 400 Bad Request | Errors exist in the format of SMS payload. |
628
+ | SERVICE_CENTRE_CONGESTION | 403 Forbidden | The delivery of the MO short message failed because SMS-SC was in congestion. |
629
+ | USER_NOT_SERVICE_CENTER | 403 Forbidden | The delivery of the short message failed because the user didn't belongs to the SMS-SC. |
630
+ | FACILITY_NOT_SUPPORTED | 403 Forbidden | The delivery of the MO short message failed because of facility not supported. |
631
+ | INVALID_SME_ADDRESS | 403 Forbidden | The delivery of the MO short message failed because the SME address is invalid. |
632
+ | UNREACHABLE_SMS_SC | 504 Gateway Timeout | The delivery of the MO short message failed because the response is timeout. |
633
+
634
+ ### 6.1.8 Feature negotiation
635
+
636
+ The optional features in table 6.1.8-1 are defined for the Niwmsc\_SMService API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4].
637
+
638
+ **Table 6.1.8-1: Supported Features**
639
+
640
+ | Feature number | Feature Name | Description |
641
+ |----------------|--------------|-------------|
642
+ | N/A | | |
643
+
644
+ ### 6.1.9 Security
645
+
646
+ As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Niwmsc\_SMService API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server.
647
+
648
+ If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Niwmsc\_SMService API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2.
649
+
650
+ NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Niwmsc\_SMService service.
651
+
652
+ The Niwmsc\_SMService API defines a single scope "niwmsc-smbservice" for the entire service, and it does not define any additional scopes at resource or operation level.
653
+
654
+ ### 6.1.10 HTTP redirection
655
+
656
+ An HTTP request may be redirected to a different SMS-IWMSC service instance, within the same SMS-IWMSC or a different SMS-IWMSC of an SMS-IWMSC set, e.g. when an SMS-IWMSC service instance is part of an SMS-IWMSC (service) set or when using indirect communications (see 3GPP TS 29.500 [4]).
657
+
658
+ An SCP that reselects a different SMS-IWMSC producer instance will return the NF Instance ID of the new SMS-IWMSC producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4].
659
+
660
+ If an SMS-IWMSC within an SMS-IWMSC set redirects a service request to a different SMS-IWMSC of the set using a 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new SMS-IWMSC towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4].
661
+
662
+ # Annex A (normative): OpenAPI specification
663
+
664
+ ## A.1 General
665
+
666
+ This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format.
667
+
668
+ This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s).
669
+
670
+ NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply.
671
+
672
+ Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [5] and clause 5B of 3GPP TR 21.900 [7]).
673
+
674
+ ## A.2 Niwmsc\_SMService API
675
+
676
+ ```
677
+ openapi: 3.0.0
678
+ info:
679
+ title: 'Niwmsc_SMService'
680
+ version: '1.1.0-alpha.2'
681
+ description: |
682
+ SMS-IWMSC Short Message Service.
683
+ © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
684
+ All rights reserved.
685
+
686
+ externalDocs:
687
+ description: 3GPP TS 29.579 V18.1.0; 5G System; SMS Services; Stage 3.
688
+ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.579/
689
+
690
+ servers:
691
+ - url: '{apiRoot}/niwmsc-smsservice/v1'
692
+ variables:
693
+ apiRoot:
694
+ default: https://example.com
695
+ description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
696
+
697
+ security:
698
+ - oAuth2ClientCredentials:
699
+ - niwmsc-smsservice
700
+ - {}
701
+
702
+ paths:
703
+ /mo-sm-infos/{supi}/sendsms:
704
+ post:
705
+ summary: Send SMS payload for a given UE
706
+ operationId: SendSMS
707
+ tags:
708
+ - Send MO SMS message and the delivery report
709
+ parameters:
710
+ - name: supi
711
+ in: path
712
+ required: true
713
+ description: Subscription Permanent Identifier (SUPI)
714
+ schema:
715
+ type: string
716
+ requestBody:
717
+ content:
718
+ multipart/related: # message with a binary body part
719
+ schema:
720
+ type: object
721
+ properties:
722
+ jsonData:
723
+ $ref: '#/components/schemas/SmsData'
724
+ binaryPayload:
725
+ ```
726
+
727
+ ```
728
+ type: string
729
+ format: binary
730
+ encoding:
731
+ jsonData:
732
+ contentType: application/json
733
+ binaryPayload:
734
+ contentType: application/vnd.3gpp.sms
735
+ headers:
736
+ Content-Id:
737
+ schema:
738
+ type: string
739
+ required: true
740
+ responses:
741
+ '200':
742
+ description: sending delivery report
743
+ content:
744
+ multipart/related: # message with a binary body part
745
+ schema:
746
+ type: object
747
+ properties:
748
+ jsonData:
749
+ $ref: '#/components/schemas/SmsDeliveryData'
750
+ binaryPayload:
751
+ type: string
752
+ format: binary
753
+ encoding:
754
+ jsonData:
755
+ contentType: application/json
756
+ binaryPayload:
757
+ contentType: application/vnd.3gpp.sms
758
+ headers:
759
+ Content-Id:
760
+ schema:
761
+ type: string
762
+ '307':
763
+ $ref: 'TS29571_CommonData.yaml#/components/responses/307'
764
+ '308':
765
+ $ref: 'TS29571_CommonData.yaml#/components/responses/308'
766
+ '400':
767
+ $ref: 'TS29571_CommonData.yaml#/components/responses/400'
768
+ '401':
769
+ $ref: 'TS29571_CommonData.yaml#/components/responses/401'
770
+ '403':
771
+ $ref: 'TS29571_CommonData.yaml#/components/responses/403'
772
+ '404':
773
+ $ref: 'TS29571_CommonData.yaml#/components/responses/404'
774
+ '411':
775
+ $ref: 'TS29571_CommonData.yaml#/components/responses/411'
776
+ '413':
777
+ $ref: 'TS29571_CommonData.yaml#/components/responses/413'
778
+ '415':
779
+ $ref: 'TS29571_CommonData.yaml#/components/responses/415'
780
+ '429':
781
+ $ref: 'TS29571_CommonData.yaml#/components/responses/429'
782
+ '500':
783
+ $ref: 'TS29571_CommonData.yaml#/components/responses/500'
784
+ '502':
785
+ $ref: 'TS29571_CommonData.yaml#/components/responses/502'
786
+ '504':
787
+ $ref: 'TS29571_CommonData.yaml#/components/responses/504'
788
+ default:
789
+ $ref: 'TS29571_CommonData.yaml#/components/responses/default'
790
+
791
+ components:
792
+
793
+ securitySchemes:
794
+ oAuth2ClientCredentials:
795
+ type: oauth2
796
+ flows:
797
+ clientCredentials:
798
+ tokenUrl: '{nrfApiRoot}/oauth2/token'
799
+ scopes:
800
+ niwmsc-smbservice: Access to the niwmsc-smbservice API
801
+
802
+ schemas:
803
+
804
+ SmsData:
805
+ description: >
806
+ ```
807
+
808
+ ```
809
+
810
+ Information within request message invoking MoForwardSm service operation,
811
+ for delivering MO SMS.
812
+ type: object
813
+ required:
814
+ - smsPayload
815
+ properties:
816
+ smsPayload:
817
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
818
+
819
+ SmsDeliveryData:
820
+ description: >
821
+ Information within response message invoking MoForwardSm service operation,
822
+ for delivering MO SMS Delivery Report.
823
+ type: object
824
+ required:
825
+ - smsPayload
826
+ properties:
827
+ smsPayload:
828
+ $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
829
+
830
+ # COMPLEX TYPES:
831
+
832
+ # SIMPLE TYPES:
833
+
834
+ # ENUMS:
835
+
836
+ ```
837
+
838
+ # --- Annex B (informative): Withdrawn API versions
839
+
840
+ ## B.1 General
841
+
842
+ This Annex lists withdrawn API versions of the APIs defined in the present specification. 3GPP TS 29.501 [5] clause 4.3.1.6 describes the withdrawal of API versions.
843
+
844
+ ## --- B.2 Niwmsc\_SMService API
845
+
846
+ The API versions listed in table B.2-1 are withdrawn for the Niwmsc\_SMService API.
847
+
848
+ **Table B.2-1: Withdrawn API versions of the Niwmsc\_SMService service**
849
+
850
+ | API version number | Remarks |
851
+ |--------------------|---------|
852
+ | | |
853
+
854
+ # Annex C (informative): Change history
855
+
856
+ | Change history | | | | | | | |
857
+ |----------------|----------|-----------|------|-----|-----|-------------------------------------------------------|-------------|
858
+ | Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version |
859
+ | 2022-04 | CT4#109e | C4-222331 | | | | C4-222331 as basis | 0.1.0 |
860
+ | 2022-04 | CT4#109e | C4-222343 | | | | Implementation of C4-222343 in CT4#109e | 0.2.0 |
861
+ | 2022-05 | CT4#110e | C4-223452 | | | | Implementation of C4-223219 and C4-223224 in CT4#110e | 0.3.0 |
862
+ | 2022-06 | CT#96 | CP-221080 | | | | TS presented for information and approval | 1.0.0 |
863
+ | 2022-06 | CT#96 | CP-221080 | | | | TS approved at CT#95 | 17.0.0 |
864
+ | 2022-09 | CT#97e | CP-222027 | 0002 | - | B | Add 3xx for the service operation | 17.1.0 |
865
+ | 2022-09 | CT#97e | CP-222027 | 0003 | - | F | Alignment on the service name used with template | 17.1.0 |
866
+ | 2022-09 | CT#97e | CP-222027 | 0004 | - | F | Corrections on the table name and NOTE | 17.1.0 |
867
+ | 2022-09 | CT#97e | CP-222027 | 0005 | - | F | Update on the content type for OpenAPI | 17.1.0 |
868
+ | 2022-09 | CT#97e | CP-222027 | 0006 | 1 | F | Update on the reference model | 17.1.0 |
869
+ | 2022-09 | CT#97e | CP-222058 | 0007 | - | F | 29.579 Rel-17 API version and External doc update | 17.1.0 |
870
+ | 2022-12 | CT#98e | CP-223028 | 0008 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 |
871
+ | 2022-12 | CT#98e | CP-223033 | 0009 | - | F | 29.579 Rel-18 API version and External doc update | 18.0.0 |
872
+ | 2023-03 | CT#99e | CP-230073 | 0012 | - | A | Rel-18 Niwmsc SMService API HTTP code correction | 18.0.1 |
873
+ | 2023-03 | CT#99e | CP-230071 | 0014 | - | F | 29.579 Rel-18 API version and External doc update | 18.0.1 |
874
+ | 2023-03 | CT#99e | CP-230321 | 0015 | - | F | 29.579 Rel-18 API version and External doc update | 18.1.0 |
875
+ | 2023-06 | CT#99e | CP-231026 | 0013 | 3 | F | Location header description | 18.2.0 |
876
+ | 2023-12 | CT#102 | CP-233027 | 0017 | - | F | HTTP RFCs obsoleted by IETF RFC 9113 | 18.3.0 |
877
+ | 2023-12 | CT#102 | CP-233028 | 0016 | 1 | F | HTTP RFCs update in TS 29.579 | 18.3.0 |
878
+ | 2023-12 | CT#102 | CP-233030 | 0018 | - | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.3.0 |
gsma/29_series/29641/raw.md ADDED
@@ -0,0 +1,204 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # 3GPP TS 29.641 V18.1.0 (2023-06)
4
+
5
+ *Technical Report*
6
+
7
+ ## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 3GPP registry for Service Names and Port Numbers (Release 18)**
8
+
9
+ ![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg)
10
+
11
+ The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller text to the right.
12
+
13
+ 5G Advanced logo
14
+
15
+ ![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg)
16
+
17
+ The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font.
18
+
19
+ 3GPP logo
20
+
21
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
22
+
23
+ ## **3GPP**
24
+
25
+ ---
26
+
27
+ Postal address
28
+
29
+ ---
30
+
31
+ 3GPP support office address
32
+
33
+ ---
34
+
35
+ 650 Route des Lucioles - Sophia Antipolis
36
+ Valbonne - FRANCE
37
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
38
+
39
+ Internet
40
+
41
+ ---
42
+
43
+ <http://www.3gpp.org>
44
+
45
+ ## --- **Copyright Notification** ---
46
+
47
+ No part may be reproduced except as authorized by written permission.
48
+ The copyright and the foregoing restriction extend to reproduction in all media.
49
+
50
+ © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
51
+ All rights reserved.
52
+
53
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
54
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
55
+ LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
56
+ GSM® and the GSM logo are registered and owned by the GSM Association
57
+
58
+ # --- Contents
59
+
60
+ | | |
61
+ |------------------------------------------------------------------------------|----------|
62
+ | Foreword ..... | 4 |
63
+ | 1 Scope..... | 5 |
64
+ | 2 References..... | 5 |
65
+ | 3 Definitions of terms, symbols and abbreviations..... | 5 |
66
+ | 3.1 Terms..... | 5 |
67
+ | 3.2 Void..... | 6 |
68
+ | 3.3 Void..... | 6 |
69
+ | 4 3GPP procedures for Service Name and Port Number registry management ..... | 6 |
70
+ | 4.1 General Principles ..... | 6 |
71
+ | 4.2 3GPP allocated Service Name and Port Number registry..... | 6 |
72
+ | 5 Port Number Database ..... | 6 |
73
+ | <b>Annex A (informative): Change history.....</b> | <b>7</b> |
74
+
75
+ # Foreword
76
+
77
+ This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).
78
+
79
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
80
+
81
+ Version x.y.z
82
+
83
+ where:
84
+
85
+ - x the first digit:
86
+ - 1 presented to TSG for information;
87
+ - 2 presented to TSG for approval;
88
+ - 3 or greater indicates TSG approved document under change control.
89
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
90
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
91
+
92
+ In the present document, modal verbs have the following meanings:
93
+
94
+ - shall** indicates a mandatory requirement to do something
95
+ - shall not** indicates an interdiction (prohibition) to do something
96
+
97
+ The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports.
98
+
99
+ The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document.
100
+
101
+ - should** indicates a recommendation to do something
102
+ - should not** indicates a recommendation not to do something
103
+ - may** indicates permission to do something
104
+ - need not** indicates permission not to do something
105
+
106
+ The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended.
107
+
108
+ - can** indicates that something is possible
109
+ - cannot** indicates that something is impossible
110
+
111
+ The constructions "can" and "cannot" are not substitutes for "may" and "need not".
112
+
113
+ - will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
114
+ - will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
115
+ - might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
116
+
117
+ **might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
118
+
119
+ In addition:
120
+
121
+ **is** (or any other verb in the indicative mood) indicates a statement of fact
122
+
123
+ **is not** (or any other negative verb in the indicative mood) indicates a statement of fact
124
+
125
+ The constructions "is" and "is not" do not indicate requirements.
126
+
127
+ # --- 1 Scope
128
+
129
+ The present document defines 3GPP procedures for Service Name and Port Number registry management. These procedures should be followed by 3GPP WGs when requesting new port numbers for the 3GPP allocated port number solution#6, which is specified in clause 4.4 of the 3GPP TR 29.941 [2].
130
+
131
+ The present document also maintains a database of the 3GPP allocated port numbers.
132
+
133
+ # --- 2 References
134
+
135
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
136
+
137
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
138
+ - For a specific reference, subsequent revisions do not apply.
139
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
140
+
141
+ [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
142
+
143
+ [2] 3GPP TR 29.941: "Study on Port Number Allocation Alternatives for New 3GPP Interfaces".
144
+
145
+ # --- 3 Definitions of terms, symbols and abbreviations
146
+
147
+ ## 3.1 Terms
148
+
149
+ For the purposes of the present document, the terms given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1].
150
+
151
+ 3.2 Void
152
+
153
+ 3.3 Void
154
+
155
+ # --- 4 3GPP procedures for Service Name and Port Number registry management
156
+
157
+ ## 4.1 General Principles
158
+
159
+ 3GPP CT4 is responsible for the management and maintenance of service name and port number registry from the sub-range of 101 ports from 65400 to 65500. This sub-range belongs to the Dynamic/Private Port range [49152 - 65535] and IANA does not assign port numbers from this range.
160
+
161
+ Clause 4.4 in 3GPP TR 29.941 [2] specifies solution#6 for 3GPP allocated port numbers. Solution#6 requires 3GPP CT4 to maintain the 3GPP allocated port number repository.
162
+
163
+ ## 4.2 3GPP allocated Service Name and Port Number registry
164
+
165
+ This clause specifies 3GPP procedure for the port number allocation based on the solution#6 (see clause 4.4 in 3GPP TR 29.941 [2]).
166
+
167
+ 1. If a 3GPP working group decides to utilize 3GPP allocated port number solution#6, the working group shall send an LS request to 3GPP CT4. CT4 accepts the request if it addresses the following matters (checklist):
168
+ - a. The request should be for a protocol, which is supported by intra-domain interface(s).
169
+ - b. The request should indicate that the request cannot meet IANA/IETF requirements for the port number allocation (see Annex C in 3GPP TR 29.941 [2]).
170
+ - c. The request should indicate that solution#6 is preferable and selected after evaluating other solutions specified in 3GPP TR 29.941 [2].
171
+ 2. LS request to 3GPP CT4 shall also contain the following information:
172
+ - a. The service name, e.g. x2-ctrl.
173
+ - b. Applicable transport protocol(s).
174
+ - c. Short description, e.g. X2-CP.
175
+ - d. A statement that the new port number will be used across intra-domain interface <name> between nodes <name> and <name>.
176
+ - e. Work Item Code (WIC) used by the request sender (both the abbreviation and the numerical value).
177
+ 3. 3GPP CT4 shall inform the 3GPP WG that has requested new port number allocation and also may inform other, relevant 3GPP WGs about the decision. 3GPP CT4 creates respective CR. If CT plenary approves the CR, then the assigned port number will be added to the Table 5-1 (see clause 5).
178
+
179
+ # --- 5 Port Number Database
180
+
181
+ Table 5-1 represents 3GPP allocated service name and port number registry of 101 ports from 65400 to 65500. 3GPP CT4 maintains the repository.
182
+
183
+ Table 5-1: Service Name/port number assigned by 3GPP
184
+
185
+ | Service Name | Port Number | Transport Protocol | Description | Inter/Intra interface between entities | Requesting WG | Registration Date |
186
+ |--------------|-------------|--------------------|--------------|----------------------------------------------------|---------------|-------------------|
187
+ | SLMP | 65400 | UDP | SLM-C-CP | Inter SLM-C hosted UEs | CT1 | 2023-06 (CT#100) |
188
+ | MSGin5GMD | 65401 | UDP | MSGin5GMD-UP | Inter MSGin5G Client to MSGin5G Server (MSGin5G-1) | CT1 | 2023-06 (CT#100) |
189
+
190
+ # Annex A (informative): Change history
191
+
192
+ | Change history | | | | | | | |
193
+ |----------------|--------------|-----------|------|-----|-----|----------------------------------------------------------------------|-------------|
194
+ | Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version |
195
+ | 2022-01 | CT4#107e-bis | C4-220265 | | | | Skeleton | 0.0.0 |
196
+ | 2022-01 | CT4#107e-bis | C4-220458 | | | | Following tdocs are implemented: C4-220287, C4-220288 and C4-220289. | 0.1.0 |
197
+ | 2022-02 | CT4#108e | C4-221587 | | | | Spec number was assigned. | 0.2.0 |
198
+ | 2022-03 | CT#95e | CP-220103 | | | | TS presented for information and approval | 1.0.0 |
199
+ | 2022-03 | CT#95e | | | | | TS approved | 17.0.0 |
200
+ | 2022-06 | CT#96 | CP-221026 | 0001 | - | D | Editorial corrections | 17.1.0 |
201
+ | 2022-09 | CT#97e | CP-222033 | 0002 | - | F | Correcting references | 17.2.0 |
202
+ | 2023-03 | CT#99 | CP-230058 | 0003 | 1 | B | Allocating new port number | 18.0.0 |
203
+ | 2023-06 | CT#100 | CP-231062 | 0004 | - | B | New UDP port number for the SLMP | 18.1.0 |
204
+ | 2023-06 | CT#100 | CP-231062 | 0005 | 3 | B | New port number for MSGin5G service | 18.1.0 |
gsma/29_series/29831/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
gsma/37_series/37145-2/04c2b0e015697b9fd54da23916a850d6_img.jpg ADDED

Git LFS Details

  • SHA256: db43dfe5e431bd3ca986714b8ea687dcaaa2d18ab66310e0ee8a62c1188fa4bb
  • Pointer size: 130 Bytes
  • Size of remote file: 26.6 kB
gsma/37_series/37145-2/07b81106e8525814c458f262000c54a9_img.jpg ADDED

Git LFS Details

  • SHA256: c9ef0ff67e305192db1f3f2105adbf66dc86a04c5615d08daeb44c98bbfdb70b
  • Pointer size: 130 Bytes
  • Size of remote file: 22 kB
gsma/37_series/37145-2/09955ff8214ffb6947951fc0f60eb6ab_img.jpg ADDED

Git LFS Details

  • SHA256: 0242c4d2e51b54075192df233a01e544d58cde981c16c56519212a1106ed85d1
  • Pointer size: 130 Bytes
  • Size of remote file: 44.8 kB
gsma/37_series/37145-2/315bdbeafb39026e19b77c26b19d9d1f_img.jpg ADDED

Git LFS Details

  • SHA256: 5c892d52c065247b715455eeab9e1472ad7b57e3fd58feef9085d56b4a4c5bfc
  • Pointer size: 130 Bytes
  • Size of remote file: 47.6 kB
gsma/37_series/37145-2/36cc7cc6626dc09bfcc888a4f8e2e9e4_img.jpg ADDED

Git LFS Details

  • SHA256: 8547b013d6cbdccb1ed0e47b413dff76a745587561b0d51ad4cd9b767b5e4384
  • Pointer size: 130 Bytes
  • Size of remote file: 71.6 kB
gsma/37_series/37145-2/3c8ed97dd81b363f7919bb50f8410baa_img.jpg ADDED

Git LFS Details

  • SHA256: 0da76a37b80833fdd200e204ed5e9bf8e114dd897327f53f4a753f0a7bc89ca7
  • Pointer size: 130 Bytes
  • Size of remote file: 45 kB
gsma/37_series/37145-2/51923f79574a4c945d05c5ad3ff8dda5_img.jpg ADDED

Git LFS Details

  • SHA256: 7498d9329ced800555cad56a6d8d43ec36ad9cd987d80957f5f2bcee9f790642
  • Pointer size: 130 Bytes
  • Size of remote file: 28.6 kB
gsma/37_series/37145-2/5fb340ad68b0c71df0b56698b137e35b_img.jpg ADDED

Git LFS Details

  • SHA256: 5a42531e878a9547fcce2d08f472ff3e0a57fff4cfba77c3b6ab40618e0f96ab
  • Pointer size: 129 Bytes
  • Size of remote file: 9.58 kB
gsma/37_series/37145-2/71440aab73c3d21521dba3a413e3a7ca_img.jpg ADDED

Git LFS Details

  • SHA256: 6b17dc87a9d3f6933b3e8a82ed2b46a041631973b52071030b29ae9a8c6e9823
  • Pointer size: 130 Bytes
  • Size of remote file: 49.3 kB
gsma/37_series/37145-2/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg ADDED

Git LFS Details

  • SHA256: bf33209ca4e7b86b5c34294316ac63e4e9960aae0b4662bebf616d6cd139e0fe
  • Pointer size: 130 Bytes
  • Size of remote file: 59.8 kB
gsma/37_series/37145-2/854a7aa42ede8d319880a076c262338e_img.jpg ADDED

Git LFS Details

  • SHA256: 02be06b6bcedf588daee2505ecba1d3be68d33a4016c2a4141e9027e1745e46d
  • Pointer size: 130 Bytes
  • Size of remote file: 23.6 kB
gsma/37_series/37145-2/87661c01f79c13b3ea49e7d3e9782c48_img.jpg ADDED

Git LFS Details

  • SHA256: 3d57e5c994825d57bf40412ef8bd5435ee73bb2b0d17dfd48d236ec35eaf2e5d
  • Pointer size: 130 Bytes
  • Size of remote file: 70.2 kB
gsma/37_series/37145-2/8b6f7b51bc160aa80e286e818baa7998_img.jpg ADDED

Git LFS Details

  • SHA256: 903b934bf4d0bdf36913e9c2ce146ef4e0c760cfe26f675a397120fa2e1e7072
  • Pointer size: 130 Bytes
  • Size of remote file: 89 kB
gsma/37_series/37145-2/8be5d9cba2614c3e06e06525a14c5a3b_img.jpg ADDED

Git LFS Details

  • SHA256: 6a62a2e5f57d9d222455a4df6a7b486299f3678d6643af485becde3669c0e297
  • Pointer size: 130 Bytes
  • Size of remote file: 76.3 kB
gsma/37_series/37145-2/8bffff22941e018add90bd8d04b6798c_img.jpg ADDED

Git LFS Details

  • SHA256: e334063c83140384fe32c878198a86c6a5023540103604c4a7a9a918e25a1b1a
  • Pointer size: 130 Bytes
  • Size of remote file: 75.9 kB
gsma/37_series/37145-2/acb90ab4b1096f13fbf453251ca3ffd2_img.jpg ADDED

Git LFS Details

  • SHA256: 8684ed1962819315e4ece6a1971d45fa24059e5bf92c182d1715246a638227b2
  • Pointer size: 130 Bytes
  • Size of remote file: 77.7 kB
gsma/37_series/37145-2/b664da64b7121b86310de02c98642405_img.jpg ADDED

Git LFS Details

  • SHA256: 075ab62b9135a775d5ba0156e7ac016a138c258bcf84d521f22eb92d82af36a3
  • Pointer size: 130 Bytes
  • Size of remote file: 80.8 kB
gsma/37_series/37145-2/b81d1613e285a9353171cdc5ef97a1f0_img.jpg ADDED

Git LFS Details

  • SHA256: 0f39656ad2511540903c1e615e9ed41a8c4add365209692af9e4500f7a430761
  • Pointer size: 130 Bytes
  • Size of remote file: 41.5 kB
gsma/37_series/37145-2/c0e1c8d37f9cd96595cb6370b1b5a8c7_img.jpg ADDED

Git LFS Details

  • SHA256: f9b57cd175b7cbfb5af9641f8b6dad37a3bbdb847e0b2afcd38d749e3fa73a94
  • Pointer size: 130 Bytes
  • Size of remote file: 73.9 kB
gsma/37_series/37145-2/dc5554f3d97c390f2e7467a86598b98e_img.jpg ADDED

Git LFS Details

  • SHA256: 36592ec741d39dacbeb45ebf3dad56a5f0d12a050df39a2c02231c28e167196a
  • Pointer size: 130 Bytes
  • Size of remote file: 71.1 kB
gsma/37_series/37145-2/e9baf350bd23410e8a6df8dc5c68c16b_img.jpg ADDED

Git LFS Details

  • SHA256: f523b45c1d74368eb37abcb8fa9fbcc61822685eee3fcd31696be093949112a8
  • Pointer size: 130 Bytes
  • Size of remote file: 21.4 kB