diff --git a/raw/rel-18/29_series/29116/raw.md b/raw/rel-18/29_series/29116/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..854b21ebf0cdd06aa78e5ac4d8a501ed52237074 --- /dev/null +++ b/raw/rel-18/29_series/29116/raw.md @@ -0,0 +1,3375 @@ + + +# 3GPP TS 29.116 V18.0.0 (2022-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Representational state transfer over xMB reference point between Content Provider and BM-SC; (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +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. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +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. + +3GPP logo + +## --- **Keywords** + + + +## **3GPP** + +## --- **Postal address** + +### --- **3GPP support office address** + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- **Internet** + + + +## --- **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 8 | +| 4 xMB reference point ..... | 8 | +| 4.1 Overview ..... | 8 | +| 4.2 Reference model..... | 8 | +| 4.3 Functional elements..... | 9 | +| 4.3.1 BM-SC..... | 9 | +| 4.3.2 Content Provider / Multicast Broadcast Source ..... | 9 | +| 4.4 Procedures over xMB reference point..... | 9 | +| 4.4.1 Introduction ..... | 9 | +| 4.4.2 Authentication Procedures..... | 9 | +| 4.4.3 Authorization Procedures ..... | 10 | +| 4.4.4 Service Management Procedures ..... | 10 | +| 4.4.4.1 Create Service ..... | 10 | +| 4.4.4.2 Get Service Properties ..... | 10 | +| 4.4.4.3 Update Service Properties..... | 10 | +| 4.4.4.4 Delete Service ..... | 10 | +| 4.4.4.5 Service Notifications..... | 10 | +| 4.4.5 Session Management Procedures ..... | 10 | +| 4.4.5.1 Create Session..... | 10 | +| 4.4.5.2 Get Session Properties ..... | 10 | +| 4.4.5.3 Update Session Properties ..... | 10 | +| 4.4.5.4 Delete Session..... | 11 | +| 5 xMB API..... | 11 | +| 5.1 Overview ..... | 11 | +| 5.1.0 General ..... | 11 | +| 5.1.1 Supported Methods..... | 11 | +| 5.1.2 Error Handling..... | 12 | +| 5.1.3 xMB Entry Point Discovery ..... | 12 | +| 5.1.4 Content type..... | 12 | +| 5.2 Resources ..... | 13 | +| 5.2.1 Services..... | 13 | +| 5.2.1.0 General..... | 13 | +| 5.2.1.1 Properties ..... | 13 | +| 5.2.1.2 API Operations ..... | 15 | +| 5.2.1.2.1 Introduction ..... | 15 | +| 5.2.1.2.2 Service Creation ..... | 15 | +| 5.2.1.2.3 Service Modification ..... | 15 | +| 5.2.1.2.4 Service Deletion ..... | 17 | +| 5.2.1.2.5 Service Retrieval ..... | 18 | +| 5.2.2 Sessions ..... | 20 | +| 5.2.2.0 General..... | 20 | +| 5.2.2.1 Properties ..... | 20 | +| 5.2.2.2 API Operations ..... | 32 | +| 5.2.2.2.1 Introduction ..... | 32 | +| 5.2.2.2.2 Session Creation..... | 32 | +| 5.2.2.2.3 Session Modification..... | 33 | +| 5.2.2.2.4 Session Deletion..... | 35 | +| 5.2.2.2.5 Session Retrieval..... | 36 | +| 5.2.3 Reports..... | 38 | + +| | | | +|----------------------------------------------------|--------------------------------------------------------------------------------|-----------| +| 5.2.3.0 | General ..... | 38 | +| 5.2.3.1 | Properties ..... | 38 | +| 5.2.3.2 | API Operations ..... | 39 | +| 5.2.3.2.1 | Introduction ..... | 39 | +| 5.2.3.2.2 | Report Retrieval ..... | 39 | +| 5.2.4 | Notifications ..... | 43 | +| 5.2.4.0 | General ..... | 43 | +| 5.2.4.1 | Properties ..... | 43 | +| 5.2.4.1.0. | General ..... | 43 | +| 5.2.4.2.1 | Introduction ..... | 45 | +| 5.2.4.2.2 | Notification Retrieval ..... | 45 | +| 6 | User Plane Procedures ..... | 46 | +| 6.1 | Introduction ..... | 46 | +| 6.2 | File Session ..... | 46 | +| 6.2.1 | General ..... | 46 | +| 6.2.2 | Push Mode ..... | 46 | +| 6.2.3 | Pull Mode ..... | 46 | +| 6.3 | Application Session ..... | 47 | +| 6.3.1 | General ..... | 47 | +| 6.3.2 | Push Mode ..... | 47 | +| 6.3.3 | Pull Mode ..... | 47 | +| 6.4 | RTP Streaming ..... | 48 | +| 6.5 | Transport ..... | 48 | +| 7 | Security ..... | 48 | +| 7.1 | Overview ..... | 48 | +| 7.2 | Authentication & Authorization ..... | 48 | +| 7.3 | Void ..... | 49 | +| 8 | Notification Push to the Content Provider ..... | 49 | +| 8.1 | Introduction ..... | 49 | +| 8.2 | Notification Post ..... | 49 | +| 9 | Feature negotiation ..... | 50 | +| 9.1 | General ..... | 50 | +| 9.2 | HTTP custom headers ..... | 51 | +| 9.2.0 | General ..... | 51 | +| 9.2.1 | 3gpp-Optional-Features ..... | 51 | +| 9.2.2 | 3gpp-Required-Features ..... | 51 | +| 9.2.3 | 3gpp-Accepted-Features ..... | 52 | +| 10 | Using Common API Framework ..... | 52 | +| 10.1 | General ..... | 52 | +| 10.2 | Security ..... | 52 | +| Annex A (informative): Call Flows ..... | | 54 | +| A.1 | Introduction ..... | 54 | +| A.2 | xMB Procedure example for Live DASH services (MBMS Broadcast only) ..... | 54 | +| A.3 | xMB Procedure example for Live DASH services (with Service Continuity) ..... | 57 | +| A.4 | xMB Procedure example for File Delivery Services (without File Schedule) ..... | 57 | +| Annex B (normative): JSON Schema ..... | | 61 | +| Annex C (informative): Change history ..... | | 80 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document describes the REST-based protocol for the xMB reference point between the Content Provider and the BM-SC. The xMB reference point and related stage 2 protocol procedures are defined in 3GPP TS 23.246 [2] and in 3GPP TS 26.346 [3]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.246: "Multimedia Broadcast/Multicast Service (MBMS) Architecture and Functional Description". +- [3] 3GPP TS 26.346: "Multimedia Broadcast/Multicast Service (MBMS); Protocols and Codecs". +- [4] Void. +- [5] Void. +- [6] IETF RFC 7231: "Hypertext transfer protocol (HTTP/1.1): Semantics and Content". +- [7] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [8] IETF RFC 7235: "Hypertext Transfer Protocol (HTTP/1.1): Authentication". +- [9] IETF RFC 4918: "HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)". +- [10] 3GPP TS 26.234: "Transparent end-to-end Packet-switched Streaming Service (PSS); Protocols and codecs". +- [11] IETF RFC 3711: "The Secure Real-time Transport Protocol (SRTP)". +- [12] Void. +- [13] Void. +- [14] Void. +- [15] Void. +- [16] Void. +- [17] Void. +- [18] 3GPP TS 26.247: "Transparent end-to-end Packet-switched Streaming Service (PSS); Progressive Download and Dynamic Adaptive Streaming over HTTP (3GP-DASH)". +- [19] IETF RFC 3926: "FLUTE - File Delivery over Unidirectional Transport". +- [20] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". + +- [21] 3GPP TS 26.347: "MBMS URLs and APIs". +- [22] Open API Initiative, "OpenAPI 2.0 Specification", . +- [23] 3GPP TS 23.285: "Architecture Enhancements for V2X services". +- [24] 3GPP TS 33.246: "3G Security; Security of Multimedia Broadcast/Multicast Service (MBMS)". +- [25] 3GPP TS 24.116: "Stage 3 aspects of system architecture enhancements for TV services". +- [26] IETF RFC 2617: "HTTP Authentication: Basic and Digest Access Authentication". +- [27] IETF RFC 5795: "The Robust Header Compression (ROHC) Framework". +- [28] IETF RFC 3095: "Robust Header Compression (ROHC): Framework and four profiles: RTP, UDP, ESP, and uncompressed". +- [29] IETF RFC 6363: "Forward Error Correction (FEC) Framework". +- [30] Void. +- [31] IETF RFC 1166: "Internet Numbers". +- [32] IETF RFC 5952: "A recommendation for IPv6 address text representation". +- [33] 3GPP TS 26.348: "Northbound Application Programming Interface (API) for Multimedia Broadcast/Multicast Service (MBMS) at the xMB reference point". +- [34] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [35] IETF RFC 7396: "JSON Merge Patch". +- [36] 3GPP TS 23.280: "Common functional architecture to support mission critical services; Stage 2". +- [37] 3GPP TS 24.008: "Mobile radio interface layer 3 specification; Core Network protocols; Stage 3". +- [38] IETF RFC 7232: "Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests". +- [39] 3GPP TS 23.222: "Common API Framework for 3GPP Northbound APIs; Stage 2". +- [40] 3GPP TS 29.222: "Common API Framework for 3GPP Northbound APIs; Stage 3". +- [41] 3GPP TS 33.122: "Security Aspects of Common API Framework for 3GPP Northbound APIs". +- [42] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [43] IETF RFC 7616: "HTTP Digest Access Authentication". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +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]. + +**Content Provider:** Entity/Entities which supplies/supply content in the form of streaming media or non-real-time (NRT) files to be delivered to UEs over the 3GPP network, via MBMS Bearer and/or unicast bearer services. Also referred to in this document as the Multicast Broadcast Source. The Content Provider may reside either inside or outside the operator's network. + +**Service:** One of the resource types exposed by the RESTful xMB API and operated on by a Content Provider using HTTP methods. It corresponds to a Content Provider's service offering for delivery over the MBMS network to UEs. + +Each service instance created over the xMB API maps to an MBMS User Service as specified by 3GPP TS 26.346 [3]. The delivery of the contents of a created service is performed during one or more sessions associated with that service. + +**Session:** One of the resource types exposed by the RESTful xMB API and operated on by a Content Provider using HTTP methods. It represents one or more time intervals during which the MBMS Bearer is active for the transmission of service contents from the BM-SC to the UE. Each session instance, besides the activity times, may contain various properties pertaining to transport, media and application level information (session type, session state, data rate, permitted delay, user plane ingestion mode, targeted delivery area, reporting parameters, identification of content components delivered during the session, etc.). + +## 3.2 Abbreviations + +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]. + +| | | +|--------|---------------------------------------------| +| 5GMS | 5G Media Streaming | +| ARP | Allocation and Retention Priority | +| API | Application Programming Interface | +| BM-SC | Broadcast Multicast Service Center | +| CAPIF | Common API Framework | +| CDN | Content Delivery Network | +| CP | Content Provider | +| DASH | Dynamic Adaptive Streaming over HTTP | +| FEC | Forward Error Correction | +| FLUTE | File Delivery over Unidirectional Transport | +| GBR | Guaranteed Bitrate | +| HTTP | HyperText Transfer Protocol | +| IS | Initialization Segment | +| JSON | JavaScript Object Notation | +| MPD | Media Presentation Description | +| MSA | MBMS Service Area | +| PKI | Public Key Infrastructure | +| PSK | Pre-Shared Key | +| REST | Representational State Transfer | +| ROHC | Robust Header Compression | +| QCI | QoS Class Identifier | +| QoS | Quality of Service | +| SACH | Service Announcement Channel | +| SAF | Service Announcement Function | +| SLA | Service Level Agreement | +| TLS | Transport Layer Security | +| TMGI | Temporarily Mobile Group Identity | +| TSI | Transport Session Identifier | +| URI | Universal Resource Identifier | +| WebDAV | Web Distributed Authoring and Versioning | +| V2X | Vehicle-to-Everything | + +# --- 4 xMB reference point + +## 4.1 Overview + +## 4.2 Reference model + +The xMB reference point resides between the BM-SC and the Content Provider as depicted in Figure 4.2.1. Control- and user-plane procedures are operated over the xMB-C and xMB-U reference points, respectively. The overall xMB reference model is depicted in clause 4.1 of 3GPP TS 26.348 [33]. + +![Diagram of the xMB reference point showing the BM-SC and Content Provider/Multicast Broadcast Source connected by two arrows labeled xMB-C and xMB-U.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` +graph LR; BM-SC[BM-SC] -- xMB-C --> CP[Content Provider/Multicast Broadcast Source]; CP -- xMB-U --> BM-SC; +``` + +Diagram of the xMB reference point showing the BM-SC and Content Provider/Multicast Broadcast Source connected by two arrows labeled xMB-C and xMB-U. + +**Figure 4.2.1 xMB reference point** + +For the V2X Localized User Plane supported feature, the reference model in Annex B.3 of 3GPP TS 23.285 [23] applies. + +## 4.3 Functional elements + +### 4.3.1 BM-SC + +The complete functionality of the BM-SC is defined in 3GPP TS 26.346 [3]. In the context of the xMB reference point, the BM-SC represents the peer endpoint to the Content Provider in supporting all procedures on the xMB interface. + +In addition to the functions defined in 3GPP TS 26.346 [3], the BM-SC may support, for V2X services, the V2X Localized User Plane procedures as defined in 3GPP TS 23.285 [23] clause 5.4.2.2 for receiving Local MBMS information from the Content Provider acting as a V2X Application Server. + +### 4.3.2 Content Provider / Multicast Broadcast Source + +The functional role of the Content Provider is defined in clause 4.4.1a of 3GPP TS 26.346 [3]. Using the xMB reference point, a Content Provider/Multicast Broadcast Source may provide media, as well as service descriptions and control data, to the BM-SC to set up and manage MBMS User Service(s) from the BM-SC to MBMS clients (the latter is not depicted in Figure 4.2.1). + +In addition, the Content Provider which acts as a V2X Application Server may support V2X Localized User Plane procedures as defined in 3GPP TS 23.285 [23] clause 5.4.2.2 for requesting the BM-SC to activate an MBMS bearer for Local MBMS based MBMS data delivery. + +The content provider may also be a mission critical service provider (3GPP TS 23.280 [36]) which is arranging MC Services to Mission Critical Organizations and may require additional control of the resource allocation (QoS, coverage area). + +The Content Provider may be a 5GMS Application Provider as defined in clause 4.1 of TS 26.348 [33], providing 5G Media Streaming services to a 5GMS System. + +## 4.4 Procedures over xMB reference point + +### 4.4.1 Introduction + +All procedures that operate across the xMB reference point, as specified in clause 5 of 3GPP TS 26.348 [33], are summarized in the following clauses. + +### 4.4.2 Authentication Procedures + +Authentication procedures shall be performed via (D)TLS as specified by 3GPP TS 33.246 [24]. The Content Provider shall act as the (D)TLS client and the BM-SC as the (D)TLS server when the Content Provider wants to provision new services or manage existing services. Similarly, the BM-SC shall act as the client when the BM-SC wishes to send reports and notifications to the Content Provider. All of the following procedures require the authentication procedure to be completed successfully. + +### 4.4.3 Authorization Procedures + +The authorization procedure of the Content Provider towards the BM-SC may be based on the (D)TLS connection established as part of the authentication procedure (see clause 4.4.2). In that case, the BM-SC shall check if the Content Provider who sent a request over an authenticated (D)TLS connection is authorized to send that specific request. See clause 7.2 for further details. + +The authorization procedure of the BM-SC towards the Content Provider to allow pushing notifications to the Content Provider may be based on the (D)TLS connection established as part of the authentication procedure (see clause 4.4.2). In that case, the Content Provider shall check if the BM-SC who sent the notification over an authenticated (See clause 7.2 for further details)(D)TLS connection is authorized to send that specific notification. + +### 4.4.4 Service Management Procedures + +#### 4.4.4.1 Create Service + +This procedure is used by the Content Provider to create a service at the BM-SC and negotiate the supported features for the created service. The Content Provider shall use HTTP POST for this purpose. A successfully created service is associated with a resource identifier which is used by the Content Provider to discover, update and delete the service. + +#### 4.4.4.2 Get Service Properties + +This procedure is used by the Content Provider to obtain the service properties from the BM-SC. The Content Provider shall use HTTP GET for this purpose. + +#### 4.4.4.3 Update Service Properties + +This procedure is used by the Content Provider for updating the service properties at the BM-SC. The Content Provider shall use HTTP PUT or HTTP PATCH, corresponding to complete or partial update of service properties, respectively, for this purpose. + +#### 4.4.4.4 Delete Service + +This procedure is used by the Content Provider to terminate the service at the BM-SC. The Content Provider shall use HTTP DELETE for this purpose. + +#### 4.4.4.5 Service Notifications + +This procedure is used by the BM-SC to send service related notifications to the Content Provider. + +### 4.4.5 Session Management Procedures + +#### 4.4.5.1 Create Session + +This procedure is used by the Content Provider to create a session for a previously created service at the BM-SC. The Content Provider shall use HTTP POST for this purpose. A successfully created session is associated with a resource identifier which is used by the Content Provider to discover, update and delete the session. + +#### 4.4.5.2 Get Session Properties + +This procedure is used by the Content Provider to obtain the session properties of a service from the BM-SC. The Content Provider shall use HTTP GET for this purpose. + +#### 4.4.5.3 Update Session Properties + +This procedure is used by the Content Provider for updating the session properties of a session at the BM-SC. The Content Provider shall use HTTP PUT or HTTP PATCH, corresponding to complete or partial update of session properties, respectively, for this purpose. + +If the V2X Localized User Plane feature is supported, the Content Provider may wish to update the session properties for Local MBMS based MBMS data delivery. If so, and the BM-SC decides to use the Local MBMS information, the BM-SC shall use the received BM-SC IP address and port for user plane data delivery. + +NOTE: The Local MBMS information is pre-configured in the Content Provider. At reception of such information, the BM-SC will further send the M1 interface information (e.g. MBMS eNB multicast address and GW source specific multicast address) to the MBMS-GW as specified in 3GPP TS 29.061 [20]. + +If the MCExtension feature is supported, the content provider acting as a mission critical service provider may include: + +- additional properties for resource allocation control (*mc-extension* in table 5.2.2.1-1); and +- specific semantic and syntax for the geographical area (clause 5.4.7 of 3GPP TS 26.348 [33]). + +#### 4.4.5.4 Delete Session + +This procedure is used by the Content Provider to terminate a session of a service at the BM-SC. The Content Provider shall use HTTP DELETE for this purpose. + +# --- 5 xMB API + +## 5.1 Overview + +### 5.1.0 General + +The xMB API is a RESTful API that allows Content Providers to provision broadcast services over 3GPP networks and subsequent ingestion of service content for distribution using eMBMS. The xMB API defines a set of resources and the related procedures for the creation and management of broadcast services and sessions are described in clause 5.2. The corresponding JSON schema for the representation of the resources and operations defined by the xMB API is provided in its complete form in Annex B. The syntax follows the rules defined by the OpenAPI specification [22]. + +### 5.1.1 Supported Methods + +The xMB API follows the RESTful design principles. All operations SHALL be performed using HTTP 1.1 (IETF RFC 7231 [6]) over TLS (3GPP TS 33.246[24]). + +Table 5.1.1-1 gives a summary of the supported HTTP methods and their applicability on a per resource basis. + +Table 5.1.1-1: Summary of supported HTTP methods of xMB API + +| HTTP Method | CRUD | Resource | PATH | +|-------------|---------|--------------|--------------------------------------------------------------------------------------| +| POST | Create | Service | /xmb/v1.0/services | +| | | Session | /xmb/v1.0/services/{service-res-id}/sessions | +| GET | Read | Service | /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} | +| | | Session | /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} | +| | | Report | /xmb/v1.0/reports?query
or
/xmb/v1.0/reports/{report-res-id} | +| | | Notification | /xmb/v1.0/notifications?query
or
/xmb/v1.0/notifications/{notification-res-id} | +| PUT | Replace | Service | /xmb/v1.0/services/{service-res-id} | +| | | Session | /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} | +| PATCH | Modify | Service | /xmb/v1.0/services/{service-res-id} | +| | | Session | /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} | +| DELETE | Delete | Service | /xmb/v1.0/services/{service-res-id} | +| | | Session | /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} | + +### 5.1.2 Error Handling + +The xMB API shall use the HTTP status codes to indicate any errors that might occur in the processing of operations on xMB resources. Unless defined otherwise, the HTTP status codes shall be interpreted as specified in IETF RFC 7231 [6]. API operations that are not successfully handled shall not leave the resource at an undefined state. The response should provide sufficient information for a human operator to understand and locate the error. + +API operations that do not follow the security procedures defined in clause 7 shall be rejected without any impact on the resources. + +Errors may also happen during the content ingestion and shall be notified to the Content Provider in a timely manner depending on the severity of the error. + +### 5.1.3 xMB Entry Point Discovery + +The Content Provider shall be able to discover the entry point to the xMB interface by one of the following methods: + +- It is provided with the URL that serves as the entry point for the xMB-C interface; +- It acquires that entry point URL from DNS resolution of the following Fully Qualified Domain Name (FQDN): + +.mcc.pub.3gppnetwork.org>, + +in which case the Content Provider shall build the following URL for the entry point of the xMB interface: + +.mcc.pub.3gppnetwork.org/xmb/v1.0/>. + +### 5.1.4 Content type + +The bodies of HTTP request and successful HTTP responses shall be encoded in JSON format (see IETF RFC 8259 [34]). + +The MIME media type that shall be used within the related Content-Type header field is "application/json", as defined in IETF RFC 8259 [34]. + +JSON object used in the HTTP PATCH request shall be encoded according to "JSON Merge Patch" (IETF RFC 7396 [35]) but within the related Content-Type header field the MIME media type shall be signalled as "application/json". + +NOTE: In this Release of the specification only MIME media type "application/json" is supported. + +## 5.2 Resources + +### 5.2.1 Services + +#### 5.2.1.0 General + +The Content Provider shall configure services at the BM-SC using the REST API methods over two resources managed at the BM-SC. + +Table 5.2.1-1 summarizes different resources for provisioning and managing services at the BM-SC. + +**Table 5.2.1-1: Resources for managing services at BM-SC** + +| Resource Name | Resource Type | Description | +|---------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| service | Instance resource | Represents a single service resource. The Content Provider can provision or modify a single service at the BM-SC by invoking REST API requests to this service resource at the BM-SC. | +| services | Collection Resource | Represents a collection of service resources. | + +#### 5.2.1.1 Properties + +Each service resource described in Table 5.2.1-1 has the set of properties described in Table 5.2.1.1-1. The Content Provider shall modify one or more of the properties of the service resource using the API operations described in clause 5.2.1.2. + +Table 5.2.1.1-1 summarizes different service properties of a service resource. + +Table 5.2.1.1-1: Properties of service resource + +| Property Token | JSON Value Type | Defaults | | | Property Description | Applicability (NOTE) | +|-------------------------------------|-----------------|-----------------|-------|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| | | Child Parameter | Units | Values | | | +| service-id | string | | None | N/A | Identifies the MBMS User Service as defined in clause 11.2.1.1 of 3GPP TS 26.346 [3] | | +| service-class | string | | None | (operator defined default) | The service class that service belongs to. (see serviceClass element in clause 11.2.1.2 of 3GPP TS 26.346 [3]). | | +| service-languages | array | | None | Empty list | List of language of the service content. (see serviceLanguage element in clause 11.2.1.1 of 3GPP TS 26.346 [3]). | | +| service-names | array | | None | Empty list | List of Service Names. (see name element in clause 11.2.1.1 of 3GPP TS 26.346 [3]) | | +| receive-only-mode | boolean | | None | False | When set to 'true', the Content Provider indicates that the service is a Receive Only Mode service. | | +| service-announcement-mode | string | | None | SACH | Enumeration of Service Announcement Mode.
Additional service announcement modes may be added in the future.
- "SACH": BM-SC performs the service announcement for the current service using the SACH channel (cf. Annex L.2, L3 of 3GPP TS 26.346 [3]).
- "Content Provider": BM-SC provides the necessary service access information used by the Content Provider to create the service announcement information. | | +| consumption-reporting-configuration | object | | | | The Content Provider wishes to collect consumption reports for the service.
Reporting start and end time: The reporting period with start and end time.
Reporting interval: The interval for which the BM-SC is aggregate the statistics in seconds. (Data type: number; default value: 3600)
Sample percentage: Percentage of users to collect reports from (Data type: number; default value: 10)
The presence of this object indicates the enabling of consumption reporting; if not present, it indicates the disabling of the consumption reporting. | | +| push-notification-url | string | | None | "" | The Content Provider provides Notification URL over which it will receive notifications "pushed" by the BM-SC. The Notification procedure is described in clause 5.3.6. of 3GPP TS 26.348 [33] | | +| push-notification-configuration | string | | None | All | If the Content Provider enables push delivery of notifications, then the Content Provider may provide notification filters
This parameter contains a comma separated list of Classes it wishes to receive among the following options:
Critical, Warning, Information, Service, Session, or All to get all types of notification.
The notification message shall be sent immediately to the Content Provider upon | | + +| | | | | | | | +|-------|-------------------------------------------------------------------------------------|--|--|--|-------------------|--| +| | | | | | its availability. | | +| NOTE: | Properties marked with a supported feature are applicable as described in clause 9. | | | | | | + +The service instance resource with the properties defined above can be found in Annex B. + +#### 5.2.1.2 API Operations + +##### 5.2.1.2.1 Introduction + +Services can be created, updated, or deleted at the BM-SC by the Content Provider, or the properties of a previously created service at the BM-SC may be obtained by the Content Provider, by invoking HTTP methods on the "service" instance resource or the "services" collection resource. + +##### 5.2.1.2.2 Service Creation + +POST /xmb/v1.0/services + +To create a service, the Content Provider shall use the HTTP POST method on the "services" collection resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services". +- the Host field is set to the address of the BM-SC + +The Content Provider shall follow the procedures defined in clause 9 to advertise support of any feature. + +The content body of the POST request shall be empty. Upon receipt of the HTTP POST request from the Content Provider to create a service, the BM-SC will check whether the Content Provider is authenticated and authorized to create services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.1.2.2-1. If the authorization is successful, the BM-SC shall create a service with default service property values as described in clause 5.2.1.1. Upon successful creation of a service, the BM-SC shall respond to the Content Provider with a 201 message indicating that the service is successfully created along with the service resource identifier of the service resource. The service resource identifier is the identifier that uniquely identifies the service. When the Content Provider receives the service resource identifier, it shall use this identifier in subsequent requests to the BM-SC to refer to this service. Alternatively, if the creation of service failed, the BM-SC shall send a 403 message to the Content Provider. + +Both the Content Provider and BM-SC shall remember the negotiated features for the lifetime of the service. + +The possible response messages from the BM-SC, depending on whether the POST request is successful or unsuccessful, are shown in Table 5.2.1.2.2-1. + +**Table 5.2.1.2.2-1: Response status code, message, and contents for service creation** + +| Status Code | Message | Contents | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| 201 Created | Service created successfully | The BM-SC shall send the service resource identifier of the created service. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 412 Precondition Failed | Request cannot be fulfilled | The precondition given in one or more of the request-header fields evaluated to false when it was tested on the recipient. | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | + +##### 5.2.1.2.3 Service Modification + +###### 5.2.1.2.3.1 Partial Modification of Service Properties + +PATCH /xmb/v1.0/services/{service-res-id} + +Assuming that a service has been created using the service creation method described in clause 5.2.1.2.2, partial updating of its properties can be performed by the Content Provider using the HTTP PATCH method on the "service" instance resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}" +- the Host field is set to the address of the BM-SC +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +The content body of the service modification request shall contain updated partial representation of the service resource. The representation of the service is based on the JSON schema of the service resource as described in clause 5.2.1.1. Further, one or more properties of the service listed in Table 5.2.1.1-1, with the exception that the value of the properties "id", "service-id", "pull-notification-url" and "receive-only-mode" cannot be modified. + +Upon receipt of the HTTP PATCH request from the Content Provider to update a service, the BM-SC will check whether the Content Provider is authenticated and authorized to update services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message. If the authorization is successful, the BM-SC shall update the requested service. Upon successful updating of the requested service, the BM-SC shall respond to the Content Provider with a 200 OK message indicating that the service is successfully updated along with the updated service resource. If the service was not found, the BM-SC shall send a 404 Not Found message. If the service cannot be updated, the BM-SC shall send a 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the PATCH request is successful or unsuccessful, are shown in Table 5.2.1.2.3.1-1. + +**Table 5.2.1.2.3.1-1: Response status code, message, and contents for service modification using HTTP PATCH** + +| Status Code | Message | Contents | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource that is modified | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | + +###### 5.2.1.2.3.2 Full Modification of Service Properties + +PUT /xmb/v1.0/services/{service-res-id} + +Assuming that a service has been created using the service creation method described in clause 5.2.1.2.2, full modification of its properties can be performed by the Content Provider using the HTTP PUT method on the "service" instance resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}" +- the Host field is set to the address of the BM-SC +- the Content-Type header field is set to "application/json" + +- the body of the message is encoded in JSON format + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +The content body of the service update request shall contain the updated representation of the service resource. The representation of the service is based on the JSON schema of the service resource as described in clause 5.2.1.1. Furthermore, when HTTP PUT method is used for updating the service, the Content Provider shall specify the updated values of all the service properties with the exception that the value of the properties "id", "service-id", "pull-notification-url" and "receive-only-mode" cannot be modified. + +Upon receipt of the HTTP PUT request from the Content Provider to update a service, the BM-SC will check whether the Content Provider is authenticated and authorized to update services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.1.2.3.2-1. If the authorization is successful, the BM-SC update the requested service. While updating the service representation, the BM-SC shall overwrite the values of all properties of the service being updated with the values provided in the update request. Upon successful update of the requested service, the BM-SC shall respond to the Content Provider with a 200 OK success message indicating that the service is successfully updated along with the updated service resource. If the service was not found, the BM-SC shall send a 404 Not Found message. If the service cannot be updated, the BM-SC shall send a 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the PUT request is successful or unsuccessful, are shown in Table 5.2.1.2.3.2-1. + +**Table 5.2.1.2.3.2-1: Response status code, message, and contents for service modification using HTTP PUT** + +| Status Code | Message | Contents | +|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|----------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource that is modified | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +##### 5.2.1.2.4 Service Deletion + +DELETE /xmb/v1.0/services/{service-res-id} + +To delete a service, the Content Provider shall use the HTTP DELETE method on the "service" instance resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}" +- the Host field is set to the address of the BM-SC +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +Upon receipt of the HTTP DELETE request from the Content Provider to delete a service, the BM-SC will check whether the Content Provider is authenticated and authorized to delete services as described in clause 7. If the + +authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.1.2.4-1. If the authorization is successful, the BM-SC shall delete the requested service. Upon successful deletion of requested service, the BM-SC shall respond to the Content Provider with a 200 OK success message indicating that the service is successfully deleted along with the service resource identifier of the service that is deleted. If the service was not found, the BM-SC shall send a 404 Not Found message. If the service cannot be deleted, the BM-SC shall send 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the DELETE request is successful or unsuccessful, are shown in Table 5.2.1.2.4-1. + +**Table 5.2.1.2.4-1: Response status code, message, and contents for service deletion** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|----------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource identifier of the service that is deleted | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | + +Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. + +##### 5.2.1.2.5 Service Retrieval + +Services can be read when the Content Provider wishes to know the latest representation of the service resource at the BM-SC. + +###### Retrieval of a specific Service + +GET /xmb/v1.0/services/{service-res-id} + +The retrieval of a service shall be performed by the Content Provider using the HTTP GET method on the "service" instance resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}" +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +Upon receipt of the HTTP GET request from the Content Provider, the BM-SC will check whether the Content Provider is authenticated and authorized to read services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.1.2.5-1. If the authorization is successful, the BM-SC shall respond to the Content Provider with a 200 OK message along with the service information. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The content body of this response message shall be the representation of the requested service based on the JSON schema of service resource as described in clause 5.2.1.1. The properties "service-id", "service-class", and "service-announcement-mode" shall be included in the response to the Content Provider. All other properties of the service instance are optional to be returned to the Content Provider. + +Alternatively, if the service was not found, the BM-SC shall send a 404 Not Found message. If the request cannot be fulfilled, the BM-SC shall send a 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.1.2.5-1. + +**Table 5.2.1.2.5-1: Response status code, message, and contents for service modification using HTTP GET** + +| Status Code | Message | Contents | +|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|-------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service representation of the service resource to the Content Provider | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +###### Retrieval of all Services + +GET /xmb/v1.0/services + +The retrieval of all services shall be performed by the Content Provider using the HTTP GET method on the "services" instance resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services" +- the Host field is set to the address of the BM-SC + +Upon receipt of the HTTP GET request from the Content Provider, the BM-SC will check whether the Content Provider is authenticated and authorized to read services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.1.2.5-2. If the authorization is successful, the BM-SC shall respond to the Content Provider with a 200 OK message along with information of all services configured at the BM-SC. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the representation of the list of all services configured at the BM-SC where each service representation is based on the JSON schema of service resource as described in clause 5.2.1.1. The properties "service-id", "service-class", and "service-announcement-mode" shall be included for each service representation in the response to the Content Provider. All other properties of the service instance are optional to be returned to the Content Provider. + +Alternatively, if there are no services configured at the BM-SC, the BM-SC shall send message content in the 200 OK message indicating to the Content Provider that there are no services configured at the BM-SC. If the request cannot be fulfilled, the BM-SC shall send a 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.1.2.5-2. + +**Table 5.2.1.2.5-2: Response status code, message, and contents for service modification using HTTP GET** + +| Status Code | Message | Contents | +|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | If there are services configured at the BM-SC, the BM-SC shall send the representations of all the configured services to the Content Provider. If there are no services configured at the BM-SC, the BM-SC shall | + +| | | | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------| +| | | send message content in this message that there are no services configured at the BM-SC | +| 401
Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403
Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | + +### 5.2.2 Sessions + +#### 5.2.2.0 General + +The Content Provider shall configure sessions at the BM-SC using the RESTful API methods over two resources managed at the BM-SC. + +Table 5.2.2-1 summarizes different resources for provisioning and managing sessions at the BM-SC. + +**Table 5.2.2-1: Resources for managing sessions at BM-SC** + +| Resource Name | Resource Type | Description | +|---------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Session | Instance resource | Represents a single session resource. The Content Provider can provision or modify a single session at the BM-SC by invoking REST API requests to this session resource at the BM-SC. | +| Sessions | Collection Resource | Represents a collection of session resources. | + +Since sessions are configured for each service, the session instance resource or the sessions collection resource are referenced through a particular service. + +#### 5.2.2.1 Properties + +Each session resource described in Table 5.2.2-1 has the set of properties described in Table 5.2.2.1-1. The Content Provider shall modify one or more of the properties of the session resource using the API operations described in clause 5.2.2.2 + +Table 5.2.2.1-1 summarizes the different properties of a session resource. + +**Table 5.2.2.1-1: Properties of session resource** + +| Property Token | JSON Value Type | Defaults | | Parameter Description | Applicability (NOTE) | +|--------------------|-----------------|--------------------------------------------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| session-start | number | UTC Date timestamp (with second precision) | Session creation date + 1h | Time at which the MBMS Bearer become active. | | +| session-stop | number | UTC Date timestamp (with second precision) | Session start date + 1h | Time at which the MBMS bearer becomes inactive. | | +| max-ingest-bitrate | number | kbps | 0 | This requested bitrate by the Content Provider for content ingestion at the BM-SC, which excludes FEC overhead and transport overhead. The BM-SC calculates the MBMS Bearer bitrate from | | + +| | | | | | | +|--------------------------------|---------------|--------------------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | its value, considering overhead like FEC and other transport overheads. The session bitrate is always larger than or equal to the payload bitrate | | +| max-delay | number | ms | -1 | Specifies the maximum delay the MBMS System should add, i.e. from the time a packet is received by the BM-SC to the time when the packet should be received by the MBMS client. | | +| session-state | string | None | Idle | The BM-SC may automatically change the state of the session.

Possible states: "Session Idle", "Session Announced", "Session Active". | | +| service-announcement-starttime | number | UTC Date timestamp (with second precision) | None | When present, the wall-clock time at which the BM-SC shall start service announcement. If absent, the BM-SC may automatically start service announcement when it has all the data needed to perform such service announcement. | | +| geographical-area | string | None | Empty list | Geographical area to which the service is to be provided, via either unicast or MBMS bearers. The BM-SC derives the MBMS service area and the SAI list corresponding to the geographical area as provided by the Content Provider.

The Geographical Area contains list of string.

If the mc-extension property is present and the MCExtension feature is supported, the content of each string follows the format specified by clause 5.4.7 of 3GPP TS 26.348 [33].

Else, the content of each string item is left to the business agreement between the Content Provider and the Operator. | | +| qoe-reporting-configuration | object | | | The Content Provider wishes to collect QoE reports for the session. The Content Provider can supply a list of QoE metric configurations where each metric configuration shall contain:

Metric name: Name of QoE metric

Metric type: Type of metric

Reporting interval: The interval at which the BM-SC should periodically aggregate and report the statistics to the Content Provider.

Sample percentage: Percentage of users to collect reports from

Start time: Start time of report collection

End time: End time of report collection

If this configuration is included, the QoE | | + +| | | | | | | +|--------------|---------|------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| | | | | reporting configuration shall be applied only for this session., and the Content Provider is requesting override of service level configuration for this session by this configuration. | | +| session-type | string | None | Files |

The Session Type represents the method used by the Content Provider in providing content to the BM-SC (via xMB-U). The BM-SC shall select the appropriate delivery method from the Session Type.

Valid values: "Streaming", "Files", "Application", "Transport-Mode"

When the Session Type is set to "Streaming", the BM-SC expects a Streaming type input (RTP), and the format shall compliant to MBMS streaming (as defined in 3GPP TS 26.346 [3]).

When the Session Type is set to "Files", the BM-SC expects generic files as input. The files can be provided either by on-request pull interactions or continuous push ingest.

When the Session Type is set to "Application", then the ingest method depends on the application service description.

When the Application Service Description corresponds to DASH, the BM-SC expects an MPD and optionally one or more Initialization Segments. The content is assumed to be 3GP-DASH compliant (as defined by 3GPP TS 26.247 [18]). The BM-SC may either pull the Media Segments from the Content Provider or the Content Provider will continuously push Media Segments to the BM-SC.

When the Session Type is set to "Transport-Mode", the BM-SC provides transport of data/TV content in a transparent manner. The Content Provider may provide some properties for the MBMS distribution.

The Session Type shall be extensible to include other session types.

| | +| max-cid | integer | none | none |

integer indicating the MAX CID parameter for the compressor (see IETF RFC 5795 [27]). The value for the LARGE_CID parameter (usage of short CID representation or large CID representation) shall be deducted from MAX_CID as follows:

If MAX_CID > 15 then LARGE_CIDS = TRUE else LARGE_CIDS = FALSE.

When header compression applies, the "max-cid" property shall be provided together with "header-compression" property.

| ROHC | + +| | | | | | | +|--------------------|----------------|------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| header-compression | object | none | none |

Requests the BM-SC to enable ROHC (see IETF RFC 5795 [27] and IETF RFC 3095 [28]) on the input flow. The object consists of:

  • - "ipv4addr": String identifying an IPv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166 [31].
  • - "ipv6addr": String identifying an IPv6 address formatted according to clause 4 of IETF RFC 5952 [32]. The mixed IPv4 IPv6 notation according to clause 5 of IETF RFC 5952 shall not be used.
  • - "port": integer between 0 and 65535 identifying a UDP or TCP port
  • - "periodicity": a number denoting the target periodicity for ROHC full header packets in units of seconds
  • - "profile": integer denoting the applicable ROHC profile (see IETF RFC 5795 [27]). The value is restricted to the 0x0001 RTP/UDP/IP profile or the 0x0002 UDP/IP profile, 0x0001 profile applies if omitted.

Either "ipv4addr" or "ipv6addr" shall be included and "port" and "periodicity" may be included.

The BM-SC shall:

  1. 1. apply the procedures in IETF RFC 5795 [27] and in IETF RFC 3095 [28] to provide header compression to downlink IP packets and possibly higher protocol layers within the user plane data;
  2. 2. use the ROHC profile requested in the "profile" property for downlink packet which belongs to any of the flows listed in this property;
  3. 3. use the 0x0000 uncompressed profile for any downlink packet which does not belong to any of the flows listed in this property; and
  4. 4. use the ROHC unidirectional mode (see IETF RFC 3095 [28]) without ROHC segmentation (see IETF RFC 5795 [27]).
| ROHC | +| fec | string | none | none | Requests the BM-SC to perform FEC (see IETF RFC 6363 [29]) protection of the input flow when transmitting over the MBMS channel. The string shall include an SDP description of FEC framework configuration information (see clause 5.5 of IETF RFC 6363 [29]) formatted according to clause 8A.5 of 3GPP TS 26.346 [3]. | FEC | +| resource- | boolean | none | false | The resource sharing indication. | ResourceSharing | + +| | | | | | | +|------------------------------------------|--------|----------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| sharing-ind | | | | When present and set to "true", it implies the current transmission resources can be shared with other sessions.

Note that other sessions will use the same Max Bitrate, Geographical Area and (in case of MC Services) QoS-Information. | | +| resource-sharing-url | string | none | none | The resource sharing id.

When present in the session modification request, the value of the field identifies an existing xMB session resource URL (as specified in table 5.1.1-1) to share the transmission, where Max Bitrate, Geographical Area and (in case of MC Services) QoS-Information are re-used.

Note that the Max Bitrate, Geographical Area and (in case of MC Services) QoS-Information cannot be changed since the values from the original session will be used. | ResourceSharing | +| session-announcement-mode | string | – None – | Other | Represents the session announcement mode. The session announcement mode is either "Content Provider" or "SACH", with the following behavior:

"Content Provider": The BMSC generates the session parameters and provides those to the Content Provider.

"SACH": In this case, the session announcement is done by the MBMS system through the SACH. (see Annex L.2, L.3 of 3GPP TS 26.346 [3]).

Additional modes may be added in future releases.

Only applicable if the Session Type is set to "Transport-Mode" | Transport | +| userplane-session-description-parameters | object | | | This property provides information to the BM-SC on where and how to access the user plane content from the content provider, and comprises one or more of the following components:

Type : the type of the content associated with the target resource, for example the Internet Media Type of the resource as identified by an HTTP/S URL. An "embedded" type is defined, which indicates that the xMB-U user plane parameters are embedded in the User Plane Parameters object described below.

Access URL : A URL that enables the access to and possibly control of the ingest session. The URL may, for example, be an RTSP URL, a reference to an SDP that describes a multicast stream, or an | Transport | + +| | | | | | | +|---------------------------------------|--------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| | | | |

HTTP/S URL to retrieve an already-packaged MPEG2-TS stream.

User Plane Parameters: When the Type is set to "embedded", the Content Provider shall provide an object to the BM-SC which contains the session description.

If this property is set to Forward-only, the object may contain a ready-made Session Description and the indication of a single xMB-U reception UDP port. When a Session Description is present, the BM-SC shall use it for Service Announcement.

If this property is set to Proxy, the object shall contain a Session Description template and a list of the transmitted UDP flows to be forwarded on the established MBMS bearer for the session. For each list entry, the content provider shall indicate whether a) this UDP flow is directly associated with a media description entry in the Session Description Template – i.e., an "m=" line is present in the template and which contains a port field, or b) this UDP flow is related to a media description entry – e.g., it corresponds to an RTCP flow affiliated with the RTP flow as described by the RTP/AVP profile). If the flow is directly associated with a media description entry, then the BM-SC shall modify the port field of the media description entry in the Session Description Template. If the flow is related to a media description entry, then the BM-SC shall simply forward the flow onto a port whose value is equal to the port of the related media session plus an offset.

Note the BM-SC may get input on session properties from the content provider, e.g. bitrate, depending on the ingest session.

| | +| userplane-delivery-mode-configuration | string | – None – | Forward-only |

This property defines how the session needs to be delivered to the application, i.e. it basically establishes the delivery mode.

Mode Enumeration: Specifies the delivery mode.

Forward-only: The BM-SC receives complete IP Multicast packets for to be forwarded.

| Transport | + +| | | | | | | +|-----------------------------------------|--------|-----------|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------| +| | | | |

The Content Provider will create the IP multicast packets.

Proxy: The BM-SC proxies the incoming UDP payloads to the outgoing UDP payloads. The BM-SC will create the IP multicast packets.

Only applicable if the Session Type is set to "Transport-Mode".

| | +| delivery-session-description-parameters | string | | |

The contents of this property depend on the setting of the Session Announcement Mode property. If Session Announcement Mode is set to "Content Provider", then at minimum the following session parameters shall be provided by the BM-SC:

TMGI of the MBMS Bearer

For Receive Only Mode service, the TMGI shall be allocated from the range specified in 3GPP TS 24.116 [25]. Note that additional session parameters may be provided, based on the configuration options of the delivery method set to "Transport-Mode".

Only applicable if the Session Type is set to "Transport-Mode".

| Transport | +| sdp-url | string | – None – | "" |

A URL to the SDP that describes the streaming session between the Content Provider and the BM-SC, which will be used for BM-SC ingestion of the streaming session via xMB-U. The SDP shall include the RTSP links for every media session as part of the "a=control" attribute to enable RTSP control of the session. The SDP shall also contain the required bitrate for each of the media sessions.

The content shall conform to the constraints of this specification.

Only applicable if the Session Type is set to "Streaming".

| RTPStreaming | +| time-shifting | number | second | 0 |

Indicates if and for how long time shifting access to the content (using unicast) may be provided for this session.

If not set (so defaulted to 0), there shall be no time shifting access.

Only applicable if the Session Type is set to "Streaming".

| RTPStreaming | +| application-service | string | MIME type | application/dash+xml |

Internet Media Type of the Application Service

Only applicable if the Session Type is set to "Application".

To refer to 5GMS DASH content, the MIME content type may include a profile parameter including the profile of 5G

| ApplicationPush, ApplicationPull | + +| | | | | | | +|----------------------------|--------|------|----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| | | | | Media Streaming as "urn:3GPP:5GMS:iop:DASH", as defined in DASH in clause 7.3.11 of 3GPP TS 26.247 [18]. | | +| ingest-mode | string | None | "Push" when Session Type is set to "Application"

"Pull" when Session Type is set to "Files" |

The ingest mode enumerates how resources are ingested into the BM-SC via xMB-U.

When the Session Type is set to "Application":

Pull: The BM-SC pulls the resources as described by the application entry point document.

Push: The Content Provider pushes resources. The BM-SC needs to provide a push URL.

In case of DASH, resources are Media Segments:

Pull: The BM-SC pulls the Media Segments as described by the Segment availability start time from a DASH MPD.

Push: The Content Provider pushes Media Segments, so that the Media Segment is available on the BM-SC according to Segment availability start time. The BM-SC needs to provide a push URL.

When the Session Type is set to "Files":

Push: The Content Provider shall push the file to the BM-SC that will immediately process and deliver as soon as it is ready. The BM-SC may be configured to ignore all files that are pushed before session active time, or store them. In case of Push mode, the BM-SC shall provide back to the Content Provider the URL the Content Provider shall use to push the files.

Pull: In this case, the Content Provider provides the resource location from which the BM-SC will fetch the file. The Content Provider may tell the BM-SC when to start fetching the file.

| ApplicationPush, ApplicationPull, FilePush, FilePull | +| application-entrypoint-url | string | None | "" |

The application entry point refers to an MPD when Application Service Description pertains to DASH.

When the Ingest Mode is set to Push, the MPD URL refers to a DASH MPD which should be fetched, optionally conditioned, and then inserted into Service Announcement.

When the Ingest Mode is set to Pull, then the BM-SC will fetch the Segments using unicast.

| ApplicationPush, ApplicationPull, | + +| | | | | | | +|------------------|---------|------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------| +| | | | | Note that if not set to a valid URL, the session will not be started. | | +| push-url | string | None | "" |

When the Session Type is set to "Application":

A resource locator for ingesting Media Segments using HTTP via xMB-U. The Content Provider may create additional sub-resources using WebDAV procedures.

This is a read-only property managed by the BM-SC and only present when Ingest Mode is set to Push

This property is mandatory if the Session type is set to "Application" and Ingest Mode is set to Push.

When the Session Type is set to Files:

A resource locator for ingesting content using HTTP via xMB-U.

This is a read-only property managed by the BM-SC and only present when Ingest Mode is set to Push.

| ApplicationPush, FilePush | +| unicast-delivery | boolean | None | False |

Indicator whether the content is also available for unicast retrieval.

Only applicable if the Session Type is set to "Application".

If set "true", the application client may access the content referenced in the application entry point from a unicast content server or a 5GMS AS.

| ApplicationPush, ApplicationPull, | +| Components | array | None | Empty list |

List of components of the application, which are recommended to be made available on MBMS Bearers.

In case of DASH, each component is identified by a representation identifier.

Only applicable if the Session Type is set to "Application".

| ApplicationPush, ApplicationPull, | +| file-list | array | | |

List of files to be sent.

In the Push mode, the file list is not used since the BM-SC will monitor its push folder and send the files it receives on a first-come first-served basis.

In Pull mode, the file list contains the following information per file entry:

file URL: the URL to the file the BM-SC will use to fetch the content

| FilePull, FileRepair (NOTE 2) | + +| | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

file display URL: The URL to the file as seen by the UE

byte-range (optional): If present and set to "true", indicates that the HTTP(S) URL given in the file display URL parameter can be used for Byte-Range-Based file repair (clause 9.3 of 3GPP TS 26.346 [3]) otherwise file display URL parameter should not be used for Byte-Range-Based file repair

e-tag (optional): represents the value of the ETag as defined in IETF RFC 7232 [38] which may also serve as the version identifier for the file in the Byte-Range-Based file repair requests. The ETag should only be supplied by the 3rd party content provider if it is expected that it is different from the one provided over xMB-U when fetching the file.

file earliest fetch time: The BM-SC shall fetch the file no sooner than this UTC timestamp. If absent, then the file shall be present on the Content Provider server and the BM-SC may fetch it at a time of its choosing.

file latest fetch time: The BM-SC shall fetch the file no later than this UTC timestamp. If absent, then the file shall be present on the Content Provider server and the BM-SC may fetch it at a time of its choosing.

file size (optional): The Content Provider may provide the precise or a file size estimate as input. The BM-SC may update the file size once it has started to fetch the file.

file status: Enumeration stating the state of the file. Possible values are pending, fetched, prepared, transmitting, sent.

Target reception completion time (on the MBMS Client): hint on the deadline by which target time the file should be completely received by the UE. The BM-SC should schedule and order the transmission accordingly.

Keep Updated Interval: The BM-SC checks the file resources with the given interval for changes.

Unicast availability: Indication that the file is also available for unicast retrieval by the application at a Content Provider server whose location is given by the HTTP(S)

| +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | | +|---------------------------------|--------|------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | | | |

URL corresponding to the value of "file display URL".

File repetition: The number of times the file shall be sent on the session (a value of 1 means the file shall be sent only once). This counter shall be decreased by one each time the file has been transmitted. When the counter reaches zero the file will cease to be delivered. The BM-SC may send FEC instead of source information.

Note that the expected behavior is that the BM-SC will first send all files in the order of the File List, then decrement the file repetition counter for each file, and subsequently retransmit the list again (only files with counter > 0 are transmitted). This is repeated until all repetitions are completed, or the session stop time has elapsed, whichever event occurring first.

Periodic update interval: When present, it is an indication that this file of the list of files is expected to be periodically updated, and the value of this parameter represents the nominally expected time interval between successive updates of this file. This parameter is a signal to the BM-SC to deliver the file and its updates as a Datacasting service. From its value, the BM-SC will choose the delivery mode ('scheduled-and-periodic' or 'back-to-back'), and set the associated interval and @mode values in controlling the transmission of the Datacasting service.

| | +| file-delivery-manifest-url | string | None | "" |

Alternative to the file list for describing file properties and delivery requirements. The resource may additionally describe scheduling information for the file.

Only applicable if the Session Type is set to Files.

| FilePush, FilePull | +| display-base-url | string | None | "" | When ingest mode is set to Push, the Base URL as seen by the UE. | FilePush | +| sa-file-url | string | None | "" | When the service announcement mode is set to "Content provider", the BM-SC returns the URL of the SA file announcing the session. The BM-SC shall follow the profile 1c (Annex L.3 of 3GPP TS 26.346 [3]) | SaProfile | +| local-mbms-delivery-information | object | | | The Content Provider may request the BM-SC to activate an MBMS bearer for local MBMS based MBMS data delivery. If | LocalMBMS | + +| | | | | | | +|--------------|--------|------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| | | | |

so, the Content Provider shall provide:

MBMS eNB IPv4 multicast address:
Contains the M1 (transport) plane IPv4 destination multicast address used by MBMS-GW for IP multicast encapsulation of application IP multicast datagrams.

MBMS eNB IPv6 multicast address:
Contains the M1 (transport) plane IPv6 prefix of destination multicast address used by MBMS-GW for IP multicast encapsulation of application IP multicast datagrams.

MBMS GW IPv4 SSM address:
Contains the value of MBMS-GW's IPv4 address for Source Specific Multicasting.

MBMS GW IPv6 SSM address:
Contains the value of MBMS-GW's IPv6 address for Source Specific Multicasting.

Common Tunnel Endpoint Identifier:
Indicates the common tunnel endpoint identifier of MBMS GW for user plane.

BM-SC IPv4 address: Indicates the destination IPv4 address of the BM-SC for the reception of user plane data via the xMB-U interface.

BM-SC IPv6 address: Indicates the destination IPv6 address of the BM-SC for the reception of user plane data via the xMB-U interface.

BM-SC port: Indicates the destination UDP port of the BM-SC for the reception of user plane data via the xMB-U interface.

| | +| group-ids | array | None | Empty list |

This parameter contains a list of group identifiers, applicable if the service-announcement-mode is set to "SACH".

It is used by the BM-SC in the service announcement for identifying UE belonging to a group.

| GroupContentDelivery | +| mc-extension | object | | |

If the MCExtension feature is supported, the Content Provider may request the BM-SC to activate an MBMS bearer with a specific QoS. If so, the Content Provider shall provide the following QoS properties in the session modification operation, to be used by the BM-SC within the QoS-Information AVP during the MBMS Session start procedure (3GPP TS 29.061 [20]):

gbr: Guaranteed bitrate for the MBMS session in unit kbps. The BM-SC shall use this value for the

| MCExtension | + +| | | | | | | +|---------------------------------------------------------------------------------------------|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

Guaranteed-Bitrate-DL AVP. The difference between the max-ingest-bitrate and gbr can be used by the BM-SC as a budget for FEC.

qci: QoS Class identifier. The BM-SC shall use this value for the QoS-Class-Identifier AVP.

arp-priority-level: the BM-SC shall use this value for the Priority-Level AVP within the Allocation-Retention-Priority AVP.

arp-pre-emption-capability: the BM-SC shall use this value for the Pre-emption-Capability AVP within the Allocation-Retention-Priority AVP.

arp-pre-emption- vulnerability: the BM-SC shall use this value for the Pre-emption- Vulnerability AVP within the Allocation-Retention-Priority AVP.

If the Content Provider includes the mc-extension property during the session modification operation, the BM-SC shall return the following property in the session retrieval operation:

tmgi: the TMGI of the MBMS session, as returned by the MBMS Session start procedure in 3GPP TS 29.061 [20], the encoding of TMGI is specified in 3GPP TS 24.008 [37], from octet 3 to 8.

| | +| NOTE 1: Properties marked with a supported feature are applicable as described in clause 9. | | | | | | +| NOTE 2: FileRepair feature is only applicable for byte-range and e-tag properties. | | | | | | + +The session instance resource with the properties defined above for each session can be found in Annex B. + +#### 5.2.2.2 API Operations + +##### 5.2.2.2.1 Introduction + +Sessions can be created, updated, or deleted at the BM-SC by the Content Provider, or the properties of a previously created session at the BM-SC, may be obtained by the Content Provider by invoking HTTP methods on the “session” instance resource or the “sessions” collection resource. + +##### 5.2.2.2.2 Session Creation + +POST /xmb/v1.0/services/{service-res-id}/sessions + +To create a session, the Content Provider shall use the HTTP POST method on the "sessions" collection resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions. +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service for which the session creation is sought. + +The content body of the session creation request shall be empty. + +Upon receipt of the HTTP POST request from the Content Provider to create a session, the BM-SC will check whether Content Provider is authenticated and authorized to create sessions as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message. If authorization is successful, the BM-SC shall verify that the service already exists with the given service resource identifier. If the service with given service resource identifier exists at the BM-SC, the BM-SC shall create the requested session for that service with default session property values described in clause 5.2.2.1. Upon successful creation of requested session, the BM-SC shall respond to the Content Provider with a 201 success message indicating that the session is successfully created along with the session resource identifier of the created session. The session resource identifier is the identifier that uniquely identifies the session within that service. When the Content Provider receives the session resource identifier, it shall use this identifier in subsequent requests to the BM-SC to refer to this session. If the creation of session failed, the BM-SC shall send a 403 message. If the service was not found for which the session creation is sought, the BM-SC shall send a 404 message. + +The possible response messages from the BM-SC, depending on whether the POST request is successful or unsuccessful, are shown in Table 5.2.2.2-1. + +**Table 5.2.2.2-1: Response status code, message, and contents for session creation** + +| Status Code | Message | Contents | +|------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------| +| 201 Created | Session created successfully | The BM-SC shall send the session resource identifier of the created session. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable | | + +##### 5.2.2.2.3 Session Modification + +###### 5.2.2.2.3.0 General + +Sessions created using the session creation methods described in clause 5.2.2.2.2 can be updated when the Content Provider wishes to modify the session properties. + +###### 5.2.2.2.3.1 Partial Modification of Session Properties + +PATCH /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} + +Assuming that a session has been created using the session creation method described in clause 5.2.2.2.2, partial updating of its properties can be performed by the Content Provider by using the HTTP PATCH method on the "session" instance resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} +- the Host field is set to the address of the BM-SC +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {service-res-id} in the request URI is the service resource identifier of the service whose session is being modified. + +The {session-res-id} in the request URI is the session resource identifier of the session that is being modified. + +The content body of the session update request shall contain updated partial representation of the session resource. The representation of the session is based on the JSON schema of session resource as described in clause 5.2.2.1. Furthermore, one or more properties of the session listed in table 5.2.2.1-1 with the exception that the session properties "id", "session-state", "qoe-report-url", "delivery-session-description-parameters" and "push-url" cannot be modified. + +Upon receipt of the HTTP PATCH request from the Content Provider to update a session, the BM-SC will check whether the Content Provider is authenticated and authorized to update sessions as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.2.2.3.1-1. If the authorization is successful, the BM-SC shall verify that the service already exists with the given service resource identifier, and a session already exists with the given session resource identifier. If both of them exist, BM-SC shall update the session as requested for that service. Upon successful update of the requested session, the BM-SC shall respond to the Content Provider with a 200 success message indicating that the session is successfully updated along with the updated session resource. As alternative to the 200 OK message, BM-SC may send a 204 No Content success message without any message content to the Content Provider. If the session cannot be updated, the BM-SC shall send a 403 message. If the session is not found or if the service was not found for which the session creation is sought, the BM-SC shall send a 404 message. + +The possible response messages from the BM-SC, depending on whether the PATCH request is successful or unsuccessful, are shown in Table 5.2.2.2.3.1-1. + +**Table 5.2.2.2.3.1-1: Response status code, message, and contents for session modification using HTTP PATCH** + +| Status Code | Message | Contents | +|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|----------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the session resource that is modified | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +###### 5.2.2.2.3.2 Full Modification of Session Properties + +PUT /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} + +Assuming that a session has been created using the session creation method described in clause 5.2.2.2.2, full update of its properties can be performed by the Content Provider using the HTTP PUT method on the "session" instance resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} +- the Host field is set to the address of the BM-SC +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {service-res-id} in the request URI is the service resource identifier of the service whose session is being modified. + +The {session-res-id} in the request URI is the session resource identifier of the session that is being modified. + +The content body of the session update request shall contain updated representation of the session resource. The representation of the session is based on the JSON schema of session resource as described in clause 5.2.2.1. Furthermore, when the HTTP PUT method is used for updating the service, the Content Provider shall specify the updated values of all the session properties with the exception that the session properties "id", "session-state", "qoe-report-url", "delivery-session-description-parameters" and "push-url" cannot be modified. + +Upon receipt of the HTTP PUT request from the Content Provider to update a session, the BM-SC will check whether the Content Provider is authenticated and authorized to update sessions as described in clause 7. If the authorization is unsuccessful, the BM-SC shall send a 401 message as described in table 5.2.2.2.3.2-1. If the authorization is successful, + +the BM-SC shall verify that the service already exists with the given service resource identifier, and a session already exists with the given session resource identifier. If both of them exist, BM-SC shall update the session as requested for that service. While updating session representation, the BM-SC shall overwrite the values of all properties of the session being updated with the values from provided in the update request. Upon successful update of the requested session, the BM-SC shall respond to the Content Provider with a 200 success message indicating that the session is successfully updated along with the updated session resource. As an alternative to 200 OK success message, BM-SC may send a 204 No Content success message without any message content to the Content Provider. If the session cannot be updated, the BM-SC shall send a 403 message. If the session is not found or if the service was not found for which the session creation is sought, the BM-SC shall send a 404 message. + +The possible response messages from the BM-SC, depending on whether the PUT request is successful or unsuccessful, are shown in Table 5.2.2.2.3.2-1. + +**Table 5.2.2.2.3.2-1: Response status code, message, and contents for session modification using HTTP PUT** + +| Status Code | Message | Contents | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the session resource that is modified | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | + +##### 5.2.2.2.4 Session Deletion + +DELETE /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} + +To delete a session, the Content Provider shall use the HTTP DELETE method on the "session" instance resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service whose session is being deleted. + +The {session-res-id} in the request URI is the session resource identifier of the session that is being deleted. + +Upon receipt of the HTTP DELETE request from the Content Provider to delete a session, the BM-SC will check whether the Content Provider is authenticated and authorized to delete services as described in clause 7. If the authorization is unsuccessful, the BM-SC shall send a 401 message as described in table 5.2.2.2.4-1. If the authorization is successful, the BM-SC shall verify that the service already exists with the given service resource identifier and a session exists with the given session resource identifier. If both of them exist, BM-SC shall delete the requested session for the given service. Upon successful deletion of requested session, the BM-SC shall respond to the Content Provider with a 200 success message indicating that the session is successfully deleted along with the service resource identifier and the session resource identifier. As an alternative to the 200 OK success message, BM-SC may send a 204 No Content success message without any message content to the Content Provider. If the session cannot be deleted, the BM-SC shall send a 403 message. If the session is not found or if the service was not found for which the session creation is sought, the BM-SC shall send a 404 message. + +The possible response messages from the BM-SC, depending on whether the DELETE request is successful or unsuccessful, are shown in Table 5.2.2.2.4-1. + +**Table 5.2.2.2.4-1: Response status code, message, and contents for session deletion** + +| Status Code | Message | Contents | +|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|----------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the session resource identifier of the session that is deleted | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +##### 5.2.2.2.5 Session Retrieval + +Sessions can be read when the Content Provider wishes to know the latest representation of the session resources at the BM-SC. + +Retrieval of a specific Session of a specific Service + +GET /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} + +The retrieval of a session shall be performed by the Content Provider using the HTTP GET method on the "session" instance resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +The {session-res-id} in the request URI is the session resource identifier of the session that is being retrieved. + +Upon receipt of the HTTP GET request from the Content Provider, the BM-SC will check whether the Content Provider is authenticated and authorized to read services and sessions as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.2.2.5-1. If the authorization is successful, the BM-SC shall respond to the Content Provider with a 200 OK message and shall include the session resource representation of the session corresponding to the given service to the Content Provider. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the representation of the session configured at the BM-SC for the given service where the session representation is based on the JSON schema of session resource as described in clause 5.2.2.1. The properties "session-start", "session-stop", "max-ingest-bitrate", "session-state", "geographical-area", "session-type", "session-announcement-mode", "session-type", "userplane-delivery-mode-configuration", "sdp-url", "application-service-description", "ingest-mode", "application-entrypoint-url", and "unicast-delivery" shall be included in the response to the Content Provider. All other properties of the session instance are optional to be returned to the Content Provider. + +Alternatively, if the service was not found or if the session was not found, the BM-SC shall send a 404 Not Found message. If the request cannot be fulfilled, the BM-SC shall send 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.2.2.5-1. + +**Table 5.2.2.2.5-1: Response status code, message, and contents for service modification using HTTP GET** + +| Status Code | Message | Contents | +|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|-------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the session representation of the session resource to the Content Provider | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +###### Retrieval of all Sessions of a Service + +GET /xmb/v1.0/services/{service-res-id}/sessions + +The retrieval of all sessions of a service shall be performed by the Content Provider using the HTTP GET method on the "sessions" instance resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +Upon receipt of the HTTP GET request from the Content Provider, the BM-SC will check whether the Content Provider is authenticated and authorized to read services and sessions as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.2.2.5-2. If the authorization is successful, the BM-SC shall respond to the Content Provider with a 200 OK message. If there are sessions configured at the BM-SC for the corresponding service, the BM-SC shall send the representation of the list of all session resources configured at the BM-SC for that service along with the 200 OK message. If there are no sessions configured at the BM-SC for that service, the BM-SC shall send message content in the 200 OK message indicating to the Content Provider that there are no sessions configured at the BM-SC for that service. + +The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the representation of list of sessions configured at the BM-SC for the given service where each session representation is based on the JSON schema of session resource as described in clause 5.2.2.1. The properties "session-start", "session-stop", "max-ingest-bitrate", "session-state", "geographical-area", "session-type", "session-announcement-mode", "session-type", "userplane-delivery-mode-configuration", "sdp-url", "application-service-description", "ingest-mode", "application-entrypoint-url", and "unicast-delivery" shall be included for each session representation in the response to the Content Provider. All other properties of the session instance are optional to be returned to the Content Provider. + +Alternatively, if the request cannot be fulfilled, the BM-SC shall send 403 Forbidden message to the Content Provider. If the service was not found, the BM-SC shall send a 404 Not Found message + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.2.2.5-2. + +**Table 5.2.2.2.5-2: Response status code, message, and contents for service modification using HTTP GET** + +| Status Code | Message | Contents | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | If there are sessions configured at the BM-SC for that service, the BM-SC shall send the representations of all the configured sessions for that service to the Content Provider. If there are no sessions configured at the BM-SC for that service, the BM-SC shall send message content in this message indicating to the Content Provider that there are no sessions configured at the BM-SC for this service | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | + +### 5.2.3 Reports + +#### 5.2.3.0 General + +The BM-SC shall send reports to the Content Provider upon request by the Content Provider. Table 5.2.3-1 summarizes different report resources that the BM-SC manages for sending reports to the Content Provider. + +**Table 5.2.3-1: Resources for managing reports at BM-SC** + +| Resource Name | Resource Type | Description | +|---------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| Report | Instance resource | Represents a single report resource. The BM-SC can send an individual report to the Content Provider using the report instance resource | +| Reports | Collection Resource | Represents a collection of report resources. | + +Reports can be generated separately for each service or for a session belonging to a particular service. Therefore, a report can be referenced with a given service resource identifier or for a combination of service resource identifier and session resource identifier. + +#### 5.2.3.1 Properties + +Each report resource described in Table 5.2.3-1 has the set of properties described in Table 5.2.3.1-1. The BM-SC shall deliver the reports as indicated by this structure using the API operations described in clause 5.2.3.2 + +Table 5.2.3.1-1 summarizes different service properties of a service resource. + +**Table 5.2.3.1-1: Resources for managing services at BM-SC** + +| Property Token | JSON Value Type | Parameter Description | +|------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| report-res-id | string | Report resource identifier | +| report-starttime | string | Report collection start time | +| report-endtime | string | Report collection end time | +| report-type | string | Type of report. Three types of reports can be generated by the BM-SC to send to the Content Provider:
Consumption report: Report that provides service consumption information
QoE report: Report that provides detailed QoE information of the content received
File reception report: Report that provides detailed reception information for each file | +| report-url | string | Location of the report from where the Content Provider can retrieve the detailed report. | +| Report | string | Detailed report. This may not be included if report-url is included | + +The report instance resource with the properties defined above for each report can be found in Annex B. + +#### 5.2.3.2 API Operations + +##### 5.2.3.2.1 Introduction + +The Content Provider can request reports from the BM-SC for a given service or a session belonging to a given service. + +##### 5.2.3.2.2 Report Retrieval + +Reports can be retrieved by the Content Provider for a service or for a session of a given service using HTTP GET method. + +###### Report Retrieval for a Service + +GET /xmb/v1.0/services/{service-res-id}/reports + +The retrieval of reports of a service shall be performed by the Content Provider using the HTTP GET method on the "reports" collection resource as follows: + +- the request URI with the "path" part set to: "/xmb/v1.0/services/{service-res-id}/reports" +- the Host field is set to the address of the BM-SC + +QoE reports however are only available on session level. The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +Upon receipt of a HTTP GET request from the Content Provider to retrieve all the reports of a service, the BM-SC will check whether the Content Provider is authenticated and authorized to request reports for services and sessions configured at the BM-SC as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.3.2.2-1. If the authorization is successful, the BM-SC shall verify that the service with the given service resource identifier exists at the BM-SC. If the service exists at the BM-SC, the BM-SC shall respond to the Content Provider with a 200 success message along with the service resource identifier and the list of all reports for that service. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the list of report for that service. Each report in this list shall be based on the JSON schema of report resource as described in clause 5.2.3.1. + +Alternatively, if the report retrieval request cannot be fulfilled, the BM-SC shall send a 403 message to the Content Provider. If the service for which the report is sought could not be found, the BM-SC shall send a 404 message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.3.2.2-1. + +**Table 5.2.3.2.2-1: Response status code, message, and contents for retrieval of all service reports** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource identifier and all the reports for the service | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | + +Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. + +GET /xmb/v1.0/services/{service-res-id}/reports/{report-res-id} + +The Content Provider can request individual reports of a service if it is aware of the report resource identifiers of that service. A specific report for a service can be retrieved by the Content Provider using the HTTP GET method on the "report" instance resource as follows. + +- the request URI with the "path" part set to: "/xmb/v1.0/services/{service-res-id}/reports/{report-res-id}" +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service whose reports are being sought. + +The {report-res-id} in the request URI is the report resource identifier of that service. + +It should be noted that QoE reports are only available on session level. Upon receipt of a HTTP GET request from the Content Provider to retrieve a specific report of a service with report resource identifier, the BM-SC will check whether the Content Provider is authenticated and authorized to request reports for services and sessions configured at the BM-SC as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.3.2.2-2. If the authorization is successful, the BM-SC shall verify that the service with the given service resource identifier and a report with given report resource identifier exists for that service at the BM-SC. If such report exists at the BM-SC, the BM-SC shall respond to the Content Provider with a 200 success message along with the service resource identifier and the report to the Content Provider. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the requested report resource for that service whose representation is based on the JSON schema of report resource as described in clause 5.2.3.1. + +Alternatively, if the report retrieval request cannot be fulfilled, the BM-SC shall send a 403 message to the Content Provider. If the service for which the report is sought could not be found, the BM-SC shall send a 404 message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.3.2.2-2. + +**Table 5.2.3.2.2-2: Response status code, message, and contents for retrieval of a specific report of a service** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|----------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource identifier and the requested report of the service | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | + +Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. + +###### Report Retrieval for a Session of a given Service + +GET /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id}/reports + +The retrieval of all the reports of a session for a given service shall be performed by the Content Provider using the HTTP GET method on the "reports" collection resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}/sessions/{session-res-id}/reports." +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +The {session-res-id} in the request URI is the session resource identifier of the session whose reports are being sought. + +Upon receipt of a HTTP GET request from the Content Provider to retrieve all the reports of a session of given service, the BM-SC will check whether the Content Provider is authenticated and authorized to request reports for services and sessions configured at the BM-SC as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.3.2.2-3. If the authorization is successful, BM-SC shall verify that the service with the given service resource identifier and a corresponding session with the given session identifier exists at the BM-SC. If such a session exists at the BM-SC, the BM-SC shall respond to the Content Provider with a 200 success message along with the list of all reports for that session. If there are no reports for that session at the BM-SC, the BM-SC shall send a 200 OK message with message content indicating that there are no reports for the session at the BM-SC. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the list of all reports for that session. Each report in this list of reports sent shall be based on the JSON schema of report resource as described in clause 5.2.3.1. + +Alternatively, if the report retrieval request cannot be fulfilled, the BM-SC shall send a 403 message to the Content Provider. If the session for which the report is sought could not be found, or if the service corresponding to that sessions could not be found, the BM-SC shall send a 404 message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.3.2.2-3. + +**Table 5.2.3.2.2-3: Response status code, message, and contents for retrieval of all reports for a session** + +| Status Code | Message | Contents | +|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource identifier, session resource identifier, and all the reports of that session. If there are no reports for that session at the | + +| | | | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| | | BM-SC, the BM-SC shall include message content indicating that there are no reports for the requested session at the BM-SC. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | + +GET /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id}/reports/{report-res-id} + +The Content Provider can request individual reports of a given session of a service if it is aware of the report resource identifiers of that session for that service. A specific report for a session can be retrieved by the Content Provider using the HTTP GET method on the "report" instance resource as follows. + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}/sessions/{session-res-id}/reports/{report-res-id}" +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +The {session-res-id} in the request URI is the session resource identifier of the session whose report is being sought. + +The {report-res-id} in the request URI is the report resource identifier that is being sought. + +Upon receipt of a HTTP GET request from the Content Provider to retrieve a specific report for a session of a service, the BM-SC will check whether the Content Provider is authenticated and authorized to request reports for services and sessions configured at the BM-SC as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.3.2.2-4. If the authorization is successful, the BM-SC shall verify that a report with report resource identifier exists for a session with given session resource identifier whose service identifier is the given service resource identifier at the BM-SC. If such a report exists at the BM-SC, the BM-SC shall respond to the Content Provider with a 200 success message along with the requested report to the Content Provider. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the requested report resource for that session for the given service and whose representation is based on the JSON schema of report resource as described in clause 5.2.3.1. + +Alternatively, if the report retrieval request cannot be fulfilled, the BM-SC shall send a 403 message to the Content Provider. If the session for which the report is sought could not be found, or if the service corresponding to that session could not be found, or if the report is not found, the BM-SC shall send a 404 message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.3.2.2-4. + +**Table 5.2.3.2.2-4: Response status code, message, and contents for retrieval of a specific report of a session** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource identifier, session resource identifier, and the requested report for the service | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|----------------------------------------------------------------------------------------| +| 403
Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not
Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +### 5.2.4 Notifications + +#### 5.2.4.0 General + +Notifications can be exchanged via two alternative methods. In the first method, the Content Provider can "pull" the notifications from the BM-SC using HTTP GET method if and when the Content Provider wishes to acquire notification information as described in this clause. The second method is that the notifications can be "pushed" from the BM-SC to the Content Provider via the push-notification-url as documented in clause 8. + +Table 5.2.4-1 summarizes different notification resources that the BM-SC manages for sending notifications to the Content Provider. + +**Table 5.2.4-1: Resources for managing services at BM-SC** + +| Resource Name | Resource Type | Description | +|---------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Notification | Instance resource | Represents a single notification resource. The BM-SC can send an individual notification to the Content Provider using the notification instance resource | +| Notifications | Collection Resource | Represents a collection of notification resources. | + +#### 5.2.4.1 Properties + +##### 5.2.4.1.0. General + +Each notification resource described in Table 5.2.4-1 has the set of properties described in Table 5.2.4.1-1. The BM-SC shall deliver the notifications as indicated by this structure using the API operations described in clause 5.2.4.2. + +Table 5.2.4.1-1 summarizes different properties of a notification resource. + +**Table 5.2.4.1-1: Resources for managing services at BM-SC** + +| Property Token | JSON Value Type | Parameter Description | +|---------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notification-res-id | string | Notification resource identifier | +| message-class | string |

Enumeration with the following values (may be expanded in the future): Critical, Warning, Information, Service, Session. The message classes bear the following meaning:

Critical: When some event drastically prevent the proper delivery of content

Warning: When the service can be partially delivered but quality is reduced

Information: When the service is properly delivered but some interesting event occurred

Session/Service: Information about Service/Session related parameters

Table 5.2.4.1-2 shows the information that can be notified for each of the message classes.

| + +| | | | +|---------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| message-name | string |

Unique identifier of the message. Provides information about the message pertaining to the message-class of the notification

Table 5.2.4.1-2 shows the information that can be notified for each of the message classes and message names.

| +| Message-information | object |

A dictionary of key values containing informations linked to the notification.

Every message-information dictionary shall include the following two keys:

date: The value of this key contains the UTC timestamp (in ms) of the date of the event

source: The value of this key is hierarchical colon separated format of services and sessions with the format "service-resource-identifier session-resource-identifier". If the notification is for a service, only the service-resource-identifier shall be included in this value. An empty value for this key shall represent a system wide notification.

Table 5.2.4.1-x shows the additional key value pairs that can be included in the message-information for each of the message-class and message-name.

| + +Table 5.2.4.1-2 shows the notification details that can be sent for each of the message classes. + +**Table 5.2.4.1-2: Notification Details for different message classes** + +| Message Class | Possible Message Name | Additional Key Value Pairs in message-information dictionary | +|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Critical | network-is-down | None | +| | service-badly-configured | bad-or-missing-parameters: [ , .. ] | +| | session-badly-configured | bad-or-missing-parameters: [ , .. ] | +| Warning | incoming-bitrate-exceed-session-capacity | incoming-bit-rate: | +| | no-incoming-data | None | +| Information | qoe-report-available | None | +| | consumption-reports-available | None | +| | reception-reports-available | None | +| Service | service-announcement-change | None | +| Session | session-state-change | from-state:
to-state:
where the from state and to state have one of the values in the enumeration:
Session Idle
Session Announced
Session Active
Session Terminated | +| | file-ready-for-transmission | file-url:
file-size:
transmission-size: | +| | file-download-started | file-url: | +| | file-successfully-sent | file-url: | +| | file-fetch-error | file-url:
http-error-code: | +| Note 1: | For the message-class "Service", the message-name service-announcement-change applies only when the session-state is in Session Announced or Session Active states. | | +| Note 2: | For the message-class "Session", the message-name file-ready-for-transmission applies only when the session-type is "Files". | | +| Note 3: | For the message-class "Session", the message-name file-download-started applies only when the session-type is "Files". | | +| Note 4: | For the message-class "Session", the message-name file-successfully-sent applies only when the session-type is "Files". | | + +The notification instance resource with the properties defined in Table 5.2.4.1-1 can be found in Annex B.5.2.4.2 API Operations + +##### 5.2.4.2.1 Introduction + +The Content Provider can request individual service and session level notifications and system-wide notifications from the BM-SC. The notifications are configured by the Content Provider when it creates services and sessions at the BM-SC. Notifications can be retrieved by the Content Provider from the BM-SC at times of its choice and shall use techniques such as long polling to poll the BM-SC for available notifications. Notifications can be retrieved from the BM-SC using HTTP methods on the notifications collection resource. + +##### 5.2.4.2.2 Notification Retrieval + +###### Retrieval of All Notifications + +###### GET /xmb/v1.0/notifications + +The retrieval of all the notifications shall be performed by the Content Provider using the HTTP GET method on the "notifications" collection resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/notifications +- the Host field is set to the address of the BM-SC + +Upon receipt of a HTTP GET request from the Content Provider to retrieve all the notifications, the BM-SC will check whether the Content Provider is authenticated and authorized to request notifications as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.4.2.2-1. If the authorization is successful, the BM-SC shall respond to the Content Provider with a 200 success message along with the list of all notifications. If there are no available notifications at the BM-SC, the BM-SC shall send a 200 OK message with message content indicating that there are no available notifications. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the list of notifications available at the BM-SC. Each notification in this list shall be based on the JSON schema of notification resource as described in clause 5.2.4.1. + +Alternatively, if the notification retrieval request cannot be fulfilled, the BM-SC shall send a 403 message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.4.2.2-1. + +**Table 5.2.4.2.2-1: Response status code, message, and contents for retrieval of all notifications of service** + +| Status Code | Message | Contents | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send all the notifications. If there are no notifications available at the BM-SC, the BM-SC shall include message content indicating that there are no notifications at the BM-SC. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7235 [8] and IETF RFC 7231 [6]. | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not fulfilled. | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | + +Individual notifications can be accessed using HTTP GET method by referencing the "notification-res-id". + +# 6 User Plane Procedures + +## 6.1 Introduction + +The xMB-U user plane procedures cover the transmission of service data between the Content Provider to the BM-SC. Only authorized and authenticated Content Provider sources shall be able to provide user plane data over xMB-U to the BM-SC. The following data transfer modes are supported: + +- File Push: the Content Provider uploads or transmits files to the BM-SC either as soon as they become available, or in advance. +- File Pull: the Content Provider makes files available prior to the session start and at least during the lifetime of a session. The BM-SC will retrieve the files when it needs to deliver them. +- RTP Streaming: the BM-SC establishes an RTSP session to the Content Provider and starts the streaming session to relay media streams. +- Transport: the BM-SC listens on one IP address and one port number to receive UDP packets. + +The details of these procedures are provided in the following clauses. + +## 6.2 File Session + +### 6.2.1 General + +Provisioning files for file distribution shall use one of the two options in the following clauses. + +### 6.2.2 Push Mode + +WebDAV as described in IETF RFC 4918 [9] or HTTP v1.1 shall be used over TLS. The Content Provider shall use the PUT method and place the file in the message body of the request associated with the push-url. The Content Provider shall ensure that each file is available at the BM-SC latest at its provided "file-earliest-fetch-time", or if that parameter is not provided, prior to the session start. Potential response codes and their interpretation is provided in Table 6.2.2-1. + +**Table 6.2.2-1: Response status code, message, and contents of File Push mode** + +| Status Code | Message | Contents | +|------------------|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| 201 Created | File pushed successfully | None | +| 401 Unauthorized | Request requires user authorization | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The Content Provider may include optional text to indicate why the request could not be fulfilled, e.g. incorrect URL used | + +### 6.2.3 Pull Mode + +HTTP v1.1 shall be used over TLS in Pull mode. The BM-SC shall use GET method to request each file as defined by the file-list or alternatively by the manifest received from the file-delivery-manifest-url. The BM-SC shall pull each file earliest at its provided "file-earliest-fetch-time", or if that parameter is not provided, prior to the session start. Upon a successful GET, the Content Provider shall provide the requested file in the response body. Potential response codes and their interpretation is provided in Table 6.2.3-1. + +**Table 6.2.3-1: Response status code, message, and contents of File Pull mode** + +| Status Code | Message | Contents | +|-------------|--------------------------------------|--------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The Content Provider shall send the requested file in the response body. | +| 401 | Request requires user authentication | In accordance to conditions as described in | + +| | | | +|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| +| Unauthorized | | IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The Content Provider may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: | If "file-delivery-manifest-url" is used, and if there is any error code in response to the request to get the manifest from the provided URL, the session is not started. | | + +## 6.3 Application Session + +### 6.3.1 General + +Application mode, including DASH service delivery shall use one of the two options in the following clauses. + +### 6.3.2 Push Mode + +WebDAV as described in IETF RFC 4918 [9] or HTTP v1.1 shall be used over TLS. The Content Provider shall use PUT method with the resource (Application Session) or the Media Segment (DASH) in the message body, to place it at the push-url. The Content Provider shall ensure that each Segment is available at the BM-SC prior to its prescribed Segment availability start time in the MPD, or if that parameter is not provided, prior to the session start. Potential response codes and their interpretation is provided in Table 6.2.2-1. + +**Table 6.3.2-1: Response status code, message, and contents of Application (including DASH) Push mode** + +| Status Code | Message | Contents | +|------------------|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| 201 Created | File pushed successfully | None | +| 401 Unauthorized | Request requires user authorization | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The Content Provider may include optional text to indicate why the request could not be fulfilled, e.g. incorrect URL was used | + +### 6.3.3 Pull Mode + +HTTP v1.1 shall be used over TLS in Pull mode. For DASH service, the BM-SC shall use the application-entry-point-url to retrieve the MPD. The BM-SC shall use GET method to request the resource, or for DASH, each Media Segment as defined by the MPD. Upon a successful GET, the Content Provider shall provide the requested resource or DASH Segment, respectively, in the response body. Potential response codes and their interpretation is provided in Table 6.2.3-1. + +**Table 6.3.3-1: Response status code, message, and contents of Application (including DASH) Pull mode** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|---------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The Content Provider shall send the requested resource or DASH Segment in the response body. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The Content Provider may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | + +The BM-SC shall ensure that each DASH Media Segment is fully received prior to its prescribed availability start time, or if not provided, prior to the session start. + +Note: If "application-entry-point-url" is used, and if there is any error code in response to the request to get the MPD from the provided URL, the session shall not be started. + +## 6.4 RTP Streaming + +The Content Provider shall support PSS server functionality according to PSS as described in clause 5.3 of 3GPP TS 26.234 [5]. The streaming session shall be accessible prior to the start of the session. A URL to the SDP file that describes the streaming session between the Content Provider and the BM-SC is provided via the sdp-url, which shall be used for ingesting the streaming session. The SDP shall include the RTSP links for every media session as part of the "a=control" attribute to enable RTSP control of the session. The SDP shall also contain the required bitrate for each of the media sessions. + +When the user plane data is provided via UDP, then SRTP over DTLS as described in 3GPP TS 33.246 [24] shall be used for user plane protection. Establishment of TCP based user plane sessions with PSS is not supported. + +If there is any error retrieving the SDP, the session shall not be started. + +## 6.5 Transport + +For Transport sessions, the BM-SC shall activate the receivers on the indicated IP address and port numbers and shall ensure that firewall and NAT traversal is enabled on these IP addresses and port numbers as defined in the SDP retrieved from the sdp-url. If there is any error retrieving the SDP, the session shall not be started. All traffic shall use DTLS as specified in 3GPP TS 33.246 [24] where both client and server certificates are verified. + +# --- 7 Security + +## 7.1 Overview + +All xMB-C and xMB-U traffic shall only be sent over secured transport channels that are established after successful authentication and authorization as described in clauses 4.4.2, 4.4.3 and 7.2. + +## 7.2 Authentication & Authorization + +(D)TLS as defined in 3GPP TS 33.246 [24] shall be used to authenticate both ends of the connection. + +The BM-SC shall support at least one of the two following modes for authorization of the Content Provider: *domain-based* or *user-based*, as defined in 3GPP TS 26.348 [33]. Authorization shall be performed after the successful completion of (D)TLS authentication. Domain-based authorization, as defined in Annex O.2 of 3GPP TS 33.246 [24], corresponds to the granting of access rights for service and/or session resource management at a coarse-grained level of the Content Provider, as identified by its administrative domain name in the subject field of the Content Provider certificate. User-based authorization, as defined in Annex O.2 of 3GPP TS 33.246 [24], corresponds to the granting of access rights for service/session resource management at a finer-grain level of an individual representative of the Content Provider. User-based authorization, if performed, shall occur after successful domain based authorization, and is based on HTTP Digest authentication of username and password as specified in IETF RFC 7616 [43]. Detailed specification of the authorization procedure and affiliated mechanisms (for example, pre-establishment of agreement between the Content Provider and mobile operator on domain- and user-based access rights, management of username and password credentials, etc.) are outside the scope of this specification, in order to allow flexibility of implementations which conform to the mechanism described herein. + +Authorization of the BM-SC by the Content Provider shall be based on the same mechanisms as described above for BM-SC authorization of the Content Provider. + +## 7.3 Void + +# 8 Notification Push to the Content Provider + +## 8.1 Introduction + +The Content Provider configures the BM-SC with a push-notification-url and push-notification-configuration property as documented in clause 5.2.1.1, where the BM-SC can post the notifications to the Content Provider. + +## 8.2 Notification Post + +To send a notification to the Content Provider, the BM-SC shall use HTTP POST as follows: + +- the request URI with the "path" part is set to: {push-notification-url} HTTP/1.1 +- the Host field is set to the address of the Content Provider +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {push-notification-url} in the URI above is the push notification URL configured by the Content Provider when the Content Provider configures the service using procedures described in clause 5.2.1.2. The URL shall be an HTTPS URL. + +The content body of the above POST request shall contain the notification that the BM-SC intends to send to the Content Provider. The representation of the notification is based on the JSON schema of notification resource as described in clause 5.2.4.1. + +Upon receipt of HTTP POST from the BM-SC to notify the Content Provider about a notification, the Content Provider shall check whether the BM-SC is authenticated and authorized to send notifications to the Content Provider. If the authorization fails, the Content Provider shall send a 401 message to the BM-SC. If the authorization is successful, the Content Provider shall accept the notification request and respond to the BM-SC with a 200 OK message indicating that it has received the notification from the BM-SC. If the request cannot be fulfilled, the Content Provider shall send a 403 Forbidden message to the BM-SC. + +The possible response messages from the Content Provider, depending on whether the notification request is accepted or not, are shown in Table 8.2-1. + +**Table 8.2-1: Response status code, message, and contents for notification request using HTTP POST** + +| Status Code | Message | Contents | +|------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | None | +| 401
Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403
Forbidden | Request cannot be fulfilled | The Content Provider may include optional text to indicate why the request could not fulfilled | +| Note: In addition to the above response codes, the Content Provider can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +# 9 Feature negotiation + +## 9.1 General + +The xMB API needs to provide a mechanism to advertise required and optional features supported by both the Content Provider and BM-SC for interoperability reasons as the functionality of the xMB interface is augmented. + +Feature negotiation shall take place during service creation procedure and applies for a given instance of service and its related session(s), and any optionally associated reports and/or notifications associated with that service until the service is terminated. The Content Provider shall include in the HTTP POST the set of supported features as follows: + +- if a feature is required for the proper operation of the service, its associated session management, and reporting and/or notification functionality, if applicable, it shall be included within the 3gpp-Required-Features header; +- if a feature is optional for the proper operation of the service, its associated session management, and reporting and/or notification functionality, if applicable, it shall be included within the 3gpp-Optional-Features header. + +The BM-SC shall include, within the 3gpp-Accepted-Features header in the response to the HTTP POST, the set of features it supports in common with the Content Provider. + +If the BM-SC does not support any of the required features advertised by the Content-Provider within the 3gpp-Required-Features header, the BM-SC shall reject the HTTP POST with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the Content Provider within the 3gpp-Accepted-Features. + +If the BM-SC requires certain features to be supported that are not advertised by the Content Provider, the BM-SC shall reject the HTTP POST with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the Content Provider within the 3gpp-Accepted-Features and the required features in the 3gpp-required-features. + +If the BM-SC and Content Provider successfully negotiate supported features, the list of commonly supported features shall be applicable for the created service, related session(s) and any optionally associated reports and/or notifications, until it is deleted. Features that are not advertised as supported shall not be used for that service. + +The sender may send information that is related to the supported features. Any unrecognized/supported information shall be ignored by the receiver. + +The table below defines the features applicable to the xMB interface. + +**Table 9.1-1: Features used in xMB Interface** + +| Feature | M/O | Description | +|----------------------|--------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| LocalMBMS | O | The feature indicates the support of Local MBMS data delivery. | +| FilePush | O | The feature indicates the support of File Session Push Mode user plane procedures as specified in clause 6.2.2 | +| FilePull | O | The feature indicates the support of File Session Pull Mode user plane procedures as specified in clause 6.2.3 | +| ApplicationPush | O | The feature indicates the support of Application Push Mode user plane procedures as specified in clause 6.3.2 | +| ApplicationPull | O | The feature indicates the support of Application Pull Mode user plane procedures as specified in clause 6.3.3 | +| RTPStreaming | O | The feature indicates the support of RTPStreaming user plane procedures as specified in clause 6.4 | +| Transport | O | The feature indicates the support of Transport user plane procedures as specified in clause 6.5 | +| FEC | O | This feature indicates the support of applying FEC (see IETF RFC 6363 [29]) to downlink packet streams at the BM-SC. | +| ROHC | O | This feature indicates the support of applying ROHC (see IETF RFC 5795 [27] and IETF RFC 3095 [28]) to downlink packet streams at the BM-SC. | +| GroupContentDelivery | O | This feature indicates the support of delivering contents to a group of UEs. | +| MCExtension | O | This feature indicates the support of the xMB mission critical extension as specified in clause 4.3.2 and clause 5.2.2.1. | +| ResourceSharing | O | This feature indicates the support of sharing transmission resource for different MBMS services. | +| SaProfile | O | This feature indicates the support of BM-SC supplied Service Announcement profile. | +| FileRepair | O | This feature indicates the support of content provider supplied file repair function. | +| Feature: | A short name for the feature to which the M/O and description pertain. | | +| M/O: | Indication on whether the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release. | | +| Description: | Textual description of the feature. | | + +NOTE: The base functionality for the xMB interface is defined in the Release-14 version of this specification and a feature is an extension of that functionality. The negotiation of supported features allows interworking between the endpoints of the xMB interface whereby each entity may support all, some, or none of the features that the xMB application can support defined in this specification. Features are defined so that they are independent of each other. Any introduced feature is explicitly defined in this specification. + +## 9.2 HTTP custom headers + +### 9.2.0 General + +This clause defines any new HTTP custom headers introduced by this specification. + +### 9.2.1 3gpp-Optional-Features + +This header is used by the Content Provider to advertise the optional features that are supported by the Content Provider. + +The encoding of the header follows the ABNF as defined in IETF RFC 7231 [6]. + +3gpp-Optional-Features = "3gpp-Optional-Features" ":" 1#token + +n example is: 3gpp-Optional-Features: feature1, feature2 + +### 9.2.2 3gpp-Required-Features + +This header is used by the Content Provider to announce the mandatory features that must be supported in BM-SC. + +This header is also used by the BM-SC to indicate the missing features that must be supported in Content Provider. + +The encoding of the header follows the ABNF as defined in IETF RFC 7231 [6]. + +3gpp-Required-Features = "3gpp-Required-Features" ":" 1#token + +An example is: 3gpp-Required-Features: feature1, feature2 + +### 9.2.3 3gpp-Accepted-Features + +The header is used by the BM-SC to confirm the commonly supported set of features with the Content Provider. + +The encoding of the header follows the ABNF as defined in IETF RFC 7231 [6]. + +3gpp-Accepted-Features = "3gpp-Accepted-Features" ":" 1#token + +An example is: 3gpp-Accepted-Features: feature1, feature2 + +# --- 10 Using Common API Framework + +## 10.1 General + +When CAPIF is used with BM-SC, BM-SC shall support the following as defined in 3GPP TS 29.222 [40]: + +- the API exposing function and related APIs over CAPIF-2/2e and CAPIF-3/3e reference points; +- the API publishing function and related APIs over CAPIF-4/4e reference point; +- the API management function and related APIs over CAPIF-5/5e reference point; and +- at least one of the the security methods for authentication and authorization, and related security mechanisms. + +In a centralized deployment as defined in 3GPP TS 23.222 [39], where the CAPIF core function and API provider domain functions are co-located, the interactions between the CAPIF core function and API provider domain functions may be independent of CAPIF-3/3e, CAPIF-4/4e and CAPIF-5/5e reference points. + +## 10.2 Security + +When CAPIF is used for external exposure, before invoking the API exposed by the BM-SC, the Content Provider as API invoker shall negotiate the security method (PKI, TLS-PSK or OAuth 2.0) with CAPIF core function and ensure the BM-SC has enough credential to authenticate the Content Provider (see 3GPP TS 29.222 [40], clause 5.6.2.2 and clause 6.2.2.2). + +If PKI or TLS-PSK is used as the selected security method between the Content Provider and the BM-SC, upon API invocation, the BM-SC shall retrieve the authorization information from the CAPIF core function as described in 3GPP TS 29.222 [40], clause 5.6.2.4. + +As indicated in 3GPP TS 33.122 [41], the access to the xMB API may be authorized by means of the OAuth 2.0 protocol (see IETF RFC 6749 [42]), using the "Client Credentials" authorization grant, where the CAPIF core function (see 3GPP TS 29.222 [40]) plays the role of the authorization server. + +NOTE 1: In this release, only "Client Credentials" authorization grant is supported. + +If OAuth 2.0 is used as the selected security method between the Content Provider and the BM-SC, the Content Provider, prior to consuming services offered by the xMB API, shall obtain a "access token" from the authorization server, by invoking the Obtain\_Authorization service, as described in 3GPP TS 29.222 [40], clause 5.6.2.3.2. + +The xMB API do not define any scopes for OAuth 2.0 authorization. It is the BM-SC responsibility to check whether the Content Provider is authorized to use an API based on the "token". Once the BM-SC verifies the "token", it shall check whether the BM-SC identifier in the "token" matches its own published identifier, and whether the API name in + +the "token" matches its own published API name. If those checks are passed, the Content Provider has full authority to access any resource or operation for the invoked API. + +NOTE 2: For aforementioned security methods, the BM-SC needs to apply admission control according to access control policies after performing the authorization checks. + +# --- Annex A (informative): Call Flows + +## A.1 Introduction + +The xMB-C procedures are used to create and control MBMS User Services from external sources. An MBMS User Service spans from the BM-SC to the UE and can contain one or more MBMS delivery methods. The provisioning procedure offer functions to create one or more delivery sessions (such as a MBMS Download Delivery session) and allows association of the delivery sessions to MBMS Bearer Services. As part of the xMB-C procedures for MBMS User Services, content ingestion for the user-plane data (i.e. xMB-U) are negotiated. As a result of the xMB-C procedures, the BM-SC can start service announcement and activates MBMS bearer services. + +The Content Provider can query its entitlements, for instance the list of broadcast areas it is authorized to use. + +The Content Provider can query the status of delivery sessions. + +The Content Provider can request reception statistics. + +## --- A.2 xMB Procedure example for Live DASH services (MBMS Broadcast only) + +This procedure example describes the xMB procedures for the delivery of a DASH Live service (see clause 11 of 3GPP TS 26.247 [18] for the specification of DASH Live services), to a single broadcast area. A push interface like WebDAV is used here as the ingestion method for the user-plane data (xMB-U). The push interface is identified by a unique URI. The source of the user plane data (CP Source) are the DASH Media Segments as produced by a Live Encoder / Segmenter and the source pushes each new Segment when it becomes available. The Media Presentation Description (MPD) URL and Initialization Segment (IS) for the Live DASH session is provided to BM-SC during Session creation or in a subsequent update request to the BM-SC. + +![Sequence diagram showing the interaction between UE, MBMS-GW, BM-SC, CP Control, and CP Source for provisioning a live DASH session.](9e8ebf03cae78f4f81b697548c2d7250_img.jpg) + +``` + +sequenceDiagram + participant UE + participant MBMS-GW + participant BM-SC + participant CP Control + participant CP Source + + Note over all: 1: Operator and Content Provider agree Service Level Agreement + Note over BM-SC: 2: BM-SC admin applies agreed ranges to BM-SC + Note over all: Provisioning a Live DASH Session + BM-SC->>CP Control: 3: Authentication and Authorization + Note over BM-SC, CP Control: Creating a Service + BM-SC->>CP Control: 4: HTTP POST + CP Control-->>BM-SC: 5: HTTP 201 CREATED + BM-SC->>CP Control: 6: HTTP GET + CP Control-->>BM-SC: HTTP 200 OK + BM-SC->>CP Control: 7: HTTP PUT/PATCH + CP Control-->>BM-SC: HTTP 200 OK + Note over BM-SC, CP Control: Creating a Session + BM-SC->>CP Control: 8: HTTP POST + CP Control-->>BM-SC: 9: HTTP 201 CREATED + BM-SC->>CP Control: 10: HTTP GET + CP Control-->>BM-SC: HTTP 200 OK + BM-SC->>CP Control: 11: HTTP PUT/PATCH + CP Control-->>BM-SC: HTTP 200 OK + BM-SC->>UE: 12: Do service announcement + Note right of MBMS-GW: (when all data present) + Note over all: MBMS Bearer is activated + BM-SC->>MBMS-GW: 13: MBMS Session Start + MBMS-GW-->>BM-SC: Ok + BM-SC->>CP Control: 14: Notification + BM-SC->>UE: 15: User Plane Data (DASH Segments) + Note over all: MBMS Bearer is deactivated + BM-SC->>MBMS-GW: 16: MBMS Session Stop + MBMS-GW-->>BM-SC: Ok + BM-SC->>CP Control: 17: Notification + +``` + +The sequence diagram illustrates the interaction for provisioning a live DASH session. It begins with an agreement between the Operator and Content Provider (Step 1), followed by the BM-SC admin applying agreed ranges (Step 2). The main process involves authentication, service creation (Steps 4-7), and session creation (Steps 8-11) between the BM-SC and CP Control. A service announcement is sent to the UE (Step 12). Upon MBMS bearer activation, an MBMS Session Start is sent to the MBMS-GW (Step 13), which responds with 'Ok'. A notification is sent to the CP Control (Step 14), and user plane data (DASH segments) are sent to the UE (Step 15). Upon MBMS bearer deactivation, an MBMS Session Stop is sent to the MBMS-GW (Step 16), which responds with 'Ok'. Finally, a notification is sent to the CP Control (Step 17). + +Sequence diagram showing the interaction between UE, MBMS-GW, BM-SC, CP Control, and CP Source for provisioning a live DASH session. + + v5.4 + +###### **Figure A.2-1: xMB-C and xMB-U Procedures for a Live DASH Service** + +- 1: The operator and the Content Provider agree on a Service Level Agreement (SLA), which entitles the Content Provider to use the MBMS system (in accordance to some rules) for content delivery. For instance, the SLA can include day/time ranges, during which the Content Provider can distribute its content. The SLA can also include geographical areas in which the Content Provider is allowed to distribute its content. The SLA also includes target bitrates and likely definitions of tolerable losses per service. +- 2: The BM-SC administrators (operator) apply the agreed ranges. This can imply the provisioning of additional Service Areas, and other system related configurations. + +The following steps describe Content Provider provisioning of a single Live DASH session in a single broadcast area. + +- 3: The Content Provider authenticates itself as authorized user. The Content Provider can only see those configurations, sessions and services which belong to the Content Provider. +- 4: The Content Provider creates a new Service. Optionally, the Content Provider may provide properties for the service like service class, service languages, service names, notification configuration as well as consumption reporting configuration. The Content Provider can select whether the Content Provider or the operator distributes service announcement by providing a list of Service Announcement Channel (SACH, as defined in Annex L.2 / L.3 of 3GPP TS 26.346 [3]) services used for operator-driven service announcement. + +NOTE 1: BM-SC derives the required UE capabilities from the provided service and session properties. + +- 5: Upon successful service creation by the BM-SC, the BM-SC will provide a unique id for the service resource which is expected to be used by the Content Provider for subsequent requests. +- 6: The Content Provider retrieves the current service properties. The unique resource id of the service are provided by the Content Provider as input to the BM-SC. The BM-SC responds with the service properties. +- 7: The Content Provider updates service properties. The unique resource id of the service and some or all service properties are provided by the Content Provider as input to the BM-SC +- 8: The Content Provider creates a session for the previously created service. The unique resource id of the service are provided by the Content Provider as input to the BM-SC. Optionally, the Content Provider may provide common session properties such as maximum ingestion bitrate (excluding any FEC redundancy and transport overhead), scheduling information (start time, stop time), QoE Reporting configuration and session type (set to Application) as input. DASH specific session properties provided as input by the Content Provider include MIME-type of MPD fragment (here, set to application/dash+xml), Application Entry Point URL (here, the MPD URL), xMB-U ingest mode (push/pull), Unicast Delivery Indicator, etc. + +NOTE 2: BM-SC allocates the following parameters for the session description of the MBMS User Service: TMGI, FLUTE IP Multicast Address, UDP Port and TSI (see IETF RFC 3926 [19]). + +NOTE 3: BM-SC derives the SAI list for the MBMS Service Area from Geographical Area provided in Content Provider request and from PLMN id negotiated in step 1. FEC information (codec and ratio) and MBMS Bearer QoS (ARP, QCI) are also negotiated in step 1. + +NOTE 4: The Service Announcement start time can be provided in the request. If not, BM-SC is expected to start announcing the service as soon as all required service and session properties are provided by the Content Provider. + +NOTE 5: In the case of regionalized services, i.e. ones whose contents are region-specific, a session can be cloned so that all sessions of the user service share the same FLUTE parameters. + +- 9: A unique resource id of the session, which identifies the created session, is returned by the BM-SC to the Content Provider. Additionally, the push URL (whereby the required xMB-U ingest mode is set to push) and QoE Report URL are added to the response. +- 10: The Content Provider queries the session configuration by providing the resource ids of the session and service. The Content Provider needs the Push URL to configure the DASH segmenter. The BM-SC provides the information in the response, which includes all readable session properties. +- 11: The Content Provider updates the session by providing the DASH MPD URL (Application Entry Point URL). The BM-SC sends a response with update status. + +- 12: Once all information for service announcement is available, and if service announcement start time has elapsed, the BM-SC starts announcing the service automatically. Service announcement is automatically updated following subsequent session updates. + +The following steps pertain to the BM-SC activating automatically the MBMS Bearer at session start time. See 3GPP TS 26.346 [3] and 3GPP TS 29.061 [20] for further details. + +- 13: The BM-SC activates the MBMS bearer by providing the TMGI, the Flow ID, the MBMS Service Area (MSA), the GBR and other parameters to the MBMS-GW. +- 14: When the Content Provider has configured a Notification URL for the service, the BM-SC delivers service/session related notification messages to the Content Provider. +- 15: When the MBMS bearer is activated, the BM-SC will start forwarding the xMB-U user plane data (push interface here). Any xMB-U user plane data received before activation of the MBMS bearer can be discarded. +- 16: At session stop time, the MBMS bearer is terminated. +- 17: The BM-SC can notify the Content Provider about the termination of the MBMS Bearer. + +NOTE 6: The Content Provider terminates the service, when the service is not needed anymore. All sessions, which have been created or are active will be deleted automatically by BM-SC with the termination of the service. + +## --- A.3 xMB Procedure example for Live DASH services (with Service Continuity) + +This procedure example describes the xMB-C procedures for a Live DASH service with service continuity. See 3GPP TS 26.247 [18] for the specification of DASH services. Service continuity allows UEs to enter or leave the MBMS service areas while receiving a Live DASH service. UEs can switch to unicast as defined in clause 7.6 of 3GPP TS 26.346 [3] when leaving the MBMS service area. + +In case of service continuity support, the system offers representations via unicast and via MBMS Bearers. A unified MPD (cf. clause 7.6 of 3GPP TS 26.346 [3]) contains the corresponding retrieval information. When service continuity is supported, the Content Provider provides MPD and Initialization Segments for both unicast and MBMS bearer access and also the associated Media Segments. The Content Handler functions forwards the content to a DASH (unicast) Server. The DASH (unicast) server can use a Content Delivery Network (CDN) for unicast delivery. + +A push interface is used here as ingestion method for the xMB-U user-plane data. The source of the user plane data (Content Provider Source) are the DASH Media Segments as produced by a Live Encoder / Segmenter, which produces the content for unicast and MBMS bearer delivery. The Media Presentation Description and Initialization Segment for the Live DASH session are provided separately to the BM-SC. + +The Service Announcement Function (SAF) of the BM-SC creates the needed metadata fragments for the MBMS User Service. To support service continuity, the SAF adds base pattern elements to the *userServiceDescription* element. The MBMS Client in the UE matches the base pattern against a portion of the entire request URL. The SAF creates unified MPD by adding information specific elements to it. The SAF makes the service announcement information available via unicast and via MBMS. + +A content handler function of the BM-SC handles the separation of unicast and MBMS bearer content. The content handler function makes the content available in operators CDN for unicast access. + +## --- A.4 xMB Procedure example for File Delivery Services (without File Schedule) + +This procedure example describes the provisioning procedure for the delivery of a File Delivery service, to a single broadcast area, without the presence of the *fileSchedule* element in the Schedule Description fragment of MBMS User Service Announcement information. The *fileSchedule* element contains transmission timing information for each file by its file URL. Consequently, the file URLs must be present when creating service announcement information. + +This example assumes that the BM-SC automatically fetches the file using a pull method (xMB-U mode) and prepares the transmission. File URLs can be provided in the session creation request or any subsequent session update request. When file preparation ends after the session start time, the file is automatically added to user plane flow. It is up to Content Provider to ensure that session scheduling is large enough to allow files preparation and transmission according to bitrate between BM-SC and file location, and bitrate of user plane. + +![Sequence diagram showing the interaction between UE, MBMS-GW, BM-SC, CP Control, and CP Source for a file delivery session. The diagram is divided into four main phases: 1. Operator and Content Provider agree Service Level Agreement; 2. BM-SC admin applies agreed ranges to BM-SC; 3. Provisioning a File Delivery Session (including Authentication, Service creation, and Session creation); 4. MBMS Bearer is activated (Session Start, User Plane Data, Notification); 5. MBMS Bearer is deactivated (Session Stop, Notification).](9b1ec0090070bdf52ea28763b8d52477_img.jpg) + +``` + +sequenceDiagram + participant UE + participant MBMS-GW + participant BM-SC + participant CP Control + participant CP Source + + Note over all: 1: Operator and Content Provider agree Service Level Agreement + Note over BM-SC: 2: BM-SC admin applies agreed ranges to BM-SC + + Note over all: Provisioning a File Delivery Session + Note over BM-SC, CP Control: Creating a Service + BM-SC->>CP Control: 3: Authentication and Authorization + Note over all: ----- + BM-SC->>CP Control: 4: HTTP POST + CP Control-->>BM-SC: 5: HTTP 201 CREATED + BM-SC->>CP Control: 6: HTTP GET + CP Control-->>BM-SC: HTTP 200 OK + BM-SC->>CP Control: 7: HTTP PUT/PATCH + CP Control-->>BM-SC: HTTP 200 OK + Note over all: ----- + Note over BM-SC, CP Control: Creating a Session + BM-SC->>CP Control: 8: HTTP POST + CP Control-->>BM-SC: 9: HTTP 201 CREATED + Note over all: ----- + BM-SC->>MBMS-GW: 10: Do service announcement (when all data present) + BM-SC->>CP Control: 11: HTTP GET + CP Control-->>BM-SC: 12: HTTP 200 OK + BM-SC->>CP Control: 13: HTTP PUT/PATCH + CP Control-->>BM-SC: 14: HTTP 200 OK + Note over all: ----- + + Note over all: MBMS Bearer is activated + BM-SC->>MBMS-GW: 15: MBMS Session Start + MBMS-GW-->>BM-SC: Ok + BM-SC->>CP Control: Notification (Session Id start) + BM-SC->>UE: 16: User Plane Data + BM-SC->>CP Control: Notification (File URL delivery) + Note over all: ----- + + Note over all: MBMS Bearer is deactivated + BM-SC->>MBMS-GW: 17: MBMS Session Stop + MBMS-GW-->>BM-SC: Ok + BM-SC->>CP Control: Notification (Session Id stop) + +``` + +Sequence diagram showing the interaction between UE, MBMS-GW, BM-SC, CP Control, and CP Source for a file delivery session. The diagram is divided into four main phases: 1. Operator and Content Provider agree Service Level Agreement; 2. BM-SC admin applies agreed ranges to BM-SC; 3. Provisioning a File Delivery Session (including Authentication, Service creation, and Session creation); 4. MBMS Bearer is activated (Session Start, User Plane Data, Notification); 5. MBMS Bearer is deactivated (Session Stop, Notification). + +###### **Figure A.4-1: xMB-C and xMB-U Procedures for a File Delivery Service** + +- 1: The operator and the Content Provider agree on a Service Level Agreement (SLA), which entitles the Content Provider to use the MBMS system (in accordance to some rules) for content delivery. For instance, the SLA can include day time ranges, during which the Content Provider can distribute its content. The SLA can also include geographical areas, in which the Content Provider is allowed to distribute content. The SLA also includes target bitrates and likely definitions of tolerable losses per service. +- 2: The BM-SC administrators (operator) apply the agreed ranges. This can imply to add additional Service Areas, the provisioning of and other system related configurations. + +The Content Provider provisioning a file delivery session in a single broadcast area. + +- 3: The Content Provider authenticates itself as authorized user. The Content Provider can only see those configurations, sessions and services, which belong to the Content Provider. +- 4: The Content Provider creates a new service. Optionally, the Content Provider may provide properties for the service like service class, service languages, service names, notification configuration as well as consumption reporting configuration. The Content Provider can select whether the Content Provider or the operator distributes service announcement by providing a list of Service Announcement Channel (SACH, as defined in Annex L.2 / L.3 of 3GPP TS 26.346 [3]) services used for operator-driven service announcement. + +NOTE 1: BM-SC derives the required UE capabilities from the provided service and session properties. + +- 5: Upon successful service creation by the BM-SC, the BM-SC shall provide a unique resource id of the service, that the Content Provider can use for subsequent requests. +- 6: The Content Provider retrieves the current service properties. The unique resource id of the service is provided by the Content Provider as input to the BM-SC. The BM-SC responds with the service properties. +- 7: The Content Provider updates service properties. The unique resource id of the service and some or all service properties are provided by the Content Provider as input to the BM-SC +- 8: The Content Provider creates a session for previously created service. The unique resource id of the service is provided by the Content Provider as input to the BM-SC. Optionally, the Content Provider may provide common session properties like max ingest bitrate (excluding any FEC redundancy and transport overhead), scheduling information (start time, stop time), Geographical Area and QoE Reporting configuration and session type (set to Files) as input. File specific session properties provided as input by Content Provider: xMB-U ingest mode (pull/push), file list if xMB-U pull mode. + +NOTE 2: BM-SC allocates following parameters for SDP of the MBMS User Service: TMGI, FLUTE IP Multicast Address, UDP Port and TSI (see 3GPP TS 26.346 [3]). + +NOTE 3: BM-SC derives the SAI list for the MBMS Service Area from Geographical Area provided in Content Provider request and from PLMN id negotiated in step 1. FEC information (codec and ratio) and MBMS Bearer QoS (ARP, QCI) are also negotiated in step 1. + +NOTE 4: In xMB-U pull ingest mode, file URLs can be provided now (i.e. at session resource creation) or at a later stage (e.g. while the session is active) through the Session Update xMB-C procedure. + +NOTE 5: Service Announcement start time can be provided in request. If not, BM-SC starts announcing service as soon as all required service and session properties are provided by Content Provider. + +NOTE 6: In the case of regional services, i.e. that deliver region specific content, a session can be cloned so that all Sessions of user service use same FLUTE parameters. + +- 9: A unique resource id of the session, which identifies the created Session, is responded. If xMB-U push ingest mode is used, BM-SC provides also the push URL the Content Provider shall use. + +NOTE 7: For file URLs provided in session creation request, the BM-SC starts automatically to fetch the file resource(s) from the content location when file earliest fetch time elapses and generates the FLUTE and FEC symbols (if any). The BM-SC can notify the Content Provider when the process is finalized. + +10: Once all information for service announcement is available, and if service announcement start time is elapsed, the BM-SC starts announcing the service automatically. Service announcement is automatically updated following subsequent Session updates. File schedule element can be present in Schedule fragment for files URLs provided in Session creation request. + +11: The Content Provider queries the Session configuration, providing the resource ids of the session and service. + +12: The BM-SC provides the information in response. + +13: The Content Provider updates session by providing additional File URLs. + +14: The BM-SC sends response with update status. + +NOTE 8: The BM-SC starts automatically to fetch the new file resource(s) from the content location when file earliest fetch time elapses and generates the FLUTE and FEC symbols (if any). The BM-SC can notify the Content Provider when the process is finalized. + +NOTE 9: Steps 9-12 can be executed at any time after Session is created and prior to the Session stop time. Any file URL added after Session start time will be automatically fetched, processed and sent on user plane. + +The BM-SC activates automatically the MBMS Bearer at session start time. + +15: The BM-SC activates the MBMS bearer by providing the TMGI, the Flow ID, the MBMS Service Area (MSA), the GBR and other parameters to the MBMS-GW. The BM-SC can notify the Content Provider about the activation of the MBMS Bearer. + +16: When the MBMS Broadcast bearer is activated, then the BM-SC starts sending the user plane data, according to target reception completion time. The BM-SC can notify Content Provider of file delivery start/end. + +17: At session stop time, the MBMS bearer is terminated. The BM-SC can notify the Content Provider about the termination of the MBMS Bearer. + +NOTE 10: The Content Provider terminates the service. All sessions, which are still created or active will be deleted automatically by BM-SC with the termination of the service. + +# Annex B (normative): JSON Schema + +``` +{ + "swagger": "2.0", + "info": { + "title": "BM-SC API", + "description": "BM-SC Content Provider ingestion API", + "version": "1.0.2" + }, + "host": "", + "schemes": [ + "https" + ], + "basePath": "/xmb/v1.0", + "produces": [ + "application/json" + ], + "paths": { + "/services": { + "get": { + "description": "Return all supported services", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "A list of services.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Service" + } + } + } + } + } + } + } +} +``` + +``` + } + } +}, +"default":{ + "description":"Unexpected error", + "schema":{ + "$ref":"#/definitions/Error" + } +} +} +}, +"post":{ + "description":"Creates a service", + "produces":[ + "application/json" + ], + "responses":{ + "201":{ + "description":"Service successfully created..", + "schema":{ + "$ref":"#/definitions/services-response" + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + } + } +} +}, +"/services/{service-id}":{ + "get":{ + "description":"Returns resource for a given service-id", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"OK.", + "schema":{ + "$ref":"#/definitions/Service" + } + } + } + } +}, +"patch":{ + "description":"Update a service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"body", + "in":"body", + "required":true, + "description":"Service that needs to be created", + "schema":{ + "$ref":"#/definitions/Service" + } + }, + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + } + ] +} +``` + +``` + "format":"int32" + } +}, +"responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/Service" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } +} +}, +"put":{ + "description":"Updates a service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"body", + "in":"body", + "required":true, + "description":"Service that needs to be created", + "schema":{ + "$ref":"#/definitions/Service" + } + }, + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/Service" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } + } +}, +"delete":{ + "description":"Delete a service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", +``` + +``` + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } +], +"responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/services-response" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } +} +} +}, +"/services/{service-id}/sessions":{ + "get":{ + "description":"Return all sessions of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"A list of sessions.", + "schema":{ + "type":"array", + "items":{ + "$ref":"#/definitions/Session" + } + } + }, + "default":{ + "description":"Unexpected error", + "schema":{ + "$ref":"#/definitions/Error" + } + } + } + }, + "post":{ + "description":"Create a session for a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ +``` + +``` + "201":{ + "description":"Session successfully created..", + "schema":{ + "$ref":"#/definitions/session-response" + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + } + } +} +}, +"/services/{service-id}/sessions/{session-id}":{ + "get":{ + "description":"Return a session of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"OK.", + "schema":{ + "$ref":"#/definitions/Session" + } + } + } + }, + "patch":{ + "description":"Updates a session of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"body", + "in":"body", + "required":true, + "description":"Session that needs to be created", + "schema":{ + "$ref":"#/definitions/Session" + } + }, + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, + "type":"integer", + "format":"int32" + } + ] + } +} +``` + +``` + } +], +"responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/Session" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } +} +}, +"put":{ + "description":"Update a session of a given service", + "produces":{ + "application/json" + }, + "parameters":{ + { + "name":"body", + "in":"body", + "required":true, + "description":"Session that needs to be created", + "schema":{ + "$ref":"#/definitions/Session" + } + }, + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, + "type":"integer", + "format":"int32" + } + }, + "responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/Session" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } + } +}, +"delete":{ + "description":"Delete a session of a given service", +} +``` + +``` +"produces":[ + "application/json" +], +"parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, + "type":"integer", + "format":"int32" + } +], +"responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/session-response" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } +} +}, +"/services/{service-id}/reports":{ + "get":{ + "description":"Returns all reports of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"A list of reports.", + "schema":{ + "type":"array", + "items":{ + "$ref":"#/definitions/Report" + } + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } + }, + }, +} +``` + +``` + "default":{ + "description":"Unexpected error", + "schema":{ + "$ref":"#/definitions/Error" + } + } + } + } + }, + "/services/{service-id}/reports/{report-id}":{ + "get":{ + "description":"Returns all reports of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"report-id", + "in":"path", + "description":"Report Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"A report with given report-id", + "schema":{ + "$ref":"#/definitions/Report" + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + }, + "default":{ + "description":"Unexpected error", + "schema":{ + "$ref":"#/definitions/Error" + } + } + } + } + }, + "/services/{service-id}/sessions/{session-id}/reports":{ + "get":{ + "description":"Return all reports of a given session of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, +``` + +``` + "type":"integer", + "format":"int32" + } +], +"responses":{ + "200":{ + "description":"OK.", + "schema":{ + "$ref":"#/definitions/Report" + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } +} +}, +"/services/{service-id}/sessions/{session-id}/reports/{report-id}":{ + "get":{ + "description":"Return all reports of a given session of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"report-id", + "in":"path", + "description":"Report Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"OK.", + "schema":{ + "$ref":"#/definitions/Report" + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } + } + } +}, +"/notifications":{ + "get":{ + "description":"Returns all notifications.", + "produces":[ +``` + +``` + + "application/json" + ], + "responses":{ + "200":{ + "description":"A list of notifications.", + "schema":{ + "type":"array", + "items":{ + "$ref":"#/definitions/Notification" + } + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "default":{ + "description":"Unexpected error", + "schema":{ + "$ref":"#/definitions/Error" + } + } + } +} +}, +"definitions":{ + "Service":{ + "type":"object", + "description":"Service Description", + "properties":{ + "id":{ + "type":"number", + "description":"Service Resource Identifier" + }, + "service-id":{ + "type":"string", + "description":"Identifies the MBMS User Service as defined in Clause 11.2.1.1 of TS +26.346." + }, + "service-class":{ + "description":"Service Class", + "type":"string" + }, + "service-languages":{ + "type":"array", + "description":"List of service languages", + "items":{ + "type":"string" + } + }, + "service-names":{ + "type":"array", + "description":"List of service names", + "items":{ + "type":"string" + } + }, + "receive-only-mode":{ + "description":" When set to true, the Content Provider indicates that the service is a Receive Only +Mode service.", + "type":"boolean" + }, + "service-announcement-mode":{ + "description":"Enumeration that the BM-SC creates according service announcement +fragments for the sessions and / or do service announcement on SACH. Additional service announcement +modes may be added in future", + "type":"string" + }, + "consumption-reporting-configuration":{ + "type":"object", + "description":"The Content Provider wishes to collect consumption reports (enabling +precision, i.e. combination of sample percentage and reporting interval)", + "properties":{ + "reporting-interval":{ + "type":"number", + } + } + } + } + } +} + +``` + +``` + "description":"The interval for which the BM-SC has to aggregate the statistics +for" + }, + "sample-percentage":{ + "type":"number", + "description":"Percentage of users to collect reports from" + }, + "start-time":{ + "type":"string", + "description":"Start time of consumption report collection" + }, + "end-time":{ + "type":"string", + "description":"End time of consumption report collection" + } + } +}, +"push-notification-url":{ + "type":"string", + "description":"The Content Provider provides Notification URL over which it will +receive notifications "pushed" by the BM-SC. The Notification procedure is described in Clause 5.3.6 +of 3GPP TS 26.348 [33]." +}, +"push-notification-configuration":{ + "type":"string", + "description":"If the Content Provider enables push delivery of notifications, then the +Content Provider may provide notification filters. This parameter contains a comma separated list of +Classes it wishes to receive among the following options: Critical, Warning, Information, Service, +Session, or All to get all types of notification. The notification message shall be sent immediately +to the Content Provider upon becoming available." +} +} +}, +"services-response": { + "required": [ + "service-res-id" + ], + "properties": { + "service-res-id": { + "type": "integer", + "format": "int32", + "description": "The resource identifier of the service." + } + } +}, +"Session":{ + "type":"object", + "description":"Session Description", + "properties":{ + "id":{ + "type":"string", + "description":"Session Resource Identifier" + }, + "session-start":{ + "description":"Start time when the MBMS Bearer is active", + "type":"number" + }, + "session-stop":{ + "description":"Stop time until the MBMS bearer is active", + "type":"number" + }, + "max-ingest-bitrate":{ + "description":"The requested bitrate excludes FEC overhead and transport overhead. The +BM-SC calculates the MBMS Bearer bitrate from it, considering overhead like FEC and other transport +overheads. The session bitrate is always larger or equal to the payload bitrate", + "type":"number", + "format":"float" + }, + "max-delay":{ + "description":"Specifies the maximum delay the MBMS System should add, i.e. from the +time the data is received to the time by when the data is released from the MBMS system", + "type":"number", + "format":"float" + }, + "session-state":{ + "description":"The BM-SC may automatically change the state of the session. Possible +states: Session Idle, Session Announced, Session Active", + "type":"string" + } + } +} +``` + +``` + + }, + "service-announcement-start-time":{ + "description":"When present, this time at which the BM-SC shall start service +announcement", + "type":"number" + }, + "geographical-area":{ + "description":"Geographics Area, where the service is provided, either through unicast +or through MBMS Bearers. The BM-SC derives the MBMS Service Area and the SAI list for the +availability information from Geographical Area as provided by the Content Provider. The content of +each string item is left to the business agreement between the Content Provider and the Operator.", + "type":"array", + "items":{ + "type":"string" + } + }, + "qoe-reporting-configuration":{ + "type":"array", + "description":"The Content Provider wishes to collect QoE reports for this session. If +this configuration is included, the QoE reporting configuration shall be applied only for this +session. If this configuration is present, the Content Provider requests overriding of service level +configuration for this session with this configuration. The possible QoE metrics that the Content +Provider may request can be either found in or derived from subclauses 8.4.2 and 10 of 3GPP TS +26.347 [21], as well as the reception reporting information that is available in subclause 9.4.6 of +3GPP TS 26.346 [3]. The detailed or aggregated reports shall not contain information such as +clientId, which might pose privacy concerns, or networkResourceCellId, which would expose mobile +network information.", + "items":{ + "type":"object", + "description":"QoE metric configuration", + "properties":{ + "metric-name":{ + "type":"string", + "description":"Name of QoE metric" + }, + "metric-type":{ + "type":"string", + "description":"Type of metric" + }, + "reporting-interval":{ + "type":"number", + "description":"The interval for which the BM-SC has to aggregate the statistics +for" + }, + "sample-percentage":{ + "type":"number", + "description":"Percentage of users to collect reports from" + }, + "start-time":{ + "type":"string", + "description":"Start time of consumption report collection" + }, + "end-time":{ + "type":"string", + "description":"End time of consumption report collection" + } + } + } + }, + "session-type":{ + "description":"The session type is how the Content Provider is providing the content to +the BM-SC. The BM-SC is selecting the appropriate delivery methods from the session type. The +session type shall be extensible for further session types", + "type":"string", + "enum":{ + "Streaming: When the session type is set to Streaming, the BM-SC expects a Streaming +type input (RTP). When the method is set to streaming, then the format is compliant to MBMS +streaming (as defined in 3GPP TS 26.346 [3]).", + "Files: When the session type is set to Files, the BM-SC expects generic files as +input. The files can be provided either by on-request pull interactions or continuous push ingest", + "Application: When the session type is set to Application, then the ingest depends on +the application service description. When the Application Service Description is set to DASH, the +BM-SC expects an MPD and optionally one or more IS's. The content is assumed to be 3GP-DASH +compliant (as defined by 3GPP TS 26.247). The BM-SC may either pull the Media Segments from the +Content Provider or the Content Provider continuously pushes Segments into the BM-SC", + "Transport-Mode: When the session type is set to Transport-Mode, the BM-SC provides +transport of data/TV content in a transparent manner. The content provide may provide some +configuration parameters for the distributions" + } + } + } +} + +``` + +``` + + ] + }, + "max-cid": { + "type": "integer", + "minimum": 0, + "maximum": 16383, + "description": "indicating the MAX CID parameter for the compressor (see IETF RFC 5795)." + }, + "header-compression":{ + "description":"Requests the BM-SC to enable ROHC on the input flows.", + "type":"array", + "items":{ + "type":"object", + "description":"Describes a single input flow where ROHC is to be applied. Either ipv4addr +or ipv6addr shall be included and port and periodicity may be included.", + "properties":{ + "ipv4addr":{ + "type":"string", + "description":"An IPv4 address formatted in the 'dotted decimal' notation as defined +in IETF RFC 1166 [31]" + }, + "ipv6addr":{ + "type":"string", + "description":" An IPv6 address formatted according to clause 4 of IETF RFC 5952 +[32]. The mixed IPv4 IPv6 notation according to clause 5 of IETF RFC 5952 [32] shall not be used." + }, + "port":{ + "type":"integer", + "description":"A UDP or TCP port between 0 and 65535 " + }, + "periodicity":{ + "type":"number", + "description":"the target periodicity for ROHC full header packets in units of seconds" + }, + "profile":{ + "type":"integer", + "description":"the applicable ROHC profile (see IETF RFC 5795 [27])" + } + } + } + }, + "fec":{ + "description":"Requests the BM-SC to perform FEC protection of the input flow when transmitting +over the MBMS channel. The string shall include an SDP description of FEC framework configuration +information (see subclause 5.5 of IETF RFC 6363 [29]) formatted according to subclause 8A.5 of +3GPP TS 26.346 [3].", + "type":"string" + }, + "resource-sharing-ind":{ + "type":"boolean", + "description": "The resource sharing indication." + }, + "resource-sharing-id":{ + "type":"string", + "description": "The resource sharing id. When present in the session modification +operation, the value of the field identifies an existing xMB session resource URL (as specified in +table 5.1.1-1) to share the transmission, where Max Bitrate, Geographical Area and (in case of MC +Services) QoS Information are re-used." + }, + "transport-mode-session":{ + "description":"Describes a transport mode session", + "type":"object", + "properties":{ + "session-announcement-mode":{ + "description":"The session announcement mode is either Content Provider or MBMS", + "type":"string", + "enum":[ + " Content Provider: the BMSC generates the session parameters and provides those +to the Content Provider.", + "SACH: the session announcement is done by the MBMS system through the SACH." + ] + }, + "userplane-session-description-parameters":{ + "description":"The session description parameters for the user plane provide the +information on where and how the to access the session at the Content Provider. The parameters Type +and Access URL. Note the BM-SC may get input on session properties from the Content Provider, e.g. +bitrate, dependening on the ingest session.", + "type":"object", + } + } + } +} + +``` + +``` + + "properties":{ + "session-description-type":{ + "type":"string", + "description":"The type of the session that describes the session, typically +for proper interpretation of the target resource of the request, for example the Internet Media Type +of the document, of the URL in an HTTP URL. An "Embedded" type is defined which indicates that the +xMB-U user plane parameters are embedded in the User Plane Parameters object." + }, + "session-description-access-url":{ + "type":"string", + "description":"A URL that enables to access and possibly control the ingest +session. The URL may for example be an RTSP URL or a URL to an SDP that describes a multicast stream +or an HTTP URL to retrieve a ready packaged MPEG2-TS stream, etc." + }, + "user-plane-parameters": { + "type": "string", + "description": "When the Type is set to 'Embedded', the Content Provider adds an +object containing the session description. In case of Forward Only Mode, the object may contain a +ready-made Session Description and the indication of a single xMB-U reception UDP port. When a +Session Description is present, then the BM-SC uses it for Session Announcement. In case of Proxy +Mode, the object shall contain a Session Description template and a list of the UDP flows to be +forwarded on the established MBMS bearer for the session. For each list entry, the content provider +indicates whether this flow is directly associated with a media description entry in the Session +Description Template or whether it is related to a media description entry (e.g. RTCP flows, which +have a relation to a media description entry, but are not described in the Session Description). If +the flow is directly associated with a media description entry, the BM-SC shall modify the port +field of the media description entry in the Session Description Template. If the flow is related to +a media description entry, then the BM-SC just forwards the flow on a port that is equal to the port +of the related media session plus an offset; such a flow is only implicitly described in the session +description - for example corresponding to the RTCP flows per the RTP/AVP profile." + } + } + }, + "userplane-delivery-mode-configuration":{ + "description":"This mode configures how the session needs to be delivered to the +application, i.e. it basically establishes the delivery mode", + "type":"string", + "enum":[ + "Forward-only: The BM-SC receives complete IP Multicast packets for to be +forwarded", + "Proxy: Proxy the incoming UDP payloads to the outgoing UDP payloads" + ] + }, + "delivery-session-description-parameters":{ + "description":"If the Service Announcement Mode is set to Content Provider, then +at least the following information is provided by the BM-SC: TMGI of the MBMS Bearer. Note that +additional parameters may be provided, based on the configuration options of the delivery method for +transport only.", + "type":"string" + } +} +}, +"streaming-session":{ + "description":"Describes a streaming session", + "type":"object", + "properties":{ + "sdp-url":{ + "description":"A URL to the SDP that describes the streaming session between the +Content Provider and the BM-SC, that will be used for ingesting the streaming session. The SDP shall +include the RTSP links for every media session as part of the "a=control" attribute to enable RTSP +control of the session. The SDP shall also contain the required bitrate for each of the media +sessions. The content shall conform to the constraints of this specification.", + "type":"string" + }, + "time-shifting":{ + "description":"Indicates if and for how long time shifting access to the content +(using unicast) may be provided for this session.", + "type":"number" + } + } +}, +"application-session":{ + "description":"Describes an application session", + "type":"object", + "properties":{ + "application-service":{ + "description":"Mimetype of the Application Service", + "type":"string" + } + } +} + +``` + +``` + + }, + "ingest-mode":{ + "description":"The ingest mode enumerates how resources are ingested into the BM- +SC", + "type":"string", + "enum":[ + "Pull: The BM-SC pulls the resources as described by the application entry point +document. If DASH resources are Media Segments, the BM-SC pulls the Media Segments as described by +the Segment availability start time from a DASH MPD.", + "Push: The Content Provider pushes resources. The BM-SC needs to provide a push +URL. If DASH resources are Media Segments, Content Provider pushes Media Segments, so that the Media +Segment is available on the BM-SC according to Segment availability start time. The BM-SC needs to +provide a push URL." + ] + }, + "application-entry-point-url":{ + "description":"The application entry point refers to an MPD when Application +Service Description is set to DASH. When the Ingest Mode is set to Push, then the MPD Url refers to +a DASH MPD which should be fetched, optionally conditioned and inserted into Service Announcement. +When the Ingest Mode is set to Pull, then the BM-SC starts fetching the Segments using unicast.", + "type":"string" + }, + "push-url":{ + "description":"If the Session Type is set to Application: A resource locator for +ingesting Media Segments using HTTP. The Content Provider may create additional sub-resources using +WebDAV procedures. This is a read-only parameter managed by the BM-SC and only present when Ingest +Mode is set to Push. If the Session Type is set to Files: This parameter contains the Push URL the +Content Provider shall use when using the Push ingestion mode. This is a read-only parameter managed +by the BM-SC and only present when Ingest Mode is set to Push. ", + "type":"string" + }, + "unicast-delivery":{ + "description":"Indicator whether the content is also available for unicast +retrieval", + "type":"boolean" + }, + "components":{ + "description":"List of Components of the application, which are recommended to be +made available on MBMS Bearers. In case of DASH, each component is identified by a representation +identifier. ", + "type":"array", + "items":{ + "type":"string" + } + } + }, + "files-session":{ + "description":"Describes a file session", + "type":"object", + "properties":{ + "ingest-mode":{ + "description":"The ingest mode enumerates how resources are ingested into the BM- +SC", + "type":"string", + "enum":[ + "Pull: The Content Provider adds files URLs that the BM-SC will fetch. The +Content Provider may tell the BM-SC when to start fetching the file", + "Push: The Content Provider shall push the file to the BM-SC that will +immediately process and deliver as soon as it is ready. The BM-SC may be configured to ignore all +files that are pushed before session active time, or stage them. The BM-SC shall provide back to the +Content Provider the URL the Content Provider shall use to push the files." + ] + }, + "push-url":{ + "description":"If the Session Type is set to Application: A resource locator for +ingesting Media Segments using HTTP. The Content Provider may create additional sub-resources using +WebDAV procedures. This is a read-only parameter managed by the BM-SC and only present when Ingest +Mode is set to Push. If the Session Type is set to Files: This parameter contains the Push URL the +Content Provider shall use when using the Push ingestion mode. This is a read-only parameter managed +by the BM-SC and only present when Ingest Mode is set to Push. ", + "type":"string" + }, + "file-list":{ + "type":"array", + "description":"List of files to be sent. In the Push mode, the file list is not +used since the BM-SC will monitor its push folder and send the files it receives on a first-come +first-served basis. In Pull mode, the file list contains the following information per file entry:", + +``` + +``` + + "items":{ + "type":"object", + "properties":{ + "file-url":{ + "type":"string", + "description":"the URL where the BM-SC will fetch the file content" + }, + "file-display-url":{ + "type":"string", + "description":"the file URL as seen by the UE" + }, + "file-earliest-fetch-time":{ + "type":"string", + "description":"The BM-SC shall fetch the file no sooner than this UTC +timestamp. If absent, then the file shall be present on the Content Provider server and the BM-SC +may fetch it when it wants", + "format":"date-time" + }, + "file-latest-fetch-time":{ + "type":"string", + "description":"The BM-SC shall fetch the file no later than this UTC +timestamp. If absent, then the file shall be present on the Content Provider server and the BM-SC +may fetch it at a time of its choosing.", + "format":"date-time" + }, + "file-size":{ + "type":"integer", + "format":"int32", + "description":"The Content Provider may provide the precise or an file size +estimate as input. The BM-SC may update the file size once it has started to fetch the file" + }, + "file-status":{ + "type":"string", + "description":"Enumeration stating the state of the file. Possible values +are pending, fetched, prepared, transmitting, sent", + "enum":[ + "pending", + "fetched", + "prepared", + "transmitting", + "sent" + ] + }, + "target-reception-completion-time":{ + "type":"string", + "description":"(On the MBMS Client) hint on the due date, when the file +should be completely received by the UE. The BM-SC should schedule and order the transmission etc +accordingly", + "format":"date-time" + }, + "keep-update-interval":{ + "type":"number", + "description":"The BM-SC checks the file resources with the given interval +for changes" + }, + "unicast-availability":{ + "description":"Indication that the file is also available for unicast +retrieval by the application at a Content Provider server whose location is given by the HTTP(S) URL +corresponding to the value of file display URL", + "type":"boolean" + }, + "byte-range":{ + "type":"boolean", + "description": "indicates that the HTTP(S) URL given in the file display +URL parameter can be used for Byte-Range-Based file repair" + }, + "e-tag":{ + "type":"boolean", + "description": "value of the ETag used as version identifier for the file +in the Byte-Range-Based file repair requests" + }, + "file-repetition-duration":{ + "type":"integer", + "format":"int32", + "description":"The number of times the file shall be sent on the session (a +value of 1 means the file shall be sent only once). This counter shall be decreased each time the +file has been transmitted. When equals to zero, no more file repeat is scheduled. The BM-SC may send +FEC instead of source information" + } + } + } + } +} + +``` + +``` + + }, + "periodic-update-interval": { + "type": "number", + "description": "When present, it is an indication that this file of the list +of files is expected to be periodically updated, and the value of this parameter represents the +nominally expected time interval between successive updates of this file. This parameter is a signal +to the BM-SC to deliver the file and its updates as a Datacasting service. From its value, the BM-SC +will choose the delivery mode, and set the associated interval and mode values in controlling the +transmission of the Datacasting service." + } + } +}, +"file-delivery-manifest-url":{ + "description":"Alternative to the file list. The resource may describe scheduling +information for the file", + "type":"string" +}, +"display-base-url": { + "type": "string", + "description": "When ingest mode is set to Push, the Base URL is seen by the UE." +}, +"sa-file-url":{ + "type":"string", + "description": "URL of the SA file announcing the download delivery session, +provided by the BM-SC when service-announcement-mode is set to 'Content Provider'." +} +} +}, +"local-mbms-delivery-information": { + "type": "object", + "description": "Local MBMS Delivery Information", + "properties": { + "mbms-enb-ipv4-multicast-address": { + "type": "string", + "format": "ipv4", + "description": "Contains the M1 (transport) plane IPv4 destination multicast +address used by MBMS-GW for IP multicast encapsulation of application IP multicast datagrams." + }, + "mbms-enb-ipv6-multicast-address ": { + "type": "string", + "format": "ipv6", + "description": "Contains the M1 (transport) plane IPv6 prefix of destination +multicast address used by MBMS-GW for IP multicast encapsulation of application IP multicast +datagrams." + }, + "mbms-gw-ipv4-ssm-address": { + "type": "string", + "format": "ipv4", + "description": "Contains the value of MBMS-GW's IPv4 address for Source +Specific Multicasting." + }, + "mbms-gw-ipv6-ssm-address": { + "type": "string", + "format": "ipv6", + "description": " Contains the value of MBMS-GW's IPv6 address for Source +Specific Multicasting." + }, + "common-tunnel-endpoint-identifier": { + "type": "string", + "description": "Indicates the common tunnel endpoint identifier of MBMS GW +for user plane." + }, + "bm-sc-ipv4-address": { + "type": "string", + "format": "ipv4", + "description": "Indicates the destination IPv4 address of the BM SC for the +reception of user plane data via the xMB U interface." + }, + "bm-sc-ipv6-address": { + "type": "string", + "format": "ipv6", + "description": "Indicates the destination IPv6 address of the BM SC for the +reception of user plane data via the xMB U interface." + }, + "bm-sc-port": { + "type": "integer", + "minimum": 0, + } + } +} + +``` + +``` + "maximum": 65535, + "description": "Indicates the destination UDP port of the BM SC for the +reception of user plane data via the xMB U interface." + } + } + }, + "group-ids": { + "type": "array", + "description": "List of group identifiers", + "items" : { + "type" : "string" + } + }, + "mc-extension": { + "type": "object", + "description": "Mission critical extension, allowing QoS control by the content +provider", + "properties": { + "gbr": { + "type": "number", + "format": "float", + "description": "Guaranteed bitrate for the MBMS bearer in unit kbps" + }, + "qci": { + "type": "integer", + "minimum": 0, + "maximum": 255, + "description": "QoS class identifier for the MBMS bearer" + }, + "arp-priority-level": { + "type": "integer", + "minimum": 1, + "maximum": 15, + "description": "ARP priority level", + }, + "arp-pre-emption-capability": { + "type": "boolean", + "description": "ARP preemption capability" + }, + "arp-pre-emption-vulnerability": { + "type": "boolean", + "description": "ARP preemption vulnerability" + }, + "tmgi": { + "type": "string", + "description": "TMGI of the MBMS bearer" + } + } + } +} +}, +"session-response": { + "required": [ + "session-res-id" + ], + "properties": { + "session-res-id": { + "type": "integer", + "format": "int32", + "description": "The resource identifier of the session." + } + } +}, +"Report":{ + "type": "object", + "description": "Report Description", + "properties": { + "id": { + "type": "string", + "description": "Report Resource Identifier" + }, + "report-type": { + "description": "Type of report", + "type": "string" + }, + "report-url": { + "type": "string", + } + } +} +``` + +``` + + "description":"Location of the report from where the Content Provider can retrieve the +detailed report" + }, + "report":{ + "type":"string", + "description":"Detailed report" + }, + "report-starttime":{ + "type":"string", + "description":"Report collection start time" + }, + "report-endtime":{ + "description":"Report collection end time", + "type":"string" + } + } +}, +"Notification": { + "type": "object", + "description": "Notification Description", + "properties": { + "id": { + "type": "string", + "description": "Notification Resource Identifier" + }, + "message-class": { + "type": "string", + "description": "Indicates the message class of the notification", +"enum" : ["Critical: When some event drastically prevent the proper delivery of content", "Warning: +When the service can be partially delivered but quality is reduced", "Information: When the service +is properly delivered but some interesting event occurred", "transmitting", "Session/Service: +Information about Service/Session related parameters"] + }, + "message-name": { + "description": "Unique identifier of the message. Provides information about the message pertaining +to the message-class of the notification", + "type": "string", +"enum" : ["network-is-down", "service-badly-configured", "session-badly-configured", "incoming- +bitrate-exceed-session-capacity", "no-incoming-data", "goe-report-available", "consumption-reports- +available", "reception-reports-available", "service-announcement-change", "session-state-change", +"file-ready-for-transmission", "file-download-started ", "file-successfully-sent", "file-fetch- +error"] + }, + "message-information": { + "type": "object", + "description": "A dictionary of key values containing informations linked to the +notification", + "additionalProperties": { + "type": "string" + } + } + } +}, +"Error":{ + "type":"object", + "properties":{ + "code":{ + "type":"integer", + "format":"int32" + }, + "message":{ + "type":"string" + } + } +} + +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------|--------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New | +| 2017-01 | | | | | | TS initial skeleton | 0.0.0 | +| 2017-01 | | | | | | C3A170064, C3A170066, C3A170069 agreed in Adhoc | 0.1.0 | +| 2017-02 | | | | | | Specification of the xMB user- and control-plane procedures, accompanied by the corresponding JSON schema. | 0.2.0 | +| 2017-03 | CT#75 | CP-170102 | | | | TS sent for approval to Plenary | 1.0.0 | +| 2017-03 | CT#75 | CP-170102 | | | | TS under change control | 14.0.0 | +| 2017-06 | CT#76 | CP-171115 | 0001 | 2 | F | Editorial Updates to TS 29.116 v14.0.0 | 14.1.0 | +| 2017-06 | CT#76 | CP-171115 | 0002 | 2 | F | Technical Corrections to TS 29.116 v14.0.0 | 14.1.0 | +| 2017-06 | CT#76 | CP-171115 | 0003 | 3 | F | Technical Corrections to TS 29.116 v14.0.0 | 14.1.0 | +| 2017-06 | CT#76 | CP-171115 | 0004 | 2 | F | Supported feature negotiation | 14.1.0 | +| 2017-06 | CT#76 | CP-171137 | 0005 | 2 | B | Local MBMS related MBMS data delivery for xMB interface | 14.1.0 | +| 2017-06 | CT#76 | CP-171115 | 0010 | 2 | F | xMB Stage-2 related updates | 14.1.0 | +| 2017-06 | CT#76 | CP-171140 | 0011 | 2 | F | Security in xMB | 14.1.0 | +| 2017-09 | CT#77 | CP-172037 | 0013 | - | F | Reference correction | 14.2.0 | +| 2017-09 | CT#77 | CP-172037 | 0014 | 1 | F | Fixes and editorial updates to TS 29.116 | 14.2.0 | +| 2017-09 | CT#77 | CP-172053 | 0016 | 1 | F | Alignment to TS 26.346 | 14.2.0 | +| 2017-09 | CT#77 | CP-172055 | 0017 | 1 | F | Modification of Text on xMB Security | 14.2.0 | +| 2017-12 | CT#78 | CP-173087 | 0018 | 1 | F | Correction of Reference | 14.3.0 | +| 2018-06 | CT#80 | CP-181024 | 0021 | 1 | B | FEC and ROHC for mission critical services over MBMS | 15.0.0 | +| 2019-03 | CT#83 | CP-190129 | 0024 | 2 | F | Moving xMB stage 2 to TS 26.348 | 16.0.0 | +| 2019-06 | CT#84 | CP-191086 | 0027 | - | A | Correct feature applicability | 16.1.0 | +| 2019-06 | CT#84 | CP-191108 | 0029 | 1 | A | UE group content delivery | 16.1.0 | +| 2019-06 | CT#84 | CP-191099 | 0031 | 1 | A | Correct ROHC usage in xMB | 16.1.0 | +| 2019-09 | CT#85 | CP-192158 | 0032 | | F | Removal of a duplicated openAPI definition | 16.2.0 | +| 2019-12 | CT#86 | CP-193199 | 0033 | | F | Add file display URI support | 16.3.0 | +| 2019-12 | CT#86 | CP-193199 | 0034 | | F | Clarify consumption report configuration | 16.3.0 | +| 2019-12 | CT#86 | CP-193199 | 0035 | 1 | F | Clarify PATCH usage | 16.3.0 | +| 2019-12 | CT#86 | CP-193204 | 0036 | 1 | B | Mission critical extension | 16.3.0 | +| 2019-12 | CT#86 | CP-193204 | 0037 | | B | MBMS resource sharing | 16.3.0 | +| 2019-12 | CT#86 | CP-193204 | 0038 | | B | SA file returned for the download delivery session | 16.3.0 | +| 2019-12 | CT#86 | CP-193204 | 0039 | | B | File Repair hosted by the content provider | 16.3.0 | +| 2019-12 | CT#86 | CP-193204 | 0040 | 1 | B | xMB adaptation for CAPIF | 16.3.0 | +| 2019-12 | CT#86 | CP-193129 | 0041 | | A | Format for FEC framework configuration information in xMB | 16.3.0 | +| 2020-03 | CT#87e | CP-200217 | 0042 | | F | Correct xMB adaptation for CAPIF | 16.4.0 | +| 2020-03 | CT#87e | CP-200213 | 0043 | 1 | F | Correct opeAPI error in Mission critical extension section | 16.4.0 | +| 2020-06 | CT#88e | CP-201246 | 0044 | | F | Corrected reference to xMB stage-2 spec | 16.5.0 | +| 2020-06 | CT#88e | CP-201246 | 0045 | 1 | D | Remove redundant annex content | 16.5.0 | +| 2020-06 | CT#88e | CP-201239 | 0046 | | F | Correct qci for Mission critical extension | 16.5.0 | +| 2020-06 | CT#88e | CP-201249 | 0047 | | F | Fix the missing push url in file session | 16.5.0 | +| 2020-09 | CT#89e | CP-202061 | 0050 | | A | Correct xMB update procedure | 16.6.0 | +| 2021-06 | CT#92e | CP-211248 | 0052 | | B | eCAPIF support | 17.0.0 | +| 2021-12 | CT#94e | CP-213220 | 0053 | | B | Update of HTTP Digest Access Authentication | 17.1.0 | +| 2022-09 | CT#97e | CP-222094 | 0054 | | B | Supporting xMB interface extensions for 5GMS via eMBMS | 17.2.0 | +| 2022-12 | CT#98e | CP-223199 | 0055 | | F | Miscellaneous corrections | 18.0.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29118/raw.md b/raw/rel-18/29_series/29118/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c2bd98dea24cf2a1ec6c9f32ce16ad24711e1a33 --- /dev/null +++ b/raw/rel-18/29_series/29118/raw.md @@ -0,0 +1,3164 @@ + + +# 3GPP TS 29.118 V18.0.0 (2023-03) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Mobility Management Entity (MME) Visitor Location Register (VLR) SGs interface specification (Release 18)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5" and "G" is a green graphic element consisting of three curved lines, resembling a signal strength indicator or a stylized wave. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. The "3" and "G" are connected by a horizontal line, and the "P" and "P" are connected by a horizontal line. Below the "P"s is a small red graphic element consisting of three curved lines, resembling a signal strength indicator or a stylized wave. + +3GPP logo + +A GLOBAL INITIATIVE + +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. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------|----| +| Foreword ..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions and abbreviations ..... | 10 | +| 3.1 Definitions..... | 10 | +| 3.2 Abbreviations ..... | 11 | +| 4 Description of the SGs association between a VLR and an MME ..... | 11 | +| 4.1 General ..... | 11 | +| 4.2 SGs association at the VLR..... | 11 | +| 4.2.1 General ..... | 11 | +| 4.2.2 States at the VLR..... | 12 | +| 4.3 SGs association at the MME ..... | 12 | +| 4.3.1 General ..... | 12 | +| 4.3.2 MM context variables at the MME ..... | 13 | +| 4.3.3 States at the MME ..... | 13 | +| 4.3.4 State transitions in the MME without SGsAP signalling ..... | 14 | +| 4.3.5 State transitions in the VLR without SGsAP signalling..... | 14 | +| 5 Procedures for SGs..... | 15 | +| 5.1 Paging for non-EPS services procedure ..... | 15 | +| 5.1.1 General description..... | 15 | +| 5.1.2 Procedures in the VLR ..... | 15 | +| 5.1.2.1 General..... | 15 | +| 5.1.2.2 Paging Initiation..... | 15 | +| 5.1.2.3 Paging Response ..... | 16 | +| 5.1.2.4 Paging Failure ..... | 16 | +| 5.1.2.5 UE unreachable..... | 17 | +| 5.1.3 Procedures in the MME..... | 17 | +| 5.1.3.1 General..... | 17 | +| 5.1.3.2 Procedure when no NAS signalling connection exists ..... | 20 | +| 5.1.3.3 Procedure when a NAS signalling connection exists ..... | 21 | +| 5.2 Location update for non-EPS services procedure ..... | 21 | +| 5.2.1 General description..... | 21 | +| 5.2.2 Procedures in the MME..... | 22 | +| 5.2.2.1 General..... | 22 | +| 5.2.2.2 Location update initiation ..... | 22 | +| 5.2.2.2.1 General ..... | 22 | +| 5.2.2.2.2 VLR fails without restart..... | 24 | +| 5.2.2.3 Location update response..... | 25 | +| 5.2.2.4 Location update failure ..... | 25 | +| 5.2.2.5 Abnormal cases..... | 26 | +| 5.2.2.6 Additional MME procedure for UE supporting NB-S1 mode only..... | 26 | +| 5.2.3 Procedures in the VLR ..... | 27 | +| 5.2.3.1 General..... | 27 | +| 5.2.3.2 Location update response..... | 27 | +| 5.2.3.3 Location update failure ..... | 28 | +| 5.2.3.4 TMSI reallocation procedure ..... | 28 | +| 5.2.3.5 Abnormal cases..... | 28 | +| 5.3 Non-EPS alert procedure..... | 29 | +| 5.3.1 General description..... | 29 | +| 5.3.2 Procedures in the VLR ..... | 29 | +| 5.3.2.1 Alert Initiation..... | 29 | +| 5.3.2.2 Alert Response..... | 29 | +| 5.3.2.3 Alert Failure ..... | 30 | +| 5.3.2.4 Alert Indication ..... | 30 | + +| | | | +|------------|--------------------------------------------------|----| +| 5.3.2.5 | Abnormal cases..... | 30 | +| 5.3.3 | Procedures in the MME..... | 30 | +| 5.3.3.1 | Alert response ..... | 30 | +| 5.3.3.2 | Alert failure..... | 30 | +| 5.3.3.3 | Alert indication ..... | 30 | +| 5.4 | Explicit IMSI detach from EPS services..... | 31 | +| 5.4.1 | General description..... | 31 | +| 5.4.2 | Procedures in the MME..... | 31 | +| 5.4.2.1 | Explicit EPS detach initiation ..... | 31 | +| 5.4.2.2 | Explicit EPS detach response ..... | 32 | +| 5.4.2.3 | Abnormal cases..... | 32 | +| 5.4.3 | Procedures in the VLR ..... | 32 | +| 5.5 | Explicit IMSI detach from non-EPS services ..... | 32 | +| 5.5.1 | General description..... | 32 | +| 5.5.2 | Procedures in the MME..... | 32 | +| 5.5.2.1 | Explicit IMSI detach initiation ..... | 32 | +| 5.5.2.2 | Explicit IMSI detach response..... | 33 | +| 5.5.2.3 | Abnormal cases..... | 33 | +| 5.5.3 | Procedures in the VLR ..... | 33 | +| 5.6 | Implicit IMSI detach from non-EPS services ..... | 33 | +| 5.6.1 | General description..... | 33 | +| 5.6.2 | Procedures in the MME..... | 34 | +| 5.6.3 | Procedures in the VLR ..... | 34 | +| 5.7 | VLR failure procedure ..... | 34 | +| 5.7.1 | General description..... | 34 | +| 5.7.2 | Procedures in the VLR ..... | 34 | +| 5.7.2.1 | VLR Reset Initiation..... | 34 | +| 5.7.2.2 | VLR Reset Response ..... | 34 | +| 5.7.2.3 | Abnormal cases..... | 35 | +| 5.7.3 | Procedures in the MME..... | 35 | +| 5.7.3.1 | VLR reset indication..... | 35 | +| 5.7.3.2 | Void ..... | 35 | +| 5.8 | MME failure procedure..... | 35 | +| 5.8.1 | General description..... | 35 | +| 5.8.2 | Procedures in the MME..... | 35 | +| 5.8.2.1 | MME Reset Initiation ..... | 35 | +| 5.8.2.2 | MME Reset Response..... | 36 | +| 5.8.2.3 | Abnormal cases..... | 36 | +| 5.8.3 | Procedures in the VLR ..... | 36 | +| 5.9 | HSS failure ..... | 36 | +| 5.9.1 | General description..... | 36 | +| 5.9.2 | Procedures in the MME..... | 36 | +| 5.10 | MM information procedure ..... | 37 | +| 5.10.1 | General description..... | 37 | +| 5.10.2 | Procedures in the VLR ..... | 37 | +| 5.10.3 | Procedures in the MME..... | 37 | +| 5.11 | Procedure for tunnelling of NAS messages ..... | 38 | +| 5.11.1 | General description..... | 38 | +| 5.11.2 | Uplink unitdata procedure ..... | 38 | +| 5.11.2.1 | Procedures in the MME..... | 38 | +| 5.11.2.2 | Procedures in the VLR..... | 38 | +| 5.11.2.2.1 | General description ..... | 38 | +| 5.11.2.2.2 | Abnormal cases ..... | 38 | +| 5.11.2.3 | Void ..... | 39 | +| 5.11.3 | Downlink unitdata procedure ..... | 39 | +| 5.11.3.1 | Procedures in the VLR..... | 39 | +| 5.11.3.2 | Procedures in the MME..... | 39 | +| 5.11.3.2.1 | General description ..... | 39 | +| 5.11.3.2.2 | Abnormal cases ..... | 39 | +| 5.11.3.3 | Void ..... | 39 | +| 5.11.4 | Release procedure..... | 39 | +| 5.12 | Service request procedure ..... | 40 | + +| | | | +|--------|-----------------------------------------------------------------|----| +| 5.12.1 | General description..... | 40 | +| 5.12.2 | Procedures in the MME..... | 40 | +| 5.12.3 | Procedures in the VLR ..... | 40 | +| 5.13 | Service abort procedure..... | 41 | +| 5.13.1 | General description..... | 41 | +| 5.13.2 | Procedures in the VLR ..... | 41 | +| 5.13.3 | Procedures in the MME..... | 41 | +| 5.14 | Implicit IMSI detach from EPS services..... | 41 | +| 5.14.1 | General description..... | 41 | +| 5.14.2 | Procedures in the MME..... | 42 | +| 5.14.3 | Procedures in the VLR ..... | 42 | +| 5.15 | UE fallback supervision procedure ..... | 42 | +| 5.15.0 | General description..... | 42 | +| 5.15.1 | Procedures in the VLR ..... | 42 | +| 5.16 | Procedure for MO CSFB indication..... | 43 | +| 5.16.1 | General description..... | 43 | +| 5.16.2 | Procedures in the MME..... | 43 | +| 5.16.3 | Procedures in the VLR ..... | 43 | +| 6 | SGs transport..... | 43 | +| 6.1 | General ..... | 43 | +| 6.2 | IP layer ..... | 43 | +| 6.3 | Transport layer ..... | 43 | +| 7 | Error handling ..... | 44 | +| 7.1 | General ..... | 44 | +| 7.2 | Message too short..... | 44 | +| 7.3 | Unknown or unforeseen message type..... | 44 | +| 7.4 | Missing mandatory information element ..... | 45 | +| 7.5 | Information elements unknown or unforeseen in the message ..... | 45 | +| 7.6 | Out of sequence information elements..... | 45 | +| 7.7 | Repeated information elements..... | 45 | +| 7.8 | Syntactically incorrect mandatory information element. .... | 45 | +| 7.9 | Syntactically incorrect optional information elements..... | 45 | +| 7.10 | Conditional information element errors ..... | 45 | +| 7.11 | Information elements with semantically incorrect contents..... | 46 | +| 8 | Message functional definitions and contents ..... | 46 | +| 8.1 | SGsAP-ALERT-ACK message..... | 46 | +| 8.2 | SGsAP-ALERT-REJECT message..... | 46 | +| 8.3 | SGsAP-ALERT-REQUEST message..... | 46 | +| 8.4 | SGsAP-DOWNLINK-UNITDATA message ..... | 47 | +| 8.5 | SGsAP-EPS-DETACH-ACK message..... | 47 | +| 8.6 | SGsAP-EPS-DETACH-INDICATION message..... | 47 | +| 8.7 | SGsAP-IMSI-DETACH-ACK message ..... | 48 | +| 8.8 | SGsAP-IMSI-DETACH-INDICATION message ..... | 48 | +| 8.9 | SGsAP-LOCATION-UPDATE-ACCEPT message..... | 48 | +| 8.9.1 | Message definition..... | 48 | +| 8.9.2 | New TMSI, or IMSI ..... | 48 | +| 8.10 | SGsAP-LOCATION-UPDATE-REJECT message..... | 49 | +| 8.10.1 | Message definition..... | 49 | +| 8.10.2 | Location area identifier..... | 49 | +| 8.11 | SGsAP-LOCATION-UPDATE-REQUEST message ..... | 50 | +| 8.11.1 | Message definition..... | 50 | +| 8.11.2 | Old location area identifier ..... | 50 | +| 8.11.3 | TMSI status ..... | 50 | +| 8.11.4 | IMEISV ..... | 50 | +| 8.11.5 | TAI ..... | 50 | +| 8.11.6 | E-CGI ..... | 50 | +| 8.11.7 | TMSI based NRI container..... | 51 | +| 8.11.8 | Selected CS domain operator ..... | 51 | +| 8.12 | SGsAP-MM-INFORMATION-REQUEST ..... | 51 | +| 8.13 | SGsAP-PAGING-REJECT message..... | 51 | + +| | | | +|---------|-----------------------------------------------|----| +| 8.14 | SGsAP-PAGING-REQUEST message..... | 51 | +| 8.14.1 | Message definition..... | 51 | +| 8.14.2 | TMSI..... | 52 | +| 8.14.3 | CLI..... | 52 | +| 8.14.4 | Location area identifier..... | 52 | +| 8.14.5 | Global CN-Id..... | 52 | +| 8.14.6 | SS code..... | 52 | +| 8.14.7 | LCS indicator..... | 53 | +| 8.14.8 | LCS client identity..... | 53 | +| 8.14.9 | Channel needed..... | 53 | +| 8.14.10 | eMLPP priority..... | 53 | +| 8.14.11 | Additional paging indicators..... | 53 | +| 8.14.12 | SM Delivery Timer..... | 53 | +| 8.14.13 | SM Delivery Start Time..... | 53 | +| 8.14.4 | Maximum Retransmission Time..... | 53 | +| 8.15 | SGsAP-RESET-ACK message..... | 53 | +| 8.15.1 | Message definition..... | 53 | +| 8.15.2 | MME name..... | 54 | +| 8.15.3 | VLR name..... | 54 | +| 8.16 | SGsAP-RESET-INDICATION message..... | 54 | +| 8.16.1 | Message definition..... | 54 | +| 8.16.2 | MME name..... | 54 | +| 8.16.3 | VLR name..... | 54 | +| 8.17 | SGsAP-SERVICE-REQUEST message..... | 55 | +| 8.17.1 | Message definition..... | 55 | +| 8.17.2 | IMEISV..... | 55 | +| 8.17.3 | UE Time Zone..... | 55 | +| 8.17.4 | Mobile Station Classmark 2..... | 55 | +| 8.17.5 | TAI..... | 55 | +| 8.17.6 | E-CGI..... | 55 | +| 8.17.7 | UE EMM Mode..... | 55 | +| 8.18 | SGsAP-STATUS message..... | 56 | +| 8.18.1 | Message definition..... | 56 | +| 8.18.2 | IMSI..... | 56 | +| 8.19 | SGsAP-TMSI-REALLOCATION-COMPLETE message..... | 56 | +| 8.20 | SGsAP-UE-ACTIVITY-INDICATION message..... | 56 | +| 8.20.1 | Maximum UE Availability Time..... | 56 | +| 8.21 | SGsAP-UE-UNREACHABLE message..... | 57 | +| 8.21.1 | Requested Retransmission Time..... | 57 | +| 8.21.2 | Additional UE Unreachable indicators..... | 57 | +| 8.22 | SGsAP-UPLINK-UNITDATA message..... | 57 | +| 8.22.1 | Message definition..... | 57 | +| 8.22.2 | IMEISV..... | 58 | +| 8.22.3 | UE Time Zone..... | 58 | +| 8.22.4 | Mobile Station Classmark 2..... | 58 | +| 8.22.5 | TAI..... | 58 | +| 8.22.6 | E-CGI..... | 58 | +| 8.23 | SGsAP-RELEASE-REQUEST message..... | 58 | +| 8.23.1 | Message definition..... | 58 | +| 8.23.2 | SGs Cause..... | 58 | +| 8.24 | SGsAP-SERVICE-ABORT-REQUEST message..... | 58 | +| 8.24.1 | Message definition..... | 58 | +| 8.25 | SGsAP-MO-CSFB-INDICATION message..... | 59 | +| 8.25.1 | Message definition..... | 59 | +| 8.25.2 | TAI..... | 59 | +| 8.25.3 | E-CGI..... | 59 | +| 9 | Information element coding..... | 59 | +| 9.1 | Overview..... | 59 | +| 9.2 | Message type..... | 60 | +| 9.3 | Information element identifiers..... | 61 | +| 9.3a | Length indicator..... | 61 | + +| | | | +|---------------------------------------------------|--------------------------------------------|-----------| +| 9.4 | Information elements..... | 61 | +| 9.4.1 | CLI..... | 61 | +| 9.4.2 | EPS location update type..... | 62 | +| 9.4.3 | Erroneous message..... | 62 | +| 9.4.3a | E-UTRAN Cell Global Identity..... | 62 | +| 9.4.4 | Global CN-Id..... | 63 | +| 9.4.5 | IMEISV..... | 63 | +| 9.4.6 | IMSI..... | 63 | +| 9.4.7 | IMSI detach from EPS service type..... | 63 | +| 9.4.8 | IMSI detach from non-EPS service type..... | 63 | +| 9.4.9 | LCS client identity..... | 64 | +| 9.4.10 | LCS indicator..... | 64 | +| 9.4.11 | Location area identifier..... | 64 | +| 9.4.12 | MM information..... | 65 | +| 9.4.13 | MME name..... | 65 | +| 9.4.14 | Mobile identity..... | 65 | +| 9.4.14a | Mobile Station Classmark 2..... | 65 | +| 9.4.15 | NAS message container..... | 65 | +| 9.4.16 | Reject cause..... | 66 | +| 9.4.17 | Service indicator..... | 66 | +| 9.4.18 | SGs cause..... | 66 | +| 9.4.19 | SS code..... | 67 | +| 9.4.20 | TMSI..... | 67 | +| 9.4.21 | TMSI status..... | 67 | +| 9.4.21a | Tracking Area Identity..... | 67 | +| 9.4.21b | UE Time Zone..... | 68 | +| 9.4.21c | UE EMM mode..... | 68 | +| 9.4.22 | VLR name..... | 68 | +| 9.4.23 | Channel needed..... | 69 | +| 9.4.24 | eMLPP priority..... | 69 | +| 9.4.25 | Additional paging indicators..... | 69 | +| 9.4.26 | TMSI based NRI container..... | 69 | +| 9.4.27 | Selected CS domain operator..... | 69 | +| 9.4.28 | Maximum UE Availability Time..... | 70 | +| 9.4.29 | SM Delivery Timer..... | 70 | +| 9.4.30 | SM Delivery Start Time..... | 70 | +| 9.4.31 | Additional UE Unreachable indicators..... | 71 | +| 9.4.32 | Maximum Retransmission Time..... | 71 | +| 9.4.33 | Requested Retransmission Time..... | 72 | +| 10 | List of system variables..... | 72 | +| 10.1 | Timers..... | 72 | +| 10.2 | Retry counters..... | 73 | +| Annex A (informative): Change history..... | | 74 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +CS Fallback in the Evolved Packet System (EPS) enables the provisioning of CS-domain services (e.g. voice call, Location Services (LCS) or supplementary services) by reuse of CS infrastructure when the UE is served by E-UTRAN. Additionally, SMS delivery via the CS core network is realized without CS fallback. + +The present document specifies the procedures and the SGs Application Part (SGsAP) messages used on the SGs interface between the Mobility Management Entity (MME) in the EPS and the Visitor Location Register (VLR), to allow location management coordination and to relay certain messages related to GSM circuit switched services over the EPS system. + +The present document also specifies the use of Stream Control Transmission Protocol (SCTP) for the transport of SGsAP messages. + +The present document is applicable to the MME in the EPS and to the VLR. The functional split between the MME and the VLR is defined in 3GPP TS 23.272 [7]. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 22.101: "Service aspects; Service principles". +- [3] 3GPP TS 23.003: "Numbering, addressing and identification". +- [4] 3GPP TS 23.007: "Restoration procedures". +- [5] 3GPP TS 23.018: "Basic call handling; Technical realization". +- [5AA] 3GPP TS 23.078: "Customised Applications for Mobile network Enhanced Logic (CAMEL) Phase 4; Stage 2". +- [5A] 3GPP TS 23.081: "Line identification supplementary services". +- [5B] 3GPP TS 23.082: "Call Forwarding (CF) supplementary services". +- [6] Void. +- [6A] 3GPP TS 23.236: "Intra-domain connection of Radio Access Network (RAN) nodes to multiple Core Network (CN) nodes". +- [7] 3GPP TS 23.272: "Circuit Switched Fallback in Evolved Packet System; Stage 2". +- [7A] 3GPP TS 23.251: "Network Sharing; Architecture and Functional Description". +- [7B] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access". +- [8] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [9] 3GPP TS 24.010: "Supplementary services specification; General aspects". + +- [10] 3GPP TS 24.011: "Point-to-Point (PP) Short Message Service (SMS) support on mobile radio interface". +- [11] 3GPP TS 24.030: "Location Services (LCS); Supplementary service operations; Stage 3". +- [12] 3GPP TS 24.081: "Line Identification Supplementary Services - Stage 3". +- [13] 3GPP TS 24.082: "Call Forwarding (CF) supplementary services; Stage 3". +- [14] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [15] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [15A] 3GPP TS 29.011: "Signalling interworking for supplementary services". +- [16] 3GPP TS 29.018: "Serving GPRS Support Node (SGSN) - Visitors Location Register (VLR) Gs interface layer 3 specification". +- [16A] 3GPP TS 29.060: General Packet Radio Service (GPRS);GPRS Tunnelling Protocol (GTP) across the Gn and Gp interface. +- [17] 3GPP TS 29.272: "MME and SGSN Related Interfaces Based on Diameter Protocol". +- [17A] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [17B] 3GPP TS 32.250: "Telecommunication management; Charging management; Circuit Switched (CS) domain charging". +- [18] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management (CM)". +- [19] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC) protocol specification". +- [20] IETF RFC 791 (September 1981): "Internet Protocol". +- [21] Void. +- [22] IETF RFC 2460 (December 1998): "Internet Protocol, Version 6 (IPv6) Specification". +- [23] IETF RFC 4960 (September 2007): "Stream Control Transmission Protocol". +- [24] 3GPP TS 22.067: "enhanced Multi Level Precedence and Pre-emption service (eMLPP); Stage 1". +- [25] 3GPP TS 23.067: "enhanced Multi-Level Precedence and Pre-emption service (eMLPP); Stage 2". +- [26] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC); Stage 2". +- [27] Void. + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] apply. Additionally the following definitions of 3GPP TS 24.301 [14] apply: + +###### **Non-EPS services** **SMS only** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.272 [7] apply: + +**CS fallback** +**SMS over SGs** +**SMS in MME** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.251 [7A] apply: + +**Common PLMN** +**Gateway core network (GWCN)** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.301 [14] apply: + +**In NB-S1 mode** + +## 3.2 Abbreviations + +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]. + +| | | +|-------|--------------------------------------| +| LCS | Location Services | +| MME | Mobility Management Entity | +| NEAF | Non-EPS Alert Flag | +| SCTP | Stream Control Transmission Protocol | +| SGsAP | SGs Application Part | +| SMS | Short Message Service | +| PSI | Provide Subscriber Information | + +# --- 4 Description of the SGs association between a VLR and an MME + +## 4.1 General + +CS fallback function and SMS delivery via the CS core network is realized by reusing Gs interface mechanisms as defined in 3GPP TS 29.018 [16] on the interface between the MME in the EPS and the VLR. This interface is called SGs interface. + +NOTE: Within this specification, the term VLR refers to MSC/VLR or MSC Server/VLR. + +The SGs interface connects the databases in the VLR and the MME. The procedures described in the present document are used to co-ordinate the location information of UEs that are IMSI attached to both EPS and non-EPS services. The SGs interface is also used to convey some circuit switched related procedures via the MME. + +The basis for the interworking between a VLR and an MME is the existence of a SGs association between those entities per UE. The SGs association is applicable to UEs which are configured to use CS fallback and SMS over SGs, or SMS over SGs only. The SGs association is not applicable if the subscriber data indicates that the subscription is for packet only. The SGs association is also not applicable if the MME is registered for SMS for the UE as specified in 3GPP TS 23.272 [7]. + +In NB-S1 mode, the SGs association is also applicable to UEs supports NB-S1 mode only to use SMS over SGs only. + +The behaviour of the VLR and the MME entities related to the SGs interface are defined by the state of the SGs association for a UE. Individual SGs association states are maintained at both the VLR and the MME for each UE. + +## 4.2 SGs association at the VLR + +### 4.2.1 General + +The states associated to the SGs interface in the VLR are specified in subclause 4.2.2 and the state diagram at the VLR is shown in figure 4.2.2.1. The state diagram does not include the message error handling specified in clause 7. + +### 4.2.2 States at the VLR + +#### SGs-NULL + +There is no SGs association with an MME for the UE and therefore the VLR considers that the UE is IMSI detached for EPS services. In this state no SGsAP-MM-INFORMATION-REQUEST messages are sent to the MME. The VLR may initiate paging on the SGs interface if the "Confirmed by Radio Contact" restoration indicator in the VLR is set to "false" (see 3GPP TS 23.007 [4]). Any message from the MME is ignored except SGsAP-LOCATION-UPDATE-REQUEST, SGsAP-IMSI-DETACH-INDICATION and SGsAP-EPS-DETACH-INDICATION. + +#### LA-UPDATE-PRESENT + +The VLR has received an SGsAP-LOCATION-UPDATE-REQUEST message from the MME. In this state, the VLR may be waiting for the outcome of the Update Location procedure from the HSS, if the IMSI is not known in the VLR. For UEs which are configured to use CS fallback and SMS over SGs, or SMS over SGs only, the VLR sends SGsAP-PAGING-REQUEST messages via the SGs interface. + +#### SGs-ASSOCIATED + +The VLR considers that the UE is attached to both EPS and non-EPS services. For UEs which are configured to use CS fallback and SMS over SGs, or SMS over SGs only, the VLR sends SGsAP-PAGING-REQUEST messages via the SGs interface. The VLR can perform the MM information procedure. + +![State diagram at the VLR showing three states: SGs-NULL, LA-UPDATE-PRESENT, and SGs-ASSOCIATED. Transitions are triggered by various messages from the MME, UE, or SGSN, and actions include sending paging, location updates, or reset messages.](af6be343f0c0a8f155f965dcf337b8af_img.jpg) + +``` + +stateDiagram-v2 + [*] --> SGs-NULL : From one of the three states (at the VLR) + SGs-NULL --> SGs-NULL : Reset received from the MME + SGs-NULL --> SGs-NULL : VLR failure + SGs-NULL --> SGs-NULL : Detach indication received from the MME or the UE + SGs-NULL --> SGs-NULL : Location Update Request received from the UE via the A interface or via the lu interface, or from the SGSN via the Gs interface + SGs-NULL --> LA-UPDATE-PRESENT : Location Update Request received from the MME + LA-UPDATE-PRESENT --> SGs-NULL : Send Location Update Reject + LA-UPDATE-PRESENT --> SGs-ASSOCIATED : Send Location Update Accept + LA-UPDATE-PRESENT --> SGs-NULL : Paging failure received + LA-UPDATE-PRESENT --> SGs-NULL : Paging Failure or Alert Failure received + LA-UPDATE-PRESENT --> LA-UPDATE-PRESENT : Send paging + SGs-ASSOCIATED --> SGs-NULL : SGsAP-UE-UNREACHABLE message received + SGs-ASSOCIATED --> SGs-NULL : TMSI Reallocation received + SGs-ASSOCIATED --> SGs-NULL : Send paging + SGs-ASSOCIATED --> LA-UPDATE-PRESENT : Location Update Request received from the MME + +``` + +State diagram at the VLR showing three states: SGs-NULL, LA-UPDATE-PRESENT, and SGs-ASSOCIATED. Transitions are triggered by various messages from the MME, UE, or SGSN, and actions include sending paging, location updates, or reset messages. + +NOTE: Receipt of an SGsAP-RESET-INDICATION message from the MME may change or not the state of the SGs interface of all the associations associated to the restarted MME, see subclause 5.8.3. + +Figure 4.2.2.1: State diagram at the VLR + +## 4.3 SGs association at the MME + +### 4.3.1 General + +The MM context variables associated to the SGs interface in the MME are specified in subclause 4.3.2 and states associated to the SGs interface in the MME are specified in subclause 4.3.3. The state diagram at the MME is shown in figure 4.3.3.1. The state diagram does not include the message error handling specified in clause 7. + +### 4.3.2 MM context variables at the MME + +#### VLR-Reliable: + +Boolean set to "false" when the MME has received a reset indication from the VLR. The MME may: + +- upon reception of a combined tracking area update request from a UE that is still attached for non-EPS services, perform immediately the location update for non-EPS services procedure; or +- upon reception of a periodic tracking area update request from a UE that is still attached for non-EPS services, dependent on network configuration and operator policy, + - perform a network initiated detach with detach type "IMSI detach" immediately after the completion of the periodic tracking area update procedure; or + - perform immediately the location update for non-EPS services procedure. + +#### MME-Reset: + +Boolean set to "true" when the MME restarts after a failure. The "MME-Reset" restoration indicator is unique within an MME and it applies to all the MM contexts stored in the MME. + +### 4.3.3 States at the MME + +#### SGs-NULL + +There is no SGs association with a VLR for the UE and therefore the MME considers that the UE is IMSI detached for non-EPS services. In this state the MME accepts SGsAP-PAGING-REQUEST messages to UEs only if: + +- the "MME-Reset" restoration indicator in the MME is set to "true"; or +- the MME supports the CS restoration indicator set in the Additional paging indicators information element in the SGs-PAGING-REQUEST message. + +#### LA-UPDATE-REQUESTED + +The MME has sent an SGsAP-LOCATION-UPDATE-REQUEST message to the VLR. In this state the MME waits for the outcome of the Update Location for non-EPS services procedure at the VLR before sending the response to the UE. In this state the MME accepts SGsAP-PAGING-REQUEST messages. + +#### SGs-ASSOCIATED + +The MME stores an SGs association for the UE. In this state the MME performs the location update for non-EPS services procedure towards the VLR, e.g. when the location area is changed. All conditions describing when to trigger the location update for non-EPS services procedure are listed in subclause 5.2.2.2. + +![Figure 4.3.3.1: State diagram at the MME. Shows states SGs-NULL, LA-UPDATE-REQUESTED, and SGs-ASSOCIATED with various transition triggers like MME failure, Paging received, and Location Update messages.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +stateDiagram-v2 + direction TB + state "From one of\nthe three states\n(at the MME)" as Start + state "SGs-\nNULL" as NULL + state "LA-UPDATE-\nREQUESTED" as LA_REQ + state "SGs-\nASSOCIATED" as ASSOC + + Start --> NULL : MME failure + Start --> NULL : Send any detach indication\nto the VLR + NULL --> NULL : Paging\nreceived + NULL --> LA_REQ : Send Location\nUpdate Request to\nthe VLR + LA_REQ --> NULL : Location\nUpdate Reject\nreceived + LA_REQ --> LA_REQ : Paging\nreceived + LA_REQ --> ASSOC : Location\nUpdate Accept\nreceived + NULL --> ASSOC : Normal tracking area\nupdate request\nreceived from the UE + NULL --> ASSOC : Periodic tracking area\nupdate request\nreceived from the UE\nwith conditions listed\nin subclause 5.2.2.2. + NULL --> ASSOC : [Any other case]\nCombined tracking area\nupdate request or periodic\ntracking area update request\nreceived from the UE + ASSOC --> NULL : Combined tracking\narea update request\nreceived from the UE\nwith conditions listed\nin subclause 5.2.2.2. + ASSOC --> ASSOC : Paging\nreceived + ASSOC --> ASSOC : Send SGsAP-UE-\nUNREACHABLE message + ASSOC --> ASSOC : Send TMSI\nReallocation + +``` + +Figure 4.3.3.1: State diagram at the MME. Shows states SGs-NULL, LA-UPDATE-REQUESTED, and SGs-ASSOCIATED with various transition triggers like MME failure, Paging received, and Location Update messages. + +**Figure 4.3.3.1: State diagram at the MME** + +### 4.3.4 State transitions in the MME without SGsAP signalling + +During the tracking area update procedure or routing area update procedure (see 3GPP TS 23.401 [7B]) and if the SGs association is not SGs-NULL, the MME may change the state of the SGs association to SGs-NULL upon receipt of a SGSN Context Acknowledge (see 3GPP TS 29.060 [16A]) or Context Acknowledge message without ISR activation (see 3GPP TS 29.274 [17A]) from the target network. + +During the inter-system handover from S1 mode to A/Gb mode or Iu mode, or handover from S1 mode to S1 mode (see 3GPP TS 23.401 [7B]) and if the SGs association is not SGs-NULL, the MME may change the state of the SGs association to SGs-NULL upon receipt of a Forward Relocation Complete (see 3GPP TS 29.060 [16A]) or Forward Relocation Complete Notification message without ISR activation (see 3GPP TS 29.274 [17A]) from the target network. + +If the MME receives a normal attach request, attach request for emergency bearer services or a normal tracking area update request from the UE in state SGs-ASSOCIATED, the MME shall change the state of the SGs association to SGs-NULL. + +If it is required by network configuration or operator policy, the MME shall change the state of the SGs association to SGs-NULL if the following conditions are fulfilled: + +- the MME receives an EXTENDED SERVICE REQUEST message with service type set to "mobile originating CS fallback emergency call or 1xCS fallback emergency call"; +- the state of the SGs association is not SGs-NULL; and +- the MME determines that the UE is not available for PS services at the target RAT as described in 3GPP TS 23.272 [7]. + +### 4.3.5 State transitions in the VLR without SGsAP signalling + +Based on configuration, during PS to CS SRVCC from E-UTRAN (see 3GPP TS 23.216 [26]) and if the SGs association is not SGs-NULL, the VLR may change the state of the SGs association to SGs-NULL upon receipt of a Relocation Complete/Handover Complete message from target RNS/BSS. + +# 5 Procedures for SGs + +## 5.1 Paging for non-EPS services procedure + +### 5.1.1 General description + +This procedure is used by the VLR to send an SGsAP-PAGING-REQUEST message to a UE. This procedure applies to UEs that are simultaneously attached for EPS services and non-EPS services, or for EPS services and SMS only. + +### 5.1.2 Procedures in the VLR + +#### 5.1.2.1 General + +The VLR shall handle the timers, queuing and retransmission for sending the SGsAP-PAGING-REQUEST message on the SGs interface in the same way that it handles the sending of a PAGING message on the A or Iu interface. + +#### 5.1.2.2 Paging Initiation + +When a VLR has to page a UE, the VLR shall check whether the VLR has a SGs association for that UE. The VLR sends SGsAP-PAGING-REQUEST messages to the MME if the MME is in service and the state of the SGs association for the UE is in any of the following states: + +- SGs-ASSOCIATED; +- LA-UPDATE-PRESENT or +- SGs-NULL and the "Confirmed by Radio Contact" restoration indicator is set to "false". + +If the VLR detects that the MME serving the UE is no longer in service and the VLR supports MT CS services delivery via an alternative MME in the MME pool as defined in 3GPP TS 23.007 [4], the VLR shall send the SGs-PAGING-REQUEST message to one alternative MME in the same MME pool. The VLR shall set the CS restoration indicator in the Additional paging indicators information element. + +NOTE 1: The VLR can detect that an MME is no longer in service if there are no SCTP associations in service with that MME. + +The sending of the SGsAP-PAGING-REQUEST message does not change the state of the SGs association with the MME. + +If the "Confirmed by Radio Contact" restoration indicator is set to "true", the VLR shall include the Location area identifier information element into the SGsAP-PAGING-REQUEST message, otherwise (i.e. after a VLR failure), the VLR shall not include the Location area identifier information element. When sending the SGsAP-PAGING-REQUEST message, the VLR shall start timer Ts5. + +If the state of the SGs association is SGs-NULL and the "Confirmed by Radio Contact" restoration indicator is set to "false", the VLR shall also perform a search procedure as specified in 3GPP TS 23.018 [5]. + +In this message, the VLR includes the Service indicator information element which will be used to indicate the type of CS service. If the SGs paging request is sent as a result of reception of Provide Subscriber Information Request message, the VLR sets the Service indicator information element to either "SMS indicator" or "CS call indicator" as specified in subclause 7.2.3.5 of 3GPP TS 23.018 [5]. For SMS, SMS indicator is used. For all the other CS services, CS call indicator is used. + +If the network supports CSFB priority call handling (see 3GPP TS 23.272 [7]) and the call was received with an eMLPP priority level indication (see 3GPP TS 24.008 [8], 3GPP TS 22.067 [24] and 3GPP TS 23.067 [25]), the VLR shall include the value of the received priority level indication in the eMLPP priority information element in the SGsAP-PAGING-REQUEST message. + +The eMLPP priority information element may be used to derive the appropriate priority of a SCTP association for the SGsAP-PAGING-REQUEST message. + +If the Calling Line Identification of the service (see 3GPP TS 24.081 [12]) is available in the VLR, the VLR may include the CLI information element in the SGsAP-PAGING-REQUEST message. The conditions specified in 3GPP TS 23.081 [5A] and 3GPP TS 29.011 [15A] apply also here. + +If the paging is due to a NW-initiated Call Independent SS procedure as defined in 3GPP TS 24.010 [9], the VLR may include the SS code in the SGsAP-PAGING-REQUEST message as defined in 3GPP TS 29.002 [15]. + +NOTE 2: The SS code used by the VLR does not link to a specific supplementary service. The VLR can use any SS code defined in 3GPP TS 29.002 [15], in the SGsAP-PAGING-REQUEST message. + +If the paging is due to a Mobile Terminated Location Request as defined in 3GPP TS 24.030 [11], the VLR shall include LCS indicator in the SGsAP-PAGING-REQUEST message. Additionally, the VLR may include LCS client identity as defined in 3GPP TS 29.002 [15] in the SGsAP-PAGING-REQUEST message. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the paging was due to SMS and the SM Delivery Timer and SM Delivery Start Time IEs were received from the SMS-GMSC as defined in 3GPP TS 29.002 [15], the VLR may include these IEs in the SGsAP-PAGING-REQUEST message. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the paging was due to SMS and the Maximum Retransmission Time IE was received from the SMS-GMSC as defined in 3GPP TS 29.002 [15], the VLR may include the received Maximum Retransmission Time IE in the SGsAP-PAGING-REQUEST message. + +While domain specific access control of the PS domain is ongoing, the VLR shall be configured to send paging messages on both the SGs and the A/Iu interface. + +The VLR may apply implementation specific rules for sending the paging on the A/Iu interface. Dependent on network configuration or operator policy, if the UE does not respond to a first paging on SGs interface or the VLR considers UE fallback was failed as described in subclause 5.15.1, and A/Iu paging has not been initiated already, the VLR shall page on the A/Iu interface. + +#### 5.1.2.3 Paging Response + +The VLR stops the paging procedure towards the MME on expiry of timer Ts5 or on receipt of a SGsAP-SERVICE-REQUEST message from the MME. + +On receipt of an SCCP connection establishment containing the Initial L3 message from the UE via the A or Iu interface, the VLR shall stop the paging procedure. + +Upon receiving the SGsAP-SERVICE-REQUEST message with the UE EMM mode information element indicating "EMM-CONNECTED", if the Service indicator information element in the SGsAP-SERVICE-REQUEST message indicates "CS call indicator" and Call Forwarding on No Reply (CFNRy) is activated for the subscriber, the VLR shall start the CFNRy timer as specified in 3GPP TS 23.082 [5B]. + +If the paging response is received via the A or Iu interface from a location area which differs from the one stored in the VLR, the VLR shall move the SGs association to the SGs-NULL state after the UE has been authenticated successfully. + +NOTE 2: UE sends this paging response as a result of receiving paging request with IMSI and with CN domain indicator set to "CS" (see 3GPP TS 24.301 [14]). + +#### 5.1.2.4 Paging Failure + +On receipt of an SGsAP-PAGING-REJECT message before the timer Ts5 expires, the VLR stops timer Ts5. If the SGs cause information element in the SGsAP-PAGING-REJECT message does not indicate "Mobile terminating CS fallback call rejected by the user", the SGs association is moved to the SGs-NULL state and within this state the SGs association is marked with the contents of the SGs cause information element. If the SGs cause information element in the SGsAP-PAGING-REJECT message indicates "IMSI detached for EPS services" the VLR shall send the paging message on the A/Iu interface. If the SGs cause information element indicates "Mobile terminating CS fallback call rejected by the user", the SGs association state shall not be changed. + +When the VLR receives the SGsAP-PAGING-REJECT message with the SGs cause information element indicating "Mobile terminating CS fallback call rejected by the user", the VLR shall trigger User Determined User Busy (UDUB) as specified in 3GPP TS 24.082 [13]. + +#### 5.1.2.5 UE unreachable + +On receipt of an SGsAP-UE-UNREACHABLE message before the timer Ts5 expires, the VLR stops timer Ts5, and the paging procedure for that paging request towards the MME is stopped. The state of the SGs association at the VLR is unchanged. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the paging was due to SMS and the VLR included the SM-Delivery-Timer and SM-Delivery-Start-Time IEs in the SGsAP-PAGING-REQUEST, and if the SM Buffer Request Indicator bit is set in the Additional UE Unreachable indicators IE in the SGsAP\_UE\_UNREACHABLE message, the VLR may buffer the Short Message until the time indicated in the SGsAP-PAGING-REQUEST or until receipt of any earlier SGsAP message for the UE. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the Retransmission Time IE was included in the SGsAP-UE-UNREACHABLE message, the VLR may forward the received Requested Retransmission Time IE to the SMS-GMSC as defined in 3GPP TS 29.002 [15]. In this case, the VLR shall not set the MNRF flag. + +NOTE 1: A/Iu paging can be ongoing. + +NOTE 2: If the VLR considers the paging procedure completed, and no response from the UE has been received, and CFNRc has been configured and activated for the terminating UE, the VLR applies the equivalent handling as for Call Forwarding on Not Reachable, as specified in 3GPP TS 23.082 [5B] and 3GPP TS 29.011 [15A]. + +### 5.1.3 Procedures in the MME + +#### 5.1.3.1 General + +The MME accepts SGsAP-PAGING-REQUEST messages in any state of the SGs association. In the SGs-NULL state, the MME accepts SGsAP-PAGING-REQUEST messages only if: + +- the "MME-Reset" restoration indicator is set to "true"; or +- the MME supports MT CS services delivery via an alternative MME in the MME pool as defined in 3GPP TS 23.007 [4] and the CS restoration indicator is set in the Additional paging indicators information element in the SGs-PAGING-REQUEST message. + +When a MME receives a SGsAP-PAGING-REQUEST message from a VLR, the MME shall first check if the UE is known by the MME. The handling of the paging request depends on the state of the SGs association, the EMM context variables at the MME, and the Service indicator information element in the SGsAP-PAGING-REQUEST message. The MME shall process the paging request and subsequent SGs procedures related to this request preferentially compared to other normal procedures if the SGsAP-PAGING-REQUEST message includes the eMLPP priority information element and if the MME determines the CS call has high priority based on the received value in the eMLPP priority information element (see 3GPP TS 23.272 [7]). + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "CS call indicator", the MME shall handle the paging request as follows: + +- If the UE is known: + - if the UE is considered to be IMSI attached for EPS services and "SMS only", the MME shall return an SGsAP-PAGING-REJECT message to the VLR indicating in the SGs cause information element "Mobile terminating CS fallback call rejected by the user"; + - if the UE is considered to be IMSI attached for EPS and non-EPS services (i.e. the SGs association is not in the state SGs-NULL), the MME shall page the UE based on the location information stored in the MME, i.e. in all tracking areas of the stored list. If the SGsAP-PAGING-REQUEST message does not include the Location area identifier information element, the MME may set the "VLR-Reliable" MM context variable to "false". If ISR is activated, and in addition the SGsAP-PAGING-REQUEST message does not include the Location area identifier or the "VLR-Reliable" MM context variable in the MME is set to "false", then the MME shall send Detach Notification (Local Detach) message to the associated SGSN; + - if the MME detects that the UE currently has an ongoing IMS emergency session as specified in subclause 4.6a, 3GPP TS 23.272 [7], the MME shall return an SGsAP-PAGING-REJECT message to the + +VLR indicating in the SGs cause information element "Mobile terminating CS fallback call rejected by the user"; + +- if the MME detects that the UE currently has an EPS bearer context with QCI=1 and the MME determines that SRVCC (as specified in 3GPP TS 23.216 [26]) is not supported in the network or it determines that the UE does not support SRVCC, MME shall return SGsAP-PAGING-REJECT message to that VLR with SGs cause information element "Mobile terminating CS fallback call rejected by the user"; +- if the UE is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services (i.e. the state of the SGs association is SGs-NULL): + - if the UE is in the EMM-DEREGISTERED state (see 3GPP TS 24.301 [14]) and if the MME supports MT CS services delivery via an alternative MME in the MME pool and the CS restoration indicator is set in the SGsAP-PAGING-REQUEST message, the MME shall send the paging request with the location information provided by the VLR, regardless of the value of the "MME-Reset" indicator. If no such location information is provided, the MME may either page the UE in all the tracking areas served by that MME or in the tracking areas served by the MME and by the VLR, or reject the paging request per operator policy; + - otherwise, the MME shall return an SGsAP-PAGING-REJECT message to that VLR indicating in the SGs cause information element the detach circumstance ("IMSI detached for EPS services", "IMSI detached for non-EPS services" or "IMSI implicitly detached for non-EPS services"); +- if the UE is marked as unreachable, indicated by Paging Proceed Flag set to "false", and the ISR is not activated, the MME shall return an SGsAP-UE-UNREACHABLE message to that VLR indicating in the SGs cause information element "UE unreachable". The state of the SGs association does not change at the MME; or +- if the UE is marked as unreachable, indicated by Paging Proceed Flag set to "false", and the ISR is activated, the MME shall not return an SGsAP-UE-UNREACHABLE message to that VLR. If the SGsAP-PAGING-REQUEST message does not include the Location area identifier or the "VLR-Reliable" MM context variable in the MME is set to "false", then the MME shall send Detach Notification (Local Detach) message to the associated SGSN; Otherwise the MME shall forward the paging request to the associated SGSN, as described in 3GPP TS 29.274 [17A]. + +b) If the UE is not known and the "MME-Reset" restoration indicator at the MME is set to "false" and if: + +- the MME does not support MT CS services delivery via an alternative MME in the MME pool; or +- the MME supports MT CS services delivery via an alternative MME in the MME pool and the CS restoration indicator is not set in the SGsAP-PAGING-REQUEST message; + +the MME shall handle the paging request as follows: + +- the MME shall return an SGsAP-PAGING-REJECT message to that VLR indicating in the SGs cause information element "IMSI unknown". + +c) If the UE is not known and if: + +- the "MME-Reset" restoration indicator at the MME is set to "true"; or +- the MME supports MT CS services delivery via an alternative MME in the MME pool and the CS restoration indicator is set in the SGsAP-PAGING-REQUEST message; + +the MME shall handle the paging request as follows: + +- if the MME only supports "SMS only", the MME shall return an SGsAP-PAGING-REJECT message to the VLR indicating in the SGs cause information element "Mobile terminating CS fallback call rejected by the user"; +- if the SGsAP-PAGING-REQUEST message includes the Location area identifier information element, the MME shall page the UE in all the tracking areas served by the MME that can be mapped to the location area indicated in the Location area identifier information element; or + +- if the SGsAP-PAGING-REQUEST message does not include the Location area identifier information element, the MME may page in all the tracking areas served by the MME, or the tracking areas served by the MME and by the VLR or reject the paging request per operator policy. + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "SMS indicator", the MME shall handle the paging request as follows: + +a) If the UE is known: + +- if the UE is considered to be IMSI attached for EPS and non-EPS services or IMSI attached for EPS services and "SMS only", the MME shall page the UE based on the location information stored in the MME. If the SGsAP-PAGING-REQUEST message does not include the Location area identifier information element, the MME may set the "VLR-Reliable" MM context variable to "false". If the UE is using eDRX, the MME may, subject to local operator policy, return an SGsAP-UE-UNREACHABLE message to the VLR indicating in the SGs cause information element "UE temporarily unreachable" while continuing to page the UE. If ISR is activated, and in addition the SGsAP-PAGING-REQUEST message does not include the Location area identifier or the "VLR-Reliable" MM context variable in the MME is set to "false", then the MME shall send Detach Notification (Local Detach) message to the associated SGSN; or + +NOTE 2: If location area identifier information element is included in the SGsAP-PAGING-REQUEST, it is not used in paging the UE. + +- for Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the UE is using eDRX, the SGsAP-PAGING-REQUEST message includes the SM Delivery Timer and SM Delivery Start Time IEs, and the UE is expected to be reachable before the time indicated by the SM-Delivery-Timer and SM-Delivery-Start-Time IEs, the MME may return an SGsAP-UE-UNREACHABLE message to the VLR indicating in the SGs cause information element "UE temporarily unreachable" and setting the SM Buffer Request Indicator bit in the Additional UE Unreachable indicators information element. The state of the SGs association does not change at the MME. The MME should then page the UE when the UE is expected to be reachable. +- for Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the UE is using eDRX and the SGsAP-PAGING-REQUEST message includes the Maximum Retransmission Time IEs, the MME may return an SGsAP-UE-UNREACHABLE message to that VLR indicating in the SGs cause information element "UE temporarily unreachable" and including the Requested Retransmission Time IE. In this case, the MME shall set the NEAF. The state of the SGs association does not change at the MME. + +NOTE 3: This mechanism does not cause additional signalling at the HLR to retransmit the Short Message. + +- if the UE is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services, or as unreachable, the MME shall proceed as specified for the case when the service indicator indicates "CS call indicator". + +b) If the UE is not known and the "MME-Reset" restoration indicator at the MME is set to "false" and if: + +- the MME does not support MT CS services delivery via an alternative MME in the MME pool; or +- the MME supports MT CS services delivery via an alternative MME in the MME pool and the CS restoration indicator is not set in the SGsAP-PAGING-REQUEST message; + +the MME shall handle the paging request as follows: + +- the MME shall return an SGsAP-PAGING-REJECT message to that VLR indicating in the SGs cause information element "IMSI unknown". + +c) If the UE is not known and if: + +- the "MME-Reset" restoration indicator at the MME is set to "true"; or +- the MME supports MT CS services delivery via an alternative MME in the MME pool and the CS restoration indicator is set in the SGsAP-PAGING-REQUEST message; + +the MME shall handle the paging request as follows: + +- if the SGsAP-PAGING-REQUEST message includes the Location area identifier information element, the MME shall page the UE in all the tracking areas served by the MME that can be mapped to the location area indicated in the Location area identifier information element; or + +- if the SGsAP-PAGING-REQUEST message does not include the Location area identifier information element, the MME may page in all the tracking areas served by the MME, or the tracking areas served by the MME and by the VLR or reject the paging request per operator policy. + +#### 5.1.3.2 Procedure when no NAS signalling connection exists + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "CS call indicator" and the MME accepts the paging request, the MME shall proceed as follows: + +- If the SGsAP-PAGING-REQUEST message includes the Location area identifier and the "VLR-Reliable" MM context variable in the MME is set to "true": +- if the UE is considered to be IMSI attached for EPS and non-EPS services, the MME pages the UE with CN domain indicator set to "CS". + +if + +- the SGsAP-PAGING-REQUEST message includes the IMSI without TMSI and the location area stored in the MME is the same as the one received in the SGsAP-PAGING-REQUEST message and S-TMSI can be retrieved, and the operator's policy allows the use of S-TMSI as paging address; or + +NOTE: The operator's policy is related to MSC pool in target RAT. + +- the SGsAP-PAGING-REQUEST message includes the TMSI and the location area stored in the MME is the same as the one received in the SGsAP-PAGING-REQUEST message; + +then the MME uses the S-TMSI as paging address at the radio interface; else the MME uses the IMSI; and + +- if the UE is not known, or is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services, the MME pages the UE with IMSI and CN domain indicator set to "PS". +- If the SGsAP-PAGING-REQUEST message does not include the Location area identifier, or the "VLR-Reliable" MM context variable in the MME is set to "false": +- if the UE is considered to be IMSI attached for EPS and non-EPS services, the MME uses IMSI as a paging address at the radio interface and CN domain indicator set to "CS". When the MME receives the paging response from the UE, the MME requests the UE to re-attach for non-EPS services as described in 3GPP TS 24.301 [14]; and +- if the UE is not known, or is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services, the MME pages the UE with IMSI with CN domain indicator set to "PS" to force the UE to re-attach to EPS and non-EPS services as described in 3GPP TS 24.301 [14]. + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "SMS indicator" and the MME accepts the paging request, the MME shall proceed as follows: + +- If the SGsAP-PAGING-REQUEST message includes the Location area identifier and the "VLR-Reliable" MM context variable in the MME is set to "true": +- if the UE is considered to be IMSI attached for EPS and non-EPS services or IMSI attached for EPS services and "SMS only", the MME shall use the S-TMSI as paging address at the radio interface with CN domain indicator set to "PS". The MME takes action as described in 3GPP TS 24.301 [14], subclause 5.6.2.4; and +- if the UE is not known, or is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services, the MME pages the UE with IMSI as paging address at the radio interface with CN domain indicator set to "PS". The MME takes action as described in 3GPP TS 24.301 [14], subclause 5.6.2.4. +- If the SGsAP-PAGING-REQUEST message does not include the Location area identifier information element or the "VLR-Reliable" MM context variable is set to "false": +- if the UE is considered to be IMSI attached for EPS and non-EPS services or IMSI attached for EPS services and for "SMS only", the MME uses S-TMSI as paging address at the radio interface with CN domain indicator set to "PS". When the MME receives the paging response from the UE, the MME requests the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14]; and + +- if the UE is not known, or is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services, the MME pages the UE with IMSI with CN domain indicator set to "PS" to force the UE to re-attach to EPS and non-EPS services as described in 3GPP TS 24.301 [14]. + +Independent of the Service indicator information element, if the MME has activated Idle mode Signalling Reduction for the UE, the MME shall forward the paging request to the associated SGSN, as described in 3GPP TS 29.274 [17A]. + +Independent of the Service indicator information element, the MME shall not retransmit the paging message to the UE. Additionally, if the MME has activated Idle mode Signalling Reduction for the UE, the MME shall not retransmit the paging request to the associated SGSN. + +#### 5.1.3.3 Procedure when a NAS signalling connection exists + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "CS call indicator" and the MME accepts the paging request, the MME shall proceed as follows: + +- The MME requests the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14] if the SGsAP-PAGING-REQUEST message does not include the Location area identifier, or the "VLR-Reliable" MM context variable in the MME is set to "false"; and +- otherwise, the MME sends the CS SERVICE NOTIFICATION message to the UE through the NAS signalling connection, including the CS service related parameters (CLI, SS code, LCS indicator and LCS client identity), received from the VLR. + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "SMS indicator" and the MME accepts the paging request, the MME shall proceed as follows: + +- If the Location area identifier information element is not included in the SGsAP-PAGING-REQUEST message or the "VLR-Reliable" MM context variable is set to "false", the MME requests the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14]; and +- otherwise, the MME need not take any action towards the UE. + +## 5.2 Location update for non-EPS services procedure + +### 5.2.1 General description + +The location update for non-EPS services procedure is a general procedure used by UEs which are configured to use CS fallback and SMS over SGs, or SMS over SGs only. This procedure is not performed if: + +- the subscriber data indicates that the subscription is for packet only; or +- the MME is registered for SMS for the UE (see 3GPP TS 23.272 [7]). + +NOTE: For the cases specified above, the registration with a VLR is not required and the MME does not initiate the location update for non-EPS services procedure. + +This procedure allows UEs and the network to perform: + +- combined IMSI attach for EPS and non-EPS services or for SMS only; +- IMSI attach for non-EPS services or for SMS only if the UE is already IMSI attached for EPS services; +- normal location update procedure to the VLR if the UE is IMSI attached for both EPS and non-EPS services, or for SMS only; or +- allocation of new TMSI to an UE. + +The location update for non-EPS services procedure in the SGs interface is always started as a consequence of a direct action from the UE. The combined attach and tracking area update procedures are further specified in 3GPP TS 23.272 [7] and 3GPP TS 24.301 [14]. + +When a UE is IMSI attached for EPS and non-EPS services, the VLR shall stop any implicit detach timer. Instead the MME uses the "Paging Proceed Flag" to determine the likely availability of the UE to the network. Upon reception of the periodic Tracking Area Update message, the MME does not report to the VLR, and the MME shall not change the state of the SGs association. When the UE performs a detach only for EPS services or the MME performs an implicit detach for EPS services, and the VLR's implicit detach timer is not already running, the EPS detach indication to the VLR shall cause the VLR's implicit detach timer to be restarted from its initial value. + +If the MME performs an implicit detach for both EPS and non-EPS services, then the MME shall send to the VLR an SGsAP-IMSI-DETACH-INDICATION message with cause "Implicit network initiated IMSI detach from EPS and non-EPS services", as further described in subclause 5.6 (the implicit IMSI detach message indicates that the UE is unavailable for both EPS and non-EPS services). + +### 5.2.2 Procedures in the MME + +#### 5.2.2.1 General + +The location update for non-EPS services procedure is initiated with a combined attach or a combined tracking area update procedure. On receipt of an ATTACH REQUEST message or a TRACKING AREA UPDATE REQUEST message from the UE, the MME handles the EPS related request as specified in 3GPP TS 24.301 [14]. + +When the MME receives the Update Location Answer message containing subscription data from the HSS, the MME determines whether it needs to perform location update for non-EPS services procedure. For the cases identified below, if the MME is configured with ability not to perform registrations with a VLR for the UE, the MME sends response message to the UE without starting the location update for non-EPS services procedure: + +- if the Network Access Mode (NAM) subscription data indicates that the subscription is for packet only (see 3GPP TS 29.272 [17]); or +- if the Network Access Mode (NAM) subscription data indicates that the subscription is for packet and circuit (see 3GPP TS 29.272 [17]) and the MME is registered for SMS as specified in annex C of 3GPP TS 23.272 [7] for this UE. + +NOTE 1: When the MME supports both SMS in MME feature and SMS over SGs, depending on UE capability and/or network configuration and/or "PS and SMS only" subscription, it can be preferred to provide SMS services via SMS in MME to avoid the VLR registration. + +Otherwise, the MME shall start the location update for non-EPS services procedure and shall wait for the outcome of both location update procedures towards the VLR and the HSS before sending the response message to the UE. + +NOTE 2: When the combined attach or tracking area update procedure is for both EPS services and non-EPS services and the MME is not registered for SMS for the UE (see 3GPP TS 23.272 [7]) and the UE has "PS and SMS only" subscription, the MME starts the location update for non-EPS services procedure for SMS over SGs only. + +#### 5.2.2.2 Location update initiation + +##### 5.2.2.2.1 General + +If timer Ts6-1 is not running, the MME shall start the location update for non-EPS services procedure when it receives from the UE: + +- an attach request indicating combined EPS/IMSI attach; +- a combined tracking area update request indicating Combined TA/LA updating with IMSI attach; +- a combined tracking area update request and the MME detects that the LAI has changed; +- a combined tracking area update request and the state of the SGs association is SGs-NULL; or +- a combined tracking area update request and the MME serving the UE has changed. + +If timer Ts6-1 is not running, the MME may start the location update for non-EPS services procedure when it receives from the UE: + +- a combined tracking area update request or a periodic tracking area update , if the MM context variable "VLR-Reliable" for the UE is set to "false" (see subclause 5.7.3). + +If multiple PLMNs are available for the CS domain, the MME shall select a PLMN for CS domain as specified in 3GPP TS 23.272 [7]. If the MME cannot select any PLMN for CS domain for the UE, the MME informs the UE that the CS domain is not available. + +The MME shall determine the new location area identification as follows: + +- if the MME received a combined attach request or combined tracking area update request from the UE with an indication for "SMS only", or the network only supports "SMS only" or the network only has a few VLRs that support SGs interface, the MME may allocate a default location area identification specifically configured for that case; +- else the MME derives the location area identification from the current tracking area identity where the UE is located. For this the MME may take any access restrictions provided by the HSS into account, if the network is using separate location areas for GERAN and UTRAN cells. + +The MME shall derive the VLR name from the location area identification which was determined. For networks supporting the feature 'Intra Domain Connection of RAN Nodes to Multiple CN Nodes', the VLR name is derived as described in 3GPP TS 23.236 [6A]. The MME shall include the location area identification in the new location area identifier information element in the SGsAP-LOCATION-UPDATE-REQUEST message. + +NOTE 1: The selection of the VLR in the MME follows the same rule as the selection of the VLR in the SGSN, as defined in 3GPP TS 23.236 [6A]. + +In networks supporting the feature 'Intra Domain Connection of RAN Nodes to Multiple CN Nodes' (3GPP TS 23.236 [6A]), if the TMSI based NRI container is not received from the UE, and the MME determines that the serving VLR of the UE is changed, the MME shall include in the Old location area identifier a specific LAI value which is not broadcasted in the network and not associated with any VLR. + +NOTE 2: The MME determines that the serving VLR of the UE is changed when the SGs association changes from one serving VLR to a different one, or based on implementation dependent criteria. + +NOTE 3: When the VLR receives the SGsAP-LOCATION-UPDATE-REQUEST message with the specific LAI value, the VLR retrieves the MM context of the UE from the HLR. + +In networks supporting the feature "Intra Domain Connection of RAN Nodes to Multiple CN Nodes" as defined in 3GPP TS 23.236 [6A], the MME shall support load re-distribution of UEs to another VLR than the current one. When the MME receives a periodic tracking area update request or a combined tracking area update request, the MME shall check whether for this UE there is a SGs association to a VLR for which load re-distribution has been initiated in the MME by O&M. If this is the case and + +- if a combined tracking area update request is received, the MME shall derive the new VLR name as described in 3GPP TS 23.236 [6A] and then send the SGsAP-LOCATION-UPDATE-REQUEST message to the new selected VLR; or +- if a periodic tracking area update request is received, dependent on network configuration and operator policy, the MME shall take one of the following actions: + - perform a network initiated detach with detach type "IMSI detach" immediately after the completion of the periodic tracking area update procedure; or + - derive the new VLR name as described in 3GPP TS 23.236 [6A] and then send the SGsAP-LOCATION-UPDATE-REQUEST message to the new selected VLR. + +If the VLR is configured for gateway core network (GWCN), the MME shall select a CS domain operator as specified in 3GPP TS 23.272 [7] and proceed as follows: + +- If the preferred RAT of the selected CS domain operator is GERAN and the UE does not support GERAN network sharing (see 3GPP TS 24.008 [8], subclause 10.5.5.12), the MME shall include the selected CS domain operator in the selected CS domain operator information element, and the common PLMN in the new location area identifier information element in the SGsAP-LOCATION-UPDATE-REQUEST message; or + +- If only common PLMN ID and no multiple PLMN IDs are provided in CS domain for selection by the UE (see 3GPP TS 23.251 [7A], subclause 4.2.3.1), the MME shall include the selected CS domain operator in the selected CS domain operator information element, and the common PLMN in the new location area identifier information element in the SGsAP-LOCATION-UPDATE-REQUEST message. + +If multiple PLMN IDs are provided in CS domain for selection by the UE and the UE supports GERAN network sharing (see 3GPP TS 24.008 [8], subclause 10.5.5.12), the MME shall include the selected PLMN for CS domain in the new location area identifier information element as specified in 3GPP TS 23.251 [7A]. + +The SGsAP-LOCATION-UPDATE-REQUEST message includes the type of location update performed by the UE in the EPS location update type information element. If the UE has performed a combined attach or a combined tracking area update indicating "combined TA/LA updating with IMSI attach", the MME indicates "IMSI attach", otherwise the MME indicates "Normal location update". + +The MME shall include the TMSI status in the SGsAP-LOCATION-UPDATE-REQUEST message if the UE indicates in the ATTACH REQUEST or the TRACKING AREA UPDATE REQUEST message that it has no valid TMSI available. The MME shall also include the old location area identifier in the SGsAP-LOCATION-UPDATE-REQUEST message if the UE included the old location area identification in the ATTACH REQUEST or TRACKING AREA UPDATE REQUEST message. + +The MME shall include the TMSI based NRI container in the SGsAP-LOCATION-UPDATE-REQUEST message if received from the UE. + +If the MME supports the "Automatic Device Detection" (see 3GPP TS 22.101 [2]) or the "Trace for Management Based Activation/Deactivation" (see 3GPP TS 32.422 [18]), the MME shall include the IMEISV in the SGsAP-LOCATION-UPDATE-REQUEST message. + +The MME shall add the UE's current TAI and E-CGI to the SGsAP-LOCATION-UPDATE-REQUEST message. + +When the MME sends the SGsAP-LOCATION-UPDATE-REQUEST, the MME shall start timer Ts6-1. + +If timer Ts6-1 is running and the MME receives from the UE: + +- an attach request indicating combined EPS/IMSI attach; or +- a combined tracking area update with or without IMSI attach. + +Then: + +- if the LAI determined by the MME is the same as in the outstanding request, the MME shall not process this new request and shall wait for the VLR response to the ongoing procedure; +- if the LAI determined by the MME is different but the VLR name is the same as for previous LAI, any response from the VLR to the outstanding request is ignored, the MME shall stop and reset timer Ts6-1 and the MME shall start the location update for non-EPS services procedure; or +- if the LAI determined by the MME is different and the VLR name is different as for previous LAI, any response from the previously addressed VLR to the outstanding request is ignored, the MME shall stop and reset timer Ts6-1, and the MME shall start the location update for non-EPS services procedure. + +When the MME receives from the UE a tracking area update request and the MME serving the UE has changed, the MME shall stop and reset timer Ts6-1. + +##### 5.2.2.2.2 VLR fails without restart + +If the MME supports restoration for CS services via an alternative VLR as defined in 3GPP TS 23.007 [4] and, upon reception of a combined tracking area update request or a periodic tracking area update request from the UE, the MME determines that the VLR serving the UE is no longer in service, the MME may: + +- if a combined tracking area update request is received, select an alternative VLR that is in service for the UE and immediately perform the location update for non-EPS services procedure towards the selected VLR as described in subclause 5.2; or +- if a periodic tracking area update request is received, dependent on network configuration and operator policy, + +- perform a network initiated detach with detach type "IMSI detach" immediately after the completion of the periodic tracking area update procedure and then select an alternative VLR that is in service for the UE during the subsequent combined tracking area update procedure, before performing the location update for non-EPS services procedure towards the selected VLR as described in subclause 5.2; or +- select an alternative VLR that is in service for the UE and immediately perform the location update for non-EPS services procedure towards the selected VLR as described in subclause 5.2. + +If the MME supports restoration for CS services via an alternative VLR as defined in 3GPP TS 23.007 [4] and, upon reception of an UPLINK NAS TRANSPORT message (see 3GPP TS 24.301 [14]) from the UE, the MME determines that the VLR serving the UE is no longer in service, the MME may: + +- request the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14] and then select an alternative VLR that is in service for the UE during the subsequent combined tracking area update procedure, before performing the location update for non-EPS services procedure towards the selected VLR as described in subclause 5.2. + +NOTE 1: How an MME detects a VLR is no longer in service and triggers selection of alternative VLR is implementation dependent. + +NOTE 2: To avoid large amounts of UEs initiating re-attach for non-EPS services simultaneously, the MME can ignore some MO-SMS. Selection of MO-SMS to ignore is implementation dependent. + +#### 5.2.2.3 Location update response + +If the MME receives an SGsAP-LOCATION-UPDATE-ACCEPT message from the VLR, the MME shall stop timer Ts6-1 and: + +- move the state of the SGs association to SGs-ASSOCIATED; +- set the MM context variable "VLR-Reliable" to "true"; and +- indicate to the UE the acceptance of the VLR to the location update procedure. The message sent to the UE includes the Location Area Identity (see 3GPP TS 24.301 [14]). + +The MME shall wait for the outcome of the location update for non-EPS services procedure towards the VLR before sending a response to location update procedure to the UE. When the MME receives an SGsAP-LOCATION-UPDATE-REJECT message from the VLR, it will map the reject cause received to the appropriate reject cause as specified in 3GPP TS 24.301 [14], and report this reject cause to the UE. + +If the VLR included the Mobile identity information element in the SGsAP-LOCATION-UPDATE-ACCEPT message, the MME shall relay the information received to the UE. If the Mobile identity information element contains a new TMSI, this will cause the UE to perform a TMSI reallocation procedure. In this case, the MME shall send to the VLR the SGsAP-TMSI-REALLOCATION-COMPLETE message when the MME receives the ATTACH COMPLETE or the TRACKING AREA UPDATE COMPLETE message from the UE. If the Mobile identity information element contains an IMSI, this will cause the UE to deallocate its TMSI. + +#### 5.2.2.4 Location update failure + +If the MME receives an SGsAP-LOCATION-UPDATE-REJECT message from the VLR, the MME + +- shall stop timer Ts6-1; +- shall move the state of the SGs association to SGs-NULL; and +- indicates to the UE the rejection of the Location Update procedure by the VLR as specified in 3GPP TS 24.301 [14]. The Reject cause value sent by the VLR shall be mapped to the appropriate reject cause as specified in 3GPP TS 24.301 [14], and the latter is forwarded to the UE. + +NOTE: Upon receiving an SGsAP-LOCATION-UPDATE-REJECT message with MM cause #11 or MM cause #13, if the MME is configured to know that the VPLMN has a suitable roaming agreement for E-UTRAN with the HPLMN of the UE, the MME can map the MM cause to EMM cause #18 as specified in 3GPP TS 24.301 [14]. + +#### 5.2.2.5 Abnormal cases + +If timer Ts6-1 expires, the MME shall abort the Location Update for non-EPS service procedure and indicate this to the UE with the Reject cause value 'MSC temporarily not reachable'. The state of the SGs association to the VLR shall be SGs-NULL. + +If the MME receives an SGsAP-LOCATION-UPDATE-ACCEPT message and timer Ts6-1 is not running then: + +- if timer Ts8 is running (see subclause 5.4), the message shall be ignored; +- if timer Ts9 is running (see subclause 5.5), the message shall be ignored; or +- if timers Ts8 and Ts9 are not running: + - if the state of the SGs association to the VLR is SGs-ASSOCIATED, the message shall be ignored; or + - if the state of the SGs association to the VLR is different than SGs-ASSOCIATED, the message shall be treated as a message incompatible with the protocol state of the MME (see subclause 7.3). + +#### 5.2.2.6 Additional MME procedure for UE supporting NB-S1 mode only + +This subclause applies when the UE supporting NB-S1 mode only requests SMS services via a normal attach request or tracking area update request. + +If the UE supporting NB-S1 mode only requests SMS services using normal attach request or tracking area update request, the location update for non-EPS services procedure can be initiated by the MME when SMS over SGs is used. + +If timer Ts6-1 is not running, the MME shall start the location update for non-EPS services procedure when it receives from the UE: + +- an attach request indicating EPS attach and "SMS only" in NB-S1 mode, SMS services via SMS in MME are not available and SMS over SGs is used for the UE; +- a tracking area update request indicating TA updating and "SMS only" in NB-S1 mode, SMS services via SMS in MME are not available, SMS over SGs is used for the UE and the MME detects that the LAI has changed; +- a tracking area update request indicating TA updating and "SMS only" in NB-S1 mode, SMS services via SMS in MME are not available, SMS over SGs is used for the UE and the state of the SGs association is SGs-NULL; or +- a tracking area update request indicating TA updating and "SMS only" in NB-S1 mode, SMS services via SMS in MME are not available, SMS over SGs is used for the UE and the MME detects that the MME serving the UE has changed. + +NOTE 1: When the MME supports both SMS in MME feature and SMS over SGs, depending on UE capability and/or network configuration and/or "PS and SMS only" subscription, it can be preferred to provide SMS services via SMS in MME to avoid the VLR registration. + +NOTE 2: The UE does not include the MS Classmark 2 IE in a normal attach request or normal tracking area update request, and the MME does not store this information or include it in subsequent messages to the VLR. Services that use information part of MS Classmark 2, e.g. CAMEL, can therefore fail when SMS over SGs is provided via normal procedures. + +If the MME has a stored TMSI for the UE, the MME may include this TMSI in the TMSI based NRI container IE in the SGsAP-LOCATION-UPDATE-REQUEST message. Otherwise the MME shall indicate "no valid TMSI available" in the TMSI status IE in the SGsAP-LOCATION-UPDATE-REQUEST message. + +If the MME received a normal attach request or normal tracking area update request from the UE with an indication for "SMS only", the MME may allocate a default location area identification specifically configured for that case. + +If the MME receives an SGsAP-LOCATION-UPDATE-ACCEPT message from the VLR, the MME shall: + +- stop timer Ts6-1 and move the state of the SGs association to SGs-ASSOCIATED; +- set the MM context variable "VLR-Reliable" to "true"; and + +- indicate to the UE the acceptance of SMS services as specified in 3GPP TS 24.301 [14]. + +NOTE 3: The message sent to the UE does not include the Location Area Identity or the Mobile identity information element if received from the VLR. + +If the VLR included the Location area identifier or the Mobile identity information element in the SGsAP-LOCATION-UPDATE-ACCEPT message, the MME may store the received Location area identifier or the Mobile identity information element for the subsequent location update for non-EPS services procedure for the UE. If the Mobile identity information element contains a new TMSI, the MME may send to the VLR the SGsAP-TMSI-REALLOCATION-COMPLETE message when the MME indicates to the UE the acceptance of SMS services. If the Mobile identity information element contains an IMSI, the MME may delete any stored TMSI for the UE. + +If the MME receives an SGsAP-LOCATION-UPDATE-REJECT message from the VLR, the MME shall: + +- stop timer Ts6-1 and move the state of the SGs association to SGs-NULL; and +- indicate to the UE the rejection of SMS services as specified in 3GPP TS 24.301 [14]. The MME maps the location update reject cause received from the VLR to an appropriate value as specified in 3GPP TS 24.301 [14] and forwards to the UE. + +If timer Ts6-1 expires, the MME shall abort the Location Update for non-EPS service procedure. The MME indicates to the UE the rejection of SMS services by setting an appropriate value and shall as specified in 3GPP TS 24.301 [14] and forwards to the UE. The state of the SGs association to the VLR shall be SGs-NULL. + +### 5.2.3 Procedures in the VLR + +#### 5.2.3.1 General + +When a VLR receives an SGsAP-LOCATION-UPDATE-REQUEST message, the VLR checks whether the IMSI is known. If the IMSI is not known, the VLR retrieves the MM context of the UE from the HSS. + +In networks supporting the feature 'Intra Domain Connection of RAN Nodes to Multiple CN Nodes' (3GPP TS 23.236 [6A]), if the TMSI based NRI container is received in the SGsAP-LOCATION-UPDATE-REQUEST message, the VLR derives the NRI value. If the NRI value is not allocated by the VLR, the VLR retrieves the MM context of the UE from the HSS. + +When the VLR is configured for gateway core network (GWCN), the VLR shall select the serving CS domain operator as follows: + +- If the selected CS domain operator information element is received in the SGsAP-LOCATION-UPDATE-REQUEST message, the VLR shall select the serving CS domain operator as specified in the selected CS domain operator information element; +- If the selected CS domain operator information element is not received in the SGsAP-LOCATION-UPDATE-REQUEST message and the PLMN ID included in the new location area identifier information element identifies a CS domain operator, the VLR shall select the serving CS domain operator as specified in the new location area identifier information element; +- Otherwise, the VLR selects the serving CS domain operator based on local policies. + +#### 5.2.3.2 Location update response + +If the location update is accepted by the VLR and, if necessary, by the HSS, the VLR shall: + +- move the SGs association to the SGs-ASSOCIATED state; +- set the "Confirmed by Radio Contact" restoration indicator to "true"; +- update the SGs association by storing the MME address included in SGsAP-LOCATION-UPDATE-REQUEST message; and +- send an SGsAP-LOCATION-UPDATE-ACCEPT message to the sending MME. This message includes the location area identifier received in the New location area identifier information element in the previous SGsAP-LOCATION-UPDATE-REQUEST message. + +After the VLR has updated the SGs association, if Ts5 is still running for a MT service for this UE, the VLR shall repeat SGs Paging Request towards the updated SGs association. + +#### 5.2.3.3 Location update failure + +If the location update is rejected by the VLR, the VLR shall: + +- send an SGsAP-LOCATION-UPDATE-REJECT message to the MME with the appropriate reject cause as indicated in 3GPP TS 24.008 [8] and shall indicate to the MME the Location area identifier received in the corresponding SGsAP-LOCATION-UPDATE-REQUEST message; and +- move the SGs association to SGs-NULL. + +#### 5.2.3.4 TMSI reallocation procedure + +If the VLR decides to allocate a new TMSI to the UE, the VLR shall include the new TMSI in the SGsAP-LOCATION-UPDATE-ACCEPT message. After sending the SGsAP-LOCATION-UPDATE-ACCEPT message with a new TMSI the VLR shall start timer Ts6-2. If the VLR decides to deallocate the TMSI of the UE, the VLR shall include the IMSI of the UE in the SGsAP-LOCATION-UPDATE-ACCEPT message. + +Upon receipt of the SGsAP-TMSI-REALLOCATION-COMPLETE message, the VLR shall stop the timer Ts6-2 and consider the new TMSI as valid. + +If the IMSI was sent to the UE, the VLR considers the old TMSI if available, as deleted. + +If no SGsAP-TMSI-REALLOCATION-COMPLETE message is received by the VLR before the timer Ts6-2 expires, the VLR shall abort the TMSI reallocation procedure. The VLR shall consider the old TMSI if available, occupied until the new TMSI is used in a subsequent A/Iu message, or for an implementation dependent time. The outcome of the TMSI reallocation procedure does not change the state of the SGs association. The VLR uses the IMSI or a TMSI, either the new TMSI or the old TMSI if available, for paging. + +NOTE: Whether the new TMSI or old TMSI is used in the SGs paging request does not impact the paging procedure or UE response. + +#### 5.2.3.5 Abnormal cases + +The following abnormal cases can be identified: + +##### i) MM signalling via A or Iu interface + +If the VLR receives a Location Update request or an IMSI detach indication from the UE by the A or Iu interface when the state of the SGs association in the VLR is not SGs-NULL, the VLR shall move the state of the SGs association to SGs-NULL. + +##### ii) Additional Location Update Request + +If the state of the SGs association in the VLR is LA-UPDATE PRESENT and an SGsAP-LOCATION-UPDATE-REQUEST message is received, then: + +- if the message is from the same MME and indicates the same New location area identifier information element as the outstanding location update request, then the VLR shall ignore this additional SGsAP-LOCATION-UPDATE-REQUEST message; +- if the message is from the same MME but indicates a different New location area identifier information element to the outstanding location update request, then the VLR shall treat this additional SGsAP-LOCATION-UPDATE-REQUEST message and the VLR shall not send any response to the previous SGsAP-LOCATION-UPDATE-REQUEST message; or +- if the message is from a different MME (indicating either the same or different New location area identifier information element) to the outstanding location update request, then the VLR shall treat this additional SGsAP-LOCATION-UPDATE-REQUEST message and the VLR shall not send any response to the previous SGsAP-LOCATION-UPDATE-REQUEST message. + +##### iii) Detach signalling from the MME + +If the state of the SGs association in the VLR is LA-UPDATE PRESENT and either an SGsAP-EPS-DETACH-INDICATION or an SGsAP-IMSI-DETACH-INDICATION message is received, then the VLR shall abandon the Location Update for non-EPS services procedure (neither an SGsAP-LOCATION-UPDATE-ACCEPT nor an SGsAP-LOCATION-UPDATE-REJECT messages is sent) and the further actions described in subclauses 5.4 or 5.5 or 5.6 are followed. + +##### iv) Signalling via Gs interface + +If the VLR receives for a UE a BSSAP+-LOCATION-UPDATE-REQUEST message (as defined in 3GPP TS 29.018 [16]) from an SGSN when the state of the SGs association for this UE in the VLR is not SGs-NONE, the VLR shall move the state of the SGs association to SGs-NONE. + +##### v) New Location Update Request during TMSI reallocation procedure + +If the VLR receives an SGsAP-LOCATION-UPDATE-REQUEST message while Ts6-2 is running, the VLR shall stop timer Ts6-2, abort the TMSI reallocation procedure and proceed with the new location update for non-EPS services procedure. If the VLR needs to page the MS during the new location update for non-EPS services procedure, the VLR uses the IMSI or a TMSI, either the new TMSI from the aborted TMSI reallocation procedure or the old TMSI if available, for paging. + +NOTE: Whether the new TMSI or old TMSI is used in the SGs paging request does not impact the paging procedure or UE response. + +##### vi) Reset signalling from the MME + +If the state of the SGs association in the VLR is LA-UPDATE PRESENT and an SGsAP-RESET-INDICATION message is received from the MME, then the VLR shall abandon the Location Update for non-EPS services procedure (neither an SGsAP-LOCATION-UPDATE-ACCEPT nor an SGsAP-LOCATION-UPDATE-REJECT messages is sent) and the further actions described in subclause 5.8 are followed. + +##### vii) Collision between A or Iu paging and Location Update Request + +If the VLR receives Location Update Request when A or Iu paging is ongoing, then the VLR may abort paging procedure over A or Iu interface and may initiate paging procedure over SGs interface after location updating procedure has successfully completed. + +## 5.3 Non-EPS alert procedure + +### 5.3.1 General description + +This procedure is used by the VLR to request from an MME an indication when any signalling activity from the UE is detected. This procedure can be invoked at any time by the VLR. The MME shall acknowledge the SGsAP-ALERT-REQUEST message. + +### 5.3.2 Procedures in the VLR + +#### 5.3.2.1 Alert Initiation + +The VLR may start the Non-EPS alert procedure at any time. When the VLR wants to request from an MME that further activity from a UE is reported by the MME, the VLR shall send an SGsAP-ALERT-REQUEST message to that MME. The VLR starts timer Ts7 when the SGsAP-ALERT-REQUEST message is sent. + +#### 5.3.2.2 Alert Response + +When an SGsAP-ALERT-ACK message is received, the VLR shall stop the timer Ts7. The state of the SGs association is not changed. + +#### 5.3.2.3 Alert Failure + +If an SGsAP-ALERT-REJECT message is received, the VLR shall stop the timer Ts7, move the state of the SGs association to SGs-NULL and within this state the SGs association is marked with the contents of the SGs cause information element. + +#### 5.3.2.4 Alert Indication + +The VLR shall not change the state of the SGs association upon reception of an SGsAP-UE-ACTIVITY-INDICATION message. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the SGsAP-UE-ACTIVITY-INDICATION message includes the Maximum UE Availability Time IE and the MNRF flag is set in the VLR, the VLR may forward the Maximum UE Availability Time IE to the HLR as defined in 3GPP TS 29.002 [15]. + +#### 5.3.2.5 Abnormal cases + +If no SGsAP-ALERT-ACK message is received before the timer Ts7 expires, the VLR shall retransmit the SGsAP-ALERT-REQUEST message a maximum of Ns7 times. + +NOTE: If no SGsAP-ALERT-ACK message is received after that, a report is made to the O&M system. The state of the SGs association is not changed. + +### 5.3.3 Procedures in the MME + +#### 5.3.3.1 Alert response + +The MME may receive an SGsAP-ALERT-REQUEST message in any state of the SGs association. Upon receipt of an SGsAP-ALERT-REQUEST message from the VLR and if the IMSI is known in the MME, the MME shall reply with an SGsAP-ALERT-ACK message and set the NEAF. If the MME has activated Idle mode Signaling Reduction for the UE, the MME shall send an Alert MME Notification message to the associated SGSN, as described in 3GPP TS 29.274 [17A], except for the conditions specified in subclause 8.2.5c of 3GPP TS 23.272 [7]. + +#### 5.3.3.2 Alert failure + +If an SGsAP-ALERT-REQUEST message is received for an IMSI that is unknown at the MME, the MME shall return an SGsAP-ALERT-REJECT message to the VLR indicating the SGs cause information element value "IMSI unknown". + +#### 5.3.3.3 Alert indication + +The MME shall report to the VLR upon detection of any activity in E-UTRAN (either signalling or, indirectly detected via S-GW, data transfer) from the UE if the NEAF is set. If the MME detects EPS signalling that leads to a procedure towards the VLR, the MME shall follow this procedure and reset the NEAF. If the MME detects activity that does not lead to any procedure towards the VLR, the MME shall send an SGsAP-UE-ACTIVITY-INDICATION message towards the VLR and reset the NEAF. Upon receipt of a UE Activity Notification message from the SGSN, the MME shall reply with a UE Activity Acknowledge message, send an SGsAP-UE-ACTIVITY-INDICATION message to the VLR and reset the NEAF flag. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the UE is using eDRX, the MME may include the Maximum UE Availability Time IE in the SGsAP-UE-ACTIVITY-INDICATION message. + +NOTE: This information can be used by the SMS Service Center to prioritize the retransmission of pending Mobile Terminated Short Messages to UEs using eDRX. + +## 5.4 Explicit IMSI detach from EPS services + +### 5.4.1 General description + +This procedure is used by the MME to indicate to the VLR that the UE has been detached from EPS services and therefore the SGs association between the MME and the VLR has to be deactivated. This procedure only applies to UEs which are not in the SGs-NULL state at the MME. The procedures specified in this subclause apply to EPS detach indication initiated by the UE or by the network as specified in 3GPP TS 24.301 [14]. + +The procedure is also used by the MME to indicate to the VLR when a combined tracking area update procedure has been rejected by the MME, except when the MME performs the NAS level mobility management congestion control as specified in 3GPP TS 24.301 [14], or the MME receives the Detach Notification from the SGSN, as described in 3GPP TS 29.274 [17A], when Idle mode Signalling Reduction is activated. + +The procedure is also used by the MME to indicate to the VLR when a periodic tracking area update procedure has been rejected by the MME, except when the MME performs the NAS level mobility management congestion control as specified in 3GPP TS 24.301 [14], for a UE for which an SGs association exists. + +The Explicit IMSI detach from EPS services procedure aborts any other ongoing procedure related to this UE on the SGs interface in the MME and in the VLR. + +### 5.4.2 Procedures in the MME + +#### 5.4.2.1 Explicit EPS detach initiation + +The MME shall send an SGsAP-EPS-DETACH-INDICATION message to a VLR if: + +- the MME receives a detach for EPS from the UE; +- the MME performs network initiated EPS detach procedure; +- the combined tracking area update procedure is rejected by the MME, except when the MME performs the NAS level mobility management congestion control as specified in 3GPP TS 24.301 [14]; +- the periodic tracking area update procedure is rejected by the MME, except when the MME performs the NAS level mobility management congestion control as specified in 3GPP TS 24.301 [14], for a UE for which an SGs association exists; or +- the MME receives a Detach Notification from the SGSN with the Detach type indicating "PS Detach". + +If the MME receives a Detach Request from a UE or Detach Notification from an SGSN and the state of the SGs association to a VLR for that UE is not SGs-NULL, the MME shall check the detach type indicated in the Detach Request message or the detach type indicated in the Detach Notification message. If the UE has indicated EPS detach the MME shall send an SGsAP-EPS-DETACH-INDICATION message to the VLR indicating "UE initiated IMSI detach from EPS services". + +If the MME performs a network initiated detach procedure and the state of the SGs association to a VLR for that UE is not SGs-NULL, the MME shall send an SGsAP-EPS-DETACH-INDICATION message to the VLR indicating "Network initiated IMSI detach from EPS services". + +If the combined or periodic tracking area update procedure is rejected at the MME, except when the MME performs the NAS level mobility management congestion control as specified in 3GPP TS 24.301 [14], for a UE with an SGs association state different from SGs-NULL, the MME shall send an SGsAP-EPS-DETACH-INDICATION to the VLR indicating "EPS services not allowed". + +After sending of the SGsAP-EPS-DETACH-INDICATION message, the MME shall move the state of the SGs association to SGs-NULL. The MME shall start timer Ts8 upon transmission of the SGsAP-EPS-DETACH-INDICATION message and the MME shall stop and reset timer Ts6-1 if running. + +#### 5.4.2.2 Explicit EPS detach response + +If the MME receives an SGsAP-EPS-DETACH-ACK message from the VLR, the MME shall stop timer Ts8. If a confirmation of the detach needs to be sent to the UE, the MME shall not wait for the reception of the SGsAP-EPS-DETACH-ACK message to send such confirmation. + +#### 5.4.2.3 Abnormal cases + +If no SGsAP-EPS-DETACH-ACK message is received by the MME in response to a previous SGsAP-EPS-DETACH-INDICATION message before timer Ts8 expires, the MME shall repeat the SGsAP-EPS-DETACH-INDICATION message a maximum of Ns8 times. + +NOTE: If no SGsAP-EPS-DETACH-ACK message is received after that, a report is made to the O&M system. The state of the SGs association during the acknowledgement procedure remains SGs-NULL. + +### 5.4.3 Procedures in the VLR + +When a VLR receives an SGsAP-EPS-DETACH-INDICATION message, the VLR shall send an SGsAP-EPS-DETACH-ACK message to the sending MME. The VLR shall check the MME name indicated in the SGsAP-EPS-DETACH-INDICATION message. If the received MME name is not changed comparing to the MME name stored in the VLR, the VLR shall move the state of the SGs association for the UE from any state to SGs-NULL and marks the SGs association as "detached for EPS services". Otherwise, the VLR shall not change the state of the SGs association. + +If the VLR's implicit detach timer is not running then the VLR shall set and restart the implicit detach timer upon reception of an SGsAP-EPS-DETACH-INDICATION message. If the VLR's implicit detach timer is running (the state of the SGs association was already SGs-NULL) then the reception of an SGsAP-EPS-DETACH-INDICATION message shall not affect VLR's implicit detach timer. + +## 5.5 Explicit IMSI detach from non-EPS services + +### 5.5.1 General description + +This procedure is used by the MME to indicate to the VLR that the UE has performed IMSI detach from non-EPS services and therefore the SGs association between the MME and the VLR has to be deactivated. This procedure applies only to UEs for which there is a SGs association at the MME. The procedures specified in this subclause apply only to IMSI detach request, combined IMSI and EPS detach requests from the UE or Detach Notification message from an SGSN. + +The explicit IMSI detach from non-EPS services procedure aborts any other ongoing procedure related to this UE on the SGs interface in the MME and in the VLR. + +In order to ensure that the VLR and the UE are synchronized as to which paging channel to use for any of the subsequent paging events, the MME shall attempt to inform the VLR about the detach event by using a retry scheme if the initial delivery of the SGsAP-IMSI-DETACH-INDICATION message fails. + +### 5.5.2 Procedures in the MME + +#### 5.5.2.1 Explicit IMSI detach initiation + +When an MME receives a Detach Request from a UE for which an SGs association exists, the MME shall check the detach type indicated. If the UE is indicating IMSI detach or combined EPS/IMSI detach, the MME shall send an SGsAP-IMSI-DETACH-INDICATION message to the VLR indicating "Explicit UE initiated IMSI detach from non-EPS services" or "Combined UE initiated IMSI detach from EPS and non-EPS services". + +When an MME receives a Detach Notification message for a UE from an SGSN and an SGs association for the UE exists, the MME shall check the cause and detach type indicated. If the cause is indicating "IMSI Detach only", the MME shall send an SGsAP-IMSI-DETACH-INDICATION message to the VLR indicating "Explicit UE initiated IMSI detach from non-EPS services". If the cause is indicating "Complete Detach" and detach type is indicating "Combined + +PS/CS Detach" as specified in 3GPP TS 29.274 [17A], the MME shall send an SGsAP-IMSI-DETACH-INDICATION message to the VLR indicating "Combined UE initiated IMSI detach from EPS and non-EPS services". + +After the sending of the SGsAP-IMSI-DETACH-INDICATION message to the VLR, the MME shall move the state of the SGs association to SGs-NULL. The MME shall start timer Ts9 upon transmission of the SGsAP-IMSI-DETACH-INDICATION message and the MME shall stop and reset timer Ts6-1, if running. + +#### 5.5.2.2 Explicit IMSI detach response + +If the MME receives an SGsAP-IMSI-DETACH-ACK message from the VLR, the MME shall stop timer Ts9. If the detach type received from the UE indicated IMSI only detach or combined EPS/IMSI detach not due to switch off, the MME shall wait for the reception of the SGsAP-IMSI-DETACH-ACK message before sending the confirmation of the detach to the UE. + +#### 5.5.2.3 Abnormal cases + +The following abnormal cases can be identified: + +- i) no SGsAP-IMSI-DETACH-ACK received for a detach with switch off + +If the MME sent an SGsAP-IMSI-DETACH-INDICATION message for a combined IMSI and EPS detach due to switch off and timer Ts9 expires, the MME shall repeat the SGsAP-IMSI-DETACH-INDICATION message a maximum of Ns9 times. + +- ii) no SGsAP-IMSI-DETACH-ACK received for a detach with no switch off + +If the MME sent an SGsAP-IMSI-DETACH-INDICATION message for an IMSI only detach or a combined IMSI and EPS detach not due to switch off and timer Ts9 expires, the MME shall repeat the SGsAP-IMSI-DETACH-INDICATION message a maximum of Ns9 times. If no SGsAP-IMSI-DETACH-ACK is received after that the MME shall send the confirmation of the detach to the UE. + +### 5.5.3 Procedures in the VLR + +When a VLR receives an SGsAP-IMSI-DETACH-INDICATION message, the VLR shall send an SGsAP-IMSI-DETACH-ACK message to the sending MME. + +The VLR shall check the MME name indicated in the SGsAP-IMSI-DETACH-INDICATION message. If the received MME name is not changed comparing to the MME name stored in the VLR, the VLR shall move the state of the SGs association for the UE from any state to SGs-NULL. If the SGsAP-IMSI-DETACH-INDICATION message indicated "Explicit UE initiated IMSI detach from non-EPS services", the VLR marks the SGs association as "IMSI detached for non-EPS services". If the SGsAP-IMSI-DETACH-INDICATION message indicated "Combined UE initiated IMSI detach from EPS and non-EPS services", the VLR marks the SGs association as "IMSI detached for EPS and non-EPS services". The VLR shall mark the UE as detached. + +If the received MME name is different from the MME name stored in the VLR, the VLR shall not change the state of the SGs association. + +## 5.6 Implicit IMSI detach from non-EPS services + +### 5.6.1 General description + +This procedure is used by the MME to indicate when, based on the criteria for implicit detach as specified in 3GPP TS 23.401 [7B], the MME has decided to delete the EMM context of an UE or mark its EMM context as detached. This procedure only applies to UEs for which there is an SGs association at the MME. + +The implicit IMSI detach from non-EPS services procedure aborts any other ongoing procedure related to this UE on the SGs interface in the MME and in the VLR. + +In order to ensure that the VLR and the UE are synchronized as to which paging channel to use for any of the subsequent paging events the MME shall attempt to inform the VLR about the detach event by using a retry scheme if the initial delivery of the SGsAP-IMSI-DETACH-INDICATION message fails. + +### 5.6.2 Procedures in the MME + +When the implicit IMSI detach from non-EPS services procedure is started for a UE, the MME shall send an SGsAP-IMSI-DETACH-INDICATION message to the VLR indicating "Implicit network initiated IMSI detach from EPS and non-EPS services". + +After the sending of the SGsAP-IMSI-DETACH-INDICATION message, the MME shall move the state of the SGs association to SGs-NULL. The MME shall start timer Ts10 upon transmission of the SGsAP-IMSI-DETACH-INDICATION message. + +If the MME receives an SGsAP-IMSI-DETACH-ACK message from the VLR, the MME shall stop timer Ts10. + +If no SGsAP-IMSI-DETACH-ACK message is received by the MME to a previous SGsAP-IMSI-DETACH-INDICATION message before timer Ts10 expires, the MME shall repeat the SGsAP-IMSI-DETACH-INDICATION message a maximum of Ns10 times. The state of the SGs association during the acknowledgement procedure remains SGs-NULL. + +### 5.6.3 Procedures in the VLR + +When a VLR receives the SGsAP-IMSI-DETACH-INDICATION message, the VLR shall send an SGsAP-IMSI-DETACH-ACK message to the sending MME. + +The VLR shall check the MME name indicated in the SGsAP-IMSI-DETACH-INDICATION message. If the received MME name is not changed comparing to the MME name stored in the VLR and the state of the SGs association is not SGs-NULL, the VLR proceeds as follows: + +- The VLR shall move the state of the SGs association for the UE to SGs-NULL. If the VLR does not have a signalling connection for the UE, the VLR shall mark the UE as detached. Additionally, the VLR marks the SGs association as "IMSI implicitly detached for EPS and non-EPS services". + +If the received MME name is different from the MME name stored in the VLR, the VLR shall not change the state of the SGs association. + +## 5.7 VLR failure procedure + +### 5.7.1 General description + +This procedure is used by the VLR to inform the MMEs with an SGs association about the recovery from an internal failure that has affected the SGs association with the MMEs when the VLR fails with restart. + +NOTE: The VLR recovery procedure is handled in such a way that the signalling load on the VLR and MMEs does not create any overload problem. + +### 5.7.2 Procedures in the VLR + +#### 5.7.2.1 VLR Reset Initiation + +In the event of a failure at the VLR which has resulted in the loss of the SGs association information for some UEs, the VLR shall move from any state to the SGs-NULL state for these UEs. The VLR shall also set the "Confirmed by Radio Contact" restoration indicator to "false" (see 3GPP TS 23.007 [4]) for affected UEs. The VLR shall not send any SGsAP-MM-INFORMATION-REQUEST messages to UEs with the SGs association in the SGs-NULL state. + +When the VLR restarts, the VLR shall send an SGsAP-RESET-INDICATION message to all the MMEs connected to the VLR by the SGs interface. This message indicates to the MME that for the UEs with an SGs association to that VLR, the SGs association is no longer reliable. The VLR shall also start a separate timer Ts11 for each MME. + +#### 5.7.2.2 VLR Reset Response + +Upon receipt of an SGsAP-RESET-ACK message from an MME, the VLR shall stop the timer Ts11 for that MME. + +#### 5.7.2.3 Abnormal cases + +If the VLR does not receive an SGsAP-RESET-ACK message from that MME before the timer Ts11 expires, the VLR shall retransmit the SGsAP-RESET-INDICATION message. The retransmission is repeated a maximum of Ns11 times. + +NOTE: If no SGsAP-RESET-ACK is received after that a report is made to the O&M system. + +### 5.7.3 Procedures in the MME + +#### 5.7.3.1 VLR reset indication + +Upon receipt of an SGsAP-RESET-INDICATION message from the VLR, the MME is informed that all the SGs associations with that VLR for all the UEs registered in the MME are no longer reliable because the VLR has lost information about the state of the UEs and during the failure the VLR might have missed signalling messages. The MME shall set the "VLR-Reliable" MM context variable to "false". The detach procedures for deleting the SGs association are still applicable (see subclauses 5.4, 5.5 and 5.6). + +The MME sends an SGsAP-RESET-ACK message to the VLR. + +If the "VLR-Reliable" MM context variable is set to "false", upon reception of a combined tracking area update request or a periodic tracking area update request from the UE that is attached for non-EPS service, the MME may: + +- if a combined tracking area update request is received, immediately perform the location update for non-EPS services procedure towards the VLR as described in subclause 5.2; or +- if a periodic tracking area update request is received, dependent on network configuration and operator policy, + - perform a network initiated detach with detach type "IMSI detach" immediately after the completion of the periodic tracking area update procedure; or + - perform immediately the location update for non-EPS services procedure towards the VLR as described in subclause 5.2. + +#### 5.7.3.2 Void + +## 5.8 MME failure procedure + +### 5.8.1 General description + +This procedure is used by the MME to inform the associated VLRs about the recovery from an internal failure that has affected the SGs association with the VLRs. + +NOTE: The MME recovery procedure is handled in such a way that the signalling load on the MME and VLRs does not create any overload problem. + +### 5.8.2 Procedures in the MME + +#### 5.8.2.1 MME Reset Initiation + +In the event of a failure at the MME which has resulted in the loss of the SGs association information on some UEs, the MME shall move from any state to the SGs-NULL state for these affected UEs. The MME shall also set the "MME-Reset" MM context variable to "true" and start the timer Ts12-1. When the timer Ts12-1 expires the "MME-Reset" MM context variable is set to "false". + +The MME may send an SGsAP-RESET-INDICATION message to all the VLRs connected to the MME by SGs interfaces. The SGsAP-RESET-INDICATION message indicates to the VLR that all the SGs associations with that particular MME for all the UEs registered in the VLR are no longer reliable. The normal procedures for updating the SGs association are still applicable (see subclauses 5.2, 5.4, 5.5 and 5.6). The MME shall also start a separate timer Ts12-2 for each VLR. + +If the MME does not send an SGsAP-RESET-INDICATION message, the MME shall move from any state to the SGs-NULL state only for the associations of the UEs affected by the loss of VLR association information. + +NOTE: The option to not send any SGsAP-RESET-INDICATION message to all the VLRs connected to the MME by SGs interfaces reduces subsequent paging signalling initiated by VLRs by avoiding a complete search of the UE on the entire VLR area. + +#### 5.8.2.2 MME Reset Response + +Upon receipt of an SGsAP-RESET-ACK message, the MME shall stop the timer Ts12-2 for that VLR. + +#### 5.8.2.3 Abnormal cases + +If the MME does not receive an SGsAP-RESET-ACK message from that VLR before the timer Ts12-2 expires, the MME shall retransmit the SGsAP-RESET-INDICATION message. The retransmission is repeated a maximum of Ns12 times. + +NOTE: If no SGsAP-RESET-ACK is received after that a report is made to the O&M system. + +### 5.8.3 Procedures in the VLR + +Upon receipt of an SGsAP-RESET-INDICATION message from the MME, the VLR is informed that all the SGs associations with that MME for all the UEs registered in the MME are no longer reliable because the MME has lost information about the state of the UEs for that VLR and during the failure the MME might have missed signalling messages. The VLR shall either: + +- set the "Confirmed by Radio Contact" restoration indicator to "false" in all the SGs associations containing the restarted MME and set the state of all the SGs associations containing the restarted MME to the SGs-NULL state; or +- keep the 'Confirmed by Radio Contact' restoration indication and the state of all the SGs associations containing the restarted MME unchanged. + +NOTE: The option to not set the 'Confirmed by Radio Contact' restoration indicator to 'false' in all the associations containing the restarted MME reduces subsequent paging signalling the VLR can initiate by avoiding a complete search of the UE on the entire VLR area. + +The VLR shall then send an SGsAP-RESET-ACK message to the MME. + +If the "Confirmed by Radio Contact" restoration indicator is "false" the VLR may send paging messages on both the SGs and the A/Iu interface. + +## 5.9 HSS failure + +### 5.9.1 General description + +This subclause describes the MME behaviour towards the VLR as a consequence of an HSS reset. + +In the case of an HSS failure, the HSS informs the associated MMEs about the recovery from an internal failure that has affected the SGs association with the MMEs according to the HSS reset procedure specified in 3GPP TS 29.272 [17]. + +This information is used in the MME to trigger the VLR to perform a location update towards the HSS in order to restore the HSS subscriber data. + +### 5.9.2 Procedures in the MME + +Upon receipt of a HSS reset indication from the HSS, the MME shall set the NEAF for all registered UEs in the MME for which a valid SGs association with a VLR exists. + +Upon detection of any signalling activity from the UE, the MME shall report to the VLR if the NEAF, as defined in subclause 5.3.3, is set for this UE. If the MME detects signalling that leads to a procedure towards the VLR, the MME + +shall follow this procedure and reset the NEAF. If the MME detects activity that does not lead to any procedure towards the VLR, the MME shall send an SGsAP-UE-ACTIVITY-INDICATION message towards the VLR and reset the NEAF. The MME may delay sending the activity indication for a maximum operator-configuration depending time period to avoid high signalling load. + +## 5.10 MM information procedure + +### 5.10.1 General description + +The MM information procedure is performed between the VLR and the MME via the SGs interface if the target UE for the MM information procedure is IMSI attached to both EPS and non-EPS services (i.e. the state of the SGs association is SGs-ASSOCIATED). The outcome of the MM Information procedure does not change the state of the SGs association at the VLR or MME. + +### 5.10.2 Procedures in the VLR + +If for the target UE for the MM information procedure the state of the SGs association in the VLR is SGs-ASSOCIATED, the VLR may initiate the MM information procedure by transferring an SGsAP-MM-INFORMATION-REQUEST message to the MME. + +### 5.10.3 Procedures in the MME + +If an SGsAP-MM-INFORMATION-REQUEST message is received for a UE for which there exists an SGs association at the MME, dependent on operator preference the MME shall either: + +- 1) check and update the contents of the received MM information information element. The MME then sends the resultant contents of the MM information information element to the UE indicated in the SGsAP-MM-INFORMATION-REQUEST message, using an EMM INFORMATION message as defined in 3GPP TS 24.301 [14]; or +- 2) discard the SGsAP-MM-INFORMATION-REQUEST message. In this case the MME can send an EMM INFORMATION message as defined in 3GPP TS 24.301 [14] to the UE, with contents generated locally by the MME. + +The MME should avoid sending both EMM INFORMATION messages according to option 1 and EMM INFORMATION messages according to option 2 to the same UE. + +NOTE 1: Sending messages according to option 1 and option 2 to the same UE can result in short-time changes of the network name or the local time displayed by the UE. + +For option 1) the MME checks and updates the contents of the MM information information element as follows: + +- a) If LSA Identity has been included in the MM information, the MME shall discard the LSA Identity; +- b) If the network spans more than one time zone, the MME shall handle the time-related parameters as follows: + - if Network Daylight Saving Time has been included in the MM information, then the MME shall discard the Network Daylight Saving Time; + - if Local Time Zone has been included in the MM information, then the MME shall replace the Local Time Zone with the Local Time Zone applicable for this UE. In addition, if the local time zone in the MME has been adjusted for daylight saving time, the MME shall indicate this by including the value used for adjustment in Network Daylight Saving Time IE in the MM information; + - if Universal time and local time zone has been included in the MM information, then the MME shall replace it with the Universal time and local time zone applicable for this UE. In addition, if the local time zone in the MME has been adjusted for daylight saving time, the MME shall indicate this by including the value used for adjustment in Network Daylight Saving Time IE in the MM information; + +NOTE 2: For the determination of the number of time zones, both CS and PS domain are taken into account. + +- c) If the network name, i.e. Full name for network or Short name for network or both, has been included by the VLR in the MM information information element, then dependent on operator preference and other information, e.g. the IMSI of the subscriber, the MME may + - replace the network name received from the VLR with a different network name; + - remove the network name from the MM information information element; or + - keep the network name received from the VLR unchanged. + +NOTE 3: The network name received from the VLR can be different from the network name provided by the MME, e.g. if multiple PLMNs are available for the CS domain. + +## 5.11 Procedure for tunnelling of NAS messages + +### 5.11.1 General description + +The tunnelling of NAS messages procedure is used to encapsulate the NAS messages exchanged between the UE and the VLR. This procedure can be used by either the VLR or the MME depending on the direction of the NAS message. The two procedures are identified as uplink unitdata, in the direction from the MME to the VLR, and downlink unitdata in the direction from the VLR to the MME. + +### 5.11.2 Uplink unitdata procedure + +#### 5.11.2.1 Procedures in the MME + +When the MME receives an Uplink NAS Transport message (see 3GPP TS 24.301 [14]) from a UE, the MME shall copy the value part of the NAS message container information element to the value part of the NAS message container information element of the SGsAP-UPLINK-UNITDATA message and send the SGsAP-UPLINK-UNITDATA message to the VLR if the "VLR-Reliable" MM context variable is not set to "false". If the "VLR-Reliable" MM context variable is set to "false", the MME requests the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14]. + +In order to permit the VLR to create an accurate charging record, the MME shall add the IMEISV, the UE Time Zone, the Mobile Station Classmark 2, and the UE's current TAI and E-CGI to the SGsAP-UPLINK-UNITDATA message. + +#### 5.11.2.2 Procedures in the VLR + +##### 5.11.2.2.1 General description + +Upon reception of an SGsAP-UPLINK-UNITDATA, the VLR shall extract the NAS message container information element and treat the value part of this information element according to the procedures defined in 3GPP TS 24.011 [10]. + +Other parameters in the message may be used as specified in 3GPP TS 32.250 [17B] and 3GPP TS 23.078 [5AA]. + +##### 5.11.2.2.2 Abnormal cases + +The following abnormal cases can be identified: + +- i) subscriber data does not exist or is not confirmed by HLR + +If the VLR receives an SGsAP-UPLINK-UNITDATA message from the MME for a UE for which subscriber data does not exist or is not confirmed by HLR, then the VLR shall ignore the received message, and return an SGsAP-RELEASE-REQUEST message to the MME with an SGs cause information element indicating "IMSI unknown". + +- ii) subscriber data exists, but there is no SGs association for the UE at the VLR + +If the VLR receives an SGsAP-UPLINK-UNITDATA message from the MME for a UE for which no SGs association exists, then the VLR shall ignore the received message, and return an SGsAP-RELEASE-REQUEST message to the MME with an SGs cause information element indicating "IMSI detached for non-EPS services". + +#### 5.11.2.3 Void + +### 5.11.3 Downlink unitdata procedure + +#### 5.11.3.1 Procedures in the VLR + +When the VLR needs to send a NAS message to the UE, the VLR shall first verify whether or not it has an SGs association for the UE. If the state of the SGs association for the UE is SGs-ASSOCIATED and LA-UPDATE-PRESENT, then the VLR continues with the procedure. The VLR shall build and encapsulate the NAS message into the value part of the NAS message container information element of an SGsAP-DOWNLINK-UNITDATA message and send the SGsAP-DOWNLINK-UNITDATA message to the MME. + +#### 5.11.3.2 Procedures in the MME + +##### 5.11.3.2.1 General description + +Upon reception of an SGsAP-DOWNLINK-UNITDATA message, the MME shall proceed as follows: + +- If the UE was in EMM-CONNECTED mode, the MME shall copy the value part of the NAS message container information element to the value part of the NAS message container information element of a Downlink NAS Transport message (see 3GPP TS 24.301 [14]) and shall send the Downlink NAS Transport message to the UE; or +- In Deployment Option 3 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the UE was in EMM-IDLE mode and temporarily unreachable for paging due to using eDRX (as specified in 3GPP TS 24.301 [14]), the MME behaves as specified in subclause 8.2.4a.3 of 3GPP TS 23.272 [7]. + +##### 5.11.3.2.2 Abnormal cases + +The following abnormal cases can be identified: + +- i) subscriber data does not exist or is not confirmed by HSS + +If the MME receives an SGsAP-DOWNLINK-UNITDATA message from the VLR for a UE for which subscriber data does not exist or is not confirmed by HSS, then the MME shall ignore the received message. + +- ii) subscriber data exists, but there is no SGs association for the UE at the MME + +If the MME receives an SGsAP-DOWNLINK-UNITDATA message from the VLR for a UE for which there is no SGs association, then the MME shall ignore the received message. + +#### 5.11.3.3 Void + +### 5.11.4 Release procedure + +When the VLR determines that there are no more NAS messages to be exchanged between the VLR and the UE, or when a further exchange of NAS messages for the specified UE is not possible due to an error, the VLR shall send the SGsAP-RELEASE-REQUEST message to the MME, including the IMSI of the UE for which there are no more NAS messages to be tunnelled. + +- NOTE: For the SMS transport, the VLR can send the SGsAP-RELEASE-REQUEST message when the SMS transaction is complete (reception of a CP-ACK message for the MO case, sending of a CP-ACK message for the MT case), upon reception of a CP-ERROR message, abort of SMS transaction by upper layers, or upon some error cases such as TC1 expiry, no SGs association for the UE or IMSI unknown. + +Upon receipt of an SGsAP-RELEASE-REQUEST message with an SGs cause information element indicating "IMSI unknown" or "IMSI detached for non-EPS services", the MME shall set the "VLR-Reliable" MM context variable to "false". In addition, the MME requests the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14]. + +## 5.12 Service request procedure + +### 5.12.1 General description + +After the reception of an SGsAP-PAGING-REQUEST message from the VLR, the MME will use this procedure to indicate to the VLR that a NAS signalling connection exists between the UE and the MME. + +The procedure can be invoked, by the MME as follows: + +- Upon reception of a Service Request message or Extended Service Request message from the UE; +- Directly after receiving the SGsAP-PAGING-REQUEST message from the VLR, based on the UE's EMM mode; or +- In Deployment Option 3 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), detecting the UE is temporarily unreachable for paging due to using eDRX (as specified in 3GPP TS 24.301 [14]) and the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "SMS indicator". + +### 5.12.2 Procedures in the MME + +When receiving the SGsAP-PAGING-REQUEST message, the MME shall first take action as described in subclause 5.1.3 and check whether the UE, for which the paging is sent, is in EMM-IDLE or EMM-CONNECTED mode. + +If the MME accepts the paging request, the MME shall proceed as follows: + +- If the UE was in EMM-CONNECTED mode, the MME creates and sends an SGsAP-SERVICE-REQUEST message to the VLR based on the conditions specified in 3GPP TS 23.272 [7]. If the UE subsequently rejects the CS fallback call, the MME shall send the SGsAP-PAGING-REJECT message to the VLR with the SGs cause information element indicating "Mobile terminating CS fallback call rejected by the user"; +- If the UE was in EMM-IDLE mode and the SGsAP-PAGING-REQUEST message was received with LAI, the MME shall send the SGsAP-SERVICE-REQUEST message to the VLR when the UE enters EMM-CONNECTED mode; +- If the UE was in EMM-IDLE mode and the SGsAP-PAGING-REQUEST message was received without LAI, the MME behaves as specified in subclause 4.8.1 of 3GPP TS 23.272 [7]; or +- In Deployment Option 3 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the UE was in EMM-IDLE mode and temporarily unreachable for paging due to using eDRX (as specified in 3GPP TS 24.301 [14]), and the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "SMS indicator", the MME behaves as specified in subclause 8.2.4a.3 of 3GPP TS 23.272 [7]. + +The MME shall set the service indicator in the SGsAP-SERVICE-REQUEST message equal to what was received in the SGsAP-PAGING-REQUEST message. Additionally, in order to permit the VLR to create an accurate charging record, the MME shall add the IMEISV, the UE Time Zone, the Mobile Station Classmark 2, and the UE's current TAI and E-CGI to the SGsAP-SERVICE-REQUEST message. + +### 5.12.3 Procedures in the VLR + +Upon reception of the SGsAP-SERVICE-REQUEST message, the VLR shall stop Timer Ts5 and consider the paging procedure as successful. If the paging procedure is for SMS, the VLR shall then start the delivery of the SMS message(s) according to the subclause 5.11.3.1. If the paging procedure with the Service indicator information element indicating "SMS Indicator" was triggered upon reception of a Provide Subscriber Information Request message, the VLR can return an SGs AP-RELEASE-REQUEST message to the MME as specified in subclause 7.2.3.5 of 3GPP TS 23.018 [5]. + +Other parameters in the message may be used as specified in 3GPP TS 32.250 [17B] and 3GPP TS 23.078 [5AA]. + +## 5.13 Service abort procedure + +### 5.13.1 General description + +This procedure can be invoked by the VLR to abort a mobile terminating CS fallback call during call establishment. The procedure applies to UEs that are simultaneously attached for EPS services and non-EPS services, but not to UEs attached for EPS services and SMS only. + +### 5.13.2 Procedures in the VLR + +If the VLR decides to abort a mobile terminating CS fallback call for which it has sent an SGsAP-PAGING-REQUEST message to the MME, and the VLR has not received an SCCP connection establishment containing the Initial L3 message from the UE via the A or Iu interface, the VLR shall send the SGsAP-SERVICE-ABORT-REQUEST message to the MME. The state of the SGs association is not changed. + +### 5.13.3 Procedures in the MME + +When the MME receives the SGsAP-SERVICE-ABORT-REQUEST message from the VLR, the MME shall set the Call Cancelled Flag to "true". + +If the MME receives an EXTENDED SERVICE REQUEST message from the UE with Service type set to "mobile terminating CS fallback or 1xCS fallback" and CSFB response set to "CS fallback accepted by the UE" and the Call Cancelled Flag is set to "true", the MME shall set the Call Cancelled Flag to "false" and will reject the CS fallback call as specified in 3GPP TS 24.301 [14]. + +If the Call Cancelled Flag is set to "true", the MME shall set the Call Cancelled Flag to "false": + +- upon reception of the EXTENDED SERVICE REQUEST message from the UE with Service type set to a value other than "mobile terminating CS fallback or 1xCS fallback" or CSFB response set to a value other than "CS fallback accepted by the UE"; or +- upon reception of a new SGsAP-PAGING-REQUEST message from the VLR. + +When the MME receives the SGsAP-SERVICE-ABORT-REQUEST message after the UE has accepted the CS fallback call, the MME shall discard the SGsAP-SERVICE-ABORT-REQUEST message. The state of the SGs association is not changed. + +## 5.14 Implicit IMSI detach from EPS services + +### 5.14.1 General description + +This procedure is used by the MME to indicate when, based on the criteria for implicit detach as specified in 3GPP TS 23.401 [7B], the MME has decided to delete the EMM context of an UE or mark its EMM context as detached. This procedure only applies to UEs for which there is an SGs association at the MME and the network operating in NMO I and supporting ISR. + +The implicit IMSI detach from EPS services procedure aborts any other ongoing procedure related to this UE on the SGs interface in the MME and in the VLR. + +In order to ensure that the VLR and the UE are synchronized as to which paging channel to use for any of the subsequent paging events the MME shall attempt to inform the VLR about the detach event by using a retry scheme if the initial delivery of the SGsAP-EPS-DETACH-INDICATION message fails. + +### 5.14.2 Procedures in the MME + +When the implicit IMSI detach from EPS services procedure is started for a UE, the MME shall send an SGsAP-EPS-DETACH-INDICATION message to the VLR indicating "Network initiated IMSI detach from EPS services". + +After the sending of the SGsAP-EPS-DETACH-INDICATION message, the MME shall move the state of the SGs association to SGs-NULL. The MME shall start timer Ts13 upon transmission of the SGsAP-EPS-DETACH-INDICATION message. + +If the MME receives an SGsAP-EPS-DETACH-ACK message from the VLR, the MME shall stop timer Ts13. + +If no SGsAP-EPS-DETACH-ACK message is received by the MME to a previous SGsAP-EPS-DETACH-INDICATION message before timer Ts13 expires, the MME shall repeat the SGsAP-EPS-DETACH-INDICATION message a maximum of Ns10 times. The state of the SGs association during the acknowledgement procedure remains SGs-NULL. + +### 5.14.3 Procedures in the VLR + +When a VLR receives an SGsAP-EPS-DETACH-INDICATION message, the VLR shall perform the procedures described in subclause 5.4.3. + +## 5.15 UE fallback supervision procedure + +### 5.15.0 General description + +This procedure is used by the VLR to monitor the status of the UE fallback procedure, after the VLR has sent an SGsAP-PAGING-REQUEST message to the MME. + +### 5.15.1 Procedures in the VLR + +Upon receipt of an SGsAP-SERVICE-REQUEST message from the MME, if the Service indicator information element in the SGsAP-SERVICE-REQUEST message indicates "CS call indicator", the VLR shall start timer Ts14 to supervise the success of UE fallback. + +The VLR shall stop timer Ts14 in the following cases: + +- upon receipt of an SCCP connection establishment containing the Initial L3 message from the UE via the A or Iu interface; +- upon receipt of an SGsAP-PAGING-REJECT message; or +- upon expiry of the CFNRy timer and if Call Forwarding on No Reply (CFNRy) has been configured and activated for the terminating UE. + +NOTE 1: Upon expiry of the CFNRy timer, the VLR triggers Call Forwarding on No Reply (CFNRy) as specified in 3GPP TS 23.082 [5B] and 3GPP TS 29.011 [15A]. + +If Call Forwarding on No Reply (CFNRy) is not activated for the terminating UE, upon expiry of timer Ts14, the VLR shall release the call as specified in 3GPP TS 24.008[8]. + +NOTE 2: Before releasing the call, the VLR needs to consider whether A/Iu paging is ongoing. In addition, if the VLR considers the paging procedure completed, and no response has been received from the UE via the A or Iu interface, and if CFNRc has been configured and activated for the terminating UE, the VLR applies the equivalent handling as for Call Forwarding on Not Reachable, as specified in 3GPP TS 23.082 [5B] and 3GPP TS 29.011 [15A]. + +## 5.16 Procedure for MO CSFB indication + +### 5.16.1 General description + +If the network is configured to support the return to the last used E-UTRAN PLMN after CS fallback as specified in 3GPP TS 23.272 [7], this procedure is used to indicate to the VLR that the UE initiated a service request for MO CS fallback. + +### 5.16.2 Procedures in the MME + +If the MME is configured to support the return to the last used E-UTRAN PLMN after CS fallback, upon reception of an EXTENDED SERVICE REQUEST message (see 3GPP TS 24.301 [14]) from the UE with Service type set to "mobile originating CS fallback or 1xCS fallback" or "mobile originating CS fallback emergency call or 1xCS fallback emergency call" from the UE, the MME shall send the SGsAP-MO-CSFB-INDICATION message to the VLR. + +### 5.16.3 Procedures in the VLR + +If the VLR is configured to support the return to the last used E-UTRAN PLMN after CS fallback, upon reception of an SGsAP-MO-CSFB-INDICATION, the VLR shall start timer Ts15 to supervise the success of the UE fallback. + +If an SCCP connection establishment containing the Initial L3 message is received from the UE via the A or Iu interface, the VLR shall stop timer Ts15 and apply specific handling related to the return to the last used E-UTRAN PLMN after CS fallback. + +Upon expiry of Ts15, the VLR considers the MO CSFB to have failed and does not apply specific handling related to support of the return to the last used E-UTRAN PLMN after CS fallback. + +# --- 6 SGs transport + +## 6.1 General + +This subclause specifies the standards for signalling transport to be used across SGs interface. SGs interface is a logical interface between the MME and the VLR. All the SGsAP messages described in the present document require an SCTP association between the MME and the VLR. + +## 6.2 IP layer + +The MME and the VLR shall support IPv6 (see IETF RFC 2460 [22]) and/or IPv4 (see IETF RFC 791 [20]). + +The IP layer of SGs only supports point-to-point transmission for delivering SGsAP messages. + +## 6.3 Transport layer + +SCTP (see IETF RFC 4960 [23]) shall be supported as the transport layer of SGsAP messages. + +Semi-permanent SCTP associations shall be established between the MME and VLR, i.e. the SCTP associations shall remain up under normal circumstances. The MME shall establish the SCTP association. + +Transport network redundancy can be achieved by SCTP multi-homing between two end-points, of which one or both is assigned with multiple IP addresses. SCTP end-points shall support a multi-homed remote SCTP end-point. + +NOTE 1: If the association initialization to an IP destination address of the VLR is unsuccessful and alternative destination IP address(es) are known, the MME reattempts initialization to an alternative IP address. + +For SCTP endpoint redundancy, an SCTP endpoint (in the MME or VLR) may send an INIT, at any time for an already established SCTP association, which the other SCTP endpoint shall handle as defined in IETF RFC 4960 [23]. + +MME and VLR shall support a configuration with a single SCTP association per MME/VLR pair. Configurations with multiple SCTP endpoints per MME/VLR pair may be supported. + +NOTE 2: If multiple SCTP endpoints are configured and several SCTP associations are established between the MME/VLR pair, whether the VLR and the MME send and receive SGsAP messages via same or different SCTP associations for a given UE is up to implementation. + +Within the SCTP association established between one MME and one VLR, both MME and VLR shall reserve several stream identifiers, based on the INIT message exchange for the sole use of SGsAP procedures. + +The registered port number for SGsAP is 29118. + +The payload protocol identifier to be used for SGsAP is 0. + +# --- 7 Error handling + +## 7.1 General + +This subclause specifies procedures for the handling of unknown, unforeseen, and erroneous protocol data by the receiving entity (i.e. the MME or the VLR). These procedures are called "error handling procedures", but in addition to providing recovery mechanisms for error situations, they define a compatibility mechanism for future extensions of the protocol. + +In this subclause, the following terminology is used: + +- an information element is defined to be syntactically incorrect in a message if it contains at least one value defined as "reserved", or if its value part violates coding rules. However, it is not a syntactical error that an information element indicates in its Length Indicator a greater length than defined in the relevant subclause; and +- a message is defined to have semantically incorrect contents if it contains information which, possibly dependant on the state of the receiver, is in contradiction to the resources of the receiver and/or to the procedural part of current specification. + +When a receiving entity detects the need to send an SGsAP-STATUS message (see errors detailed below), the entity shall copy the IMSI information element value (if included) of the incorrect message to the IMSI information element of the SGsAP-STATUS message. The message in error is also included in the SGsAP-STATUS message. Both the receiving and the sending entity shall abandon the procedure related to the incorrect message and return to the state from where the procedure related to the incorrect message was started. + +An SGsAP-STATUS message shall not be sent in response to a received SGsAP-STATUS message. + +Both the receiving and the sending entity shall inform the O&M entity upon sending or receiving an SGsAP-STATUS message. + +The next subclauses shall be applied in order of precedence. + +## 7.2 Message too short + +When the receiving entity receives a message that is too short to contain a complete message type information element, the receiving entity shall ignore that message. + +## 7.3 Unknown or unforeseen message type + +The entity receiving a message with a message type not defined or not implemented shall ignore the message. The receiving entity shall return an SGsAP-STATUS message with the SGs cause information element set to "message unknown" and the Erroneous message information element containing the received message. + +The entity receiving a message that is not compatible with the protocol state shall return an SGsAP-STATUS message with the SGs cause information element set to "message not compatible with the protocol state" and the erroneous message. + +The entity receiving a message that is not defined to be received by that entity (i.e. the message is sent in the wrong direction) shall treat the message as unknown message and shall ignore the message. The entity shall return an SGsAP-STATUS message with the SGs cause information element set to "message unknown" and the Erroneous message information element containing the received message. + +## 7.4 Missing mandatory information element + +When the receiving entity diagnoses a "missing mandatory information element" error, the receiving entity shall ignore the message and return an SGsAP-STATUS message with the SGs cause information element set to "missing mandatory information element" and shall return the Erroneous message information element containing the received message. + +## 7.5 Information elements unknown or unforeseen in the message + +The receiving entity shall ignore all information elements unknown or unforeseen in a message. + +## 7.6 Out of sequence information elements + +The receiving entity shall ignore all information elements that are out of sequence. + +## 7.7 Repeated information elements + +If an information element with format T, TV, or TLV is repeated in a message in which repetition of the information element is not specified, the receiving entity shall only handle the contents of the information element appearing first and shall ignore all subsequent repetitions of the information element. When repetition of information elements is specified, the receiving entity shall only handle the contents of specified repeated information elements. If the limit on repetition of information elements is exceeded, the receiving entity shall handle the contents of information elements appearing first up to the limit of repetitions and shall ignore all subsequent repetitions of the information element. + +## 7.8 Syntactically incorrect mandatory information element. + +On receipt of a message which contains a syntactically incorrect mandatory information element, the receiver shall ignore the message and return an SGsAP-STATUS message with the SGs cause information element set to "invalid mandatory information" and shall return the Erroneous message information element containing the received message. + +## 7.9 Syntactically incorrect optional information elements + +The receiving entity shall treat all optional information elements that are syntactically incorrect in a message as not present in the message. + +## 7.10 Conditional information element errors + +When the entity receiving a message diagnoses a "missing conditional information element" error or an "unexpected conditional information element" error or when it receives a message containing at least one syntactically incorrect conditional information element which is required to be present in the message, the receiving entity shall ignore the message and return an SGsAP-STATUS message with the SGs cause information element set to "conditional information element error" and shall return the Erroneous message information element containing the received message. + +When the entity receives a message containing a syntactically incorrect conditional information element which is not required to be present in the message, nor required to be absent in the message, then the receiving entity shall ignore that information element. + +## 7.11 Information elements with semantically incorrect contents + +When an information element with semantically incorrect contents is received, the foreseen reactions of the procedural part of the present specification are performed. + +If however no such reactions are specified, the receiving entity shall ignore that information element and treat the rest of the message. If, because this information element was ignored, the rest of the message can no longer be handled then the receiving entity shall return an SGsAP-STATUS message with the SGs cause information element set to "semantically incorrect message" and shall return the Erroneous message information element containing the received message. + +# 8 Message functional definitions and contents + +## 8.1 SGsAP-ALERT-ACK message + +This message is sent by the MME to the VLR to acknowledge a previous SGsAP-ALERT-REQUEST message. Table 8.1.1 shows the content of the SGsAP-ALERT-ACK message. + +**Table 8.1.1: SGsAP-ALERT-ACK message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +## 8.2 SGsAP-ALERT-REJECT message + +This message is sent from the MME to the VLR to indicate that the MME could not identify the IMSI indicated in the SGsAP-ALERT-REQUEST message. Table 8.2.1 shows the content of the SGsAP-ALERT-REJECT message. + +**Table 8.2.1: SGsAP-ALERT-REJECT message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| SGs Cause | SGs cause
9.4.18 | M | TLV | 3 | + +## 8.3 SGsAP-ALERT-REQUEST message + +This message is sent by the VLR to the MME to request an indication when the next activity of a UE is detected. Table 8.3.1 shows the content of the SGsAP-ALERT-REQUEST message. + +**Table 8.3.1: SGsAP-ALERT-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +## 8.4 SGsAP-DOWNLINK-UNITDATA message + +This message is sent from the VLR to the MME to transparently relay a NAS message, from the VLR, to the UE. Table 8.4.1 shows the content of the SGsAP-DOWNLINK-UNITDATA message. + +**Table 8.4.1: SGsAP-DOWNLINK-UNITDATA message content** + +| Information element | Type/Reference | Presence | Format | Length | +|-----------------------|---------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| NAS message container | NAS message container
9.4.15 | M | TLV | 4-253 | + +## 8.5 SGsAP-EPS-DETACH-ACK message + +This message is sent by the VLR to the MME to acknowledge a previous SGsAP-EPS-DETACH-INDICATION message. Table 8.5.1 shows the content of the SGsAP-EPS-DETACH-ACK message. + +**Table 8.5.1: SGsAP-EPS-DETACH-ACK message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +## 8.6 SGsAP-EPS-DETACH-INDICATION message + +This message is sent by the MME to the VLR to indicate an EPS detach performed from the UE or the MME. The type of detach is indicated in the IMSI detach from EPS service type information element. Table 8.6.1 shows the content of the SGsAP-EPS-DETACH-INDICATION message. + +**Table 8.6.1: SGsAP-EPS-DETACH-INDICATION message content** + +| Information element | Type/Reference | Presence | Format | Length | +|-----------------------------------|--------------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| MME name | MME name
9.4.13 | M | TLV | 57 | +| IMSI detach from EPS service type | IMSI detach from EPS service type
9.4.7 | M | TLV | 3 | + +## 8.7 SGsAP-IMSI-DETACH-ACK message + +This message is sent by the VLR to the MME to acknowledge a previous SGsAP-IMSI-DETACH-INDICATION message. Table 8.7.1 shows the content of the SGsAP-IMSI-DETACH-ACK message. + +**Table 8.7.1: SGsAP-IMSI-DETACH-ACK message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +## 8.8 SGsAP-IMSI-DETACH-INDICATION message + +This message is sent by the MME to the VLR to indicate an IMSI detach performed from the UE or the MME. The type of detach is indicated in the IMSI detach from non-EPS service type information element. Table 8.8.1 shows the content of the SGsAP-IMSI-DETACH-INDICATION message. + +**Table 8.8.1: SGsAP-IMSI-DETACH-INDICATION message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------------------------|------------------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| MME name | MME name
9.4.13 | M | TLV | 57 | +| IMSI Detach from non-EPS service type | IMSI detach from non-EPS service type
9.4.8 | M | TLV | 3 | + +## 8.9 SGsAP-LOCATION-UPDATE-ACCEPT message + +### 8.9.1 Message definition + +This message is sent by the VLR to the MME to indicate that update or IMSI attach in the VLR has been completed. Table 8.9.1.1 shows the content of the SGsAP-LOCATION-UPDATE-ACCEPT message. + +**Table 8.9.1.1: SGsAP-LOCATION-UPDATE-ACCEPT message content** + +| Information element | Type/Reference | Presence | Format | Length | +|--------------------------|------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| Location area identifier | Location area identifier
9.4.11 | M | TLV | 7 | +| New TMSI, or IMSI | Mobile identity
9.4.14 | O | TLV | 6-10 | + +### 8.9.2 New TMSI, or IMSI + +This information element represents the identity to be used for (and then by) the UE. + +If this information element is an IMSI, then the UE is not allocated any TMSI (and deletes any TMSI accordingly). If this information element is a TMSI, then the UE will use this TMSI as the new temporary identity (the UE deletes its + +old TMSI if available, and stores the new TMSI). If neither a TMSI nor an IMSI are included in this information element, the old TMSI, if any available, will be kept. + +## 8.10 SGsAP-LOCATION-UPDATE-REJECT message + +### 8.10.1 Message definition + +This message is sent by the VLR to the MME to indicate that location update or IMSI attach has failed. Table 8.10.1 shows the content of the SGsAP-LOCATION-UPDATE-REJECT message. + +**Table 8.10.1: SGsAP-LOCATION-UPDATE-REJECT message content** + +| Information element | Type/Reference | Presence | Format | Length | +|--------------------------|------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| Reject cause | Reject cause
9.4.16 | M | TLV | 3 | +| Location area identifier | Location area identifier
9.4.11 | O | TLV | 7 | + +### 8.10.2 Location area identifier + +The VLR shall include this information element. + +## 8.11 SGsAP-LOCATION-UPDATE-REQUEST message + +### 8.11.1 Message definition + +This message is sent by the MME to the VLR either to request update of its location file (normal update) or to request IMSI attach. Table 8.11.1.1 shows the content of the SGsAP-LOCATION-UPDATE-REQUEST message. + +**Table 8.11.1.1: SGsAP-LOCATION-UPDATE-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|------------------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| MME name | MME name
9.4.13 | M | TLV | 57 | +| EPS location update type | EPS location update type
9.4.2 | M | TLV | 3 | +| New location area identifier | Location area identifier
9.4.11 | M | TLV | 7 | +| Old location area identifier | Location area identifier
9.4.11 | O | TLV | 7 | +| TMSI status | TMSI status
9.4.21 | O | TLV | 3 | +| IMEISV | IMEISV
9.4.5 | O | TLV | 10 | +| TAI | Tracking Area Identity
9.4.21a | O | TLV | 7 | +| E-CGI | E-UTRAN Cell Global Identity
9.4.3a | O | TLV | 9 | +| TMSI based NRI container | TMSI based NRI container
9.4.26 | O | TLV | 4 | +| Selected CS domain operator | Selected CS domain operator
9.4.27 | O | TLV | 5 | + +### 8.11.2 Old location area identifier + +The MME shall include this information element if the UE included the old location area information in the ATTACH REQUEST or TRACKING AREA UPDATE REQUEST message. + +### 8.11.3 TMSI status + +The MME shall include this information element if the TMSI status received in the ATTACH REQUEST or TRACKING AREA UPDATING REQUEST message from the UE indicates that no valid TMSI is available in the UE. + +### 8.11.4 IMEISV + +The MME shall include this information element if the IMEISV is available in the MME. + +### 8.11.5 TAI + +If the TAI is available in the MME, the MME shall include this information element. + +### 8.11.6 E-CGI + +If the E-CGI is available in the MME, the MME shall include this information element. + +### 8.11.7 TMSI based NRI container + +This information element shall be included if the TMSI based NRI container has been received in the ATTACH REQUEST or TRACKING AREA UPDATING REQUEST message from the UE. + +### 8.11.8 Selected CS domain operator + +This information element shall be included if the network is configured to support gateway core network (GWCN) for CS domain, the preferred RAT of the selected PLMN for CS fallback is GERAN, and the UE does not support GERAN network sharing. + +## 8.12 SGsAP-MM-INFORMATION-REQUEST + +This message is sent by the VLR to the MME to provide the UE with subscriber specific information. Table 8.12.1 shows the content of the SGsAP-MM-INFORMATION-REQUEST message. + +**Table 8.12.1: SGsAP-MM-INFORMATION-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|--------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| MM information | MM information
9.4.12 | M | TLV | 3-n | + +## 8.13 SGsAP-PAGING-REJECT message + +This message is sent from the MME to the VLR to indicate that the delivery of a previous SGsAP-PAGING-REQUEST message has failed. Table 8.13.1 shows the content of the SGsAP-PAGING-REJECT message. + +**Table 8.13.1: SGsAP-PAGING-REJECT message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| SGs Cause | SGs Cause
9.4.18 | M | TLV | 3 | + +## 8.14 SGsAP-PAGING-REQUEST message + +### 8.14.1 Message definition + +This message is sent from the VLR to the MME and contains sufficient information to allow the paging message to be transmitted by the correct cells at the correct time. Table 8.14.1.1 shows the content of the SGsAP-PAGING-REQUEST message. + +Table 8.14.1.1: SGsAP-PAGING-REQUEST message content + +| Information element | Type/Reference | Presence | Format | Length | +|------------------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| VLR name | VLR name
9.4.22 | M | TLV | 3-n | +| Service indicator | Service indicator
9.4.17 | M | TLV | 3 | +| TMSI | TMSI
9.4.20 | O | TLV | 6 | +| CLI | CLI
9.4.1 | O | TLV | 3-14 | +| Location area identifier | Location area identifier
9.4.11 | O | TLV | 7 | +| Global CN-Id | Global CN-Id
9.4.4 | O | TLV | 7 | +| SS code | SS code
9.4.19 | O | TLV | 3 | +| LCS indicator | LCS indicator
9.4.10 | O | TLV | 3 | +| LCS client identity | LCS client identity
9.4.9 | O | TLV | 3-n | +| Channel needed | Channel needed
9.4.23 | O | TLV | 3 | +| eMLPP Priority | eMLPP Priority
9.4.24 | O | TLV | 3 | +| Additional paging indicators | Additional paging indicators
9.4.25 | O | TLV | 3 | +| SM Delivery Timer | SM Delivery Timer
9.4.29 | O | TLV | 4 | +| SM Delivery Start Time | SM Delivery Start Time
9.4.30 | O | TLV | 6 | +| Maximum Retransmission Time | Maximum Retransmission Time
9.4.32 | O | TLV | 6 | + +## 8.14.2 TMSI + +This element is omitted in the exceptional case where paging with IMSI is performed. + +## 8.14.3 CLI + +If the Calling Line Identification is available in the VLR, the VLR shall include this information element. + +## 8.14.4 Location area identifier + +The VLR shall include this information element if the "Confirmed by Radio Contact" restoration indicator is set to "true". + +## 8.14.5 Global CN-Id + +If the network supports the Intra Domain Connection of RAN Nodes to multiple CN Nodes functionality, the VLR shall include this information element when the VLR initiates paging by IMSI, via the SGs interface. + +## 8.14.6 SS code + +The VLR may include this information element if paging is due to a NW-initiated Call Independent SS procedure (see 3GPP TS 24.010 [9]). + +### 8.14.7 LCS indicator + +The VLR shall include this information element if the paging is due to a Mobile Terminated Location Request (see 3GPP TS 24.030 [11]). + +### 8.14.8 LCS client identity + +The VLR may include this information element if the paging is due to a Mobile Terminated Location Request (see 3GPP TS 24.030 [11]). If the paging is due to emergency positioning, then VLR should include this information element. + +### 8.14.9 Channel needed + +This information element shall be included if the VLR intends to indicate which channel the UE should use. + +### 8.14.10 eMLPP priority + +This information element shall be included if the VLR supports CSFB priority call handling and the call was received with eMLPP priority level indication. + +The eMLPP priority IE may be used to determine the required priority of a SCTP association for the associated SGsAP message. + +### 8.14.11 Additional paging indicators + +This information element shall be included if additional paging information e.g. CS restoration indicator needs to be passed to the MME. + +### 8.14.12 SM Delivery Timer + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this information element may be included if the Service Indicator IE indicates "SMS indicator" and the SM Delivery Timer and SM Delivery Start Time IEs were received from the SMS-GMSC as defined in 3GPP TS 24.010 [9]. + +### 8.14.13 SM Delivery Start Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this information element may be included if the Service Indicator IE indicates "SMS indicator" and the SM Delivery Timer and SM Delivery Start Time IEs were received from the SMS-GMSC as defined in 3GPP TS 24.010 [9]. + +### 8.14.4 Maximum Retransmission Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this information element may be included if the Service Indicator IE indicates "SMS indicator" and if the Maximum Retransmission Time IE was received from the SMS-GMSC as defined in 3GPP TS 29.002 [15]. + +## 8.15 SGsAP-RESET-ACK message + +### 8.15.1 Message definition + +This message is sent from the MME or the VLR to acknowledge a previous SGsAP-RESET-INDICATION message. This message indicates that all the SGs associations to the VLR or the MME have been marked as invalid. + +The sending entity (either the MME or the VLR) includes its identity in the form of a name in the SGsAP-RESET-ACK message. Table 8.15.1.1 shows the content of the SGsAP-RESET-ACK message. + +**Table 8.15.1.1: SGsAP-RESET-ACK message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| MME name | MME name
9.4.13 | C | TLV | 57 | +| VLR name | VLR name
9.4.22 | C | TLV | 3-n | + +## 8.15.2 MME name + +If the MME is the sending entity, then the MME shall indicate its identity by including its MME name information element. Otherwise (i.e. if the VLR is the sending entity), then the VLR shall not include the MME name information element. + +## 8.15.3 VLR name + +If the VLR is the sending entity, then the VLR shall indicate its identity by including its VLR name information element. Otherwise (i.e. if the MME is the sending entity), then MME shall not include the VLR name information element. + +# 8.16 SGsAP-RESET-INDICATION message + +## 8.16.1 Message definition + +This message is sent from the VLR to the MME to indicate that a failure in the VLR has occurred and all the SGs associations to the VLR are to be marked as invalid. + +This message is also sent from the MME to the VLR to indicate that a failure in the MME has occurred and all the SGs associations to the MME are to be marked as invalid. + +The sending entity (either the MME or the VLR) includes its identity in the SGsAP-RESET-INDICATION message. Table 8.16.1.1 shows the content of the SGsAP-RESET-INDICATION message. + +**Table 8.16.1.1: SGsAP-RESET-INDICATION message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| MME name | MME name
9.4.13 | C | TLV | 57 | +| VLR name | VLR name
9.4.22 | C | TLV | 3-n | + +## 8.16.2 MME name + +If the MME is the sending entity, then the MME shall indicate its identity by including its MME name information element. Otherwise (i.e. if the VLR is the sending entity), then the VLR shall not include the MME name information element. + +## 8.16.3 VLR name + +If the VLR is the sending entity, then the VLR shall indicate its identity by including its VLR name information element. Otherwise (i.e. if the MME is the sending entity), then the MME shall not include the VLR name information element. + +## 8.17 SGsAP-SERVICE-REQUEST message + +### 8.17.1 Message definition + +This message is sent from the MME to the VLR as a response to a previously received SGsAP-PAGING-REQUEST message to indicate the existence of a NAS signalling connection between the UE and the MME or to indicate to the VLR that the NAS signalling connection has been established after the paging procedure. Table 8.17.1 shows the content of the SGsAP-SERVICE-REQUEST message. + +**Table 8.17.1: SGsAP-SERVICE-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|----------------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| Service indicator | Service indicator
9.4.17 | M | TLV | 3 | +| IMEISV | IMEISV
9.4.5 | O | TLV | 10 | +| UE Time Zone | UE Time Zone
9.4.21b | O | TLV | 3 | +| Mobile Station Classmark 2 | Mobile Station Classmark 2
9.4.14a | O | TLV | 5 | +| TAI | Tracking Area Identity
9.4.21a | O | TLV | 7 | +| E-CGI | E-UTRAN Cell Global Identity
9.4.3a | O | TLV | 9 | +| UE EMM Mode | UE EMM mode
9.4.21c | O | TLV | 3 | + +### 8.17.2 IMEISV + +If the IMEISV is available in the MME, the MME shall include this information element. + +### 8.17.3 UE Time Zone + +If the UE Time Zone is available in the MME, the MME shall include this information element. + +### 8.17.4 Mobile Station Classmark 2 + +If the Mobile Station Classmark 2 is available in the MME, the MME shall include this information element. + +### 8.17.5 TAI + +If the TAI is available in the MME, the MME shall include this information element. + +### 8.17.6 E-CGI + +If the E-CGI is available in the MME, the MME shall include this information element. + +### 8.17.7 UE EMM Mode + +The MME shall include this information element. This information element indicates the EMM mode of the UE when the SGsAP-PAGING-REQUEST message was received by the MME. + +## 8.18 SGsAP-STATUS message + +### 8.18.1 Message definition + +This message is sent by both the VLR and the MME to indicate an error. The contents of SGsAP-STATUS message are shown in table 8.18.1.1. + +**Table 8.18.1.1: SGsAP-STATUS message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|----------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | O | TLV | 6-10 | +| SGs cause | SGs cause
9.4.18 | M | TLV | 3 | +| Erroneous message | Erroneous message
9.4.3 | M | TLV | 3-n | + +### 8.18.2 IMSI + +The MME shall include this information element if the IMSI is present in the erroneous message. + +## 8.19 SGsAP-TMSI-REALLOCATION-COMPLETE message + +This message is sent by the MME to the VLR to indicate that TMSI reallocation on the UE has been successfully completed. Table 8.19.1 shows the content of the SGsAP-TMSI-REALLOCATION-COMPLETE message. + +**Table 8.19.1: SGsAP-TMSI-REALLOCATION-COMPLETE message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +## 8.20 SGsAP-UE-ACTIVITY-INDICATION message + +This message is sent by the MME to the VLR to indicate that activity from a UE has been detected. Table 8.20.1 shows the content of the SGsAP-UE-ACTIVITY-INDICATION message. + +**Table 8.20.1: SGsAP-UE-ACTIVITY-INDICATION message content** + +| Information element | Type/Reference | Presence | Format | Length | +|------------------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| Maximum UE Availability Time | Maximum UE Availability Time
9.4.28 | O | TLV | 6 | + +### 8.20.1 Maximum UE Availability Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), the MME may include this information element to indicate the time until the UE is available. + +## 8.21 SGsAP-UE-UNREACHABLE message + +This message is sent from the MME to the VLR to indicate that, for example, paging could not be performed because the UE is marked as unreachable at the MME. Table 8.21.1 shows the content of the SGsAP-UE-UNREACHABLE message. + +**Table 8.21.1: SGsAP-UE-UNREACHABLE message content** + +| Information element | Type/Reference | Presence | Format | Length | +|--------------------------------------|------------------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| SGs cause | SGs cause
9.4.18 | M | TLV | 3 | +| Requested Retransmission Time | Requested Retransmission Time
9.4.33 | O | TLV | 6 | +| Additional UE Unreachable indicators | Additional UE Unreachable indicators
9.4.31 | O | TLV | 3 | + +### 8.21.1 Requested Retransmission Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this information element may be included if the SGsAP-PAGING-REQUEST message included the Maximum Retransmission Time IE. + +### 8.21.2 Additional UE Unreachable indicators + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this information element may be included if the SGsAP-PAGING-REQUEST message includes the SM Delivery Timer and SM Delivery Start Time IEs and the UE is expected to be reachable before the time indicated by the SM Delivery Timer and SM Delivery Start Time IEs received in the SGsAP-PAGING-REQUEST message. + +## 8.22 SGsAP-UPLINK-UNITDATA message + +### 8.22.1 Message definition + +This message is sent from the MME to the VLR to transparently convey a NAS message, from the UE, to the VLR. Table 8.22.1 shows the content of the SGsAP-UPLINK-UNITDATA message. + +**Table 8.22.1: SGsAP-UPLINK-UNITDATA message content** + +| Information element | Type/Reference | Presence | Format | Length | +|----------------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| NAS message container | NAS message container
9.4.15 | M | TLV | 4-253 | +| IMEISV | IMEISV
9.4.5 | O | TLV | 10 | +| UE Time Zone | UE Time Zone
9.4.21b | O | TLV | 3 | +| Mobile Station Classmark 2 | Mobile Station Classmark 2
9.4.14a | O | TLV | 5 | +| TAI | Tracking Area Identity
9.4.21a | O | TLV | 7 | +| E-CGI | E-UTRAN Cell Global Identity
9.4.3a | O | TLV | 9 | + +## 8.22.2 IMEISV + +If the IMEISV is available in the MME, the MME shall include this information element. + +## 8.22.3 UE Time Zone + +If the UE Time Zone is available in the MME, the MME shall include this information element. + +## 8.22.4 Mobile Station Classmark 2 + +If the Mobile Station Classmark 2 is available in the MME, the MME shall include this information element. + +## 8.22.5 TAI + +If the TAI is available in the MME, the MME shall include this information element. + +## 8.22.6 E-CGI + +If the E-CGI is available in the MME, the MME shall include this information element. + +# 8.23 SGsAP-RELEASE-REQUEST message + +## 8.23.1 Message definition + +This message is sent by the VLR to the MME when the VLR determines that there are no more NAS messages to be exchanged between the VLR and the UE, or when a further exchange of NAS messages for the specified UE is not possible due to an error. Table 8.23.1 shows the content of the SGsAP-RELEASE-REQUEST message. + +**Table 8.23.1: SGsAP-RELEASE-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| SGs cause | SGs cause
9.4.18 | O | TLV | 3 | + +## 8.23.2 SGs Cause + +The VLR shall include the SGs Cause to indicate an error. + +# 8.24 SGsAP-SERVICE-ABORT-REQUEST message + +## 8.24.1 Message definition + +This message is sent from the VLR to the MME to abort a mobile terminating CS fallback call during call establishment. Table 8.24.1.1 shows the content of the SGsAP-SERVICE-ABORT-REQUEST message. + +Table 8.24.1.1: SGsAP-SERVICE-ABORT-REQUEST message content + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +## 8.25 SGsAP-MO-CSFB-INDICATION message + +### 8.25.1 Message definition + +If the network is configured to support the return to the last used E-UTRAN PLMN after CS fallback, this message is sent from the MME to the VLR to indicate to the VLR that the UE initiated a service request for MO CS fallback. Table 8.25.1 shows the content of the SGsAP-MO-CSFB-INDICATION message. + +Table 8.25.1: SGsAP-MO-CSFB-INDICATION message content + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.1 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| TAI | Tracking Area Identity
9.4.21a | O | TLV | 7 | +| E-CGI | E-UTRAN Cell Global Identity
9.4.3a | O | TLV | 9 | + +### 8.25.2 TAI + +If the TAI is available in the MME, the MME shall include this information element. + +### 8.25.3 E-CGI + +If the E-CGI is available in the MME, the MME shall include this information element. + +## 9 Information element coding + +### 9.1 Overview + +This clause specifies the coding of the information elements used in by the SGsAP protocol. + +The spare bits in the coding of an information element shall be set to zero by the sender and shall be ignored by the receiver. + +All unassigned codes (whether omitted or explicitly *Unassigned* in the text) shall be treated as unknown (see clause 7). + +## 9.2 Message type + +Message type uniquely identifies the message being sent. It is a single octet information element, mandatory in all messages. Table 9.2.1 defines the value part of the Message type information element. + +**Table 9.2.1: Message type information element** + +| 8 7 6 5 4 3 2 1 | Message type | Reference | +|------------------------------------------|------------------------------------------------|-----------| +| 0 0 0 0 0 0 0 0 | Unassigned: treated as an unknown Message type | 7 | +| 0 0 0 0 0 0 0 1 | SGsAP-PAGING-REQUEST | 8.14 | +| 0 0 0 0 0 0 1 0 | SGsAP-PAGING-REJECT | 8.13 | +| 0 0 0 0 0 0 1 1
to
0 0 0 0 0 1 0 1 | Unassigned: treated as an unknown Message type | 7 | +| 0 0 0 0 0 1 1 0 | SGsAP-SERVICE-REQUEST | 8.17 | +| 0 0 0 0 0 1 1 1 | SGsAP-DOWNLINK-UNITDATA | 8.4 | +| 0 0 0 0 1 0 0 0 | SGsAP-UPLINK-UNITDATA | 8.22 | +| 0 0 0 0 1 0 0 1 | SGsAP-LOCATION-UPDATE-REQUEST | 8.11 | +| 0 0 0 0 1 0 1 0 | SGsAP-LOCATION-UPDATE-ACCEPT | 8.9 | +| 0 0 0 0 1 0 1 1 | SGsAP-LOCATION-UPDATE-REJECT | 8.10 | +| 0 0 0 0 1 1 0 0 | SGsAP-TMSI-REALLOCATION-COMPLETE | 8.19 | +| 0 0 0 0 1 1 0 1 | SGsAP-ALERT-REQUEST | 8.3 | +| 0 0 0 0 1 1 1 0 | SGsAP-ALERT-ACK | 8.1 | +| 0 0 0 0 1 1 1 1 | SGsAP-ALERT-REJECT | 8.2 | +| 0 0 0 1 0 0 0 0 | SGsAP-UE-ACTIVITY-INDICATION | 8.20 | +| 0 0 0 1 0 0 0 1 | SGsAP-EPS-DETACH-INDICATION | 8.6 | +| 0 0 0 1 0 0 1 0 | SGsAP-EPS-DETACH-ACK | 8.5 | +| 0 0 0 1 0 0 1 1 | SGsAP-IMSI-DETACH-INDICATION | 8.8 | +| 0 0 0 1 0 1 0 0 | SGsAP-IMSI-DETACH-ACK | 8.7 | +| 0 0 0 1 0 1 0 1 | SGsAP-RESET-INDICATION | 8.16 | +| 0 0 0 1 0 1 1 0 | SGsAP-RESET-ACK | 8.15 | +| 0 0 0 1 0 1 1 1 | SGsAP-SERVICE-ABORT-REQUEST | 8.24 | +| 0 0 0 1 1 0 0 0 | SGsAP-MO-CSFB-INDICATION | 8.25 | +| 0 0 0 1 1 0 0 1
to
0 0 0 1 1 0 0 1 | Unassigned: treated as an unknown Message type | 7 | +| 0 0 0 1 1 0 1 0 | SGsAP-MM-INFORMATION-REQUEST | 8.12 | +| 0 0 0 1 1 0 1 1 | SGsAP-RELEASE-REQUEST | 8.23 | +| 0 0 0 1 1 1 0 0 | Unassigned: treated as an unknown Message type | 7 | +| 0 0 0 1 1 1 0 1 | SGsAP-STATUS | 8.18 | +| 0 0 0 1 1 1 1 0 | Unassigned: treated as an unknown Message type | 7 | +| 0 0 0 1 1 1 1 1 | SGsAP-UE-UNREACHABLE | 8.21 | + +## 9.3 Information element identifiers + +The next list shows the coding of the information element identifiers used in the present document. Table 9.3.1 shows the values assigned for the information element identifiers. + +**Table 9.3.1: Information element identifier coding** + +| 8 7 6 5 4 3 2 1 | Information element | Reference | +|-----------------|---------------------------------------|-----------| +| 0 0 0 0 0 0 0 1 | IMSI | 9.4.6 | +| 0 0 0 0 0 0 1 0 | VLR name | 9.4.22 | +| 0 0 0 0 0 0 1 1 | TMSI | 9.4.20 | +| 0 0 0 0 0 1 0 0 | Location area identifier | 9.4.11 | +| 0 0 0 0 0 1 0 1 | Channel Needed | 9.4.23 | +| 0 0 0 0 0 1 1 0 | eMLPP Priority | 9.4.24 | +| 0 0 0 0 0 1 1 1 | TMSI status | 9.4.21 | +| 0 0 0 0 1 0 0 0 | SGs cause | 9.4.18 | +| 0 0 0 0 1 0 0 1 | MME name | 9.4.13 | +| 0 0 0 0 1 0 1 0 | EPS location update type | 9.4.2 | +| 0 0 0 0 1 0 1 1 | Global CN-Id | 9.4.4 | +| 0 0 0 0 1 1 1 0 | Mobile identity | 9.4.14 | +| 0 0 0 0 1 1 1 1 | Reject cause | 9.4.16 | +| 0 0 0 1 0 0 0 0 | IMSI detach from EPS service type | 9.4.7 | +| 0 0 0 1 0 0 0 1 | IMSI detach from non-EPS service type | 9.4.8 | +| 0 0 0 1 0 1 0 1 | IMEISV | 9.4.5 | +| 0 0 0 1 0 1 1 0 | NAS message container | 9.4.15 | +| 0 0 0 1 0 1 1 1 | MM information | 9.4.12 | +| 0 0 0 1 1 0 1 1 | Erroneous message | 9.4.3 | +| 0 0 0 1 1 1 0 0 | CLI | 9.4.1 | +| 0 0 0 1 1 1 0 1 | LCS client identity | 9.4.9 | +| 0 0 0 1 1 1 1 0 | LCS indicator | 9.4.10 | +| 0 0 0 1 1 1 1 1 | SS code | 9.4.19 | +| 0 0 1 0 0 0 0 0 | Service indicator | 9.4.17 | +| 0 0 1 0 0 0 0 1 | UE Time Zone | 9.4.21b | +| 0 0 1 0 0 0 1 0 | Mobile Station Classmark 2 | 9.4.14a | +| 0 0 1 0 0 0 1 1 | Tracking Area Identity | 9.4.21a | +| 0 0 1 0 0 1 0 0 | E-UTRAN Cell Global Identity | 9.4.3a | +| 0 0 1 0 0 1 0 1 | UE EMM mode | 9.4.21c | +| 0 0 1 0 0 1 1 0 | Additional paging indicators | 9.4.25 | +| 0 0 1 0 0 1 1 1 | TMSI based NRI container | 9.4.26 | +| 0 0 1 0 1 0 0 0 | Selected CS domain operator | 9.4.27 | +| 0 0 1 0 1 0 0 1 | Maximum UE Availability Time | 9.4.28 | +| 0 0 1 0 1 0 1 0 | SM Delivery Timer | 9.4.29 | +| 0 0 1 0 1 0 1 1 | SM Delivery Start Time | 9.4.30 | +| 0 0 1 0 1 1 0 0 | Additional UE Unreachable indicators | 9.4.31 | +| 0 0 1 0 1 1 0 1 | Maximum Retransmission Time | 9.4.32 | +| 0 0 1 0 1 1 1 0 | Requested Retransmission Time | 9.4.33 | + +### 9.3a Length indicator + +The length indicator of the information elements consists of one octet and contains the binary encoding of the number of octets of the value part in the information elements. + +## 9.4 Information elements + +### 9.4.1 CLI + +This information element is used to represent calling line identification for the terminating call received in the CS domain. The CLI information element is coded as shown in figure 9.4.1.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
To
Octet 14 | Octets 3 to 14 contain the value part of the Calling party BCD number information element defined in subclause 10.5.4.9 of 3GPP TS 24.008 [8] (octets 3 to 14, i.e. not including 3GPP TS 24.008 IEI and 3GPP TS 24.008 length indicator) | | | | | | | | + +Figure 9.4.1.1: Calling Line Identification information element + +## 9.4.2 EPS location update type + +The purpose of the EPS location update type information element is to indicate to the VLR whether an IMSI attach or a normal location update has been performed by the UE. The EPS location update type information element is coded as shown in figure 9.4.2.1 and table 9.4.2.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|--------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | EPS location update type value | | | | | | | | + +Figure 9.4.2.1: EPS location update type information element + +Table 9.4.2.1: EPS location update type information element value part + +| EPS location update type value (octet 3) | | +|------------------------------------------|------------------------------------------------------------------------------------------------| +| Bits | | +| 8 | 7 6 5 4 3 2 1 | +| 0 0 0 0 0 0 0 0 | Shall not be sent in this version of the protocol. If received, shall be treated as '00000010' | +| 0 0 0 0 0 0 0 1 | IMSI attach | +| 0 0 0 0 0 0 1 0 | Normal location update | +| 0 0 0 0 0 0 1 1 | to | +| 1 1 1 1 1 1 1 1 | Shall not be sent in this version of the protocol. If received, shall be treated as '00000010' | + +## 9.4.3 Erroneous message + +See subclause 18.4.5 in 3GPP TS 29.018 [16]. + +### 9.4.3a E-UTRAN Cell Global Identity + +The E-UTRAN Cell Global Identity information element indicates the UE's current E-UTRAN Cell Global Identity. The E-UTRAN Cell Global Identity information element is coded as shown in figure 9.4.3a.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
- | The coding of the E-UTRAN Cell Global Identity value is according to ECGI field information element as specified in subclause 8.21.5 of 3GPP TS 29.274 [17A] | | | | | | | | +| Octet 9 | | | | | | | | | + +Figure 9.4.3a.1: E-UTRAN Cell Global Identity information element + +### 9.4.4 Global CN-Id + +See subclause 18.4.27 in 3GPP TS 29.018 [16]. + +### 9.4.5 IMEISV + +See subclause 18.4.9 in 3GPP TS 29.018 [16]. + +### 9.4.6 IMSI + +See subclause 18.4.10 in 3GPP TS 29.018 [16]. + +### 9.4.7 IMSI detach from EPS service type + +The IMSI detach from EPS service type information element indicates from MME to VLR the particular type of IMSI detach from EPS. The IMSI detach from EPS service type information element is coded as shown in figure 9.4.7.1 and table 9.4.7.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|-----------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | IMSI detach from EPS service type value | | | | | | | | + +Figure 9.4.7.1: IMSI detach from EPS service type information element + +Table 9.4.7.1: IMSI detach from EPS service type information element value + +| | | +|---------------------------------------------------|---------------------------------------------------------| +| IMSI detach from EPS service type value (octet 3) | | +| Bits | | +| 8 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 0 | Interpreted as reserved in this version of the protocol | +| 0 0 0 0 0 0 0 1 | Network initiated IMSI detach from EPS services | +| 0 0 0 0 0 0 1 0 | UE initiated IMSI detach from EPS services | +| 0 0 0 0 0 0 1 1 | EPS services not allowed | +| 0 0 0 0 0 1 0 0 | Interpreted as reserved in this version of the protocol | +| to | | +| 1 1 1 1 1 1 1 1 | | + +### 9.4.8 IMSI detach from non-EPS service type + +The IMSI detach from non-EPS service type information element indicates from MME to VLR the particular type of IMSI detach from non-EPS. The IMSI detach from non-EPS service type information element is coded as shown in figure 9.4.8.1 and table 9.4.8.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|---------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | IMSI detach from non-EPS service type value | | | | | | | | + +Figure 9.4.8.1: IMSI detach from non-EPS service type information element + +**Table 9.4.8.1: IMSI detach from non-EPS service type information element value** + +| | | +|-------------------------------------------------------|----------------------------------------------------------------------| +| IMSI detach from non-EPS service type value (octet 3) | | +| Bits | | +| 8 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 0 | Interpreted as reserved in this version of the protocol | +| 0 0 0 0 0 0 0 1 | Explicit UE initiated IMSI detach from non-EPS services | +| 0 0 0 0 0 1 0 | Combined UE initiated IMSI detach from EPS and non-EPS services | +| 0 0 0 0 0 1 1 | Implicit network initiated IMSI detach from EPS and non-EPS services | +| 0 0 0 0 1 0 0 | Interpreted as reserved in this version of the protocol | +| to | | +| 1 1 1 1 1 1 1 | | + +## 9.4.9 LCS client identity + +The LCS client identity information element is a compound parameter and comprises information related to the client of a LCS request. The LCS client identity information element is coded as shown in figure 9.4.9.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet n | The coding of the LCS client identity value is according to LCS-ClientID as specified in subclause 17.7.13 of 3GPP TS 29.002 [15] | | | | | | | | + +**Figure 9.4.9.1: LCS client identity information element** + +## 9.4.10 LCS indicator + +The LCS indicator information element indicates that the origin of the message is due to a LCS request and the type of this request. The LCS indicator information element is coded as shown in figure 9.4.10.1 and table 9.4.10.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|---------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | LCS indicator value | | | | | | | | + +**Figure 9.4.10.1: LCS indicator information element****Table 9.4.10.1: LCS indicator value** + +| | | +|-----------------|------------------------------------------------------| +| LCS indicator | | +| Bits | | +| 8 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 0 | Normal, unspecified in this version of the protocol. | +| 0 0 0 0 0 0 0 1 | MT-LR | +| 0 0 0 0 0 1 0 | Normal, unspecified in this version of the protocol | +| to | | +| 1 1 1 1 1 1 1 | | + +## 9.4.11 Location area identifier + +This element uniquely identifies one Location Area. The Location area identifier information element is coded as shown in figure 9.4.11.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length Indicator | | | | | | | | +| Octet 3
-
Octet 7 | Octets 3 to 7 contain the value part of the Location area identification information element defined in 3GPP TS 24.008 [8] (starting with octet 2, i.e. not including 3GPP TS 24.008 IEI) | | | | | | | | + +Figure 9.4.11.1: Location area identifier information element + +## 9.4.12 MM information + +The MM information information element is a TLV information element that encapsulates the user information that the MME forwards to the UE. For the coding see subclause 18.4.16 in 3GPP TS 29.018 [16]. + +## 9.4.13 MME name + +The MME name information element specifies the MME name and is coded as shown in figure 9.4.13.1. Octets 3 through 57 contain MME node FQDN as specified in subclause 19.4.2.4 of 3GPP TS 23.003 [3]. The contents of octets 3 through 57 shall be coded as a fully qualified domain name (FQDN) as specified in subclause 19.4.2.1 of 3GPP TS 23.003 [3]. The value part of the MME name information element (not including IEI and length indicator) shall have a length of 55 octets. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|-----------|-------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length Indicator | | | | | | | | +| Octet 3 | Length field of the 1st label of the MME Name | | | | | | | | +| Octet 4 | Leftmost character of the 1st label of the MME name | | | | | | | | +| Octet 5 | - | | | | | | | | +| Octet m | Length field of the i-th label of the MME Name | | | | | | | | +| Octet m+1 | Leftmost character of the i-th label of the MME name | | | | | | | | +| Octet m+2 | - | | | | | | | | +| - | - | | | | | | | | +| Octet 57 | Rightmost character of the last label of the MME Name | | | | | | | | + +Figure 9.4.13.1: MME name information element + +## 9.4.14 Mobile identity + +See subclause 18.4.17 in 3GPP TS 29.018 [16]. + +### 9.4.14a Mobile Station Classmark 2 + +With the exception of the IEI, the contents are specified in subclause 10.5.1.6 in 3GPP TS 24.008 [8]. + +## 9.4.15 NAS message container + +This information element is used to encapsulate the SMS messages transferred between the VLR and the MME. The NAS message container information element is coded as shown in figure 9.4.15.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------------------|-------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | E | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet 253 | Octets 3 to 253 contain the SMS message (i.e. CP-DATA, CP-ACK or CP-ERROR) as defined in subclause 7.2 of 3GPP TS 24.011 [10] | | | | | | | | + +Figure 9.4.15.1: NAS message container information element + +## 9.4.16 Reject cause + +See subclause 18.4.21 in 3GPP TS 29.018 [16]. + +## 9.4.17 Service indicator + +This information element indicates the type of the CS service (e.g. voice call, Short Message Service). The Service indicator information element is coded as shown in figure 9.4.17.1 and table 9.4.17.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|-------------------------|---|---|---|---|---|---|---| +| Octet 1 | E | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | Service indicator value | | | | | | | | + +Figure 9.4.17.1: Service indicator information element + +Table 9.4.17.1: Service indicator value + +| | | +|-------------------|------------------------------------------------------------------------------------------------| +| Service indicator | | +| Bits | | +| 8 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 0 | Shall not be sent in this version of the protocol. If received, shall be treated as '00000001' | +| 0 0 0 0 0 0 0 1 | CS call indicator | +| 0 0 0 0 0 0 1 0 | SMS indicator | +| 0 0 0 0 0 0 1 1 | | +| to | Shall not be sent in this version of the protocol. If received, shall be treated as '00000001' | +| 1 1 1 1 1 1 1 1 | | + +## 9.4.18 SGs cause + +The purpose of the SGs cause information element is to indicate an error to the receiving entity. This could be a protocol data error, to indicate to the VLR the reason why a paging procedure could not be performed or to indicate to the VLR that the mobile terminating CS fallback call has been rejected by the user. The SGs cause information element is coded as shown in figure 9.4.18.1 and table 9.4.18.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|------------------|---|---|---|---|---|---|---| +| Octet 1 | E | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | SGs cause value | | | | | | | | + +Figure 9.4.18.1: SGs cause information element + +Table 9.4.18.1: SGs cause information element value part + +| SGs cause value (octet 3) | | +|---------------------------|----------------------------------------------------------| +| Bits | | +| 8 | 7 6 5 4 3 2 1 | +| 0 0 0 0 0 0 0 0 | Normal, unspecified in this version of the protocol. | +| 0 0 0 0 0 0 0 1 | IMSI detached for EPS services | +| 0 0 0 0 0 0 1 0 | IMSI detached for EPS and non-EPS services | +| 0 0 0 0 0 0 1 1 | IMSI unknown | +| 0 0 0 0 0 1 0 0 | IMSI detached for non-EPS services | +| 0 0 0 0 0 1 0 1 | IMSI implicitly detached for non-EPS services | +| 0 0 0 0 0 1 1 0 | UE unreachable | +| 0 0 0 0 0 1 1 1 | Message not compatible with the protocol state | +| 0 0 0 0 1 0 0 0 | Missing mandatory information element | +| 0 0 0 0 1 0 0 1 | Invalid mandatory information | +| 0 0 0 0 1 0 1 0 | Conditional information element error | +| 0 0 0 0 1 0 1 1 | Semantically incorrect message | +| 0 0 0 0 1 1 0 0 | Message unknown | +| 0 0 0 0 1 1 0 1 | Mobile terminating CS fallback call rejected by the user | +| 0 0 0 0 1 1 1 0 | UE temporarily unreachable | +| 0 0 0 0 1 1 1 1 | to Normal, unspecified in this version of the protocol | +| 1 1 1 1 1 1 1 1 | | + +NOTE: "Normal, unspecified" has the same meaning than in 3GPP TS 24.008 [8], informative Annex H (UMTS specific cause values for call control). It is used to report a normal event, and should not be interpreted as syntactically incorrect nor unknown if received. + +## 9.4.19 SS code + +The SS code information element is used to represent the code identifying a single supplementary service, a group of supplementary services, or all supplementary services. The SS code information element is coded as shown in figure 9.4.19.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|-----------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | The coding of the SS code value is according to SS-Code as specified in subclause 17.7.5 of 3GPP TS 29.002 [15] | | | | | | | | + +Figure 9.4.19.1: SS code information element + +## 9.4.20 TMSI + +See subclause 18.4.23 in 3GPP TS 29.018 [16]. + +## 9.4.21 TMSI status + +See subclause 18.4.24 in 3GPP TS 29.018 [16]. + +## 9.4.21a Tracking Area Identity + +This element uniquely identifies one Tracking Area. The Tracking Area Identity information element is coded as shown in figure 9.4.21a.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
-
Octet 7 | Octets 3 to 7 contain the value part of the Tracking Area Identity information element defined in 3GPP TS 24.301 [14] (starting with octet 2, i.e. not including 3GPP TS 24.301 IEI) | | | | | | | | + +Figure 9.4.21a.1: Tracking Area Identity information element + +## 9.4.21b UE Time Zone + +This element identifies the offset between universal time and local time in steps of 15 minutes. The UE Time Zone information element is coded as shown in figure 9.4.21b.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | The coding of the UE Time Zone value is according to value part of the Time Zone information element as specified in subclause 10.5.3.8 of 3GPP TS 24.008 [8] (i.e. not including 3GPP TS 24.008 IEI) | | | | | | | | + +Figure 9.4.21b.1: UE Time Zone information element + +## 9.4.21c UE EMM mode + +The UE EMM mode information element is used by MME to indicate to the VLR the EMM mode of the UE upon reception of the SGsAP-PAGING-REQUEST message. The UE EMM mode information element is coded as shown in figure 9.4.21c.1 and table 9.4.21c.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|-------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | UE EMM mode value | | | | | | | | + +Figure 9.4.21c.1: UE EMM mode information element + +Table 9.4.21c.1: UE EMM mode value + +| | +|------------------------------------------------------------| +| UE EMM mode value (octet 3) | +| Bits | +| 8 7 6 5 4 3 2 1 | +| 0 0 0 0 0 0 0 0 EMM-IDLE | +| 0 0 0 0 0 0 0 1 EMM-CONNECTED | +| 0 0 0 0 0 0 1 0 | +| to Interpreted as reserved in this version of the protocol | +| 1 1 1 1 1 1 1 1 | + +## 9.4.22 VLR name + +The VLR name information element specifies the VLR name and is coded as shown in figure 9.4.22.1. The contents of octets 3 through n shall be coded as a fully qualified domain name (FQDN) as specified in 3GPP TS 23.003 [3]. + +NOTE: In earlier releases of this specification, the coding of VLR Name was not clear. Implementations based on earlier releases that encode VLR Name as a string with labels separated by dot can exist. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|-----------|-------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length Indicator | | | | | | | | +| Octet 3 | Length field of the 1st label of the VLR Name | | | | | | | | +| Octet 4 | Leftmost character of the 1st label of the VLR name | | | | | | | | +| Octet 5 | - | | | | | | | | +| Octet m | Length field of the i-th label of the VLR Name | | | | | | | | +| Octet m+1 | Leftmost character of the i-th label of the VLR name | | | | | | | | +| Octet m+2 | - | | | | | | | | +| - | | | | | | | | | +| Octet n | Rightmost character of the last label of the VLR Name | | | | | | | | + +Figure 9.4.22.1: VLR name information element + +## 9.4.23 Channel needed + +See subclause 18.4.2 in 3GPP TS 29.018 [16]. + +## 9.4.24 eMLPP priority + +See subclause 18.4.4 in 3GPP TS 29.018 [16]. + +## 9.4.25 Additional paging indicators + +The Additional paging indicators information element provides additional information during the paging procedure. The Additional paging indicators information element is coded as shown in figure 9.4.25.1 and table 9.4.25.1. + +The Additional paging indicators is a type 4 information element with a length of 3 octets. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|------------------|---|---|---|---|---|---|---------------| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | CSRI
Spare | + +Figure 9.4.25.1: Additional paging indicators information element + +Table 9.4.25.1: Additional paging indicators value + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Additional paging indicators value (octet 3, bit 1)
Bits
1
0 CS restoration indicator (CSRI) is not set
1 CS restoration indicator (CSRI) is set | +| Bits 8 to 2 of octet 3 are spare and shall be all coded as zero. | + +## 9.4.26 TMSI based NRI container + +See subclause 18.4.28 in 3GPP TS 29.018 [16]. + +## 9.4.27 Selected CS domain operator + +The selected CS domain operator information element indicates the CS domain operator selected by the MME when CS domain is configured for gateway core network (GWCN), the preferred RAT of the selected PLMN for CS fallback is + +GERAN, and the UE does not support GERAN network sharing. The selected CS domain operator information element is coded as shown in figure 9.4.27.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | Coded as octets 2 to 4 of the Location Area Identification IE, defined in 3GPP TS 24.008 [8] (not including 3GPP TS 24.008 IEI and LAC). | | | | | | | | +| - | | | | | | | | | +| Octet 5 | | | | | | | | | + +Figure 9.4.27.1: Selected CS domain operator information element + +## 9.4.28 Maximum UE Availability Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), the Maximum UE Availability Time IE indicates the (UTC) time until which a UE using eDRX is expected to be reachable. The Maximum UE Availability Time IE is coded as shown in figure 9.4.28.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|--------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | Maximum UE Availability Time value, encoded as the Maximum UE Availability Time IE in subclause 12.4.2 of 3GPP TS 29.002 [15]. | | | | | | | | +| to | | | | | | | | | +| Octet 6 | | | | | | | | | +| | | | | | | | | | + +Figure 9.4.28.1: Maximum UE Availability Time information element + +## 9.4.29 SM Delivery Timer + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this IE identifies, together with the SM Delivery Start Time, the time until which the VLR buffers the Short Message. The SM Delivery Timer IE is coded as shown in figure 9.4.29.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|----------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | SM Delivery Timer value, encoded as the SM Delivery Timer IE in subclause 12.9.2 of 3GPP TS 29.002 [15]. | | | | | | | | +| to | | | | | | | | | +| Octet 4 | | | | | | | | | + +Figure 9.4.29.1: SM Delivery Timer information element + +## 9.4.30 SM Delivery Start Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this IE identifies, together with the SM Delivery Timer, the time until which the VLR buffers the Short Message. The SM Delivery Timer IE is coded as shown in figure 9.4.30.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|--------------------------|--------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet 6 | SM Delivery Start Time value, encoded as the SM Delivery Start Time IE in subclause 12.9.2 of 3GPP TS 29.002 [15]. | | | | | | | | + +Figure 9.4.30.1: SM Delivery Start Time information element + +## 9.4.31 Additional UE Unreachable indicators + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), the Additional UE Unreachable indicators information element provides additional information during the paging for non-EPS services procedure. The Additional UE Unreachable indicators information element is coded as shown in figure 9.4.31.1 and table 9.4.31.1. + +The Additional UE Unreachable indicators is a type 4 information element with a length of 3 octets. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|------------------|---|---|---|---|---|---|-------| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | SMBRI | +| | Spare | | | | | | | | + +Figure 9.4.31.1: Additional UE Unreachable indicators information element + +Table 9.4.31.1: Additional UE Unreachable indicators value + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Additional paging indicators value (octet 3, bit 1)
Bits
1
0 SM Buffer Request Indicator (SMBRI) is not set
1 SM Buffer Request Indicator (SMBRI) is set | +| Bits 8 to 2 of octet 3 are spare and shall be all coded as zero. | + +## 9.4.32 Maximum Retransmission Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), the Maximum Retransmission Time IE indicates the time until which the SMS-GMSC is capable to retransmit the Short Message. The Maximum Retransmission Time IE is coded as shown in figure 9.4.32.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet 6 | Maximum Retransmission Time value, encoded as the Maximum Retransmission Time IE in subclause 12.9.2 of 3GPP TS 29.002 [15]. | | | | | | | | + +Figure 9.4.32.1: Maximum Retransmission Time information element + +## 9.4.33 Requested Retransmission Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), the Requested Retransmission Time IE indicates the time at which the MME requests the SMS-GMSC to retransmit the Short Message. The Requested Retransmission Time IE is coded as shown in figure 9.4.33.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet 6 | Requested Retransmission Time value, encoded as the Requested Retransmission Time IE in subclause 12.9.2 of 3GPPTS 29.002 [15]. | | | | | | | | + +Figure 9.4.33.1: Requested Retransmission Time information element + +# 10 List of system variables + +## 10.1 Timers + +This subclause lists the management timers specified for the operation of the SGsAP protocol. All the implementation shall support the range of values specified in table 10.1.1 or table 10.1.2 as appropriate. The specific value of the timers is under the control of the operator. + +Table 10.1.1: Management timers – MME side + +| Timer name | Default value | Timer range | Granularity | Notes | Relation to other timers | +|------------|---------------|----------------|-------------|------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Ts6-1 | - | 10 s to 90 s | 1 s | Guards the Location Update procedure. | It is expected to take a value greater than 2 times the maximum transmission time in the SGs interface, plus the supervision timer of the Update Location procedure (as defined in 3GPP TS 29.002 [15]) | +| Ts8 | 4 s | 1s to 30 s | 1 s | Guards the Explicit IMSI detach from EPS services procedure. | None. | +| Ts9 | 4 s | 1-30 s | 1 s | Guards the Explicit IMSI detach from non-EPS services procedure. | None. | +| Ts10 | 4 s | 1-30 s | 1 s | Guards the Implicit IMSI detach from non-EPS services procedure. | None. | +| Ts12-1 | - | 8 - 60x384+8 s | 1 min | Controls the resetting of the 'MME-Reset' variable. | It is expected to take a value greater than the longest periodic tracking area update timer running on the MME, plus the transmission delay on the radio interface. | +| Ts12-2 | 4 s | 1-120 s | 1 s | Guards the MME reset procedure. There is one Ts12-2 timer per VLR for which the MME has a SGs association. | None. | +| Ts13 | 4 s | 1-30 s | 1 s | Guards the Implicit IMSI detach from EPS services procedure. | None. | + +NOTE: The Default value is the recommended value. + +Table 10.1.2: Management timers – VLR side + +| Timer name | Default value | Timer range | Granularity | Notes | Relation to other timers | +|------------|---------------|----------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Ts5 | - | 2 s to 20 s | 100 ms | Guards the Paging procedure at the VLR. | Value is correlated to paging cycle. The default is set according to maximum paging cycle supported by the MME (operator choice) as defined in 3GPP TS 36.331 [19]. | +| Ts6-2 | 40 s | 5 s to 60 s | 1 s | Guards the TMSI reallocation procedure. | It is expected to take a value greater than 2 times the maximum transmission time in the SGs interface, plus 4 times T3450 (as defined in 3GPP TS 24.301 [14]). The T3450 value to use in the calculation is the value for cases without coverage enhancement. | +| Ts7 | 4 s | 1 s to 30 s | 1 s | Guards the Non-EPS alert procedure. | None. | +| Ts11 | 4 s | 1-120 s | 1 s | Guards the VLR reset procedure. There is one Ts11 timer per MME for which the VLR has a SGs association. | None. | +| Ts14 | - | 5 s to 20 s (NOTE 2) | 1 s | Guards the MT UE fallback procedure to UTRAN/GERAN | It is expected to take a value greater than T3417ext-mt. Otherwise, the UE can attempt to select GERAN/UTRAN although the call is already released. | +| Ts15 | - | 1 s to 20 s (NOTE 2) | 1 s | Guards the MO UE fallback procedure to UTRAN/GERAN when the network is configured to support the return to the last used E-UTRAN PLMN after CS fallback | None. | + +NOTE 1: The Default value is the recommended value. +NOTE 2: If a too small value is configured, the timer can expire before a successful fallback to UTRAN/GERAN occurs. + +## 10.2 Retry counters + +This subclause lists the management retry counters specified for the operation of the SGsAP protocol. The values in table 10.2.1 and table 10.2.2 are recommended values. + +Table 10.2.1: Management retry counters – VLR side + +| Retry counter name | Retry value | +|--------------------|-------------| +| Ns7 | 2 | +| Ns11 | 2 | + +Table 10.2.2: Management retry counters – MME side + +| Retry counter name | Retry value | +|--------------------|-------------| +| Ns8 | 2 | +| Ns9 | 2 | +| Ns10 | 2 | +| Ns12 | 2 | + +## Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------------|-----------|------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-------| +| Date | TSG # | TSG Doc. | CR | R
e
v | Subject/Comment | Old | New | +| 2008-06 | | | | | Draft skeleton provided by rapporteur. | - | 0.0.0 | +| 2008-06 | CT1#54 | | | | Includes the following contributions agreed by CT1:
C1-082435, C1-082710 | 0.0.0 | 0.1.0 | +| 2008-08 | CT1#55 | | | | Includes the following contributions agreed by CT1:
C1-083518, C1-083519, C1-083520, C1-083521, C1-083523, C1-083586 | 0.1.0 | 0.2.0 | +| 2008-09 | e-mail review | | | | Added newly assigned TS number and updated title and scope for correct definition of VLR acronym. | 0.2.0 | 0.2.1 | +| 2008-10 | CT1#55 bis | | | | Includes the following contributions agreed by CT1:
C1-083821, C1-083822, C1-083824, C1-084195, C1-084199, C1-084300, C1-084301, C1-084302, C1-084303, C1-084304, C1-084305, C1-084306, C1-084307, C1-084312, C1-084314, C1-084483, C1-084485, C1-084486, C1-084487, C1-084488 | 0.2.1 | 0.3.0 | +| 2008-11 | CT1#56 | | | | Includes the following contributions agreed by CT1:
C1-084709, C1-084719, C1-084722, C1-085182, C1-085194, C1-085195, C1-085196, C1-085197, C1-085301, C1-085302, C1-085303, C1-085311, C1-085522
Changes by the rapporteur:
- correction of title for 3GPP TS 22.101 and 3GPP TS 32.422 in references subclause
- information element identifiers for LCS client identity, LCS indicator, MM information and SS code added to table 9.3.1
- details for coding of LCS client identity moved to figure 9.4.9.1 and details for coding of SS code moved to figure 9.4.19.1
- editorial corrections to align with drafting rules | 0.3.0 | 0.4.0 | +| 2008-11 | | | | | Version 1.0.0 created for presentation to CT#42 for information and approval | 0.4.0 | 1.0.0 | +| 2008-12 | CT#42 | | | | Version 8.0.0 created after approval in CT#42 | 1.0.0 | 8.0.0 | +| 2009-03 | CT#43 | CP-090154 | 0001 | 2 | Handle of CSFB paging procedure when UE is in connected mode | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0002 | | SGs paging with access control in E-UTRAN | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0003 | 2 | Clarifications of paging procedure in MME | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0004 | 1 | Consistent usage of HSS | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0005 | | Location update for non-EPS services procedure: failure and abnormal cases | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0006 | 1 | Clarifications for MM information procedure | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0007 | 1 | VLR number derivation | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0008 | 3 | Abnormal conditions for UL and DL Unitdata procedures | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0009 | 1 | MME behaviour when receiving paging for SMS | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0010 | 1 | Adding IE details | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0011 | 2 | Corrections in state models for VLR/MME | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0012 | 2 | SS handling details in VLR | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0013 | 2 | IE of paging request | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0014 | 1 | Corrections and additions for procedures for SMS delivery over SGs | 8.0.0 | 8.1.0 | +| 2009-06 | CT#44 | CP-090421 | 0017 | | Removing Editor's note on EPS location update type | 8.1.0 | 8.2.0 | +| 2009-06 | CT#44 | CP-090421 | 0019 | 1 | Correction of the location update initiation | 8.1.0 | 8.2.0 | +| 2009-06 | CT#44 | CP-090421 | 0021 | 1 | Paging Procedure when MME restarts | 8.1.0 | 8.2.0 | +| 2009-06 | CT#44 | CP-090421 | 0022 | | Forward of CS paging to the SGSN when ISR is activated | 8.1.0 | 8.2.0 | +| 2009-09 | CT#45 | CP-090674 | 0023 | | Correction to the Location update for non-EPS services procedure in the MME | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0024 | 1 | Support multiple SCTP associations | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0025 | | Port number and payload protocol identifier for SGsAP | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0026 | | The usage of timer Ns12 | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0027 | | Corrections for the length of IE | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0028 | 2 | Clarification of Location Update | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090675 | 0029 | 2 | Update for 'SMS-only' behaviour | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0031 | 2 | Clarify the condition for starting the location update for non-EPS services procedure | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090675 | 0033 | 1 | SMS over SGs charging and authority enquiry parameters | 8.2.0 | 8.3.0 | +| 2009-09 | CT#46 | CP-090916 | 0036 | 1 | Paging procedure in MME for supporting SMS only | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090916 | 0037 | 1 | Location update initiation for SMS over SGs only | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0038 | 6 | Corrections for SGs Service Request | 8.3.0 | 8.4.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|--------------------------------------------------------------------------------------------------------------|--------|--------| +| 2009-09 | CT#46 | CP-090916 | 0039 | 2 | Correction for Online and offline charging parameters | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0040 | 1 | Correction of definition of MME name | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0041 | 1 | Implicit detach procedure in VLR correction | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090916 | 0042 | | Remove use case of UE not supporting combined attach for 'SMS only' | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0043 | 1 | Handling of EPS detach indication | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0044 | | Correction of reference to TS 23.195 | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0046 | | MME executing the HSS location updating procedure and location update procedure for non-EPS services | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0047 | 1 | Correction of values of IMSI detach from EPS service type IE and IMSI detach from non-EPS service type IE | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090922 | 0034 | 1 | Paging signalling optimization after MME failure | 8.4.0 | 9.0.0 | +| 2009-09 | CT#46 | CP-090922 | 0035 | 2 | Paging clarifications | 8.4.0 | 9.0.0 | +| 2009-09 | CT#46 | CP-090922 | 0048 | 1 | Add UE EMM Mode IE in SGsAP-SERVICE-REQUEST message | 8.4.0 | 9.0.0 | +| 2010-03 | CT#47 | CP-100126 | 0049 | 2 | MME Name octet length correction | 9.0.0 | 9.1.0 | +| 2010-03 | CT#47 | CP-100126 | 0052 | | Alignment term "CSFB and SMS over SGs" with TS23.401 (Part III) | 9.0.0 | 9.1.0 | +| 2010-03 | CT#47 | CP-100134 | 0053 | 2 | Modification of the paging procedure | 9.0.0 | 9.1.0 | +| 2010-03 | CT#47 | CP-100126 | 0056 | | Clarification of paging procedure for SMS | 9.0.0 | 9.1.0 | +| 2010-03 | CT#47 | CP-100126 | 0058 | 1 | Paging for SMS on S3 and no paging retransmission in the MME | 9.0.0 | 9.1.0 | +| 2010-06 | CT#48 | CP-100348 | 0065 | 2 | Alert MME Notification / UE Activity Notification procedure on S3 interface | 9.1.0 | 9.2.0 | +| 2010-06 | CT#48 | CP-100348 | 0069 | 3 | Paging Procedures in the MME for SMS Service Type | 9.1.0 | 9.2.0 | +| 2010-06 | CT#48 | CP-100348 | 0072 | | Removal of reference to TS 23.195 | 9.1.0 | 9.2.0 | +| 2010-06 | CT#48 | CP-100354 | 0074 | 1 | New LAI derivation at MME | 9.1.0 | 9.2.0 | +| 2010-06 | CT#48 | CP-100370 | 0066 | 2 | Message Name and Miscellaneous Editorial changes | 9.2.0 | 10.0.0 | +| 2010-06 | CT#48 | CP-100370 | 0073 | | Update to service request procedure | 9.2.0 | 10.0.0 | +| 2010-09 | CT#49 | CP-100518 | 0076 | 1 | Location Update Retry on LAIs of other RATs | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100520 | 0081 | 4 | Add Timezone IE in Location Update Request | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0083 | 1 | MME Name | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100501 | 0086 | 2 | Correction to LAI derivation for default SGs scenario | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0088 | 3 | Call cancellation for CSFB MT | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100495 | 0091 | 1 | IMSI detach from EPS and Non-EPS services | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0098 | 2 | MME State Diagram Correction | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0102 | 2 | VLR Abnormal Case Handling for SMS-MO Call | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0103 | 2 | Data Restoration and SGs Association Recovery | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0105 | | Where to page for the UE for a mobile terminated CS call when no NAS signalling connection exists | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0106 | | SGsAP-SERVICE-REQUEST message is not sent when UE is in EMM-IDLE mode | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0111 | | Behavior of the recipient upon receipt of an erroneous SGsAP-Status message | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0112 | | Corrections related to use of location area identifier IE at MME upon receiving SGsAP-PAGING-REQUEST message | 10.0.0 | 10.1.0 | +| 2010-12 | CT#50 | CP-100763 | 0099 | 2 | VLR Failure Handling | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0100 | 2 | MME Failure Handling | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0107 | 2 | VLR name is not configured locally in the MME for SGsAP-Paging-Request | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0112 | 1 | Correction of use of release procedure | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0114 | 3 | CS PLMN determination for CSFB | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0117 | 1 | CS domain access rights check in CSFB | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100740 | 0122 | 1 | Paging failure on SGs | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0123 | | Length indicator in SGsAP information elements | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0124 | 2 | Adding location area identity to SGs location update reject message | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0127 | 3 | DST, Universal time and local time zone handling at the MME | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0128 | 1 | Call Forwarding on No Reply Triggering in EMM-CONNECTED Mode | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100740 | 0136 | | Removal of VLR number derivation by the MME | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0137 | 1 | Additional MME Abnormal Cases | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0142 | 1 | Removing unused stored parameters in the VLR | 10.1.0 | 10.2.0 | +| 2011-03 | CT#51 | CP-110197 | 0143 | | Requirement for inclusion of LCS client identity IE in SGsAP-PAGING-REQUEST message | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0144 | | Correction of handling of call forwarding | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0145 | 3 | Implicit detach handling for EPS and non-EPS services | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0148 | 1 | Explicit IMSI detach from EPS services triggered by PTAU reject | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0149 | 2 | Discarding LSA identity in MM INFORMATION REQUEST message | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110189 | 0150 | 2 | Clarification about usage of eMLPP priority IE in SGsAP-PAGING-REQUEST | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0151 | 1 | Implicit detach procedure in VLR when MME goes detached | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0153 | | Timer handling in detach response | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0154 | 1 | Location update trigger correction in SGs-ASSOCIATED state | 10.2.0 | 10.3.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|----------------------------------------------------------------------------------------------------------------------|--------|--------| +| 2011-03 | CT#51 | CP-110197 | 0155 | 1 | Paging accept in SGs NULL state at MME | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0156 | 2 | VLR behavior in SGs NULL state | 10.2.0 | 10.3.0 | +| 2011-06 | CT#52 | CP-110464 | 0158 | 2 | Correction on SGs UE unreachable handling | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0159 | 1 | UE Paging Initiation after SGs association has been established | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0160 | 1 | Detach handling for Implicit IMSI detach from non-EPS services | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110457 | 0162 | 1 | Removal of CS PLMN reselection requirement for CSFB | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0163 | 1 | New Location Update Request during TMSI reallocation procedure | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0165 | 1 | Updating IMSI detach flag during explicit IMSI detach for non-EPS services | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0167 | 1 | SMS paging at MME failure | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0171 | | MME state diagram corrections | 10.3.0 | 10.4.0 | +| 2011-09 | CT#53 | CP-110682 | 0174 | 2 | MO SMS over SGs handling at VLR failure | 10.4.0 | 10.5.0 | +| 2011-09 | CT#53 | CP-110684 | 0175 | 2 | MT SMS over SGs handling at VLR failure | 10.4.0 | 10.5.0 | +| 2011-09 | CT#53 | CP-110682 | 0176 | 1 | Correction on detach in SGs-NULL state for non-EPS service | 10.4.0 | 10.5.0 | +| 2011-09 | CT#53 | CP-110694 | 0169 | 3 | Abnormal case for SGs location update procedure | 10.5.0 | 11.0.0 | +| 2011-09 | CT#53 | CP-110691 | 0179 | 1 | Inclusion of SS Code in SGs Paging for Network initiated CISS Procedure | 10.5.0 | 11.0.0 | +| 2011-09 | CT#53 | CP-110691 | 0182 | 2 | Overlapping with TS 24.301 scope | 10.5.0 | 11.0.0 | +| 2011-12 | CT#54 | CP-110886 | 0177 | 6 | Restoration of CS Services during long MME failure | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110882 | 0180 | 4 | Asynchronous display of network name in CSFB deployment | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110882 | 0181 | 1 | Correction to references | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110888 | 0184 | 1 | Editorial corrections | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110858 | 0193 | 1 | Inclusion of E-UTRAN location in SGs Location Update message | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110874 | 0194 | 1 | Correction on trigger of EPS detach indication at the MME | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110888 | 0198 | 2 | Correct the behaviors of the VLR during the implicit IMSI detach procedure | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110942 | 0183 | 6 | Provide Subscriber Information handling for UE under LTE | 11.0.0 | 11.1.0 | +| 2012-03 | CT#55 | CP-120113 | 0186 | 6 | SGs paging handling in the VLR and the MME failure cases | 11.1.0 | 11.2.0 | +| 2012-06 | CT#56 | CP-120318 | 0203 | 3 | MME paging handling for "SMS Indicator" case | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120293 | 0207 | 2 | Change to the detach message for implicit detach at MME | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120293 | 0211 | 2 | Clarification of MME behaviour in receiving CS Paging when MRT has expired but IDT is running while ISR is activated | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120309 | 0213 | 2 | SGs Support for MSC in Pool to avoid dual VLR registration | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120318 | 0219 | 3 | Support of MAP signalling in the MME (via IWF) | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120315 | 0201 | 6 | Support of SMS in MME for PS-only subscription | 11.2.0 | 11.3.0 | +| 2012-09 | CT#57 | CP-120572 | 0221 | 2 | Partial VLR failure or VLR restart with CSFB while ISR is activated | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120594 | 0225 | 1 | Clarification of MME Name and VLR Name format | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120594 | 0227 | 1 | Transitioning to SGs-NULL upon Attach | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120584 | 0228 | 1 | Avoiding dual VLR registration for legacy UEs | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120589 | 0222 | 2 | Additional condition for skipping VLR SGs registration | 11.3.0 | 11.4.0 | +| 2012-12 | CT#58 | CP-120807 | 0232 | 3 | Handling of VLR failure without restart | 11.4.0 | 11.5.0 | +| 2012-12 | CT#58 | CP-120803 | 0233 | 5 | SMS in MME registration indication from the HSS | 11.4.0 | 11.5.0 | +| 2012-12 | CT#58 | CP-120807 | 0234 | 2 | Configurations with multiple SCTP endpoints per MME/VLR pair | 11.4.0 | 11.5.0 | +| 2012-12 | CT#58 | CP-120807 | 0239 | 5 | FQDN coding in VLR name and MME name | 11.4.0 | 11.5.0 | +| 2012-12 | CT#58 | CP-120898 | 0230 | 7 | Selected PLMN in network sharing for CSFB | 11.4.0 | 11.5.0 | +| 2013-03 | CT#59 | CP-130108 | 0242 | | SGs Interface applicability in case of SMS in MME | 11.5.0 | 11.6.0 | +| 2013-03 | CT#59 | CP-130123 | 0246 | 2 | CS domain operator selection in GWCN | 11.5.0 | 11.6.0 | +| 2013-03 | CT#59 | CP-130134 | 0241 | 6 | MME handling of VLR Failure without restart | 11.6.0 | 12.0.0 | +| 2013-03 | CT#59 | CP-130125 | 0243 | 2 | Editorial change on reset indication | 11.6.0 | 12.0.0 | +| 2013-06 | CT#60 | CP-130255 | 0249 | 1 | Correction to Selected CS Domain Operator IE definition | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0256 | 1 | Clarification on the SGs-implicit IMSI detach | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130239 | 0259 | 2 | Explicit IMSI detach trigger by the rejection of TAU procedure | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130264 | 0264 | 3 | State transition in the MME without SGs signaling | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0265 | 3 | Paging response from GERAN/UTRAN during CSFB | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130386 | 0266 | 3 | Implicit detach timer and implicit IMSI detach | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0267 | | Stop the timer Ts13 | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0268 | | Change VLR number to VLR name | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130264 | 0269 | 4 | Cause Value Mapping Method for Contact without 2G/3G Roaming Agreement | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0270 | 3 | VLR handling when CSFB UE failing to access to UTRAN/GERAN | 12.0.0 | 12.1.0 | +| 2013-09 | CT#61 | CP-130505 | 0276 | | General description for UE fallback supervision procedure | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130505 | 0277 | 2 | Re-paging for MT CSFB call at VLR | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130505 | 0278 | 1 | MME handling when receiving paging at the SGs-NULL | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130505 | 0279 | 2 | Handling the collision of call services | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130505 | 0283 | 2 | CSFB supervision via timer Ts5/Ts14 and CFNRy/CRNRc handling | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130510 | 0284 | 2 | Implicit IMSI detach triggering criteria | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130498 | 0292 | 1 | Clarification on SS code used in the Paging message | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130525 | 0296 | 2 | State of SGs association in the MME for emergency CSFB | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130573 | 0290 | 4 | Handling of VLR failure without restart during MO-SMS procedure | 12.1.0 | 12.2.0 | +| 2013-12 | CT#62 | CP-130762 | 0301 | | Correction on reference of message type IE | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130742 | 0303 | 5 | Addition of MO CSFB indication for return to last LTE PLMN | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130754 | 0304 | 1 | Cleanup of SGs paging without LAI case | 12.2.0 | 12.3.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|--------------------------------------------------------------------------------------------|--------|--------| +| 2013-12 | CT#62 | CP-130745 | 0306 | 6 | UE paging after TMSI reallocation procedure abort | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130739 | 0313 | 1 | Modification for paging with IMSI in MME for CSFB | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130754 | 0315 | 2 | Paging identity usage after new Location Update Request during TMSI reallocation procedure | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130754 | 0316 | | Trigger of the SGs service request procedure | 12.2.0 | 12.3.0 | +| 2014-03 | CT#63 | CP-140144 | 0314 | 3 | Collision of tracking area update and the MME initiated IMSI detach procedures | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140141 | 0320 | | Clarification on Ts14 minimum value | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140130 | 0326 | 1 | Response to SGs paging | 12.3.0 | 12.4.0 | +| 2014-06 | CT#64 | CP-140301 | 0329 | 1 | CSFB priority call handling in a network supporting Multimedia Priority Service | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140309 | 0331 | | Return to last LTE PLMN indication for emergency calls | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140331 | 0332 | 1 | Available old TMSI | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140328 | 0336 | 2 | Release of SGs association in case of SRVCC | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140304 | 0338 | 3 | Handling paging request for USSD when VoLTE call is ongoing | 12.4.0 | 12.5.0 | +| 2014-09 | CT#65 | CP-140661 | 0341 | 1 | Clarification on SCTP multi-homing support for SGsAP transport | 12.5.0 | 12.6.0 | +| 2014-12 | CT#66 | CP-140832 | 0343 | 3 | Service request in idle mode. | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140832 | 0346 | 2 | SGs paging when NAS signalling connection is present | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140832 | 0347 | | Removal of duplicated references TS 23.216 | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140862 | 0342 | | Correction of faulty interface reference | 12.7.0 | 13.0.0 | +| 2014-12 | CT#66 | CP-140862 | 0344 | 1 | Correct MME's behaviour in VLR fails without restart | 12.7.0 | 13.0.0 | +| 2014-12 | CT#66 | CP-140858 | 0345 | 1 | Collision during paging procedure in A/lu mode | 12.7.0 | 13.0.0 | +| 2015-06 | CT#68 | CP-150329 | 0354 | | Correction on background color of text | 13.0.0 | 13.1.0 | +| 2015-09 | CT#69 | CP-150529 | 0355 | 3 | SGs state change without SGsAP signalling at the MME during PS HO | 13.1.0 | 13.2.0 | +| 2015-09 | CT#69 | CP-150529 | 0356 | | IMSI format correction | 13.1.0 | 13.2.0 | +| 2016-03 | CT#71 | CP-160072 | 0357 | 8 | UE temporarily unreachable due to eDRX | 13.2.0 | 13.3.0 | +| 2016-03 | CT#71 | CP-160082 | 0358 | | Alignment of paging for MT-SMS in case of ISR activated and VLR failure | 13.2.0 | 13.3.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-09 | CT#73 | CP-160492 | 0359 | 6 | B | Prioritized SM retransmission by the SMS SC when the UE becomes reachable | 13.4.0 | +| 2016-09 | CT#73 | CP-160492 | 0360 | 5 | B | MT SM transmission to a UE in eDRX within the SM-Delivery-Start-Time/Timer | 13.4.0 | +| 2016-09 | CT#73 | CP-160492 | 0361 | 5 | B | MT SM retransmission by the SMS GMSC to a UE in eDRX at the time requested in the Delivery Report | 13.4.0 | +| 2016-09 | CT#73 | CP-160492 | 0362 | 1 | F | Improve the MT SMS over SGs procedure in eDRX | 13.4.0 | +| 2016-12 | CT#74 | CP-160722 | 0363 | 3 | F | Enabling SMS over SGs for NB-IoT only UEs | 13.5.0 | +| 2017-03 | CT#75 | CP-170110 | 0365 | 3 | F | Failure case handling of SMS over SGs for NB-IoT only UEs | 13.6.0 | +| 2017-03 | CT#75 | CP-170111 | 0367 | | F | Correction on CR implementation for eDRX | 13.6.0 | +| 2017-03 | SA#75 | | | | | Upgrade to Rel-14 | 14.0.0 | +| 2017-06 | CT#76 | CP-171073 | 0369 | | F | MS Classmark 2 IE not provided at normal procedures | 14.1.0 | +| 2017-06 | CT#76 | CP-171073 | 0370 | 1 | F | Specification of TMSI handling in the MME at SMS via SGs using normal procedures | 14.1.0 | +| 2017-06 | CT#76 | CP-171073 | 0371 | | F | Extended NAS timer impact on TMSI reallocation supervision timer | 14.1.0 | +| 2017-09 | CT#77 | CP-172120 | 0372 | | C | Handling of timer expiry during extended service request procedure for MT CSFB | 15.0.0 | +| 2017-12 | CT#78 | CP-173054 | 0376 | | A | Missing IE Identifier coding assignments for eDRX | 15.1.0 | +| 2017-12 | CT#78 | CP-173079 | 0377 | 1 | B | Setting of priority transport value for priority services on the SGs Interface | 15.1.0 | +| 2018-03 | CT#79 | CP-180088 | 0378 | | F | IMEISV inclusion criteria correction for ICS | 15.2.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | +| 2022-04 | SA-95e | - | - | - | | Update to Rel-17 version (MCC) | 17.0.0 | +| 2023-03 | CT#99 | CP-230246 | 0379 | | F | Correction on SS code inclusion in SGs paging | 18.0.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29510/raw.md b/raw/rel-18/29_series/29510/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..cb1e795f0fe13702108d51b323ca76a55248adbe --- /dev/null +++ b/raw/rel-18/29_series/29510/raw.md @@ -0,0 +1,17530 @@ + + +# 3GPP TS 29.510 V18.5.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Network Function Repository Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +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. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, stylized font with a red signal wave icon below the 'P', and the text 'A GLOBAL INITIATIVE' underneath. + +3GPP logo + +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. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------|----| +| Foreword..... | 11 | +| 1 Scope..... | 12 | +| 2 References..... | 12 | +| 3 Definitions and abbreviations..... | 14 | +| 3.1 Definitions..... | 14 | +| 3.2 Abbreviations..... | 14 | +| 4 Overview..... | 14 | +| 5 Services Offered by the NRF..... | 15 | +| 5.1 Introduction..... | 15 | +| 5.2 Nnrf_NFManagement Service..... | 16 | +| 5.2.1 Service Description..... | 16 | +| 5.2.2 Service Operations..... | 17 | +| 5.2.2.1 Introduction..... | 17 | +| 5.2.2.2 NFRegister..... | 18 | +| 5.2.2.2.1 General..... | 18 | +| 5.2.2.2.2 NF (other than NRF) registration to NRF..... | 18 | +| 5.2.2.2.3 NRF registration to another NRF..... | 19 | +| 5.2.2.3 NFUpdate..... | 19 | +| 5.2.2.3.1 General..... | 19 | +| 5.2.2.3.2 NF Heart-Beat..... | 21 | +| 5.2.2.4 NFDeregister..... | 22 | +| 5.2.2.4.1 General..... | 22 | +| 5.2.2.5 NFStatusSubscribe..... | 23 | +| 5.2.2.5.1 General..... | 23 | +| 5.2.2.5.2 Subscription to NF Instances in the same PLMN..... | 23 | +| 5.2.2.5.3 Subscription to NF Instances in a different PLMN..... | 24 | +| 5.2.2.5.4 Subscription to NF Instances with intermediate forwarding NRF..... | 25 | +| 5.2.2.5.5 Subscription to NF Instances with intermediate redirecting NRF..... | 26 | +| 5.2.2.5.6 Update of Subscription to NF Instances..... | 27 | +| 5.2.2.5.7 Update of Subscription to NF Instances in a different PLMN..... | 28 | +| 5.2.2.6 NFStatusNotify..... | 29 | +| 5.2.2.6.1 General..... | 29 | +| 5.2.2.6.2 Notification from NRF in the same PLMN..... | 29 | +| 5.2.2.6.3 Notification from NRF in a different PLMN..... | 31 | +| 5.2.2.6.4 Notification for subscription via intermediate NRF..... | 32 | +| 5.2.2.7 NFStatusUnSubscribe..... | 32 | +| 5.2.2.7.1 General..... | 32 | +| 5.2.2.7.2 Subscription removal in the same PLMN..... | 32 | +| 5.2.2.7.3 Subscription removal in a different PLMN..... | 33 | +| 5.2.2.8 NFListRetrieval..... | 33 | +| 5.2.2.8.1 General..... | 33 | +| 5.2.2.9 NFProfileRetrieval..... | 34 | +| 5.2.2.9.1 General..... | 34 | +| 5.3 Nnrf_NFDiscovery Service..... | 35 | +| 5.3.1 Service Description..... | 35 | +| 5.3.2 Service Operations..... | 35 | +| 5.3.2.1 Introduction..... | 35 | +| 5.3.2.2 NFDiscover..... | 36 | +| 5.3.2.2.1 General..... | 36 | +| 5.3.2.2.2 Service Discovery in the same PLMN..... | 37 | +| 5.3.2.2.3 Service Discovery in a different PLMN..... | 38 | +| 5.3.2.2.4 Service Discovery with intermediate redirecting NRF..... | 39 | +| 5.3.2.2.5 Service Discovery with intermediate forwarding NRF..... | 40 | +| 5.3.2.2.6 Service Discovery with resolution of the target PLMN..... | 41 | + +| | | | +|-----------|-------------------------------------------------------------|----| +| 5.3.2.3 | SCPDomainRoutingInfoGet..... | 42 | +| 5.3.2.4 | SCPDomainRoutingInfoSubscribe..... | 43 | +| 5.3.2.5 | SCPDomainRoutingInfoNotify..... | 43 | +| 5.3.2.6 | SCPDomainRoutingInfoUnSubscribe..... | 44 | +| 5.4 | Nnrf_AccessToken Service..... | 44 | +| 5.4.1 | Service Description..... | 44 | +| 5.4.2 | Service Operations..... | 45 | +| 5.4.2.1 | Introduction..... | 45 | +| 5.4.2.2 | Get (Access Token Request)..... | 45 | +| 5.4.2.2.1 | General..... | 45 | +| 5.4.2.2.2 | Access Token request with intermediate forwarding NRF..... | 46 | +| 5.4.2.2.3 | Access Token request with intermediate redirecting NRF..... | 47 | +| 5.5 | Nnrf_Bootstrapping Service..... | 48 | +| 5.5.1 | Service Description..... | 48 | +| 5.5.2 | Service Operations..... | 49 | +| 5.5.2.1 | Introduction..... | 49 | +| 5.5.2.2 | Get..... | 49 | +| 5.5.2.2.1 | General..... | 49 | +| 6 | API Definitions..... | 50 | +| 6.1 | Nnrf_NFManagement Service API..... | 50 | +| 6.1.1 | API URI..... | 50 | +| 6.1.2 | Usage of HTTP..... | 50 | +| 6.1.2.1 | General..... | 50 | +| 6.1.2.2 | HTTP standard headers..... | 50 | +| 6.1.2.2.1 | General..... | 50 | +| 6.1.2.2.2 | Content type..... | 50 | +| 6.1.2.2.3 | Accept-Encoding..... | 51 | +| 6.1.2.2.4 | ETag..... | 51 | +| 6.1.2.2.5 | If-Match..... | 51 | +| 6.1.2.3 | HTTP custom headers..... | 51 | +| 6.1.2.3.1 | General..... | 51 | +| 6.1.3 | Resources..... | 51 | +| 6.1.3.1 | Overview..... | 51 | +| 6.1.3.2 | Resource: nf-instances (Store)..... | 53 | +| 6.1.3.2.1 | Description..... | 53 | +| 6.1.3.2.2 | Resource Definition..... | 53 | +| 6.1.3.2.3 | Resource Standard Methods..... | 53 | +| 6.1.3.2.4 | Resource Custom Operations..... | 57 | +| 6.1.3.3 | Resource: nf-instance (Document)..... | 57 | +| 6.1.3.3.1 | Description..... | 57 | +| 6.1.3.3.2 | Resource Definition..... | 57 | +| 6.1.3.3.3 | Resource Standard Methods..... | 58 | +| 6.1.3.4 | Resource: subscriptions (Collection)..... | 64 | +| 6.1.3.4.1 | Description..... | 64 | +| 6.1.3.4.2 | Resource Definition..... | 64 | +| 6.1.3.4.3 | Resource Standard Methods..... | 64 | +| 6.1.3.5 | Resource: subscription (Document)..... | 66 | +| 6.1.3.5.1 | Description..... | 66 | +| 6.1.3.5.2 | Resource Definition..... | 66 | +| 6.1.3.5.3 | Resource Standard Methods..... | 66 | +| 6.1.4 | Custom Operations without associated resources..... | 68 | +| 6.1.5 | Notifications..... | 68 | +| 6.1.5.1 | General..... | 68 | +| 6.1.5.2 | NF Instance Status Notification..... | 69 | +| 6.1.5.2.1 | Description..... | 69 | +| 6.1.5.2.2 | Notification Definition..... | 69 | +| 6.1.6 | Data Model..... | 70 | +| 6.1.6.1 | General..... | 70 | +| 6.1.6.2 | Structured data types..... | 76 | +| 6.1.6.2.1 | Introduction..... | 76 | +| 6.1.6.2.2 | Type: NFProfile..... | 77 | + +| | | | +|------------|--------------------------------------------|-----| +| 6.1.6.2.3 | Type: NFService..... | 87 | +| 6.1.6.2.4 | Type: DefaultNotificationSubscription..... | 94 | +| 6.1.6.2.5 | Type: IpEndPoint..... | 96 | +| 6.1.6.2.6 | Type: UdrInfo..... | 97 | +| 6.1.6.2.7 | Type: UdmInfo..... | 98 | +| 6.1.6.2.8 | Type: AusfInfo..... | 99 | +| 6.1.6.2.9 | Type: SupiRange..... | 99 | +| 6.1.6.2.10 | Type: IdentityRange..... | 100 | +| 6.1.6.2.11 | Type: AmfInfo..... | 101 | +| 6.1.6.2.12 | Type: SmfInfo..... | 103 | +| 6.1.6.2.13 | Type: UpfInfo..... | 105 | +| 6.1.6.2.14 | Type: SnssaiUpfInfoItem..... | 107 | +| 6.1.6.2.15 | Type: DnnUpfInfoItem..... | 108 | +| 6.1.6.2.16 | Type: SubscriptionData..... | 109 | +| 6.1.6.2.17 | Type: NotificationData..... | 113 | +| 6.1.6.2.18 | Void..... | 114 | +| 6.1.6.2.19 | Type: NFServiceVersion..... | 114 | +| 6.1.6.2.20 | Type: PcfInfo..... | 115 | +| 6.1.6.2.21 | Type: BsfInfo..... | 116 | +| 6.1.6.2.22 | Type: Ipv4AddressRange..... | 116 | +| 6.1.6.2.23 | Type: Ipv6PrefixRange..... | 117 | +| 6.1.6.2.24 | Type: InterfaceUpfInfoItem..... | 117 | +| 6.1.6.2.25 | Type: UriList..... | 117 | +| 6.1.6.2.26 | Type: N2InterfaceAmfInfo..... | 118 | +| 6.1.6.2.27 | Type: TaiRange..... | 118 | +| 6.1.6.2.28 | Type: TacRange..... | 118 | +| 6.1.6.2.29 | Type: SnssaiSmfInfoItem..... | 119 | +| 6.1.6.2.30 | Type: DnnSmfInfoItem..... | 119 | +| 6.1.6.2.31 | Type: NrfInfo..... | 120 | +| 6.1.6.2.32 | Type: ChfInfo..... | 123 | +| 6.1.6.2.33 | Void..... | 124 | +| 6.1.6.2.34 | Type: PlmnRange..... | 124 | +| 6.1.6.2.35 | Type: SubscrCond..... | 125 | +| 6.1.6.2.36 | Type: NfInstanceIdCond..... | 125 | +| 6.1.6.2.37 | Type: NfTypeCond..... | 126 | +| 6.1.6.2.38 | Type: ServiceNameCond..... | 126 | +| 6.1.6.2.39 | Type: AmfCond..... | 126 | +| 6.1.6.2.40 | Type: GuamiListCond..... | 126 | +| 6.1.6.2.41 | Type: NetworkSliceCond..... | 126 | +| 6.1.6.2.42 | Type: NfGroupCond..... | 127 | +| 6.1.6.2.43 | Type: NotifCondition..... | 127 | +| 6.1.6.2.44 | Type: PlmnSnssai..... | 127 | +| 6.1.6.2.45 | Type: NwdafInfo..... | 128 | +| 6.1.6.2.46 | Type: LmfInfo..... | 129 | +| 6.1.6.2.47 | Type: GmlcInfo..... | 130 | +| 6.1.6.2.48 | Type: NefInfo..... | 131 | +| 6.1.6.2.49 | Type: PfdData..... | 132 | +| 6.1.6.2.50 | Type: AfEventExposureData..... | 132 | +| 6.1.6.2.51 | Type: WAgfInfo..... | 132 | +| 6.1.6.2.52 | Type: TngfInfo..... | 133 | +| 6.1.6.2.53 | Type: PscfInfo..... | 133 | +| 6.1.6.2.54 | Type: NfSetCond..... | 134 | +| 6.1.6.2.55 | Type: NfServiceSetCond..... | 134 | +| 6.1.6.2.56 | Type: NfInfo..... | 134 | +| 6.1.6.2.57 | Type: HssInfo..... | 135 | +| 6.1.6.2.58 | Type: ImsiRange..... | 135 | +| 6.1.6.2.59 | Type: InternalGroupIdRange..... | 136 | +| 6.1.6.2.60 | Type: UpfCond..... | 136 | +| 6.1.6.2.61 | Type: TwifInfo..... | 136 | +| 6.1.6.2.62 | Type: VendorSpecificFeature..... | 137 | +| 6.1.6.2.63 | Type: UdsfInfo..... | 137 | + +| | | | +|-------------|------------------------------------|-----| +| 6.1.6.2.64 | Type: NfInstanceIdListCond..... | 137 | +| 6.1.6.2.65 | Type: ScpInfo..... | 138 | +| 6.1.6.2.66 | Type: ScpDomainInfo..... | 140 | +| 6.1.6.2.67 | Type: ScpDomainCond..... | 140 | +| 6.1.6.2.68 | Type: OptionsResponse..... | 141 | +| 6.1.6.2.69 | Type: NwdafCond..... | 141 | +| 6.1.6.2.70 | Type: NefCond..... | 142 | +| 6.1.6.2.71 | Type: SuciInfo..... | 142 | +| 6.1.6.2.72 | Type: SeppInfo..... | 143 | +| 6.1.6.2.73 | Type: AanfInfo..... | 143 | +| 6.1.6.2.74 | Type: 5GDnmfInfo..... | 143 | +| 6.1.6.2.75 | Type: MfafInfo..... | 144 | +| 6.1.6.2.76 | Type: NwdafCapability..... | 145 | +| 6.1.6.2.77 | Type: EasdfInfo..... | 145 | +| 6.1.6.2.78 | Type: SnssaiEasdfInfoItem..... | 146 | +| 6.1.6.2.79 | Type: DnnEasdfInfoItem..... | 146 | +| 6.1.6.2.80 | Type: DccfInfo..... | 146 | +| 6.1.6.2.81 | Type: NsacfInfo..... | 147 | +| 6.1.6.2.82 | Type: NsacfCapability..... | 147 | +| 6.1.6.2.83 | Type: DccfCond..... | 148 | +| 6.1.6.2.84 | Type: MIAnalyticsInfo..... | 148 | +| 6.1.6.2.85 | Type: MbSmfInfo..... | 149 | +| 6.1.6.2.86 | Type: TmgiRange..... | 149 | +| 6.1.6.2.87 | Type: MbsSession..... | 150 | +| 6.1.6.2.88 | Type: SnssaiMbSmfInfoItem..... | 150 | +| 6.1.6.2.89 | Type: DnnMbSmfInfoItem..... | 150 | +| 6.1.6.2.90 | Void..... | 151 | +| 6.1.6.2.91 | Type: TsctsInfo..... | 151 | +| 6.1.6.2.92 | Type: SnssaiTsctsInfoItem..... | 151 | +| 6.1.6.2.93 | Type: DnnTsctsInfoItem..... | 151 | +| 6.1.6.2.94 | Type: MbUpfInfo..... | 152 | +| 6.1.6.2.95 | Type: UnTrustAfInfo..... | 153 | +| 6.1.6.2.96 | Type: TrustAfInfo..... | 153 | +| 6.1.6.2.97 | Type: SnssaiInfoItem..... | 154 | +| 6.1.6.2.98 | Type: DnnInfoItem..... | 154 | +| 6.1.6.2.99 | Type: CollocatedNfInstance..... | 154 | +| 6.1.6.2.100 | Type: ServiceNameListCond..... | 154 | +| 6.1.6.2.101 | Type: NfGroupListCond..... | 155 | +| 6.1.6.2.102 | Type: PlmnOAuth2..... | 155 | +| 6.1.6.2.103 | Type: V2xCapability..... | 155 | +| 6.1.6.2.104 | Type: NssaaInfo..... | 156 | +| 6.1.6.2.105 | Type: ProSeCapability..... | 157 | +| 6.1.6.2.106 | Type: SharedDataIdRange..... | 158 | +| 6.1.6.2.107 | Type: SubscriptionContext..... | 158 | +| 6.1.6.2.108 | Type: IwmscInfo..... | 158 | +| 6.1.6.2.109 | Type: MnpfInfo..... | 159 | +| 6.1.6.2.110 | Type: DefSubServiceInfo..... | 159 | +| 6.1.6.2.111 | Type: LocalityDescriptionItem..... | 159 | +| 6.1.6.2.112 | Type: LocalityDescription..... | 159 | +| 6.1.6.2.113 | Type: SmsfInfo..... | 160 | +| 6.1.6.2.114 | Type: DcsfInfo..... | 160 | +| 6.1.6.2.115 | Type: MIModelInterInfo..... | 160 | +| 6.1.6.2.116 | Type: PruExistenceInfo..... | 161 | +| 6.1.6.2.117 | Type: MrfInfo..... | 161 | +| 6.1.6.2.118 | Type: MrfpInfo..... | 161 | +| 6.1.6.2.119 | Type: MfInfo..... | 161 | +| 6.1.6.2.120 | Type: A2xCapability..... | 162 | +| 6.1.6.2.121 | Type: RuleSet..... | 163 | +| 6.1.6.2.122 | Type: AdrfInfo..... | 164 | +| 6.1.6.2.123 | Type: SelectionConditions..... | 164 | +| 6.1.6.2.124 | Type: ConditionItem..... | 165 | + +| | | | +|-------------|--------------------------------------------------------------------------|-----| +| 6.1.6.2.125 | Type: ConditionGroup..... | 166 | +| 6.1.6.2.126 | Type: EpdgInfo..... | 166 | +| 6.1.6.2.127 | Type: CallbackUriPrefixItem..... | 166 | +| 6.1.6.3 | Simple data types and enumerations..... | 166 | +| 6.1.6.3.1 | Introduction..... | 166 | +| 6.1.6.3.2 | Simple data types..... | 166 | +| 6.1.6.3.3 | Enumeration: NFType..... | 167 | +| 6.1.6.3.4 | Enumeration: NotificationType..... | 170 | +| 6.1.6.3.5 | Enumeration: TransportProtocol..... | 172 | +| 6.1.6.3.6 | Enumeration: NotificationEventType..... | 172 | +| 6.1.6.3.7 | Enumeration: NFStatus..... | 172 | +| 6.1.6.3.8 | Enumeration: DataSetId..... | 172 | +| 6.1.6.3.9 | Enumeration: UPInterfaceType..... | 174 | +| 6.1.6.3.10 | Relation Types..... | 174 | +| 6.1.6.3.11 | Enumeration: ServiceName..... | 175 | +| 6.1.6.3.12 | Enumeration: NFServiceStatus..... | 177 | +| 6.1.6.3.13 | Enumeration: AnNodeType..... | 178 | +| 6.1.6.3.14 | Enumeration: ConditionEventType..... | 178 | +| 6.1.6.3.15 | Enumeration: IpReachability..... | 178 | +| 6.1.6.3.16 | Enumeration: ScpCapability..... | 178 | +| 6.1.6.3.17 | Enumeration: CollocatedNfType..... | 178 | +| 6.1.6.3.18 | Enumeration: LocalityType..... | 179 | +| 6.1.6.3.19 | Enumeration: FICapabilityType..... | 179 | +| 6.1.6.3.20 | Void..... | 179 | +| 6.1.6.3.21 | Enumeration: RuleSetAction..... | 179 | +| 6.1.7 | Error Handling..... | 179 | +| 6.1.7.1 | General..... | 179 | +| 6.1.7.2 | Protocol Errors..... | 179 | +| 6.1.7.3 | Application Errors..... | 179 | +| 6.1.8 | Security..... | 180 | +| 6.1.9 | Features supported by the NFManagement service..... | 180 | +| 6.2 | Nnrf_NFDiscovery Service API..... | 181 | +| 6.2.1 | API URI..... | 181 | +| 6.2.2 | Usage of HTTP..... | 181 | +| 6.2.2.1 | General..... | 181 | +| 6.2.2.2 | HTTP standard headers..... | 182 | +| 6.2.2.2.1 | General..... | 182 | +| 6.2.2.2.2 | Content type..... | 182 | +| 6.2.2.2.3 | Cache-Control..... | 182 | +| 6.2.2.2.4 | ETag..... | 182 | +| 6.2.2.2.5 | If-None-Match..... | 182 | +| 6.2.2.3 | HTTP custom headers..... | 182 | +| 6.2.2.3.1 | General..... | 182 | +| 6.2.3 | Resources..... | 182 | +| 6.2.3.1 | Overview..... | 182 | +| 6.2.3.2 | Resource: nf-instances (Store)..... | 184 | +| 6.2.3.2.1 | Description..... | 184 | +| 6.2.3.2.2 | Resource Definition..... | 184 | +| 6.2.3.2.3 | Resource Standard Methods..... | 184 | +| 6.2.3.2.4 | Resource Custom Operations..... | 207 | +| 6.2.3.3 | Resource: Stored Search (Document)..... | 207 | +| 6.2.3.3.1 | Description..... | 207 | +| 6.2.3.3.2 | Resource Definition..... | 207 | +| 6.2.3.4 | Resource: Complete Stored Search (Document)..... | 208 | +| 6.2.3.4.1 | Description..... | 208 | +| 6.2.3.4.2 | Resource Definition..... | 208 | +| 6.2.3.5 | Resource: SCP Domain Routing Information (Document)..... | 209 | +| 6.2.3.5.1 | Description..... | 209 | +| 6.2.3.5.2 | Resource Definition..... | 209 | +| 6.2.3.6 | Resource: SCP Domain Routing Information Subscriptions (Collection)..... | 210 | +| 6.2.3.6.1 | Description..... | 210 | + +| | | | +|------------|----------------------------------------------------------------------------------|-----| +| 6.2.3.6.2 | Resource Definition..... | 210 | +| 6.2.3.6.3 | Resource Standard Methods..... | 210 | +| 6.2.3.7 | Resource: Individual SCP Domain Routing Information Subscription (Document)..... | 211 | +| 6.2.3.7.1 | Description..... | 211 | +| 6.2.3.7.2 | Resource Definition..... | 211 | +| 6.2.3.7.3 | Resource Standard Methods..... | 211 | +| 6.2.4 | Custom Operations without associated resources..... | 212 | +| 6.2.5 | Notifications..... | 212 | +| 6.2.5.1 | General..... | 212 | +| 6.2.5.2 | SCP Domain Routing Information Change Notification..... | 212 | +| 6.2.5.2.1 | Description..... | 212 | +| 6.2.5.2.2 | Notification Definition..... | 212 | +| 6.2.6 | Data Model..... | 213 | +| 6.2.6.1 | General..... | 213 | +| 6.2.6.2 | Structured data types..... | 216 | +| 6.2.6.2.1 | Introduction..... | 216 | +| 6.2.6.2.2 | Type: SearchResult..... | 217 | +| 6.2.6.2.3 | Type: NFProfile..... | 219 | +| 6.2.6.2.4 | Type: NFService..... | 226 | +| 6.2.6.2.5 | Type: StoredSearchResult..... | 230 | +| 6.2.6.2.6 | Type: PreferredSearch..... | 231 | +| 6.2.6.2.7 | Type: NfInstanceInfo..... | 233 | +| 6.2.6.2.8 | Type: ScpDomainRoutingInformation..... | 233 | +| 6.2.6.2.9 | Type: ScpDomainConnectivity..... | 234 | +| 6.2.6.2.10 | Type: ScpDomainRoutingInfoSubscription..... | 234 | +| 6.2.6.2.11 | Type: ScpDomainRoutingInfoNotification..... | 235 | +| 6.2.6.2.12 | Type: NfServiceInstance..... | 235 | +| 6.2.6.2.13 | Type: NoProfileMatchInfo..... | 235 | +| 6.2.6.2.14 | Type: QueryParamCombination..... | 235 | +| 6.2.6.2.15 | Type: QueryParameter..... | 235 | +| 6.2.6.2.16 | Type: AfData..... | 236 | +| 6.2.6.2.17 | Type: SearchResultInfo..... | 236 | +| 6.2.6.3 | Simple data types and enumerations..... | 236 | +| 6.2.6.3.1 | Introduction..... | 236 | +| 6.2.6.3.2 | Simple data types..... | 236 | +| 6.2.6.3.3 | Enumeration: NoProfileMatchReason..... | 236 | +| 6.2.7 | Error Handling..... | 237 | +| 6.2.7.1 | General..... | 237 | +| 6.2.7.2 | Protocol Errors..... | 237 | +| 6.2.7.3 | Application Errors..... | 237 | +| 6.2.8 | Security..... | 237 | +| 6.2.9 | Features supported by the NFDiscovery service..... | 238 | +| 6.3 | Nnrf_AccessToken Service API..... | 242 | +| 6.3.1 | General..... | 242 | +| 6.3.2 | API URI..... | 243 | +| 6.3.3 | Usage of HTTP..... | 243 | +| 6.3.3.1 | General..... | 243 | +| 6.3.3.2 | HTTP standard headers..... | 243 | +| 6.3.3.2.1 | General..... | 243 | +| 6.3.3.2.2 | Content type..... | 243 | +| 6.3.3.3 | HTTP custom headers..... | 243 | +| 6.3.3.3.1 | General..... | 243 | +| 6.3.4 | Custom Operations without associated resources..... | 243 | +| 6.3.4.1 | Overview..... | 243 | +| 6.3.4.2 | Operation: Get (Access Token Request)..... | 244 | +| 6.3.4.2.1 | Description..... | 244 | +| 6.3.4.2.2 | Operation Definition..... | 244 | +| 6.3.5 | Data Model..... | 246 | +| 6.3.5.1 | General..... | 246 | +| 6.3.5.2 | Structured data types..... | 246 | +| 6.3.5.2.1 | Introduction..... | 246 | + +| | | | +|-----------|---------------------------------------------------------------------------------|-----| +| 6.3.5.2.2 | Type: AccessTokenReq..... | 247 | +| 6.3.5.2.3 | Type: AccessTokenRsp..... | 250 | +| 6.3.5.2.4 | Type: AccessTokenClaims..... | 251 | +| 6.3.5.2.5 | Type: AccessTokenErr..... | 252 | +| 6.3.5.3 | Simple data types and enumerations..... | 253 | +| 6.3.5.3.1 | Introduction..... | 253 | +| 6.3.5.3.2 | Simple data types..... | 253 | +| 6.3.5.3.3 | Void..... | 253 | +| 6.3.5.4 | Data types describing alternative data types or combinations of data types..... | 253 | +| 6.3.5.4.1 | Type: Audience..... | 253 | +| 6.3.6 | Error Handling..... | 253 | +| 6.3.6.1 | General..... | 253 | +| 6.3.6.2 | Protocol Errors..... | 253 | +| 6.3.6.3 | Application Errors..... | 253 | +| 6.4 | Nnrf_Bootstrapping Service API..... | 254 | +| 6.4.1 | API URI..... | 254 | +| 6.4.2 | Usage of HTTP..... | 254 | +| 6.4.2.1 | General..... | 254 | +| 6.4.2.2 | HTTP standard headers..... | 254 | +| 6.4.2.2.1 | General..... | 254 | +| 6.4.2.2.2 | Content type..... | 254 | +| 6.4.2.2.3 | Cache-Control..... | 254 | +| 6.4.2.2.4 | ETag..... | 254 | +| 6.4.2.2.5 | If-None-Match..... | 254 | +| 6.4.2.3 | HTTP custom headers..... | 255 | +| 6.4.2.3.1 | General..... | 255 | +| 6.4.3 | Resources..... | 255 | +| 6.4.3.1 | Overview..... | 255 | +| 6.4.3.2 | Resource: Bootstrapping (Document)..... | 255 | +| 6.4.3.2.1 | Description..... | 255 | +| 6.4.3.2.2 | Resource Definition..... | 255 | +| 6.4.3.2.3 | Resource Standard Methods..... | 256 | +| 6.4.4 | Custom Operations without associated resources..... | 256 | +| 6.4.5 | Notifications..... | 256 | +| 6.4.6 | Data Model..... | 256 | +| 6.4.6.1 | General..... | 256 | +| 6.4.6.2 | Structured data types..... | 257 | +| 6.4.6.2.1 | Introduction..... | 257 | +| 6.4.6.2.2 | Type: BootstrappingInfo..... | 258 | +| 6.4.6.3 | Simple data types and enumerations..... | 258 | +| 6.4.6.3.1 | Introduction..... | 258 | +| 6.4.6.3.2 | Enumeration: Status..... | 258 | +| 6.4.6.3.3 | Relation Types..... | 259 | + +| | | | +|-------------------------------|-----------------------------------------------------------------------------------------------------------------------|------------| +| Annex A (normative): | OpenAPI specification..... | 260 | +| A.1 | General..... | 260 | +| A.2 | Nnrf_NFManagement API..... | 260 | +| A.3 | Nnrf_NFDiscovery API..... | 328 | +| A.4 | Nnrf_AccessToken API (NRF OAuth2 Authorization)..... | 360 | +| A.5 | Nnrf_Bootstrapping API..... | 364 | +| Annex B (normative): | NF Profile changes in NFRegister and NFUpdate responses..... | 366 | +| B.1 | General..... | 366 | +| Annex C (normative): | Enhanced Authorization Policy using RuleSets in NF (Service) Profile..... | 367 | +| C.1 | General..... | 367 | +| C.2 | Examples of NF-Producer profile only using RuleSets (i.e. without AllowedXXX parameters) in NF (Service) Profile..... | 367 | +| C.3 | Example of NF-Producer profile using RuleSets and AllowedXXX parameters in NF (Service) Profile..... | 368 | +| C.4 | Backward Compatibility..... | 369 | +| Annex D (normative): | Support of "Canary Release" testing in the NRF..... | 369 | +| Annex E (informative): | Change history..... | 373 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nnrf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the NRF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +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]. + +--- + +## 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [7] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [8] ECMA-262: "ECMAScript® Language Specification", . +- [9] IETF RFC 9113: "HTTP/2". +- [10] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0", . +- [11] IETF RFC 9457: "Problem Details for HTTP APIs". +- [12] 3GPP TS 23.003: "Numbering, Addressing and Identification". +- [13] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [14] IETF RFC 6901: "JavaScript Object Notation (JSON) Pointer". + +- [15] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [16] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [17] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [18] IETF RFC 4122: "A Universally Unique Identifier (UUID) URN Namespace". +- [19] Void. +- [20] IETF RFC 9111: "HTTP Caching". +- [21] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane Nodes; Stage 3". +- [22] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [23] IETF RFC 2782: "A DNS RR for specifying the location of services (DNS SRV)". +- [24] IETF RFC 7515: "JSON Web Signature (JWS)". +- [25] IETF RFC 7519: "JSON Web Token (JWT)". +- [26] W3C HTML 4.01 Specification, . +- [27] 3GPP TS 23.527: "5G System; Restoration Procedures; Stage 2". +- [28] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [29] 3GPP TS 38.413: "NG-RAN; NG Application Protocol (NGAP)". +- [30] IETF RFC 1952: "GZIP file format specification version 4.3". +- [31] 3GPP TR 21.900: "Technical Specification Group working methods". +- [32] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [33] 3GPP TS 29.572: "5G System; Location Management Services; Stage 3". +- [34] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [35] 3GPP TS 29.517: "Application Function Event Exposure Service". +- [36] 3GPP TS 29.503: "Unified Data Management Services". +- [37] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [38] IANA: "SMI Network Management Private Enterprise Codes", . +- [39] Semantic Versioning Specification: . +- [40] IETF RFC 9110: "HTTP Semantics". +- [41] Void. +- [42] 3GPP TS 29.531: "5G System; Network Slice Selection Services; Stage 3". +- [43] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services". +- [44] ITU-T Recommendation E.164: "The international public telecommunication numbering plan". +- [45] 3GPP TS 23.380: "IMS Restoration Procedures". +- [46] 3GPP TS 32.255: "Telecommunication management; Charging management; 5G data connectivity domain charging; Stage 2". + +- [47] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [48] 3GPP TS 23.540: "5G System; Technical realization of Service Based Short Message Service; Stage 2". +- [49] 3GPP TS 29.564: "5G System; User Plane Function Services; Stage 3". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +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]. + +**Canary Release:** When an NF Instance is software upgraded, a canary release allows to have features incrementally tested by a small set of users, which can be targeted by geographic locations or user attributes (e.g., SUPI, PEI, ...). If a feature's performance is not satisfactory, then it can be rolled back without any adverse effects on the rest of the system. + +### 3.2 Abbreviations + +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]. + +| | | +|--------|----------------------------------------------------------------| +| 5GC | 5G Core Network | +| CEF | Charging Enablement Function | +| CH | Credentials Holder | +| CHF | Charging Function | +| DCS | Default Credentials Server | +| DCSF | Data Channel Signaling Function | +| IPUPS | Inter-PLMN User Plane Security | +| MBS | Multicast/Broadcast Service | +| MB-SMF | Multicast/Broadcast Session Management Function | +| NF | Network Function | +| NRF | NF Repository Function | +| NWDAF | Network Data Analytics Function | +| PFD | Packet Flow Description | +| PRU | Positioning Reference Unit | +| SNPN | Stand-alone Non-Public Network | +| SSM | Source Specific IP Multicast (address) | +| TNGF | Trusted Non-3GPP Gateway Function | +| TSCTSF | Time Sensitive Communication and Time Synchronization Function | +| TWIF | Trusted WLAN Interworking Function | +| W-AGF | Wireline Access Gateway Function | + +--- + +## 4 Overview + +The Network Function (NF) Repository Function (NRF) is the network entity in the 5G Core Network (5GC) supporting the following functionality: + +- Maintains the NF profile of available NF instances and their supported services; +- Maintains the SCP profile of available SCP instances; +- Maintains the SEPP profile of available SEPP instances; + +- Allows other NF or SCP instances to subscribe to, and get notified about, the registration in NRF of new NF instances of a given type or of SEPP instances. It also allows SCP instances to subscribe to, and get notified about, the registration in NRF of new SCP instances; +- Supports service discovery function. It receives NF Discovery Requests from NF or SCP instances, and provides the information of the available NF instances fulfilling certain criteria (e.g., supporting a given service); +- Support SCP discovery function. It receives NF Discovery Requests for SCP profiles from other SCP instances, and provides the information of the available SCP instances fulfilling certain criteria (e.g., serving a given NF set); +- Support SEPP discovery function. It receives NF Discovery Requests for SEPP profiles from other NF or SCP instances, and provides the information of the available SEPP instances fulfilling certain criteria (e.g. supporting connectivity with a remote PLMN). + +Figures 4-1 shows the reference architecture for the 5GC, with focus on the NRF: + +![Figure 4-1: 5G System architecture diagram showing the HPLMN and VPLMN components and their interactions.](9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg) + +The diagram illustrates the 5G System architecture, divided into HPLMN (Home PLMN) and VPLMN (Visited PLMN) by a vertical dashed line. On the HPLMN side, a Service Based Interface (SBI) bus connects various Network Functions (NFs). Above the bus are: MBSF, MB-SMF, NSSAAF, NWDAF, GMLC, NSSF, NEF, NRF (highlighted in blue), PCF, and UDM. Below the bus are: MBSTF, MNPF, SMS-IWMSC, LMF, UDR, AUSF, AMF, SMF, SCP, AF, CHF, and SEPP. The NRF is connected to the SBI and has a dashed line labeled 'Nnrf' pointing to it. A dotted line labeled 'N27' connects the NRF in the HPLMN to another NRF in the VPLMN. The VPLMN side contains several empty boxes representing other NFs, with one NRF also present. + +Figure 4-1: 5G System architecture diagram showing the HPLMN and VPLMN components and their interactions. + +**Figure 4-1: 5G System architecture** + +Figure 4-1 illustrates PLMN level scenarios, but this architecture is also applicable to the SNPn scenarios, as explained below. + +For the sake of clarity, the NRF is never depicted in reference point representation figures, given that the NRF interacts with every other NF in the 5GC. As an exception, in the roaming case, the reference point between the vNRF and the hNRF is named as N27. The reference point name of N27 is used only for representation purposes, but its functionality is included in the services offered by the Nnrf Service-Based Interface. + +In the case of SNPn, the NRF provides services e.g. in the following scenarios: + +- For a SNPn for which roaming is not supported (see 3GPP TS 23.501 [2], clause 5.30.2.0); +- For the case of UE access to SNPn using credentials from Credentials Holder (see 3GPP TS 23.501 [2], clause 5.30.2.9); +- For the case of Onboarding of UEs for SNPns (see 3GPP TS 23.501 [2], clause 5.30.2.10). + +## 5 Services Offered by the NRF + +### 5.1 Introduction + +The NRF offers to other NFs the following services: + +- Nnrf\_NFManagement +- Nnrf\_NFDiscovery +- Nnrf\_AccessToken (OAuth2 Authorization) +- Nnrf\_Bootstrapping + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|--------------------|--------|--------------------------|---------------------------------|-----------|-------| +| Nnrf_NFManagement | 6.1 | NRF NFManagement Service | TS29510_Nnrf_NFManagement.yaml | nnrf-nfm | A.2 | +| Nnrf_NFDiscovery | 6.2 | NRF NFDiscovery Service | TS29510_Nnrf_NFDiscovery.yaml | nnrf-disc | A.3 | +| Nnrf_AccessToken | 6.3 | NRF OAuth2 Authorization | TS29510_Nnrf_AccessToken.yaml | | A.4 | +| Nnrf_Bootstrapping | 6.4 | NRF Bootstrapping | TS29510_Nnrf_Bootstrapping.yaml | | A.5 | + +NRF provides services to the following SNPN scenarios (see clauses 4.17.4a, 4.17.5a, 5.2.7.2 and 5.2.7.3 in 3GPP TS 23.502 [3]): + +- In a SNPN where roaming is not supported, which corresponds to the NRF services in the same PLMN; +- In the case of UE access to SNPN using credentials from Credentials Holder with AAA-S, which corresponds to the NRF services in the same PLMN; +- In the case of UE access to SNPN using credentials from Credentials Holder with AUSF and UDM, which corresponds to the NRF services across different PLMNs; +- In the case of Onboarding of UEs for SNPNs without using Default Credentials Server, which corresponds to the NRF services in the same PLMN; +- In the case of Onboarding of UEs for SNPNs using Default Credentials Server with AAA-S, which corresponds to the NRF services in the same PLMN; +- In the case of Onboarding of UEs for SNPNs using Default Credentials Server with AUSF and UDM, which corresponds to the NRF services across different PLMNs. + +## 5.2 Nnrf\_NFManagement Service + +### 5.2.1 Service Description + +The Nnrf\_NFManagement service allows an NF, SCP or SEPP Instance in the serving PLMN to register, update or deregister its profile in the NRF. + +The Nnrf\_NFManagement service also allows an NRF Instance to register, update or deregister its profile in another NRF in the same PLMN. + +NOTE: Alternatively, other means such as OA&M can also be used to register, update or deregister NRF profile in another NRF. + +It also allows an NF or an SCP to subscribe to be notified of registration, deregistration and profile changes of NF Instances, along with their potential NF services, or of SEPP instances. It also enables an SCP to subscribe to be notified of registration, deregistration and profile changes of other SCP instances. + +The NF profile consists of general parameters of the NF Instance, and also the parameters of the different NF Service Instances exposed by the NF Instance, if applicable. + +The PLMN of the NRF may comprise one or multiple PLMN IDs (i.e. MCC and MNC). An NRF configured with multiple PLMN IDs shall support registering, updating and deregistering the profile of Network Function Instances from any of these PLMN IDs. + +The Nnrf\_NFManagement service also allows retrieving a list of NF, SCP or SEPP Instances currently registered in the NRF or the NF Profile of a given NF, SCP or SEPP Instance. + +The Nnrf\_NFManagement service also allows checking whether the registered NFs, SCPs and SEPPs are operative. + +## 5.2.2 Service Operations + +### 5.2.2.1 Introduction + +The services operations defined for the Nnrf\_NFManagement service are as follows: + +- NFRegister: It allows an NF, SCP or SEPP Instance to register its profile in the NRF; it includes the registration of the general parameters of the NF, SCP or SEPP Instance, together with the list of potential services exposed by the NF Instance. This service operation is not allowed to be invoked from an NRF in a different PLMN. +- NFUpdate: It allows an NF, SCP or SEPP Instance to replace, or update partially, the parameters of its profile (including the parameters of the associated services, if any) in the NRF; it also allows to add or delete individual services offered by the NF Instance. This service operation is not allowed to be invoked from an NRF in a different PLMN. +- NFDeregister: It allows an NF, SCP or SEPP Instance to deregister its profile in the NRF, including the services offered by the NF Instance, if any. This service operation is not allowed to be invoked from an NRF in a different PLMN. +- NFStatusSubscribe: It allows an NF or SCP Instance to subscribe to changes on the status of NF or SEPP Instances registered in NRF. It also allows an SCP Instance to subscribe to changes on the status of other SCP Instances registered in NRF. This service operation can be invoked by an NF Instance in a different PLMN (via the local NRF in that PLMN) for changes on the status of NF Instances. It cannot be invoked by an SCP instance in a different PLMN. For changes on the status of SEPP Instance, this operation can only be invoked between the NRF and an NF Instance or SCP in the same PLMN. +- NFStatusNotify: It allows the NRF to notify subscribed NF or SCP Instances of changes on the status of NF or SEPP Instances. It also allows the NRF to notify subscribed SCP Instances of changes on the status of SCP Instances. This service operation can be invoked directly between the NRF and an NF Instance in a different PLMN (without involvement of the local NRF in that PLMN) for changes on the status of NF Instances. It cannot be invoked between the NRF and an SCP instance in a different PLMN. For changes on the status of SEPP Instance, this operation can only be invoked between the NRF and an NF Instance or SCP in the same PLMN. +- NFStatusUnsubscribe: It allows an NF or SCP Instance to unsubscribe to changes on the status of NF or SEPP Instances registered in NRF. It also allows an SCP Instance to unsubscribe to changes on the status of other SCP Instances registered in NRF. This service operation can be invoked by an NF Instance in a different PLMN (via the local NRF in that PLMN) for changes on the status of NF Instances. It cannot be invoked by an SCP instance in a different PLMN. For changes on the status of SEPP Instance, this operation can only be invoked between the NRF and an NF Instance or SCP in the same PLMN. + +NOTE 1: The "change of status" of the NFStatus service operations can imply a request to be notified of newly registered NF, SCP or SEPP Instances in NRF, or to be notified of profile changes of a specific NF, SCP or SEPP Instance, or to be notified of the deregistration of an NF, SCP or SEPP Instance. + +NOTE 2: An NRF instance can also use the NFRegister, NFUpdate or NFDeregister service operations or OA&M system to register, update or deregister its profile in another NRF in the same PLMN. + +- NFListRetrieval: It allows retrieving a list of NFs, SCPs and SEPPs currently registered in the NRF. This service operation is not allowed to be invoked from an NRF in a different PLMN. +- NFProfileRetrieval: It allows retrieving the profile of a given NF, SCP or SEPP instance. This service operation is not allowed to be invoked from an NRF in a different PLMN. + +The NFStatusSubscribe / NFStatusNotify / NFStatusUnsubscribe operations can be invoked by an NF Service Consumer (i.e., "source NF" or "SCP") requesting to be notified about events (registration, deregistration, profile change) related to an NF instance (i.e., "target NF") located in the same PLMN, or in a different PLMN, or related to a SEPP instance located in the same PLMN. An SCP can also invoke these operations to be notified about events (registration, deregistration, profile change) related to an SCP instance or SEPP instance located in the same PLMN. + +In the description of these operations in clauses 5.2.2.5, 5.2.2.6 and 5.2.2.7, when the NF instances are located in the same PLMN, both source NF and target NF are said to be located in the "Serving PLMN" but, in the general case, the functionality is not restricted to the PLMN that is serving a given UE, and it shall be applicable as well to any scenario in which source NF and target NFs belong to the same PLMN. + +When source NF and target NF are located in different PLMNs, the source NF is said to be in the "Serving PLMN", and the target NF (and the NRF where such NF is registered) is said to be in the "Home PLMN", similarly to the scenarios described in 3GPP TS 23.502 [3], but the functionality shall be equally applicable to any scenario between any pair of PLMNs (e.g. with the source NF in the Home PLMN and the target NF in the Serving PLMN). + +The SCP and SEPP are treated by the Nnrf\_NFManagement service in the same way as NFs. Specifically, the SCP and SEPP are designated with a specific NF type and NF Instance ID. However, the SCP and SEPP do not support services. Accordingly, references to "NF" or "NF Profile" in the description of the service operations in the following clauses also apply to an SCP and SEPP. + +## 5.2.2.2 NFRegister + +### 5.2.2.2.1 General + +This service operation is used: + +- to register an NF in the NRF by providing the NF profile of the requesting NF to the NRF, and the NRF marks the requesting NF as available to be discovered by other NFs; +- to register services associated to an existing NF Instance; +- to register NRF information in another NRF, and this information is used for forwarding or redirecting service discovery request. + +### 5.2.2.2.2 NF (other than NRF) registration to NRF + +![Sequence diagram showing NF Instance Registration. An NF Service Consumer sends a PUT request to the NRF. The NRF responds with either a 201 Created (NFProfile) or a 4xx/5xx (ProblemDetails) or 3xx response.](e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NRF + Note right of NRF: 1. PUT .../nf-instances/{nfInstanceID} (NFProfile) + NF Service Consumer->>NRF: 1. PUT .../nf-instances/{nfInstanceID} (NFProfile) + Note left of NF Service Consumer: 2a. 201 Created (NFProfile) +2b. 4xx/5xx (ProblemDetails) or 3xx + NRF-->>NF Service Consumer: 2a. 201 Created (NFProfile) +2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing NF Instance Registration. An NF Service Consumer sends a PUT request to the NRF. The NRF responds with either a 201 Created (NFProfile) or a 4xx/5xx (ProblemDetails) or 3xx response. + +**Figure 5.2.2.2.2-1: NF Instance Registration** + +1. The NF Service Consumer shall send a PUT request to the resource URI representing the NF Instance. The URI is determined by the NF Instance. The variable {nfInstanceID} represents an identifier, provided by the NF Service Consumer that shall be globally unique inside the PLMN of the NRF where the NF is being registered. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122 [18]. + +The UUIDs in URIs, HTTP request content and HTTP response content should be formatted using lower-case hexadecimal digits; if the NF Service Consumer sends a request where the UUIDs are formatted with upper-case hexadecimal letters, the NRF shall handle it as if the request had been formatted with lower-case characters. + +EXAMPLE: UUID version 4: "4947a69a-f61b-4bc1-b9da-47c9c5d14b64" + +The content of the PUT request shall contain a representation of the NF Instance to be created. + +- 2a. On success, "201 Created" shall be returned, the content of the PUT response shall contain the representation of the created resource and the "Location" header shall contain the URI of the created resource. Additionally, the NRF returns a "heart-beat timer" containing the number of seconds expected between two consecutive heart-beat messages from an NF Instance to the NRF (see clause 5.2.2.3.2). The representation of the created resource may + +be a complete NF Profile or a NF Profile just including the mandatory attributes of the NF Profile and the attributes which the NRF added or changed (see Annex B). + +2b. On failure or redirection: + +- If the registration of the NF instance fails at the NRF due to errors in the encoding of the NFProfile JSON object, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. +- If the registration of the NF instance fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +The NRF shall allow the registration of a Network Function instance with any of the NF types described in clause 6.1.6.3.3, and it shall also allow registration of Network Function instances with custom NF types (e.g., NF type values not defined by 3GPP, or NF type values not defined by this API version). + +NOTE 1: When registering a custom NF in NRF, it is recommended to use a NF type name that prevents collisions with other custom NF type names, or with NF types defined in the future by 3GPP. E.g., prefixing the custom NF type name with the string "CUSTOM\_". + +During the registration of a Network Function instance with a custom NF type, the NF instance may provide NF-specific data (in the "customInfo" attribute), that shall be stored by the NRF as part of the NF profile of the NF instance. + +The NRF shall accept the registration of NF Instances containing Vendor-Specific attributes (see 3GPP TS 29.500 [4], clause 6.6.3), and therefore, it shall accept NF Profiles containing attributes whose type may be unknown to the NRF, and those attributes shall be stored as part of the NF's profile data in NRF. + +Before an NF Instance registers its NF Profile in NRF, the NF Instance should check the capabilities of the NRF by issuing an OPTIONS request to the "nf-instances" resource (see clause 6.1.3.2.3.2), unless the NF Instance already sent a Bootstrapping Request to the NRF and received the nrfFeatures attribute in the response. The NRF may indicate in the response capabilities such as the support of receiving compressed content in the HTTP PUT request used for registration of the NF Profile, or support of specific attributes of the NF Profile. + +NOTE 2: A Rel-16 NF needs to register the list of NF Service Instances in the "nfServices" array attribute towards an NRF not supporting the Service-Map feature (i.e. a Rel-15 NRF). + +### 5.2.2.2.3 NRF registration to another NRF + +The procedure specified in clause 5.2.2.2.2 applies. Additionally: + +- the registering NRF shall set the nfType to "NRF" in the nfProfile; +- the registering NRF shall set the nfService to contain "nnrf-disc", "nnrf-nfm" and optionally "nnrf-oauth2" in the nfProfile; +- the registering NRF may include nrfInfo which contains the information of e.g. udrInfo, udmInfo, ausfInfo, amfInfo, smfInfo, upfInfo, pcfInfo, bsfInfo, nefInfo, chfInfo, pscfInfo, lmfInfo, gmfcInfo, aanfInfo, nfnInfo and nsacfInfo in the nfProfile locally configured in the NRF or the NRF received during registration of other NFs, this means the registering NRF is able to provide service for discovery of NFs subject to that information; +- if the NRF receives an NF registration with the nfType set to "NRF", the NRF shall use the information contained in the nfProfile to target the registering NRF when forwarding or redirecting NF service discovery request. + +### 5.2.2.3 NFUpdate + +#### 5.2.2.3.1 General + +This service operation updates the profile of a Network Function previously registered in the NRF by providing the updated NF profile of the requesting NF to the NRF. The update operation may apply to the whole profile of the NF (complete replacement of the existing profile by a new profile), or it may apply only to a subset of the parameters of the profile (including adding/deleting/replacing services to the NF profile). + +To perform a complete replacement of the NF Profile of a given NF Instance, the NF Service Consumer shall issue an HTTP PUT request, as shown in Figure 5.2.2.3.1-1: + +![Sequence diagram for NF Profile Complete Replacement. The NF Service Consumer sends a PUT request to the NRF. The NRF responds with either a 200 OK (containing the NFPProfile) or a 4xx/5xx (containing ProblemDetails) or a 3xx status code.](523ab7b925beb555f88b2e1e1336974f_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NRF + Note left of NF Service Consumer: 1. PUT .../nf-instances/{nfInstanceID} (NFPProfile) + NF Service Consumer->>NRF: 1. PUT .../nf-instances/{nfInstanceID} (NFPProfile) + Note right of NRF: 2a. 200 OK (NFPProfile) +2b. 4xx/5xx (ProblemDetails) or 3xx + NRF-->>NF Service Consumer: 2a. 200 OK (NFPProfile) +2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for NF Profile Complete Replacement. The NF Service Consumer sends a PUT request to the NRF. The NRF responds with either a 200 OK (containing the NFPProfile) or a 4xx/5xx (containing ProblemDetails) or a 3xx status code. + +**Figure 5.2.2.3.1-1: NF Profile Complete Replacement** + +1. The NF Service Consumer shall send a PUT request to the resource URI representing the NF Instance. The content of the PUT request shall contain a representation of the NF Instance to be completely replaced in the NRF. +- 2a. On success, "200 OK" shall be returned, the content of the PUT response shall contain the representation of the replaced resource. The representation of the replaced resource may be a complete NF Profile or a NF Profile just including the mandatory attributes of the NF Profile and the attributes which the NRF added or changed (see Annex B). +- 2b. On failure or redirection: + - If the update of the NF instance fails at the NRF due to errors in the encoding of the NFPProfile JSON object, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. + - If the update of the NF instance fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +To perform a partial update of the NF Profile of a given NF Instance, the NF Service Consumer shall issue an HTTP PATCH request, as shown in Figure 5.2.2.3.1-2. This partial update shall be used to add/delete/replace individual parameters of the NF Instance, and also to add/delete/replace any of the services (and their parameters) offered by the NF Instance. + +![Sequence diagram for NF Profile Partial Update. The NF Service Consumer sends a PATCH request to the NRF. The NRF responds with either a 200 OK (containing the NFPProfile) or a 204 No Content (empty), or a 4xx/5xx (containing ProblemDetails) or a 3xx status code.](1a85642ed2356d183ce598f2c8b3ee8b_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NRF + Note left of NF Service Consumer: 1. PATCH .../nf-instances/{nfInstanceID} (PatchData) + NF Service Consumer->>NRF: 1. PATCH .../nf-instances/{nfInstanceID} (PatchData) + Note right of NRF: 2a. 200 OK (NFPProfile) / 204 No Content () +2b. 4xx/5xx (ProblemDetails) or 3xx + NRF-->>NF Service Consumer: 2a. 200 OK (NFPProfile) / 204 No Content () +2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for NF Profile Partial Update. The NF Service Consumer sends a PATCH request to the NRF. The NRF responds with either a 200 OK (containing the NFPProfile) or a 204 No Content (empty), or a 4xx/5xx (containing ProblemDetails) or a 3xx status code. + +**Figure 5.2.2.3.1-2: NF Profile Partial Update** + +1. The NF Service Consumer shall send a PATCH request to the resource URI representing the NF Instance. The content of the PATCH request shall contain the list of operations (add/delete/replace) to be applied to the NF Profile of the NF Instance; these operations may be directed to individual parameters of the NF Profile or to the list of services (and their parameters) offered by the NF Instances. In order to leave the NF Profile in a consistent state, all the operations specified by the PATCH request body shall be executed atomically. + +The NF Service Consumer should include a "If-Match" HTTP header carrying the latest entity-tag received from NRF for the NF profile to which the PATCH document shall be applied. + +- 2a. On success, if all update operations are accepted by the NRF, "204 No Content" should be returned; the NRF may instead return "200 OK" with the content of the PATCH response containing the representation of the + +replaced resource. The representation of the replaced resource may be a complete NF Profile or a NF Profile just including the mandatory attributes of the NF Profile and the attributes which the NRF added or changed (see Annex B). + +2b. On failure or redirection: + +- If the NF Instance, identified by the "nfInstanceID", is not found in the list of registered NF Instances in the NRF's database, the NRF shall return "404 Not Found" status code with the ProblemDetails IE providing details of the error. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. +- If "If-Match" header is received with an entity tag different from the entity-tag in NRF for NF profile of the target NF instance, the NRF shall return "412 Precondition Failed" status code with the ProblemDetails IE providing details of the error. +- If no precondition was defined in the request and another confliction has been detected (e.g. to change value of a non-existing IE), the NRF shall return "409 Conflicting" status code with the ProblemDetails IE providing details of the error. + +The NRF shall allow updating Vendor-Specific attributes (see 3GPP TS 29.500 [4], clause 6.6.3) that may exist in the NF Profile of a registered NF Instance. + +### 5.2.2.3.2 NF Heart-Beat + +Each NF that has previously registered in NRF shall contact the NRF periodically (heart-beat), by invoking the NFUpdate service operation, in order to show that the NF is still operative. + +The time interval at which the NRF shall be contacted is deployment-specific, and it is returned by the NRF to the NF Service Consumer as a result of a successful registration. + +When the NRF detects that a given NF has not updated its profile for a configurable amount of time (longer than the heart-beat interval), the NRF changes the status of the NF to SUSPENDED and considers that the NF and its services can no longer be discovered by other NFs via the NFDiscovery service. The NRF notifies NFs subscribed to receiving notifications of changes of the NF Profile that the NF status has been changed to SUSPENDED. + +If the NRF modifies the heart-beat interval value of a given NF instance currently registered (e.g. as a result of an OA&M operation), it shall return the new value to the registered NF in the response of the next periodic heart-beat interaction received from that NF and, until then, the NRF shall apply the heart-beat check procedure according to the original interval value. + +![Sequence diagram illustrating the NF Heart-Beat interaction between an NF Service Consumer and an NRF.](35127fe87029df6f5f0b2ee85f6193f1_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant NRF + Note right of NRF: 1. PATCH .../nf-instances/{nfInstanceID} (PatchData) + NF Service Consumer->>NRF: 1. PATCH .../nf-instances/{nfInstanceID} (PatchData) + Note left of NF Service Consumer: 2a. 200 OK (NFProfile) / 204 No Content () + Note left of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NRF-->>NF Service Consumer: 2a. 200 OK (NFProfile) / 204 No Content () + NRF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +The diagram shows a sequence of interactions between an NF Service Consumer and an NRF. The NF Service Consumer sends a PATCH request to the NRF. The NRF responds with either a 200 OK (NFProfile) / 204 No Content () or a 4xx/5xx (ProblemDetails) or 3xx status code. + +Sequence diagram illustrating the NF Heart-Beat interaction between an NF Service Consumer and an NRF. + +**Figure 5.2.2.3.2-1: NF Heart-Beat** + +1. The NF Service Consumer shall send a PATCH request to the resource URI representing the NF Instance. The content of the PATCH request shall contain a "replace" operation on the "nfStatus" attribute of the NF Profile of the NF Instance, and set it to the value "REGISTERED" or "UNDISCOVERABLE". + +In addition, the NF Service Consumer may also provide the load information of the NF, and/or the load information of the NF associated NF services. The provision of such load information may be limited by this NF via appropriate configuration (e.g. granularity threshold) in order to avoid notifying minor load changes. + +The NF Service Consumer shall not include "If-Match" HTTP header in the Heart-Beat request if the request is not modifying any attribute in the NF profile. + +- 2a. On success, the NRF should return "204 No Content"; the NRF may also answer with "200 OK" along with the full NF Profile, e.g. in cases where the NRF determines that the NF Profile has changed significantly since the last heart-beat, and wants to send the new profile to the NF Service Consumer (note that this alternative has bigger signalling overhead). + +The NRF shall not generate a new entity tag for the NF profile in Heart-Beat operation if no attribute is modified. + +- 2b. On failure or redirection: + +- If the NF Instance, identified by the "nfInstanceID", is not found in the list of registered NF Instances in the NRF's database, the NRF shall return "404 Not Found" status code with the ProblemDetails IE providing details of the error. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +EXAMPLE: + +``` +PATCH ../nf-instances/4947a69a-f61b-4bc1-b9da-47c9c5d14b64 +Content-Type: application/json-patch+json + +[ + { "op": "replace", "path": "/nfStatus", "value": "REGISTERED" }, + { "op": "replace", "path": "/load", "value": 50 } +] + +HTTP/2 204 No Content +Content-Location: ../nf-instances/4947a69a-f61b-4bc1-b9da-47c9c5d14b64 +``` + +## 5.2.2.4 NFDeregister + +### 5.2.2.4.1 General + +This service operation removes the profile of a Network Function previously registered in the NRF. + +It is executed by deleting a given resource identified by a "NF Instance ID". The operation is invoked by issuing a DELETE request on the URI representing the specific NF Instance. + +![Sequence diagram for NF Instance Deregistration. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'NRF' on the right. Step 1: A solid arrow points from the NF Service Consumer to the NRF with the message '1. DELETE ../nf-instances/{nfInstanceID} ()'. Step 2: A return message is shown with two possible outcomes: '2a. 204 No Content ()' and '2b. 4xx/5xx (ProblemDetails) or 3xx'. This return message is represented by a dashed arrow pointing from the NRF back to the NF Service Consumer, with the text split into two lines within a single message box.](8ed7f57cc317f6574bec781d01ae6ad2_img.jpg) + +Sequence diagram for NF Instance Deregistration. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'NRF' on the right. Step 1: A solid arrow points from the NF Service Consumer to the NRF with the message '1. DELETE ../nf-instances/{nfInstanceID} ()'. Step 2: A return message is shown with two possible outcomes: '2a. 204 No Content ()' and '2b. 4xx/5xx (ProblemDetails) or 3xx'. This return message is represented by a dashed arrow pointing from the NRF back to the NF Service Consumer, with the text split into two lines within a single message box. + +Figure 5.2.2.4.1-1: NF Instance Deregistration + +1. The NF Service Consumer shall send a DELETE request to the resource URI representing the NF Instance. The request body shall be empty. +- 2a. On success, "204 No Content" shall be returned. The response body shall be empty. +- 2b. On failure or redirection: + - If the NF Instance, identified by the "nfInstanceID", is not found in the list of registered NF Instances in the NRF's database, the NRF shall return "404 Not Found" status code with the ProblemDetails IE providing details of the error. + +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +## 5.2.2.5 NFStatusSubscribe + +### 5.2.2.5.1 General + +This service operation is used to: + +- create a subscription so an NF Service Consumer can request to be notified when NF Instances of a given set, following certain filter criteria are registered/deregistered in NRF or when their profile is modified; +- create a subscription to a specific NF Instance so an NF Service Consumer can request to be notified when the profile of such NF Instance is modified or when the NF Instance is deregistered from NRF. + +### 5.2.2.5.2 Subscription to NF Instances in the same PLMN + +The subscription to notifications on NF Instances is executed creating a new individual resource under the collection resource "subscriptions". The operation is invoked by issuing a POST request on the URI representing the "subscriptions" resource. + +![Sequence diagram showing the interaction between an NF Service Consumer and an NRF in the same PLMN for subscription creation.](f0b7aaa539a2f77c98d53ed6c1c2366b_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer in Serving PLMN + participant NRF as NRF in Serving PLMN + Note right of Consumer: 1. POST .../subscriptions (SubscriptionData) + Consumer->>NRF: Request + Note left of NRF: 2a. 201 Created (SubscriptionData) +2b. 4xx/5xx (ProblemDetails) or 3xx + NRF-->>Consumer: Response + +``` + +The diagram illustrates a sequence of messages between an NF Service Consumer and an NRF, both located within the same Serving PLMN. The interaction begins with the Consumer sending a POST request to the subscriptions resource. The NRF responds with either a 201 Created status containing SubscriptionData, or a 4xx/5xx status containing ProblemDetails, or a 3xx redirection status. + +Sequence diagram showing the interaction between an NF Service Consumer and an NRF in the same PLMN for subscription creation. + +**Figure 5.2.2.5.2-1: Subscription to NF Instances in the same PLMN** + +1. The NF Service Consumer shall send a POST request to the resource URI representing the "subscriptions" collection resource. The custom HTTP header "3gpp-Sbi-Notif-Accepted-Encoding", as defined in 3GPP TS 29.500 [4] clause 5.2.3.3.6, may be included to indicate the content-encodings supported by the NF Service Consumer receiving the notification. + +The request body shall include the data indicating the type of notifications that the NF Service Consumer is interested in receiving; it also contains a callback URI, where the NF Service Consumer shall be prepared to receive the actual notification from the NRF (see NFStatusNotify operation in 5.2.2.6) and it may contain a validity time, suggested by the NF Service Consumer, representing the time span during which the subscription is desired to be kept active. When the NF Service Consumer creates multiple subscriptions in the NRF, it should use distinct callback URIs for each subscription. + +The subscription request may also include additional parameters indicating the list of attributes (including Vendor-Specific attributes, see 3GPP TS 29.500 [4], clause 6.6.3) in the NF Profile to be monitored (or to be excluded from monitoring), in order to determine whether a notification from NRF should be sent, or not, when any of those attributes is changed in the profile. + +The NF Service Consumer may request the creation of a subscription to a specific NF Instance, or to a set of NF Instances, where the set is determined according to different criteria specified in the request body, in the "subscrCond" attribute of the "SubscriptionData" object type (see clause 6.1.6.2.16). + +The subscription shall be authorized, or rejected, by the NRF by checking the relevant input attributes (e.g. reqNfType, reqNfFqdn, reqSnssais, reqPerPlmnSnssais, reqPlmnList, reqSnpnList, etc.) in the subscription request body (along with the contents of any optional Oauth2 access token provided in the API request) against the list of authorization attributes in the NF Profile of the target NF Instance to be monitored. + +An SCP may request a subscription to the complete profile of NF Instances (including, e.g. the authorization attributes of the target NF Instances to be monitored). Upon receiving such a request, the NRF shall verify that the requesting entity is authorized to subscribe to the complete profile of NF instances, based on local policies or + +the receipt of an Oauth2 access token granting such permission. If the requesting entity is not authorized to do so, the NRF shall reject the request or handle it as a subscription request without access to the complete profile. + +When the subscription request is for a set of NFs, the authorization attributes of the NF Instances in the set may differ, resulting in positive authorization of the subscription for only a part of the NF Instances in the set; in that case, the subscription to the set of NFs may be accepted by the NRF, but the NF Instances in the set that are not authorized for the NF Service Consumer that requested the subscription, shall not result in triggering any notification event from the NRF to the NF Service Consumer. + +- 2a. On success, "201 Created" shall be returned. The response shall contain the data related to the created subscription, including the validity time, as determined by the NRF, after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving status notifications, it shall create a new subscription in the NRF. +- 2b. On failure or redirection: + - If the creation of the subscription fails at the NRF due to errors in the SubscriptionData JSON object in the request body, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. + - If the creation of the subscription fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +### 5.2.2.5.3 Subscription to NF Instances in a different PLMN + +The subscription to notifications on NF Instances in a different PLMN is done by creating a resource under the collection resource "subscriptions", in the NRF of the Home PLMN. + +For that, step 1 in clause 5.2.2.5.2 is executed (send a POST request to the NRF in the Serving PLMN); this request shall include the identity of the PLMN of the home NRF in the SubscriptionData parameter in the request body. + +If the NRF in Serving PLMN knows that Oauth2-based authorization is required for accessing the NFManagement service of the NRF in Home PLMN, e.g. by learning this during an earlier Bootstrapping procedure or local configuration, and if the request received at the NRF in Serving PLMN does not include an access token, the NRF in Serving PLMN may reject the request with a 401 Unauthorized as specified in clause 6.7.3 of 3GPP TS 29.500 [4]. + +Then, steps 1-2 in Figure 5.2.2.5.3-1 are executed, between the NRF in the Serving PLMN and the NRF in the Home PLMN. In this step, the PLMN ID may be present in the SubscriptionData parameter. The NRF in the Home PLMN returns a subscriptionID identifying the created subscription. + +Finally, step 2 in clause 5.2.2.5.2 is executed; a new subscriptionID shall be generated by the NRF in the Serving PLMN as indicated in step 2 of Figure 5.2.2.5.3-1, and shall be sent to the NF Service Consumer in the Serving PLMN. + +![Sequence diagram showing the interaction between the NRF in the Serving PLMN and the NRF in the Home PLMN for subscription creation. The Serving PLMN sends a POST request to the Home PLMN, which responds with 201 Created or an error/redirection status code.](14515d82ffeec9475b9add3036ff26ab_img.jpg) + +``` + +sequenceDiagram + participant NRF_Serving as NRF in Serving PLMN + participant NRF_Home as NRF in Home PLMN + Note left of NRF_Serving: NF Service Consumer in Serving PLMN + NRF_Serving->>NRF_Home: 1. POST .../subscriptions (SubscriptionData) + NRF_Home-->>NRF_Serving: 2a. 201 Created (SubscriptionData) + NRF_Home-->>NRF_Serving: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between the NRF in the Serving PLMN and the NRF in the Home PLMN for subscription creation. The Serving PLMN sends a POST request to the Home PLMN, which responds with 201 Created or an error/redirection status code. + +**Figure 5.2.2.5.3-1: Subscription to NF Instances in a different PLMN** + +1. The NRF in Serving PLMN shall send a POST request to the resource URI in the NRF in Home PLMN representing the "subscriptions" collection resource. The request body shall include the SubscriptionData as received by the NRF in Serving PLMN from the NF Service Consumer in the Serving PLMN (see 5.2.2.5.2), containing the data about the type of notifications that the NF Service Consumer is interested in receiving and + +the callback URI where the NF Service Consumer shall be prepared to receive the notifications from the NRF (see NFStatusNotify operation in 5.2.2.6). + +- 2a. On success, "201 Created" shall be returned. If the subscription is created in a different NRF in the HPLMN than the NRF in the HPLMN that receives the subscription request, the latter should include information in the subscriptionID (after the first 5 or 6 digits and "-") such as to be able to forward the subsequent subscription modification or deletion request it may receive from the NRF in the serving PLMN towards the NRF in the HPLMN holding the subscription. The information to be included in the subscriptionID is left to implementation. + +If the Home NRF is located in a PLMN: + +The NRF in Serving PLMN should not keep state for this created subscription and shall send to the NF Service Consumer in Serving PLMN (step 2 in 5.2.2.5.2) a subscriptionID that shall consist on the following structure: +++"-"+ + +If the Home NRF is located in an SNPN: + +++"-"+"x3Lf57A"+"nid="++"-"+ + +NOTE: The fixed 7-character string "x3Lf57A" is used to prevent accidental collisions with subscription IDs generated according to earlier versions of this specification, where the subscription ID could only contain MCC and MNC values; this mechanism is commonly known as "magic cookie". + +EXAMPLE 1: If the NRF in a Home PLMN (where MCC = 123, and MNC=456) creates a subscription with value "subs987654", the subscriptionID that the NRF in Serving PLMN would send to the NF Service Consumer in Serving PLMN is: "123456-subs987654" + +EXAMPLE 2: If the NRF in an SNPN (where MCC = 321, MNC = 654 and NID = 023f245ac42) creates a subscription with value "subs987654", the subscriptionID that the NRF in Serving PLMN would send to the NF Service Consumer in Serving PLMN is: +"321654-x3Lf57A:nid=023f245ac42:subs987654". + +The URI in the Location header that the NRF in Serving PLMN returns to the NF Service Consumer in Serving PLMN shall contain a modified as described above and, if it is as an absolute URI, an apiRoot pointing to the address of the NRF in Serving PLMN. The subscriptionId attribute in the message body that the NRF in Serving PLMN returns to the NF Service Consumer in Serving PLMN shall also contain a modified as described above. + +2b. On failure or redirection: + +- If the creation of the subscription fails at the NRF due to errors in the SubscriptionData JSON object in the request body, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. +- If the creation of the subscription fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +#### 5.2.2.5.4 Subscription to NF Instances with intermediate forwarding NRF + +When multiple NRFs are deployed in one PLMN, an NF Instance can subscribe to changes of NF Instances registered in an NRF to which it is not directly interacting. The subscription message is forwarded by an intermediate NRF to which the subscribing NF instance is directly interacting. + +For that, step 1 in clause 5.2.2.5.2 is executed (send a POST request to the NRF-1 in the Serving PLMN); this request shall include the SubscriptionData parameter in the request body. + +Then, steps 1-4 in Figure 5.2.2.5.4-1 are executed between NF Service Consumer in Serving PLMN, NRF-1 in Serving PLMN and NRF-2 in Serving PLMN. In these steps, NRF-1 sends the subscription request to a pre-configured NRF-2. NRF-2 requests corresponding NRF (e.g. the NF Service Producer registered NRF) and returns a subscriptionID identifying the created subscription and this subscriptionID is sent to the NF Service Consumer via NRF-1. + +Finally, step 2 in clause 5.2.2.5.2 is executed; the subscriptionID shall be sent to the NF Service Consumer. + +![Sequence diagram illustrating 'Subscription with intermediate forwarding NRF'. The diagram shows three participants: NF Service Consumer in Serving PLMN, NRF-1 in Serving PLMN, and NRF-2 in Serving PLMN. The sequence of messages is: 1. POST ../subscriptions(SubscriptionData) from Consumer to NRF-1; 2. POST ../subscriptions(SubscriptionData) from NRF-1 to NRF-2; 3. Responses from NRF-2 to NRF-1 (3a. 201 Created, 3b. 4xx/5xx, 3c. 3xx Redirect); 4. Responses from NRF-1 to Consumer (4a. 201 Created, 4b. 4xx/5xx, 4c. 3xx Redirect).](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer in Serving PLMN + participant NRF1 as NRF-1 in Serving PLMN + participant NRF2 as NRF-2 in Serving PLMN + Note left of Consumer: 1. POST ../subscriptions(SubscriptionData) + Consumer->>NRF1: 1. POST ../subscriptions(SubscriptionData) + Note right of NRF1: 2. POST ../subscriptions(SubscriptionData) + NRF1->>NRF2: 2. POST ../subscriptions(SubscriptionData) + Note right of NRF2: 3a. 201 Created(Subscription ID) +3b. 4xx/5xx(ProblemDetails) +3c. 3xx Temporary/Permanent Redirect + NRF2-->>NRF1: 3a. 201 Created(Subscription ID) +3b. 4xx/5xx(ProblemDetails) +3c. 3xx Temporary/Permanent Redirect + Note left of NRF1: 4a. 201 Created(Subscription ID) +4b. 4xx/5xx(ProblemDetails) +4c. 3xx Temporary/Permanent Redirect + NRF1-->>Consumer: 4a. 201 Created(Subscription ID) +4b. 4xx/5xx(ProblemDetails) +4c. 3xx Temporary/Permanent Redirect + +``` + +Sequence diagram illustrating 'Subscription with intermediate forwarding NRF'. The diagram shows three participants: NF Service Consumer in Serving PLMN, NRF-1 in Serving PLMN, and NRF-2 in Serving PLMN. The sequence of messages is: 1. POST ../subscriptions(SubscriptionData) from Consumer to NRF-1; 2. POST ../subscriptions(SubscriptionData) from NRF-1 to NRF-2; 3. Responses from NRF-2 to NRF-1 (3a. 201 Created, 3b. 4xx/5xx, 3c. 3xx Redirect); 4. Responses from NRF-1 to Consumer (4a. 201 Created, 4b. 4xx/5xx, 4c. 3xx Redirect). + +**Figure 5.2.2.5.4-1: Subscription with intermediate forwarding NRF** + +1. NRF-1 receives a subscription request and sends the subscription request to a pre-configured NRF-2. This may for example include cases where NRF-1 does not have sufficient information as determined by the operator policy to fulfill the request locally. +2. Upon receiving a subscription request, based on the SubscriptionData contained in the subscription request (e.g. NF type) and locally stored information (see clause 5.2.2.2.3), NRF-2 shall identify the next hop NRF and forward the subscription request to that NRF (i.e. NF Service Producer registered NRF). +- 3a. On success, "201 Created" shall be returned by NRF-2. +- 3b. On failure, i.e. if the creation of the subscription fails, the NRF-2 shall return "4XX/5XX" response. +- 3c. In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. +- 4a. NRF-1 forwards the success response to NF Service Consumer. The content of the POST response shall contain the representation describing the status of the request and the "Location" header shall be present and shall contain the URI of the created resource. The authority and/or deployment-specific string of the apiRoot of the created resource URI may differ from the authority and/or deployment-specific string of the apiRoot of the request URI received in the POST request. +- 4b. On failure, NRF-1 forwards the error response to NF Service Consumer. +- 4c. In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +#### 5.2.2.5.5 Subscription to NF Instances with intermediate redirecting NRF + +When multiple NRFs are deployed in one PLMN, an NF Instance can subscribe to changes of NF Instances registered in another NRF. The subscription message is redirected by a third NRF. + +For that, step 1 in clause 5.2.2.5.2 is executed (send a POST request to the NRF-1 in the Serving PLMN); this request shall include the SubscriptionData parameter in the request body. + +Then, steps 2-5 in Figure 5.2.2.5.5-1 are executed between NRF-1, NRF-2 and NRF-3. + +Finally, step 2 in clause 5.2.2.5.2 is executed; the subscriptionID shall be sent to the NF Service Consumer. + +![Sequence diagram showing the subscription process to NF instances with intermediate redirecting NRF. The diagram involves four lifelines: NF Service Consumer in Serving PLMN, NRF-1 in Serving PLMN, NRF-2 in Serving PLMN, and NRF-3 in Serving PLMN. The sequence of messages is: 1. POST ../subscriptions(SubscriptionData) from Consumer to NRF-1; 2. POST ../subscriptions(SubscriptionData) from NRF-1 to NRF-2; 3. 307 Temporary Redirect from NRF-2 to NRF-1; 4. POST ../subscriptions(SubscriptionData) from NRF-1 to NRF-3; 5a. 201 Created(Subscription ID) from NRF-3 to NRF-1; 5b. 4xx/5xx(ProblemDetails) from NRF-3 to NRF-1; 6a. 201 Created(Subscription ID) from NRF-1 to Consumer; 6b. 4xx/5xx(ProblemDetails) from NRF-1 to Consumer.](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer in Serving PLMN + participant NRF1 as NRF-1 in Serving PLMN + participant NRF2 as NRF-2 in Serving PLMN + participant NRF3 as NRF-3 in Serving PLMN + Note left of Consumer: 1. POST ../subscriptions(SubscriptionData) + Consumer->>NRF1: 1. POST ../subscriptions(SubscriptionData) + Note right of NRF1: 2. POST ../subscriptions(SubscriptionData) + NRF1->>NRF2: 2. POST ../subscriptions(SubscriptionData) + Note right of NRF2: 3. 307 Temporary Redirect + NRF2->>NRF1: 3. 307 Temporary Redirect + Note right of NRF1: 4. POST ../subscriptions(SubscriptionData) + NRF1->>NRF3: 4. POST ../subscriptions(SubscriptionData) + Note right of NRF3: 5a. 201 Created(Subscription ID) + NRF3->>NRF1: 5a. 201 Created(Subscription ID) + Note right of NRF3: 5b. 4xx/5xx(ProblemDetails) + NRF3->>NRF1: 5b. 4xx/5xx(ProblemDetails) + Note right of NRF1: 6a. 201 Created(Subscription ID) + NRF1->>Consumer: 6a. 201 Created(Subscription ID) + Note right of NRF1: 6b. 4xx/5xx(ProblemDetails) + NRF1->>Consumer: 6b. 4xx/5xx(ProblemDetails) + +``` + +Sequence diagram showing the subscription process to NF instances with intermediate redirecting NRF. The diagram involves four lifelines: NF Service Consumer in Serving PLMN, NRF-1 in Serving PLMN, NRF-2 in Serving PLMN, and NRF-3 in Serving PLMN. The sequence of messages is: 1. POST ../subscriptions(SubscriptionData) from Consumer to NRF-1; 2. POST ../subscriptions(SubscriptionData) from NRF-1 to NRF-2; 3. 307 Temporary Redirect from NRF-2 to NRF-1; 4. POST ../subscriptions(SubscriptionData) from NRF-1 to NRF-3; 5a. 201 Created(Subscription ID) from NRF-3 to NRF-1; 5b. 4xx/5xx(ProblemDetails) from NRF-3 to NRF-1; 6a. 201 Created(Subscription ID) from NRF-1 to Consumer; 6b. 4xx/5xx(ProblemDetails) from NRF-1 to Consumer. + +**Figure 5.2.2.5.5-1: Subscription to NF Instances with intermediate redirecting NRF** + +1. NF Service Consumer send a subscription request to NRF-1. +2. NRF-1 receives a subscription request but does not have the information to fulfil the request. Then NRF-1 sends the subscription request to a pre-configured NRF-2. +3. Upon receiving a subscription request, based on the SubscriptionData contained in the subscription request (e.g. NF type) and locally stored information (see clause 5.2.2.2.3), NRF-2 shall identify the next hop NRF, and redirect the subscription request by returning HTTP 307 Temporary Redirect response. +The 307 Temporary Redirect response shall contain a Location header field, the host part of the URI in the Location header field represents NRF-3. +4. Upon receiving 307 Temporary Redirect response, NRF-1 sends the subscription request to NRF-3 by using the URI contained in the Location header field of the 307 Temporary Redirect response. +- 5a. On success, "201 Created" shall be returned by NRF-3. +- 5b. On failure, if the creation of the subscription fails at the NRF-3, the NRF-3 shall return "4XX/5XX" response. +- 6a. On success, "201 Created" shall be forwarded to NF Service Consumer via NRF-1. The content of the POST response shall contain the representation describing the status of the request and the "Location" header shall be present and shall contain the URI of the created resource. The authority and/or deployment-specific string of the apiRoot of the created resource URI may differ from the authority and/or deployment-specific string of the apiRoot of the request URI received in the POST request. +- 6b. On failure, if the creation of the subscription fails, "4XX/5XX" shall be forwarded to NF Service Consumer via NRF-1. + +#### 5.2.2.5.6 Update of Subscription to NF Instances + +The subscription to notifications on NF Instances may be updated to refresh the validity time, when this time is about to expire. The NF Service Consumer may request a new validity time to the NRF, and the NRF shall answer with the new assigned validity time, if the operation is successful. + +This operation is executed by updating the resource identified by "subscriptionID". It is invoked by issuing an HTTP PATCH request on the URI representing the individual resource received in the Location header field of the "201 Created" response received during a successful subscription (see clause 5.2.2.5). + +![Sequence diagram showing the interaction between an NF Service Consumer and an NRF for subscription management. The consumer sends a PATCH request to the NRF. The NRF responds with one of three options: 2a. 204 No Content, 2b. 200 OK with SubscriptionData, or 2c. 4xx/5xx ProblemDetails or 3xx redirection.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NRF + Note right of NRF: 2a. 204 No Content () +2b. 200 OK (SubscriptionData) +2c. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer->>NRF: 1. PATCH .../subscriptions/{subscriptionID} (PatchData) + NRF-->>NF Service Consumer: 2a. 204 No Content () + Note right of NRF: 2b. 200 OK (SubscriptionData) + NRF-->>NF Service Consumer: 2b. 200 OK (SubscriptionData) + Note right of NRF: 2c. 4xx/5xx (ProblemDetails) or 3xx + NRF-->>NF Service Consumer: 2c. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an NRF for subscription management. The consumer sends a PATCH request to the NRF. The NRF responds with one of three options: 2a. 204 No Content, 2b. 200 OK with SubscriptionData, or 2c. 4xx/5xx ProblemDetails or 3xx redirection. + +**Figure 5.2.2.5.6-1: Subscription to NF Instances in the same PLMN** + +1. The NF Service Consumer shall send a PATCH request to the resource URI identifying the individual subscription resource. The content of the PATCH request shall contain a "replace" operation on the "validityTime" attribute of the SubscriptionData structure and shall contain a new suggested value for it; no other attribute of the resource shall be updated as part of this operation. +- 2a. On success, if the NRF accepts the extension of the lifetime of the subscription, and it accepts the requested value for the "validityTime" attribute, a response with status code "204 No Content" shall be returned. +- 2b. On success, if the NRF accepts the extension of the lifetime of the subscription, but it assigns a validity time different than the value suggested by the NF Service Consumer, a "200 OK" response code shall be returned. The response shall contain the new resource representation of the "subscription" resource, which includes the new validity time, as determined by the NRF, after which the subscription becomes invalid. +- 2c. On failure or redirection: + - If the update of the subscription fails at the NRF due to errors in the JSON Patch object in the request body, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. + - If the update of the subscription fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +**EXAMPLE:** + +``` + +PATCH .../subscriptions/2a58bf47 +Content-Type: application/json-patch+json + +[ + { "op": "replace", "path": "/validityTime", "value": "2018-12-30T23:20:50Z" }, +] + +``` + +``` + +HTTP/2 204 No Content + +``` + +## 5.2.2.5.7 Update of Subscription to NF Instances in a different PLMN + +The update of subscription in a different PLMN is done by updating a subscription resource identified by a "subscriptionID". + +For that, step 1 in clause 5.2.2.5.6 is executed (send a PATCH request to the NRF in the Serving PLMN); this request shall include the identity of the PLMN or SNPN of the home NRF (MCC/MNC/NID values) as a component values of the subscriptionID. + +Then, steps 1-2 in Figure 5.2.2.5.7-1 are executed, between the NRF in the Serving PLMN and the NRF in the Home PLMN. In this step, the subscriptionID sent to the NRF in the Home PLMN shall not contain the identity of the PLMN (i.e., it shall be the same subscriptionID value as originally generated by the NRF in the Home PLMN). The NRF in the Home PLMN returns a status code with the result of the operation. + +If the subscription was created in a different NRF in the HPLMN than the NRF in the HPLMN that receives the subscription update request, the latter shall forward the request received from the NRF in the serving PLMN towards the NRF in the HPLMN holding the subscription, using the information included in the subscriptionID (see + +clause 5.2.2.5.3). The subscriptionID value in the request forwarded to the NRF in the HPLMN holding the subscription shall contain the same value as originally generated by the latter. + +Finally, step 2 in clause 5.2.2.5.7-2 is executed; a status code is returned to the NF Service Consumer in Serving PLMN in accordance to the result received from NRF in the Home PLMN. + +![Sequence diagram showing the update of a subscription to NF instances in a different PLMN. The diagram involves two main entities: 'NRF in Serving PLMN' and 'NRF in Home PLMN'. Step 1 shows a PATCH request from the Serving PLMN to the Home PLMN. Step 2 shows the response from the Home PLMN back to the Serving PLMN, with three possible outcomes: 2a. 204 No Content, 2b. 200 OK with SubscriptionData, and 2c. 4xx/5xx (ProblemDetails) or 3xx.](6ca05954842b17f14dfd52f26b9d43d2_img.jpg) + +``` + +sequenceDiagram + participant NRF_Serving as NRF in Serving PLMN + participant NRF_Home as NRF in Home PLMN + Note right of NRF_Home: 2a. 204 No Content () +2b. 200 OK (SubscriptionData) +2c. 4xx/5xx (ProblemDetails) or 3xx + NRF_Serving->>NRF_Home: 1. PATCH .../subscriptions/{subscriptionID} (PatchData) + NRF_Home-->>NRF_Serving: 2a. 204 No Content () + NRF_Home-->>NRF_Serving: 2b. 200 OK (SubscriptionData) + NRF_Home-->>NRF_Serving: 2c. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the update of a subscription to NF instances in a different PLMN. The diagram involves two main entities: 'NRF in Serving PLMN' and 'NRF in Home PLMN'. Step 1 shows a PATCH request from the Serving PLMN to the Home PLMN. Step 2 shows the response from the Home PLMN back to the Serving PLMN, with three possible outcomes: 2a. 204 No Content, 2b. 200 OK with SubscriptionData, and 2c. 4xx/5xx (ProblemDetails) or 3xx. + +**Figure 5.2.2.5.7-1: Update of Subscription to NF Instances in a different PLMN** + +1. The NRF in Serving PLMN shall send a PATCH request to the resource URI representing the individual subscription. The content of the PATCH request shall contain a "replace" operation on the "validityTime" attribute of the SubscriptionData structure and shall contain a new suggested value for it; +- 2a. On success, if the NRF in the Home PLMN accepts the extension of the lifetime of the subscription, and it accepts the requested value for the "validityTime" attribute, a response with status code "204 No Content" shall be returned. +- 2b. On success, if the NRF in the Home PLMN accepts the extension of the lifetime of the subscription, but it assigns a validity time different than the value suggested by the NF Service Consumer, a "200 OK" response code shall be returned. The response shall contain the new resource representation of the "subscription" resource, which includes the new validity time, as determined by the NRF in the Home PLMN, after which the subscription becomes invalid. +- 2c. On failure or redirection: + - If the update of the subscription fails at the NRF due to errors in the JSON Patch object in the request body, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. + - If the update of the subscription fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +## 5.2.2.6 NFStatusNotify + +### 5.2.2.6.1 General + +This service operation notifies each NF Service Consumer that was previously subscribed to receiving notifications of registration/deregistration of NF Instances, or notifications of changes of the NF profile of a given NF Instance. The notification is sent to a callback URI that each NF Service Consumer provided during the subscription (see NFStatusSubscribe operation in 5.2.2.5). + +### 5.2.2.6.2 Notification from NRF in the same PLMN + +The operation is invoked by issuing a POST request to each callback URI of the different subscribed NF Instances. + +![Sequence diagram showing notification from NRF in the same PLMN. The diagram shows two lifelines: 'NF Service Consumer in Serving PLMN' and 'NRF in Serving PLMN'. The NRF sends a POST request (1. POST {nfStatusNotificationUri} (NotificationData)) to the consumer. The consumer responds with either a 204 No Content (2a) or an error status (2b. 4xx/5xx (ProblemDetails) or 3xx).](dd5771673aececa53d42ece89218299d_img.jpg) + +``` + +sequenceDiagram + participant NRF as NRF in Serving PLMN + participant Consumer as NF Service Consumer in Serving PLMN + Note right of Consumer: 2a. 204 No Content () + Note right of Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NRF->>Consumer: 1. POST {nfStatusNotificationUri} (NotificationData) + Consumer-->>NRF: 2a. 204 No Content () + Consumer-->>NRF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing notification from NRF in the same PLMN. The diagram shows two lifelines: 'NF Service Consumer in Serving PLMN' and 'NRF in Serving PLMN'. The NRF sends a POST request (1. POST {nfStatusNotificationUri} (NotificationData)) to the consumer. The consumer responds with either a 204 No Content (2a) or an error status (2b. 4xx/5xx (ProblemDetails) or 3xx). + +**Figure 5.2.2.6.2-1: Notification from NRF in the same PLMN** + +1. The NRF shall send a POST request to the callback URI. + +For notifications of newly registered NF Instances, the request body shall include the data associated to the newly registered NF, and its services, according to the criteria indicated by the NF Service Consumer during the subscription operation. These data shall contain the `nfInstanceURI` of the NF Instance, an indication of the event being notified ("registration"), and the new profile data (including, among others, the services offered by the NF Instance). + +For notifications of changes of the profile of a NF Instance, the request body shall include the `NFInstanceID` of the NF Instance whose profile was changed, an indication of the event being notified ("profile change"), and the new profile data. + +For notifications of deregistration of the NF Instance from NRF, the request body shall include the `NFInstanceID` of the deregistered NF Instance, and an indication of the event being notified ("deregistration"). + +**NOTE:** When the NF Instance changes its `NFStatus`, the NRF notifies subscribing entities with an "NF\_PROFILE\_CHANGED" event, except if the new `NFStatus` changes to "CANARY\_RELEASE" and the subscribing entity does not support the "Canary-Release" feature (see clause 6.1.9); in such case, the NRF notifies the subscribing entities with an "NF\_DEREGISTERED" event (see clause 6.1.6.3.6). + +When an NF Instance is newly registered in NRF, the NRF notifies subscribing entities with an "NF\_REGISTERED" event, except if such NF instance newly registers with status "CANARY\_RELEASE" and the subscribing entity does not support the "Canary-Release" feature; in such case, the NRF does not send an "NF\_REGISTERED" event to the subscribing entity. + +When an NF Service Instance changes its `NFServiceStatus` to "CANARY\_RELEASE", and the subscribing entity does not support the "Canary-Release" feature, the NRF sends a notification with an "NF\_PROFILE\_CHANGED" event that removes such NF Service Instance from the NF profile, so the subscribing entity can remove such instance from the list of available service instances of the corresponding NF producer. + +When an NF Service Consumer subscribes to a set of NFs (using the different subscription conditions specified in clause 6.1.6.2.35), a change in the profile of the monitored NF Instance may result in such NF becoming a part of the NF set, or stops becoming a part of it (e.g., an NF Service Consumer subscribing to all NFs offering a given NF Service, and then, a certain NF Instance changes its profile by adding or removing an NF Service of its NF Profile); in such case, the NRF shall use the "NF\_PROFILE\_CHANGED" event type in the notification. Similarly, a change of the status (i.e. the "`nfStatus`" attribute of the NF Profile) shall result into the NRF to send notifications to subscribing NFs with event type set to "NF\_PROFILE\_CHANGED". + +When an NF Service Consumer subscribes to a set of NFs, using the subscription conditions specified in clause 6.1.6.2.35, in case of a change of profile(s) of NFs potentially related to those subscription conditions, the NRF shall send notification to subscribing NF Service Consumer(s) to those NFs no longer matching the subscription conditions, and to subscribing NF Service Consumer(s) to NFs that start matching the subscription conditions. In that case, the NRF indicates in the notification data whether the notification is due to the NF Instance to newly start or stop matching the subscription condition (i.e. based on the presence of the "`conditionEvent`" attribute of the `NotificationData`). + +The notification of changes of the profile may be done by the NRF either by sending the entire new NF Profile, or by indicating a number of "delta" changes (see clause 6.1.6.2.17) from an existing NF Profile that might have been previously received by the NF Service Consumer during an `NFDiscovery` search operation (see clause 5.3.2.2). If the NF Service Consumer receives "delta" changes related to an NF Service Instance (other than + +adding a new NF Service Instance) that had not been previously discovered, those changes shall be ignored by the NF Service Consumer, but any other "delta" changes related to NF Service Instances previously discovered or adding a new NF Service Instance shall be applied. + +Change of authorization attributes (allowedNfTypes, allowedNfDomains, allowedNssais, allowedPlmns etc) shall trigger a "NF\_PROFILE\_CHANGED" notification from NRF, if the change of the NF Profile results in that the NF Instance starts or stops being authorized to be accessed by an NF having subscribed to be notified about NF profile changes. In this case, the NRF indicates in the notification data whether the notification is due to the NF Instance to newly start or stop matching the subscription condition (i.e. based on the presence of the "conditionEvent" attribute of the NotificationData). Otherwise change of authorization attributes shall not trigger notification. + +The notifications of new registrations, or updates of existing registrations, shall not include the content (or the changes) of the authorization attributes ("allowedXXX" attributes) of the target NF profile being monitored, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request. + +2a. On success, "204 No content" shall be returned by the NF Service Consumer. + +2b. On failure or redirection: + +- If the NF Service Consumer does not consider the "nfStatusNotificationUri" as a valid notification URI (e.g., because the URI does not belong to any of the existing subscriptions created by the NF Service Consumer in the NRF), the NF Service Consumer shall return "404 Not Found" status code with the ProblemDetails IE providing details of the error. +- In the case of redirection, the NF service consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NF service consumer endpoint. + +#### 5.2.2.6.3 Notification from NRF in a different PLMN + +The operation is invoked by issuing a POST request to each callback URI of the different subscribed NF Instances. + +![Sequence diagram showing notification from NRF in Home PLMN to NF Service Consumer in Serving PLMN.](ca5dc5fde2061d0ca2051ef7840fc842_img.jpg) + +``` + +sequenceDiagram + participant NRF as NRF in Home PLMN + participant NSC as NF Service Consumer in Serving PLMN + Note right of NSC: 1. POST {nfStatusNotificationUri} (NotificationData) + NSC->>NRF: + Note left of NRF: 2a. 204 No Content () + Note left of NRF: 2b. 4xx/5xx (ProblemDetails) or 3xx + NRF-->>NSC: + +``` + +The diagram illustrates a sequence of interactions between an NF Service Consumer in a Serving PLMN and an NRF in a Home PLMN. + Step 1: A POST request containing {nfStatusNotificationUri} (NotificationData) is sent from the NRF in Home PLMN to the NF Service Consumer in Serving PLMN. + Step 2: The NF Service Consumer in Serving PLMN responds with either a 204 No Content () status code (2a) or a 4xx/5xx (ProblemDetails) or 3xx status code (2b) back to the NRF in Home PLMN. + +Sequence diagram showing notification from NRF in Home PLMN to NF Service Consumer in Serving PLMN. + +**Figure 5.2.2.6.3-1: Notification from NRF in a different PLMN** + +Steps 1 and 2 are identical to steps 1 and 2 in Figure 5.2.2.6.2-1. + +It should be noted that the POST request shall be sent directly from the NRF in Home PLMN to the NF Service Consumer in Serving PLMN, without involvement of the NRF in Serving PLMN. + +#### 5.2.2.6.4 Notification for subscription via intermediate NRF + +![Sequence diagram for Notification for subscription via intermediate NRF. Lifelines: NF Service Consumer in Serving PLMN, NRF-1 in Serving PLMN, NRF-2 in Serving PLMN. Step 0: Subscription via intermediate NRF. Step 1: POST {nfSatusModificationURI}(NotificationData) from NRF-2 to Consumer. Step 2a: 204 No Content () from NRF-2 to Consumer. Step 2b: 4xx/5xx(ProblemDetails) or 3xx from NRF-2 to Consumer.](9f9386d5b3d6cbeb1ed104a799320ebf_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer in Serving PLMN + participant NRF1 as NRF-1 in Serving PLMN + participant NRF2 as NRF-2 in Serving PLMN + Note over Consumer, NRF2: 0. Subscription via intermediate NRF + NRF2->>Consumer: 1. POST {nfSatusModificationURI}(NotificationData) + NRF2-->>Consumer: 2a. 204 No Content () + NRF2-->>Consumer: 2b. 4xx/5xx(ProblemDetails) or 3xx + +``` + +Sequence diagram for Notification for subscription via intermediate NRF. Lifelines: NF Service Consumer in Serving PLMN, NRF-1 in Serving PLMN, NRF-2 in Serving PLMN. Step 0: Subscription via intermediate NRF. Step 1: POST {nfSatusModificationURI}(NotificationData) from NRF-2 to Consumer. Step 2a: 204 No Content () from NRF-2 to Consumer. Step 2b: 4xx/5xx(ProblemDetails) or 3xx from NRF-2 to Consumer. + +**Figure 5.2.2.6.4-1: Notification for subscription via intermediate NRF** + +Step 0 is the NF Service Consumer creates a subscription to NRF-2 via intermediate NRF. + +Steps 1 and 2 are identical to steps 1 and 2 in Figure 5.2.2.6.2-1. + +The POST request shall be sent directly from NRF-2 to the NF Service Consumer without involvement of NRF-1. + +#### 5.2.2.7 NFStatusUnSubscribe + +##### 5.2.2.7.1 General + +This service operation removes an existing subscription to notifications. + +##### 5.2.2.7.2 Subscription removal in the same PLMN + +It is executed by deleting a given resource identified by a "subscriptionID". The operation is invoked by issuing a DELETE request on the URI representing the specific subscription received in the Location header field of the "201 Created" response received during a successful subscription (see clause 5.2.2.5). + +![Sequence diagram for Subscription removal in the same PLMN. Lifelines: NF Service Consumer in Serving PLMN, NRF in Serving PLMN. Step 1: DELETE .../subscriptions/{subscriptionID} () from Consumer to NRF. Step 2a: 204 No Content () from NRF to Consumer. Step 2b: 4xx/5xx (ProblemDetails) or 3xx from NRF to Consumer.](e5d1bcc699904ca5d56caf65ec83f5f3_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer in Serving PLMN + participant NRF as NRF in Serving PLMN + Consumer->>NRF: 1. DELETE .../subscriptions/{subscriptionID} () + NRF-->>Consumer: 2a. 204 No Content () + NRF-->>Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Subscription removal in the same PLMN. Lifelines: NF Service Consumer in Serving PLMN, NRF in Serving PLMN. Step 1: DELETE .../subscriptions/{subscriptionID} () from Consumer to NRF. Step 2a: 204 No Content () from NRF to Consumer. Step 2b: 4xx/5xx (ProblemDetails) or 3xx from NRF to Consumer. + +**Figure 5.2.2.7.2-1: Subscription removal in the same PLMN** + +1. The NF Service Consumer shall send a DELETE request to the resource URI representing the individual subscription. The request body shall be empty. +- 2a. On success, "204 No Content" shall be returned. The response body shall be empty. +- 2b. On failure or redirection: + - If the subscription, identified by the "subscriptionID", is not found in the list of active subscriptions in the NRF's database, the NRF shall return "404 Not Found" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +### 5.2.2.7.3 Subscription removal in a different PLMN + +The subscription removal in a different PLMN is done by deleting a resource identified by a "subscriptionID", in the NRF of the Home PLMN. + +For that, step 1 in clause 5.2.2.7.2 is executed (send a DELETE request to the NRF in the Serving PLMN); this request shall include the identity of the PLMN or SNPN of the home NRF (MCC/MNC/NID values) as component values of the subscriptionID (see clause 5.2.2.5.3). + +Then, steps 1-2 in Figure 5.2.2.7.3-1 are executed, between the NRF in the Serving PLMN and the NRF in the Home PLMN. In this step, the subscriptionID sent to the NRF in the Home PLMN shall not contain the identity of the PLMN (i.e., it shall be the same subscriptionID value as originally generated by the NRF in the Home PLMN). The NRF in the Home PLMN returns a status code with the result of the operation. + +If the subscription was created in a different NRF in the HPLMN than the NRF in the HPLMN that receives the subscription delete request, the latter shall forward the request received from the NRF in the serving PLMN towards the NRF in the HPLMN holding the subscription, using the information included in the subscriptionID (see clause 5.2.2.5.3). The subscriptionID value in the request forwarded to the NRF in the HPLMN holding the subscription shall contain the same value as originally generated by the latter. + +Finally, step 2 in clause 5.2.2.7.2 is executed; a status code is returned from the NRF in serving PLMN to the NF Service Consumer in Serving PLMN in accordance to the result received from NRF in Home PLMN. + +![Sequence diagram showing subscription removal in a different PLMN. The diagram involves two main entities: 'NRF in Serving PLMN' and 'NRF in Home PLMN'. The sequence of messages is: 1. A DELETE request is sent from the Serving PLMN to the Home PLMN. 2a. A '204 No Content' response is sent from the Home PLMN back to the Serving PLMN. 2b. Alternatively, a '4xx/5xx (ProblemDetails)' or '3xx' response is sent from the Home PLMN back to the Serving PLMN.](dfaa8b98082261913dac00eae86b2889_img.jpg) + +``` + +sequenceDiagram + participant NRF_Serving as NRF in Serving PLMN + participant NRF_Home as NRF in Home PLMN + Note left of NRF_Serving: 1. DELETE .../subscriptions/{subscriptionID} () + NRF_Serving->>NRF_Home: 1. DELETE .../subscriptions/{subscriptionID} () + Note right of NRF_Home: 2a. 204 No Content () + NRF_Home-->>NRF_Serving: 2a. 204 No Content () + Note right of NRF_Home: 2b. 4xx/5xx (ProblemDetails) or 3xx + NRF_Home-->>NRF_Serving: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing subscription removal in a different PLMN. The diagram involves two main entities: 'NRF in Serving PLMN' and 'NRF in Home PLMN'. The sequence of messages is: 1. A DELETE request is sent from the Serving PLMN to the Home PLMN. 2a. A '204 No Content' response is sent from the Home PLMN back to the Serving PLMN. 2b. Alternatively, a '4xx/5xx (ProblemDetails)' or '3xx' response is sent from the Home PLMN back to the Serving PLMN. + +**Figure 5.2.2.7.3-1: Subscription removal in a different PLMN** + +1. The NF Service Consumer shall send a DELETE request to the resource URI representing the individual subscription. The request body shall be empty. +- 2a. On success, "204 No Content" shall be returned. The response body shall be empty. +- 2b. On failure or redirection: + - If the subscription, identified by the "subscriptionID", is not found in the list of active subscriptions in the NRF's database, the NRF shall return "404 Not Found" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +### 5.2.2.8 NFListRetrieval + +#### 5.2.2.8.1 General + +This service operation allows the retrieval of a list of NF Instances that are currently registered in NRF. The operation may apply to the whole set of registered NF instances or only to a subset of the NF instances, based on a given NF type and/or maximum number of NF instances to be returned. + +![Sequence diagram for NF instance list retrieval](05eb72d372e4bf78e3d6a64949d77bcc_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant NRF + Note right of NRF: 1. GET .../nf-instances? + NRF->>NF Service Consumer: 2a. 200 OK (UriList) + Note right of NRF: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +The diagram illustrates the interaction for NF instance list retrieval. It features two lifelines: 'NF Service Consumer' on the left and 'NRF' on the right. A solid arrow labeled '1. GET .../nf-instances?' points from the consumer to the NRF. A return arrow points from the NRF back to the consumer, with two possible response boxes: '2a. 200 OK (UriList)' and '2b. 4xx/5xx (ProblemDetails) or 3xx'. + +Sequence diagram for NF instance list retrieval + +**Figure 5.2.2.8.1-1: NF instance list retrieval** + +1. The NF Service Consumer shall send an HTTP GET request to the resource URI "nf-instances" collection resource. The optional input filter criteria (e.g. "nf-type") and pagination parameters for the retrieval request may be included in query parameters. +- 2a. On success, "200 OK" shall be returned. The response body shall contain the URI (conforming to the resource URI structure as described in clause 5.2.2.9.1) of each registered NF in the NRF that satisfy the retrieval filter criteria (e.g., all NF instances of the same NF type), or an empty list if there are no NFs to return in the query result (e.g., because there are no registered NFs in the NRF, or because there are no matching NFs of the type specified in the "nf-type" query parameter, currently registered in the NRF). The total count of items satisfying the filter criteria (e.g. "nf-type") should be returned in the response. +- 2b. On failure or redirection: + - If the NF Service Consumer is not allowed to retrieve the registered NF instances, the NRF shall return "403 Forbidden" status code. + - If the NF Instance list retrieval fails at the NRF due to errors in the input data in the URI query parameters, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. + - If the discovery request fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +## 5.2.2.9 NFProfileRetrieval + +### 5.2.2.9.1 General + +This service operation allows the retrieval of the NF profile of a given NF instance currently registered in NRF. + +![Sequence diagram for NF profile retrieval](1841f348dfa81a3438d4e1f8465d9ac7_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant NRF + Note right of NRF: 1. GET .../nf-instances/{nfInstanceId} + NRF->>NF Service Consumer: 2a. 200 OK (NFProfile) + Note right of NRF: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +The diagram illustrates the interaction for NF profile retrieval. It features two lifelines: 'NF Service Consumer' on the left and 'NRF' on the right. A solid arrow labeled '1. GET .../nf-instances/{nfInstanceId}' points from the consumer to the NRF. A return arrow points from the NRF back to the consumer, with two possible response boxes: '2a. 200 OK (NFProfile)' and '2b. 4xx/5xx (ProblemDetails) or 3xx'. + +Sequence diagram for NF profile retrieval + +**Figure 5.2.2.9.1-1: NF profile retrieval** + +1. The NF Service Consumer shall send an HTTP GET request to the resource URI "nf-instances/{nfInstanceId}". +- 2a. On success, "200 OK" shall be returned. The response body shall contain the NF profile of the NF instance identified in the request. +- 2b. On failure or redirection: + +- If the NF Service Consumer is not allowed to retrieve the NF profile of this specific registered NF instance, the NRF shall return "403 Forbidden" status code. +- If the NF Profile retrieval fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +## 5.3 Nnrf\_NFDiscovery Service + +### 5.3.1 Service Description + +The Nnrf\_NFDiscovery service allows a NF or SCP Instance to discover other NF Instances with the potential services they offer, or to discover SEPP instances in the same PLMN, by querying the local NRF. + +The Nnrf\_NFDiscovery service also allows: + +- an SCP to discover other SCP instances, +- an NF or SCP to discover the list of NRF instances that are part of the NRF set with, for each NRF instance, its NRF instance ID and addressing information, if the NRF is part of an NRF set. + +It also allows an NRF in a PLMN to re-issue a discovery request towards an NRF in another PLMN (e.g., the HPLMN of a certain UE). + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +The service operations defined for the Nnrf\_NFDiscovery service are as follows: + +- NFDiscover: It provides to the NF service consumer or SCP the profile (including IP address(es) or FQDN) of the NF Instance(s) or NF Service(s) or SEPP instances matching certain input criteria. It also provides to the SCP the profile (including IP address(es) or FQDN) of the SCP Instance(s) matching certain input criteria. + +The NFDiscover operation can be invoked by an NF Service Consumer (i.e., "source NF") or SCP requesting to discover NF instances (i.e., "target NFs") located in the same PLMN, or in a different PLMN, or SEPP instances located in the same PLMN. It can also be invoked by an SCP requesting to discover SCP instances located in the same PLMN. + +In the description of these operations in clause 5.3.2.2, when the NF instances are located in the same PLMN, both source NF and target NFs are said to be located in the "Serving PLMN" but, in the general case, the functionality is not restricted to the PLMN that is serving a given UE, and it shall be applicable as well to any scenario in which source NF and target NFs belong to the same PLMN. + +When source NF and target NFs are located in different PLMNs, the source NF is said to be in the "Serving PLMN", and the target NFs (and the NRF where they are registered) are said to be in the "Home PLMN", similarly to the scenarios described in 3GPP TS 23.502 [3], but the functionality shall be equally applicable to any scenario between any pair of PLMNs (e.g. with the source NF in the Home PLMN and the target NF in the Serving PLMN). + +The SCP and SEPP are treated by the Nnrf\_NFDiscovery service in the same way as NFs. Specifically, the SCP and SEPP are designated with a specific NF type and NF Instance ID. However, the SCP and SEPP do not support services. Accordingly, references to "NF" or "NF Profile" in the description of the service operations in the following clauses also apply to an SCP and SEPP. + +- SCPDomainRoutingInfoGet: It allows a service consumer (e.g. SCP) to fetch the SCP domain routing information (list of all SCP Domains registered by SCPs and the interconnected SCP domains per SCP domain), if both the SCP and the NRF supports the "SCPDR" feature. It also allows a service consumer (e.g. NRF) to fetch the local SCP domain routing information (based on SCPs registered in the NRF as service producer), if both the NRF as service consumer and NRF as service producer supports the "SCPDR" feature. + +NOTE: Two SCP domains are considered interconnected when at least one SCP belongs to both SCP domains, i.e. at least one SCP can bridge messages between these two SCP domains. + +- SCPDomainRoutingInfoSubscribe: It allows a service consumer (e.g. SCP) to create a subscription for changes of the SCP domain routing information, if both the SCP and the NRF supports the "SCPDRI" feature. It also allows a service consumer (e.g. NRF) to create a subscription for changes of local SCP domain routing information, if both the NRF as service consumer and NRF as service producer supports the "SCPDRI" feature. +- SCPDomainRoutingInfoNotify: It allows the NRF to send notification(s) to a service consumer (e.g. SCP) previously subscribed to the changes of the SCP domain routing information, if both the SCP and the NRF supports the "SCPDRI" feature. It also allows the NRF as service producer to send notification(s) to a service consumer (e.g. NRF) previously subscribed to the changes of the local SCP domain routing information, if both the NRF as service consumer and NRF as service producer supports the "SCPDRI" feature. +- SCPDomainRoutingInfoUnsubscribe: It allows a service consumer (e.g. SCP or NRF) to delete a previously created subscription for changes of the SCP domain routing information, if both the service consumer and the NRF as service producer supports the "SCPDRI" feature. + +A NRF may be part of an NRF set, whereby all NRF instances of the NRF Set share the same context data (e.g. registered NF profiles, NF status subscriptions). If so, the NF Service Consumer may be configured with the NRF Set ID or it may discover the same in the NRF Bootstrapping response. + +If the NRF is part of an NRF set, the NF Service Consumer may retrieve the NRF Set Information from the NRF via the Nnrf\_NFDiscovery service, which allows to discover the list of NRF instances that are part of the NRF set with, for each NRF instance, its NRF Instance ID and addressing information (i.e. part of NRF profile). + +NOTE: As part of the discovery of NRF instances belonging to an NRF Set, not all attributes in the NFProfile and NFService data structures (typically used for NF Consumer – NF Producer interaction) are needed for the NF Consumer to interact with the instances of the NRF Set, so the discovery response from NRF can be simplified and omit certain parameters. + +The NF Service Consumer may register with any of the NRF Instance Id within the NRF Set. If the NRF instance where an NF Service Consumer registered is down, the NF Service Consumer need not re-register to any new NRF instance within the NRF Set. The NRF may provide a binding indication to the NF service consumer, e.g. when the NF Service Consumer registers or updates its NF profile in the NRF or when it issues heartbeat requests, to indicate a preferred binding of the NF Service Consumer to one NRF instance within the NRF set, e.g. based on the location or data center of the registering/registered NF Service Consumer. + +## 5.3.2.2 NFDiscover + +### 5.3.2.2.1 General + +This service operation discovers the set of NF Instances (and their associated NF Service Instances), represented by their NF Profile, that are currently registered in NRF and satisfy a number of input query parameters. + +Before a service consumer invokes this service operation, it shall consider if it is possible to reuse the results from a previous searching (service discovery). + +The service consumer should reuse the previous result if input query parameters in the new service discovery request are the same as used for the previous search and the validity period of the result is not expired. + +The service consumer may consider reusing the previous result if the attributes as required for the new query consist of the query attributes from the previous query and additional query attributes. In such case, when the results of a previous query are reused, the service consumer need consider that the previous results will possibly include NF profiles that the new query would not; hence, the service consumer has to complete the filtering itself against the additional filter attributes in the new internal query. + +Otherwise, if the query parameters in the new service discovery are different and don't consist of the previous query attributes and additional ones (i.e. the new query parameters, in general, don't have any relationship with those of the previous search), the reuse of cached profiles may still be done. + +In these two last cases (i.e. where the query parameters of the new query are not identical to the previous query), re-using data from cached profiles may possibly yield to different results than if a new discovery was performed, and thus may be subject to operator's policy. + +NOTE: Certain types of query attributes affect the contents of the NF Profiles returned in the discovery responses (e.g., "preferred-location" typically affects the setting of the "priority" attribute inside the NF Profiles returned by NRF); reusing the results from a previous query, when the new query involves any of such parameters, may not be feasible. + +If an SCP receives complete NF profiles (including, e.g. the authorization attributes) from the NRF (see clauses 5.3.2.2.2 and 5.2.2.5.2), the SCP may use these cached profiles to serve new service requests received from NFs with different requester's information (e.g. different NF type, domain, S-NSSAI), but if it does so, the SCP shall check the authorization parameters of the complete profiles to ascertain that the requesting NFs are authorized to access the related NF services. + +The NF Service Consumer should avoid to send multiple NF discovery requests with the same query parameters to NRF simultaneously. + +### 5.3.2.2.2 Service Discovery in the same PLMN + +This service operation is executed by querying the "nf-instances" resource. The request is sent to an NRF in the same PLMN of the NF Service Consumer. + +![Sequence diagram showing Service Discovery Request in the same PLMN. The NF Service Consumer in Serving PLMN sends a GET request to the NRF in Serving PLMN. The NRF responds with either a 200 OK (SearchResult) or a 4xx/5xx (ProblemDetails) or 3xx.](9ff1b32449ea068bba9647d71904bd59_img.jpg) + +``` + +sequenceDiagram + participant NFSC as NF Service Consumer in Serving PLMN + participant NRF as NRF in Serving PLMN + Note left of NFSC: + NFSC->>NRF: 1. GET ../nf-instances? + Note right of NRF: + NRF-->>NFSC: 2a. 200 OK (SearchResult) + Note right of NRF: + NRF-->>NFSC: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing Service Discovery Request in the same PLMN. The NF Service Consumer in Serving PLMN sends a GET request to the NRF in Serving PLMN. The NRF responds with either a 200 OK (SearchResult) or a 4xx/5xx (ProblemDetails) or 3xx. + +**Figure 5.3.2.2.2-1: Service Discovery Request in the same PLMN** + +1. The NF Service Consumer shall send an HTTP GET request to the resource URI "nf-instances" collection resource. The input filter criteria for the discovery request shall be included in query parameters. + +An SCP may request to discover the complete profile of NF instances (including, e.g. the authorization attributes) matching the query parameters. Upon receiving such a request, the NRF shall verify that the requesting entity is authorized to discover the complete profile of NF instances, based on local policies or the receipt of an access token granting such permission. If the requesting entity is not authorized to do so, the NRF shall reject the request or handle it as a service discovery request without access to the complete profile. + +When certain query parameters in the discovery request are not supported by the NRF, the NRF shall ignore the unsupported query parameters and continue processing the request with the rest of the query parameters. + +- 2a. On success, "200 OK" shall be returned. The response body shall contain a validity period, during which the search result can be cached by the NF Service Consumer, and an array of NF Profile objects, and/or a map of NFInstanceInfo objects of NF instances (if the NF service consumer indicated support of the Enh-NF-Discovery feature in the request) that satisfy the search filter criteria (e.g., all NF Instances offering a certain NF Service name in REGISTERED status, or empty array in case search filter criteria do not match a NF Instance in REGISTERED status). In the latter case, the response may include the noProfileMatchInfo attribute to provide the specific reason for not finding any NF instance that can match the search filter criteria. + +If the NRF has ignored certain unsupported query parameter(s) when processing the discovery request, the NRF may additionally include the indication of ignored unsupported query parameters in the search result. The NF consumer may use the indication to identify whether the NF candidates in the search result are all usable for the service logic, i.e. all query parameter related to the key service logic are not ignored. + +- 2b. On failure or redirection: + +- If the NF Service Consumer is not allowed to discover the NF services for the requested NF type provided in the query parameters, the NRF shall return "403 Forbidden" response. +- If the discovery request fails at the NRF due to errors in the input data in the URI query parameters, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. +- If the discovery request fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +The NF Profile objects returned in a successful result shall contain generic data of each NF Instance, applicable to any NF type, and it may also contain NF-specific data, for those NF Instances belonging to a specific type (e.g., the attribute "udrInfo" is typically present in the NF Profile when the type of the NF Instance takes the value "UDR"). In addition, the attribute "customInfo", may be present in the NF Profile for those NF Instances with custom NF types. + +For those NF Instances, the "customInfo" attribute shall be returned by NRF, if available, as part of the NF Profiles returned in the discovery response. + +The NRF shall also include, in the returned NF Profile objects, the Vendor-Specific attributes (see 3GPP TS 29.500 [4], clause 6.6.3) that may have been provided by the registered NF Instances. + +If the response includes a map of NFInstanceInfo objects of NF instances, the NF Service Consumer may retrieve the NF profiles by issuing service discovery requests with the target-nf-instance-id parameter identifying the target NF Instance ID, or with the target-nf-instance-id-list parameter identifying a list of target NF Instance IDs held by the same NRF; the service discovery request shall also include the nrf-disc-uri parameter set to the API URI of the Nnrf\_NFDiscovery service of the NRF holding the NF profile(s), if the nrfDiscApiUri attribute was received in the NFInstanceInfo object and if the service discovery request is addressed to a different NRF than the NRF holding the NF profile(s). + +### 5.3.2.2.3 Service Discovery in a different PLMN + +The service discovery in a different PLMN is done by querying the "nf-instances" resource in the NRF of the Home PLMN. + +For that, step 1 in clause 5.3.2.2.2 is executed (send a GET request to the NRF in the Serving PLMN); this request shall include the identity of the PLMN of the home NRF in a query parameter of the URI. + +If the NRF in Serving PLMN knows that Oauth2-based authorization is required for accessing the NF Discovery service of the NRF in Home PLMN, e.g. by learning this during an earlier Bootstrapping procedure or local configuration, and if the request received at the NRF in Serving PLMN does not include an access token, the NRF in Serving PLMN may reject the request with a 401 Unauthorized as specified in clause 6.7.3 of 3GPP TS 29.500 [4]. + +Then, steps 1-2 in Figure 5.3.2.2.3-1 are executed, between the NRF in the Serving PLMN and the NRF in the Home PLMN. In this step, the presence of the PLMN ID of the Home NRF in the query parameter of the URI is not required. The NRF in the Home PLMN returns a status code with the result of the operation. The NRF in the Serving PLMN shall be configured with: + +- a telescopic FQDN (see 3GPP TS 23.003 [12] and 3GPP TS 29.500 [4]) of the NRF in the Home PLMN, if TLS protection between the NRF and the SEPP in the serving PLMN relies on using telescopic FQDN; or + +NOTE: This is required for the NRF in the serving PLMN to route the NF discovery request to the NRF in the HPLMN through a SEPP in the serving PLMN and the SEPP to terminate the TLS connection with a wildcard certificate. + +- with the SEPP FQDN (or the FQDN of the SCP if the communication between the NRF and the SEPP goes through an SCP), if TLS protection between the NRF and the SEPP in the serving PLMN relies on using the 3gpp-Sbi-Target-apiRoot header. + +See clause 6.1.4.3 of 3GPP TS 29.500 [4]. + +Finally, step 2 in clause 5.3.2.2.2 is executed; a status code is returned to the NF Service Consumer in Serving PLMN in accordance to the result received from NRF in Home PLMN. + +![Sequence diagram for Service Discovery in a different PLMN. It shows two lifelines: 'NRF in Serving PLMN' and 'NRF in Home PLMN'. Step 1: 'NRF in Serving PLMN' sends a 'GET .../nf-instances?' request to 'NRF in Home PLMN'. Step 2: 'NRF in Home PLMN' responds with '2a. 200 OK (SearchResult)' or '2b. 4xx/5xx (ProblemDetails) or 3xx' back to 'NRF in Serving PLMN'.](9f6dec4d4e9fde40bce018861ef1278e_img.jpg) + +``` + +sequenceDiagram + participant NRF_Serving as NRF in Serving PLMN + participant NRF_Home as NRF in Home PLMN + Note left of NRF_Serving: + NRF_Serving->>NRF_Home: 1. GET .../nf-instances? + Note right of NRF_Home: + NRF_Home-->>NRF_Serving: 2a. 200 OK (SearchResult) +2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Service Discovery in a different PLMN. It shows two lifelines: 'NRF in Serving PLMN' and 'NRF in Home PLMN'. Step 1: 'NRF in Serving PLMN' sends a 'GET .../nf-instances?' request to 'NRF in Home PLMN'. Step 2: 'NRF in Home PLMN' responds with '2a. 200 OK (SearchResult)' or '2b. 4xx/5xx (ProblemDetails) or 3xx' back to 'NRF in Serving PLMN'. + +**Figure 5.3.2.2.3-1: Service Discovery in a different PLMN** + +Steps 1 and 2 are similar to steps 1 and 2 in Figure 5.3.2.2.2-1, where the originator of the service invocation is the NRF in Serving PLMN, and the recipient of the service invocation is the NRF in the Home PLMN. + +As most NF Service Consumers in Serving PLMN do not need the entire data in the NF profile of the NF producer, the NRF in the home PLMN, based on operator policies, may simplify the NF discovery response by not including the entire data which is not directly relevant to the NF discovery request (e.g. returning a subset of supiRanges, or not including taiList). + +If the NRF in the home PLMN has ignored certain unsupported query parameter(s) when processing the discovery request, the NRF may additionally include the indication of ignored unsupported query parameters in the search result. If the indication of ignored unsupported query parameters is supported by the NRF in the serving PLMN, it should forward the received indication of ignored unsupported query parameters to the NF service consumer. + +#### 5.3.2.2.4 Service Discovery with intermediate redirecting NRF + +When multiple NRFs are deployed in one PLMN, one NRF may query the "nf-instances" resource in a different NRF so as to fulfil the service discovery request from a NF service consumer. The query between these two NRFs is redirected by a third NRF. + +![Sequence diagram for Service Discovery with intermediate redirecting NRF. It shows three lifelines: 'NRF-1', 'NRF-2', and 'NRF-3'. Step 1: 'NRF-1' sends a 'GET .../nf-instances?' request to 'NRF-2'. Step 2: 'NRF-2' responds with '2a. 307 Temporary Redirect' or '2b. 404 Not Found' back to 'NRF-1'. Step 3: 'NRF-1' then sends the 'GET .../nf-instances?' request to 'NRF-3'. Step 4: 'NRF-3' responds with '4a. 200 OK (SearchResult)' or '4b. 4xx/5xx (ProblemDetails) or 3xx' back to 'NRF-1'.](b560268ea8f6526970f23f0da225b099_img.jpg) + +``` + +sequenceDiagram + participant NRF1 as NRF-1 + participant NRF2 as NRF-2 + participant NRF3 as NRF-3 + Note left of NRF1: + NRF1->>NRF2: 1. GET .../nf-instances? + Note right of NRF2: + NRF2-->>NRF1: 2a. 307 Temporary Redirect +2b. 404 Not Found + Note left of NRF1: + NRF1->>NRF3: 3. GET .../nf-instances? + Note right of NRF3: + NRF3-->>NRF1: 4a. 200 OK (SearchResult) +4b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Service Discovery with intermediate redirecting NRF. It shows three lifelines: 'NRF-1', 'NRF-2', and 'NRF-3'. Step 1: 'NRF-1' sends a 'GET .../nf-instances?' request to 'NRF-2'. Step 2: 'NRF-2' responds with '2a. 307 Temporary Redirect' or '2b. 404 Not Found' back to 'NRF-1'. Step 3: 'NRF-1' then sends the 'GET .../nf-instances?' request to 'NRF-3'. Step 4: 'NRF-3' responds with '4a. 200 OK (SearchResult)' or '4b. 4xx/5xx (ProblemDetails) or 3xx' back to 'NRF-1'. + +**Figure 5.3.2.2.4-1: Service Discovery with intermediate redirecting NRF** + +1. NRF-1 receives a service discovery request but does not have the information to fulfil the request. Then NRF-1 sends the service discovery request to a pre-configured NRF-2. +- 2a. Upon receiving a service discovery request, based on the information contained in the service discovery request (e.g. the "supi" query parameter in the URI) and locally stored information NRF-2 shall identify the next hop NRF (see clause 5.2.2.2.3), and redirect the service discovery request by returning HTTP 307 Temporary Redirect response. The locally stored information in NRF-2 may: + - a) be preconfigured; or + +- b) registered by other NRFs (see clause 5.2.2.2.3). + +The 307 Temporary Redirect response shall contain a Location header field, the host part of the URI in the Location header field represents NRF-3. + +- 2b. if NRF-2 does not have enough information to redirect the service discovery request, then it responds with 404 Not Found, and the rest of the steps are omitted. +- 3. Upon receiving 307 Temporary Redirect response, NRF-1 sends the service discovery request to NRF-3 by using the URI contained in the Location header field of the 307 Temporary Redirect response. +- 4a. Upon success, NRF-3 returns the search result. +- 4b. On failure or redirection: + - If the NF Service Consumer is not allowed to discover the NF services for the requested NF type provided in the query parameters, the NRF shall return "403 Forbidden" response. + - If the discovery request fails at the NRF due to errors in the input data in the URI query parameters, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. + - If the discovery request fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +#### 5.3.2.2.5 Service Discovery with intermediate forwarding NRF + +When multiple NRFs are deployed in one PLMN, one NRF may query the "nf-instances" resource in a different NRF so as to fulfil the service discovery request from a NF service consumer. The query between these two NRFs is forwarded by a third NRF. + +![Sequence diagram illustrating Service Discovery with intermediate forwarding NRF. The diagram shows three NRFs: NRF-1, NRF-2, and NRF-3. NRF-1 sends a GET request to NRF-2. NRF-2 then forwards the request to NRF-3. NRF-3 returns a response to NRF-2, which in turn returns a response to NRF-1. The responses can be 200 OK (SearchResult), 4xx/5xx (ProblemDetails), or 3xx (redirect).](132cff7e872feb31f629703959beddd7_img.jpg) + +``` + +sequenceDiagram + participant NRF-1 + participant NRF-2 + participant NRF-3 + Note left of NRF-1: 1. GET .../nf-instances? + NRF-1->>NRF-2: 1. GET .../nf-instances? + Note right of NRF-2: 2a. GET .../nf-instances? + NRF-2->>NRF-3: 2a. GET .../nf-instances? + Note right of NRF-3: 3a. 200 OK (SearchResult) +3b. 4xx/5xx (ProblemDetails) or 3xx + NRF-3-->>NRF-2: 3a. 200 OK (SearchResult) +3b. 4xx/5xx (ProblemDetails) or 3xx + Note left of NRF-2: 4a. 200 OK (SearchResult) +4b. 4xx/5xx (ProblemDetails) or 3xx + NRF-2-->>NRF-1: 4a. 200 OK (SearchResult) +4b. 4xx/5xx (ProblemDetails) or 3xx + Note left of NRF-1: 2b. 404 Not Found + NRF-2-->>NRF-1: 2b. 404 Not Found + +``` + +Sequence diagram illustrating Service Discovery with intermediate forwarding NRF. The diagram shows three NRFs: NRF-1, NRF-2, and NRF-3. NRF-1 sends a GET request to NRF-2. NRF-2 then forwards the request to NRF-3. NRF-3 returns a response to NRF-2, which in turn returns a response to NRF-1. The responses can be 200 OK (SearchResult), 4xx/5xx (ProblemDetails), or 3xx (redirect). + +**Figure 5.3.2.2.5-1: Service Discovery with intermediate forwarding NRF** + +1. NRF-1 receives a service discovery request and sends the service discovery request to a pre-configured NRF-2. This may for example include cases where NRF-1 does not have sufficient information as determined by the operator policy to fulfill the request locally. +- 2a. Upon receiving a service discovery request, based on the information contained in the service discovery request (e.g. the "supi" query parameter in the URI) and locally stored information, NRF-2 shall identify the next hop NRF (see clause 5.2.2.2.3), and forward the service discovery request to that NRF (i.e. NRF-3 in this example) similarly to steps 1 and 2 in Figure 5.3.2.2.2-1 where the originator of the service invocation is NRF-2 and the recipient of the service invocation is NRF-3. The locally stored information in NRF-2 may: + - a) be preconfigured; or + - b) registered by other NRFs (see clause 5.2.2.2.3). + +- 2b. if NRF-2 does not have enough information to forward the service discovery request, then it responds with 404 Not Found, and the rest of the steps are omitted. +- 3a. Upon success, NRF-3 returns the search result. +- 3b. On failure or redirection: +- If the NF Service Consumer is not allowed to discover the NF services for the requested NF type provided in the query parameters, the NRF shall return "403 Forbidden" response. + - If the discovery request fails at the NRF due to errors in the input data in the URI query parameters, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. + - If the discovery request fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. +- 4a. NRF-2 forwards the success response to NRF-1. +- 4b. On failure or redirection: +- NRF-2 forwards the error response to NRF-1. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. +- NOTE: It is not assumed that there can only be two NRF hierarchies, i.e. the NRF-3 can go on to forward the service discovery request to another NRF. + +### 5.3.2.2.6 Service Discovery with resolution of the target PLMN + +This service discovery is done by querying the "nf-instances" resource in the NRF of the target PLMN, similar to the "Service Discovery in a different PLMN", as described in clause 5.3.2.2.3. + +The main difference compared with clause 5.3.2.2.3 is that the identity of the target PLMN is not explicitly provided by the NF Service Consumer. + +NOTE: This can happen, e.g., when the identity of the UE involved in the service discovery is not based on IMSI, but on GPSI (MSISDN) and, therefore, the MNC/MCC of the target PLMN cannot be derived from the UE identity. It should also be noted that, in these scenarios, the MSISDN may be subject to Mobile Number Portability. + +![Sequence diagram for Service Discovery with resolution of the target PLMN. The diagram shows three lifelines: NF Service Consumer, NRF in Local PLMN, and NRF in Target PLMN. The process starts with the NF Service Consumer sending a GET request to the NRF in Local PLMN with query parameters including 'gpsi' and 'target-nw-resolution=true'. The NRF in Local PLMN then performs a 'Determination of Target PLMN'. It then sends a GET request to the NRF in Target PLMN. The NRF in Target PLMN returns a response (200 OK with SearchResult, or 4xx/5xx with ProblemDetails, or 3xx). The NRF in Local PLMN then forwards this response to the NF Service Consumer.](4669a2ca9d019b9c2de9a9d9a0c4e644_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NRF in Local PLMN + participant NRF in Target PLMN + + Note right of NRF in Local PLMN: 2. Determination of Target PLMN + + NF Service Consumer->>NRF in Local PLMN: 1. GET .../nf-instances?&gpsi=&target-nw-resolution=true + NRF in Local PLMN->>NRF in Target PLMN: 3. GET .../nf-instances? + NRF in Target PLMN-->>NRF in Local PLMN: 4a. 200 OK (SearchResult) +4b. 4xx/5xx (ProblemDetails) or 3xx + NRF in Local PLMN-->>NF Service Consumer: 5a. 200 OK (SearchResult) +5b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Service Discovery with resolution of the target PLMN. The diagram shows three lifelines: NF Service Consumer, NRF in Local PLMN, and NRF in Target PLMN. The process starts with the NF Service Consumer sending a GET request to the NRF in Local PLMN with query parameters including 'gpsi' and 'target-nw-resolution=true'. The NRF in Local PLMN then performs a 'Determination of Target PLMN'. It then sends a GET request to the NRF in Target PLMN. The NRF in Target PLMN returns a response (200 OK with SearchResult, or 4xx/5xx with ProblemDetails, or 3xx). The NRF in Local PLMN then forwards this response to the NF Service Consumer. + +**Figure 5.3.2.2.6-1: Service Discovery with resolution of the target PLMN** + +1. The NF Service Consumer (e.g. an SMS-GMSC) sends a GET request to the NRF in the Local PLMN (i.e., the same PLMN where the NF Service Consumer is located); given that the identity of the target PLMN is not + +known to the NF Service Consumer, this request shall include as query parameters the identity of the target UE for which NF Service Producers need to be discovered (i.e., the "gpsi" query parameter) and also a parameter indicating that the resolution of the target PLMN must be performed (i.e., "target-nw-resolution" set to true). + +2. The NRF in the Local PLMN determines the identity of the Target PLMN, as described in 3GPP TS 23.540 [48], and determines the URI of the Nnrf\_NFDiscovery service of the NRF in the Target PLMN. +3. This step is similar to step 1 in Figure 5.3.2.2.3-1, for "Service Discovery in a different PLMN", with the only difference that the "Serving/Home" PLMNs in clause 5.3.2.2.3 are replaced by "Local/Target" PLMNs in the present clause. +4. Steps 4a, 4b are similar to steps 2a, 2b in Figure 5.3.2.2.3-1. +5. Steps 5a, 5b are similar to steps 2a, 2b in Figure 5.3.2.2.2-1. + +### 5.3.2.3 SCPDomainRoutingInfoGet + +This service operation retrieves the SCP domain routing information, by sending a HTTP GET request to the resource URI representing the "SCP Domain Routing Information" resource. + +![Sequence diagram for SCP Domain Routing Information Get](43979979715bb3304389a0cb18f34444_img.jpg) + +``` +sequenceDiagram + participant Service Consumer (e.g. SCP) + participant NRF + Note right of Service Consumer: 1. GET ../scp-domain-routing-info + Service Consumer->>NRF: 1. GET ../scp-domain-routing-info + Note right of NRF: 2a. 200 OK (ScpDomainRoutingInfo) +2b. 4xx/5xx (ProblemDetails) + NRF-->>Service Consumer: 2a. 200 OK (ScpDomainRoutingInfo) +2b. 4xx/5xx (ProblemDetails) +``` + +The diagram shows a sequence of interactions between a Service Consumer (e.g. SCP) and an NRF. The Service Consumer sends a GET request to the resource URI "scp-domain-routing-info". The NRF responds with either a 200 OK status containing the ScpDomainRoutingInfo, or a 4xx/5xx status containing ProblemDetails. + +Sequence diagram for SCP Domain Routing Information Get + +Figure 5.3.2.3-1: SCP Domain Routing Information Get + +1. The Service Consumer (i.e. SCP) shall send an HTTP GET request to the resource URI "scp-domain-routing-info" document resource. +- 2a. On success, "200 OK" shall be returned with SCP Domain Routing Information in response body. SCP Domain Routing Information with empty map indicates that no SCP domain is registered in the network. +- 2b. On failure, the NRF shall return "4xx/5xx" response and the response body may contain a ProblemDetails object describing the detailed information of the failure. + +When SCPs are registered to multiple NRFs in the network, any NRF providing SCP domain routing information for the whole network shall retrieve the local SCP domain routing information in other NRF(s) and perform aggregation. This service operation retrieves the local SCP domain routing information, e.g. by another NRF, by sending a HTTP GET request to the resource URI representing the "SCP Domain Routing Information" resource with "local" query parameter set to value "true". + +![Sequence diagram for Local SCP Domain Routing Information Get](4c9ba399ca7df11cbe9b6322cd9aee0a_img.jpg) + +``` +sequenceDiagram + participant Service Consumer (e.g. NRF) + participant NRF + Note right of Service Consumer: 1. GET ../scp-domain-routing-info?local=true + Service Consumer->>NRF: 1. GET ../scp-domain-routing-info?local=true + Note right of NRF: 2a. 200 OK (ScpDomainRoutingInfo) +2b. 4xx/5xx (ProblemDetails) + NRF-->>Service Consumer: 2a. 200 OK (ScpDomainRoutingInfo) +2b. 4xx/5xx (ProblemDetails) +``` + +The diagram shows a sequence of interactions between a Service Consumer (e.g. NRF) and an NRF. The Service Consumer sends a GET request to the resource URI "scp-domain-routing-info" with the query parameter "local=true". The NRF responds with either a 200 OK status containing the ScpDomainRoutingInfo, or a 4xx/5xx status containing ProblemDetails. + +Sequence diagram for Local SCP Domain Routing Information Get + +Figure 5.3.2.3-2: Local SCP Domain Routing Information Get + +1. The Service Consumer (i.e. SCP) shall send an HTTP GET request to the resource URI "scp-domain-routing-info" document resource with "local" query parameter set to value "true". + +- 2a. On success, "200 OK" shall be returned with local SCP Domain Routing Information in response body. SCP Domain Routing Information with empty map indicates that no SCP domain is registered in the producer NRF. +- 2b. On failure, the NRF shall return "4xx/5xx" response and the response body may contain a ProblemDetails object describing the detailed information of the failure. + +NOTE: In deployments where all SCPs in the network can be managed by the same NRF, i.e. all SCPs register to and discover each other with the same NRF, the NRF managing the SCPs can generate the SCP Domain Routing Information accordingly without involvement of other NRFs. + +### 5.3.2.4 SCPDomainRoutingInfoSubscribe + +This service operation is used to create a subscription to get notification when SCP Domain Routing Information is changed, e.g. due to a SCP has registered or updated or deregistered in the network, or to get notification when local SCP Domain Routing Information is changed, e.g. due to a SCP has registered or updated or deregistered in the producer NRF. The operation is invoked by issuing a POST request to the resource URI representing the "SCP Domain Routing Info Subscriptions" collection resource. + +![Sequence diagram showing the subscription process between a Service Consumer and an NRF.](3b00a61116faef21d3a6009fd350b46a_img.jpg) + +``` + +sequenceDiagram + participant SC as Service Consumer (e.g. SCP or NRF) + participant NRF + Note right of SC: 1. POST ../scp-domain-routing-info-subs (ScpDomainRoutingInfoSubscription) + SC->>NRF: Request + Note left of NRF: 2a. 201 Created (ScpDomainRoutingInfoSubscription) +2b. 4xx/5xx (ProblemDetails) + NRF-->>SC: Response + +``` + +The diagram illustrates the interaction for subscribing to SCP Domain Routing Information changes. A Service Consumer (e.g., SCP or NRF) sends a POST request to the NRF. The request is labeled '1. POST ../scp-domain-routing-info-subs (ScpDomainRoutingInfoSubscription)'. The NRF responds with either a '201 Created' status containing subscription details (2a) or a '4xx/5xx' error status with problem details (2b). + +Sequence diagram showing the subscription process between a Service Consumer and an NRF. + +**Figure 5.3.2.4-1: Subscription to SCP Domain Routing Information change** + +1. The Service Consumer (i.e. SCP) shall send a POST request to the URI representing the "SCP Domain Routing Info Subscriptions" collection resource. The request body shall contain the callback URI on the Service Consumer to receive the notifications. + +To create a subscription for changes of local SCP Domain Routing Information, the request body shall contain the "localInd" with value "true". + +- 2a. On success, "201 Created" shall be returned with "Location" header containing the resource URI to the newly created subscription resource. The response shall contain the data related to the created subscription, including the validity time, as determined by the NRF, after which the subscription becomes invalid. Once the subscription expires, if the Service Consumer wants to keep receiving notifications, it shall create a new subscription in the NRF. +- 2b. On failure, the NRF shall return "4xx/5xx" response and the response body may contain a ProblemDetails object describing the detailed information of the failure. + +### 5.3.2.5 SCPDomainRoutingInfoNotify + +This service operation notifies each subscriber for (local) SCP Domain Routing Information change. The notification is sent to a callback URI that Service Consumer provided during the subscription (see SCPDomainRoutingInfoSubscribe operation in clause 5.3.2.4). The operation is invoked by sending a POST request to the callback URI. + +![Sequence diagram for Figure 5.3.2.5-1: Notification of SCP Domain Routing Info Change. A Service Consumer (e.g. SCP or NRF) sends a POST {callbackUri} (ScpDomainRoutingInfoNotification) to the NRF. The NRF responds with 2a. 204 No Content () or 2b. 4xx/5xx (ProblemDetails).](32ff77da4286b58c4778033acaa10836_img.jpg) + +``` + +sequenceDiagram + participant Service Consumer (e.g. SCP or NRF) + participant NRF + Note right of Service Consumer: 1. POST {callbackUri} (ScpDomainRoutingInfoNotification) + Service Consumer->>NRF: 1. POST {callbackUri} (ScpDomainRoutingInfoNotification) + Note left of NRF: 2a. 204 No Content () +2b. 4xx/5xx (ProblemDetails) + NRF-->>Service Consumer: 2a. 204 No Content () +2b. 4xx/5xx (ProblemDetails) + +``` + +Sequence diagram for Figure 5.3.2.5-1: Notification of SCP Domain Routing Info Change. A Service Consumer (e.g. SCP or NRF) sends a POST {callbackUri} (ScpDomainRoutingInfoNotification) to the NRF. The NRF responds with 2a. 204 No Content () or 2b. 4xx/5xx (ProblemDetails). + +**Figure 5.3.2.5-1: Notification of SCP Domain Routing Info Change** + +1. The NRF shall send a POST request to the callback URI. The request body shall contain the updated SCP Domain Routing Information. The request body shall contain the "localInd" IE with value "true" if the notification is for a change of local SCP Domain Routing Information. SCP Domain Routing Information with empty map indicates that no SCP domain is registered in the network (or in the producer NRF for local SCP Domain Routing Information) after the change. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure, the NRF shall return "4xx/5xx" response and the response body may contain a ProblemDetails object describing the detailed information of the failure. + +### 5.3.2.6 SCPDomainRoutingInfoUnSubscribe + +This service operation removes an existing subscription to SCP (local) Domain Information Change. The operation is invoked by issuing a DELETE request on the resource URI representing the "Individual SCP Domain Routing Info Subscription", which was received in the Location header field of the "201 Created" response received during a successful subscription (see clause 5.3.2.4). + +![Sequence diagram for Figure 5.3.2.6-1: Unsubscribe to SCP Domain Routing Information Change. An NF Service Consumer (e.g. SCP or NRF) sends a DELETE ../subscriptions/{subscriptionID} () to the NRF. The NRF responds with 2a. 204 No Content () or 2b. 4xx/5xx (ProblemDetails).](09e20a17ecd8042b3d9b7fd462f2d9b4_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer (e.g. SCP or NRF) + participant NRF + Note right of NF Service Consumer: 1. DELETE ../subscriptions/{subscriptionID} () + NF Service Consumer->>NRF: 1. DELETE ../subscriptions/{subscriptionID} () + Note left of NRF: 2a. 204 No Content () +2b. 4xx/5xx (ProblemDetails) + NRF-->>NF Service Consumer: 2a. 204 No Content () +2b. 4xx/5xx (ProblemDetails) + +``` + +Sequence diagram for Figure 5.3.2.6-1: Unsubscribe to SCP Domain Routing Information Change. An NF Service Consumer (e.g. SCP or NRF) sends a DELETE ../subscriptions/{subscriptionID} () to the NRF. The NRF responds with 2a. 204 No Content () or 2b. 4xx/5xx (ProblemDetails). + +**Figure 5.3.2.6-1: Unsubscribe to SCP Domain Routing Information Change** + +1. The Service Consumer (e.g. SCP or NRF) shall send a DELETE request to the resource URI representing the individual subscription. The request body shall be empty. +- 2a. On success, "204 No Content" shall be returned. The response body shall be empty. +- 2b. On failure, the NRF shall return "4xx/5xx" response and the response body may contain a ProblemDetails object describing the detailed information of the failure. + +## 5.4 Nnrf\_AccessToken Service + +### 5.4.1 Service Description + +The NRF offers an Nnrf\_AccessToken service (used for OAuth2 authorization, see IETF RFC 6749 [16]), following the "Client Credentials" authorization grant, as specified in 3GPP TS 33.501 [15]. It exposes a "Token Endpoint" where the Access Token Request service can be requested by NF Service Consumers. + +## 5.4.2 Service Operations + +### 5.4.2.1 Introduction + +The services operations defined for the Nnrf\_AccessToken service are as follows: + +- Access Token Request (i.e. Nnrf\_AccessToken\_Get) + +### 5.4.2.2 Get (Access Token Request) + +#### 5.4.2.2.1 General + +This service operation is used by an NF Service Consumer to request an OAuth 2.0 access token from the authorization server (NRF). + +![Sequence diagram showing the Access Token Request process between an NF Service Consumer and an NRF. The consumer sends a POST /oauth2/token request to the NRF. The NRF responds with either a 200 OK (AccessTokenRsp) or an error response (400 Bad Request, 403 Forbidden, or 3xx).](080a7af02bc47cf21ebfae4e0be39745_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NRF + Note right of NRF: 1. POST /oauth2/token (AccessTokenReq) + NRF-->>NF Service Consumer: 2a. 200 OK (AccessTokenRsp) + Note right of NRF: 2b. 400 Bad Request (AccessTokenErr) or 403 Forbidden (ProblemDetails) or 3xx + NRF-->>NF Service Consumer: + +``` + +Sequence diagram showing the Access Token Request process between an NF Service Consumer and an NRF. The consumer sends a POST /oauth2/token request to the NRF. The NRF responds with either a 200 OK (AccessTokenRsp) or an error response (400 Bad Request, 403 Forbidden, or 3xx). + +**Figure 5.4.2.2.1-1: Access Token Request** + +1. The NF Service Consumer shall send a POST request to the "Token Endpoint", as described in IETF RFC 6749 [16], clause 3.2. The "Token Endpoint" URI shall be: + +{nrfApiRoot}/oauth2/token + +where {nrfApiRoot} represents the concatenation of the "scheme" and "authority" components of the NRF, as defined in IETF RFC 3986 [17]. + +The OAuth 2.0 Access Token Request includes in the body of the HTTP POST request shall contain: + +- An OAuth 2.0 grant type set to "client\_credentials"; +- The "scope" parameter indicating the names of the NF Services that the NF Service Consumer is trying to access (i.e., the expected NF service names); +- The NF Instance Id of the the NF Service Consumer requesting the OAuth 2.0 access token; +- NF type of the NF Service Consumer, if this is an access token request not for a specific NF Service Producer; +- NF type of the expected NF Service Producer, if this is an access token request not for a specific NF Service Producer; +- The NF Instance Id of the expected NF Service Producer, if this is an access token request for a specific NF Service Producer; +- Home and Serving PLMN IDs, if this is an access token request for use in roaming scenarios (see clause 13.4.1.2 of 3GPP TS 33.501 [15]). + +The request may additionally contain: + +- the NF Set ID of the expected NF service producer instances, if this is an access token request not for a specific NF Service Producer. + +- the NF Instance Id of the source NF (the NF that requests data), if this is an access token request from the DCCF as NF Service Consumer request data from NF Service Producers on behalf of the source NF. + +The NF Service Consumer shall use TLS for mutual authentication with the NRF in order to access this endpoint, if the PLMN uses protection at the transport layer. Otherwise, the NF Service Consumer shall use NDS or physical security to mutually authenticate with the NRF as specified in clause 13.3.1 of 3GPP TS 33.501 [15]. + +The NRF may verify that the input attributes (e.g. NF type) in the access token request match with the corresponding ones in the public key certificate of the NF service consumer. If the verification is successful, other authorization check shall be performed, otherwise, the request shall be rejected immediately with "400 Bad Request" status code, and "error" attribute set to "invalid\_client". + +2a. On success, "200 OK" shall be returned, the content of the POST response shall contain the requested access token and the token type set to value "Bearer". The response in addition: + +- should contain the expiration time for the token as indicated in IETF RFC 6749 [16] unless the expiration time of the token is made available by other means (e.g. deployment-specific documentation); and +- shall contain the NF service name(s) of the requested NF service producer(s), if it is different from the scope included in the access token request (see IETF RFC 6749 [16]). + +The access token shall be a JSON Web Token (JWT) as specified in IETF RFC 7519 [25]. The access token returned by the NRF shall include the claims encoded as a JSON object as specified in clause 6.3.5.2.4 and then digitally signed using JWS as specified in IETF RFC 7515 [24] and in clause 13.4.1 of 3GPP TS 33.501 [15]. + +The digitally signed access token shall be converted to the JWS Compact Serialization encoding as a string as specified in clause 7.1 of IETF RFC 7515 [24]. + +2b. On failure or redirection: + +- If the access token request fails at the NRF, the NRF shall return "400 Bad Request" status code, including in the response content a JSON object that provides details about the specific error that occurred. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. +- If based on operator policy the required information used to authorize the access token request, e.g. requesterSnsSaiList, is not included, the NRF may return "403 Forbidden" status code with the ProblemDetails IE indicating that the missing information shall be provided. + +#### 5.4.2.2.2 Access Token request with intermediate forwarding NRF + +When multiple NRFs are deployed in one PLMN, one NRF may request an OAuth2 access token to a different NRF so as to fulfil the Access Token Request from a NF service consumer. The access token request between these two NRFs is forwarded by a third NRF in this case. + +For this, step 1 in clause 5.4.2.2.1 is executed (send a POST request to NRF-1 in the Serving PLMN); this request shall include the OAuth 2.0 Access Token Request in the request body. + +Then, steps 1-4 in Figure 5.4.2.2.2-1 hereinafter are executed between NRF-1 in Serving PLMN, NRF-2 in Serving PLMN and NRF-3 in Serving PLMN. + +Finally, step 2 in clause 5.4.2.2.1 is executed, the Access Token Response containing the requested access token, the token type and additional attributes shall be sent to the NF Service Consumer. + +![Sequence diagram illustrating the Access Token Request with intermediate forwarding NRF. The diagram shows three NRFs: NRF-1, NRF-2, and NRF-3, all in the serving PLMN. The sequence of messages is: 1. NRF-1 sends a POST /oauth2/token (AccessTokenReq) to NRF-2. 2a. NRF-2 forwards the request to NRF-3. 2b. NRF-2 returns a 404 Not Found response to NRF-1. 3a. NRF-3 returns a 200 OK (AccessTokenRsp) to NRF-2. 3b. NRF-3 returns a 400 Bad Request (AccessTokenErr) or 3xx response to NRF-2. 4a. NRF-2 forwards the 200 OK response to NRF-1. 4b. NRF-2 forwards a 400 Bad Request (AccessTokenErr) or 3xx response to NRF-1.](be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg) + +``` + +sequenceDiagram + participant NRF1 as NRF-1 +in serving PLMN + participant NRF2 as NRF-2 +in serving PLMN + participant NRF3 as NRF-3 +in serving PLMN + + NRF1->>NRF2: 1. POST /oauth2/token (AccessTokenReq) + NRF2->>NRF3: 2a. POST /oauth2/token (AccessTokenReq) + NRF2-->>NRF1: 2b. 404 Not Found + NRF3-->>NRF2: 3a. 200 OK (AccessTokenRsp) + NRF3-->>NRF2: 3b. 400 Bad Request (AccessTokenErr) or 3xx + NRF2-->>NRF1: 4a. 200 OK (AccessTokenRsp) + NRF2-->>NRF1: 4b. 400 Bad Request (AccessTokenErr) or 3xx + +``` + +Sequence diagram illustrating the Access Token Request with intermediate forwarding NRF. The diagram shows three NRFs: NRF-1, NRF-2, and NRF-3, all in the serving PLMN. The sequence of messages is: 1. NRF-1 sends a POST /oauth2/token (AccessTokenReq) to NRF-2. 2a. NRF-2 forwards the request to NRF-3. 2b. NRF-2 returns a 404 Not Found response to NRF-1. 3a. NRF-3 returns a 200 OK (AccessTokenRsp) to NRF-2. 3b. NRF-3 returns a 400 Bad Request (AccessTokenErr) or 3xx response to NRF-2. 4a. NRF-2 forwards the 200 OK response to NRF-1. 4b. NRF-2 forwards a 400 Bad Request (AccessTokenErr) or 3xx response to NRF-1. + +**Figure 5.4.2.2.2-1: Access Token Request with intermediate forwarding NRF** + +1. NRF-1 receives an Access token request but does not have the information to fulfil the request. Then NRF-1 sends the Access token request to a pre-configured NRF-2. + - 2a. Upon reception of the Access token request and based on the information contained in the Acces token request and locally stored information, NRF-2 shall identify the next hop NRF (see clause 5.2.2.2.3), and forward the Access token request to that NRF (i.e. NRF-3 in this example) by replacing the originator of the service invocation with NRF-2, and the recipient of the service invocation with NRF-3. The locally stored information in NRF-2 may: + - a) be preconfigured; or + - b) registered by other NRFs (see clause 5.2.2.2.3). + - 2b. if NRF-2 does not have enough information to forward the Access token request, then it responds with 404 Not Found, and the rest of the steps are omitted. + - 3a. Upon success, NRF-3 shall return a "200 OK" status code, including in the response content the Access token response containing the requested access token, the token type and additional attributes. + - 3b. Upon failure, NRF-3 shall return "400 Bad Request" status code, including in the response content a JSON object that provides details about the specific error(s) that occurred. + - 4a. NRF-2 forwards the success response to NRF-1. + - 4b. On failure or redirection: + - NRF-2 forwards the error response to NRF-1. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. +- NOTE: It is not assumed that there can only be two NRF hierarchies, i.e. the NRF-3 can go on and forward the Access token request to another NRF. + +### 5.4.2.2.3 Access Token request with intermediate redirecting NRF + +When multiple NRFs are deployed in one PLMN, one NRF may request an OAuth2 access token to a different NRF so as to fulfil the Access Token Request from a NF service consumer. The acces token request between these two NRFs is redirected by a third NRF in this case. + +For this, step 1 in clause 5.4.2.2.1 is executed (send a POST request to NRF-1 in the Serving PLMN); this request shall include the OAuth 2.0 Access Token Request in the request body + +Then, steps 1-4 in Figure 5.4.2.2.3-1 hereinafter are executed between NRF-1in Serving PLMN, NRF-2 in Serving PLMN and NRF-3 in Serving PLMN. + +Finally, step 2 in clause 5.4.2.2.1 is executed, the Access token response containing the requested access token, the token type and additional attributes shall be sent to the NF Service Consumer. + +![Sequence diagram illustrating the Access Token Request with intermediate redirecting NRF. The diagram shows three NRFs: NRF-1, NRF-2, and NRF-3, all in the serving PLMN. The sequence of messages is: 1. NRF-1 sends a POST /oauth2/token (AccessTokenReq) to NRF-2. 2a. NRF-2 responds with a 307 Temporary Redirect. 2b. Alternatively, NRF-2 could respond with a 404 Not Found. 3. Upon receiving the 307 redirect, NRF-1 sends the POST /oauth2/token (AccessTokenReq) to NRF-3. 4a. NRF-3 responds with a 200 OK (AccessTokenRsp). 4b. Alternatively, NRF-3 could respond with a 400 Bad Request (AccessTokenErr) or a 3xx status code.](a003ffe7299e0a48bceb7f1e45a4f1a3_img.jpg) + +``` + +sequenceDiagram + participant NRF-1 as NRF-1 in serving PLMN + participant NRF-2 as NRF-2 in serving PLMN + participant NRF-3 as NRF-3 in serving PLMN + Note left of NRF-1: Request + NRF-1->>NRF-2: 1. POST /oauth2/token (AccessTokenReq) + NRF-2-->>NRF-1: 2a. 307 Temporary Redirect + Note right of NRF-2: 2b. 404 Not Found + Note left of NRF-1: Redirect + NRF-1->>NRF-3: 3. POST /oauth2/token (AccessTokenReq) + NRF-3-->>NRF-1: 4a. 200 OK (AccessTokenRsp) + Note right of NRF-3: 4b. 400 Bad Request (AccessTokenErr) or 3xx + +``` + +Sequence diagram illustrating the Access Token Request with intermediate redirecting NRF. The diagram shows three NRFs: NRF-1, NRF-2, and NRF-3, all in the serving PLMN. The sequence of messages is: 1. NRF-1 sends a POST /oauth2/token (AccessTokenReq) to NRF-2. 2a. NRF-2 responds with a 307 Temporary Redirect. 2b. Alternatively, NRF-2 could respond with a 404 Not Found. 3. Upon receiving the 307 redirect, NRF-1 sends the POST /oauth2/token (AccessTokenReq) to NRF-3. 4a. NRF-3 responds with a 200 OK (AccessTokenRsp). 4b. Alternatively, NRF-3 could respond with a 400 Bad Request (AccessTokenErr) or a 3xx status code. + +**Figure 5.4.2.2.3-1: Access Token Request with intermediate redirecting NRF** + +1. NRF-1 receives an Access token request but does not have the information to fulfil the request. Then NRF-1 sends the Access token request to a pre-configured NRF-2. +- 2a. Upon reception of the Access token request and based on the information contained in the Access token request and locally stored information, NRF-2 shall identify the next hop NRF (see clause 5.2.2.2.3), and redirect the Access token request by returning HTTP "307 Temporary Redirect" response. The locally stored information in NRF-2 may: + - a) be preconfigured; or + - b) registered by other NRFs (see clause 5.2.2.2.3). + The "307 Temporary Redirect" response shall contain a Location header field, the host part of the URI in the Location header field represents NRF-3. +- 2b. if NRF-2 does not have enough information to forward the Access token request, then it responds with "404 Not Found", and the rest of the steps are omitted. +3. Upon reception of "307 Temporary Redirect" response, NRF-1 sends the Access token request to NRF-3 by using the URI contained in the Location header field of the "307 Temporary Redirect" response. +- 4a. Upon success, NRF-3 shall return a "200 OK" status code including in the response content the Access token response containing the requested access token, the token type and additional attributes. +- 4b. On failure or redirection: + - Upon failure, the NRF-3 shall return "400 Bad Request" status code, including in the response content a JSON object that provides details about the specific error(s) that occurred. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +## 5.5 Nnrf\_Bootstrapping Service + +### 5.5.1 Service Description + +The NRF offers a Nnrf\_Bootstrapping service to let NF Service Consumers of the NRF know about the services endpoints it supports, the NRF Instance ID and NRF Set ID if the NRF is part of an NRF set, by using a version-independent URI endpoint that does not need to be discovered by using a Discovery service. + +This service shall be used in inter-PLMN scenarios where the NRF in a PLMN-A needs to invoke services from an NRF in PLMN-B, when there is no pre-configured information indicating the version of the services deployed in PLMN-B. + +This service may also be used in intra-PLMN scenarios, to avoid configuring statically in the different NFs information about the service versions deployed in the NRF to be used by those NFs. + +## 5.5.2 Service Operations + +### 5.5.2.1 Introduction + +The services operations defined for the Nnrf\_Bootstrapping service are as follows: + +- Nnrf\_Bootstrapping\_Get + +### 5.5.2.2 Get + +#### 5.5.2.2.1 General + +This service operation is used by an NF Service Consumer to request bootstrapping information from the NRF. + +![Sequence diagram showing the bootstrapping request process between an NF Service Consumer and an NRF. The consumer sends a GET /bootstrapping() request to the NRF. The NRF responds with either a 200 OK (BootstrappingInfo) or a 400 Bad Request (ProblemDetails) or a 3xx status.](1174e0fd3f2c73de8e5c6ce8ea6bdda1_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NRF + Note right of NRF: 1. GET /bootstrapping () + NRF->>NF Service Consumer: 2a. 200 OK (BootstrappingInfo) +2b. 400 Bad Request (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the bootstrapping request process between an NF Service Consumer and an NRF. The consumer sends a GET /bootstrapping() request to the NRF. The NRF responds with either a 200 OK (BootstrappingInfo) or a 400 Bad Request (ProblemDetails) or a 3xx status. + +**Figure 5.5.2.2.1-1: Bootstrapping Request** + +1. The NF Service Consumer shall send a GET request to the "Bootstrapping Endpoint". + +The "Bootstrapping Endpoint" URI shall be constructed as: + +{nrfApiRoot}/bootstrapping + +where {nrfApiRoot} represents the concatenation of the "scheme" and "authority" components of the NRF, as defined in IETF RFC 3986 [17]; see also the definition of NRF FQDN and NRF URI in 3GPP TS 23.003 [12], clause 28.3.2.3. + +- 2a. On success, "200 OK" shall be returned, the content of the GET response shall contain the requested bootstrapping information. + +#### EXAMPLE: + +``` +GET https://nrf.example.com/bootstrapping +Accept: application/3gppHal+json +``` + +``` +HTTP/2 200 OK +``` + +``` +Content-Type: application/3gppHal+json +``` + +``` +{ + "status": "OPERATIVE", + "_links": { + "self": { + "href": "https://nrf.example.com/bootstrapping" + }, + "manage": { + "href": "https://nrf.example.com/nnrf-nfm/v1/nf-instances" + }, + "subscribe": { + "href": "https://nrf.example.com/nnrf-nfm/v1/subscriptions" + }, + "discover": { + "href": "https://nrf.example.com/nnrf-disc/v1/nf-instances" + }, + "authorize": { + "href": "https://nrf.example.com/oauth2/token" + } + }, +} +``` + +``` + "nrfFeatures": { + "nnrf-nfm": "1", + "nnrf-disc": "D", + "nnrf-oauth2": "0" + }, + "oauth2Required": { + "nnrf-nfm": true, + "nnrf-disc": false + }, + "nrfSetId": "set12.nrfset.5gc.mnc012.mcc345", + "nrfInstanceId": "4947a69a-f61b-4bc1-b9da-47c9c5d14b67" + } +} +``` + +2b. On failure or redirection: + +- Upon failure, the NRF shall return "400 Bad Request" status code, including in the response content a JSON object that provides details about the specific error(s) that occurred. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +--- + +## 6 API Definitions + +### 6.1 Nnrf\_NFManagement Service API + +#### 6.1.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion} + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nnrf-nfm" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +#### 6.1.2 Usage of HTTP + +##### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nnrf\_NFManagement service shall comply with the OpenAPI [10] specification contained in Annex A. + +##### 6.1.2.2 HTTP standard headers + +###### 6.1.2.2.1 General + +The mandatory standard HTTP headers as specified in clause 5.2.2.2 of 3GPP TS 29.500 [4] shall be supported. + +###### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [22], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. + +- The Problem Details JSON Object (IETF RFC 9457 [11]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". +- JSON Patch (IETF RFC 6902 [13]). The use of the JSON Patch format in a HTTP request body shall be signalled by the content type "application/json-patch+json". +- The 3GPP hypermedia format as defined in 3GPP TS 29.501 [5]. The use of the 3GPP hypermedia format in a HTTP response body shall be signalled by the content type "application/3gppHal+json". + +#### 6.1.2.2.3 Accept-Encoding + +The NRF should support gzip coding (see IETF RFC 1952 [30]) in HTTP requests and responses and indicate so in the Accept-Encoding header, as described in clause 6.9 of 3GPP TS 29.500 [4]. + +NF Service Consumers of the NFManagement API should support gzip coding in HTTP requests and responses and they should support gzip coding in the reception of notification requests sent by the NRF. + +#### 6.1.2.2.4 ETag + +An "ETag" (entity-tag) header should be included in HTTP responses for resource creation and resource update, as described in IETF RFC 9110 [40], clause 8.8.3. It shall contain a server-generated strong validator, that allows further matching of this value (included in subsequent client requests) with a given resource representation stored in the server or in a cache. + +An "Etag" (entity-tag) header shall not be included in HTTP responses for Heart-Beat operation. + +#### 6.1.2.2.5 If-Match + +An NF Service Consumer should issue conditional PATCH request towards NRF, by including an If-Match header in HTTP requests, as described in IETF RFC 9110 [40], clause 13.1.1, containing an entity tags received in latest response for the same resource. + +An NF Service Consumer shall not include If-Match header in HTTP requests for Heart-Beat operation. + +#### 6.1.2.3 HTTP custom headers + +##### 6.1.2.3.1 General + +In this release of this specification, no custom headers specific to the Nnrf\_NFManagement service are defined. For 3GPP specific HTTP custom headers used across all service-based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +The structure of the Resource URIs of the NFManagement service is shown in figure 6.1.3.1-1. + +![Resource URI structure of the NFManagement API diagram](40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnrf-nfm/v1"] --> NFInstances["/nf-instances"] + Root --> Subscriptions["/subscriptions"] + NFInstances --> NFInstanceID["/{nflInstanceID}"] + Subscriptions --> SubscriptionID["/{subscriptionID}"] + +``` + +The diagram illustrates the hierarchical structure of the NFManagement API. The root path is {apiRoot}/nnrf-nfm/v1. It branches into two main resource paths: /nf-instances and /subscriptions. The /nf-instances path further branches into a specific instance identified by {nflInstanceID}. The /subscriptions path further branches into a specific subscription identified by {subscriptionID}. + +Resource URI structure of the NFManagement API diagram + +**Figure 6.1.3.1-1: Resource URI structure of the NFManagement API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------|---------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------| +| nf-instances (Store) | /nf-instances | GET | Read a collection of NF Instances. | +| | | OPTIONS | Discover the communication options supported by the NRF for this resource. | +| nf-instance (Document) | /nf-instances/{nflInstanceID} | GET | Read the profile of a given NF Instance. | +| | | PUT | Register in NRF a new NF Instance, or replace the profile of an existing NF Instance, by providing an NF profile. | +| | | PATCH | Modify the NF profile of an existing NF Instance. | +| | | DELETE | Deregister from NRF a given NF Instance. | +| subscriptions (Collection) | /subscriptions | POST | Creates a new subscription in NRF to newly registered NF Instances. | +| subscription (Document) | /subscriptions/{subscriptionID} | PATCH | Updates an existing subscription in NRF. | + +| | | | | +|-----------------------|---------------------------|--------|--------------------------------------------------------------------------------------------------| +| | | DELETE | Deletes an existing subscription from NRF. | +| Notification Callback | {nfStatusNotificationUri} | POST | Notify about newly created NF Instances, or about changes of the profile of a given NF Instance. | + +### 6.1.3.2 Resource: nf-instances (Store) + +#### 6.1.3.2.1 Description + +This resource represents a collection of the different NF instances registered in the NRF. + +This resource is modelled as the Store resource archetype (see clause C.3 of 3GPP TS 29.501 [5]). + +#### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-nfm/v1/nf-instances + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +#### 6.1.3.2.3 Resource Standard Methods + +##### 6.1.3.2.3.1 GET + +This method retrieves a list of all NF instances currently registered in the NRF. This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nf-type | NFType | O | 0..1 | The type of NF to restrict the list of returned NF Instances. | +| limit | integer | C | 0..1 | Maximum number of items to be returned in this query; this parameter should only be provided if the "nf-type" parameter is provided.
If the "page-number" and "page-size" parameters are present, the "limit" parameter shall be absent. | +| page-number | integer | C | 0..1 | This parameter shall be present if the NF Service Consumer requests the retrieval of NF Instance URIs based on pages (i.e. a subset of the total number of items).

If present, it shall contain the page number to retrieve.

The total number of pages available, N, can be determined based on the "totalItemCount" attribute of the response (see clause 6.1.6.2.25) as:

$N = \text{ceiling}(\text{totalItemCount} / \text{page-size})$

The first page shall be identified by "page-number" set to 1.

Minimum: 1

(See NOTE 1, NOTE 2) | +| page-size | integer | C | 0..1 | This parameter shall be present if the NF Service Consumer requests the retrieval of NF Instance URIs based on pages .

If present, it shall contain the maximum number of items to be returned per page.

Minimum: 1

(See NOTE 1, NOTE 2) | + +NOTE 1: The parameters "page-number" and "page-size" shall be either both present, or both absent. +NOTE 2: If the NRF supports the pagination query parameters, it shall ensure that the response to these requests always return the same set of items for the same query parameters, as long as the ETag of the collection resource is not changed. + +EXAMPLE: The NF Service Consumer can retrieve the whole set of NF Instances URIs available in the NRF, using paginated requests, by issuing multiple GET requests, as: + +GET .../nnrf-nfm/v1/nf-instances?page-number=1&page-size=100 + +(returns items from 0 to 99) + +GET .../nnrf-nfm/v1/nf-instances?page-number=2&page-size=100 + +(returns items from 100 to 199) + +... + +GET .../nnrf-nfm/v1/nf-instances?page-number=N&page-size=100 + +(returns items from (N-1)\*100 up to totalItemCount-1) + +where the first N-1 requests return 100 items each, and the last request (page-number=N) returns between 1 and 100 items. + +The NF Service Consumer can also retrieve arbitrary page numbers and page sizes, independently from any prior request previously issued; e.g. + +GET .../nnrf-nfm/v1/nf-instances?page-number=4&page-size=50 + +(returns items from 150 to 199; assuming totalItemCount >= 200) + +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. + +**Table 6.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UriList | M | 1 | 200 OK |

The response body contains a "_links" object containing the URI of each registered NF in the NRF.

If there are no NFs to return in the query result (e.g., because there are no registered NFs in the NRF, or because there are no matching NFs of the type specified in the "nf-type" query parameter, currently registered in the NRF), the "_links" attribute may be absent or, if present, it shall contain only the "self" attribute (i.e. the "item" attribute shall be absent).

| +| RedirectResponse | O | 0..1 | 307 Temporary Redirect |

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

| +| RedirectResponse | O | 0..1 | 308 Permanent Redirect |

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

| + +NOTE: The mandatory HTTP error status codes for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.3.2.3.1-6: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ETag | string | C | 0..1 | Entity Tag containing a strong validator, described in IETF RFC 9110 [40], clause 8.8.3.
In this resource, this header shall contain a different value if the list of NF instances (regardless of the contents of each NF instance profile) stored in the NRF has changed; i.e. it shall change if there are new instances added to the NRF, or if existing instances are removed from the NRF.
If the NF Service Consumer, during the course of successive paginated requests, receives a different ETag value, it shall conclude that the list of NF Instances in the NRF has changed, so it may re-start the paginated NFListRetrieval service operation. | + +#### 6.1.3.2.3.2 OPTIONS + +This method queries the communication options supported by the NRF (see clause 6.9 of 3GPP TS 29.500 [4]). This method shall support the URI query parameters specified in table 6.1.3.2.3.2-1. + +**Table 6.1.3.2.3.2-1: URI query parameters supported by the OPTIONS method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.2-2 and the response data structures and response codes specified in table 6.1.3.2.3.2-3. + +**Table 6.1.3.2.3.2-2: Data structures supported by the OPTIONS Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.2.3.2-3: Data structures supported by the OPTIONS Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| OptionsResponse | M | 1 | 200 OK | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| ProblemDetails | O | 0..1 | 405 Method Not Allowed | | +| ProblemDetails | O | 0..1 | 501 Not Implemented | | + +NOTE: The mandatory HTTP error status codes for the OPTIONS method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.2.3.2-4: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------|-----------|---|-------------|--------------------------------------------------| +| Accept-Encoding | string | O | 0..1 | Accept-Encoding, described in IETF RFC 9110 [40] | + +**Table 6.1.3.2.3.2-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.3.2.3.2-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +#### 6.1.3.2.4 Resource Custom Operations + +There are no resource custom operations for the Nnrf\_NFManagement service in this release of the specification. + +#### 6.1.3.3 Resource: nf-instance (Document) + +##### 6.1.3.3.1 Description + +This resource represents a single NF instance. + +### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-nfm/v1/nf-instances/{nfInstanceID} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|--------------|-----------------------------------| +| apiRoot | string | See clause 6.1.1 | +| nfInstanceID | NfInstanceId | Represents a specific NF Instance | + +### 6.1.3.3.3 Resource Standard Methods + +#### 6.1.3.3.3.1 GET + +This method retrieves the NF Profile of a given NF instance. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| requester-features | SupportedFeatures | C | 0..1 | Nnrf_NFManagement features supported by the NF Service Consumer that is invoking the Nnrf_NFManagement service. See clause 6.1.9.

This IE shall be included if at least one feature is supported by the NF Service Consumer. | + +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. + +**Table 6.1.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NFProfile | M | 1 | 200 OK | The response body contains the profile of a given NF Instance. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.3.3.3.1-6: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| ETag | string | C | 0..1 | Entity Tag containing a strong validator, described in IETF RFC 9110 [40], clause 8.8.3 | + +#### 6.1.3.3.3.2 PUT + +This method registers a new NF instance in the NRF, or replaces completely an existing NF instance. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +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. + +**Table 6.1.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|------------------------------------------------------------------------------| +| NFProfile | M | 1 | Profile of the NF Instance to be registered, or completely replaced, in NRF. | + +**Table 6.1.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NFProfile | M | 1 | 200 OK | This case represents the successful replacement of an existing NF Instance profile.

Upon success, a response body is returned containing the replaced profile of the NF Instance. | +| NFProfile | M | 1 | 201 Created | This case represents the successful registration of a new NF Instance.

Upon success, a response body is returned containing the newly created NF Instance profile; also, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created NF Instance. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.3.3.2-4: Headers supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|---------------------------------------------------| +| Content-Encoding | string | O | 0..1 | Content-Encoding, described in IETF RFC 9110 [40] | + +**Table 6.1.3.3.3.2-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Accept-Encoding | string | O | 0..1 | Accept-Encoding, described in IETF RFC 9110 [40] | +| ETag | string | C | 0..1 | Entity Tag containing a strong validator, described in IETF RFC 9110 [40], clause 8.8.3 | + +**Table 6.1.3.3.3.2-6: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nnrf-nfm/v1/nf-instances/{nfInstanceId} | +| Accept-Encoding | string | O | 0..1 | Accept-Encoding, described in IETF RFC 9110 [40] | +| ETag | string | C | 0..1 | Entity Tag containing a strong validator, described in IETF RFC 9110 [40], clause 8.8.3 | + +**Table 6.1.3.3.3.2-7: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.3.3.3.2-8: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +#### 6.1.3.3.3.3 PATCH + +This method updates partially the profile of a given NF instance. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.3-1. + +**Table 6.1.3.3.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.3-2 and the response data structures and response codes specified in table 6.1.3.3.3.3-3. + +**Table 6.1.3.3.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It contains the list of changes to be made to the profile of the NF Instance, according to the JSON PATCH format specified in IETF RFC 6902 [13]. | + +**Table 6.1.3.3.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NFProfile | M | 1 | 200 OK | Upon success, a response body is returned containing the updated profile of the NF Instance. | +| n/a | | | 204 No Content | Successful response sent when there is no need to provide a full updated profile of the NF Instance (e.g., in the partial update procedure when all update operations are accepted by the NRF, as described in clause 5.2.2.3.1, or in the Heart-Beat operation response described in clause 5.2.2.3.2). | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| ProblemDetails | O | 0..1 | 412 Precondition Failed | The modification has failed due to the precondition in the request is not fulfilled. | +| ProblemDetails | O | 0..1 | 409 Conflict | The modification has failed due to confliction (e.g. to change a value of a non-existing IE). | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.3.3.3.3-6: Headers supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------| +| If-Match | string | C | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [40], clause 13.1.1. | + +**Table 6.1.3.3.3.3-7: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|------------------------------------------------------------------------------------------| +| ETag | string | C | 0..1 | Entity Tag containing a strong validator, described in IETF RFC 9110 [40], clause 8.8.3. | + +#### 6.1.3.3.3.4 DELETE + +This method deregisters an existing NF instance from the NRF. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.4-1. + +**Table 6.1.3.3.3.4-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.4-2 and the response data structures and response codes specified in table 6.1.3.3.3.4-3. + +**Table 6.1.3.3.3.4-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.4-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect |

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

| +| RedirectResponse | O | 0..1 | 308 Permanent Redirect |

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

| +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). | | | | | + +**Table 6.1.3.3.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.3.3.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +### 6.1.3.4 Resource: subscriptions (Collection) + +#### 6.1.3.4.1 Description + +This resource represents a collection of subscriptions of NF Instances to newly registered NF Instances. + +#### 6.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-nfm/v1/subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.4.2-1. + +**Table 6.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +#### 6.1.3.4.3 Resource Standard Methods + +##### 6.1.3.4.3.1 POST + +This method creates a new subscription. This method shall support the URI query parameters specified in table 6.1.3.4.3.1-1. + +**Table 6.1.3.4.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3. + +**Table 6.1.3.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | The request body contains the input parameters for the subscription. These parameters include, e.g.:
- Target NF type
- Target Service Name
- Callback URI of the Requester NF | + +**Table 6.1.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | 201 Created | This case represents the successful creation of a subscription.

Upon success, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- NF_NOT_FOUND | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.4.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nnrf-nfm/v1/subscriptions/{subscriptionId} | + +**Table 6.1.3.4.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.3.4.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +### 6.1.3.5 Resource: subscription (Document) + +#### 6.1.3.5.1 Description + +This resource represents an individual subscription of a given NF Instance to newly registered NF Instances. + +#### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-nfm/v1/subscriptions/{subscriptionID} + +This resource shall support the resource URI variables defined in table 6.1.3.5.2-1. + +**Table 6.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| subscriptionID | string | Represents a specific subscription | + +#### 6.1.3.5.3 Resource Standard Methods + +##### 6.1.3.5.3.1 DELETE + +This method terminates an existing subscription. This method shall support the URI query parameters specified in table 6.1.3.5.3.1-1. + +**Table 6.1.3.5.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.5.3.1-2 and the response data structures and response codes specified in table 6.1.3.5.3.1-3. + +**Table 6.1.3.5.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.5.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.5.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.3.5.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +#### 6.1.3.5.3.2 PATCH + +This method updates an existing subscription. This method shall support the URI query parameters specified in table 6.1.3.5.3.2-1. + +**Table 6.1.3.5.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.5.3.2-2 and the response data structures and response codes specified in table 6.1.3.5.3.2-3. + +**Table 6.1.3.5.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | It contains the list of changes to be made to an individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [13]. | + +**Table 6.1.3.5.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | 200 OK | | +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- NF_NOT_FOUND | + +**Table 6.1.3.5.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.3.5.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +## 6.1.4 Custom Operations without associated resources + +There are no custom operations defined without any associated resources for the Nnrf\_NFManagement service in this release of the specification. + +## 6.1.5 Notifications + +### 6.1.5.1 General + +This clause specifies the notifications provided by the Nnrf\_NFManagement service. + +The delivery of notifications shall be supported as specified in clause 6.2 of 3GPP TS 29.500 [4] for Server-initiated communication. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------|--------------------------------------------------------------------------------|---------------------------------|---------------------------------------------------------------------------------| +| NF Instance Status Notification | {nfStatusNotificationUri}
(NF Service Consumer provided callback reference) | POST | Notify about registrations / deregistrations or profile changes of NF Instances | + +## 6.1.5.2 NF Instance Status Notification + +### 6.1.5.2.1 Description + +The NF Service Consumer provides a callback URI for getting notified about NF Instances status events, the NRF shall notify the NF Service Consumer, when the conditions specified in the subscription are met. + +### 6.1.5.2.2 Notification Definition + +The POST method shall be used for NF Instance Status notification and the URI shall be the callback reference provided by the NF Service Consumer during the subscription to this notification. + +Resource URI: {nfStatusNotificationUri} + +Support of URI query parameters is specified in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.1.5.2.2-2, and support of response data structures and response codes is specified in table 6.1.5.2-3. + +**Table 6.1.5.2.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------| +| NotificationData | M | 1 | Representation of the NF Instance status notification. | + +**Table 6.1.5.2.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| N/A | | | 204 No Content | This case represents a successful notification of the NF Instance status event. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF Service Consumer instance to which the notification should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF Service Consumer instance to which the notification should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.5.2.2-4: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer instance to which the request should be sent | + +**Table 6.1.5.2.2-5: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer instance to which the request should be sent | + +## 6.1.6 Data Model + +### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nnrf\_NFManagement service-based interface protocol. + +**Table 6.1.6.1-1: Nnrf\_NFManagement specific Data Types** + +| Data type | Clause defined | Description | +|---------------------------------|----------------|---------------------------------------------------------------------------------------------------------------------| +| NFProfile | 6.1.6.2.2 | Information of an NF Instance registered in the NRF. | +| NFService | 6.1.6.2.3 | Information of a given NF Service Instance; it is part of the NFProfile of an NF Instance. | +| DefaultNotificationSubscription | 6.1.6.2.4 | Data structure for specifying the notifications the NF service subscribes by default along with callback URI. | +| IpEndPoint | 6.1.6.2.5 | IP addressing information of a given NFService; it consists on, e.g. IP address, TCP port, transport protocol... | +| UdrInfo | 6.1.6.2.6 | Information of an UDR NF Instance. | +| UdmInfo | 6.1.6.2.7 | Information of an UDM NF Instance. | +| AusfInfo | 6.1.6.2.8 | Information of an AUSF NF Instance. | +| SupiRange | 6.1.6.2.9 | A range of SUPIs (subscriber identities), either based on a numeric range, or based on regular-expression matching. | +| IdentityRange | 6.1.6.2.10 | A range of subscriber identities, either based on a numeric range, or based on regular-expression matching. | +| AmfInfo | 6.1.6.2.11 | Information of an AMF NF Instance. | +| SmfInfo | 6.1.6.2.12 | Information of an SMF NF Instance. | +| UpfInfo | 6.1.6.2.13 | Information of an UPF NF Instance. | +| SnssaiUpfInfoItem | 6.1.6.2.14 | Set of parameters supported by UPF for a given S-NSSAI. | +| DnnUpfInfoItem | 6.1.6.2.15 | Set of parameters supported by UPF for a given DNN. | +| SubscriptionData | 6.1.6.2.16 | Information of a subscription to notifications to NRF events, included in subscription requests and responses. | +| NotificationData | 6.1.6.2.17 | Data sent in notifications from NRF to subscribed NF Instances. | +| NFServiceVersion | 6.1.6.2.19 | Contains the version details of an NF service. | +| PcfInfo | 6.1.6.2.20 | Information of a PCF NF Instance. | +| BsfInfo | 6.1.6.2.21 | Information of a BSF NF Instance. | +| Ipv4AddressRange | 6.1.6.2.22 | Range of IPv4 addresses. | +| Ipv6PrefixRange | 6.1.6.2.23 | Range of IPv6 prefixes. | +| InterfaceUpfInfoItem | 6.1.6.2.24 | Information of a given IP interface of an UPF. | +| UriList | 6.1.6.2.25 | Set of URIs following 3GPP hypermedia format (containing a " _links" attribute). | +| N2InterfaceAmfInfo | 6.1.6.2.26 | AMF N2 interface information | +| TaiRange | 6.1.6.2.27 | Range of TAIIs (Tracking Area Identities). | +| TacRange | 6.1.6.2.28 | Range of TACs (Tracking Area Codes). | +| SnssaiSmfInfoItem | 6.1.6.2.29 | Set of parameters supported by SMF for a given S-NSSAI. | +| DnnSmfInfoItem | 6.1.6.2.30 | Set of parameters supported by SMF for a given DNN. | +| NrfInfo | 6.1.6.2.31 | Information of an NRF NF Instance, used in hierarchical NRF deployments. | +| ChfInfo | 6.1.6.2.32 | Information of a CHF NF Instance. | +| PlmnRange | 6.1.6.2.34 | Range of PLMN IDs. | +| SubscrCond | 6.1.6.2.35 | Condition to determine the set of NFs to monitor under a certain subscription in NRF. | +| NfInstanceIdCond | 6.1.6.2.36 | Subscription to a given NF Instance Id. | +| NfTypeCond | 6.1.6.2.37 | Subscription to a set of NFs based on their NF Type. | +| ServiceNameCond | 6.1.6.2.38 | Subscription to a set of NFs based on their support for a given Service Name. | +| AmfCond | 6.1.6.2.39 | Subscription to a set of AMFs, based on AMF Set Id and/or AMF Region Id. | +| GuamiListCond | 6.1.6.2.40 | Subscription to a set of AMFs, based on their GUAMIIs. | +| NetworkSliceCond | 6.1.6.2.41 | Subscription to a set of NFs, based on the slices (S-NSSAI and NSI) they support . | +| NfGroupCond | 6.1.6.2.42 | Subscription to a set of NFs based on their Group Id. | +| NotifCondition | 6.1.6.2.43 | Condition (list of attributes in the NF Profile) to determine whether a notification must be sent by NRF. | +| PlmnSnssai | 6.1.6.2.44 | List of network slices (S-NSSAIs) for a given PLMN ID. | +| NwdaifInfo | 6.1.6.2.45 | Information of a NWDAF NF Instance. | +| LmfInfo | 6.1.6.2.46 | Information of an LMF NF Instance. | +| GmlcInfo | 6.1.6.2.47 | Information of a GMLC NF Instance. | +| NefInfo | 6.1.6.2.48 | Information of an NEF NF Instance. | +| PfdData | 6.1.6.2.49 | List of Application IDs and/or AF IDs managed by a given NEF Instance. | +| AfEventExposureData | 6.1.6.2.50 | AF Event Exposure data managed by a given NEF Instance. | +| WAgfInfo | 6.1.6.2.51 | Information of the W-AGF endpoints. | +| TngfInfo | 6.1.6.2.52 | Information of the TNGF endpoints. | + +| | | | +|-----------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Pscsflnfo | 6.1.6.2.53 | Information of a P-CSCF NF Instance. | +| NfSetCond | 6.1.6.2.54 | Subscription to a set of NFs based on their Set Id. | +| NfServiceSetCond | 6.1.6.2.55 | Subscription to a set of NFs based on their Service Set Id. | +| Nflnfo | 6.1.6.2.56 | Information of a generic NF Instance. | +| Hsslnfo | 6.1.6.2.57 | Information of an HSS NF Instance. | +| ImsiRange | 6.1.6.2.58 | A range of IMSIs (subscriber identities), either based on a numeric range, or based on regular-expression matching. | +| InternalGroupIdRange | 6.1.6.2.59 | A range of Group IDs (internal group identities), either based on a numeric range, or based on regular-expression matching. | +| UpfCond | 6.1.6.2.60 | Subscription to a set of NF Instances (UPFs), able to serve a certain service area (i.e. SMF serving area or TAI list). | +| Twiflnfo | 6.1.6.2.61 | Addressing information (IP addresses, FQDN) of the TWIF. | +| VendorSpecificFeature | 6.1.6.2.62 | Information about a vendor-specific feature | +| Udsflnfo | 6.1.6.2.63 | Information related to UDSF | +| Scplnfo | 6.1.6.2.65 | Information of an SCP Instance | +| ScpDomainInfo | 6.1.6.2.66 | SCP domain information | +| ScpDomainCond | 6.1.6.2.67 | Subscription to an SCP domain | +| OptionsResponse | 6.1.6.2.68 | Communication options of the NRF | +| NwdafCond | 6.1.6.2.69 | Subscription to a set of NF Instances (NWDAFs), identified by Analytics ID(s), S-NSSAI(s) or NWDAF Serving Area information, i.e. list of TAIs for which the NWDAF can provide analytics. | +| NefCond | 6.1.6.2.70 | Subscription to a set of NF Instances (NEFs), identified by Event ID(s) provided by AF, S-NSSAI(s), AF Instance ID, Application Identifier, External Identifier, External Group Identifier, or domain name. | +| Sucilnfo | 6.1.6.2.71 | SUCI information containing Routing Indicator and Home Network Public Key ID. | +| Sepplnfo | 6.1.6.2.72 | Information of a SEPP Instance | +| Aanflnfo | 6.1.6.2.73 | Information of an AAnF NF Instance. | +| 5GDdnmflnfo | 6.1.6.2.74 | Information of a 5G DDNMF NF Instance. | +| Mfaflnfo | 6.1.6.2.75 | Information of the MFAF NF Instance. | +| NwdafCapability | 6.1.6.2.76 | Indicates the capability supported by the NWDAF. | +| Dccflnfo | 6.1.6.2.80 | Information of a DCCF NF Instance. | +| Nsacflnfo | 6.1.6.2.81 | Information of an NSACF NF Instance. | +| NsacfCapability | 6.1.6.2.82 | NSACF service capability. | +| DccfCond | 6.1.6.2.83 | Subscription to a set of NF Instances (DCCFs), identified by NF types, NF Set Id(s) or DCCF Serving Area information, i.e. list of TAIs served by the DCCF. | +| MIAnalyticsInfo | 6.1.6.2.84 | ML Analytics Filter information supported by the Nnwdaf_MLModelProvision service | +| MbSmflnfo | 6.1.6.2.85 | Information of a MB-SMF NF Instance | +| TmgiRange | 6.1.6.2.86 | Range of TMGIs | +| MbsSession | 6.1.6.2.87 | MBS Session served by an MB-SMF | +| SnssaiMbSmflnfoItem | 6.1.6.2.88 | Parameters supported by an MB-SMF for a given S-NSSAI | +| DnnMbSmflnfoItem | 6.1.6.2.89 | Parameters supported by an MB-SMF for a given DNN | +| Tsctsflnfo | 6.1.6.2.91 | Information of a TSCTSF NF Instance. | +| SnssaiTsctsflnfoItem | 6.1.6.2.92 | Set of parameters supported by TSCTSF for a given S-NSSAI. | +| DnnTsctsflnfoItem | 6.1.6.2.93 | Set of parameters supported by TSCTSF for a given DNN. | +| MbUpflnfo | 6.1.6.2.94 | Information of a MB-UPF NF Instance. | +| UnTrustAflnfo | 6.1.6.2.95 | Information of a untrusted AF Instance. | +| TrustAflnfo | 6.1.6.2.96 | Information of a trusted AF Instance | +| SnssaiAflnfoItem | 6.1.6.2.97 | Set of parameters supported by NF for a given S-NSSAI. | +| DnnAflnfoItem | 6.1.6.2.98 | Set of parameters supported by NF for a given DNN. | +| CollocatedNfInstance | 6.1.6.2.99 | Information related to collocated NF type(s) and corresponding NF Instance(s) when the NF is collocated with NFs supporting other NF types. | +| ServiceNameListCond | 6.1.6.2.100 | Subscription to a set of NF Instances that offer a service name in the Service Name list. | +| NfGroupListCond | 6.1.6.2.101 | Subscription to a set of NF Instances, identified by a NF Group Identity in the NF Group Identity list. | +| PlmnOauth2 | 6.1.6.2.102 | Per PLMN Oauth2.0 indication. | +| V2xCapability | 6.1.6.2.103 | Indicate the supported V2X Capability by the PCF. | +| Nssaaflnfo | 6.1.6.2.104 | Information of a NSSAAF NF Instance. | + +| | | | +|-------------------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ProSeCapability | 6.1.6.2.105 | Indicate the supported ProSe Capability by the PCF. | +| SharedDataIdRange | 6.1.6.2.106 | | +| SubscriptionContext | 6.1.6.2.107 | Context data related to a created subscription, to be included in notifications sent by NRF. | +| IwmscInfo | 6.1.6.2.108 | Information of a SMS-IWMSC NF Instance. | +| MnpfInfo | 6.1.6.2.109 | Information of an MNPF Instance. | +| DefSubServiceInfo | 6.1.6.2.110 | Service Specific Information for Default Notification Subscription. | +| LocalityDescriptionItem | 6.1.6.2.111 | Description of locality information item | +| LocalityDescription | 6.1.6.2.112 | Description of locality information comprising one or more locality information items | +| DcsfInfo | 6.1.6.2.114 | Information of a DCSF NF Instance. | +| MIModelInterInfo | 6.1.6.2.115 | ML Model Interoperability Information | +| PruExistenceInfo | 6.1.6.2.116 | PRU Existence Information | +| MrfInfo | 6.1.6.2.117 | Information of a MRF NF instance. | +| MrfpInfo | 6.1.6.2.118 | Information of a MRFP NF instance. | +| MfInfo | 6.1.6.2.119 | Information of a MF NF instance. | +| A2xCapability | 6.1.6.2.120 | Indicate the supported A2X Capability by the PCF. | +| RuleSet | 6.1.6.2.121 | List of rules specifying whether access/scopes are allowed/denied for NF-Consumers. | +| SelectionConditions | 6.1.6.2.123 | List of conditions under which an NF Instance with an NFStatus or NFServiceStatus value set to "CANARY_RELEASE" shall be selected by an NF Service Consumer (e.g. if the UE belongs to a range of SUPIs) | +| ConditionItem | 6.1.6.2.124 | Each of the conditions that compose the SelectionConditions. A ConditionItem consists of a number of attributes representing individual conditions (e.g. a SUPI range, or a TAI list) | +| ConditionGroup | 6.1.6.2.125 | List (array) of conditions (joined by the "and" or "or" logical relationship), under which an NF Instance with an NFStatus or NFServiceStatus value set to "CANARY_RELEASE" shall be selected by an NF Service Consumer. | +| EpdgInfo | 6.1.6.2.126 | Information of the ePDG endpoints. | +| CallbackUriPrefixItem | 6.1.6.2.127 | Callback URI prefix value to be used for specific notification types | +| NefId | 6.1.6.3.2 | Identity of the NEF. | +| VendorId | 6.1.6.3.2 | Vendor ID of the NF Service instance (Private Enterprise Number assigned by IANA) | +| WildcardDnai | 6.1.6.3.2 | Wildcard DNAI | +| MediaCapability | 6.1.6.3.2 | Media capability offered by NF instance. | +| NFType | 6.1.6.3.3 | NF types known to NRF. | +| NotificationType | 6.1.6.3.4 | Types of notifications used in Default Notification URIs in the NF Profile of an NF Instance. | +| TransportProtocol | 6.1.6.3.5 | Types of transport protocol used in a given IP endpoint of an NF Service Instance. | +| NotificationEventType | 6.1.6.3.6 | Types of events sent in notifications from NRF to subscribed NF Instances. | +| NFStatus | 6.1.6.3.7 | Status of a given NF Instance stored in NRF. | +| DataSetId | 6.1.6.3.8 | Types of data sets stored in UDR. | +| UPInterfaceType | 6.1.6.3.9 | Types of User-Plane interfaces of the UPF. | +| ServiceName | 6.1.6.3.11 | Service names known to NRF. | +| NFServiceStatus | 6.1.6.3.12 | Status of a given NF Service Instance of an NF Instance stored in NRF. | +| AnNodeType | 6.1.6.3.13 | Access Network Node Type (gNB, ng-eNB...). | +| ConditionEventType | 6.1.6.3.14 | Indicates whether a notification is due to the NF Instance to start or stop being part of a condition for a subscription to a set of NFs | +| IpReachability | 6.1.6.3.15 | Indicates the type(s) of IP addresses reachable via an SCP. | +| CollocatedNfType | 6.1.6.3.17 | Possible NF types supported by a collocated NF. | +| LocalityType | 6.1.6.3.18 | Type of Locality description item. | +| FICapabilityType | 6.1.6.3.19 | Type of Federated Learning Capability | +| RuleSetAction | 6.1.6.3.21 | Specifies whether access/scope is allowed or denied for a specific NF-Consumer | + +Table 6.1.6.1-2 specifies data types re-used by the Nnrf\_NFManagement 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 Nnrf\_NFManagement service-based interface. + +**Table 6.1.6.1-2: Nnrf\_NFManagement re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| N1MessageClass | 3GPP TS 29.518 [6] | The N1 message type | +| N2InformationClass | 3GPP TS 29.518 [6] | The N2 information type | +| IPv4Addr | 3GPP TS 29.571 [7] | | +| IPv6Addr | 3GPP TS 29.571 [7] | | +| IPv6Prefix | 3GPP TS 29.571 [7] | | +| Uri | 3GPP TS 29.571 [7] | | +| Dnn | 3GPP TS 29.571 [7] | | +| SupportedFeatures | 3GPP TS 29.571 [7] | | +| Snssai | 3GPP TS 29.571 [7] | | +| PlmnId | 3GPP TS 29.571 [7] | | +| Guami | 3GPP TS 29.571 [7] | | +| Tai | 3GPP TS 29.571 [7] | | +| NfInstanceId | 3GPP TS 29.571 [7] | Identifier (UUID) of the NF Instance. The hexadecimal letters of the UUID should be formatted by the sender as lower-case characters and shall be handled as case-insensitive by the receiver. | +| LinksValueSchema | 3GPP TS 29.571 [7] | 3GPP Hypermedia link | +| UriScheme | 3GPP TS 29.571 [7] | | +| AmfName | 3GPP TS 29.571 [7] | | +| DateTime | 3GPP TS 29.571 [7] | | +| Dnai | 3GPP TS 29.571 [7] | | +| ChangeItem | 3GPP TS 29.571 [7] | | +| DiameterIdentity | 3GPP TS 29.571 [7] | | +| AccessType | 3GPP TS 29.571 [7] | | +| NfGroupId | 3GPP TS 29.571 [7] | Network Function Group Id | +| AmfRegionId | 3GPP TS 29.571 [7] | | +| AmfSetId | 3GPP TS 29.571 [7] | | +| PduSessionType | 3GPP TS 29.571 [7] | | +| AtsssCapability | 3GPP TS 29.571 [7] | Capability to support procedures related to Access Traffic Steering, Switching, Splitting. | +| Nid | 3GPP TS 29.571 [7] | | +| PlmnIdNid | 3GPP TS 29.571 [7] | | +| NfSetId | 3GPP TS 29.571 [7] | NF Set ID (see clause 28.12 of 3GPP TS 23.003 [12]) | +| NfServiceSetId | 3GPP TS 29.571 [7] | NF Service Set ID (see clause 28.13 of 3GPP TS 23.003 [12]) | +| GroupId | 3GPP TS 29.571 [7] | Internal Group Identifier | +| RatType | 3GPP TS 29.571 [7] | RAT Type | +| DurationSec | 3GPP TS 29.571 [7] | | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of the redirect response message. | +| ExtSnssai | 3GPP TS 29.571 [7] | | +| AreaSessionId | 3GPP TS 29.571 [7] | Area Session Identifier used for an MBS session with location dependent content | +| MbsSessionId | 3GPP TS 29.571 [7] | MBS Session Identifier | +| MbsServiceArea | 3GPP TS 29.571 [7] | MBS Service Area | +| IpAddr | 3GPP TS 29.571 [7] | IP Address | +| MbsServiceAreaInfo | 3GPP TS 29.571 [7] | MBS Service Area Information for Location dependent MBS session | +| Fqdn | 3GPP TS 29.571 [7] | Fully Qualified Domain Name | +| EventId | 3GPP TS 29.520 [32] | Defined in Nnwdaf_AnalyticsInfo API. | +| NwdafEvent | 3GPP TS 29.520 [32] | Defined in Nnwdaf_EventsSubscription API. | +| ExternalClientType | 3GPP TS 29.572 [33] | | +| LMFIdentification | 3GPP TS 29.572 [33] | LMF Identification | +| AfEvent | 3GPP TS 29.517 [35] | Defined in Naf_EventExposure API | +| SupportedGADShapes | 3GPP TS 29.572 [33] | Supported GAD Shapes | +| NetworkNodeDiameter Address | 3GPP TS 29.503 [36] | Diameter Address of a Network Node | +| IpIndex | 3GPP TS 29.503 [36] | IP Index | +| EventType | 3GPP TS 29.564 [49] | Event type supported by the UPF Event Exposure service | + +## 6.1.6.2 Structured data types + +### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 6.1.6.2.2 Type: NFProfile + +**Table 6.1.6.2.2-1: Definition of type NFProfile** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nflInstanceId | NflInstanceId | M | 1 | Unique identity of the NF Instance. | +| nfType | NFType | M | 1 | Type of Network Function | +| nfStatus | NFStatus | M | 1 | Status of the NF Instance (NOTE 5) (NOTE 16) | +| collocatedNfInstances | array(Collocated NflInstance) | O | 1..N | Information related to collocated NF type(s) and corresponding NF Instances when the NF is collocated with NFs supporting other NF types. (NOTE 21)

In this release of the specification, following collocation scenarios are supported (see clause 6.1.6.2.99):
- a MB-SMF collocated with a SMF;
- a MB-UPF collocated with a UPF. | +| nflInstanceName | string | O | 0..1 | Human readable name of the NF Instance | +| heartBeatTimer | integer | C | 0..1 | Time in seconds expected between 2 consecutive heart-beat messages from an NF Instance to the NRF.
It may be included in the registration request. When present in the request it shall contain the heartbeat time proposed by the NF service consumer.
It shall be included in responses from NRF to registration requests (PUT) or in NF profile updates (PUT or PATCH). If the proposed heartbeat time is acceptable by the NRF based on the local configuration, it shall use the same value as in the registration request; otherwise the NRF shall override the value using a preconfigured value. | +| plmnList | array(PlmnId) | C | 1..N | PLMN(s) of the Network Function (NOTE 7).
This IE shall be present if this information is available for the NF.
If neither the plmnList IE nor the snpnList IE are provided, PLMN ID(s) of the PLMN of the NRF are assumed for the NF. | +| snpnList | array(PlmnIdNid) | C | 1..N | SNPN(s) of the Network Function.
This IE shall be present if the NF pertains to one or more SNPNs. | +| sNssais | array(ExtSnssai) | O | 1..N | S-NSSAIs of the Network Function.
If not provided, and if the perPlmnSnssaiList attribute is not present, the NF can serve any S-NSSAI.
When present this IE represents the list of S-NSSAIs supported in all the PLMNs listed in the plmnList IE and all the SNPNs listed in the snpnList.
If the sNssais attribute is provided in at least one NF Service, the S-NSSAIs supported by the NF Profile shall be the set or a superset of the S-NSSAIs of the NFService(s). | +| perPlmnSnssaiList | array(PlmnSnssai ) | O | 1..N | This IE may be included when the list of S-NSSAIs supported by the NF for each PLMN it is supporting is different. When present, this IE shall include the S-NSSAIs supported by the Network Function for each PLMN supported by the Network Function. When present, this IE shall override sNssais IE. (NOTE 9)
If the perPlmnSnssaiList attribute is provided in at least one NF Service, the S-NSSAIs supported per PLMN in the NF Profile shall be the set or a superset of the perPlmnSnssaiList of the NFService(s). | +| nsiList | array(string) | O | 1..N | NSI identities of the Network Function.
If not provided, the NF can serve any NSI. | +| fqdn | Fqdn | C | 0..1 | FQDN of the Network Function (NOTE 1) (NOTE 2) (NOTE 18). For AMF, the FQDN registered with the NRF shall be that of the AMF Name (see 3GPP TS 23.003 [12] clause 28.3.2.5). | +| interPlmnFqdn | Fqdn | C | 0..1 | If the NF needs to be discoverable by other NFs in a different PLMN, then an FQDN that is used for inter-PLMN routing as specified in 3GPP TS 23.003 [12] shall be registered with the NRF (NOTE 8). | + +| | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

A change of this attribute shall result in triggering a "NF_PROFILE_CHANGED" notification from NRF towards subscribing NFs located in the same or a different PLMN, but in the latter case the new value shall be notified as a change of the "fqdn" attribute.

The NRF shall not send intra-PLMN notifications containing this attribute to subscribing NFs not supporting the "Inter-Plmn-Fqdn" feature (see clause 6.1.9).

| +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|------------------|------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipv4Addresses | array(Ipv4Addr) | C | 1..N | IPv4 address(es) of the Network Function (NOTE 1) (NOTE 2) (NOTE 18) | +| ipv6Addresses | array(Ipv6Addr) | C | 1..N | IPv6 address(es) of the Network Function (NOTE 1) (NOTE 2) (NOTE 18) | +| allowedPlmns | array(PlmnId) | O | 1..N |

PLMNs allowed to access the NF instance. If not provided, any PLMN is allowed to access the NF.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 17)

| +| allowedSnpons | array(PlmnIdNid) | O | 1..N |

SNPNs allowed to access the NF instance.

If this attribute is present in the NFService and in the NF profile, the attribute from the NFService shall prevail.

The absence of this attribute in both the NFService and in the NF profile indicates that no SNPN, other than the SNPN(s) registered in the snpnList attribute of the NF Profile (if the NF pertains to an SNPN), is allowed to access the service instance.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 17)

| +| allowedNfTypes | array(NFType) | O | 1..N |

Type of the NFs allowed to access the NF instance. If not provided, any NF type is allowed to access the NF.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 17)

| +| allowedNfDomains | array(string) | O | 1..N |

Pattern (regular expression according to the ECMA-262 dialect [8]) representing the NF domain names within the PLMN of the NRF allowed to access the NF instance. If not provided, any NF domain is allowed to access the NF.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 17)

| +| allowedNssais | array(ExtSnssai) | O | 1..N |

S-NSSAI of the allowed slices to access the NF instance. If not provided, any slice is allowed to access the NF.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the

| + +| | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------| +| | | | | subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 17) | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|----------------|--------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedRuleSet | map(RuleSet) | O | 1..N |

Map of rules specifying NF-Consumers allowed or denied to access the NF-Producer. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.

This IE may be present when the NF-Producer and the NRF support Allowed-ruleset feature as specified in clause 6.1.9.

When NRF utilizes this parameter to determine if the NF-Consumers allowed or denied to access an NF-Producer, it matches the NF-Consumer's properties (PLMN, SNPN, nfType, NfDomain, S-NSSAIs) against each rule in decreasing order of priority (1 being the highest). When a matching rule is found, the search is stopped and the NF-Consumer is allowed/dis-allowed to access the NF-Producer (see Annex C).

This attribute shall not be included in profile change notifications to subscribed NFs.

If the subscribing entity included "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17), the complete IE shall be present in the profile change notification (NOTE 17)

| +| priority | integer | O | 0..1 |

Priority (relative to other NFs of the same type) within the range 0 to 65535, to be used for NF selection; lower values indicate a higher priority. Priority may or may not be present in the nfServiceList parameters, xxxInfo parameters and in this attribute. Priority in the nfServiceList has precedence over the priority in this attribute (NOTE 4).

Priority in xxxInfo parameter shall only be used to determine the relative priority among NF instances with the same priority at NFProfile/NFService.

The NRF may overwrite the received priority value when exposing an NFProfile with the Nnrf_NFDiscovery service.

| +| capacity | integer | O | 0..1 |

Static capacity information within the range 0 to 65535, expressed as a weight relative to other NF instances of the same type; if capacity is also present in the nfServiceList parameters, those will have precedence over this value. (NOTE 4).

| +| load | integer | O | 0..1 |

Dynamic load information, within the range 0 to 100, indicates the current load percentage of the NF.

| +| loadTimeStamp | DateTime | O | 0..1 |

It indicates the point in time in which the latest load information (sent by the NF in the "load" attribute of the NF Profile) was generated at the NF Instance.

If the NF did not provide a timestamp, the NRF should set it to the instant when the NRF received the message where the NF provided the latest load information.

| +| locality | string | O | 0..1 |

Operator defined information about the location of the NF instance (e.g. geographic location, data center) (NOTE 3)

| +| extLocality | map(string) | O | 1..N |

Operator defined information about the location of the NF instance. (NOTE 3)

The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters, representing a type of

| + +| | | | | | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | locality as defined in clause 6.1.6.3.18.

Example:
{
"DATA_CENTER": "dc-123",
"CITY": "Los Angeles",
"STATE": "California"
} | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|--------------|---------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| udrInfo | UdrInfo | O | 0..1 | Specific data for the UDR (ranges of SUPI, group ID ...) | +| udrInfoList | map(UdrInfo) | O | 1..N | Multiple entries of UdrInfo. This attribute provides additional information to the udrInfo. udrInfoList may be present even if the udrInfo is absent.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| udmInfo | UdmInfo | O | 0..1 | Specific data for the UDM (ranges of SUPI, group ID...) | +| udmInfoList | map(UdmInfo) | O | 1..N | Multiple entries of UdmInfo. This attribute provides additional information to the udmInfo. udmInfoList may be present even if the udmInfo is absent.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| ausfInfo | AusfInfo | O | 0..1 | Specific data for the AUSF (ranges of SUPI, group ID...) | +| ausfInfoList | map(AusfInfo) | O | 1..N | Multiple entries of AusfInfo. This attribute provides additional information to the ausfInfo. ausfInfoList may be present even if the ausfInfo is absent.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| amfInfo | AmfInfo | O | 0..1 | Specific data for the AMF (AMF Set ID, ...) | +| amfInfoList | map(AmfInfo) | O | 1..N | Multiple entries of AmfInfo. This attribute provides additional information to the amfInfo. amfInfoList may be present even if the amfInfo is absent.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| smfInfo | SmfInfo | O | 0..1 | Specific data for the SMF (DNN's, ...).
(NOTE 12) | +| smfInfoList | map(SmfInfo) | O | 1..N | Multiple entries of SmfInfo. This attribute provides additional information to the smfInfo. smfInfoList may be present even if the smfInfo is absent.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.
(NOTE 12) | +| upfInfo | UpfInfo | O | 0..1 | Specific data for the UPF (S-NSSAI, DNN, SMF serving area, interface...) | +| upfInfoList | map(UpfInfo) | O | 1..N | Multiple entries of UpfInfo. This attribute provides additional information to the upfInfo. upfInfoList may be present even if the upfInfo is absent.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| pcfInfo | PcfInfo | O | 0..1 | Specific data for the PCF. | +| pcfInfoList | map(PcfInfo) | O | 1..N | Multiple entries of PcfInfo. This attribute provides additional information to the pcfInfo. pcfInfoList may be present even if the pcfInfo is absent.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| bsfInfo | BsfInfo | O | 0..1 | Specific data for the BSF. | +| bsfInfoList | map(BsfInfo) | O | 1..N | Multiple entries of BsfInfo. This attribute provides additional information to the bsfInfo. bsfInfoList may be present even if the bsfInfo is absent.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| chfInfo | ChfInfo | O | 0..1 | Specific data for the CHF. | +| chfInfoList | map(ChfInfo) | O | 1..N | Multiple entries of ChfInfo. This attribute provides additional information to the chfInfo. chfInfoList may be present even if the chfInfo is absent.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a | + +| | | | | | +|--|--|--|--|---------------------------| +| | | | | maximum of 32 characters. | +|--|--|--|--|---------------------------| + +| | | | | | +|----------------------------|------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nefInfo | NefInfo | O | 0..1 | Specific data for the NEF. | +| nrfInfo | NrfInfo | O | 0..1 | Specific data for the NRF. | +| udsfInfo | UdsfInfo | O | 0..1 | Specific data for the UDSF. | +| udsfInfoList | map(UdsfInfo) | O | 1..N | Multiple entries of udsfInfo. This attribute provides additional information to the udsfInfo. udsfInfoList may be present even if the udsfInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| nwdaflInfo | NwdaflInfo | O | 0..1 | Specific data for the NWDAF. | +| nwdaflInfoList | map(NwdaflInfo) | O | 1..N | Multiple entries of nwdaflInfo. This attribute provides additional information to the nwdaflInfo. nwdaflInfoList may be present even if the nwdaflInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| pcscfInfoList | map(PcscfInfo) | O | 1..N | Specific data for the P-CSCF. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. (NOTE 11) | +| hssInfoList | map(HssInfo) | O | 1..N | Specific data for the HSS. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| customInfo | object | O | 0..1 | Specific data for custom Network Functions | +| recoveryTime | DateTime | O | 0..1 | Timestamp when the NF was (re)started (NOTE 5) (NOTE 6) | +| nfServicePersistence | boolean | O | 0..1 |

- true: If present, and set to true, it indicates that the different service instances of a same NF Service in this NF instance, supporting a same API version, are capable to persist their resource state in shared storage and therefore these resources are available after a new NF service instance supporting the same API version is selected by a NF Service Consumer (see 3GPP TS 23.527 [27]).

- false (default): Otherwise, it indicates that the NF Service Instances of a same NF Service are not capable to share resource state inside the NF Instance.

| +| nfServices | array(NFService) | O | 1..N |

List of NF Service Instances. It shall include the services produced by the NF that can be discovered by other NFs, if any. (NOTE 15)

This attribute is deprecated; the attribute "nfServiceList" should be used instead.

| +| nfServiceList | map(NFService) | O | 1..N |

Map of NF Service Instances, where the "serviceInstanceId" attribute of the NFService object shall be used as the key of the map. (NOTE 15)

It shall include the services produced by the NF that can be discovered by other NFs, if any.

| +| nfProfileChangesSupportInd | boolean | O | 0..1 |

NF Profile Changes Support Indicator. See Annex B.

This IE may be present in the NFRegister or NFUpdate (NF Profile Complete Replacement) request and shall be absent in the response.

true: the NF Service Consumer supports receiving NF Profile Changes in the response.

false (default): the NF Service Consumer does not support receiving NF Profile Changes in the response.

Write-Only: true

| + +| | | | | | +|-----------------------------------------|----------------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nfProfilePartialUpdateChangesSupportInd | boolean | O | 0..1 |

NF Profile Partial Update Changes Support Indicator.
See Annex B.

This IE may be present in the NFRegister or NFUpdate request and shall be absent in the response.

true: the NF Service Consumer supports receiving NF Profile Changes in the response to an NF Profile Partial Update operation.

false (default): the NF Service Consumer does not support receiving NF Profile Changes in the response to an NF Profile Partial Update operation.

Write-Only: true

| +| nfProfileChangesInd | boolean | O | 0..1 |

NF Profile Changes Indicator.
See Annex B.

This IE shall be absent in the request to the NRF and may be included by the NRF in NFRegister or NFUpdate response.

true: the NF Profile contains NF Profile changes.
false (default): complete NF Profile.

Read-Only: true

| +| defaultNotificationSubscriptions | array(DefaultNotificationSubscription) | O | 1..N | Notification endpoints for different notification types. (NOTE 10) | +| lmfInfo | LmfInfo | O | 0..1 | Specific data for the LMF. | +| gmlcInfo | GmlcInfo | O | 0..1 | Specific data for the GMLC. | +| nfSetIdList | array(NfSetId) | C | 1..N |

NF Set ID defined in clause 28.12 of 3GPP TS 23.003 [12].

At most one NF Set ID shall be indicated per PLMN-ID or SNPN of the NF. At most one combination of an AMF region and an AMF Set ID shall be indicated per PLMN-ID or SNPN in an AMF profile.

This information shall be present if available. (NOTE 22) (NOTE 23)

| +| servingScope | array(string) | O | 1..N |

The served area(s) of the NF instance.

The absence of this attribute does not imply that the NF instance can serve every area in the PLMN. (NOTE 13)

| +| lchSupportInd | boolean | O | 0..1 |

This IE indicates whether the NF supports Load Control based on LCI Header (see clause 6.3 of 3GPP TS 29.500 [4]).

  • - true: the NF supports the feature.
  • - false (default): the NF does not support the feature.
| +| olchSupportInd | boolean | O | 0..1 |

This IE indicates whether the NF supports Overload Control based on OCI Header (see clause 6.4 of 3GPP TS 29.500 [4]).

  • - true: the NF supports the feature.
  • - false (default): the NF does not support the feature.
| +| nfSetRecoveryTimeList | map(DateTime) | O | 1..N |

Map of recovery time, where the key of the map is the NfSetId of NF Set(s) that the NF instance belongs to.

When present, the value of each entry of the map shall be the recovery time of the NF Set indicated by the key.

| +| serviceSetRecoveryTimeList | map(DateTime) | O | 1..N |

Map of recovery time, where the key of the map is the NfServiceSetId of the NF Service Set(s) configured in the NF instance.

| + +| | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------| +| | | | | When present, the value of each entry of the map shall be the recovery time of the NF Service Set indicated by the key. | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|---------------------------------|-----------------------------------|---|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| scpDomains | array(string) | O | 1..N | When present, this IE shall carry the list of SCP domains the SCP belongs to, or the SCP domain the NF (other than SCP) or the SEPP belongs to. (NOTE 14) | +| scpInfo | ScpInfo | O | 0..1 | Specific data for the SCP. | +| seppInfo | SeppInfo | O | 0..1 | Specific data for the SEPP. | +| vendorId | VendorId | O | 0..1 | Vendor ID of the NF instance, according to the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. | +| supportedVendorSpecificFeatures | map(array(VendorSpecificFeature)) | O | 1..N(1..M) | Map of Vendor-Specific features, where the key of the map is the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. The string used as key of the map shall contain 6 decimal digits; if the SMI code has less than 6 digits, it shall be padded with leading digits "0" to complete a 6-digit string value. The value of each entry of the map shall be a list (array) of VendorSpecificFeature objects. (NOTE 19) | +| aanflInfoList | map(AanflInfo) | O | 1..N | Multiple entries of AanflInfo. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| 5gDdnmfInfo | 5GDdnmfInfo | O | 0..1 | Specific data for the 5G DDNMF (5G DDNMF ID, ...) | +| mfaflInfo | MfaflInfo | O | 0..1 | Specific data for the MFAF | +| easdfInfoList | map(EasdfInfo) | O | 1..N | EASDF specific data. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. (NOTE 20) | +| dcclfInfo | DccfInfo | O | 0..1 | Specific data for the DCCF. | +| nsacflInfoList | map(NsacflInfo) | O | 1..N | Specific data for the NSACF. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| mbSmfInfoList | map(MbSmfInfo) | O | 1..N | MB-SMF specific data. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| tsctsfInfoList | map(TsctsfInfo) | O | 1..N | Specific data for the TSCTSF. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| mbUpfInfoList | map(MbUpfInfo) | O | 1..N | MB-UPF specific data. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| trustAflInfo | TrustAflInfo | O | 0..1 | Specific data for the trusted AF. | +| nssaaflInfo | NssaaflInfo | O | 0..1 | Specific data for the NSSAAF. | +| hniList | array(Fqdn) | C | 1..N | Identifications of Credentials Holder or Default Credentials Server. This IE shall be present if the NFs are available for the case of access to an SNPN using credentials owned by a Credentials Holder or for the case of SNPN Onboarding using a DCS. | +| iwmscflInfo | IwmscflInfo | O | 0..1 | Specific data for the SMS-IWMSC. | +| mnpflInfo | MnpflInfo | O | 0..1 | Specific data for the MNPF. | +| smsflInfo | SmsflInfo | O | 0..1 | Specific data for the SMSF. | +| dcssfInfoList | map(DcsfInfo) | O | 1..N | Specific data for the DCSF. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| mrfInfoList | map(MrfInfo) | O | 1..N | Specific data for the MRF. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mrfpInfoList | map(MrfpInfo) | O | 1..N | Specific data for the MRFP.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| mflInfoList | map(MflInfo) | O | 1..N | Specific data for the MF.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| adrflInfoList | map(AdrflInfo) | O | 1..N | Specific data for the ADRF.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| selectionConditions | SelectionConditions | O | 0..1 | This IE is only applicable if the NFStatus is set to "CANARY_RELEASE".

If present, it includes the conditions under which an NF Instance with an NFStatus value set to "CANARY_RELEASE" shall be selected by an NF Service Consumer (e.g. if the UE belongs to a range of SUPIs) | +| NOTE 1: At least one of the addressing parameters (fqdn, ipv4address or ipv6address) shall be included in the NF Profile. If the NF supports the NF services with "https" URI scheme (i.e use of TLS is mandatory), then the FQDN shall be provided in the NF Profile or the NF Service profile (see clause 6.1.6.2.3) and it shall be used to construct the target URI (unless overridden by a NFService-specific FQDN). See NOTE 1 of Table 6.1.6.2.3-1 for the use of these parameters. If multiple ipv4 addresses and/or ipv6 addresses are included in the NF Profile, the NF Service Consumer of the discovery service shall select one of these addresses randomly, unless operator defined local policy of IP address selection, in order to avoid overload for a specific ipv4 address and/or ipv6 address. | | | | | +| NOTE 2: If the type of Network Function is UPF, the addressing information is for the UPF N4 interface and, if the UPF registers service instances supporting the UPF Event Exposure service or the Nupf_GetUEPrivateIPaddrAndIdentifiers service without registering addressing information at these service instances level, also for accessing the UPF Event Exposure service or the Nupf_GetUEPrivateIPaddrAndIdentifiers service at these service instances. If the type of Network Function is MB-UPF, the addressing information is for the MB-UPF N4mb interface. If the type of Network Function is a P-CSCF and if no Gm FQDN or IP addresses are registered in the pcscfInfoList attribute, the addressing information is also used for the P-CSCF Gm interface. | | | | | +| NOTE 3: A requester NF may use this information to select a NF instance (e.g. a NF instance preferably located in the same data center). | | | | | +| NOTE 4: The capacity and priority parameters, if present, are used for NF selection and load balancing. The priority and capacity attributes shall be used for NF selection in the same way that priority and weight are used for server selection as defined in IETF RFC 2782 [23]. | | | | | +| NOTE 5: The NRF shall notify NFs subscribed to receiving notifications of changes of the NF profile, if the NF recoveryTime or the nfStatus is changed. See clause 6.2 of 3GPP TS 23.527 [27]. | | | | | +| NOTE 6: A requester NF may consider that all the resources created in the NF before the NF recovery time have been lost. This may be used to detect a restart of a NF and to trigger appropriate actions, e.g. release local resources. See clause 6.2 of 3GPP TS 23.527 [27]. | | | | | +| NOTE 7: A NF may register multiple PLMN IDs in its profile within a PLMN comprising multiple PLMN IDs. If so, all the attributes of the NF Profile shall apply to each PLMN ID registered in the plmnList. As an exception, attributes including a PLMN ID, e.g. IMSI-based SUPI ranges, TAIs and GUAMIs, are specific to one PLMN ID and the NF may register in its profile multiple occurrences of such attributes for different PLMN IDs (e.g. the UDM may register in its profile SUPI ranges for different PLMN IDs). | | | | | +| NOTE 8: Other NFs are in a different PLMN if they belong to none of the PLMN ID(s) configured for the PLMN of the NRF. | | | | | +| NOTE 9: This is for the use case where an NF (e.g. AMF) supports multiple PLMNs and the slices supported in each PLMN are different. See clause 9.2.6.2 of 3GPP TS 38.413 [29]. | | | | | +| NOTE 10: For notification types that may be associated with a specific service of the NF Instance receiving the notification (see clause 6.1.6.3.4), if notification endpoints are present both in the profile of the NF instance (NFProfile) and in some of its NF Services (NFService) for a same notification type, the notification endpoint(s) of the NF Services shall be used for this notification type. The defaultNotificationSubscriptions attribute may contain multiple default subscriptions for a same notification type; in that case, those default subscriptions are used as alternative notification endpoints so, for each notification event that needs to be sent, the NF Service Consumer shall select one of such subscriptions and use it to send the notification. | | | | | +| NOTE 11: The absence of the pcscfInfoList attribute in a P-CSCF profile indicates that the P-CSCF can be selected for any DNN and Access Type, and that the P-CSCF Gm addressing information is the same as the addressing information registered in the fqdn, ipv4Addresses and ipv4Addresses attributes of the NF profile. | | | | | +| NOTE 12: The absence of both the smfInfo and smfInfoList attributes in an SMF profile indicates that the SMF can be selected for any S-NSSAI listed in the sNSSAIs and perPlmnSnssaiList IEs, or for any S-NSSAI if neither the | | | | | + +sNSSAI IE nor the perPlmnSnsaiList IE are present, and for any DNN, TAI and access type. + +- NOTE 13: The servingScope attribute may indicate geographical areas. It may be used e.g. to discover and select NFs in centralized Data Centers that are expected to serve users located in specific region(s) or province(s). It may also be used to reduce the large configuration of TAIs in the NF instances. +- NOTE 14: An NF (other than a SCP) can register at most one SCP domain in NF profile, i.e. the NF can belong to only one SCP domain. If an NF (other than a SCP) includes this information in its profile, this indicates that the services produced by this NF should be accessed preferably via an SCP from the SCP domain the NF belongs to. +- NOTE 15: If the NF Service Consumer that issues an NF profile retrieval request indicates support for the "Service-Map" feature, the NRF shall return in the NF profile retrieval response the list of NF Service Instances in the "nfServiceList" map attribute. Otherwise, the NRF shall return the list of NF Service Instances in the "nfServices" array attribute. +- NOTE 16: The nfStatus also indicate the Status of the NF instance as NF Service Consumer for notification delivery. When a notification is to be delivered to the NF instance and the NF Service Producer (or SCP) has been aware that the NF instance is not operative from the nfStatus in its NF profile, the NF Service producer (or SCP) shall reselect another NF Service Consumer as target if possible, e.g. using binding indication or discovery factors previously provided for the notification. When selecting or reselecting an NF Service Consumer for notification delivery, not operative NF instances shall not be selected as target. +- NOTE 17: A change of this attribute shall trigger a "NF\_PROFILE\_CHANGED" notification from NRF, if the change of the NF Profile results in that the NF Instance starts or stops being authorized to be accessed by an NF having subscribed to be notified about NF profile changes. +- NOTE 18: For API URIs constructed with an FQDN, the NF Service Consumer may use the FQDN of the target URI to do a DNS query and obtain the IP address(es) to setup the TCP connection, and ignore the IP addresses that may be present in the NFProfile; alternatively, the NF Service Consumer may use those IP addresses to setup the TCP connection, if no service-specific FQDN or IP address is provided in the NFService data and if the NF Service Consumer supports to indicate specific IP address(es) to establish an HTTP/2 connection with an FQDN in the target URI. +- NOTE 19: When present, this attribute allows an NF requesting NF Discovery (e.g. an NF Service Consumer) to determine which vendor-specific extensions are supported in a given NF (e.g. an NF Service Producer), so as to select an appropriate NF with specific capability, or to include or not the vendor-specific attributes (see 3GPP TS 29.500 [4] clause 6.6.3) required for a given feature in subsequent messages towards a certain NF. One given vendor-specific feature shall not appear in both NF Profile and NF Service Profile. If one vendor-specific feature is service related, it shall only be included in the NF Service Profile. +- NOTE 20: The absence of the easdfInfoList attribute in an EASDF profile indicates that the EASDF can be selected for any S-NSSAI, DNN, DNAI or PSA UPF N6 IP address. +- NOTE 21: The NF service consumer when invoking NF services offered by collocated NF service producers shall follow the respective service API in the same manner as if they were not collocated with any other NF type. The NF service consumer shall not assume any optimization of signaling between the NF service consumer and the collocated NF service producers. +- NOTE 22: The nfSetIdList attribute shall be present only if all NF service instance(s) of the NF instance are redundant at NF Set level. i.e. any NF service instance shall be redundant (i.e. functionally equivalent, interchangeable and sharing contexts) with equivalent service instance(s) of every other NF instance(s) within the indicated NF Set or, if the NF service instance belongs to an NF service set, it shall be redundant with NF service instance(s) in an equivalent NF service set of every other NF instance(s) within the indicated NF set. +- NOTE 23: The NF Instance shall be removed from an NF set or re-assigned to another NF set ONLY when there is NO ongoing resource/context associated with the NF instance. + +## 6.1.6.2.3 Type: NFService + +**Table 6.1.6.2.3-1: Definition of type NFService** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------|----------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| serviceInstanceId | string | M | 1 | Unique ID of the service instance within a given NF Instance | +| serviceName | ServiceName | M | 1 | Name of the service instance (e.g. "nudm-sdm") | +| versions | array(NFService Version) | M | 1..N | The API versions supported by the NF Service and if available, the corresponding retirement date of the NF Service.
The different array elements shall have distinct unique values for "apiVersionInUri", and consequently, the values of "apiFullVersion" shall have a unique first digit version number. | +| scheme | UriScheme | M | 1 | URI scheme (e.g. "http", "https") | +| nfServiceStatus | NFServiceStatus | M | 1 | Status of the NF Service Instance (NOTE 3) (NOTE 12) | +| fqdn | Fqdn | O | 0..1 | FQDN of the NF Service Instance (NOTE 1) (NOTE 8) (NOTE 14)
The FQDN provided as part of the NFService information has precedence over the FQDN and IP addresses provided as part of the NFProfile information (see clause 6.1.6.2.2). | +| interPlmnFqdn | Fqdn | O | 0..1 | If the NF service needs to be discoverable by other NFs in a different PLMN, then an FQDN that is used for inter PLMN routing as specified in 3GPP TS 23.003 [12] may be registered with the NRF (NOTE 1) (NOTE 6).
A change of this attribute shall result in triggering a "NF_PROFILE_CHANGED" notification from NRF towards subscribing NFs located in the same or a different PLMN, but in the latter case the new value shall be notified as a change of the "fqdn" attribute.
The NRF shall not send intra-PLMN notifications containing this attribute to subscribing NFs not supporting the "Inter-Plmn-Fqdn" feature (see clause 6.1.9). | +| ipEndPoints | array(IpEndPoint) | O | 1..N | IP address(es) and port information of the Network Function (including IPv4 and/or IPv6 address) where the service is listening for incoming service requests (NOTE 1) (NOTE 7) (NOTE 14).
IP addresses provided in ipEndPoints have precedence over IP addresses provided as part of the NFProfile information and, when using the HTTP scheme, over FQDN provided as part of the NFProfile information (see clause 6.1.6.2.2). | +| apiPrefix | string | O | 0..1 | Optional path segment(s) used to construct the {apiRoot} variable of the different API URIs, as described in 3GPP TS 29.501 [5], clause 4.4.1 | +| callbackUriPrefixList | array(CallbackUri PrefixItem) | O | 1..N | Optional path segment(s) used to construct the prefix of the Callback URIs during the reselection of an NF service consumer, as described in 3GPP TS 29.501 [5], clause 4.4.3.
When present, this IE shall contain callback URI prefix values to be used for specific notification types. | +| defaultNotificationSubscriptions | array(DefaultNotificationSubscription) | O | 1..N | Notification endpoints for different notification types. (See also NOTE 10 in clause 6.1.6.2.2) | +| allowedPlmns | array(PlmnId) | O | 1..N | PLMNs allowed to access the service instance (NOTE 5).
The absence of this attribute indicates that any PLMN is allowed to access the service instance.
When included, the allowedPlmns attribute needs not include the PLMN ID(s) registered in the plmnList attribute of the NF Profile, i.e. the PLMN ID(s) registered in the NF Profile shall be considered to be | + +| | | | | | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

allowed to access the service instance.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 13)

| +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|-----------------------------|---------------------|---|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedSnpns | array(PlmnIdNid) | O | 1..N |

SNPNs allowed to access the service instance.

If this attribute is present in the NFService and in the NF profile, the attribute from the NFService shall prevail.

The absence of this attribute in both the NFService and in the NF profile indicates that no SNPN, other than the SNPN(s) registered in the snpnList attribute of the NF Profile (if the NF pertains to an SNPN), is allowed to access the service instance.

When included, the allowedSnpns attribute needs not include the PLMN ID/NID(s) registered in the snpnList attribute of the NF Profile (if the NF pertains to an SNPN), i.e. the SNPNs registered in the NF Profile (if any) shall be considered to be allowed to access the service instance.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 13)

| +| allowedNfTypes | array(NFType) | O | 1..N |

Type of the NFs allowed to access the service instance (NOTE 5).

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 13)

| +| allowedNfDomains | array(string) | O | 1..N |

Pattern (regular expression according to the ECMA-262 dialect [8]) representing the NF domain names within the PLMN of the NRF allowed to access the service instance (NOTE 5).

The absence of this attribute indicates that any NF domain is allowed to access the service instance.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 13)

| +| allowedNssais | array(ExtSnssai) | O | 1..N |

S-NSSAI of the allowed slices to access the service instance (NOTE 5).

The absence of this attribute indicates that any slice is allowed to access the service instance.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 13)

| +| allowedOperationsPerNf Type | map(array(string) ) | C | 1..N(1..M) |

Map of allowed operations on resources for each type of NF; the key of the map is the NF Type, and the value is an array of scopes.

| + +| | | | | | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

The scopes shall be any of those defined in the API that defines the current service (identified by the "serviceName" attribute).

In an NFRegister (or NFUpdate) procedure, this IE should be present if the NF service instance supports and is configured to use resource/operation specific scope(s) for at least one NF type of NF service consumer.

In an NFStatusNotify procedure, this IE should be present, if it is present in the registered NF service instance and if the map contains a key matching the subscriber's NF type. When present, this IE should only contain the key-value pair of the map matching the subscriber's NF type.

(NOTE 11)

| +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|-----------------------------------------|--------------------|---|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedOperationsPerNfInstance | map(array(string)) | C | 1..N(1..M) |

Map of allowed operations on resources for a given NF Instance; the key of the map is the NF Instance Id, and the value is an array of scopes.

The scopes shall be any of those defined in the API that defines the current service (identified by the "serviceName" attribute).

In an NFRegister (or NFUpdate) procedure, this IE should be present if the NF service instance supports and is configured to use resource/operation specific scope(s) for at least one NF instance of NF service consumer.

In an NFStatusNotify procedure, this IE should be present, if it is present in the registered NF service instance and if the map contains a key matching the subscriber's NF Instance ID. When present, this IE should only contain the key-value pair of the map matching the subscriber's NF Instance ID.

(NOTE 11)

| +| allowedOperationsPerNfInstanceOverrides | boolean | O | 0..1 |

This IE, when present and set to true, indicates that the scopes defined in attribute "allowedOperationsPerNfInstance" for a given NF Instance ID take precedence over the scopes defined in attribute "allowedOperationsPerNfType" for the corresponding NF type of the NF Instance associated to such NF Instance ID.

If the IE is not present, or set to false (default), it indicates that the allowed scopes are any of the scopes present either in "allowedOperationsPerNfType" or in "allowedOperationsPerNfInstance" for the NF Type and NF Instance ID of the NF Service Consumer.

(NOTE 11)

| +| allowedScopesRuleSet | map(RuleSet) | O | 1..N |

Map of rules specifying scopes allowed or denied for NF-Consumers. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.

This IE may be present when the NF-Producer and the NRF support Allowed-ruleset feature as specified in Clause 6.1.9.

When NRF utilizes this parameter to determine the scopes allowed or denied to an NF-Consumer, it matches the NF-Consumer's properties (PLMN, SNPN, nfType, NfDomain, S-NSSAIs, NF-Instance Id) against each rule in decreasing order of priority (1 being the highest). When a matching rule is found, the search is stopped and the scopes associated to matching rule are allowed/dis-allowed to the NF-Consumer (see Annex C).

In an NFStatusNotify procedure, this IE may be present if the subscribing NF supports the Allowed-ruleset feature as specified in Clause 6.1.9, and should only contain the highest priority RuleSet matching the requester's NF Instance ID, nfType, PLMN-ID, SNPN-ID, NfDomain and S-NSSAI if any.

If the subscribing entity included "completeProfileSubscription" attribute in the subscription request message, and the NRF

| + +| | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17), the complete IE shall be present in the profile change notification (NOTE 13) | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|---------------------------------|-----------------------------------|---|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| priority | integer | O | 0..1 | Priority (relative to other services of the same type) in the range of 0-65535, to be used for NF Service selection; lower values indicate a higher priority. (NOTE 2).
The NRF may overwrite the received priority value when exposing an NFProfile with the Nnrf_NFDiscovery service. | +| capacity | integer | O | 0..1 | Static capacity information in the range of 0-65535, expressed as a weight relative to other services of the same type. (NOTE 2). | +| load | integer | O | 0..1 | Dynamic load information, ranged from 0 to 100, indicates the current load percentage of the NF Service. | +| loadTimeStamp | DateTime | O | 0..1 | It indicates the point in time in which the latest load information (sent by the NF in the "load" attribute of the NF Service) was generated at the NF Service Instance.

If the NF did not provide a timestamp, the NRF should set it to the instant when the NRF received the message where the NF provided the latest load information. | +| recoveryTime | DateTime | O | 0..1 | Timestamp when the NF service was (re)started (NOTE 3) (NOTE 4) | +| supportedFeatures | SupportedFeatures | O | 0..1 | Supported Features of the NF Service instance | +| nfServiceSetIdList | array(NfServiceSetId) | C | 1..N | NF Service Set ID (see clause 28.13 of 3GPP TS 23.003 [12])
At most one NF Service Set ID shall be indicated per PLMN-ID or SNPN of the NF.
This information shall be present if available. (NOTE 15) | +| sNssais | array(ExtSnssai) | O | 1..N | S-NSSAIs of the NF Service. This may be a subset of the S-NSSAIs supported by the NF (see sNssais attribute in NFProfile).
When present, this IE shall represent the list of S-NSSAIs supported by the NF Service in all the PLMNs listed in the plmnList IE and all the SNPNs listed in the snpnList and it shall prevail over the list of S-NSSAIs supported by the NF instance. | +| perPlmnSnssaiList | array(PlmnSnssai) | O | 1..N | S-NSSAIs of the NF Service per PLMN. This may be a subset of the S-NSSAIs supported per PLMN by the NF (see perPlmnSnssaiList attribute in NFProfile).

This IE may be included when the list of S-NSSAIs supported by the NF Service for each PLMN it is supporting is different. When present, this IE shall include the S-NSSAIs supported by the NF Service for each PLMN and it shall prevail over the list of S-NSSAIs supported per PLMN by the NF instance. When present, this IE shall override the sNssais IE. (NOTE 9) | +| vendorId | VendorId | O | 0..1 | Vendor ID of the NF Service instance, according to the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. | +| supportedVendorSpecificFeatures | map(array(VendorSpecificFeature)) | O | 1..N(1..M) | Map of Vendor-Specific features, where the key of the map is the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. The string used as key of the map shall contain 6 decimal digits; if the SMI code has less than 6 digits, it shall be padded with leading digits "0" to complete a 6-digit string value.
The value of each entry of the map shall be a list (array) of VendorSpecificFeature objects. (NOTE 10) | +| oauth2Required | boolean | O | 0..1 | It indicates whether the NF Service Instance requires Oauth2-based authorization. | + +| | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------| +| | | | | Absence of this IE means that the NF Service Producer has not provided any indication about its usage of Oauth2 for authorization. | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|----------------------|---------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| perPlmnOAuth2ReqList | PlmnOAuth2 | O | 0..1 | When present, this IE shall include the Oauth2-based authorization requirement supported by the NF Service Instance per PLMN of the NF Service Consumer.
This IE may be included when the Oauth2.0 authorization requirement supported by the NF Service Instance for different PLMN is different. When the requester PLMN Id is available in perPlmnOAuth2ReqList IE, this IE shall override the oauth2Required IE. If the requester PLMN ID is not present in perPlmnOAuth2ReqList IE, then the value of oauth2Required IE shall be applicable if available. | +| selectionConditions | SelectionConditions | O | 0..1 | This IE is only applicable if the NFServiceStatus is set to "CANARY_RELEASE".

If present, it includes the conditions under which an NF Service Instance with an NFServiceStatus value set to "CANARY_RELEASE" shall be selected by an NF Service Consumer (e.g. if the UE belongs to a range of SUPIs) | + +NOTE 1: The NF Service Consumer will construct the API URIs of the service using: + +- For intra-PLMN signalling: If TLS is used, the FQDN present in the NF Service Profile, if any; otherwise, the FQDN present in the NF Profile. If TLS is not used, the FQDN should be used if the NF Service Consumer uses Indirect Communication via an SCP; the FQDN or the IP address in the ipEndPoints attribute may be used if the NF Service Consumer uses Direct Communication. + +- For inter-PLMN signalling: the interPlmnFqdn present in the NF Service Profile, if any; otherwise, the interPlmnFqdn present in the NF Profile. + +See Table 6.2.6.2.4-1. + +NOTE 2: The capacity and priority parameters, if present, are used for NF selection and load balancing. The priority and capacity attributes shall be used for NF selection in the same way that priority and weight are used for server selection as defined in IETF RFC 2782 [23]. + +NOTE 3: The NRF shall notify NFs subscribed to receiving notifications of changes of the NF profile, if the recoveryTime or the nfServiceStatus is changed. See clause 6.2 of 3GPP TS 23.527 [27]. + +NOTE 4: A requester NF subscribed to NF status changes may consider that all the resources created in the NF service before the NF service recovery time have been lost. This may be used to detect a restart of a NF service and to trigger appropriate actions, e.g. release local resources. See clause 6.2 of 3GPP TS 23.527 [27]. + +NOTE 5: If this attribute is present in the NFService and in the NF profile, the attribute from the NFService shall prevail. The absence of this attribute in the NFService and in the NFProfile indicates that there is no corresponding restriction to access the service instance. If this attribute is absent in the NF Service, but it is present in the NF Profile, the attribute from the NF Profile shall be applied. + +NOTE 6: Other NFs are in a different PLMN if they belong to none of the PLMN ID(s) configured for the PLMN of the NRF. + +NOTE 7: If multiple ipv4 addresses and/or ipv6 addresses are included in the NF Service, the NF Service Consumer of the discovery service shall select one of these addresses randomly, unless operator defined local policy of IP address selection, in order to avoid overload for a specific ipv4 address and/or ipv6 address. + +NOTE 8: If the URI scheme registered for the NF service is "https" then FQDN shall be provided in the NF Service profile or in NF Profile (see clause 6.1.6.2.2). + +NOTE 9: This is for the use case where an NF (e.g. AMF) supports multiple PLMNs and the slices supported in each PLMN are different. See clause 9.2.6.2 of 3GPP TS 38.413 [29]. + +NOTE 10: When present, this attribute allows the NF requesting NF discovery (e.g. an NF Service Consumer) to determine which vendor-specific extensions are supported in a given NF (e.g. an Service Producer) in order to select an appropriate NF, or to include or not include the vendor-specific attributes (see 3GPP TS 29.500 [4] clause 6.6.3) required for a given feature in subsequent service requests towards a certain service instance of the NF Service Producer. One given vendor-specific feature shall not appear in both NF Profile and NF Service Profile. If one vendor-specific feature is service related, it shall only be included in the NF Service Profile. + +NOTE 11: These attributes are used in order to determine whether a given resource/operation-level scope shall be granted to an NF Service Consumer that requested an Oauth2 access token with a specific scope. If attribute "allowedOperationsPerNfInstanceOverrides" is absent, or set to false, the NRF shall only grant such scope in the access token, if the scope is present in either "allowedOperationsPerNfType", for the specific NF type of the NF Service Consumer, or in "allowedOperationsPerNfInstance", for the specific NF instance ID of the NF Service Consumer. If attribute "allowedOperationsPerNfInstanceOverrides" is present and set to true, the NRF shall grant such scope in the access token, if the scope is included in the "allowedOperationsPerNfInstance" attribute for the NF Instance ID of the NF Service Consumer. If attribute "allowedOperationPerNfInstanceOverrides" is present and set to true, but the NF Instance ID of the NF Service Consumer is not included in attribute "allowedOperationPerNfInstance", the NRF shall grant such scope if it is present in the "allowedOperationsPerNfType" for the specific NF type of the NF Service + +Consumer. + +These attributes need not be registered if the NF service instance only supports (or is configured to only use) the service-level scope for all NF service consumers allowed to access the service. When both these attributes are absent, the NRF should grant access tokens for the service-level scope only. + +When at least one of these IEs is present, these IEs shall indicate all the NF types or NF instances allowed to access the NF service instance, with all the corresponding scopes (i.e. the service-level scope and resource/operation specific scopes) allowed for each NF type or NF instance, i.e. any NF type or NF instance not listed in these IEs is disallowed to access the NF service instance. + +Example: if an NF service instance is configured to enable an NF type X to access all service operations including resource/operations defined with resource/operation specific scopes and an NF type Y to access only the service operations not requiring resource/operation specific scopes, the allowedOperationsPerNfType IE should be present and set as follows: + +``` +allowedOperationsPerNfType: { + X: [, , ], + Y: [] +} +``` + +- NOTE 12: The nfServiceStatus also indicate the Status of the NF service instance as NF Service Consumer for notification delivery. When a notification is to be delivered to the NF service instance and the NF Service Producer (or SCP) has been aware that the NF service instance is not operative from the nfServiceStatus in the NF profile, the NF Service producer (or SCP) shall reselect another NF Service Consumer as target if possible, e.g. using binding indication or discovery factors previously provided for the notification. When selecting or reselecting an NF Service Consumer for notification delivery, not operative NF (service) instances shall not be selected as target. +- NOTE 13: A change of this attribute shall trigger a "NF\_PROFILE\_CHANGED" notification from NRF, if the change of the NF Profile results in that the NF Instance starts or stops being authorized to be accessed by an NF having subscribed to be notified about NF profile changes. +- NOTE 14: For API URIs constructed with an FQDN, the NF Service Consumer may use the FQDN in the target URI to do a DNS query and obtain the IP address(es) to setup the TCP connection, and ignore the IP addresses that may be present in the ipEndPoints attribute; alternatively, the NF Service Consumer may use those IP addresses to setup the TCP connection, if the NF Service Consumer supports to indicate specific IP address(es) to establish an HTTP/2 connection with an FQDN in the target URI. +- NOTE 15: The NF service Instance shall be removed from an NF service set or re-assigned to another NF service set ONLY when there is NO ongoing resource/context associated with the NF service instance. + +6.1.6.2.4 Type: DefaultNotificationSubscription + +**Table 6.1.6.2.4-1: Definition of type DefaultNotificationSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationType | NotificationType | M | 1 | Type of notification for which the corresponding callback URI is provided. | +| callbackUri | Uri | M | 1 | This attribute contains a default notification endpoint to be used by a NF Service Producer towards an NF Service Consumer that has not registered explicitly a callback URI in the NF Service Producer (e.g. as a result of an implicit subscription). | +| InterPlmnCallbackUri | Uri | C | 0..1 |

This IE shall be present when the default notification may be sent by a NF Service Producer in a different PLMN (e.g. the NSSAAF in HPLMN sends a notification to the AMF in VPLMN to re-authorize or revoke a S-NSSAI for a roaming UE) and the callback URI indicated in the callbackUri IE is not supporting inter-PLMN access.

When present, this IE shall indicate the callback URI to be used by NF Service Producers located in PLMNs that are different from the PLMN of the NF consumer.

| +| n1MessageClass | N1MessageClass | C | 0..1 | If the notification type is N1_MESSAGES, this IE shall be present and shall identify the class of N1 messages to be notified. | +| n2InformationClass | N2InformationClass | C | 0..1 | If the notification type is N2_INFORMATION, this IE shall be present and shall identify the class of N2 information to be notified. | +| versions | array(string) | O | 1..N | API versions (e.g. "v1") supported for the default notification type. (NOTE 3) | +| binding | string | O | 0..1 | When present, this IE shall contain the value of the Binding Indication for the default subscription notification (i.e. the value part of "3gpp-Sbi-Binding" header), as specified in clause 6.12.4 of 3GPP TS 29.500 [4]. (NOTE 1) | +| acceptedEncoding | string | O | 0..1 |

Content encodings that are accepted by a NF Service Consumer when receiving a notification related to a default notification subscription. The value of this attribute shall be formatted as the value of the Accept-Encoding header defined in IETF RFC 9110 [40] clause 12.5.3 (e.g. acceptedEncoding: "gzip;q=1.0, identity;q=0.5, *;q=0")

The absence of this IE shall not be interpreted as indicating that no specific encodings are supported, but the NF Service Consumer did not register the encodings it may support.

| +| supportedFeatures | SupportedFeatures | O | 0..1 | When present, this attribute shall indicate the features of the service corresponding to the subscribed default notification, which are supported by the NF (Service) instance acting as NF service consumer. (NOTE 2, NOTE 3) | +| serviceInfoList | map(DefSubServiceInfo) | O | 1..N |

This IE may be present when the notification request of the notification type may be generated by multiple services, i.e. notifications from different services may be received by the subscription.

When present, this IE shall contain a map of service specific information. The name of the corresponding service (as specified in ServiceName data type, see clause 6.1.6.3.11) is the key of the map and the value of the map is the specific information for the indicated service supported by the NF (Service) instance acting as NF service consumer.

For example, when the NF subscribes to default notification of "LOCATION_NOTIFICATION" type

| + +| | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

which may be sent by Namf_Location service and Nlmf_Location service, the NF may provide service specific information as below:

 {   "namf-loc" : {     "versions" : [ "v1" ],     "supportedFeatures" : "AB"   },    "nlmf-loc" : {     "versions" : [ "v1" ],     "supportedFeatures" : "12"   } }

(NOTE 3, NOTE 4)

| +| callbackUriPrefix | string | O | 0..1 | Optional path segment(s) used to construct the prefix of the Callback URIs during the reselection of an NF service consumer, as described in 3GPP TS 29.501 [5], clause 4.4.3 | +|

NOTE 1: The binding indication for default subscription may be used by a NF service producer to reselect an alternative NF service consumer instance, when delivering a notification for a default subscription towards a specific NF consumer but the latter is not reachable. E.g. an AMF notifies corresponding uplink LPP/NRPPa messages via default subscription, to the LMF instance who previously sent downlink LPP/NRPPa message during a location procedure, If the original LMF instance is not reachable, the AMF selects an alternative LMF instance using the binding indication and delivers the notification towards the selected LMF instance.

NOTE 2: When sending notifications towards the subscribed NF service consumer, the NF service producer shall generate the default notifications according to the supported features indicated in this attribute, e.g. to include the attributes or enumerated values related to particular features only if the corresponding features are supported, as specified in clause 6.6.2 of 3GPP TS 29.500 [4].

NOTE 3: When the serviceInfoList IE is present, the versions IE and the supportedFeatures IE shall be absent.

NOTE 4: When the serviceInfoList IE is present, the NF producer shall determine whether the service of the default notification is supported, i.e. whether the service is listed in the map keys. If supported, the NF producer shall generate the default notification according to the specific information of the service, i.e. the corresponding map value.

| | | | | + +## 6.1.6.2.5 Type: IpEndPoint + +Table 6.1.6.2.5-1: Definition of type IpEndPoint + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|---------------------------------------------------| +| ipv4Address | Ipv4Addr | C | 0..1 | IPv4 address (NOTE 1) | +| ipv6Address | Ipv6Addr | C | 0..1 | IPv6 address (NOTE 1) | +| transport | TransportProtocol | O | 0..1 | Transport protocol | +| port | integer | O | 0..1 | Port number (NOTE 2)
Minimum: 0 Maximum: 65535 | + +NOTE 1: At most one occurrence of either ipv4Address or ipv6Address shall be included in this data structure. +NOTE 2: If the port number is absent from the ipEndPoints attribute (see clause 6.1.6.2.3), i.e. there is no "port" attribute in any of the IpEndPoints objects of the ipEndPoints array, the NF service consumer shall use the default HTTP port number, i.e. TCP port 80 for "http" URIs or TCP port 443 for "https" URIs as specified in IETF RFC 9113 [9] when invoking the service. +NOTE 3: If the "port" attribute is present, but the ipv4Address and ipv6Address attributes are absent, the NF service consumer shall use such port number along with the FQDN present in the NFService or NFProfile data types or IP address parameters present in the NFProfile data type to construct the target URI where the NF Service Producer is listening for incoming service requests. +NOTE 4: If the "port" attribute is present with any ipv4Address and ipv6Address attributes and the HTTP scheme of the service is "https", or the inter-PLMN signalling uses the "http" scheme, the NF service consumer shall use such port number along with the FQDN parameter present in the NFService or NFProfile data types to construct the target URI where the NF Service Producer is listening for incoming service requests. +NOTE 5: If the HTTP scheme of the service (see clause 6.1.6.2.3) is "https" or the inter-PLMN signalling uses the "http" scheme, the operator should not configure IpEndPoints having pairs of IP addresses and ports, with different "port" values in each entry. This is so because the authority of the target URI shall consist of an FQDN (due to the "https" scheme or inter-PLMN signalling), and it is not always possible to ensure which IP address will be used by the HTTP/2 stack after the DNS resolution has been performed. +NOTE 6: If the "ipEndPoints" array contains an entry (IpEndPoint object) containing either ipv4Address or ipv6Address, and with the "port" attribute absent, the NF Service Consumer shall use the default port for the given HTTP scheme when building a target URI that uses such IP address in the authority field of the URI. + +The following examples describe valid cases of the authority of target URIs, considering the addressing information present in the NFProfile and in the NFService objects (in the "nfServiceList" map). + +## EXAMPLE 1: + +## NFProfile: + +``` +{ + "fqdn": "nf.example.com", + "ipv4Addresses": [ "1.2.3.4" ], + "nfServiceList": { + "Service1": { + "scheme": "http", + "ipEndPoints": [ + { "port": 8080 }, + { "ipv4Address": "1.2.3.5", "port": 8081 } + ] + } + } +} +``` + +Valid authority for target URIs: + + + +Note that the IP address contained in ipEndPoints override the FQDN and IP address in NFProfile-level, so the value contained in "port" cannot be used, in this configuration. + +## EXAMPLE 2: + +## NFProfile: + +``` +{ + "fqdn": "nf.example.com", + "ipv4Addresses": [ "1.2.3.4" ], + "nfServiceList": { +``` + +``` + + "Service1": { + "scheme": "http", + "fqdn": "service1.example.com", + "ipEndPoints": [ + { "ipv4Address": "1.2.3.5", "port": 8081 }, + { "ipv4Address": "1.2.3.6" } + ] + } + } + } + } +} + +``` + +Valid authority for target URIs: + +``` + +http://1.2.3.5:8081/ +http://1.2.3.6:80/ +http://1.2.3.6/ + +``` + +#### EXAMPLE 3: + +NFProfile: + +``` + +{ + "fqdn": "nf.example.com", + "ipv4Addresses": [ "1.2.3.4" ], + "nfServiceList": { + "Service1": { + "scheme": "http", + "ipEndPoints": [ + { "port": 8080 }, + ] + } + } +} + +``` + +Valid authority for target URIs: + +``` + +http://nf.example.com:8080/ +http://1.2.3.4:8080/ + +``` + +#### 6.1.6.2.6 Type: UdrInfo + +**Table 6.1.6.2.6-1: Definition of type UdrInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| groupId | NfGroupId | O | 0..1 | Identity of the UDR group that is served by the UDR instance.
If not provided, the UDR instance does not pertain to any UDR group.
(NOTE 1) | +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPI's whose profile data is available in the UDR instance (NOTE 1) | +| gpsiRanges | array(IdentityRange) | O | 1..N | List of ranges of GPSIs whose profile data is available in the UDR instance (NOTE 1) | +| externalGroupIdentifiersRanges | array(IdentityRange) | O | 1..N | List of ranges of external groups whose profile data is available in the UDR instance (NOTE 1) | +| supportedDataSets | array(DataSetId) | O | 1..N | List of supported data sets in the UDR instance.
If not provided, the UDR supports all data sets. | +| sharedDataIdRanges | array(SharedDataIdRange) | O | 1..N | List of ranges of Shared Data IDs that identify shared data available in the UDR instance (NOTE 1) | + +NOTE 1: If none of these parameters are provided, the UDR can serve any external group and any SUPI or GPSI and any SharedData managed by the PLMN of the UDR instance. If "supiRanges", "gpsiRanges" and "externalGroupIdentifiersRanges" attributes are absent, and "groupId" is present, the SUPIs / GPSIs / ExternalGroups served by this UDR instance is determined by the NRF (see 3GPP TS 23.501 [2], clause 6.2.6.2). + +## 6.1.6.2.7 Type: UdmInfo + +Table 6.1.6.2.7-1: Definition of type UdmInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| groupId | NfGroupId | O | 0..1 | Identity of the UDM group that is served by the UDM instance.
If not provided, the UDM instance does not pertain to any UDM group.
(NOTE 1) | +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPIs whose profile data is available in the UDM instance (NOTE 1) | +| gpsiRanges | array(IdentityRange) | O | 1..N | List of ranges of GPSIs whose profile data is available in the UDM instance (NOTE 1) | +| externalGroupIdentifiersRanges | array(IdentityRange) | O | 1..N | List of ranges of external groups whose profile data is available in the UDM instance (NOTE 1) | +| routingIndicators | array(string) | O | 1..N | List of Routing Indicator information that allows to route network signalling with SUCI (see 3GPP TS 23.003 [12]) to the UDM instance.
(NOTE 4)

If not provided, and "groupId" attribute is absent, the UDM can serve any Routing Indicator.

Pattern: '^[0-9]{1,4}\$' | +| internalGroupIdentifiersRanges | array(InternalGroupIdRange) | O | 1..N | List of ranges of Internal Group Identifiers whose profile data is available in the UDM instance.
If not provided, it does not imply that the UDM supports all internal groups. | +| suciInfos | array(SuciInfo) | O | 1..N | List of SuciInfo. A SUCI that matches this information can be served by the UDM .
(NOTE 2, NOTE 3)
A SUCI that matches all attributes of at least one entry in this array shall be considered as a match of this information. | + +NOTE 1: If none of these parameters are provided, the UDM can serve any external group and any SUPI or GPSI managed by the PLMN of the UDM instance. If "supiRanges", "gpsiRanges" and "externalGroupIdentifiersRanges" attributes are absent, and "groupId" is present, the SUPIs / GPSIs / ExternalGroups served by this UDM instance is determined by the NRF (see 3GPP TS 23.501 [2], clause 6.2.6.2). + +NOTE 2: The combination of SUCI informations, e.g. Routing Indicator and Home Network Public Key Id, may be used as criteria for UDM discovery. In this release, the usage of Home Network Public Key identifier for UDM discovery is limited to the scenario where the UDM NF consumers belong to the same PLMN as UDM. + +NOTE 3: If the suciInfos attribute is present and contains the routingInds sub-attribute, then the routingIndicators attribute shall also be present. + +NOTE 4: If "routingIndicators" attribute is absent, and "groupId" is present, the set of Routing Indicators served by this UDM instance is determined by the NRF. When "groupId" is present, if the consumer of the Nnrf\_Discovery service does not support the "RID-NfGroupId-Mapping" feature (see clause 6.2.9), the NRF shall include in the discovery response the list of supported "routingIndicators" served by the UDM Group ID to which this UDM instance belongs, as determined by the NRF (or leave absent the "routingIndicators" attribute to indicate that any Routing Indicator is served by this UDM instance). + +## 6.1.6.2.8 Type: AusfInfo + +Table 6.1.6.2.8-1: Definition of type AusfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| groupId | NfGroupId | O | 0..1 | Identity of the AUSF group.
If not provided, the AUSF instance does not pertain to any AUSF group.
(NOTE 1) | +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPIs that can be served by the AUSF instance.
(NOTE 1) | +| routingIndicators | array(string) | O | 1..N | List of Routing Indicator information that allows to route network signalling with SUCI (see 3GPP TS 23.003 [12]) to the AUSF instance.
(NOTE 4)

If not provided, and "groupId" attribute is absent, the AUSF can serve any Routing Indicator.

Pattern: '[0-9]{1,4}\$' | +| suciInfos | array(SuciInfo) | O | 1..N | List of SuciInfo. A SUCI that matches this information can be served by the AUSF. (NOTE 2, NOTE 3)
A SUCI that matches all attributes of at least one entry in this array shall be considered as a match of this information. | + +NOTE 1: If none of these parameters are provided, the AUSF can serve any SUPI managed by the PLMN of the AUSF instance. If "supiRanges" attribute is absent, and "groupId" is present, the SUPIs served by this AUSF instance is determined by the NRF (see 3GPP TS 23.501 [2], clause 6.2.6.2). + +NOTE 2: The combination of SUCI informations, e.g. Routing Indicator and Home Network Public Key Id, can be used as criteria for AUSF discovery. In this release, the usage of Home Network Public Key identifier for AUSF discovery is limited to the scenario where the AUSF NF consumers belong to the same PLMN as AUSF. + +NOTE 3: If the suciInfos attribute is present and contains the routingInds sub-attribute, then the routingIndicators attribute shall also be present. + +NOTE 4: If "routingIndicators" attribute is absent, and "groupId" is present, the set of Routing Indicators served by this AUSF instance is determined by the NRF. When "groupId" is present, if the consumer of the Nnrf\_Discovery service does not support the "RID-NfGroupId-Mapping" feature (see clause 6.2.9), the NRF shall include in the discovery response the list of supported "routingIndicators" served by the AUSF Group ID to which this AUSF instance belongs, as determined by the NRF (or leave absent the "routingIndicators" attribute to indicate that any Routing Indicator is served by this AUSF instance). + +## 6.1.6.2.9 Type: SupiRange + +Table 6.1.6.2.9-1: Definition of type SupiRange + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| start | string | O | 0..1 | First value identifying the start of a SUPI range, to be used when the range of SUPI's can be represented as a numeric range (e.g., IMSI ranges). This string shall consist only of digits.
Pattern: "^[0-9]+\$" | +| end | string | O | 0..1 | Last value identifying the end of a SUPI range, to be used when the range of SUPI's can be represented as a numeric range (e.g. IMSI ranges). This string shall consist only of digits.
Pattern: "^[0-9]+\$" | +| pattern | string | O | 0..1 | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of SUPI's belonging to this range. A SUPI value is considered part of the range if and only if the SUPI string fully matches the regular expression. | + +NOTE: Either the start and end attributes, or the pattern attribute, shall be present. + +- EXAMPLE 1: IMSI range. From: 123 45 6789040000 To: 123 45 6789059999 (i.e., 20,000 IMSI numbers) + JSON: { "start": "123456789040000", "end": "123456789059999" } +- EXAMPLE 2: IMSI range. From: 123 45 6789040000 To: 123 45 6789049999 (i.e., 10,000 IMSI numbers) + JSON: { "pattern": "^imsi-12345678904[0-9]{4}\$" }, or + JSON: { "start": "123456789040000", "end": "123456789049999" } +- EXAMPLE 3: NAI range. "smartmeter-{factoryID}@company.com" where "{factoryID}" can be any string. + JSON: { "pattern": "^nai-smartmeter-.+@company\\.com\$" } + +#### 6.1.6.2.10 Type: IdentityRange + +**Table 6.1.6.2.10-1: Definition of type IdentityRange** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------------------------------------------------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| start | string | O | 0..1 | First value identifying the start of an identity range, to be used when the range of identities can be represented as a numeric range (e.g., MSISDN ranges). This string shall consist only of digits.
Pattern: "[0-9]+\$" | +| end | string | O | 0..1 | Last value identifying the end of an identity range, to be used when the range of identities can be represented as a numeric range (e.g., MSISDN ranges). This string shall consist only of digits.
Pattern: "[0-9]+\$" | +| pattern | string | O | 0..1 | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of identities belonging to this range. An identity value is considered part of the range if and only if the identity string fully matches the regular expression. | +| NOTE: Either the start and end attributes, or the pattern attribute, shall be present. | | | | | + +## 6.1.6.2.11 Type: AmfInfo + +Table 6.1.6.2.11-1: Definition of type AmfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| amfRegionId | AmfRegionId | M | 1 | AMF region identifier | +| amfSetId | AmfSetId | M | 1 | AMF set identifier. | +| guamiList | array(Guami) | M | 1..N | List of supported GUAMIs | +| taiList | array(Tai) | O | 1..N | The list of TAIs the AMF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the AMF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the AMF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the taiList attribute indicate that the AMF can be selected for any TAI in the serving network. | +| backupInfoAmfFailure | array(Guami) | O | 1..N | List of GUAMIs for which the AMF acts as a backup for AMF failure | +| backupInfoAmfRemoval | array(Guami) | O | 1..N | List of GUAMIs for which the AMF acts as a backup for planned AMF removal | +| n2InterfaceAmfInfo | N2InterfaceAmfInfo | O | 0..1 | N2 interface information of the AMF. This information needs not be sent in NF Discovery responses. It may be used by the NRF to update the DNS for AMF discovery by the 5G Access Network. The procedures for updating the DNS are out of scope of this specification. | +| amfOnboardingCapability | boolean | O | 0..1 | When present, this IE indicates the AMF supports SNPN Onboarding capability. This is used for the case of Onboarding of UEs for SNPNs (see 3GPP TS 23.501 [2], clause 5.30.2.10).
  • - false (default): AMF does not support SNPN Onboarding;
  • - true: AMF supports SNPN Onboarding.
| +| highLatencyCom | boolean | O | 0..1 | When present, this IE indicates whether the AMF supports High Latency communication (e.g. for NR RedCap UE). This is used for CP NF to discover AMF supporting High Latency communication (see 3GPP TS 23.501 [2], clause 6.3.5).
  • - true: AMF supports High Latency communication e.g. for NR RedCap UE;
  • - false: AMF does not support High Latency communication e.g. for NR RedCap UE.
| + +The "backupInfoAmfFailure" attribute and "backupInfoAmfRemoval" attribute indicates the GUAMIs for which the AMF can act as Backup, when the serving AMF has failed or under planned removal. + +## EXAMPLE: + +When AMF-A, AMF-B and AMF-C registered their NF profiles for PLMN (e.g. MCC = 234, MNC = 15) as following: + +AMF-A NF Profile: + +``` +{ + "amfInfo": { + "guamiList": [{ "plmnId": { "mcc": "234", "mnc": "15" }, "amfId": "000001"}], + "backupInfoAmfFailure": [{ "plmnId": { "mcc": "234", "mnc": "15" }, "amfId": "000003"}] + } +} +``` + +**AMF-B NF Profile:** + +``` +{ + "amfInfo": { + "guamiList": [{ "plmnId": { "mcc": "234", "mnc": "15" }, "amfId": "000002"}], + "backupInfoAmfRemoval": [{ "plmnId": { "mcc": "234", "mnc": "15" }, "amfId": "000003"}] + } +} +``` + +**AMF-C NF Profile:** + +``` +{ + "amfInfo": { + "guamiList": [{ "plmnId": { "mcc": "234", "mnc": "15" }, "amfId": "000003"}] + } +} +``` + +When one NF consumer queries NRF with a GUAMI served by AMF-C (i.e. {"plmnId":{"mcc":"234","mnc":"15"},"amfId":"000003"}), then + +- if the NRF detects the AMF-C has failed, e.g. using heartbeat, the NRF shall return AMF-A instance as backup AMF; or +- if the NRF detects AMF-C has entered planned removal, i.e. received a de-registration request from AMF-C, the NRF shall return AMF-B instance as backup AMF. + +6.1.6.2.12 Type: SmfInfo + +**Table 6.1.6.2.12-1: Definition of type SmfInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|--------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssaiSmfInfoList | array(SnssaiSmfInfoItem) | M | 1..N | List of parameters supported by the SMF per S-NSSAI (NOTE 1). | +| tailList | array(Tai) | O | 1..N | The list of TAIs the SMF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the SMF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the SMF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the tailList attribute indicate that the SMF can be selected for any TAI in the serving network. | +| pgwFqdn | Fqdn | O | 0..1 | The FQDN of the PGW if the SMF is a combined SMF/PGW-C. | +| pgwIpAddrList | array(IpAddr) | O | 1..N | When present, this IE shall contain the PGW IP addresses of the combined SMF/PGW-C. Each PGW IP address shall be encoded as an IPv4 or an IPv6 address (i.e. not as an IPv6 prefix).

This IE allows the NF Service consumer to find the target combined SMF/PGW-C by PGW IP Address, e.g. when only PGW IP Address is available. | +| accessType | array(AccessType) | C | 1..2 | If included, this IE shall contain the access type (3GPP_ACCESS and/or NON_3GPP_ACCESS) supported by the SMF.
If not included, it shall be assumed the both access types are supported. | +| priority | integer | O | 0..1 | Priority (relative to other NFs of the same type) in the range of 0-65535, to be used for NF selection for a service request matching the attributes of the SmfInfo; lower values indicate a higher priority.

The NRF may overwrite the received priority value when exposing an NFProfile with the Nnrf_NFDiscovery service.

Absence of this attribute equals to having the same smfInfo priority as the priority defined at NFProfile/NFService level.

(NOTE 2) | +| vsmfSupportInd | boolean | O | 0..1 | This IE may be used by an SMF to explicitly indicate the support of V-SMF capability and its preference to be selected as V-SMF.

When present, this IE shall indicate whether the V-SMF capability are supported by the SMF:
- true: V-SMF capability supported by the SMF
- false: V-SMF capability not supported by the SMF.

Absence of this IE indicates the V-SMF capability support of the SMF is not specified.
(NOTE 3) | +| ismfSupportInd | boolean | O | 0..1 | This IE may be used by an SMF to explicitly indicate the support of I-SMF capability and its preference to be selected as I-SMF.

When present, this IE shall indicate whether the I-SMF capability are supported by the SMF:
- true: I-SMF capability supported by the SMF
- false: I-SMF capability not supported by the SMF.

Absence of this IE indicates the I-SMF capability support of the SMF is not specified.
(NOTE 3) | +| pgwFqdnList | array(Fqdn) | O | 1..N | When present, this attribute provides additional FQDNs to the FQDN indicated in the pgwFqdn | + +| | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | attribute. The pgwFqdnList attribute may be present if the pgwFqdn attribute is present. | +| smfOnboardingCapability | boolean | O | 0..1 | When present, this IE indicates the SMF supports SNPN Onboarding capability and User Plane Remote Provisioning. This is used for the case of Onboarding of UEs for SNPNs (see 3GPP TS 23.501 [2], clauses 5.30.2.10 and 6.2.6.2).
  • - false (default): SMF does not support SNPN Onboarding;
  • - true: SMF supports SNPN Onboarding.
(NOTE 4) | +| smfUPRPCapability | boolean | O | 0..1 | When present, this IE indicates the SMF supports User Plane Remote Provisioning (UPRP) capability. This is used for the case of Onboarding of UEs for SNPNs (see 3GPP TS 23.501 [2], clauses 5.30.2.10 and 6.2.6.2).
  • - false (default): SMF does not support UPRP;
  • - true: SMF supports UPRP.
| +| NOTE 1: If this S-NSSAIs is present in the SmfInfo and in the NFprofile, the S-NSSAIs from the SmfInfo shall prevail. | | | | | +| NOTE 2: An SMF profile may e.g. contain multiple SmfInfo entries, with each entry containing a different list of TAIs and a different priority, to differentiate the priority to select the SMF based on the user location. The priority in SmfInfo applies between SMFs or SMF Services with the same priority. | | | | | +| NOTE 3: The IE should only be registered when the SMF is configured to be preferably selected as V-SMF/I-SMF. | | | | | +| NOTE 4: The IE is deprecated and replaced by smfUPRPCapability attribute. | | | | | + +6.1.6.2.13 Type: UpfInfo + +**Table 6.1.6.2.13-1: Definition of type UpfInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssaiUpflnfoList | array(SNSSAIUpflnfoItem) | M | 1..N | List of parameters supported by the UPF per S-NSSAI (NOTE 1) | +| smfServingArea | array(string) | O | 1..N | The SMF service area(s) the UPF can serve.
If not provided, the UPF can serve any SMF service area. | +| interfaceUpflnfoList | array(InterfaceUpflnfoItem) | O | 1..N | List of User Plane interfaces configured on the UPF. When this IE is provided in the NF Discovery response, the NF Service Consumer (e.g. SMF) may use this information for UPF selection. (NOTE 7) | +| iwkEpsInd | boolean | O | 0..1 | Indicates whether interworking with EPS is supported by the UPF.
true: Supported
false (default): Not Supported | +| sxaInd | boolean | O | 0..1 | Indicates whether the UPF is configured to support Sxa interface.
true: Supported
false: Not Supported | +| pduSessionTypes | array(PduSessionType) | O | 1..N | List of PDU session type(s) supported by the UPF. The absence of this attribute indicates that the UPF can be selected for any PDU session type. | +| atsssCapability | AtsssCapability | C | 0..1 | If present, this IE shall indicate the ATSSS capability of the UPF.
If not present, the UPF shall be regarded with no ATSSS capability. | +| uelpAddrInd | boolean | O | 0..1 | Indicates whether the UPF supports allocating UE IP addresses/prefixes.
true: supported
false (default): not supported | +| tailList | array(Tai) | O | 1..N | The list of TAIIs the UPF can serve. It may contain one or more non-3GPP access TAIIs. The absence of this attribute and the taiRangeList attribute indicates that the UPF can serve the whole SMF service area defined by the smfServingArea attribute. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIIs the UPF can serve. It may contain non-3GPP access TAIIs. The absence of this attribute and the tailList attribute indicates that the UPF can serve the whole SMF service area defined by the smfServingArea attribute. (NOTE 6) | +| wAgflnfo | WAgflnfo | C | 0..1 | If present, this IE shall indicate that the UPF is collocated with W-AGF.
If not present, the UPF is not collocated with W-AGF. | +| tnzglnfo | Tngzglnfo | C | 0..1 | If present, this IE shall indicate that the UPF is collocated with TNGF.
If not present, the UPF is not collocated with TNGF. | +| twiflnfo | Twiflnfo | C | 0..1 | If present, this IE shall indicate that the UPF is collocated with TWIF.
If not present, the UPF is not collocated with TWIF. | +| preferredEpdglInfoList | array(EpdglInfo) | O | 1..N | If present, this IE shall indicate that ePDG(s) that are preferred (e.g. for traffic efficiency, distance wise or topology wise) to be served by the UPF/PGW-U. | +| preferredWagflnfoList | array(WAgflnfo) | O | 1..N | If present, this IE shall indicate that W-AGF(s) that are preferred (e.g. for traffic efficiency, distance wise or topology wise) to be served by the UPF. | +| preferredTngzglnfoList | array(Tngzglnfo) | O | 1..N | If present, this IE shall indicate that TNGF(s) that are preferred (e.g. for traffic efficiency, distance wise or topology wise) to be served by the UPF. | +| preferredTwiflnfoList | array(Twiflnfo) | O | 1..N | If present, this IE shall indicate that TWIF(s) that are preferred (e.g. for traffic efficiency, distance wise or topology wise) to be served by the UPF. | +| priority | integer | O | 0..1 | Priority (relative to other NFs of the same type) in the range of 0-65535, to be used for NF selection for a service request matching the attributes of the Upflnfo; lower values indicate a higher priority. | + +| | | | | | +|-----------------------|------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | See the precedence rules in the description of the priority attribute in NFPprofile, if Priority is also present in NFPprofile.
The NRF may overwrite the received priority value when exposing an NFPprofile with the Nnrf_NFDiscovery service.
(NOTE 2) | +| redundantGtpu | boolean | O | 0..1 | Indicates whether the UPF supports redundant GTP-U path.
true: supported
false (default): not supported | +| ipups | boolean | O | 0..1 | Indicates whether the UPF is configured for IPUPS.
(NOTE 3)

true: the UPF is configured for IPUPS.
false (default): the UPF is not configured for IPUPS. | +| dataForwarding | boolean | O | 0..1 | Indicates whether the UPF is configured for data forwarding. (NOTE 4)

When present, this IE shall be set as following:
- true: the UPF is configured for data forwarding
- false (default): the UPF is not configured for data forwarding

If the UPF is configured for data forwarding, it shall support UP network interface with type "DATA_FORWARDING". | +| supportedPfcpFeatures | string | O | 0..1 | Supported PFCP Features.

A string used to indicate the PFCP features supported by the UPF, which encodes the "UP Function Features" IE as specified in Table 8.2.25-1 of 3GPP TS 29.244 [21] (starting from Octet 5), in hexadecimal representation.

Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and each two characters shall represent one octet of "UP Function Features" IE (starting from Octet 5, to higher octets). For each two characters representing one octet, the first character representing the 4 most significant bits of the octet and the second character the 4 least significant bits of the octet.

(NOTE 5) | +| upfEvents | array(EventType) | O | 1..N | UPF event(s) exposed by the UPF | + +NOTE 1: If this S-NSSAIs is present in the UpfInfo and in the NFprofile, the S-NSSAIs from the UpfInfo shall prevail. + +NOTE 2: An UPF profile may e.g. contain multiple UpfInfo entries, with each entry containing a different list of TAIs and a different priority, to differentiate the priority to select the UPF based on the user location. The priority in UpfInfo has the least precedence, i.e. it applies between UPFs with the same priority. + +NOTE 3: Any UPF can support the IPUPS functionality. In network deployments where specific UPFs are used to provide IPUPS, UPFs configured for providing IPUPS services shall be selected to provide IPUPS. + +NOTE 4: Based on operator policies, if dedicated UPFs are preferred to be used for indirect data forwarding during handover scenarios, when setting up the indirect data forwarding tunnel, the SMF should preferably select a UPF configured for data forwarding and use the network instance indicated in the Network Instance ID associated to the DATA\_FORWARDING interface type in the interfaceUpfInfoList attribute. + +NOTE 5: The supportedPfcpFeatures shall be provisioned in addition and be consistent with the existing UPF features (atsssCapability, uelpAddrInd, redundantGtpu and ipups) in the upfInfo, e.g. if the uelpAddrInd is set to "true", then the UEIP flag shall also be set to "1" in the supportedPfcpFeatures. + +NOTE 6: This attribute should only be used by the UPF if, based on specific operator's deployment, the NRF and the SMFs intended to interwork with this UPF, have been upgraded to support this feature (i.e. to understand the definition of TAIs in the UPF profile based on ranges of TAIs). + +NOTE 7: The information elements included in the InterfaceUpfInfoItems, e.g. the Network Instance, can be used for any S-NSSAI and/or DNN which have no InterfaceUpfInfoList provisioned in the corresponding SnssaiUpfInfoItem and/or DnnUpfInfoItem. + +## 6.1.6.2.14 Type: SnssaiUpflnfoltem + +**Table 6.1.6.2.14-1: Definition of type SnssaiUpflnfoltem** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssai | ExtSnssai | M | 1 | Supported S-NSSAI (NOTE 1) | +| dnnUpflnfolList | array(DnnUpflnfolItem) | M | 1..N | List of parameters supported by the UPF per DNN | +| redundantTransport | boolean | O | 0..1 | Indicates whether the UPF supports redundant transport path on the transport layer in the corresponding network slice.
true: supported
false (default): not supported | +| interfaceUpflnfolList | array(InterfaceUpflnfolItem) | O | 1..N | This IE may be present to contain a list of User Plane interfaces configured on the UPF for the network slice. (NOTE 2) | + +NOTE 1: A UPF may register SD ranges or a wildcard SD if the NRF and all consumers of the UPF profile have been upgraded to support SD ranges and wildcard SD in this attribute. + +NOTE 2: The interfaceUpflnfolList included in this data type SnssaiUpflnfoltem shall prevail over the one included in the Upflnfol. + +## 6.1.6.2.15 Type: DnnUpflnfoltem + +Table 6.1.6.2.15-1: Definition of type DnnUpflnfoltem + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | Supported DNN. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. | +| dnaiList | array(Dnai) | O | 1..N | List of Data network access identifiers supported by the UPF for this DNN. The absence of this attribute indicates that the UPF can be selected for this DNN for any DNAI. | +| pduSessionTypes | array(PduSessionType) | O | 1..N | List of PDU session type(s) supported by the UPF for a specific DNN. The absence of this attribute indicates that the UPF can be selected for this DNN for any PDU session type supported by the UPF (see clause 6.1.6.2.13). | +| ipv4AddressRanges | array(Ipv4AddressRange) | O | 1..N | List of ranges of IPv4 addresses handled by UPF. (NOTE 1) | +| ipv6PrefixRanges | array(Ipv6PrefixRange) | O | 1..N | List of ranges of IPv6 prefixes handled by the UPF. (NOTE 1) | +| natedIpv4AddressRanges | array(Ipv4AddressRange) | O | 1..N | List of ranges of NATed IPv4 addresses. | +| natedIpv6PrefixRanges | array(Ipv6PrefixRange) | O | 1..N | List of ranges of NATed IPv6 prefixes. | +| ipv4IndexList | array(IpIndex) | O | 1..N | List of Ipv4 Index supported by the UPF. (NOTE 3) | +| ipv6IndexList | array(IpIndex) | O | 1..N | List of Ipv6 Index supported by the UPF. (NOTE 3) | +| networkInstance | string | O | 0..1 | The N6 Network Instance (See 3GPP TS 29.244 [21]) associated with the S-NSSAI and DNN. (NOTE 4) | +| dnaiNwInstanceList | map(string) | O | 1..N | Map of a network instance per DNAI for the DNN, where the key of the map is the DNAI.

When present, the value of each entry of the map shall contain a N6 network instance that is configured for the DNAI indicated by the key.

(NOTE 2) | +| interfaceUpflnfolList | array(InterfaceUpflnfoltem) | O | 1..N | This IE may be present to contain a list of User Plane interfaces configured on the UPF for the network slice and Dnn. (NOTE 5) | + +NOTE 1: The list of ranges of IPv4/v6 address may be used by the SMF to select a UPF which supports a UE static IP address received in user subscription, or when the UE IP address is to be allocated by an external server, e.g. AAA/Radius Server. + +NOTE 2: This IE may be used by the SMF to determine the Network Instance associated to a given S-NSSAI, DNN and DNAI. If this IE is not present, the SMF needs to be configured with corresponding information. + +NOTE 3: The list of IPv4/v6 Indexes may be used by the SMF to select a UPF which supports a specific IP Index received from the UDM or the PCF for a UE's PDU session. + +NOTE 4: The networkInstance IE and the dnaiNwInstanceList shall not be present simultaneously. The networkInstance IE may be used by the SMF to determine the Network Instance associated to a given S-NSSAI and DNN where DNAI(s) are not configured, i.e. the dnaiNwInstanceList is not present. If this IE is not present and the dnaiNwInstanceList is also not present, the SMF needs to be configured with corresponding information. A network instance can be associated with multiple network slices if the UP function supports the "Per Slice UP Resource Management" feature as specified in clause 5.35.1 of 3GPP TS 29.244 [21]. + +NOTE 5: The interfaceUpflnfolList included in this data type DnnUpflnfoltem shall prevail over the one included in the SnssaiUpflnfoltem. + +6.1.6.2.16 Type: SubscriptionData + +**Table 6.1.6.2.16-1: Definition of type SubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nfStatusNotificationUri | Uri | M | 1 | Callback URI where the NF Service Consumer will receive the notifications from NRF. | +| reqNfInstanceId | NfInstanceId | O | 0..1 | If present, this IE shall contain the NF instance id of the NF service consumer. | +| subscrCond | SubscrCond | O | 0..1 | If present, this attributed shall contain the conditions identifying the set of NF Instances whose status is requested to be monitored. If this attribute is not present, it means that the NF Service Consumer requests a subscription to all NFs in the NRF (NOTE 1). | +| subscriptionId | string | C | 0..1 | Subscription ID for the newly created resource. This parameter shall be absent in the request to the NRF and shall be included by NRF in the response to the subscription creation request.
Read-Only: true
Pattern: "^[0-9]{5,6}-(x3Lf57A:nid=[A-Fa-f0-9]{11}:)?[^-]+\$" | +| validityTime | DateTime | C | 0..1 | Time instant after which the subscription becomes invalid. This parameter may be sent by the client, as a hint to the server, but it shall be always sent back by the server (regardless of the presence of the attribute in the request) in the response to the subscription creation request. | +| reqNotifEvents | array(NotificationEventType) | O | 1..N | If present, this attribute shall contain the list of event types that the NF Service Consumer is interested in receiving.

If this attribute is not present, it means that notifications for all event types are requested. | +| reqNfType | NFType | C | 0..1 | An NF Service Consumer complying with this version of the specification shall include this IE. If included, this IE shall contain the NF type of the NF Service Consumer that is requesting the creation of the subscription. The NRF shall use it for authorizing the request, in the same way as the "requester-nf-type" is used in the NF Discovery service (see Table 6.2.3.2.3.1-1).

When the subscription is for a set of NF Instances, the subscription may be accepted by NRF, but it shall only generate notifications from NF Instances whose authorization parameters allow the NF Service Consumer to access their services (NOTE 2). | +| reqNfFqdn | Fqdn | O | 0..1 | This IE may be present for a subscription request within the same PLMN as the NRF. If included, this IE shall contain the FQDN of the NF Service Consumer that is requesting the creation of the subscription. The NRF shall use it for authorizing the request, in the same way as the "requester-nf-instance-fqdn" is used in the NF Discovery service (see Table 6.2.3.2.3.1-1). This IE shall be ignored by the NRF if it is received from a requester NF belonging to a different PLMN.

When the subscription is for a set of NF Instances, the subscription may be accepted by NRF, but it shall only generate notifications from NF Instances whose authorization parameters allow the NF Service Consumer to access their services (NOTE 2). | +| reqSnssais | array(ExtSnssai) | O | 1..N | If included, this IE shall contain the list of S-NSSAIs of the NF Service Consumer that is requesting the creation of the subscription. If this IE is included in a subscription request in a different PLMN, the requester NF shall provide S-NSSAI values of the target PLMN, that correspond to the S-NSSAI values | + +| | | | | | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

of the requester NF. The NRF shall use it for authorizing the request, in the same way as the "requester-snssais" is used in the NF Discovery service (see Table 6.2.3.2.3.1-1).

When the subscription is for a set of NF Instances, the subscription may be accepted by NRF, but it shall only generate notifications from NF Instances whose authorization parameters allow the NF Service Consumer to access their services (NOTE 2).

| +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|----------------------|-------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reqPerPlmnSnssais | array(PlmnSnssai) | O | 1..N |

If included, this IE shall indicate the list of S-NSSAIs supported by the NF Service Consumer in each of the PLMNs it supports. The NRF shall use it for authorizing the request, in the same way as the "per-plmn-requester-snssais" is used in the NF Discovery service (see Table 6.2.3.2.3.1-1).

When the subscription is for a set of NF Instances, the subscription may be accepted by NRF, but it shall only generate notifications from NF Instances whose authorization parameters allow the NF Service Consumer to access their services (NOTE 2).

| +| plmnId | PlmnId | O | 0..1 |

If present, this attribute contains the target PLMN ID of the NF Instance(s) whose status is requested to be monitored. (NOTE 7)

| +| nid | Nid | O | 0..1 |

If present, this attribute contains the target NID that, together with the plmnId attribute, identifies the SNPn of the NF Instance(s) whose status is requested to be monitored.

| +| onboardingCapability | boolean | O | 0..1 |

If present, this attribute indicates the NF Instance(s) whose status is requested to be monitored support SNPn Onboarding capability.

| +| notifCondition | NotifCondition | O | 0..1 |

If present, this attribute contains the conditions that trigger a notification from NRF; this attribute shall only be present if the NF Service Consumer has subscribed to changes on the NF Profile (i.e., reqNotifEvents contains the value "NF_PROFILE_CHANGED", or reqNotifEvents attribute is absent) (NOTE 3).

If this attribute is absent, it means that the NF Service Consumer does not indicate any restriction, or condition, on which attributes of the NF Profile shall trigger a notification from NRF. (NOTE 5).

| +| reqPlmnList | array(PlmnId) | C | 1..N |

This IE shall be included when subscribing to NF services in a different PLMN. It may be present when subscribing to NF services in the same PLMN. When included, this IE shall contain the PLMN ID(s) of the requester NF. (NOTE 2)

| +| reqSnpnList | array(PlmnIdNid) | C | 1..N |

This IE shall be included when the subscribing NF belongs to one or several SNPns and it subscribes to NF services of a specific SNPn. When included, this IE shall contain the SNPn ID(s) of the requester NF.

When the subscription is for a set of NF Instances, the subscription may be accepted by NRF, but it shall only generate notifications from NF Instances whose authorization parameters allow the NF Service Consumer to access their services. (NOTE 2)

| +| servingScope | array(string) | O | 1..N |

If present, this attribute indicates the target served area(s) of the NF instance(s) whose status is required to be monitored. (NOTE 4)

| +| requesterFeatures | SupportedFeatures | C | 0..1 |

Nnrf_NFManagement features supported by the NF Service Consumer that is invoking the Nnrf_NFManagement service. See clause 6.1.9.

This IE shall be included if at least one feature is supported by the NF Service Consumer.

Write-Only: true

(NOTE 6)

| +| nrfSupportedFeatures | SupportedFeatur | C | 0..1 |

Features supported by the NRF in the

| + +| | | | | | +|--|----|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| | es | | | Nnrf_NFManagement service. See clause 6.1.9.

This IE shall be included if at least one feature is supported by the NRF.

Read-Only: true | +|--|----|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|---|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| hnrfUri | Uri | C | 0..1 |

If included, this IE shall contain the API URI of the NFManagement Service (see clause 6.1.1) of the home NRF.

It shall be included if the NF Service Consumer has previously received such API URI from the NSSF in the home PLMN (see clause 6.1.6.2.11 of 3GPP TS 29.531 [42]).

| +| targetHni | Fqdn | O | 0..1 |

If present, this attribute shall contain the identification of the Default Credentials Server or the identification of the Credentials Holder.

| +| preferredLocality | string | O | 0..1 |

Preferred target NF location (e.g. geographic location, data center).

When present, the NRF should set a priority for the monitored NF instance in the notification as specified in the description of the preferred-locality in Table 6.2.3.2.3.1-1.

| +| extPreferredLocality | map(array(LocalityDescription)) | O | 1..N(1..M) |

Preferred target NF location (e.g. geographic location, data center).

The key of the map shall represent the relative priority, for the requester, of each locality description among the list of locality descriptions in this attribute, encoded as "1" (highest priority), "2", "3", ..., "n" (lowest priority). See examples in the description of the ext-preferred-locality in Table 6.2.3.2.3.1-1.

When present, the NRF should set a priority for the monitored NF instance in the notification as specified in the description of the ext-preferred-locality in Table 6.2.3.2.3.1-1.

| +| completeProfileSubscription | boolean | O | 0..1 |

This IE may be included by an SCP with the value true to request to monitor, and to be notified of, changes on the complete profile of the NF Instance (including authorization attributes such as the "allowedXXX" attributes of NFProfile and NFService data types). See clause 5.2.2.5.2.

Write-Only: true

| +|

NOTE 1: The "subscription to all NFs" may be quite demanding in terms of resources in NRF and also in terms of network traffic of the resulting notifications, so it should be authorized by NRF under very strict policies (e.g. only to a specific requesting NF, as indicated by reqNfType and reqNfFqdn attributes).

NOTE 2: The authorization parameters in NF Profile are those used by NRF to determine whether a given NF Instance / NF Service Instance can be discovered by an NF Service Consumer in order to consume its offered services (e.g. "allowedNfTypes", "allowedNfDomains", etc.). Based on operator's policies, a subscription request not including the requester's information necessary to validate the authorization parameters in NF Profiles may be rejected or may be accepted but with only generating notifications from NF Instances whose authorization parameters allow any NF Service Consumer to access their services.

NOTE 3: The subscription to load changes may be quite demanding in terms of network traffic of the resulting notifications, thus it may be limited by the NRF via appropriate configuration (e.g. granularity threshold)

NOTE 4: An NF instance may explicitly indicate the served areas in the NF profile when registered to NRF. When this IE is present, the NRF shall only monitor the NF instance(s) indicating at least one of the served areas in the list. If an NF instance has not indicated any served area in its NF profile, it shall not be monitored.

NOTE 5: If the attributes to be monitored or excluded from monitoring, included as part of the "notifCondition" attribute, refer to a specific element of an array (e.g. they refer to a specific array index of the "nfServices" attribute of the NFProfile), the NRF shall apply the same condition to all elements of the same array.

NOTE 6: If the NF Service Consumer that issued the subscription request indicated support for the "Service-Map" feature, the NRF shall send notifications of profile changes (see clause 6.1.6.2.17) affecting the list of NF Service Instances, as modifications of specific attributes of the "nfServiceList" map. Otherwise, the NRF shall send those notifications as a complete replacement of the "nfServices" array attribute.

NOTE 7: The PLMN ID should be used by the NRF as an additional subscription condition to monitor the change of target NF profile, unless the subscription is specific to one or a list of NF(s) explicitly indicated by their NF Instance ID(s), e.g. using the NfInstanceIdCond or NfInstanceIdListCond, in which case the NRF shall not use the PLMN ID provided in the subscription (if any) as an additional subscription condition to monitor the change of target NF profile.

| | | | | + +6.1.6.2.17 Type: NotificationData + +**Table 6.1.6.2.17-1: Definition of type NotificationData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| event | NotificationEventType | M | 1 | Notification type. It shall take the values "NF_REGISTERED", "NF_DEREGISTERED" or "NF_PROFILE_CHANGED". | +| nfInstanceUri | Uri | M | 1 | Uri of the NF Instance (see clause 6.1.3.3.2) associated to the notification event. | +| nfProfile | NFProfile | C | 0..1 |

New NF Profile or Updated NF Profile; it shall be present when the notification type is "NF_REGISTERED" and it may be present when the notification type is "NF_PROFILE_CHANGED".
(NOTE 3)

This IE, if present, shall not contain authorization attributes (such as the "allowedXXX" attributes of the NFProfile or NFService data types).

| +| profileChanges | array(ChangeItem) | C | 1..N | List of changes on the profile of the NF Instance associated to the notification event; it may be present when the notification type is "NF_PROFILE_CHANGED" (see NOTE 1, NOTE 2). | +| conditionEvent | ConditionEventType | C | 0..1 |

Type of event indicating whether a change of NF Profile results in that the NF Instance starts or stops being part of a given set of NF Instances, as indicated in the subscription condition (see attribute "subscrCond" in clause 6.1.6.2.16).

Type of event may also indicate whether a change of NF Profile results in that the NF Instance starts or stops being authorized to be accessed by the NF consumer, as specified in clause 5.2.2.6.2.

It can take the value "NF_ADDED" (if the NF Instance starts being part of a given set or starts being authorized to be accessed by the NF consumer) or "NF_REMOVED" (if the NF Instance stops being part of a given set or stops being authorized to be accessed by the NF consumer).

(NOTE 3)

| +| subscriptionContext | SubscriptionContext | C | 0..1 |

It shall contain data related to the subscription to which this notification belongs to, such as the subscription ID and the subscription conditions.

An NRF complying with this release of the specification shall include this attribute, to facilitate to the subscribing entity the identification of the subscription data, or context, that triggered this notification.

| +| completeNfProfile | NFProfile | C | 0..1 |

Complete new NF Profile or updated NF Profile; it shall be present when the notification type is "NF_REGISTERED" and it may be present when the notification type is "NF_PROFILE_CHANGED".
(NOTE 3)

This IE shall only be present if the NRF supports the "Complete-Profile-Subscription" feature, the "completeProfileSubscription" attribute is present and set to true in the request (see clause 6.1.6.2.16) and if the requesting entity is authorized to subscribe to the complete profile of NF instances.

This IE, if present, should contain the complete set of attributes (including, e.g. the "allowedXXX"

| + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|-------------------------------------------------------| +| | | | | attributes of the NFProfile or NFService data types). | +| NOTE 1: If "event" attribute takes the value "NF_PROFILE_CHANGED", then one and only one of the "nfProfile", "profileChanges" or "completeNfProfile" attributes shall be present. | | | | | +| NOTE 2: The NRF shall notify about NF Profile changes affecting attributes of type "array" only as a complete replacement of the whole array (i.e. it shall not notify about changes of individual array elements). | | | | | +| NOTE 3: When a change in an NF Profile results in an NF to start being part of a given set or an NF Instance starts being authorized to be accessed by the NF consumer, the NRF shall indicate such condition by including the "conditionEvent" attribute with value "NF_ADDED", and it shall include in the notification the "nfProfile" attribute with the full NF Profile of the NF Instance; the "profileChanges" attribute shall not be included. When a change in an NFProfile results in an NF to stop being part of a given set or an NF Instance stops being authorized to be accessed by the NF consumer, the NRF shall indicate such condition by including the "conditionEvent" attribute with value "NF_REMOVED", and it shall include in the notification either the "nfProfile" or the "profileChanges" attribute. The NRF should include the IE with less information if possible. | | | | | + +EXAMPLE: Notification content sent from NRF when an NF Instance has changed its profile by updating the value of the "recoveryTime" attribute of its NF Profile, and updated any attribute of any of its NF Service Instances: + +``` +{ + "event": "NF_PROFILE_CHANGED", + "nfInstanceUri": ".../nf-instances/4947a69a-f61b-4bc1-b9da-47c9c5d14b64", + "profileChanges": [ + { + "op": "REPLACE", + "path": "/recoveryTime", + "newValue": "2018-12-30T23:20:50Z" + }, + { + "op": "REPLACE", + "path": "/nfServices", + "newValue": [ ...new array content... ] + } + ] +} +``` + +6.1.6.2.18 Void + +6.1.6.2.19 Type: NFServiceVersion + +**Table 6.1.6.2.19-1: Definition of type NFServiceVersion** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| apiVersionInUri | string | M | 1 | Version of the service instance to be used in the URI for accessing the API (e.g. "v1"). | +| apiFullVersion | string | M | 1 | Full version number of the API as specified in clause 4.3.1 of 3GPP TS 29.501 [5]. | +| expiry | DateTime | O | 0..1 | Expiry date and time of the NF service. This represents the planned retirement date as specified in clause 4.3.1.5 of 3GPP TS 29.501 [5]. | + +## 6.1.6.2.20 Type: PcflInfo + +Table 6.1.6.2.20-1: Definition of type PcflInfo + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| groupId | NfGroupId | O | 0..1 | Identity of the PCF group that is served by the PCF instance.
If not provided, the PCF instance does not pertain to any PCF group.
(NOTE) | +| dnnList | array(Dnn) | O | 1..N | DNNs supported by the PCF. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile.
If not provided, the PCF can serve any DNN. | +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPIs that can be served by the PCF instance.
(NOTE) | +| gpsiRanges | array(IdentityRange) | O | 1..N | List of ranges of GPSIs that can be served by the PCF instance.
(NOTE) | +| rxDiamHost | DiameterIdentity | C | 0..1 | This IE shall be present if the PCF supports Rx interface.

When present, this IE shall indicate the Diameter host of the Rx interface for the PCF. | +| rxDiamRealm | DiameterIdentity | C | 0..1 | This IE shall be present if the PCF supports Rx interface.

When present, this IE shall indicate the Diameter realm of the Rx interface for the PCF. | +| v2xSupportInd | boolean | O | 0..1 | Indicates whether V2X Policy/Parameter provisioning is supported by the PCF.
true: Supported
false (default): Not Supported | +| proseSupportInd | boolean | O | 0..1 | Indicates whether ProSe capability is supported by the PCF.
true: Supported
false (default): Not Supported | +| proseCapability | ProseCapability | C | 0..1 | This IE shall be present if the PCF supports ProSe Capability.

When present, this IE shall indicate the supported ProSe Capability by the PCF. | +| v2xCapability | V2xCapability | C | 0..1 | This IE shall be present if the PCF supports V2X Capability.

When present, this IE shall indicate the supported V2X Capability by the PCF. | +| a2xSupportInd | boolean | O | 0..1 | Indicates whether A2X Policy/Parameter provisioning is supported by the PCF.
true: Supported
false (default): Not Supported | +| a2xCapability | A2xCapability | C | 0..1 | This IE shall be present if the PCF supports A2X Capability.

When present, this IE shall indicate the supported A2X Capability by the PCF. | +| rangingSIPosSupportInd | boolean | O | 0..1 | Indicates whether ranging and sidelink positioning capability is supported by the PCF.
true: Supported
false (default): Not Supported | +| NOTE: | If none of these parameters are provided, the PCF can serve any SUPI or GPSI managed by the PLMN of the PCF instance. If "supiRanges" and "gpsiRanges" attributes are absent, and "groupId" is present, the SUPIs / GPSIs served by this PCF instance is determined by the NRF (see 3GPP TS 23.501 [2], clause 6.2.6.2). | | | | + +## 6.1.6.2.21 Type: BsflInfo + +Table 6.1.6.2.21-1: Definition of type BsflInfo + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipv4AddressRanges | array(Ipv4AddressRange) | O | 1..N | List of ranges of IPv4 addresses handled by BSF. If not provided, the BSF can serve any IPv4 address. | +| dnnList | array(Dnn) | O | 1..N | List of DNNs handled by the BSF. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. If not provided, the BSF can serve any DNN. | +| ipDomainList | array(string) | O | 1..N | List of IPv4 address domains, as described in clause 6.2 of 3GPP TS 29.513 [28], handled by the BSF. If not provided, the BSF can serve any IP domain. | +| ipv6PrefixRanges | array(Ipv6PrefixRange) | O | 1..N | List of ranges of IPv6 prefixes handled by the BSF. If not provided, the BSF can serve any IPv6 prefix. | +| rxDiamHost | DiameterIdentity | C | 0..1 | This IE shall be present if the BSF supports Rx interface.

When present, this IE shall indicate the Diameter host of the Rx interface for the BSF. | +| rxDiamRealm | DiameterIdentity | C | 0..1 | This IE shall be present if the BSF supports Rx interface.

When present, this IE shall indicate the Diameter realm of the Rx interface for the BSF. | +| groupId | NfGroupId | O | 0..1 | Identity of the BSF group that is served by the BSF instance. If not provided, the BSF instance does not pertain to any BSF group. (NOTE) | +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPI's served by the BSF instance (NOTE) | +| gpsiranges | array(IdentityRange) | O | 1..N | List of ranges of GPSIs served by the BSF instance (NOTE) | +| NOTE: If none of these parameters are provided, the BSF can serve any SUPI or GPSI managed by the PLMN of the BSF instance. If "supiRanges" and "gpsiranges" attributes are absent, and "groupId" is present, the SUPIs / GPSIs served by this BSF instance is determined by the NRF. | | | | | + +## 6.1.6.2.22 Type: Ipv4AddressRange + +Table 6.1.6.2.22-1: Definition of type IPv4AddressRange + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------| +| start | Ipv4Addr | M | 1 | First value identifying the start of an IPv4 address range | +| end | Ipv4Addr | M | 1 | Last value identifying the end of an IPv4 address range | + +## 6.1.6.2.23 Type: Ipv6PrefixRange + +Table 6.1.6.2.23-1: Definition of type IPv6PrefixRange + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|-----------------------------------------------------------| +| start | Ipv6Prefix | M | 1 | First value identifying the start of an IPv6 prefix range | +| end | Ipv6Prefix | M | 1 | Last value identifying the end of an IPv6 prefix range | + +NOTE: When Ipv6PrefixRange is used to identify a range of IPv6 addresses served by certain NF (e.g. BSF), the range of IPv6 addresses identified by the IPv6PrefixRange shall include the entire IPv6 addresses represented by the "start" and "end" IPv6 prefixes. For example, if the "start" attribute is set to "240e:006a:0000:0000::/32" and the "end" attribute is set to "250e:006a:0000:0000::/32", the Ipv6PrefixRange identifies all the IPv6 addresses from the start IPv6 address "240e:006a:0000:0000::/32" to the end IPv6 address "250e:006a:ffff:ffff:ffff:ffff:ffff:ffff/32". + +## 6.1.6.2.24 Type: InterfaceUpflnfoItem + +Table 6.1.6.2.24-1: Definition of type InterfaceUpflnfoItem + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------|---|-------------|-----------------------------------------------------------------------------------| +| interfaceType | UPInterfaceType | M | 1 | User Plane interface type | +| ipv4EndpointAddresses | array(Ipv4Addr) | C | 1..N | Available endpoint IPv4 address(es) of the User Plane interface (NOTE 1) (NOTE 2) | +| ipv6EndpointAddresses | array(Ipv6Addr) | C | 1..N | Available endpoint IPv6 address(es) of the User Plane interface (NOTE 1) (NOTE 2) | +| endpointFqdn | Fqdn | C | 0..1 | FQDN of available endpoint of the User Plane interface (NOTE 1) (NOTE 2) | +| networkInstance | string | O | 0..1 | Network Instance (See 3GPP TS 29.244 [21]) associated to the User Plane interface | + +NOTE 1: At least one of the addressing parameters (ipv4address, ipv6address or endpointFqdn) shall be included in the InterfaceUpflnfoItem. + +NOTE 2: When interfaceType is "DATA\_FORWARDING", the SMF shall ignore these IEs. The UPF shall register a dummy FQDN or IP address for interfaceType "DATA\_FORWARDING" (for backward compatibility reason). + +## 6.1.6.2.25 Type: UriList + +Table 6.1.6.2.25-1: Definition of type UriList + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| _links | map(LinksValueSchema) | O | 1..N | See clause 4.9.4 of 3GPP TS 29.501 [5] for the description of the members.
In this map, the key "item", if present, shall contain an array of objects, where each object contains an "href" attribute containing the URI of the NF Instance.
If the response contains no URIs to return, the "_links" attribute may be absent; if it is included, it shall only contain the "self" key (i.e. the "item" key shall be absent), and the "totalItemCount" attribute shall be set to 0. | +| totalItemCount | integer | C | 0..1 | This attribute should be included in the response and it shall contain the total number of items matching the input filter criteria of the request (e.g. "nf-type"). | + +## 6.1.6.2.26 Type: N2InterfaceAmfInfo + +Table 6.1.6.2.26-1: Definition of type N2InterfaceAmfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------------|---|-------------|---------------------------------------------------------------------| +| ipv4EndpointAddress | array(Ipv4Addr) | C | 1..N | Available AMF endpoint IPv4 address(es) for N2 (see NOTE 1) | +| ipv6EndpointAddress | array(Ipv6Addr) | C | 1..N | Available AMF endpoint IPv6 address(es) for N2 (see NOTE 1) | +| amfName | AmfName | O | 0..1 | AMF Name FQDN as defined in clause 28.3.2.5 of 3GPP TS 23.003 [12]. | + +NOTE 1: At least one of the addressing parameters (ipv4address or ipv6address) shall be included. + +## 6.1.6.2.27 Type: TaiRange + +Table 6.1.6.2.27-1: Definition of type TaiRange + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|------------------------------------------| +| plmnId | PlmnId | M | 1 | PLMN ID related to the TacRange. | +| tacRangeList | array(TacRange) | M | 1..N | The range of the TACs | +| nid | Nid | O | 0..1 | NID related to the TacRange, for an SNPN | + +## 6.1.6.2.28 Type: TacRange + +Table 6.1.6.2.28-1: Definition of type TacRange + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| start | string | O | 0..1 | First value identifying the start of a TAC range, to be used when the range of TAC's can be represented as a hexadecimal range (e.g., TAC ranges). 3-octet string identifying a tracking area code, each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the TAC shall appear first in the string, and the character representing the 4 least significant bit of the TAC shall appear last in the string.
Pattern: "^[A-Fa-f0-9]{4}[A-Fa-f0-9]{6}\$" | +| end | string | O | 0..1 | Last value identifying the end of a TAC range, to be used when the range of TAC's can be represented as a hexadecimal range (e.g. TAC ranges). 3-octet string identifying a tracking area code, each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the TAC shall appear first in the string, and the character representing the 4 least significant bit of the TAC shall appear last in the string.
Pattern: "^[A-Fa-f0-9]{4}[A-Fa-f0-9]{6}\$" | +| pattern | string | O | 0..1 | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of TAC's belonging to this range. A TAC value is considered part of the range if and only if the TAC string fully matches the regular expression. | + +NOTE: Either the start and end attributes, or the pattern attribute, shall be present. + +EXAMPLE 1: TAC range. From: 543000 To: 5433E7 (i.e., 1000 TAC numbers) + JSON: { "start": "543000", "end": "5433E7" } + +EXAMPLE 2: TAC range. From: 54E000 To: 54EFFF (i.e., 4096 TAC numbers) + JSON: { "pattern": "^54E[0-9a-fA-F]{3}\$" }, or + JSON: { "start": "54E000", "end": "54EFFF" } + +6.1.6.2.29 Type: SnssaiSmfInfoItem + +**Table 6.1.6.2.29-1: Definition of type SnssaiSmfInfoItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------|---|-------------|-------------------------------------------------| +| sNssai | ExtSnssai | M | 1 | Supported S-NSSAI (NOTE) | +| dnnSmfInfoList | array(DnnSmfInfoItem) | M | 1..N | List of parameters supported by the SMF per DNN | + +NOTE: An SMF may register SD ranges or a wildcard SD if the SMF profile is not discoverable from other PLMNs and if the NRF and all consumers of the SMF profile in the same PLMN have been upgraded to support SD ranges and wildcard SD in this attribute. + +6.1.6.2.30 Type: DnnSmfInfoItem + +**Table 6.1.6.2.30-1: Definition of type DnnSmfInfoItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | Supported DNN (NOTE) or Wildcard DNN if the SMF supports all DNNs for the related S-NSSAI. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. | +| dnaiList | array(Dnai) | O | 1..N | List of DNAIs or Wildcard DNAI supported by the SMF for this DNN.
(See NOTE 2) | + +NOTE 1: For a SMF which only supports the I-SMF related functionalities, the dnn attribute may be an invalid DNN according to operator's local policy. + +NOTE 2: The Wildcard DNAI included in the "dnaiList" attribute indicates that the SMF can be selected for this DNN for any DNAI. The absence of "dnaiList" attribute does not mean that the SMF (e.g. pre-Rel-17 compliant) does not support any DNAI, but the SMF did not indicate which DNAIs it may support. + +6.1.6.2.31 Type: NrflInfo + +**Table 6.1.6.2.31-1: Definition of type NrflInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servedUdrInfo | map(UdrInfo) | O | 1..N | This attribute contains all the udrInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the udrInfo belongs to. | +| servedUdrInfoList | map(map(UdrInfo)) | O | 1..N(1..M) | This attribute contains the udrInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnstanceId to which the map entry belongs to. | +| servedUdmInfo | map(UdmInfo) | O | 1..N | This attribute contains all the udmInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the udmInfo belongs to. | +| servedUdmInfoList | map(map(UdmInfo)) | O | 1..N(1..M) | This attribute contains the udmInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnstanceId to which the map entry belongs to. | +| servedAusfInfo | map(AusfInfo) | O | 1..N | This attribute contains all the ausfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the ausfInfo belongs to. | +| servedAusfInfoList | map(map(AusfInfo)) | O | 1..N(1..M) | This attribute contains the ausfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnstanceId to which the map entry belongs to. | +| servedAmfInfo | map(AmfInfo) | O | 1..N | This attribute contains all the amfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the amfInfo belongs to. | +| servedAmfInfoList | map(map(AmfInfo)) | O | 1..N(1..M) | This attribute contains the amfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnstanceId to which the map entry belongs to. | +| servedSmfInfo | map(SmfInfo) | O | 1..N | This attribute contains all the smfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the smfInfo belongs to. | +| servedSmfInfoList | map(map(SmfInfo)) | O | 1..N(1..M) | This attribute contains the smfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnstanceId to which the map entry belongs to. | +| servedUpfInfo | map(UpfInfo) | O | 1..N | This attribute contains all the upfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the upfInfo belongs to. | +| servedUpfInfoList | map(map(UpfInfo)) | O | 1..N(1..M) | This attribute contains the upfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnstanceId to which the map entry belongs to. | +| servedPcfInfo | map(PcfInfo) | O | 1..N | This attribute contains all the pcfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the pcfInfo belongs to. | +| servedPcfInfoList | map(map(PcfInfo)) | O | 1..N(1..M) | This attribute contains the pcfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnstanceId to which the map entry belongs to. | +| servedBsfInfo | map(BsfInfo) | O | 1..N | This attribute contains all the bsfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the bsfInfo belongs to. | +| servedBsfInfoList | map(map(BsfInfo)) | O | 1..N(1..M) | This attribute contains the bsfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the | + +| | | | | | +|--|--|--|--|-------------------------------------------------| +| | | | | nfInstanceId to which the map entry belongs to. | +|--|--|--|--|-------------------------------------------------| + +| | | | | | +|--------------------|--------------------|---|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servedChfInfo | map(ChfInfo) | O | 1..N | This attribute contains all the chfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid of which the chfInfo belongs to. | +| servedChfInfoList | map(map(ChfInfo)) | O | 1..N(1..M) | This attribute contains the chfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnInstanceid to which the map entry belongs to. | +| servedNefInfo | map(NefInfo) | O | 1..N | This attribute contains all the nefInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid of which the nefInfo belongs to. | +| servedNwdaInfo | map(NwdaInfo) | O | 1..N | This attribute contains all the nwdaInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid of which the nwdaInfo belongs to. | +| servedNwdaInfoList | map(map(NwdaInfo)) | O | 1..N | This attribute contains all the nwdaInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid to which the map entry belongs to. | +| servedPscfInfoList | map(map(PscfInfo)) | O | 1..N(1..M) | This attribute contains all the pscfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid to which the map entry belongs to. | +| servedGmlcInfo | map(GmlcInfo) | O | 1..N | This attribute contains all the gmlcInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid of which the gmlcInfo belongs to. | +| servedLmfInfo | map(LmfInfo) | O | 1..N | This attribute contains all the lmfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid of which the lmfInfo belongs to. | +| servedNfInfo | map(NfInfo) | O | 1..N | This attribute contains information of other NFs without corresponding NF type specific Info extensions locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid of the NF. | +| servedHssInfoList | map(map(HssInfo)) | O | 1..N(1..M) | This attribute contains all the hssInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid to which the map entry belongs to. | +| servedUdsfInfo | map(UdsfInfo) | O | 1..N | This attribute contains all the udsfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid to which the map entry belongs to. | +| servedUdsfInfoList | map(map(UdsfInfo)) | O | 1..N(1..M) | This attribute contains the udsfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnInstanceid to which the map entry belongs to. | +| servedScpInfoList | map(ScpInfo) | O | 1..N | This attribute contains the scpInfo attribute locally configured in the NRF or that the NRF received during SCP registration. The key of the map is the nfnInstanceid to which the scpInfo belongs to. | +| servedSeppInfoList | map(SeppInfo) | O | 1..N | This attribute contains the seppInfo attribute locally configured in the NRF or that the NRF received during SEPP registration. The key of the map is the nfnInstanceid to which the seppInfo belongs to. | +| servedAanfInfoList | map(map(AanfInfo)) | O | 1..N(1..M) | This attribute contains the aanfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnInstanceid to which the map entry belongs to. | +| served5GDnmfInfo | map(5GDnmfInfo) | O | 1..N | This attribute contains all the 5GDnmfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid of which the 5GDnmfInfo belongs to. | +| servedMfaInfoList | map(MfaInfo) | O | 1..N | This attribute contains the mfaInfo attribute locally | + +| | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | configured in the NRF or that the NRF received during MFAF registration. The key of the map is the nfnInstanceId to which the mfaflnfo belongs to. | +| servedEasdflnfoList | map(map(Easdflnfo)) | O | 1..N(1..M) | This attribute contains the easdflnfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnInstanceId to which the map entry belongs to. | +| servedDccflnfoList | map(Dccflnfo) | O | 1..N | This attribute contains the dccflnfo attribute locally configured in the NRF or that the NRF received during DCCF registration. The key of the map is the nfnInstanceId to which the dccflnfo belongs to. | +| servedMbSmflnfoList | map(map(MbSmflnfo)) | O | 1..N(1..M) | This attribute contains the mbSmflnfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnInstanceId to which the map entry belongs to. | +| servedTsctslfnfoList | map(map(Tsctslfnfo)) | O | 1..N(1..M) | This attribute contains the tsctslfnfoList attribute locally configured in the NRF or that the NRF received during TSCTSF registration. The key of the map is the nfnInstanceId to which the map entry belongs to. | +| servedMbUpflnfoList | map(map(MbUpflnfo)) | O | 1..N(1..M) | This attribute contains the mbUpflnfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnInstanceId to which the map entry belongs to. | +| servedTrustAflnfo | map(TrustAflnfo) | O | 1..N | This attribute contains the trustAflnfo attribute locally configured in the NRF or that the NRF received during AF registration. The key of the map is the nfnInstanceId to which the map entry belongs to. | +| servedNssaaflnfo | map(Nssaaflnfo) | O | 1..N | This attribute contains all the nssaaflnfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceId of which the nssaaflnfo belongs to. | +| NOTE 1: The absence of these parameters means the NRF is able to serve any NF discovery request.
NOTE 2: For any of the servedxxxInfo/servedxxxInfoList attributes (other than servedNflnfo), if the data type definition of the corresponding xxxInfo attribute allows to use an empty JSON object, the registering NRF shall include in the servedxxxInfo/servedxxxInfoList a map entry with an empty JSON object as value, to indicate the registration of an NF Instance that did not include any xxxInfo/xxxInfoList attributes; otherwise, the registering NRF shall check the support of the feature "Empty-Objects-Nrf-Info" (see clause 6.1.9) in the target NRF and, if the feature is not supported, it shall use the generic servedNflnfo attribute (instead of the servedxxxInfo corresponding to its NF type) to signal the registration of such NF instance with absent xxxInfo/xxxInfoList attributes. | | | | | + +## 6.1.6.2.32 Type: ChfInfo + +Table 6.1.6.2.32-1: Definition of type ChfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supiRangeList | array(SupiRange) | O | 1..N | List of ranges of SUPIs that can be served by the CHF instance.
(NOTE 1) | +| gpsiRangeList | array(IdentityRange) | O | 1..N | List of ranges of GPSI that can be served by the CHF instance.
(NOTE 1) | +| plmnRangeList | array(PlmnRange) | O | 1..N | List of ranges of PLMNs (including the PLMN IDs of the CHF instance) that can be served by the CHF instance. If not provided, the CHF can serve any PLMN. | +| groupId | NfGroupId | O | 0..1 | Identity of the CHF group that is served by the CHF instance.
If not provided, the CHF instance does not pertain to any CHF group.
(NOTE 1) | +| primaryChfInstance | NfInstanceId | C | 0..1 | This IE shall be present if the CHF instance serves as a secondary CHF instance of another primary CHF instance. When present, it shall be set to the NF Instance Id of the primary CHF instance.

This IE shall be absent if the secondaryChfInstance is present.
(NOTE 2, NOTE 3) | +| secondaryChfInstance | NfInstanceId | C | 0..1 | This IE shall be present if the CHF instance serves as a primary CHF instance of another secondary CHF instance. When present, it shall be set to the NF Instance Id of the secondary CHF instance.

This IE shall be absent if the primaryChfInstance is present.
(NOTE 2, NOTE 3) | + +NOTE 1: If none of these parameters are provided, the CHF can serve any SUPI or GPSI managed by the PLMN of the CHF instance. If "supiRangeList" and "gpsiRangeList" attributes are absent, and "groupId" is present, the SUPIs / GPSIs served by this CHF instance is determined by the NRF (see 3GPP TS 23.501 [2], clause 6.2.6.2). + +NOTE 2: The NF Service Consumer of the CHF may use these attributes as primary/secondary redundancy mechanism, or alternatively, it may also rely on the availability of an NF Set (or NF Service Set) of CHF Instances (or CHF Service Instances) for the same purpose. + +NOTE 3: If the CHF does not provide NF set ID or NF Service Set ID in NFProfile, it shall provide one of these attributes. These attributes may be present if the CHF registers an NF set ID or NF service set ID. + +6.1.6.2.33 Void + +6.1.6.2.34 Type: PlmnRange + +**Table 6.1.6.2.34-1: Definition of type PlmnRange** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| start | string | O | 0..1 | First value identifying the start of a PLMN range. The string shall be encoded as follows:


Pattern: '[0-9]{3}[0-9]{2,3}\$' | +| end | string | O | 0..1 | Last value identifying the end of a PLMN range. The string shall be encoded as follows:


Pattern: '[0-9]{3}[0-9]{2,3}\$' | +| pattern | string | O | 0..1 | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of PLMNs belonging to this range. A PLMN value is considered part of the range if and only if the PLMN string (formatted as ) fully matches the regular expression. | + +NOTE: Either the start and end attributes, or the pattern attribute, shall be present. + +EXAMPLE 1: PLMN range. MCC 123, any MNC + +JSON: { "start": "12300", "end": "123999" } + +EXAMPLE 2: PLMN range. MCC 123, MNC within range 45 to 49 + +JSON: { "pattern": "^1234[5-9]\$" }, or + +JSON: { "start": "12345", "end": "12349" } + +EXAMPLE 3: PLMN range. MCC within range 123 to 257, any MNC + +JSON: { "start": "12300", "end": "257999" } + +## 6.1.6.2.35 Type: SubscrCond + +**Table 6.1.6.2.35-1: Definition of type SubscrCond as a list of mutually exclusive alternatives** + +| Data type | Cardinality | Description | +|----------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NfInstanceIdCond | 1 | Subscription to a given NF Instance | +| NfInstanceIdListCond | 1 | Subscription to a list of NF Instances | +| NfTypeCond | 1 | Subscription to a set of NF Instances, identified by their NF Type | +| ServiceNameCond | 1 | Subscription to a set of NF Instances that offer a certain service name | +| ServiceNameListCond | 1 | Subscription to a set of NF Instances that offer a service name in the Service Name list. | +| AmfCond | 1 | Subscription to a set of NF Instances (AMFs), belonging to a certain AMF Set and/or belonging to a certain AMF Region. | +| GuamiListCond | 1 | Subscription to a set of NF Instances (AMFs) identified by their Guamis (i.e. whose guamiList IE in the amfInfo or amfInfoList IE matches at least one of the GUAMI in the guamiList IE of the subscription). | +| NetworkSliceCond | 1 | Subscription to a set of NF Instances, identified by S-NSSAI(s) and NSI ID(s). | +| NfGroupCond | 1 | Subscription to a set of NF Instances, identified by a NF (UDM, AUSF, PCF, CHF, HSS or UDR) Group Identity. | +| NfGroupListCond | 1 | Subscription to a set of NF Instances, identified by a NF Group Identity in the NF Group Identity list. | +| NfSetCond | 1 | Subscription to a set of NF Instances belonging to a certain NF Set. | +| NfServiceSetCond | 1 | Subscription to a set of NF Service Instances, or to a set of equivalent NF Service Instances. | +| UpfCond | 1 | Subscription to a set of NF Instances (UPFs), able to serve a certain service area (i.e. SMF serving area or TAI list). | +| ScpDomainCond | 1 | Subscription to a set of NF, SCP or SEPP instances belonging to certain SCP domains. | +| NwdafCond | 1 | Subscription to a set of NF Instances (NWDAFs), identified by Analytics ID(s), S-NSSAI(s) or NWDAF Serving Area information, i.e. list of TAIs for which the NWDAF can provide analytics. | +| NefCond | 1 | Subscription to a set of NF Instances (NEFs), identified by Event ID(s) provided by AF, S-NSSAI(s), AF Instance ID, Application Identifier, External Identifier, External Group Identifier, or domain name. | +| DccfCond | 1 | Subscription to a set of NF Instances (DCCFs), identified by NF types, NF Set Id(s) or DCCF Serving Area information, i.e. list of TAIs served by the DCCF. | + +## 6.1.6.2.36 Type: NfInstanceIdCond + +**Table 6.1.6.2.36-1: Definition of type NfInstanceIdCond** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|------------------------------------------------------------------------------| +| nfInstanceId | NfInstanceId | M | 1 | NF Instance ID of the NF Instance whose status is requested to be monitored. | + +## 6.1.6.2.37 Type: NfTypeCond + +Table 6.1.6.2.37-1: Definition of type NfTypeCond + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------|-----------|---|-------------|------------------------------------------------------------------------| +| nfType | NfType | M | 1 | NF type of the NF Instances whose status is requested to be monitored. | +| NOTE: This type shall not contain the attribute "nfGroupId", to avoid that this type has a matching definition with "NfGroupCond" type. | | | | | + +## 6.1.6.2.38 Type: ServiceNameCond + +Table 6.1.6.2.38-1: Definition of type ServiceNameCond + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-------------------------------------------------------------------------------------| +| serviceName | ServiceName | M | 1 | Service name offered by the NF Instances whose status is requested to be monitored. | + +## 6.1.6.2.39 Type: AmfCond + +Table 6.1.6.2.39-1: Definition of type AmfCond + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---|-------------|------------------------------------------------------------------------------------| +| amfSetId | AmfSetId | C | 1 | AMF Set ID of the NF Instances (AMF) whose status is requested to be monitored. | +| amfRegionId | AmfRegionId | C | 1 | AMF Region ID of the NF Instances (AMF) whose status is requested to be monitored. | +| NOTE 1: At least amfSetId or amfRegionId shall be present; if both the amfRegionId and amfSetId attributes are present in the SubscriptionData, this indicates a subscription for notifications satisfying both attributes (i.e. notifications for NFs from that amfRegionId and amfSetId). | | | | | +| NOTE 2: The PLMN ID (or PLMN ID and NID) of the AMF Region and AMF Set of the NF Instances (AMF) whose status is requested to be monitored may be indicated in the plmnId attribute (or plmnId and nid attributes) in the SubscriptionData. | | | | | + +## 6.1.6.2.40 Type: GuamiListCond + +Table 6.1.6.2.40-1: Definition of type GuamiListCond + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| guamiList | array(Guami) | M | 1..N | Guamis of the NF Instances (AMFs) whose status is requested to be monitored (i.e. whose guamiList IE in the amfInfo or amfInfoList IE matches at least one of the GUAMI in the guamiList IE of the subscription). | + +## 6.1.6.2.41 Type: NetworkSliceCond + +Table 6.1.6.2.41-1: Definition of type NetworkSliceCond + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------| +| snssaiList | array(SNSSAI) | M | 1..N | S -NSSAIs of the NF Instances whose status is requested to be monitored. | +| nsiList | array(string) | O | 1..N | NSI IDs of the NF Instances whose status is requested to be monitored. | + +## 6.1.6.2.42 Type: NfGroupCond + +**Table 6.1.6.2.42-1: Definition of type NfGroupCond** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------| +| nfType | string | M | 1 | NF type (UDM, AUSF, PCF, UDR, HSS or CHF) of the NF Instances whose status is requested to be monitored. | +| nfGroupId | NfGroupId | M | 1 | Group ID of the NF Instances whose status is requested to be monitored. | + +## 6.1.6.2.43 Type: NotifCondition + +**Table 6.1.6.2.43-1: Definition of type NotifCondition** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| monitoredAttributes | array(string) | C | 1..N | List of JSON Pointers (as specified in IETF RFC 6901 [14]) of attributes in the NF Profile.

If this attribute is present, the NRF shall send notification only for changes in the attributes included in this list (see NOTE 1). | +| unmonitoredAttributes | array(string) | C | 1..N | List of JSON Pointers (as specified in IETF RFC 6901 [14]) of attributes in the NF Profile.

If this attribute is present, the NRF shall send notification for changes on any attribute, except for those included in this list (see NOTE 1). | + +NOTE 1: Attributes "monitoredAttributes" and "unmonitoredAttributes" shall not be included simultaneously + +EXAMPLE 1: The following JSON object would represent a monitoring condition where the client requests to be notified of all changes on the NF Profile, except "load" attribute. + +``` +{ + "unmonitoredAttributes": [ "/load" ] +} +``` + +EXAMPLE 2: The following JSON object would represent a monitoring condition where the client requests to be notified only of changes on attribute "nfStatus": + +``` +{ + "monitoredAttributes": [ "/nfStatus" ] +} +``` + +EXAMPLE 3: The following JSON object would represent a monitoring condition where the client requests to be notified only of changes on the first item of "nfServices": + +``` +{ + "monitoredAttributes": [ "/nfServices/0" ] +} +``` + +## 6.1.6.2.44 Type: PlmnSnssai + +**Table 6.1.6.2.44-1: Definition of type PlmnSnssai** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|--------------------------------------------------------------------| +| plmnId | PlmnId | M | 1 | PLMN ID for which list of supported S-NSSAI(s) is provided. | +| sNssaiList | array(ExtSnssai) | M | 1..N | The specific list of S-NSSAIs supported by the given PLMN or SNPN. | +| nid | Nid | O | 0..1 | NID for which list of supported S-NSSAI(s) is provided. | + +## 6.1.6.2.45 Type: NwdaInfo + +**Table 6.1.6.2.45-1: Definition of type NwdaInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| eventIds | array(EventId) | C | 1..N | EventId(s) supported by the Nnwdaf_AnalyticsInfo service, if none are provided the NWDAF can serve any eventId. | +| nwdafEvents | array(NwdafEvent) | C | 1..N | Event(s) supported by the Nnwdaf_EventsSubscription service, if none are provided the NWDAF can serve any nwdafEvent. | +| taiList | array(Tai) | O | 1..N | The list of TAIs the NWDAF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the NWDAF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the NWDAF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the taiList attribute indicate that the NWDAF can be selected for any TAI in the serving network. | +| nwdafCapability | NwdafCapability | O | 0..1 | If present, this IE shall indicate the capability of the NWDAF.
If not present, the NWDAF shall be regarded with no capability. | +| analyticsDelay | DurationSec | O | 0..1 | Supported Analytics Delay related to the eventIds and nwdafEvents. | +| servingNfTypeList | array(NFType) | O | 1..N | If present, this IE shall contain the list of NF type(s) from which the NWDAF NF can collect data. The absence of this attribute indicates that the NWDAF can collect data from any NF type. | +| servingNfSetIdList | array(NfSetId) | O | 1..N | If present, this IE shall contain the list of NF Set Id(s) from which the NWDAF NF can collect data. The absence of this attribute indicates that the NWDAF can collect data from any NF Set. | +| mlAnalyticsList | array(MlAnalyticsInfo) | C | 1..N | ML Analytics Filter information supported by the Nnwdaf_MLModelProvision service. | + +6.1.6.2.46 Type: LmflInfo + +**Table 6.1.6.2.46-1: Definition of type LmflInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servingClientTypes | array(ExternalClientType) | C | 1..N | This IE shall be present if the LMF is dedicated to serve the listed external client type(s), e.g. emergency client. The NRF should only include this LMF instance to NF discovery with "client-type" query parameter indicating one of the external client types in the list.

Absence of this IE means the LMF is not dedicated to serve specific client types. | +| lmfId | LMFIdentification | C | 0..1 | When present, this ID shall indicate the LMF identification. | +| servingAccessTypes | array(AccessType) | C | 1..N | If included, this IE shall contain the access type (i.e. 3GPP_ACCESS and/or NON_3GPP_ACCESS) supported by the LMF.

If not included, it shall be assumed that all access types are supported. | +| servingAnNodeTypes | array(AnNodeType) | C | 1..N | If included, this IE shall contain the AN node type (i.e. gNB or NG-eNB) supported by the LMF.

If not included, it shall be assumed that all AN node types are supported. | +| servingRatTypes | array(RatType) | C | 1..N | If included, this IE shall contain the RAT type (e.g. 5G NR, eLTE or any of the RAT Types specified for NR satellite access) supported by the LMF.

If not included, it shall be assumed that all RAT types are supported. | +| tailList | array(Tai) | O | 1..N | When present, this IE shall contain TAI list that the LMF can serve. It may contain one or more non-3GPP access TAIs.
The absence of both this attribute and the taiRangeList attribute indicates that the LMF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | When present, this IE shall contain TAI range list that the LMF can serve. It may contain one or more non-3GPP access TAI ranges. The absence of both this attribute and the tailList attribute indicates that the LMF can be selected for any TAI in the serving network. | +| supportedGADShapes | array(SupportedGADShapes) | O | 1..N | If included, this IE shall contain the GAD shapes supported by the LMF.

If not included, it doesn't indicate that the LMF doesn't support any GAD shapes. | +| pruExistenceInfo | PruExistenceInfo | O | 0..1 | When present, this IE shall contain the PRU Existence Information. | +| pruSupportInd | boolean | O | 0..1 | This IE may be used by the LMF to indicate the support of PRU function.

When the IE is present and set to true, it indicates that the PRU function is supported by the LMF.

If the IE is not present or set to false (default), it indicates that the PRU function is not supported by the LMF. | +| rangingslposSupportInd | boolean | O | 0..1 | When present, this ID shall indicate whether ranging and sidelink positioning capability is supported by the LMF.
true: Supported
false (default): Not Supported | +| upPositioningInd | boolean | O | 0..1 | When present, this IE shall indicate whether user plane positioning capability is supported by the LMF.
true: Supported
false (default): Not Supported | + +## 6.1.6.2.47 Type: GmlcInfo + +**Table 6.1.6.2.47-1: Definition of type GmlcInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servingClientTypes | array(ExternalClientType) | C | 1..N |

This IE shall be present if the GMLC is dedicated to serve the listed external client type(s), e.g. emergency client. The NRF should only include this GMLC instance to NF discovery with "client-type" query parameter indicating one of the external client types in the list.

Absence of this IE means the GMLC is not dedicated to serve specific client types.

| +| gmlcNumbers | array(string) | O | 1..N |

This IE shall be present if the GMLC is configured with a number of GMLC Numbers. When present, each item of the array shall carry an OctetString indicating the ISDN number of the GMLC in international number format as described in ITU-T Rec. E.164 [44] and shall be encoded as a TBCD-string.

Pattern for each item of the array: "[0-9]{5,15}\$"

| + +## 6.1.6.2.48 Type: NefInfo + +Table 6.1.6.2.48-1: Definition of type NefInfo + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nefId | NefId | C | 0..1 | This IE shall be present and contain the NEF ID of the NEF if NIDD service is supported. | +| pfdData | PfdData | O | 0..1 | PFD data, containing the list of internal application identifiers and/or the list of application function identifiers for which the PFDs can be provided.

Absence of this attribute indicates that the PFDs for any internal application identifier and for any application function identifier can be provided. | +| afEeData | AfEventExposure Data | O | 0..1 | The AF provided event exposure data. The NEF registers such information in the NRF on behalf of the AF. | +| gpsiRanges | array(IdentityRange) | O | 1..N | Range(s) of External Identifiers | +| externalGroupIdentifiers Ranges | array(IdentityRange) | O | 1..N | Range(s) of External Group Identifiers | +| servedFqdnList | array(string) | O | 1..N | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the Domain names served by the NEF | +| tailList | array(Tai) | O | 1..N | The list of TAIs the NEF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicates that the NEF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the NEF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the tailList attribute indicates that the NEF can be selected for any TAI in the serving network. | +| dnaiList | array(Dnai) | O | 1..N | List of Data network access identifiers supported by the NEF. The absence of this attribute indicates that the NEF can be selected for any DNAI. | +| unTrustAflInfoList | array(UnTrustAflInfo) | O | 1..N | List of information corresponding to the AFs. | +| uasNfFunctionalityInd | boolean | O | 0..1 | When present, this IE shall indicate whether the NEF supports UAS NF functionality:

- true: UAS NF functionality is supported by the NEF
- false (default): UAS NF functionality is not supported by the NEF. | +| multiMemAfSessQosInd | boolean | O | 0..1 | When present, this IE shall indicate whether the NEF supports Multi-member AF session with required QoS functionality:

- true: Multi-member AF session with required QoS functionality is supported by the NEF
- false (default): Multi-member AF session with required QoS functionality is not supported by the NEF. | +| memberUESelAssistInd | boolean | O | 0..1 | When present, this IE shall indicate whether the NEF supports member UE selection assistance functionality:

- true: member UE selection assistance functionality is supported by the NEF
- false (default): member UE selection assistance functionality is not supported by the NEF. | + +## 6.1.6.2.49 Type: PfdData + +Table 6.1.6.2.49-1: Definition of type PfdData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|---------------------------------------------------------------| +| appIds | array(string) | O | 1..N | List of internal application identifiers of the managed PFDs. | +| afIds | array(string) | O | 1..N | List of application function identifiers of the managed PFDs. | + +## 6.1.6.2.50 Type: AfEventExposureData + +Table 6.1.6.2.50-1: Definition of type AfEventExposureData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| afEvents | array(AfEvent) | M | 1..N | AF Event(s) exposed by the NEF after registration of the AF(s) at the NEF. | +| afIds | array(string) | O | 1..N | Associated AF identifications to the AfEvents. The absence of this attribute indicate that the NEF can be selected for any AF.
If present the ordered list of afIds shall contain as many elements as the ordered list of afEvents, where the ordering determines the association between afId and AfEvent. | +| appIds | array(string) | O | 1..N | The list of Application ID(s) the AF(s) connected to the NEF supports. The absence of this attribute indicate that the NEF can be selected for any Application.
If present the ordered list of appIds shall contain as many elements as the ordered list of afEvents, where the ordering determines the association between appId and AfEvent. | +| tailList | array(Tai) | O | 1..N | This IE may be present if the AfEvent is set to "GNSS_ASSISTANCE_DATA".
When present, this IE shall contain the list of TAIs the trusted AF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the trusted AF can be selected for any TAI in the serving network. | +| tailRangeList | array(TaiRange) | O | 1..N | This IE may be present if the AfEvent is set to "GNSS_ASSISTANCE_DATA".
When present, this IE shall contain the range of TAIs the trusted AF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the tailList attribute indicate that the trusted AF can be selected for any TAI in the serving network. | + +## 6.1.6.2.51 Type: WAgfInfo + +Table 6.1.6.2.51-1: Definition of type WAgfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------|---|-------------|----------------------------------------------------------------------| +| ipv4EndpointAddresses | array(Ipv4Addr) | C | 1..N | Available endpoint IPv4 address(es) of the N3 terminations (NOTE 1). | +| ipv6EndpointAddresses | array(Ipv6Addr) | C | 1..N | Available endpoint IPv6 address(es) of the N3 terminations (NOTE 1). | +| endpointFqdn | Fqdn | C | 0..1 | Available endpoint FQDN of the N3 terminations (NOTE 1). | + +NOTE 1: At least one of the addressing parameters (ipv4address, ipv6adress or endpointFqdn) shall be included in the WAgfInfo. + +## 6.1.6.2.52 Type: TngfInfo + +Table 6.1.6.2.52-1: Definition of type TngfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------|---|-------------|----------------------------------------------------------------------| +| ipv4EndpointAddresses | array(Ipv4Addr) | C | 1..N | Available endpoint IPv4 address(es) of the N3 terminations (NOTE 1). | +| ipv6EndpointAddresses | array(Ipv6Addr) | C | 1..N | Available endpoint IPv6 address(es) of the N3 terminations (NOTE 1). | +| endpointFqdn | Fqdn | C | 0..1 | Available endpoint FQDN of the N3 terminations (NOTE 1). | + +NOTE 1: At least one of the addressing parameters (ipv4address, ipv6address or endpointFqdn) shall be included in the TngfInfo. + +## 6.1.6.2.53 Type: PscfInfo + +Table 6.1.6.2.53-1: Definition of type PscfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| accessType | array(AccessType) | C | 1..N | If included, this IE shall contain the access type (3GPP_ACCESS and/or NON_3GPP_ACCESS) supported by the P-CSCF.
If not included, it shall be assumed that all access types are supported. | +| dnnList | array(Dnn) | O | 1..N | DNNs supported by the P-CSCF. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile.
If not provided, the P-CSCF can serve any DNN. | +| gmFqdn | Fqdn | O | 0..1 | FQDN of the P-CSCF for the Gm interface | +| gmlpv4Addresses | array(Ipv4Addr) | O | 1..N | IPv4 address(es) of the P-CSCF for the Gm interface | +| gmlpv6Addresses | array(Ipv6Addr) | O | 1..N | IPv6 address(es) of the P-CSCF for the Gm interface | +| mwFqdn | Fqdn | O | 0..1 | FQDN of the P-CSCF for the Mw interface (NOTE) | +| mwlpv4Addresses | array(Ipv4Addr) | O | 1..N | IPv4 address(es) of the P-CSCF for the Mw interface (NOTE) | +| mwlpv6Addresses | array(Ipv6Addr) | O | 1..N | IPv6 address(es) of the P-CSCF for the Mw interface (NOTE) | +| servedIpv4AddressRanges | array(Ipv4AddressRange) | O | 1..N | List of ranges of UE IPv4 addresses used on the Gm interface, served by P-CSCF.
The absence of this attribute does not mean the P-CSCF can serve any IPv4 address. | +| servedIpv6PrefixRanges | array(Ipv6PrefixRange) | O | 1..N | List of ranges of UE IPv6 prefixes used on the Gm interface, served by P-CSCF.
The absence of this attribute does not mean the P-CSCF can serve any IPv6 prefix. | + +NOTE: The Mw addressing information of the P-CSCF may be used by other NFs (e.g., SMF) in P-CSCF restoration scenarios (see 3GPP TS 23.380 [45], clause 5.8.4.2 and clause 5.8.5.2), where a mapping between Gm and Mw addresses may be used to determine the updated list of P-CSCFs to be sent to the UE, after excluding those P-CSCF instances that have been deemed as failed by the S-CSCF. + +## 6.1.6.2.54 Type: NfSetCond + +**Table 6.1.6.2.54-1: Definition of type NfSetCond** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------| +| nfSetId | NfSetId | M | 1 | NF Set ID (see clause 28.12 of 3GPP TS 23.003 [12]) of NF Instances whose status is requested to be monitored. | + +## 6.1.6.2.55 Type: NfServiceSetCond + +**Table 6.1.6.2.55-1: Definition of type NfServiceSetCond** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nfServiceSetId | NfServiceSetId | M | 1 | NF Service Set ID (see clause 28.13 of 3GPP TS 23.003 [12]) of NF service instances whose status is requested to be monitored. | +| nfSetId | NfSetId | C | 0..1 | NF Set ID (see clause 28.12 of 3GPP TS 23.003 [12]).

This attribute shall be included if the consumer requests to monitor the status of all equivalent NF Service Instances in the provided NF Set ID and NF Service Set ID. | + +## 6.1.6.2.56 Type: NfInfo + +**Table 6.1.6.2.56-1: Definition of type NfInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------| +| nfType | NFType | M | 1 | This IE shall indicate the type of the NF. | + +## 6.1.6.2.57 Type: HssInfo + +Table 6.1.6.2.57-1: Definition of type HssInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------|-----------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| groupId | NfGroupId | O | 0..1 | Identity of the HSS group that is served by the HSS instance.
If not provided, the HSS instance does not pertain to any HSS group.
(NOTE 1) | +| imsiRanges | array(ImsiRange) | O | 1..N | List of ranges of IMSIs whose profile data is available in the HSS instance (NOTE 1) | +| imsPrivateIdentityRanges | array(IdentityRange) | O | 1..N | List of ranges of IMS Private Identities whose profile data is available in the HSS instance (NOTE 1, NOTE 2) | +| imsPublicIdentityRanges | array(IdentityRange) | O | 1..N | List of ranges of IMS Public Identities whose profile data is available in the HSS instance (NOTE 1) | +| msisdnRanges | array(IdentityRange) | O | 1..N | List of ranges of MSISDNs whose profile data is available in the HSS instance (NOTE 1) | +| externalGroupIdentifiersRanges | array(IdentityRange) | O | 1..N | List of ranges of external group IDs that can be served by this HSS instance.
If not provided, the HSS instance does not serve any external groups. | +| hssDiameterAddress | NetworkNodeDiameterAddress | O | 0..1 | Diameter Address of the HSS | +| additionalDiamAddresses | array(NetworkNodeDiameterAddress) | O | 1..N | Additional Diameter Addresses of the HSS; may be present if hssDiameterAddress is present | + +NOTE 1: If none of these parameters are provided, the HSS can serve any IMSI or IMS Private Identity or IMS Public Identity or MSISDN managed by the PLMN of the HSS instance. If "imsiRanges", "imsPrivateIdentityRanges", "imsPublicIdentityRanges" and "msisdnRanges" attributes are absent, and "groupId" is present, the IMSIs / IMS Private Identities / IMS Public Identities / MSISDNs served by this HSS instance is determined by the NRF. + +NOTE 2: In deployments where the users IMPIs are derived from their IMSIs (see 3GPP TS 23.003 [12], clause 13.3, the HSS shall only register imsiRanges in NRF. + +## 6.1.6.2.58 Type: ImsiRange + +Table 6.1.6.2.58-1: Definition of type ImsiRange + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| start | string | O | 0..1 | First value identifying the start of a IMSI range.
Pattern: "^[0-9]+\$" | +| end | string | O | 0..1 | Last value identifying the end of a IMSI range.
Pattern: "^[0-9]+\$" | +| pattern | string | O | 0..1 | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of IMSIs belonging to this range. An IMSI value is considered part of the range if and only if the IMSI string fully matches the regular expression. | + +NOTE: Either the start and end attributes, or the pattern attribute, shall be present. + +## 6.1.6.2.59 Type: InternalGroupIdRange + +**Table 6.1.6.2.59-1: Definition of type InternalGroupIdRange** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| start | GroupId | O | 0..1 | First value identifying the start of an identity range, to be used when the range of identities can be represented as a consecutive numeric range. | +| end | GroupId | O | 0..1 | Last value identifying the end of an identity range, to be used when the range of identities can be represented as a consecutive numeric range. | +| pattern | string | O | 0..1 | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of identities belonging to this range. An identity value is considered part of the range if and only if the identity string fully matches the regular expression. | + +NOTE: Either the start and end attributes, or the pattern attribute, shall be present. + +## 6.1.6.2.60 Type: UpfCond + +**Table 6.1.6.2.60-1: Definition of type UpfCond** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionType | string | M | 1 | This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive.
In this data type, it shall take the value "UPF_COND". | +| smfServingArea | array(string) | C | 1..N | SMF service area(s) of the UPF whose status is requested to be monitored.
This IE shall be present if the monitored granularity is SMF service area(s). | +| taiList | array(Tai) | C | 1..N | TAI(s) of the UPF whose status is requested to be monitored.
This IE shall be present if the monitored granularity is TAI list. | + +## 6.1.6.2.61 Type: TwifiInfo + +**Table 6.1.6.2.61-1: Definition of type TwifiInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------|---|-------------|---------------------------------------------------------------------| +| ipv4EndpointAddresses | array(Ipv4Addr) | C | 1..N | Available endpoint IPv4 address(es) of the N3 terminations (NOTE 1) | +| ipv6EndpointAddresses | array(Ipv6Addr) | C | 1..N | Available endpoint IPv6 address(es) of the N3 terminations (NOTE 1) | +| endpointFqdn | Fqdn | C | 0..1 | Available endpoint FQDN of the N3 terminations (NOTE 1) | + +NOTE 1: At least one of the addressing parameters (ipv4address, ipv6address or endpointFqdn) shall be included in the TwifiInfo. + +## 6.1.6.2.62 Type: VendorSpecificFeature + +**Table 6.1.6.2.62-1: Definition of type VendorSpecificFeature** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| featureName | string | M | 1 | String representing a proprietary feature specific to a given vendor.

It is recommended that the case convention for these strings is the same as for enumerated data types (i.e. UPPER_WITH_UNDERSCORE; see 3GPP TS 29.501 [5], clause 5.1.1). | +| featureVersion | string | M | 1 | String representing the version of the feature.

It is recommended that the versioning system follows the Semantic Versioning Specification [39]. | + +## 6.1.6.2.63 Type: UdsfInfo + +**Table 6.1.6.2.63-1: Definition of type UdsfInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|---------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| groupId | NfGroupId | O | 0..1 | Identity of the UDSF group that is served by the UDSF instance.
If not provided, the UDSF instance does not pertain to any UDSF group. | +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPIs whose profile data is available in the UDSF instance (NOTE 1) | +| storageIdRanges | map(array(IdentityRange)) | C | 1..N(1..M) | A map (list of key-value pairs) where realmId serves as key and each value in the map is an array of IdentityRanges. Each IdentityRange is a range of storageIds. A UDSF complying with this version of the specification shall include this IE. Absence indicates that the UDSF's supported realms and storages are determined by the UDSF's consumer by other means such as local provisioning. | + +NOTE 1: If this parameter is not provided, then the UDSF can serve any SUPI range. + +## 6.1.6.2.64 Type: NfInstanceIdListCond + +**Table 6.1.6.2.64-1: Definition of type NfInstanceIdListCond** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|---------------------|---|-------------|-------------------------------------------------------------------| +| nfInstanceIdList | array(NfInstanceId) | C | 1..N | A list of NF Instances whose status is requested to be monitored. | + +6.1.6.2.65 Type: ScpInfo + +**Table 6.1.6.2.65-1: Definition of type ScpInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| scpDomainInfoList | map(ScpDomainInfo) | O | 1..N | SCP domain specific information of the SCP that differs from the common information in NFPProfile data type. The key of the map shall be the string identifying an SCP domain. | +| scpPrefix | string | O | 0..1 | Optional deployment specific string used to construct the apiRoot of the next hop SCP, as described in clause 6.10 of 3GPP TS 29.500 [4]. | +| scpPorts | map(integer) | C | 1..N |

SCP port number(s) for HTTP and/or HTTPS (NOTE 1)

This attribute shall be present if the SCP uses non-default HTTP and/or HTTPS ports and if the SCP does not provision port information within ScpDomainInfo for each SCP domain it belongs to.

When present, it shall contain the HTTP and/or HTTPS ports.

The key of the map shall be "http" or "https".
The value shall indicate the port number for HTTP or HTTPS respectively.
Minimum: 0 Maximum: 65535

| +| addressDomains | array(string) | O | 1..N |

Pattern (regular expression according to the ECMA-262 dialect [8]) representing the address domain names reachable through the SCP.

Absence of this IE indicates the SCP can reach any address domain names in the SCP domain(s) it belongs to.

| +| ipv4Addresses | array(Ipv4Addr) | O | 1..N |

List of IPv4 addresses reachable through the SCP.

This IE may be present if IPv4 addresses are reachable via the SCP.

If IPv4 addresses are reachable via the SCP, absence of both this IE and ipv4AddrRanges IE indicates the SCP can reach any IPv4 addresses in the SCP domain(s) it belongs to.

| +| ipv6Prefixes | array(Ipv6Prefix) | O | 1..N |

List of IPv6 prefixes reachable through the SCP.

This IE may be present if IPv6 addresses are reachable via the SCP.

If IPv6 addresses are reachable via the SCP, absence of both this IE and ipv6PrefixRanges IE indicates the SCP can reach any IPv6 prefixes in the SCP domain(s) it belongs to.

| +| ipv4AddrRanges | array(Ipv4AddressRange) | O | 1..N |

List of IPv4 addresses ranges reachable through the SCP.

This IE may be present if IPv4 addresses are reachable via the SCP.

If IPv4 addresses are reachable via the SCP, absence of both this IE and ipv4Addresses IE indicates the SCP can reach any IPv4 addresses in the SCP domain(s) it belongs to.

| +| ipv6PrefixRanges | array(Ipv6PrefixRange) | O | 1..N |

List of IPv6 prefixes ranges reachable through the SCP.

This IE may be present if IPv6 addresses are reachable via the SCP.

If IPv6 addresses are reachable via the SCP, absence of both this IE and ipv6Prefixes IE indicates the SCP can reach any IPv6 prefixes in the SCP

| + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | domain(s) it belongs to. | +| servedNfSetIdList | array(NfSetId) | O | 1..N | List of NF set ID of NFs served by the SCP.

Absence of this IE indicates the SCP can reach any NF set in the SCP domain(s) it belongs to. | +| remotePlmnList | array(PlmnId) | O | 1..N | List of remote PLMNs reachable through the SCP.

Absence of this IE indicates that no remote PLMN is reachable through the SCP. | +| remoteSnpnList | array(PlmnIdNid) | O | 1..N | List of remote SNPNS reachable through the SCP.
The absence of this IE indicates that no remote SNPN is reachable through the SCP. | +| ipReachability | IpReachability | O | 0..1 | This IE may be present to indicate the type(s) of IP addresses reachable via the SCP in the SCP domain(s) it belongs to.

Absence of this IE indicates that the SCP can be used to reach both IPv4 addresses and IPv6 addresses in the SCP domain(s) it belongs to. | +| scpCapabilities | array(ScpCapability) | C | 0..N | List of SCP capabilities supported by the SCP.
This IE shall be present if the SCP supports at least one SCP capability. It may be present otherwise, with an empty array, to indicate that the SCP does not support any capability of the ScpCapability data type. The absence of this attribute shall not be interpreted as an SCP that does not support any capability; this only means that the SCP (e.g. pre-Rel-17 SCP) did not register the capabilities it may support.
(NOTE 2) | +| NOTE 1: If no SCP port information is present in ScpInfo or in ScpDomainInfo for a specific SCP domain, the HTTP client shall use the default HTTP port number, i.e. TCP port 80 for "http" URIs or TCP port 443 for "https" URIs as specified in IETF RFC 9113 [9] when sending a request to the SCP within the specific SCP domain. | | | | | +| NOTE 2: This IE may be used by another SCP (e.g. SCP-c) to determine whether next hops' SCP(s) (e.g. SCP-p) supports Indirect Communication with Delegated Discovery, e.g. in scenarios with more than one SCP between an NF service consumer and NF service producer. This information is not intended for NF service consumers. This information shall not be used for selecting a next hop SCP. It may only be used by an SCP, once a next hop SCP is selected, to learn the capabilities of the selected SCP, and based on local policy, to determine whether to delegate the selection of the target NF service producer instance to the next hop SCP or not. | | | | | + +## 6.1.6.2.66 Type: ScpDomainInfo + +Table 6.1.6.2.66-1: Definition of type ScpDomainInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| scpFqdn | Fqdn | C | 0..1 | FQDN of the SCP (NOTE) | +| scpIpEndPoints | array(IpEndPoint) | C | 1..N | IP address(es) and port information of the SCP.
If port information is present in this attribute, it applies to any scheme (i.e. HTTP and HTTPS). (NOTE) | +| scpPorts | map(integer) | C | 1..N | SCP port number(s) for HTTP and/or HTTPS.

This attribute shall be present if the SCP uses different ports for HTTP and HTTPS and at least one port is not the default HTTP or HTTPS port, for this SCP domain. This attribute shall be absent if port information is present in the scpIpEndPoints.

When present, it shall contain the HTTP and/or HTTPS ports.

The key of the map shall be "http" or "https".
The value shall indicate the port number for HTTP or HTTPS respectively.
Minimum: 0 Maximum: 65535

If this attribute is present, it has precedence over the scpPorts attribute of ScpInfo. | +| scpPrefix | string | O | 0..1 | Optional deployment specific string used to construct the apiRoot of the next hop SCP, as described in clause 6.10 of 3GPP TS 29.500 [4].
If the scpPrefix attribute is present in ScpInfo and in ScpDomainInfo for a specific SCP domain, the attribute in ScpDomainInfo shall prevail for this SCP domain. | +| NOTE: If any of these attributes is present for a given SCP domain, it shall apply instead of the attributes fqdn, Ipv4Addresses and Ipv6Addresses within the NFProfile data type for the corresponding SCP Domain. If none of these attributes is present for a given SCP domain, the attributes fqdn, Ipv4Addresses, and Ipv6Addresses within the NFProfile data type shall apply for the corresponding SCP Domain. | | | | | + +## 6.1.6.2.67 Type: ScpDomainCond + +Table 6.1.6.2.67-1: Definition of type ScpDomainCond + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| scpDomains | array(string) | M | 1..N | SCP domains of NF, SCP or SEPP instances whose status is requested to be monitored. | +| nfTypeList | array(NFType) | C | 1..N | This IE shall be present if available.
When present, it shall contain the type of the NF Instances or Network Entities (pertaining to any SCP domain in the scpDomains attribute) whose status is requested to be monitored.
If not present, it means that the NF Service Consumer requests a subscription to all NF, SCP and SEPP instances pertaining to any SCP domain in the scpDomains attribute. | + +## 6.1.6.2.68 Type: OptionsResponse + +**Table 6.1.6.2.68-1: Definition of type OptionsResponse** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supportedFeatures | SupportedFeatures | C | 0..1 | Supported features of the NRF, for the nf-instances store resource. See clause 6.1.9.

This IE shall be included if at least one Nnrf_NFManagement feature is supported by the NRF. | + +## 6.1.6.2.69 Type: NwdafCond + +**Table 6.1.6.2.69-1: Definition of type NwdafCond** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionType | string | M | 1 | This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive.
In this data type, it shall take the value "NWDAF_COND". | +| analyticsIds | array(string) | O | 1..N | Analytics Id(s) provided by consumers of NWDAF. In this data type, it shall take the value as defined in NwdafEvent IE and EventId IE in nwdafInfo. | +| snssaiList | array(SNSSAI) | O | 1..N | S-NSSAIs of the NWDAF whose status is requested to be monitored. | +| taiList | array(TAI) | O | 1..N | TAI(s) of the NWDAF whose status is requested to be monitored. It may contain one or more non-3GPP access TAIs. | +| taiRangeList | array(TAIRange) | O | 1..N | The range of TAIs of the NWDAF whose status is requested to be monitored. It may contain non-3GPP access TAIs. | +| servingNfTypeList | array(NFType) | O | 1..N | NF type(s) served by the NWDAF whose status is requested to be monitored. | +| servingNfSetIdList | array(NfSetId) | O | 1..N | NF Set Id(s) served by the NWDAF whose status is requested to be monitored. | +| mlAnalyticsList | array(MLAnalyticsInfo) | C | 1..N | The list of ML Analytics Filter information per Analytics ID(s) supported by the NWDAF, whose status is requested to be monitored. | + +## 6.1.6.2.70 Type: NefCond + +**Table 6.1.6.2.70-1: Definition of type NefCond** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionType | string | M | 1 | This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive.
In this data type, it shall take the value "NEF_COND". | +| afEvents | array(AfEvent) | O | 1..N | EventId(s) supported by the AFs. | +| snssaiList | array(SNSSAI) | O | 1..N | S-NSSAIs of the NEF whose status is requested to be monitored. | +| pfdData | PfdData | O | 0..1 | PFD data of the NEF whose status is requested to be monitored. | +| gpsiRanges | array(IdentityRange) | O | 1..N | Range(s) of External Identifiers of the NEF whose status is requested to be monitored. | +| externalGroupIdentifiers | array(IdentityRange) | O | 1..N | Range(s) of External Group Identifiers of the NEF whose status is requested to be monitored. | +| servedFqdnList | array(string) | O | 1..N | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the Domain names of the NEF whose status is requested to be monitored. | + +## 6.1.6.2.71 Type: SuciInfo + +**Table 6.1.6.2.71-1: Definition of type SuciInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------|----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| routingInds | array(string) | O | 1..N | Indicating served Routing Indicator (see 3GPP TS 23.003 [12], clause 2.2B). If not provided, the AUSF/UDM can serve any Routing Indicator. | +| hNwPubKeyIds | array(integer) | O | 1..N | Indicating served Home Network Public Key (see 3GPP TS 23.003 [12], clause 2.2B). If not provided, the AUSF/UDM can serve any public key. | +| NOTE: Any combination of any routingInds value and any hNwPubKeyIds value is valid. | | | | | + +## 6.1.6.2.72 Type: SeppInfo + +Table 6.1.6.2.72-1: Definition of type SeppInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| seppPrefix | string | O | 0..1 | Optional deployment specific string used to construct the apiRoot of the next hop SEPP, as described in clause 6.10 of 3GPP TS 29.500 [4]. | +| seppPorts | map(integer) | C | 1..N | SEPP port number(s) for HTTP and/or HTTPS (NOTE 1)
This attribute shall be present if the SEPP uses non-default HTTP and/or HTTPS ports. When present, it shall contain the HTTP and/or HTTPS ports.

The key of the map shall be "http" or "https".
The value shall indicate the port number for HTTP or HTTPS respectively.
Minimum: 0 Maximum: 65535 | +| remotePlmnList | array(PlmnId) | O | 1..N | List of remote PLMNs reachable through the SEPP. The absence of this attribute indicates that any PLMN is reachable through the SEPP. | +| remoteSnpnList | array(PlmnIdNid) | O | 1..N | List of remote SNPNS reachable through the SEPP. The absence of this attribute indicates that no SNPN is reachable through the SEPP. | +| n32Purposes | array(N32Purpose) | C | 1..N | This IE should be present if the SEPP is configured to support specific N32 purposes. When present, it shall contain the list of N32 purposes supported by the SEPP.
The absence of this IE indicates that the SEPP can be selected for any N32 purpose. | + +NOTE 1: If no SEPP port information is present in SeppInfo, the HTTP client shall use the default HTTP port number, i.e. TCP port 80 for "http" URIs or TCP port 443 for "https" URIs as specified in IETF RFC 9113 [9] when sending a request to the SEPP. + +NOTE 2: The attributes fqdn, ipv4Addresses and ipv6Addresses within the NFProfile data type shall be used to determine the SEPP address. + +## 6.1.6.2.73 Type: AanfInfo + +Table 6.1.6.2.73-1: Definition of type AanfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| routingIndicators | array(string) | O | 1..N | List of Routing Indicators supported by the Aanf instance. If not provided, the Aanf can serve any Routing Indicator.
Pattern: '^[0-9]{1,4}\$' | + +## 6.1.6.2.74 Type: 5GDnmfInfo + +Table 6.1.6.2.74-1: Definition of type 5GDnmfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------| +| plmnId | PlmnId | M | 1 | PLMN ID of the PLMN which the 5G DDNMF served. | + +## 6.1.6.2.75 Type: MfaflInfo + +**Table 6.1.6.2.75-1: Definition of type MfaflInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servingNfTypeList | array(NFType) | O | 1..N | If present, this IE shall contain the list of NF type(s) served by MFAF NF. The absence of this attribute indicates that the MFAF can be selected for any NF type | +| servingNfSetIdList | array(NfSetId) | O | 1..N | If present, this IE shall contain the list of NF Set Id(s) served by MFAF NF. The absence of this attribute indicates that the MFAF can be selected for any NF Set Id. | +| taiList | array(Tai) | O | 1..N | The list of TAIs the MFAF can serve. It may contain one or more non-3GPP access TAIs. The absence of both this attribute and the taiRangeList attribute indicates that the MFAF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the MFAF can serve. It may contain one or more non-3GPP access TAI ranges. The absence of both this attribute and the taiList attribute indicates that the MFAF can be selected for any TAI in the serving network. | + +## 6.1.6.2.76 Type: NwdafCapability + +**Table 6.1.6.2.76-1: Definition of type NwdafCapability** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| analyticsAggregation | boolean | O | 0..1 | When present, this IE shall indicate whether the NWDAF supports analytics aggregation:

- true: analytics aggregation capability is supported by the NWDAF
- false (default): analytics aggregation capability is not supported by the NWDAF. | +| analyticsMetadataProvisioning | boolean | O | 0..1 | When present, this IE shall indicate whether the NWDAF supports analytics metadata provisioning:

- true: analytics metadata provisioning capability is supported by the NWDAF
- false (default): analytics metadata provisioning capability is not supported by the NWDAF. | +| mlModelAccuracyChecking | boolean | O | 0..1 | When present, this IE shall indicate whether the NWDAF containing MTLF supports ML model accuracy checking:

- true: ML model accuracy checking capability is supported by the NWDAF
- false (default): ML model accuracy checking capability is not supported by the NWDAF. | +| analyticsAccuracyChecking | boolean | O | 0..1 | When present, this IE shall indicate whether the NWDAF containing AnLF supports Analytics accuracy checking:

- true: Analytics accuracy checking capability is supported by the NWDAF
- false (default): Analytics accuracy checking capability is not supported by the NWDAF. | +| roamingExchange | boolean | O | 0..1 | When present, this IE shall indicate whether the NWDAF supports roaming exchange capability:

- true: roaming exchange capability is supported by the NWDAF
- false (default): roaming exchange capability is not supported by the NWDAF. | + +## 6.1.6.2.77 Type: EasdfInfo + +**Table 6.1.6.2.77-1: Definition of type EasdfInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------|----------------------------|---|-------------|--------------------------------------------------------------| +| sNssaiEasdfInfoList | array(SnssaiEasdfInfoItem) | O | 1..N | List of parameters supported by the EASDF per S-NSSAI (NOTE) | +| easdfN6IpAddressList | array(IpAddr) | O | 1..N | N6 IP addresses of the EASDF | +| upfN6IpAddressList | array(IpAddr) | O | 1..N | N6 IP addresses of PSA UPFs | +| NOTE: If S-NSSAIs are present in the EasdfInfo and in the NFprofile, the S-NSSAIs from the EasdfInfo shall prevail. | | | | | + +## 6.1.6.2.78 Type: SnssaiEasdflnfoltem + +Table 6.1.6.2.78-1: Definition of type SnssaiEasdflnfoltem + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-------------------------|---|-------------|---------------------------------------------------| +| sNssai | ExtSnssai | M | 1 | S-NSSAI | +| dnnEasdflnfoltemList | array(DnnEasdflnfoltem) | M | 1..N | List of parameters supported by the EASDF per DNN | + +## 6.1.6.2.79 Type: DnnEasdflnfoltem + +Table 6.1.6.2.79-1: Definition of type DnnEasdflnfoltem + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | Supported DNN or Wildcard DNN if the EASDF supports all DNNs for the related S-NSSAI. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. | +| dnaiList | array(Dnai) | O | 1..N | List of Data network access identifiers supported by the EASDF for this DNN. The absence of this attribute indicates that the EASDF can be selected for this DNN for any DNAI. | + +## 6.1.6.2.80 Type: DccfInfo + +Table 6.1.6.2.80-1: Definition of type DccfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servingNfTypeList | array(NFType) | O | 1..N | If present, this IE shall contain the list of NF type(s) from which the DCCF NF can collect data. The absence of this attribute indicates that the DCCF can collect data from any NF type. | +| servingNfSetIdList | array(NfSetId) | O | 1..N | If present, this IE shall contain the list of NF Set Id(s) from which the DCCF NF can collect data. The absence of this attribute indicates that the DCCF can collect data from any NF Set. | +| taiList | array(Tai) | O | 1..N | The list of TAIs the DCCF can serve. It may contain one or more non-3GPP access TAIs. The absence of both this attribute and the taiRangeList attribute indicates that the DCCF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the DCCF can serve. It may contain one or more non-3GPP access TAI ranges. The absence of both this attribute and the taiList attribute indicates that the DCCF can be selected for any TAI in the serving network. | +| dataSubsRelocInd | boolean | O | 0..1 | When present, this IE shall indicate whether the DCCF supports relocation of data subscription:
- true: relocation of data subscription is supported by the DCCF
- false (default): relocation of data subscription is not supported by the DCCF. | + +## 6.1.6.2.8.1 Type: Nsacflnfo + +Table 6.1.6.2.8.1-1: Definition of type Nsacflnfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nsacfCapability | NsacfCapability | M | 1 | Indicates the NSAC service capability supported by the NSACF. | +| snssaiListForEntirePlmn | array(ExtSnssai) | O | 1..N | Indicates the list of S-NSSAIs for which the NSACF manages for entire PLMN (i.e NSACF is primary or central NSACF for specific S-NSSAIs). | +| tailList | array(Tai) | O | 1..N | The list of TAIs the NSACF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the NSACF can be selected for any TAI in the serving network.

(NOTE 1) (NOTE 2) | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the NSACF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the tailList attribute indicate that the NSACF can be selected for any TAI in the serving network.

(NOTE 1) (NOTE 2) | +| nsacSaiList | array(NsacSai) | O | 1..N | When present, it shall indicate the NSAC service areas which are supported by the NSACF. | + +NOTE 1: When NSACF serving area is configured with TAI list, the serving area of the NSACF should be configured to cover the complete serving area of any of its AMF and SMF consumers, i.e. the TAI list served by NSACF should include all the TAIs served by its AMF and SMF consumers. This can avoid NSACF reselection when the UE moves within the serving area of the NF consumer, e.g. avoid NSACF reselection during intra-AMF UE mobility + +NOTE 2: This attribute is deprecated; the attribute "nsacSaiList" should be used instead. + +## 6.1.6.2.8.2 Type: NsacfCapability + +Table 6.1.6.2.8.2-1: Definition of type NsacfCapability + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supportUeSAC | boolean | C | 0..1 | Indicates the service capability of the NSACF to monitor and control the number of registered UEs per network slice for the network slice that is subject to NSAC.
true: Supported
false (default): Not Supported | +| supportPduSAC | boolean | C | 0..1 | Indicates the service capability of the NSACF to monitor and control the number of established PDU sessions per network slice for the network slice that is subject to NSAC.
true: Supported
false (default): Not Supported | +| supportUeWithPduSAC | boolean | C | 0..1 | Indicates the service capability of the NSACF to monitor and control the number of registered UEs with at least one PDU session / PDN connection for the network slice that is subject to NSAC, if EPS counting is supported by the NSACF.
true: Supported
false (default): Not Supported | + +## 6.1.6.2.83 Type: DccfCond + +Table 6.1.6.2.83-1: Definition of type DccfCond + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionType | string | M | 1 | This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive.
In this data type, it shall take the value "DCCF_COND". | +| tailList | array(Tai) | O | 1..N | TAI(s) of the DCCF whose status is requested to be monitored. It may contain one or more non-3GPP access TAIs. | +| tailRangeList | array(TaiRange) | O | 1..N | The range of TAIs of the DCCF whose status is requested to be monitored. It may contain non-3GPP access TAIs. | +| servingNfTypeList | array(NFType) | O | 1..N | The list of NF type(s) served by DCCF whose status is requested to be monitored. | +| servingNfSetIdList | array(NfSetId) | O | 1..N | The list of NF Set Id(s) served by DCCF whose status is requested to be monitored. | + +## 6.1.6.2.84 Type: MIAnalyticsInfo + +Table 6.1.6.2.84-1: Definition of type MIAnalyticsInfo + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mlAnalyticsIds | array(NwdafEvent) | C | 1..N | Analytics Id(s) supported by the Nnwdaf_MLModelProvision service, if none are provided the NWDAF can serve any mlAnalyticsId. | +| snssaiList | array(Snssai) | O | 1..N | S-NSSAIs of the ML model, if none are provided the ML model for the analytics can apply to any snssai. | +| trackingAreaList | array(Tai) | O | 1..N | Area of Interest of the ML model, if none are provided the ML model for the analytics can apply to any TAIs.

If present, this IE represents the list of TAIs, it may contain one or more non-3GPP access TAIs. | +| mlModelInterInfo | MLModelInterInfo | O | 0..1 | ML Model Interoperability indicator, if none are provided the ML models are not allowed to be retrieved by any NWDAF vendors. | +| flCapabilityType | FLCapabilityType | O | 0..1 | Federated Learning capability type of the NWDAF as specified in clause 5.2.7.2.2 of 3GPP TS 23.502 [3], if none are provided the NWDAF can not support any type. | +| flTimeInterval | DurationSec | O | 0..1 | Time interval supporting Federated Learning as specified in clause 5.2.7.2.2 of 3GPP TS 23.502 [3]. This IE may be present if the flCapabilityType attribute is present. | +| nfTypeList | array(NFType) | O | 1..N | NF type of the data source where data can be collected as input for local model training. This IE may be present if the flCapabilityType attribute is present. (NOTE) | +| nfSetIdList | array(NfSetId) | O | 1..N | NF Set ID of the data source where data can be collected as input for local model training. This IE may be present if the flCapabilityType attribute is present. (NOTE) | + +NOTE: If the attribute is also present in Nwdaflnfo, the attribute values provided in MIAnalyticsInfo shall be a subset of the attribute values provided in Nwdaflnfo. + +## 6.1.6.2.85 Type: MbSmfInfo + +Table 6.1.6.2.85-1: Definition of type MbSmfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssaiInfoList | map(SNSSAIMbSmfInfoItem) | O | 1..N | S-NSSAIs and DNNs supported by the MB-SMF (NOTE 1)
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| tmgiRangeList | map(TmgiRange) | O | 1..N | TMGI range(s) supported by the MB-SMF
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| tailList | array(Tai) | O | 1..N | List of TAIs the MB-SMF can serve.
The absence of this attribute and the taiRangeList attribute indicates that the MB-SMF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the MB-SMF can serve.
The absence of this attribute and the taiList attribute indicates that the MB-SMF can be selected for any TAI in the serving network. | +| mbsSessionList | map(MbsSession) | O | 1..N | List of MBS sessions currently served by the MB-SMF
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | + +NOTE 1: If S-NSSAIs are present in MbSmfInfo and in the NFprofile, the S-NSSAIs from MbSmfInfo shall prevail. + +## 6.1.6.2.86 Type: TmgiRange + +Table 6.1.6.2.86-1: Definition of type TmgiRange + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsServiceIdStart | string | M | 1 | First MBS Service ID value identifying the start of a TMGI range.
The value shall be coded as defined for the mbsServiceId attribute of the Tmgi data type defined in 3GPP TS 29.571 [7].
Pattern: '[A-Fa-f0-9]{6}\$' | +| mbsServiceIdEnd | string | M | 1 | Last MBS Service ID value identifying the end of a TMGI range.
The value shall be coded as defined for the mbsServiceId attribute of the Tmgi data type defined in 3GPP TS 29.571 [7].
Pattern: '[A-Fa-f0-9]{6}\$' | +| plmnId | PlmnId | M | 1 | PLMN ID | +| nid | Nid | O | 0..1 | Network Identity used for SNPn | + +## 6.1.6.2.87 Type: MbsSession + +**Table 6.1.6.2.87-1: Definition of type MbsSession** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsSessionId | MbsSessionId | M | 1 | MBS session identifier | +| mbsAreaSessions | map(MbsServiceAreaInfo) | C | 1..N | Map of Area Session Id and related MBS Service Area information used for MBS session with location dependent content. The Area Session ID together with the mbsSessionId (TMGI) uniquely identifies the MBS session in a specific MBS service area. For an MBS session with location dependent content, one map entry shall be registered for each MBS Service Area served by the MBS session. The key of the map shall be the areaSessionId. | + +## 6.1.6.2.88 Type: SnssaiMbSmfInfoItem + +**Table 6.1.6.2.88-1: Definition of type SnssaiMbSmfInfoItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------|---|-------------|----------------------------------------------------| +| sNssai | ExtSnssai | M | 1 | Supported S-NSSAI | +| dnnInfoList | array(DnnMbSmfInfoItem) | M | 1..N | List of parameters supported by the MB-SMF per DNN | + +## 6.1.6.2.89 Type: DnnMbSmfInfoItem + +**Table 6.1.6.2.89-1: Definition of type DnnMbSmfInfoItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | Supported DNN or Wildcard DNN if the MB-SMF supports all DNNs for the related S-NSSAI. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. | + +6.1.6.2.90 Void + +6.1.6.2.91 Type: Tsctsflnfo + +**Table 6.1.6.2.91-1: Definition of type Tsctsflnfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssaiInfoList | map(SnssaiTsctsflnfoItem) | O | 1..N | S-NSSAIs and DNNs supported by the TSCTSF (NOTE 1)
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| externalGroupIdentifiers Ranges | array(IdentityRange) | O | 1..N | Ranges of External Group Identifiers that can be served by the TSCTSF.

The absence of this IE indicates that the TSCTSF can serve any external group managed by the PLMN (or SNPN) of the TSCTSF instance. | +| supiRanges | array(SupiRange) | O | 1..N | Ranges of SUPIs that can be served by the TSCTSF instance.
(NOTE 2) | +| gpsiRanges | array(IdentityRange) | O | 1..N | Ranges of GPSIs that can be served by the TSCTSF instance.
(NOTE 2) | +| internalGroupIdentifiers Ranges | array(InternalGroupldRange) | O | 1..N | Ranges of Internal Group Identifiers that can be served by the TSCTSF instance.

The absence of this IE indicates that the TSCTSF can serve any internal group managed by the PLMN (or SNPN) of the TSCTSF instance. | + +NOTE 1: If S-NSSAIs are present in Tsctsflnfo and in the NFprofile, the S-NSSAIs from Tsctsflnfo shall prevail. Only one TSCTSF instance, or only the TSCTSF instances belonging to one TSCTSF Set, shall be configured in the PLMN (or SNPN) to serve a specific DNN and S-NSSAI combination. + +NOTE 2: If both parameters are not provided, the TSCTSF can serve any SUPI or GPSI managed by the PLMN (or SNPN) of the TSCTSF instance. + +6.1.6.2.92 Type: SnssaiTsctsflnfoItem + +**Table 6.1.6.2.92-1: Definition of type SnssaiTsctsflnfoItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------------|---|-------------|-------------------------------------------------------------------------------| +| sNssai | ExtSnssai | M | 1 | Supported S-NSSAI. | +| dnnInfoList | array(DnnTsctsflnfoItem) | M | 1..N | List of parameters supported by the TSCTSF per DNN for the indicated S-NSSAI. | + +6.1.6.2.93 Type: DnnTsctsflnfoItem + +**Table 6.1.6.2.93-1: Definition of type DnnTsctsflnfoItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | Supported DNN or Wildcard DNN if the TSCTSF supports all DNNs for the related S-NSSAI. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. | + +## 6.1.6.2.94 Type: MbUpflInfo + +Table 6.1.6.2.94-1: Definition of type MbUpflInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssaiMbUpflInfoList | array(SnssaiUpflnfoltem) | M | 1..N | List of parameters supported by the MB-UPF per S-NSSAI. (NOTE) | +| mbSmfServingArea | array(string) | O | 1..N | The MB-SMF service area(s) the MB-UPF can serve.
If not provided, the MB-UPF can serve any MB-SMF service area. | +| interfaceMbUpflInfoList | array(InterfaceUpflnfoltem) | O | 1..N | List of User Plane interfaces configured on the MB-UPF. When this IE is provided in the NF Discovery response, the NF Service Consumer (e.g. MB-SMF) may use this information for MB-UPF selection. | +| tailList | array(Tai) | O | 1..N | The list of TAls the MB-UPF can serve.

The absence of this attribute and the taiRangeList attribute indicates that the MB-UPF can serve the whole MB-SMF service area defined by the MbSmfServingArea attribute. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAls the MB-UPF can serve.

The absence of this attribute and the tailList attribute indicates that the MB-UPF can serve the whole MB-SMF service area defined by the MbSmfServingArea attribute. | +| priority | integer | O | 0..1 | Priority (relative to other NFs of the same type) in the range of 0-65535, to be used for NF selection for a service request matching the attributes of the MbUpflInfo; lower values indicate a higher priority. See the precedence rules in the description of the priority attribute in NFProfile, if Priority is also present in NFProfile.
The NRF may overwrite the received priority value when exposing an NFProfile with the Nnrf_NFDiscovery service. | +| supportedPfcpFeatures | string | O | 0..1 | Supported PFCP Features.

A string used to indicate the PFCP features supported by the MB-UPF, which encodes the "UP Function Features" IE as specified in Table 8.2.25-1 of 3GPP TS 29.244 [21] (starting from Octet 5), in hexadecimal representation.

Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and each two characters shall represent one octet of "UP Function Features" IE (starting from Octet 5, to higher octets). For each two characters representing one octet, the first character representing the 4 most significant bits of the octet and the second character the 4 least significant bits of the octet. | + +NOTE : If this S-NSSAI is present in the MbUpflInfo and in the NFprofile, the S-NSSAIs from the MbUpflInfo shall prevail. + +## 6.1.6.2.95 Type: UnTrustAflInfo + +Table 6.1.6.2.95-1: Definition of type UnTrustAflInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| aflId | string | M | 1 | Associated AF id. | +| sNssaiInfoList | array(SNSSAIInfoItem) | O | 1..N | S-NSSAIs and DNNs supported by the AF. | +| mappingInd | boolean | O | 0..1 | When present, this IE indicates whether the AF supports mapping between UE IP address (IPv4 address or IPv6 prefix) and UE ID (i.e. GPSI).

true: the AF supports mapping between UE IP address and UE ID;
false (default): the AF does not support mapping between UE IP address and UE ID. | + +#### 6.1.6.2.96 Type: TrustAflInfo + +**Table 6.1.6.2.96-1: Definition of type TrustAflInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssaiInfoList | array(SNSSAIInfoItem) | O | 1..N | S-NSSAIs and DNNs supported by the trusted AF (NOTE 1). | +| afEvents | array(AfEvent) | O | 1..N | AF Event(s) supported by the trusted AF. | +| appIds | array(string) | O | 1..N | The list of Application ID(s) supported by the trusted AF. The absence of this attribute indicate that the AF can be selected for any Application. | +| internalGroupId | array(GroupId) | O | 1..N | List of Internal Group Identifiers supported by the trusted AF.
If not provided, it does not imply that the AF supports all internal groups. | +| mappingInd | boolean | O | 0..1 | When present, this IE indicates whether the trusted AF supports mapping between UE IP address (IPv4 address or IPv6 prefix) and UE ID (i.e. SUPI).

true: the trusted AF supports mapping between UE IP address and UE ID;
false (default): the trusted AF does not support mapping between UE IP address and UE ID. | +| taiList | array(Tai) | O | 1..N | This IE may be present if the AfEvent is set to "GNSS_ASSISTANCE_DATA".
When present, this IE shall contain the list of TAIs the trusted AF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the trusted AF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | This IE may be present if the AfEvent is set to "GNSS_ASSISTANCE_DATA".
When present, this IE shall contain the range of TAIs the trusted AF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the taiList attribute indicate that the trusted AF can be selected for any TAI in the serving network. | + +NOTE 1: If S-NSSAIs are present in TrustAflInfo and in the NFprofile, the S-NSSAIs from TrustAflInfo shall prevail. + +#### 6.1.6.2.97 Type: SnssaiInfoItem + +**Table 6.1.6.2.97-1: Definition of type SnssaiInfoItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------|---|-------------|------------------------------------------------| +| sNssai | ExtSnssai | M | 1 | Supported S-NSSAI | +| dnnInfoList | array(DnnInfoItem) | M | 1..N | List of parameters supported by the NF per DNN | + +## 6.1.6.2.98 Type: DnnInfItem + +**Table 6.1.6.2.98-1: Definition of type DnnInfItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | Supported DNN or Wildcard DNN if the NF supports all DNNs for the related S-NSSAI. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. | + +## 6.1.6.2.99 Type: CollocatedNfInstance + +**Table 6.1.6.2.99-1: Definition of type CollocatedNfInstance** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|------------------------------------------------------------------| +| nfInstanceId | NfInstanceId | M | 1 | Unique identity of the NF Instance for a collocated NF type. | +| nfType | CollocatedNfType | M | 1 | Possible NF types supported by a collocated NF. (NOTE 1, NOTE 2) | + +NOTE 1: Whether NFs of any NF types are collocated or not, is an implementation and/or deployment issue and needs not be known in general to the NF service consumers and therefore needs not be registered in the NF profile. This data type is only intended for specific scenarios where the discovery and selection of a combined NF service producer by a NF service consumer can allow specific optimizations. In order to retrieve the NFProfile of the collocated NF instance, the NF service consumer shall trigger a separate discovery procedure using the nfType and nfInstanceId in the CollocatedNfInstance data type. + +NOTE 2: The supported collocated NF types in this release of the specification may only be one of the following: +- a MB-SMF may be collocated with a SMF (N16mb internal interface); +- a MB-UPF may be collocated with a UPF (N19mb internal interface). + +## 6.1.6.2.100 Type: ServiceNameListCond + +**Table 6.1.6.2.100-1: Definition of type ServiceNameListCond** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionType | string | M | 1 | This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive.
In this data type, it shall take the value "SERVICE_NAME_LIST_COND". | +| serviceNameList | array(ServiceName) | M | 1..N | Service names offered by the NF Instances whose status is requested to be monitored. | + +## 6.1.6.2.101 Type: NfGroupListCond + +**Table 6.1.6.2.101-1: Definition of type NfGroupListCond** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionType | string | M | 1 | This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive.
In this data type, it shall take the value "NF_GROUP_LIST_COND". | +| nfType | string | M | 1 | NF type (UDM, AUSF, PCF, UDR, HSS or CHF) of the NF Instances whose status is requested to be monitored. | +| nfGroupIdList | array(NfGroupId) | M | 1..N | Group IDs of the NF Instances whose status is requested to be monitored. | + +## 6.1.6.2.102 Type: PlmnOauth2 + +**Table 6.1.6.2.102-1: Definition of type PlmnOauth2** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------|---------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------| +| oauth2RequiredPlmnIdList | array(PlmnId) | O | 1..N | It shall indicate the consumer PLMN ID list for which NF Service Instance requires Oauth2-based authorization.
(See NOTE 1) | +| oauth2NotRequiredPlmnIdList | array(PlmnId) | O | 1..N | It shall indicate the consumer PLMN ID list for which NF Service Instance does not require Oauth2-based authorization.
(See NOTE 1) | + +NOTE 1: The same PLMN Id shall not be present in both oauth2RequiredPlmnIdList and oauth2NotRequiredPlmnIdList. + +## 6.1.6.2.103 Type: V2xCapability + +**Table 6.1.6.2.103-1: Definition of type V2xCapability** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lteV2x | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports LTE V2X capability:

- true: LTE V2X capability is supported by the PCF
- false (default): LTE V2X capability is not supported by the PCF. | +| nrV2x | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports NR V2X capability:

- true: NR V2X capability is supported by the PCF
- false (default): NR V2X capability is not supported by the PCF. | + +## 6.1.6.2.104 Type: Nssaaflnfo + +**Table 6.1.6.2.104-1: Definition of type Nssaaflnfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------|-----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPIs that can be served by the NSSAAF instance. | +| internalGroupIdentifiersRanges | array(InternalGroupIdRange) | O | 1..N | List of ranges of Internal Group Identifiers that can be served by the NSSAAF instance. If not provided, it does not imply that the NSSAAF supports all internal groups. | + +6.1.6.2.105 Type: ProSeCapability + +**Table 6.1.6.2.105-1: Definition of type ProSeCapability** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| proseDirectDiscover | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Direct Discovery:

- true: ProSe Direct Discovery is supported by the PCF
- false (default): ProSe Direct Discovery is not supported by the PCF. | +| proseDirectCommunication | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Direct Communication:

- true: ProSe Direct Communication is supported by the PCF
- false (default): ProSe Direct Communication is not supported by the PCF. | +| proseL2UetoNetworkRelay | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-2 UE-to-Network Relay:

- true: ProSe Layer-2 UE-to-Network Relay is supported by the PCF
- false (default): ProSe Layer-2 UE-to-Network Relay is not supported by the PCF. | +| proseL3UetoNetworkRelay | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-3 UE-to-Network Relay:

- true: ProSe Layer-3 UE-to-Network Relay is supported by the PCF
- false (default): ProSe Layer-3 UE-to-Network Relay is not supported by the PCF. | +| proseL2RemoteUe | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-2 Remote UE:

- true: ProSe Layer-2 Remote UE is supported by the PCF
- false (default): ProSe Layer-2 Remote UE is not supported by the PCF. | +| proseL3RemoteUe | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-3 Remote UE:

- true: ProSe Layer-3 Remote UE is supported by the PCF
- false (default): ProSe Layer-3 Remote UE is not supported by the PCF. | +| proseL2UetoUeRelay | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-2 UE-to-UE Relay:

- true: ProSe Layer-2 UE-to-UE Relay is supported by the PCF
- false (default): ProSe Layer-2 UE-to-UE Relay is not supported by the PCF. | +| proseL3UetoUeRelay | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-3 UE-to-UE Relay:

- true: ProSe Layer-3 UE-to-UE Relay is supported by the PCF
- false (default): ProSe Layer-3 UE-to-UE Relay is not supported by the PCF. | +| proseL2EndUe | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-2 End UE:

- true: ProSe Layer-2 End UE is supported by the PCF
- false (default): ProSe Layer-2 End UE is not supported by the PCF. | +| proseL3EndUe | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-3 End UE:

- true: ProSe Layer-3 End UE is supported by the | + +| | | | | | +|--|--|--|--|-----------------------------------------------------------------------------| +| | | | | PCF
- false (default): ProSe Layer-3 End UE is not supported by the PCF. | +|--|--|--|--|-----------------------------------------------------------------------------| + +#### 6.1.6.2.106 Type: SharedDataIdRange + +**Table 6.1.6.2.106-1: Definition of type SharedDataIdRange** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| pattern | string | O | 0..1 | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of SharedDataIds belonging to this range. A SharedDataId value is considered part of the range if and only if the SharedDataId string fully matches the regular expression. | + +EXAMPLE: SharedDataId range. "123456-sharedAmData{localID}" where "123456" is the HPLMN id (i.e. MCC followed by MNC) and "{localID}" can be any string. + JSON: { "pattern": "^123456-sharedAmData.+\$" } + +#### 6.1.6.2.107 Type: SubscriptionContext + +**Table 6.1.6.2.107-1: Definition of type SubscriptionContext** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| subscriptionId | string | M | 1 | Subscription ID of the corresponding subscription resource that originated the notification. | +| subscrCond | SubscrCond | O | 0..1 | If present, this attribute shall contain the conditions identifying the set of NF Instances whose status was requested to be monitored in the corresponding subscription that originated this notification. | + +#### 6.1.6.2.108 Type: IwmscInfo + +**Table 6.1.6.2.108-1: Definition of type IwmscInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| msisdnRanges | array(IdentityRange) | O | 1..N | List of ranges of MSISDNs supported by the SMS-IWMSC.
See NOTE. | +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPIs supported by the SMS-IWMSC.
See NOTE. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAs the SMS-IWMSC can serve.

The absence of this attribute indicates that the SMS-IWMSC can serve any TA. | +| scNumber | string | O | 0..1 | When present, this IE carry an OctetString indicating the ISDN number of the SC in international number format as described in ITU-T Rec. E.164 [44] and shall be encoded as a TBCD-string.

Pattern: "^[0-9]{5,15}\$" | + +NOTE: If both parameters are not provided, the SMS-IWMSC can serve any SUPI or MSISDN. + +## 6.1.6.2.109 Type: Mnpflnfo + +**Table 6.1.6.2.109-1: Definition of type Mnpflnfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------| +| msisdnRanges | array(IdentityRange) | M | 1..N | List of ranges of MSISDNs whose portability status is available in the MNPF | + +## 6.1.6.2.110 Type: DefSubServiceInfo + +**Table 6.1.6.2.110-1: Definition of type DefSubServiceInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| versions | array(string) | O | 1..N | When present, this attribute shall indicate the API version (e.g. "v1") of the indicated service which are supported by the NF (Service) instance acting as NF service consumer. | +| supportedFeatures | SupportedFeatures | O | 0..1 | When present, this attribute shall indicate the features of the indicated service which are supported by the NF (Service) instance acting as NF service consumer. | + +## 6.1.6.2.111 Type: LocalityDescriptionItem + +**Table 6.1.6.2.111-1: Definition of type LocalityDescriptionItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|------------------------------| +| localityType | LocalityType | M | 1 | Type of locality description | +| localityValue | string | M | 1 | Locality value | + +## 6.1.6.2.112 Type: LocalityDescription + +**Table 6.1.6.2.112-1: Definition of type LocalityDescription** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|--------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| localityType | LocalityType | M | 1 | Type of locality description | +| localityValue | string | M | 1 | Locality value | +| addLocDescrItems | array(LocalityDescriptionItem) | O | 0..1 | Additional locality description items
This IE may be present to express a preferred locality as a set of locality description items to match with an "AND" relationship, e.g. to express a preference for NF profiles that are located in a given city and state. This may be used e.g. when a locality value of a given locality type may not be unique within the PLMN, such as cities with the same name in different states. | + +## 6.1.6.2.113 Type: SmsfInfo + +Table 6.1.6.2.113-1: Definition of type SmsfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| roamingUeInd | boolean | O | 0..1 | When present, this IE shall indicate whether the SMSF can serve roaming UE:

- true: the SMSF can support roaming UEs.
- false: the SMSF can not support roaming UEs.

Absence of this IE indicates whether the SMSF can serve roaming UEs is not specified. | +| remotePlmnRangeList | array(PlmnRange) | O | 1..N | This IE maybe present when the roamingUeInd IE is present with the value "true".

When present, this IE shall indicate the list of ranges of remote PLMNs served by the SMSF, i.e. the SMSF can serve the roaming UEs which belong to the indicated remote PLMNs. | + +NOTE: If the roamingUeInd IE is present with the value "true", absence of remotePlmnRangeList IE indicates that the SMSF can serve roaming UEs from any remote PLMN. + +## 6.1.6.2.114 Type: DcsfInfo + +Table 6.1.6.2.114-1: Definition of type DcsfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| imsDomainNameList | array(imsDomainName) | O | 1..N | List of IMS domain names served by the DCSF. | +| imsiRanges | array(ImsiRange) | O | 1..N | List of ranges of IMSIs whose profile data is available in the DCSF instance. (NOTE 1) | +| msisdnRanges | array(IdentityRange) | O | 1..N | List of ranges of MSISDNs whose profile data is available in the DCSF instance. (NOTE 1) | +| imsPrivateIdentityRanges | array(IdentityRange) | O | 1..N | List of ranges of IMS Private Identities whose profile data is available in the DCSF instance. (NOTE 1) | +| imsPublicIdentityRanges | array(IdentityRange) | O | 1..N | List of ranges of IMS Public Identities whose profile data is available in the DCSF instance. (NOTE 1) | + +NOTE 1: If none of these parameters are provided, the DCSF can serve any IMSI or IMS Private Identity or IMS Public Identity or MSISDN managed by the PLMN of the DCSF instance. + +## 6.1.6.2.115 Type: MIModelInterInfo + +Table 6.1.6.2.115-1: Definition of type MIModelInterInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------| +| vendorList | array(VendorId) | O | 1..N | When present, this IE shall include the list of NWDAF vendors that are allowed to retrieve ML models from the NWDAF containing MTLF. | + +## 6.1.6.2.116 Type: PruExistenceInfo + +**Table 6.1.6.2.116-1: Definition of type PruExistenceInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------| +| tailList | array(Tai) | O | 1..N | When present, this IE shall contain PRU(s) TAI list that the LMF can serve. It may contain one or more non-3GPP access TAIs. | +| taiRangeList | array(TaiRange) | O | 1..N | When present, this IE shall contain PRU(s) TAI range list that the LMF can serve. It may contain one or more non-3GPP access TAI ranges. | + +## 6.1.6.2.117 Type: MrfInfo + +**Table 6.1.6.2.117-1: Definition of type MrfInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| mediaCapabilityList | array(MediaCapability) | O | 1..N | List of IMS media capabilities offered by the MRF. An IMS media capability that matches this information can be served by the MRF. (NOTE 1) | +| NOTE 1: Locality of MRF may be configured to allow the MRF consumers to discover and select candidate MRF based on Locality information. See NOTE 25 of Table 6.2.3.2.3.1-1. | | | | | + +## 6.1.6.2.118 Type: MrfpInfo + +**Table 6.1.6.2.118-1: Definition of type MrfpInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| mediaCapabilityList | array(MediaCapability) | O | 1..N | List of IMS media capabilities offered by the MRFP. An IMS media capability that matches this information can be served by the MRFP. (NOTE 1) | +| NOTE 1: Locality of MRFP may be configured to allow the MRFP consumers to discover and select candidate MRFP based on Locality information. See NOTE 25 of Table 6.2.3.2.3.1-1. | | | | | + +## 6.1.6.2.119 Type: MfInfo + +**Table 6.1.6.2.119-1: Definition of type MfInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| mediaCapabilityList | array(MediaCapability) | O | 1..N | List of media capabilities offered by the MF. A media capability that matches this information can be served by the MF. E.g. DC, AR. (NOTE 1) | +| NOTE 1: Locality of MF may be configured to allow the MF consumers to discover and select candidate MF based on Locality information. See NOTE 25 of Table 6.2.3.2.3.1-1. | | | | | + +## 6.1.6.2.120 Type: A2xCapability + +**Table 6.1.6.2.120-1: Definition of type A2xCapability** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lteA2x | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports LTE A2X capability:

- true: LTE A2X capability is supported by the PCF
- false (default): LTE A2X capability is not supported by the PCF. | +| nrA2x | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports NR A2X capability:

- true: NR A2X capability is supported by the PCF
- false (default): NR A2X capability is not supported by the PCF. | + +## 6.1.6.2.121 Type: RuleSet + +Table 6.1.6.2.121-1: Definition of type RuleSet + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| priority | integer | M | 1 | Unique Priority of the rule. Lower value means higher priority. | +| plmns | array(PlmnId) | O | 1..N | PLMNs allowed/dis-allowed to access the service instance.

When absent, NF-Consumers of all PLMNs are assumed to match this criteria. | +| snpns | array(PlmnIdNid) | O | 1..N | SNPNs allowed/dis-allowed to access the service instance.

When absent, NF-Consumers of all SNPNs are assumed to match this criteria. | +| nfTypes | array(NFType) | O | 1..N | Type of the NFs allowed/dis-allowed to access the service instance.

When absent, NF-Consumers of all nfTypes are assumed to match this criteria. | +| nfDomains | array(string) | O | 1..N | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the NF domain names within the PLMN of the NRF allowed/dis-allowed to access the service instance.

When absent, NF-Consumers of all nfDomains are assumed to match this criteria. | +| nssais | array(ExtSnssai) | O | 1..N | S-NSSAIs of the NF-Consumers allowed/dis-allowed to access the service instance.

When absent, NF-Consumers of all slices are assumed to match this criteria. | +| nfInstances | array(NfInstanceId) | O | 1..N | NF-Instance IDs of the NF-Consumers allowed/dis-allowed to access the NF/NF-Service instance.

When absent, all the NF-Consumers are assumed to match this criteria. | +| scopes | array(string) | O | 1..N | List of scopes allowed or denied to the NF-Consumers matching the rule.

The scopes shall be any of those defined in the API that defines the current service (identified by the "serviceName" attribute), including the service-level scopes.

When absent, the NF-Consumer is allowed or denied full access to all the resources/operations of service instance.

This IE is applicable only in NF-Service definition. | +| action | RuleSetAction | M | 1 | Specifies whether the scopes/access mentioned are allowed or denied for a specific NF-Consumer. | + +## 6.1.6.2.122 Type: AdrflInfo + +**Table 6.1.6.2.122-1: Definition of type AdrflInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mlModelStorageInd | boolean | O | 0..1 | When present, this IE shall indicate whether the ADRF supports ML model storage and retrieval:

- true: ML model storage capability is supported by the ADRF
- false (default): ML model storage capability is not supported by the ADRF. | +| dataStorageInd | boolean | O | 0..1 | When present, this IE shall indicate whether the ADRF supports data and analytics storage and retrieval capability:

- true: data and analytics storage and retrieval capability is supported by the ADRF.
- false (default): data and analytics storage and retrieval capability is not supported by the ADRF. | + +## 6.1.6.2.123 Type: SelectionConditions + +**Table 6.1.6.2.123-1: Definition of type SelectionConditions as a list of mutually exclusive alternatives** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ConditionItem | O | 0..1 | A single condition item that shall be evaluated (as or ) to determine whether a discovered NF (Service) Instance shall be selected. | +| ConditionGroup | O | 0..1 | A group of conditions (joined by a boolean "and" or "or" connector) that shall be evaluated (as or ) to determine whether a discovered NF (Service) Instance shall be selected. | + +## 6.1.6.2.124 Type: ConditionItem + +Table 6.1.6.2.124-1: Definition of type ConditionItem + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| consumerNfTypes | array(NFType) | O | 1..N |

The NF types of the consumers for which the conditions included in this ConditionItem apply.

If this attribute is absent, the conditions are applicable to all NF consumer types.

| +| serviceFeature | integer | O | 0..1 |

This attribute only applies when the selectionConditions, where this ConditionItem is included, is included in a NF Service Instance.

It represents a feature number of that NF Service Instance, under CANARY_RELEASE status.

This condition is evaluated to <true> when the service requests from a consumer of this NF Service Instance require the support of the indicated feature on the NF Service Instance.

EXAMPLE: If "serviceFeature" is set to 2, for a service instance of "nsmf-pdusession", such instance will only be selected for consumers supporting, and requiring the support from the NF Service producer, of the "MAPDU" (ATSSS) feature (see 3GPP TS 29.502, clause 6.1.8),.

| +| vsServiceFeature | integer | O | 0..1 |

This attribute only applies when the selectionConditions, where this ConditionItem is included, is included in a NF Service Instance.

It represents a Vendor-Specific feature number of that NF Service Instance, under CANARY_RELEASE status.

This condition is evaluated to <true> when the service requests from a consumer of this NF Service Instance require the support of the indicated Vendor-Specific feature on the NF Service Instance.

| +| supiRangeList | array(SupiRange) | O | 1..N | A set of SUPIs for which the NF (Service) instance under CANARY_RELEASE status shall be selected | +| gpsirangeList | array(IdentityRange) | O | 1..N | A set of GPSIs for which the NF (Service) instance under CANARY_RELEASE status shall be selected | +| impurangeList | array(IdentityRange) | O | 1..N | A set of IMS Public Identities for which the NF (Service) instance under CANARY_RELEASE status shall be selected. | +| impirangeList | array(IdentityRange) | O | 1..N | A set of IMS Private Identities for which the NF (Service) instance under CANARY_RELEASE status shall be selected | +| peiList | array(Pei) | O | 1..N | A set of PEIs of the UEs for which the NF (Service) instance under CANARY_RELEASE status shall be selected | +| tairangeList | array(TaiRange) | O | 1..N | A set of TAsIs where the NF (Service) instance under CANARY_RELEASE status shall be selected for a certain UE | +| dnnList | array(Dnn) | O | 1..N | A set of DNNs where the NF (Service) instance under CANARY_RELEASE status shall be selected. | +| NOTE 1: If several attributes (conditions) are present, the evaluation logic shall be the result of a boolean "AND" of the conditions expressed in the different attributes of this object. | | | | | +| NOTE 2: If an NF Service Consumer finds an unknown condition/attribute (e.g. because the attribute has been added in a later version of the specification), or if the NF Service Consumer does not have enough data to evaluate the condition, the result of the evaluation of such condition shall be . | | | | | + +## 6.1.6.2.125 Type: ConditionGroup + +**Table 6.1.6.2.125-1: Definition of type ConditionGroup** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------|----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| and | array(SelectionConditions) | C | 1..N | A list (array) of conditions where the overall evaluation is only if all the conditions in the list are evaluated as . | +| or | array(SelectionConditions) | C | 1..N | A list (array) of conditions where the overall evaluation is if at least one of the conditions in the list is evaluated as . | +| NOTE: Exactly one of either attribute "and" or attribute "or", but not both, shall be present. | | | | | + +## 6.1.6.2.126 Type: EpdgInfo + +**Table 6.1.6.2.126-1: Definition of type EpdgInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------------------------------------------|-----------------|---|-------------|-----------------------------------------------------------------------| +| ipv4EndpointAddresses | array(Ipv4Addr) | C | 1..N | Available endpoint IPv4 address(es) of the S2b-u terminations (NOTE). | +| ipv6EndpointAddresses | array(Ipv6Addr) | C | 1..N | Available endpoint IPv6 address(es) of the S2b-u terminations (NOTE). | +| NOTE: At least one of the addressing parameters (ipv4EndpointAddresses, ipv6EndpointAddresses) shall be included in the EpdgInfo. | | | | | + +## 6.1.6.2.127 Type: CallbackUriPrefixItem + +**Table 6.1.6.2.127-1: Definition of type CallbackUriPrefixItem** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------------------------------------------------------------------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| callbackUriPrefix | string | M | 1 | Optional path segment(s) used to construct the prefix of the Callback URIs during the reselection of an NF service consumer, as described in 3GPP TS 29.501 [5], clause 4.4.3 | +| notificationTypes | array(string) | M | 0..N | List of notification type values using the callback URI prefix of the callbackUriPrefix IE.
Each notification type value shall be encoded as defined in Annex B of 3GPP TS 29.500 [4].
When this IE is set with an empty array, the callback URI prefix indicated in the callbackUriPefix IE shall be used for all notification types not present in any other CallbackUriPrefixItem entry of the callbackUriPrefixList IE. | +| NOTE: A given notification type value shall be associated with only one callbackUriPrefix value. | | | | | + +## 6.1.6.3 Simple data types and enumerations + +## 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NefId | string | The NEF ID as specified in clause 4.25.2 of 3GPP TS 23.502 [3].

For combined SCEF+NEF, the NEF ID shall contain the SCEF ID encoded as specified in clause 8.4.5 of 3GPP TS 29.336 [37]. | +| VendorId | string | Vendor ID, according to the IANA-assigned "SMI Network Management Private Enterprise Codes" [38].
It shall be formatted as a fixed 6-digit string, padding with leading digits "0" to complete a 6-digit length.

Pattern: "[0-9]{6}\$" | +| WildcardDnai | string | String representing the Wildcard DNAI.
It shall contain the string "*".
Pattern: "^[*]\$" | +| ImsDomainName | string | The IMS domain name. | +| MediaCapability | string | String representing the media capability offered by NF instance.
Pattern: "[a-zA-Z0-9_ ]+\$" | + +### 6.1.6.3.3 Enumeration: NFType + +The enumeration NFType represents the different types of Network Functions or Network Entities that can be found in the 5GC. + +**Table 6.1.6.3.3-1: Enumeration NFType** + +| Enumeration value | Description | +|-------------------|------------------------------------| +| "NRF" | Network Function: NRF | +| "UDM" | Network Function: UDM | +| "AMF" | Network Function: AMF | +| "SMF" | Network Function: SMF | +| "AUSF" | Network Function: AUSF | +| "NEF" | Network Function: NEF | +| "PCF" | Network Function: PCF | +| "SMSF" | Network Function: SMSF | +| "NSSF" | Network Function: NSSF | +| "UDR" | Network Function: UDR | +| "LMF" | Network Function: LMF | +| "GMLC" | Network Function: GMLC | +| "5G_EIR" | Network Function: 5G-EIR | +| "SEPP" | Network Entity: SEPP | +| "UPF" | Network Function: UPF | +| "N3IWF" | Network Function and Entity: N3IWF | +| "AF" | Network Function: AF | +| "UDSF" | Network Function: UDSF | +| "BSF" | Network Function: BSF | +| "CHF" | Network Function: CHF | +| "NWDAF" | Network Function: NWDAF | +| "PCSCF" | Network Function: P-CSCF | +| "CBCF" | Network Function: CBCF | +| "UCMF" | Network Function: UCMF | +| "HSS" | Network Function: HSS | +| "SOR_AF" | Network Function: SOR-AF | +| "SPAF" | Network Function: SP-AF | +| "MME" | Network Function: MME | +| "SCSAS" | Network Function: SCS/AS | +| "SCEF" | Network Function: SCEF | +| "SCP" | Network Entity: SCP | +| "NSSAAF" | Network Function: NSSAAF | +| "ICSCF" | Network Function: I-CSCF | +| "SCSCF" | Network Function: S-CSCF | +| "DRA" | Network Function: DRA | +| "IMS_AS" | Network Function: IMS-AS | +| "AANF" | Network Function: AAnF | +| "5G_DDNMF" | Network Function: 5G DDNMF | +| "NSACF" | Network Function: NSACF | +| "MFAF" | Network Function: MFAF | +| "EASDF" | Network Function: EASDF | +| "DCCF" | Network Function: DCCF | +| "MB_SMF" | Network Function: MB-SMF | +| "TSCTSF" | Network Function: TSCTSF | +| "ADRF" | Network Function: ADRF | +| "GBA_BSF" | Network Function: GBA BSF | +| "CEF" | Network Function: CEF | +| "MB_UPF" | Network Function: MB-UPF | +| "NSWOF" | Network Function: NSWOF | +| "PKMF" | Network Function: PKMF | +| "MNPf" | Network Function: MNPf | +| "SMS_GMSC" | Network Function: SMS-GMSC | +| "SMS_IWMSC" | Network Function: SMS-IWMSC | +| "MBSF" | Network Function: MBSF | +| "MBSTF" | Network Function: MBSTF | +| "PANF" | Network Function: PANF | +| "DCSF" | Network Function: DCSF | +| "MRF" | Network Function: MRF | +| "MRFP" | Network Function: MRFP | +| "MF" | Network Function: MF | +| "SLPKMF" | Network Function: SLPKMF | + + + +#### 6.1.6.3.4 Enumeration: NotificationType + +**Table 6.1.6.3.4-1: Enumeration NotificationType** + +| Enumeration value | Description | +|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "N1_MESSAGES" |

Notification of N1 messages.

This notification type may be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2) or as part of a specific service instance.

If the AMF registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "namf-comm" or with a custom service.

If the LMF registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "nlmf-loc" or with a custom service.

| +| "N2_INFORMATION" |

Notification of N2 information.

This notification type may be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2) or as part of a specific service instance.

If the AMF registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "namf-comm" or with a custom service.

If the LMF registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "nlmf-loc" or with a custom service.

| +| "LOCATION_NOTIFICATION" |

Notification of Location Information sent by AMF/LMF towards NF Service Consumers (e.g GMLC).

This notification type may be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2) or as part of a specific service instance.

If the the GMLC registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "ngmlc-loc" or with a custom service.

| +| "DATA_REMOVAL_NOTIFICATION" |

Notification of Data Removal sent by UDR (e.g., removal of UE registration data upon subscription withdrawal).

This notification type shall be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2).

| +| "DATA_CHANGE_NOTIFICATION" |

Notification of Data Changes sent by UDR.

This notification type shall be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2).

| +| "LOCATION_UPDATE_NOTIFICATION" |

Notification of UE Location Information Update sent by GMLC towards NF Service Consumers (e.g. H-GMLC, NEF), during MO_LR procedure.

This notification type may be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2) or as part of a specific service instance.

If the the GMLC registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "ngmlc-loc" or with a custom service.

If the the NEF registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "nnef-eventexposure" or with a custom service.

| +| "NSSAA_REAUTH_NOTIFICATION" |

Re-authentication notification for slice-specific authentication and authorization sent by NSSAAF towards NF Service

| + +| | | +|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Consumers (e.g. AMF).

This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. | +| "NSSAA_REVOC_NOTIFICATION" | Revocation notification for slice-specific authentication and authorization sent by NSSAAF towards NF Service Consumers (e.g. AMF).

This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. | +| "MATCH_INFO_NOTIFICATION" | Notification of a matching result, and the information that can be used for charging purpose by 5G DDNMF towards NF Service Consumers (e.g. 5G DDNMF), during Discovery Reporting procedures.

This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. | +| "DATA_RESTORATION_NOTIFICATION" | Notification by UDR to its NF Service Consumers (e.g. UDM, PCF, NEF...) or by UDM to its NF Service Consumers (e.g. AMF, SMF, SMSF...) of a potential data-loss event originated at UDR. The content of the notification shall be as described in 3GPP TS 29.503 [36], clause 5.3.2.12.2 and 6.2.5.4.

This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. | +| "TSCTS_NOTIFICATION" | Notification sent by PCF to TSCTSF of TSC user-plane node information. The content of the notification is described in 3GPP TS 29.514 [47], clause 4.2.5.16.

This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. | +| "LCS_KEY_DELIVERY_NOTIFICATION" | Notification sent by LMF to AMF to deliver ciphering key information.

This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. | +| "UUAA_MM_AUTH_NOTIFICATION" | Authentication notification sent by UAS-NF towards NF Service Consumers (i.e. AMF), during USS Initiated reauthorization, update authorization data or revoke authorization with UUAA-MM procedures.

This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. | + +### 6.1.6.3.5 Enumeration: TransportProtocol + +**Table 6.1.6.3.5-1: Enumeration TransportProtocol** + +| Enumeration value | Description | +|-------------------|-------------------------| +| "TCP" | Transport protocol: TCP | + +### 6.1.6.3.6 Enumeration: NotificationEventType + +**Table 6.1.6.3.6-1: Enumeration NotificationEventType** + +| Enumeration value | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------| +| "NF_REGISTERED" | The NF Instance has been registered in NRF | +| "NF_DEREGISTERED" | The NF Instance has been deregistered from NRF (NOTE) | +| "NF_PROFILE_CHANGED" | The profile of the NF Instance has been modified (NOTE) | +| NOTE: A change of the NFStatus value shall be notified as "NF_PROFILE_CHANGED" event, except if the NFStatus is set to value "CANARY_RELEASE" and the subscribing entity does not support the "Canary-Release" feature; in such case, the subscribing entity shall be notified as a "NF_DEREGISTERED" event. | | + +### 6.1.6.3.7 Enumeration: NFStatus + +**Table 6.1.6.3.7-1: Enumeration NFStatus** + +| Enumeration value | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "REGISTERED" | The NF Instance is registered in NRF and can be discovered by other NFs. | +| "SUSPENDED" | The NF Instance is registered in NRF but it is not operative and cannot be discovered by other NFs.
This status may result from a NF Heart-Beat failure (see clause 5.2.2.3.2) or a NF failure and may trigger restoration procedures (see clause 6.2 of 3GPP TS 23.527 [27]). | +| "UNDISCOVERABLE" | The NF instance is registered in NRF, is operative but cannot be discovered by other NFs.
This status may be set by the NF e.g. in shutting down scenarios where the NF is still able to process requests for existing resources or sessions but cannot accept new resource creation or session establishment. | +| "CANARY_RELEASE" | The NF instance is registered in NRF, is operative and can be discovered and selected by other NFs under certain conditions (see SelectionConditions, in clause 6.1.6.2.123).

This status may be set by the NF e.g. in upgrade scenarios or during canary testing scenarios where the NF is able to process requests for new resource creation or session establishment under certain conditions (e.g. for a restricted set of users).

(NOTE 2) | +| NOTE 1: An NF instance cannot be discovered by other NFs if the NF status is set to "SUSPENDED" or "UNDISCOVERABLE". | | +| NOTE 2: A discovered NF instance with NFStatus "CANARY_RELEASE" shall only be selected by an NF Service Consumer if the conditions included in the "selectionConditions" attribute of the NFProfile are evaluated to ; if such attribute is not included, the NF instance shall not be selected. | | + +### 6.1.6.3.8 Enumeration: DataSetId + +The enumeration DataSetId represents the different types of data sets supported by an UDR instance. + +**Table 6.1.6.3.8-1: Enumeration DataSetId** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "SUBSCRIPTION" | Data set: Subscription data | +| "POLICY" | Data set: Policy data (including all defined subsets) | +| "EXPOSURE" | Data set: Structured data for exposure | +| "APPLICATION" | Data set: Application data (including all defined subsets) | +| "A_PFD" | ApplicationData subset: Packet Flow Descriptions | +| "A_AFTI" | ApplicationData subset: AF Traffic Influence Data | +| "A_AFQOS" | ApplicationData subset: AF Requested QoS Data | +| "A_IPTV" | ApplicationData subset: IPTV Config Data | +| "A_BDT" | ApplicationData subset: Background Data Transfer | +| "A_SPD" | ApplicationData subset: Service Parameter Data | +| "A_EASD" | ApplicationData subset: EAS Deployment Information | +| "A_AMI" | ApplicationData subset: AM Influence Data | +| "P_UE" | PolicyData subset: UE Specific Data | +| "P_SCD" | PolicyData subset: Sponsored Connectivity Data | +| "P_BDT" | PolicyData subset: Background Data Transfer | +| "P_PLMNUE" | PolicyData subset: PLMN specific UE policy data | +| "P_NSSCD" | PolicyData subset: Network Slice Specific Control Data | +| "P_PDTQ" | PolicyData subset: Planned Data Transfer with QoS requirements Data | +| "P_MBSCD" | PolicyData subset: MBS Session Policy Control Data | +| "P_GROUP" | PolicyData subset: Group Policy Control Data | +| NOTE: | Enumeration values identifying an ApplicationData subset or PolicyData subset should not be used in NF discovery requests unless UDR and NRF have been upgraded to support these values.
If the UDR registers all defined ApplicationData subset values and/or all defined PolicyData subset values, it shall also register the ApplicationData data set value and/or PolicyData data set value.
The UDR that registers the Application Data set value and/or the Policy Data set value shall also register all defined ApplicationData subset values and/or PolicyData subset values. | + +## 6.1.6.3.9 Enumeration: UPInterfaceType + +**Table 6.1.6.3.9-1: Enumeration UPInterfaceType** + +| Enumeration value | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| +| "N3" | User Plane Interface: N3 (or N3 for 3GPP Access, see NOTE 2) | +| "N6" | User Plane Interface: N6 | +| "N9" | User Plane Interface: N9 (or N9 for non-roaming, see NOTE 3) | +| "DATA_FORWARDING" | User Plane Interface for indirect data forwarding. (NOTE 1) | +| "N6MB" | User Plane Interface: N6mb | +| "N19MB" | User Plane Interface: N19mb | +| "N3MB" | User Plane Interface: N3mb | +| "NMB9" | User Plane Interface: Nmb9 | +| "S1U" | User Plane Interface: S1-U | +| "S5U" | User Plane Interface: S5-U | +| "S8U" | User Plane Interface: S8-U | +| "S11U" | User Plane Interface: S11-U | +| "S12" | User Plane Interface: S12 | +| "S2AU" | User Plane Interface: S2AU | +| "S2BU" | User Plane Interface: S2BU | +| "N3TRUSTEDN3GPP" | User Plane Interface: N3 Trusted Non-3GPP access | +| "N3UNTRUSTEDN3GPP" | User Plane Interface: N3 Untrusted Non-3GPP access | +| "N9ROAMING" | User Plane Interface: N9 for roaming interface | +| "SGI" | User Plane Interface: SGI | +| "N19" | User Plane Interface: N19 | +| "SXAU" | User Plane Interface: Sxa-U | +| "SXBU" | User Plane Interface: Sxb-U | +| "N4U" | User Plane Interface: N4-U | +| NOTE 1: This interface type may be used when a dedicated network instance is deployed for data forwarding. | | +| NOTE 2: If separation of N3 traffic from 3GPP access and non-3GPP access is required for a PLMN, this value should only be used for the N3 for 3GPP access. | | +| NOTE 3: If separation of roaming and non-roaming traffic is desired over N9, this value should only be used for N9 non-roaming interfaces. | | + +## 6.1.6.3.10 Relation Types + +## 6.1.6.3.10.1 General + +This clause describes the possible relation types defined within NRF API. See clause 4.7.5.2 of 3GPP TS 29.501 [5] for the description of the relation types. + +**Table 6.1.6.3.10.1-1: supported registered relation types** + +| Relation Name | +|---------------| +| self | +| item | + +6.1.6.3.11 Enumeration: ServiceName + +**Table 6.1.6.3.11-1: Enumeration ServiceName** + +| Enumeration value | Description | +|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| "nnrf-nfm" | Nnrf_NFManagement Service offered by the NRF | +| "nnrf-disc" | Nnrf_NFDiscovery Service offered by the NRF | +| "nnrf-oauth2" | Nnrf_AccessToken Service offered by the NRF | +| "nudm-sdm" | Nudm_SubscriberDataManagement Service offered by the UDM | +| "nudm-uecm" | Nudm_UEContextManagement Service offered by the UDM | +| "nudm-ueau" | Nudm_UEAuthentication Service offered by the UDM | +| "nudm-ee" | Nudm_EventExposure Service offered by the UDM | +| "nudm-pp" | Nudm_ParameterProvision Service offered by the UDM | +| "nudm-niddau" | Nudm_NIDDAuthorization Service offered by the UDM | +| "nudm-mt" | Nudm_MT Service offered by the UDM | +| "nudm-ssau" | Nudm_ServiceSpecificAuthorization Service offered by the UDM | +| "nudm-rsds" | Nudm_ReportSMDeliveryStatus Service offered by the UDM | +| "nudm-ueid" | Nudm_UEIdentifier Service offered by the UDM | +| "namf-comm" | Namf_Communication Service offered by the AMF | +| "namf-evts" | Namf_EventExposure Service offered by the AMF | +| "namf-mt" | Namf_MT Service offered by the AMF | +| "namf-loc" | Namf_Location Service offered by the AMF | +| "namf-mbs-comm" | Namf_MBSCommunication Service offered by AMF | +| "namf-mbs-bc" | Namf_MBSBroadcast Service offered by AMF | +| "nsmf-pdusession" | Nsmf_PDUSession Service offered by the SMF | +| "nsmf-event-exposure" | Nsmf_EventExposure Service offered by the SMF | +| "nsmf-nidd" | Nsmf_NIDD Service offered by the SMF | +| "nausf-auth" | Nausf_UEAuthentication Service offered by the AUSF | +| "nausf-sorprotection" | Nausf_SoRProtection Service offered by the AUSF | +| "nausf-upuprotection" | Nausf_UPUProtection Service offered by the AUSF | +| "nnef-pfdmanagement" | Nnef_PFDManagement offered by the NEF | +| "nnef-smcontext" | Nnef_SMContext Service offered by the NEF | +| "nnef-eventexposure" | Nnef_EventExposure Service offered by the NEF | +| "nnef-eas-deployment-info" | Nnef_EASDeployment InfoService offered by the NEF. This is the southbound part of the API (e.g. the service operations used by the SMF) | +| "nnef-dnai-mapping" | Nnef_DNAIMapping Service offered by the NEF | +| "nnef-traffic-influence-data" | Nnef_TrafficInfluenceData Service offered by the NEF | +| "nnef-ecs-addr-cfg-info" | Nnef_ECSAddress Service offered by the NEF | +| "3gpp-cp-parameter-provisioning" | Nnef_ParameterProvision Service offered by the NEF | +| "3gpp-device-triggering" | Nnef_Trigger Service offered by the NEF | +| "3gpp-bdt" | Nnef_BDTPNegotiation Service offered by the NEF | +| "3gpp-traffic-influence" | Nnef_TrafficInfluence Service offered by the NEF | +| "3gpp-chargeable-party" | Nnef_ChargeableParty Service offered by the NEF | +| "3gpp-as-session-with-qos" | Nnef_AFSsessionWithQoS Service offered by the NEF | +| "3gpp-msisdn-less-mo-sms" | Nnef_MSISDN-less_MO_SMS Service offered by the NEF | +| "3gpp-service-parameter" | Nnef_ServiceParameter Service offered by the NEF | +| "3gpp-monitoring-event" | Nnef_APISupportCapability Service offered by the NEF | +| "3gpp-nidd-configuration-trigger" | Nnef_NIDDConfiguration Service offered by the NEF | +| "3gpp-nidd" | Nnef_NIDD Service offered by the NEF | +| "3gpp-analyticsexposure" | Nnef_AnalyticsExposure Service offered by the NEF | +| "3gpp-racs-parameter-provisioning" | Nnef_UCMFProvisioning Service offered by the NEF | +| "3gpp-ecr-control" | Nnef_ECRestriction Service offered by the NEF | +| "3gpp-applying-bdt-policy" | Nnef_ApplyPolicy Service offered by the NEF | +| "3gpp-mo-lcs-notify" | Nnef_Location Service offered by the NEF | +| "3gpp-time-sync" | Nnef_TimeSynchronization Service offered by the NEF | +| "3gpp-am-influence" | Nnef_AMInfluence Service offered by the NEF | +| "3gpp-am-policyauthorization" | Nnef_AMPolicyAuthorization | +| "3gpp-akma" | Nnef_AKMA Service offered by the NEF | +| "3gpp-eas-deployment" | Nnef_EASDeployment Service offered by the NEF. This is the northbound part (e.g. the service operations used by the AF). | +| "3gpp-iptvconfiguration" | Nnef_IPTV_configuration Service offered by the NEF | +| "3gpp-mbs-tmgi" | Nnef_MBSTMGI Service offered by the NEF | +| "3gpp-mbs-session" | Nnef_MBSSession Service offered by the NEF | +| "3gpp-authentication" | Nnef_Authentication Service offered by the NEF | +| "3gpp-asti" | Nnef_ASTI Service offered by the NEF | +| "3gpp-pdtq-policy-negotiation" | Nnef_PDTQPolicyNegotiation offered by the NEF | + +| | | +|--------------------------------|--------------------------------------------------------------| +| "3gpp-musa" | Nnef_MemberUESelectionAssistance offered by the NEF | +| "npcf-am-policy-control" | Npcf_AMPolicyControl Service offered by the PCF | +| "npcf-smpolicycontrol" | Npcf_SMPolicyControl Service offered by the PCF | +| "npcf-policyauthorization" | Npcf_PolicyAuthorization Service offered by the PCF | +| "npcf-bdtpolicycontrol" | Npcf_BDTPolicyControl Service offered by the PCF | +| "npcf-eventexposure" | Npcf_EventExposure Service offered by the PCF | +| "npcf-ue-policy-control" | Npcf_UEPolicyControl Service offered by the PCF | +| "npcf-am-policyauthorization" | Npcf_AM_PolicyAuthorization Service offered by the PCF | +| "npcf-pdtq-policy-control" | Npcf_PDTQPolicyControl Service offered by the PCF | +| "npcf-mbspolicycontrol" | Npcf_MBSPolicyControl Service offered by the PCF | +| "npcf-mbspolicyauth" | Npcf_MBSPolicyAuthorization Service offered by the PCF | +| "nsmf-sms" | Nsmf_SMSService Service offered by the SMSF | +| "nssf-nselection" | Nssf_NSSelection Service offered by the NSSF | +| "nssf-nssaiavailability" | Nssf_NSSAIAvailability Service offered by the NSSF | +| "nudr-dr" | Nudr_DataRepository Service offered by the UDR | +| "nudr-group-id-map" | Nudr_GroupIDmap Service offered by the UDR | +| "nlmf-loc" | Nlmf_Location Service offered by the LMF | +| "n5g-eir-eic" | N5g-eir_EquipmentIdentityCheck Service offered by the 5G-EIR | +| "nbsf-management" | Nbsf_Management Service offered by the BSF | +| "nchf-spendinglimitcontrol" | Nchf_SpendingLimitControl Service offered by the CHF | +| "nchf-convergedcharging" | Nchf_Converged_Charging Service offered by the CHF | +| "nchf-offlineonlycharging" | Nchf_OfflineOnlyCharging Service offered by the CHF | +| "nnwdaf-eventssubscription" | Nnwdaf_EventsSubscription Service offered by the NWDAF | +| "nnwdaf-analyticsinfo" | Nnwdaf_AnalyticsInfo Service offered by the NWDAF | +| "nnwdaf-datamanagement" | Nnwdaf_DataManagement Service offered by the NWDAF | +| "nnwdaf-mlmodelprovision" | Nnwdaf_MLModelProvision Service offered by the NWDAF | +| "nnwdaf-mlmodeltraining" | Nnwdaf_MLModelTraining Service offered by the NWDAF | +| "nnwdaf-mlmodelmonitor" | Nnwdaf_MLModelMonitor Service offered by the NWDAF | +| "ngmlc-loc" | Ngmlc_Location Service offered by GMLC | +| "nucmf-provisioning" | Nucmf_Provisioning Service offered by UCMF | +| "nucmf-uecapabilitymanagement" | Nucmf_UECapabilityManagement Service offered by UCMF | +| "nhss-sdm" | Nhss_SubscriberDataManagement Service offered by the HSS | +| "nhss-uecm" | Nhss_UEContextManagement Service offered by the HSS | +| "nhss-ueau" | Nhss_UEAuthentication Service offered by the HSS | +| "nhss-ee" | Nhss_EventExposure Service offered by the HSS | +| "nhss-ims-sdm" | Nhss_imsSubscriberDataManagement Service offered by the HSS | +| "nhss-ims-uecm" | Nhss_imsUEContextManagement Service offered by the HSS | +| "nhss-ims-ueau" | Nhss_imsUEAuthentication Service offered by the HSS | +| "nhss-gba-sdm" | Nhss_gbaSubscriberDataManagement Service offered by the HSS | +| "nhss-gba-ueau" | Nhss_gbaUEAuthentication Service offered by the HSS | +| "nsepp-telescopic" | Nsepp_Telescopic_FQDN_Mapping Service offered by the SEPP | +| "nsoraf-sor" | Nsoraf_SteeringOfRoaming Service offered by the SOR-AF | +| "nspaf-secured-packed" | Nspaf_SecuredPacket Service offered by the SP-AF | +| "nudsf-dr" | Nudsf_Data Repository service offered by the UDSF. | +| "nudsf-timer" | Nudsf_Timer service offered by the UDSF | +| "nnssAAF-nssaa" | NnssAAF_NSSAA service offered by the NSSAAF. | +| "nnssAAF-aiw" | NnssAAF_AIW service offered by the NSSAAF. | +| "naanf-akma" | Naanf_AKMA service offered by the AAnF. | +| "n5gddnmf-discovery" | N5g-ddnmf_Discovery service offered by 5G DDNMF | +| "nmfaf-3dadm" | Nmfaf_3daDataManagement service offered by the MFAF. | +| "nmfaf-3cadm" | Nmfaf_3caDataManagement service offered by the MFAF. | +| "neasdf-dnscontext" | Neasdf_DNSContext service offered by the EASDF | +| "neasdf-baselinednspattern" | Neasdf_BaselineDNSPattern service offered by the EASDF | +| "ndccf-dm" | Ndccf_DataManagement service offered by the DCCF. | +| "ndccf-cm" | Ndccf_ContextManagement service offered by the DCCF. | +| "nnsacf-nsac" | Nnsacf_NSAC service offered by the NSACF. | +| "nnsacf-slice-ee" | Nnsacf_SliceEventExposure service offered by the NSACF. | +| "nmbsmf-tmgi" | Nmbsmf_TMGI service offered by the MB-SMF | +| "nmbsmf-mbssession" | Nmbsmf_MBSSession service offered by the MB-SMF | +| "nadrf-dm" | Nadrf_DataManagement service offered by the ADRF. | +| "nadrf-mlmodelmanagement" | Nadrf_MLModelManagement service offered by the ADRF. | + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------| +| "nbsp-gba" | Nbsp_GBA service offered by the GBA BSF. | +| "ntsctsf-time-sync" | Ntsctsf_TimeSynchronization service offered by the TSCTSF | +| "ntsctsf-qos-tscai" | Ntsctsf_QoSAndTSCAssistance service offered by the TSCTSF | +| "ntsctsf-asti" | Ntsctsf_ASTI service offered by the TSCTSF | +| "npkmf-keyrequest" | Npkmf_PKMFKeyRequest service offered by the PKMF | +| "npkmf-userid" | Npkmf_ResolveRemoteUserId service offered by the PKMF | +| "npkmf-discovery" | Npkmf_Discovery service offered by the PKMF | +| "nmnpf-npstatus" | Nmnpf_NPStatus service offered by the MNPF | +| "niwmsc-smsservice" | Niwmsc_SMSService service offered by the SMS-IWMSC | +| "nmbsf-mbs-us" | Nmbsf_MBSUserService service offered by the MBSF | +| "nmbsf-mbs-ud-ingest" | Nmbsf_MBSUserDataIngestSession service offered by the MBSF | +| "nmbstf-distsession" | Nmbstf_MBSDistributionSession service offered by the MBSTF | +| "npanf-prosekey" | Npanf_ProseKey service offered by the PANF | +| "npanf-userid" | Npanf_ResolveRemoteUserId service offered by the PANF | +| "nupf-ee" | Nupf_EventExposure service offered by the UPF | +| "nupf-gueip" | Nupf_GetUEPrivateIPAddrAndIdentifiers Service offered by the UPF | +| "naf-prose" | Naf_ProSe Service offered by the AF | +| "naf-eventexposure" | Naf_EventExposure Service offered by the AF | +| NOTE: The services defined in this table are those defined by 3GPP NFs in 5GC; however, in order to support custom services offered by standard and custom NFs, the NRF shall also accept the registration of NF Services with other service names. | | + +#### 6.1.6.3.12 Enumeration: NFServiceStatus + +**Table 6.1.6.3.12-1: Enumeration NFServiceStatus** + +| Enumeration value | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "REGISTERED" | The NF Service Instance is registered in NRF and can be discovered by other NFs.
(NOTE 2) | +| "SUSPENDED" | The NF Service Instance is registered in NRF but it is not operative and cannot be discovered by other NFs.
This status may result from a NF Service failure and may trigger restoration procedures (see clause 6.2 of 3GPP TS 23.527 [27]). | +| "UNDISCOVERABLE" | The NF Service instance is registered in NRF, is operative but cannot be discovered by other NFs.
This status may be set by the NF e.g. in shutting down scenarios where the NF service is still able to process requests for existing resources or sessions but cannot accept new resource creation or session establishment. | +| "CANARY_RELEASE" | The NF Service Instance is registered in NRF, is operative and can be discovered and selected by other NFs under certain conditions (see SelectionConditions, in clause 6.1.6.2.123).

This status may be set by the NF e.g. in upgrade scenarios or during canary testing scenarios where the NF is able to process requests for new resource creation or session establishment under certain conditions (e.g. for a restricted set of users).

(NOTE 3) | +| NOTE 1: An NF service cannot be discovered by other NFs if the NF status is set to "SUSPENDED" or "UNDISCOVERABLE", regardless of the NF service status. | | +| NOTE 2: A discovered NF service instance with NFServiceStatus set to "REGISTERED", and with NFStatus of the NF Instance set to "CANARY_RELEASE", shall only be selected by an NF Service Consumer if the conditions included in the "selectionConditions" attribute of the NFProfile are evaluated to ; if such attribute is not included in NFProfile, the NF service instance shall not be selected. | | +| NOTE 3: A discovered NF service instance with NFServiceStatus "CANARY_RELEASE" shall only be selected by an NF Service Consumer if the conditions included in the "selectionConditions" attribute of the NFService are evaluated to ; if such attribute is not included in NFService, the NF service instance shall not be selected. | | + +## 6.1.6.3.13 Enumeration: AnNodeType + +**Table 6.1.6.3.13-1: Enumeration AnNodeType** + +| Enumeration value | Description | +|-------------------|-------------| +| "GNB" | gNB | +| "NG_ENB" | NG-eNB | + +## 6.1.6.3.14 Enumeration: ConditionEventType + +**Table 6.1.6.3.14-1: Enumeration ConditionEventType** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------------------------------------------------------| +| "NF_ADDED" | The NF Instance notified by NRF starts being part of a condition for a subscription on a set of NFs. | +| "NF_REMOVED" | The NF Instance notified by NRF stops being part of a condition for a subscription on a set of NFs. | + +## 6.1.6.3.15 Enumeration: IpReachability + +**Table 6.1.6.3.15-1: Enumeration IpReachability** + +| Enumeration value | Description | +|-------------------|-------------------------------------------------------| +| "IPv4" | Only IPv4 addresses are reachable. | +| "IPv6" | Only IPv6 addresses are reachable. | +| "IPv4V6" | Both IPv4 addresses and IPv6 addresses are reachable. | + +## 6.1.6.3.16 Enumeration: ScpCapability + +**Table 6.1.6.3.16-1: Enumeration ScpCapability** + +| Enumeration value | Description | +|--------------------------------|-----------------------------------------------------------| +| "INDIRECT_COM_WITH_DELEG_DISC" | Indirect communication with delegated discovery supported | + +## 6.1.6.3.17 Enumeration: CollocatedNfType + +**Table 6.1.6.3.17-1: Enumeration CollocatedNfType** + +| Enumeration value | Description | +|-------------------|--------------------------| +| "UPF" | Network function: UPF | +| "SMF" | Network function: SMF | +| "MB_UPF" | Network function: MB-UPF | +| "MB_SMF" | Network function: MB-SMF | + +## 6.1.6.3.18 Enumeration: LocalityType + +**Table 6.1.6.3.18-1: Enumeration LocalityType** + +| Enumeration value | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| "DATA_CENTER" | Data center | +| "CITY" | City | +| "COUNTY" | County | +| "DISTRICT" | District | +| "STATE" | State | +| "CANTON" | Canton | +| "REGION" | Region | +| "PROVINCE" | Province | +| "PREFECTURE" | Prefecture | +| "COUNTRY" | Country | +| NOTE 1: An operator may define custom locality types other than those defined in this table. The NRF and NFs shall accept locality types defined with custom locality type values. | | +| NOTE 2: The NRF needs not understand the semantic of the LocalityType enumeration values. The LocalityType information is used by the NRF to correlate a locality description received in the ext-preferred-locality query parameter with a locality description registered in the extLocality attribute of NFProfile with a matching LocalityType. | | + +## 6.1.6.3.19 Enumeration: FICapabilityType + +**Table 6.1.6.3.19-1: Enumeration FICapabilityType** + +| Enumeration value | Description | +|------------------------|----------------------------------------------------------------| +| "FL_SERVER" | NWDAF containing MTLF as Federated Learning server. | +| "FL_CLIENT" | NWDAF containing MTLF as Federated Learning client. | +| "FL_SERVER_AND_CLIENT" | NWDAF containing MTLF as Federated Learning server and client. | + +## 6.1.6.3.20 Void + +## 6.1.6.3.21 Enumeration: RuleSetAction + +**Table 6.1.6.3.21-1: Enumeration RuleSetAction** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------| +| "ALLOW" | The NF consumer is allowed to access NF producer | +| "DENY" | The NF consumer is not allowed to access NF Producer | + +## 6.1.7 Error Handling + +## 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +## 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +## 6.1.7.3 Application Errors + +The application errors defined for the Nnrf\_NFManagement service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|--------------------------|-------------------------|---------------------------------------------------------------------------------------------------------| +| SUBSCRIPTION_NOT_ALLOWED | 403 Forbidden | It is used when the validation of the authorization parameters in the subscription request has failed. | +| NF_NOT_FOUND | 404 Not Found | It is used when no NFProfile corresponding to the NF Instance Id in NfInstanceIdCond exists in the NRF. | + +## 6.1.8 Security + +As indicated in clause 13.3 of 3GPP TS 33.501 [15], when static authorization is not used, the access to the Nnrf\_NFManagement API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [16]), using the "Client Credentials" authorization grant, where the NRF plays the role of the authorization server. + +If OAuth2 authorization is used on the Nnrf\_NFManagement API, an NF Service Consumer, prior to consuming services offered by the Nnrf\_NFManagement API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF where the Nnrf\_NFManagement service is invoked by the NF Service Producer. + +The Nnrf\_NFManagement API defines the following scopes for OAuth2 authorization: + +**Table 6.1.8-1: OAuth2 scopes defined in Nnrf\_NFManagement API** + +| Scope | Description | +|------------------------------------------------|------------------------------------------------------------------------------------| +| "nnrf-nfm" | Access to the Nnrf_NFManagement API | +| "nnrf-nfm:nf-instances:read" | Access to read the nf-instances resource, or an individual NF Instance ID resource | +| "nnrf-nfm:subscriptions:subs-complete-profile" | Access to subscribe to the complete profile of NF instances | +| "nnrf-nfm:nf-instance:write" | Access to write (create, update, delete) an individual NF Instance ID resource | + +## 6.1.9 Features supported by the NFManagement service + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [7]. + +The following features are defined for the Nnrf\_NFManagement service. + +**Table 6.1.9-1: Features of supportedFeatures attribute used by Nnrf\_NFManagement service** + +| Feature Number | Feature | M/O | Description | +|----------------|-------------------------------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Service-Map | M | Support of defining in the profile of the NF Instance the list of NF Service Instances based on a map type (i.e. support of the "nfServiceList" attribute in NFProfile). | +| 2 | Empty-Objects-Nrf-Info | O | Support of receiving empty JSON objects as values in the servedxxxInfo/servedxxxInfoList map attributes of the NrfInfo data structure used by an NRF during registration into another NRF (see clause 6.1.6.2.31).

An NRF that supports registering into another NRF shall support this feature. | +| 3 | Inter-Plmn-Fqdn | M | Support of receiving intra-PLMN notification of changes in the NFProfile/NFService containing the "interPlmnFqdn" attribute (see clauses 6.1.6.2.2 and 6.1.6.2.3).

The NRF shall not send intra-PLMN notifications containing the "interPlmnFqdn" attribute to subscribing NF Instances that don't support this feature. | +| 4 | Complete-Profile-Subscription | O | Support subscriptions to the complete NF Profile of NF Instances (including, e.g. the authorization attributes) and their notifications. | +| 5 | Allowed-ruleset | O | Support registering RuleSets in NF (Service) profile | +| 6 | Canary-Release | O | Support of "CANARY_RELEASE" value for NFStatus and NFServiceStatus, used for e.g. canary testing | + +Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1). +Feature: A short name that can be used to refer to the bit and to the feature. +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). +Description: A clear textual description of the feature. + +## 6.2 Nnrf\_NFDiscovery Service API + +### 6.2.1 API URI + +The API URI of the Nnrf\_NFDiscovery API shall be: + +**{apiRoot}** + +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.: + +**{apiRoot}** + +where: + +- the {apiRoot} shall be set as defined in clause 4.4.1 of 3GPP TS 29.501 [5]; +- the shall be set to "nnrf-disc"; +- the shall be set to "v1" for the current version of this specification; +- the shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nnrf\_NFDiscovery service shall comply with the OpenAPI [10] specification contained in Annex A. + +## 6.2.2.2 HTTP standard headers + +### 6.2.2.2.1 General + +The mandatory standard HTTP headers as specified in clause 5.2.2.2 of 3GPP TS 29.500 [4] shall be supported. + +### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- The JSON format (IETF RFC 8259 [22]). The use of the JSON format shall be signalled by the content type "application/json". See also clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [11]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +### 6.2.2.2.3 Cache-Control + +A "Cache-Control" header should be included in HTTP responses, as described in IETF RFC 9111 [20], clause 5.2. It shall contain a "max-age" value, indicating the amount of time in seconds after which the received response is considered stale; this value shall be the same as the content of the "validityPeriod" element described in clause 6.2.6.2.2. + +### 6.2.2.2.4 ETag + +An "ETag" (entity-tag) header should be included in HTTP responses, as described in IETF RFC 9110 [40], clause 8.8.3. It shall contain a server-generated strong validator, that allows further matching of this value (included in subsequent client requests) with a given resource representation stored in the server or in a cache. + +### 6.2.2.2.5 If-None-Match + +An NF Service Consumer should issue conditional GET request towards NRF, by including an If-None-Match header in HTTP requests, as described in IETF RFC 9110 [40], clause 13.1.2, containing one or several entity tags received in previous responses for the same resource. + +## 6.2.2.3 HTTP custom headers + +### 6.2.2.3.1 General + +In this release of this specification, no custom headers specific to the Nnrf\_NFDiscovery service are defined. For 3GPP specific HTTP custom headers used across all service-based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.2.3 Resources + +### 6.2.3.1 Overview + +The structure of the Resource URIs of the NFDiscovery service is shown in figure 6.2.3.1-1. + +![Resource URI structure of the NFDiscovery API diagram](cf734b5645d3e02a8df25f67904cd2d3_img.jpg) + +``` +graph TD; Root["{apiRoot}/nnrf-disc/v1"] --- nf_instances["/nf-instances"]; Root --- searches["/searches"]; Root --- scp_domain_routing_info["/scp-domain-routing-info"]; Root --- scp_domain_routing_info_subs["/scp-domain-routing-info-subs"]; searches --- search_id["/{searchId}"]; search_id --- complete["/complete"]; scp_domain_routing_info_subs --- subscription_id["/{subscriptionID}"]; +``` + +The diagram illustrates the hierarchical structure of the NFDiscovery API. The root path is {apiRoot}/nnrf-disc/v1. From this root, four main resource paths branch out: /nf-instances, /searches, /scp-domain-routing-info, and /scp-domain-routing-info-subs. The /searches path further branches into /{searchId}, which in turn branches into /complete. The /scp-domain-routing-info-subs path branches into /{subscriptionID}. + +Resource URI structure of the NFDiscovery API diagram + +**Figure 6.2.3.1-1: Resource URI structure of the NFDiscovery API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------------------------------------|------------------------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nf-instances (Store) | /nf-instances | GET | Retrieve a collection of NF Instances according to certain filter criteria. | +| Stored Search (Document) | /searches/{searchId} | GET | Retrieve a collection of NF Instances, previously stored by NRF as a consequence of a prior search result. | +| Complete Stored Search (Document) | /searches/{searchId}/complete | GET | Retrieve a collection of NF Instances, previously stored by NRF as a consequence of a prior search result, without applying any client restriction on the number of instances (e.g. "limit" or "max-payload-size" query parameters). | +| SCP Domain Routing Information (Document) | /scp-domain-routing-info | GET | Retrieve the SCP Domain Routing Information. | +| SCP Domain Routing Info Subscriptions (Collection) | /scp-domain-routing-info-subs | POST | Subscribe to SCP Domain Routing Information change. | +| Individual SCP Domain Routing Info Subscription (Document) | /scp-domain-routing-info-subs/{subscriptionID} | DELETE | Unsubscribe to SCP Domain Routing Information change. | + +## 6.2.3.2 Resource: nf-instances (Store) + +### 6.2.3.2.1 Description + +This resource represents a collection of the different NF instances registered in the NRF. + +This resource is modelled as the Store resource archetype (see clause C.3 of 3GPP TS 29.501 [5]). + +### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-disc/v1/nf-instances + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +### 6.2.3.2.3 Resource Standard Methods + +#### 6.2.3.2.3.1 GET + +This operation retrieves a list of NF Instances, and their offered services, currently registered in the NRF, satisfying a number of filter criteria, such as those NF Instances offering a certain service name, or those NF Instances of a given NF type (e.g., AMF). + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| target-nf-type | NFType | M | 1 | This IE shall contain the NF type of the target NF being discovered. | | +| requester-nf-type | NFType | M | 1 | This IE shall contain the NF type of the Requester NF that is invoking the Nnrf_NFDiscovery service. | | +| preferred-collocated-nf-types | array(CollocatedNFType) | O | 1..N | The IE may be present to indicate desired collocated NF type(s) when the NF service consumer wants to discover candidate NFs matching the target NF Type that are preferentially collocated with other NF types. (NOTE 19) | Collocated-NF-Selection | +| requester-nf-instance-id | NfInstanceId | O | 0..1 | If included, this IE shall contain the NF instance id of the Requester NF. | Query-Params-Ext2 | +| service-names | array(ServiceName) | O | 1..N |

If included, this IE shall contain an array of service names for which the NRF is queried to provide the list of NF profiles.

The NRF shall return the NF profiles that have at least one NF service matching the NF service names in this list.

The NF services returned by the NRF (inside the nfServices or nfServiceList attributes) in each matching NFProfile shall be those services whose service name matches one of the service names included in this list.

If not included, the NRF shall not filter based on service name.

This array shall contain unique items.

Example:

 NF1 supports services: A, B, C NF2 supports services:      C, D, E NF3 supports services: A,      C,      E NF4 supports services:    B, C, D  Consumer asks for service-names=A,E  NRF returns:  NF1 containing service A NF2 containing service E NF3 containing services A, E NF4 is not returned
| | +| requester-nf-instance-fqdn | Fqdn | O | 0..1 |

This IE may be present for an NF discovery request within the same PLMN as the NRF.

If included, this IE shall contain the FQDN of the Requester NF that is invoking the Nnrf_NFDiscovery service.

The NRF shall use this to return only those NF profiles that include at least one NF service containing an entry in the "allowedNfDomains" list (see clause 6.1.6.2.3) that matches the domain of the requester NF.

This IE shall be ignored by the NRF if it is received from a requester NF belonging to a different PLMN. (NOTE 12)

| | +| target-plmn-list | array(PlmnId) | C | 1..N |

This IE shall be included when NF services in a different PLMN, or NF services of specific PLMN ID(s) in a same PLMN comprising multiple PLMN IDs, need to be discovered. When included, this IE shall contain the PLMN ID of the target NF. If more than one PLMN ID is included, NFs from any PLMN ID present in the list matches the query parameter.

This IE shall also be included in SNPN scenarios, when the entity owning the subscription, the Credentials Holder (see clause 5.30.2.9 in 3GPP TS 23.501 [2]) is a PLMN.

For inter-PLMN service discovery, at most 1 PLMN ID shall be included in the list; it shall be included in the service discovery from the NF in the source PLMN sent to the NRF in the same PLMN, while it may be absent in the service discovery request sent from the source NRF to the target NRF. In such case, if the NRF receives more than 1 PLMN ID, it shall only consider the

| | + +| | | | | | | +|--|--|--|--|--------------------------------------------------|--| +| | | | | first element of the array, and ignore the rest. | | +|--|--|--|--|--------------------------------------------------|--| + +| | | | | | | +|----------------------------|---------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| requester-plmn-list | array(PlmnId) | C | 1..N | This IE shall be included when NF services in a different PLMN need to be discovered. It may be present when NF services in the same PLMN need to be discovered. When included, this IE shall contain the PLMN ID(s) of the requester NF. (NOTE 12) | | +| requester-snpn-list | array(PlmnIdNid) | C | 1..N | This IE shall be included when the Requester NF belongs to one or several SNPNs, and NF services of a specific SNPN or PLMN need to be discovered. The SNPN scenarios include use cases when CH/DCS is using AAA-S or when CH/DCS is using AUSF/UDM, see clauses 5.30.2.9.2, 5.30.2.9.3 and 5.30.2.10.2.2 in 3GPP TS 23.501 [2]). It may be present when NF services from the same SNPN need to be discovered. When present, this IE shall contain the SNPN ID(s) of the requester NF.
The NRF shall use this to return only those NF profiles of NF Instances allowing to be discovered from the SNPNs identified by this IE, according to the "allowedSnpons" list in the NF Profile and NF Service (see clauses 6.1.6.2.2 and 6.1.6.2.3). | Query-Params-Ext2 | +| target-nf-instance-id | NfInstanceId | O | 0..1 | Identity of the NF instance being discovered. | | +| target-nf-instance-id-list | array(NfInstanceId) | O | 2..N | Identities of the NF instances being discovered. (NOTE 26)
If included, the NRF shall return the NF profile of each NF instance indicated in this query parameter that is available at the NRF. | Enh-NF-Discovery-Ext1 | +| target-nf-fqdn | Fqdn | O | 0..1 | FQDN of the target NF instance being discovered. | | +| hnr-uri | Uri | C | 0..1 | If included, this IE shall contain the API URI of the NFDiscovery Service (see clause 6.2.1) of the home NRF. It shall be included if the Requester NF has previously received such API URI to be used for service discovery (e.g., from the NSSF in the home PLMN as specified in clause 6.1.6.2.11 of 3GPP TS 29.531 [42]). | | +| snssais | array(Snssai) | O | 1..N | If included, this IE shall contain the list of S-NSSAIs that are served by the NF (Service) Instances being discovered. The NRF shall return those NF profiles/NF services of NF (Service) Instances that have at least one of the S-NSSAIs in this list. The S-NSSAIs included in the NF profiles/NF services of NF (Service) Instances returned by the NRF shall be an interclause of the S-NSSAIs requested and the S-NSSAIs supported by those NF (Service) Instances. (NOTE 10)
When the NF Profile of the NF Instances being discovered has defined the list of supported S-NSSAIs in the "perPlmnSnssaiList", the discovered NF Instances shall be those having any of the S-NSSAIs included in this "snssais" parameter in any of the PLMNs included in the "target-plmn-list" attribute, if present; if the "target-plmn-list" is not included, the NRF shall assume that the discovery request is for any of the PLMNs it supports. | | +| additional-snssais | array(ExtSnssai) | O | 1..N | This IE may be included if the "snssais" IE is present.

If this IE is present and supported by the NRF, when the NRF has successfully discovered NF (service) instances based on the "snssais" IE, the S-NSSAIs included in the NF profiles/NF services of NF (Service) Instances returned by the NRF shall additionally include the interclause of the S-NSSAIs listed in this IE and the S-NSSAIs supported by those NF (Service) Instances.

When the NF Profile of the NF Instances in the discovery result has defined the list of supported S-NSSAIs in the "perPlmnSnssaiList", the additional S-NSSAIs to be included shall be the ones supported in the PLMN(s) indicated in the "target-plmn-list" attribute, if present; if the "target-plmn-list" is not present, the additional S-NSSAIs in any supported PLMN(s) shall be included. | Query-SBIProtoc18 | +| requester-snssais | array(ExtSnssai) | O | 1..N | If included, this IE shall contain the list of S-NSSAI of the requester NF. If this IE is included in a service discovery in a different PLMN, the requester NF shall provide S-NSSAI values of the target PLMN, that correspond to the S-NSSAI values of | | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

the requester NF.
The NRF shall use this to return only those NF Instances allowing to be discovered from at least one network slice identified by this IE, according to the "allowedNssais" list in the NF Profile and NF Service (see clause 6.1.6.2.2 and 6.1.6.2.3). (NOTE 12)

| | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------------------------|-------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| plmn-specific-snssai-list | array(PlmnSnssai) | O | 1..N | If included, this IE shall contain the list of S-NSSAI that are served by the NF service being discovered for the corresponding PLMN provided. The NRF shall use this to identify the NF services that have registered their support for the S-NSSAIs for the corresponding PLMN given. The NRF shall return the NF profiles that have at least one S-NSSAI supported in any of the PLMNs provided in this list. The per PLMN list of S-NSSAIs included in the NF profile returned by the NRF shall be an interclause of the list requested and the list registered in the NF profile. (NOTE 10). | | +| requester-plmn-specific-snssai-list | array(PlmnSnssai) | O | 1..N | If included, this IE shall contain the list of S-NSSAI of the requester NF, for each of the PLMNs it supports. The NRF shall use this to return only those NF profiles of NF Instances allowing to be discovered from at least one network slice identified by this IE, according to the "allowedNssais" and "allowedPlmns" attributes in the NF Profile and NF Service (see clause 6.1.6.2.2 and 6.1.6.2.3). (NOTE 12) | Query-Params-Ext3 | +| nsi-list | array(string) | O | 1..N | If included, this IE shall contain the list of NSI IDs that are served by the services being discovered. | | +| dnn | Dnn | O | 0..1 | If included, this IE shall contain the DNN for which NF services serving that DNN is discovered. DNN may be included if the target NF type is e.g. "BSF", "SMF", "PCF", "PCSCF", "UPF", "EASDF", "TSCTSF", "MB-UPF" or "MB-SMF".
The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. (NOTE 11).
If the Snssai(s) are also included, the NF services serving the DNN shall be available in the network slice(s) identified by the Snssai(s). | | +| ipv4-index | lpIndex | O | 0..1 | This IE may be included if the target NF type is "UPF" and the dnn IE is included.

When included, this IE shall indicate the IPv4 index that is supported by the candidate UPF. | Query-Upf-IpIndex | +| ipv6-index | lpIndex | O | 0..1 | This IE may be included if the target NF type is "UPF" and the dnn IE is included.

When included, this IE shall indicate the IPv6 index that is supported by the candidate UPF. | Query-Upf-IpIndex | +| smf-serving-area | string | O | 0..1 | If included, this IE shall contain the serving area of the SMF. It may be included if the target NF type is "UPF". | | +| mbsmf-serving-area | string | O | 0..1 | If included, this IE shall contain the serving area of the MB-SMF. It may be included if the target NF type is "MB-UPF". | Query-MBS | +| tai | Tai | O | 0..1 | Tracking Area Identity. (NOTE 22). | | +| amf-region-id | AmfRegionId | O | 0..1 | AMF Region Identity. | | +| amf-set-id | AmfSetId | O | 0..1 | AMF Set Identity. | | +| guami | Guami | O | 0..1 | Guami used to search for an appropriate AMF. (NOTE 1) | | +| supi | Supi | O | 0..1 | If included, this IE shall contain the SUPI of the requester UE to search for an appropriate NF. SUPI may be included if the target NF type is e.g. "PCF", "CHF", "AUSF", "BSF", "UDM", "TSCTSF", "NSSAAF" or "UDR". | | +| ue-ipv4-address | Ipv4Addr | O | 0..1 | The IPv4 address of the UE for which a BSF or P-CSCF or UPF needs to be discovered. (NOTE 27) | | +| ip-domain | string | O | 0..1 | The IPv4 address domain of the UE for which a BSF needs to be discovered. | | +| ue-ipv6-prefix | Ipv6Prefix | O | 0..1 | The IPv6 prefix of the UE for which a BSF or P-CSCF or UPF needs to be discovered. (NOTE 27) | | +| pgw-ind | boolean | O | 0..1 | When present, this IE indicates whether a combined SMF/PGW-C or a standalone SMF needs to be discovered.

true: A combined SMF/PGW-C is requested to be discovered;
false: A standalone SMF is requested to be discovered.
(See NOTE 2, NOTE 21) | | +| preferred-pgw-ind | boolean | O | 0..1 | When present, this IE indicates whether combined PGW-C+SMF(s) or standalone SMF(s) are preferred. | Query-SBIPROTO | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| | | | | true: Combined PGW-C+SMF(s) are preferred to be discovered;
false: Standalone SMF(s) are preferred to be discovered.
(See NOTE 2, NOTE 20, NOTE 21) | c17 | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------|-----| + +| | | | | | | +|-------------------------|---------------------------------|---|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| pgw | Fqdn | O | 0..1 | If included, this IE shall contain the PGW FQDN which is used by the AMF to find the combined SMF/PGW-C. | | +| pgw-ip | IpAddr | O | 0..1 | If included, this IE shall contain the PGW IP Address used by the AMF to find the combined SMF/PGW-C. | Query-SBIProtoc17 | +| gpsi | Gpsi | O | 0..1 | If included, this IE shall contain the GPSI of the requester UE to search for an appropriate NF. GPSI may be included if the target NF type is "CHF", "PCF", "BSF", "UDM", "TSCTSF" or "UDR". | | +| external-group-identity | ExtGroupId | O | 0..1 | If included, this IE shall contain the external group identifier of the requester UE to search for an appropriate NF. This may be included if the target NF type is "UDM", "UDR", "HSS" or "TSCTSF". | | +| pfd-data | PfdData | O | 0..1 | When present, this IE shall contain the application identifiers and/or application function identifiers in PFD management. This may be included if the target NF type is "NEF".
The NRF shall return those NEF instances which can provide the PFDs for at least one of the provided application identifiers, or for at least one of the provided application function identifiers. | Query-Params-Ext2 | +| data-set | DataSetId | O | 0..1 | Indicates the data set to be supported by the NF to be discovered. May be included if the target NF type is "UDR". | | +| routing-indicator | string | O | 0..1 | Routing Indicator information that allows to route network signalling with SUCI (see 3GPP TS 23.003 [12]) to an AUSF, AAnF and UDM instance capable to serve the subscriber. May be included if the target NF type is "AUSF", "AANF" or "UDM".
Pattern: "^[0-9]{1,4}\$" | | +| group-id-list | array(NfGroupId) | O | 1..N | Identity of the group(s) of the NFs of the target NF type to be discovered. May be included if the target NF type is "UDR", "UDM", "HSS", "PCF", "AUSF", "BSF" or "CHF". | | +| dnai-list | array(Dnai) | O | 1..N | If included, this IE shall contain the Data network access identifiers. It may be included if the target NF type is "UPF", "SMF", "EASDF" or "NEF". | | +| upf-iwk-eps-ind | boolean | O | 0..1 | When present, this IE indicates whether a UPF supporting interworking with EPS needs to be discovered.

true: A UPF supporting interworking with EPS is requested to be discovered;
false: A UPF not supporting interworking with EPS is requested to be discovered.
(NOTE 3) | | +| chf-supported-plmn | PlmnId | O | 0..1 | If included, this IE shall contain the PLMN ID that a CHF supports (i.e., in the PlmnRange of ChfInfo attribute in the NFProfile). This IE may be included when the target NF type is "CHF".

When an SMF discovers CHF(s) for a PDU session, the SMF shall set the value of this IE as specified in clause 5.1.9.2 of 3GPP TS 32.255 [46]. | | +| preferred-locality | string | O | 0..1 | Preferred target NF location (e.g. geographic location, data center).
When present, the NRF shall prefer NF profiles with a locality attribute that matches the preferred-locality.
The NRF may return additional NFs in the response not matching the preferred target NF location, e.g. if no NF profile is found matching the preferred target NF location.
The NRF should set a lower priority for any additional NFs on the response not matching the preferred target NF location than those matching the preferred target NF location. In addition, based on operator's policy, the NRF may set different priorities based on the localities of the NFs.
(NOTE 6, NOTE 25) | | +| ext-preferred-locality | map(array(LocalityDescription)) | O | 1..N(
1..M) | Preferred target NF location (e.g. geographic location, data center).
The key of the map shall represent the relative priority, for the requester, of each locality description among the list of locality descriptions in this query parameter, encoded as "1" (highest priority), "2", "3", ..., "n" (lowest priority). | Query-SBIProtoc18 | + +| | | | | | +|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | |

When present, the NRF shall prefer NF profiles with an extLocality attribute that matches at least one LocalityDescription of the ext-preferred-locality, with the highest possible priority.

The NRF may return additional NFs in the response not matching the preferred target NF location, e.g. if no NF profile is found matching the preferred target NF location.

The NRF should set the priority of each NF profile returned in the response based on the priority associated with the matching locality description of the ext-preferred-locality. The NRF should set a lower priority for any additional NFs in the response not matching the preferred target NF location than those matching the preferred target NF location. In addition, based on operator's policy, the NRF may set different priorities based on the localities of the NFs.
(NOTE 6)

Example 1 indicating a preference to discover an NFp in the data center "dc-123" as a first choice, otherwise in the city of Los Angeles or San Diego as a second choice, otherwise in the state of California as a third choice.

{   "1": [{"localityType": "DATA_CENTER", "localityValue": "dc-123"}],   "2": [{"localityType": "CITY", "localityValue": "Los Angeles"},         {"localityType": "CITY", "localityValue": "San Diego"}],   "3": [{"localityType": "STATE", "localityValue": "California"}] }

Example 2 indicating a preference to discover an NFp in the data center "dc-123" as a first choice, otherwise in the data center "dc-456" or "dc-789" as a second choice.

{   "1": [{"localityType": "DATA_CENTER", "localityValue": "dc-123"}],   "2": [{"localityType": "DATA_CENTER", "localityValue": "dc-456"},         {"localityType": "DATA_CENTER", "localityValue": "dc-789"}] }

Example 3 indicating a preference to discover an NFp in the city of Bath and in the state of Virginia as a first choice, otherwise in the state of Virginia as a second choice.

{   "1": [{"localityType": "CITY", "localityValue": "Bath",         "addLocDescItems": [{"localityType": "STATE", "localityValue":           "Virginia"}]}],   "2": [{"localityType": "STATE", "localityValue": "Virginia"}] }

(NOTE 25)

| | +|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|----------------------|--------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| access-type | AccessType | C | 0..1 | If included, this IE shall contain the Access type which is required to be supported by the target Network Function (i.e. SMF). | | +| supported-features | SupportedFeatures | O | 0..1 | List of features required to be supported by the target Network Function.
This IE may be present only if the service-names attribute is present and if it contains a single service-name. It shall be ignored by the NRF otherwise.
(NOTE 4) | | +| required-features | array(SupportedFeatures) | O | 1..N | List of features required to be supported by the target Network Function, as defined by the supportedFeatures attribute in NFService (see clauses 6.1.6.2.3 and 6.2.6.2.4).
This IE may be present only if the service-names attribute is present.
When present, the required-features attribute shall contain as many entries as the number of entries in the service-names attribute. The n th entry in the required-features attribute shall correspond to the n th entry in the service-names attribute. An entry corresponding to a service for which no specific feature is required shall be encoded as "0".
(NOTE 24) | Query-Params-Ext1 | +| complex-query | ComplexQuery | O | 0..1 | This query parameter is used to override the default logical relationship of query parameters. | Complex-Query | +| limit | integer | O | 0..1 | Maximum number of NFProfiles to be returned in the response.
Minimum: 1 | Query-Params-Ext1 | +| max-payload-size | integer | O | 0..1 | Maximum content size (before compression, if any) of the response, expressed in kilo octets.
When present, the NRF shall limit the number of NF profiles returned in the response such as to not exceed the maximum content size indicated in the request.
Default: 124. Maximum: 2000 (i.e. 2 Mo). | Query-Params-Ext1 | +| max-payload-size-ext | integer | O | 0..1 | Maximum content size (before compression, if any) of the response, expressed in kilo octets.
When present, the NRF shall limit the number of NF profiles returned in the response such as to not exceed the maximum content size indicated in the request.
This query parameter is used when the consumer supports content size bigger than 2 million octets.
Default: 124 | Query-Params-Ext2 | +| pdu-session-types | array(PduSessionType) | O | 1..N | List of the PDU session type (s) requested to be supported by the target Network Function (i.e. UPF). | Query-Params-Ext1 | +| event-id-list | array(EventId) | O | 1..N | If present, this attribute shall contain the list of events requested to be supported by the Nnwdaf AnalyticsInfo Service, the NRF shall return NF which support all the requested events. | Query-Param-Analytics | +| nwdaf-event-list | array(NwdafEvent) | O | 1..N | If present, this attribute shall contain the list of events requested to be supported by the Nnwdaf_EventsSubscription service, the NRF shall return NF which support all the requested events. | Query-Param-Analytics | +| upf-event-list | array(EventType) | O | 1..N | If present, this attribute shall contain the list of events requested to be supported by the Nupf_EventExposure service. The NRF shall return UPFs which support all the requested events. | Query-UPEAS | +| atsss-capability | AtsssCapability | O | 0..1 | When present, this IE indicates the ATSSS capability of the target UPF needs to be supported. | MAPDU | +| upf-ue-ip-addr-ind | boolean | O | 0..1 | When present, this IE indicates whether a UPF supporting allocating UE IP addresses/prefixes needs to be discovered.

true: a UPF supporting UE IP addresses/prefixes allocation is requested to be discovered;
false: a UPF not supporting UE IP addresses/prefixes allocation is requested to be discovered. | Query-Params-Ext2 | +| client-type | ExternalClientType | O | 0..1 | When present, this IE indicates that NF(s) dedicatedly serving the specified Client Type needs to be discovered. This IE may be included when target NF Type is "LMF" and "GMLC".

If no NF profile is found dedicatedly serving the requested client type, the NRF may return NF(s) not dedicatedly serving the request client type in the response. | Query-Params-Ext2 | + +| | | | | | | +|--|--|--|--|--|--| +| | | | | | | +|--|--|--|--|--|--| + +| | | | | | | +|--------------------------|---------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| lmf-id | LMFIdentification | O | 0..1 | When present, this IE shall contain LMF identification to be discovered. This may be included if the target NF type is "LMF". | Query-Params-Ext2 | +| an-node-type | AnNodeType | O | 0..1 | If included, this IE shall contain the AN Node type which is required to be supported by the target Network Function (i.e. LMF). | Query-Params-Ext2 | +| rat-type | RatType | O | 0..1 | If included, this IE shall contain the RAT type which is required to be supported by the target Network Function (i.e. LMF). | Query-Params-Ext2 | +| target-snpn | PlmnIdNid | C | 0..1 | This IE shall be included when NF services of a specific SNPN need to be discovered. When included, this IE shall contain the PLMN ID and NID of the target NF.
This IE shall also be included in SNPN scenarios, when the entity owning the subscription, the Credentials Holder (see clause 5.30.2.9 in 3GPP TS 23.501 [2]) is an SNPN. | Query-Params-Ext2 | +| af-ee-data | AfEventExposureData | O | 0..1 | When present, this shall contain the application events, and optionally application function identifiers, application identifiers of the AF(s). This may be included if the target NF type is "NEF". | Query-Params-Ext2 | +| w-agf-info | WAgfInfo | O | 0..1 | If included, this IE shall contain the W-AGF identifiers of N3 terminations which is received by the SMF to find the combined W-AGF/UPF or the preferred UPF(s) for the W-AGF.

The NRF shall return UPFs co-located with the W-AGF if any exists (see wAgfInfo attribute in UpfInfo). Otherwise, if the NRF supports the Query-UPF-Selection-N3GPP feature, the NRF shall return preferred UPF(s) for the W-AGF if any preferred UPF exist (see preferredWagfInfoList attribute in UpfInfo). | Query-Params-Ext2 | +| tngf-info | TngfInfo | O | 0..1 | If included, this IE shall contain the TNGF identifiers of N3 terminations which is received by the SMF to find the combined TNGF/UPF or the preferred UPF(s) for the TNGF.

The NRF shall return UPFs co-located with the TNGF if any exists (see tngfInfo attribute in UpfInfo). Otherwise, if the NRF supports the Query-UPF-Selection-N3GPP feature, the NRF shall return preferred UPF(s) for the TNGF if any preferred UPF exist (see preferredTngfInfoList attribute in UpfInfo). | Query-Params-Ext2 | +| twif-info | TwifInfo | O | 0..1 | If included, this IE shall contain the TWIF identifiers of N3 terminations which is received by the SMF to find the combined TWIF/UPF or the preferred UPF(s) for the TWIF.

The NRF shall return UPFs co-located with the TWIF if any exists (see twifInfo attribute in UpfInfo). Otherwise, if the NRF supports the Query-UPF-Selection-N3GPP feature, the NRF shall return preferred UPF(s) for the TWIF if any preferred UPF exist (see preferredTwifInfoList attribute in UpfInfo). | Query-Params-Ext2 | +| upf-select-epdg-info | EpdgInfo | O | 0..1 | If included, this IE shall contain the EPDG identifiers of S2b-u terminations which is received by the SMF/PGW-C to find the preferred UPF/PGW-U to serve the ePDG. | Query-UPF-Selection-N3GPP | +| target-nf-set-id | NfSetId | O | 0..1 | When present, this IE shall contain the target NF Set ID (as defined in clause 28.12 of 3GPP TS 23.003 [12]) of the NF instances being discovered. | Query-Params-Ext2 | +| target-nf-service-set-id | NfServiceSetId | O | 0..1 | When present, this IE shall contain the target NF Service Set ID (as defined in clause 28.13 of 3GPP TS 23.003 [12]) of the NF service instances being discovered.

If this IE is provided together with the target-nf-set-id IE, the NRF shall return service instances of the NF Service Set indicated in the request and should additionally return equivalent ones, if any. | Query-Params-Ext2 | +| preferred-tai | Tai | O | 0..1 | When present, the NRF shall prefer NF profiles that can serve the TAI, or the NRF shall return NF profiles not matching the TAI if no NF profile is found matching the TAI.
(NOTE 5) | Query-Params-Ext2 | +| nef-id | NefId | O | 0..1 | When present, this IE shall contain the NEF ID of the NEF to be discovered. This may be included if the target NF type is "NEF".
(NOTE 7) | Query-Params-Ext2 | + +| | | | | | | +|-------------------------|---------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| preferred-nf-instances | array(NfInstanceId) | O | 1..N | When present, this IE shall contain a list of preferred candidate NF instance IDs. (NOTE 8) | Query-Params-Ext2 | +| notification-type | NotificationType | O | 0..1 | If included, this IE shall contain the notification type of default notification subscriptions that shall be registered in the NFProfile or NFService of the NF Instances being discovered. The NF profiles returned by the NRF shall contain all the registered default notification subscriptions, including the one corresponding to the notification-type parameter. (NOTE 9) | Query-Params-Ext2 | +| n1-msg-class | N1MessageClass | O | 0..1 | This IE may be included when "notification-type" IE is present with value "N1_MESSAGES".

When included, this IE shall contain the N1 message class of default notification subscriptions that shall be registered in the NFProfile or NFService of the NF Instances being discovered. The NF profiles returned by the NRF shall contain all the registered default notification subscriptions, including the one corresponding to the n1-msg-class parameter. (NOTE 9) | Query-Params-Ext3 | +| n2-info-class | N2InformationClass | O | 0..1 | This IE may be included when "notification-type" IE is present with value "N2_INFORMATION".

If included, this IE shall contain the notification type of default notification subscriptions that shall be registered in the NFProfile or NFService of the NF Instances being discovered. The NF profiles returned by the NRF shall contain all the registered default notification subscriptions, including the one corresponding to the n2-info-class parameter. (NOTE 9) | Query-Params-Ext3 | +| serving-scope | array(string) | O | 1..N | If present, this attribute shall contain the list of areas that can be served by the NF instances to be discovered. The NRF shall return NF profiles of NFs which can serve all the areas requested in this query parameter. (NOTE 18) | Query-Params-Ext2 | +| ims-domain-name | string | O | 1..N | If included, this IE shall contain the IMS domain name to search for an appropriate NF. IMS domain name may be included if the target NF type is "DCSF". | Query-NG-RTC | +| imsi | string | O | 0..1 | If included, this IE shall contain the IMSI of the requester UE to search for an appropriate NF. IMSI may be included if the target NF type is "HSS" or "DCSF".
pattern: ^[0-9]{5,15}\$ | Query-Params-Ext2 | +| ims-private-identity | string | O | 0..1 | If included, this IE shall contain the IMS Private Identity of the requester UE to search for an appropriate NF. IMS Private Identity may be included if the target NF type is "HSS" or "DCSF". | Query-Params-Ext3 | +| ims-public-identity | string | O | 0..1 | If included, this IE shall contain the IMS Public Identity of the requester UE to search for an appropriate NF. IMS Public Identity may be included if the target NF type is "HSS" or "DCSF". | Query-Params-Ext3 | +| msisdn | string | O | 0..1 | If included, this IE shall contain the MSISDN of the requester UE to search for an appropriate NF. IMS Public Identity may be included if the target NF type is "HSS" or "DCSF". | Query-Params-Ext3 | +| internal-group-identity | GroupId | O | 0..1 | If included, this IE shall contain the internal group identifier of the UE to search for an appropriate NF. This may be included if the target NF type is "UDM", "NSSAAF" or "TSCTSF". | Query-Params-Ext2 | +| preferred-api-versions | map(string) | O | 1..N | When present, this IE indicates the preferred API version of the services that are supported by the target NF instances. The key of the map is the ServiceName (see clause 6.1.6.3.11) for which the preferred API version is indicated. Each element carries the API Version Indication for the service indicated by the key. The NRF may return additional NFs in the response not matching the preferred API versions, e.g. if no NF profile is found matching the preferred-api-versions.

An API Version Indication is a string formatted as {operator}+{API Version}. | Query-Params-Ext2 | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

The following operators shall be supported:

  • "=" match a version equals to the version value indicated.
  • ">" match any version greater than the version value indicated
  • ">=" match any version greater than or equal to the version value indicated
  • "<" match any version less than the version value indicated
  • "<=" match any version less than or equal to the version value indicated
  • "^" match any version compatible with the version indicated, i.e. any version with the same major version as the version indicated.

Precedence between versions is identified by comparing the Major, Minor, and Patch version fields numerically, from left to right.

If no operator or an unknown operator is provided in API Version Indication, "=" operator is applied.

Example of API Version Indication:

Case1: "=1.2.4.operator-ext" or "1.2.4.operator-ext" means matching the service with API version "1.2.4.operator-ext"

Case2: ">1.2.4" means matching the service with API versions greater than "1.2.4"

Case3: "^2.3.0" or "^2" means matching the service with all API versions with major version "2".

| | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|---------------------|---------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| v2x-support-ind | boolean | O | 0..1 | When present, this IE indicates whether a PCF supporting V2X Policy/Parameter provisioning needs to be discovered.

true: a PCF supporting V2X Policy/Parameter provisioning is requested to be discovered;
false: a PCF not supporting V2X Policy/Parameter provisioning is requested to be discovered. | Query-Params-Ext2 | +| redundant-gtpu | boolean | O | 0..1 | When present, this IE indicates whether a UPF supporting redundant GTP-U path needs to be discovered.

true: a UPF supporting redundant GTP-U path is requested to be discovered;
false: a UPF not supporting redundant GTP-U path is requested to be discovered. | Query-Params-Ext2 | +| redundant-transport | boolean | O | 0..1 | When present, this IE indicates whether a UPF supporting redundant transport path on the transport layer in the corresponding network slice needs to be discovered.

true: a UPF supporting redundant transport path on the transport layer is requested to be discovered;
false: a UPF not supporting redundant transport path on the transport layer is requested to be discovered.

If the Snssai(s) are also included, the UPF supporting redundant transport path on the transport layer shall be available in the network slice(s) identified by the Snssai(s). | Query-Params-Ext2 | +| ipups | boolean | O | 0..1 | When present, this IE indicates whether a UPF which is configured for IPUPS is requested to be discovered.

true: a UPF which is configured for IPUPS is requested to be discovered;
false: a UPF which is not configured for IPUPS is requested to be discovered. | Query-Params-Ext2 | +| sxa-ind | boolean | O | 0..1 | When present, this IE indicates whether a UPF which is configured to support Sxa interface is requested to be discovered.

true: a UPF which is configured to support Sxa interface is requested to be discovered;
false: a UPF which is not configured to support Sxa interface is requested to be discovered. | Query-SBIProtoc18 | +| scp-domain-list | array(string) | O | 1..N | When present, this IE shall contain the SCP domain(s) the target NF, SCP or SEPP belongs to. The NRF shall return NF, SCP or SEPP profiles that belong to all the SCP domains provided in this list. | Query-Params-Ext2 | +| address-domain | Fqdn | O | 0..1 | If included, this IE shall contain the address domain that shall be reachable through the SCP. This IE may be included when the target NF type is "SCP". | Query-Params-Ext2 | +| ipv4-addr | Ipv4Addr | O | 0..1 | If included, this IE shall contain the IPv4 address that shall be reachable through the SCP. This IE may be included when the target NF type is "SCP". | Query-Params-Ext2 | +| ipv6-prefix | Ipv6Prefix | O | 0..1 | If included, this IE shall contain the IPv6 prefix that shall be reachable through the SCP. This IE may be included when the target NF type is "SCP". | Query-Params-Ext2 | +| served-nf-set-id | NfSetId | O | 0..1 | When present, this IE shall contain the NF Set ID that shall be reachable through the SCP. This IE may be included when the target NF type is "SCP". | Query-Params-Ext2 | +| remote-plmn-id | PlmnId | O | 0..1 | If included, this IE shall contain the remote PLMN ID that shall be reachable through the SCP or SEPP. This IE may be included when the target NF type is "SCP" or "SEPP". | Query-Params-Ext2 | +| remote-snpn-id | PlmnIdNid | O | 0..1 | If included, this IE shall contain the remote SNPN ID that shall be reachable through the SCP or SEPP. This IE may be included when the target NF type is "SCP" or "SEPP". | Query-ENPN | +| data-forwarding | boolean | O | 0..1 | This may be included if the target NF type is "UPF". (NOTE 13)

When present, the IE indicates whether UPF(s) configured for data forwarding needs to be discovered. | Query-Params-Ext2 | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | true: UPF(s) configured for data forwarding is requested to be discovered;
false: UPF(s) not configured for data forwarding is requested to be discovered. | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|------------------------------------|------------------------------------------|---|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| preferred-full-plmn | boolean | O | 0..1 | When present, the NRF shall prefer NF profile(s) that can serve the full PLMN (i.e. can serve any TAI in the PLMN), or the NRF shall return other NF profiles if no NF profile serving the full PLMN is found:

- true: NF instance(s) serving the full PLMN is preferred;
- false: NF instance(s) serving the full PLMN is not preferred.

(NOTE 14) | Query-Params-Ext2 | +| requester-features | SupportedFeatures | C | 0..1 | Nnrf_NFDiscovery features supported by the Requester NF that is invoking the Nnrf_NFDiscovery service.

This IE shall be included if at least one of the following features is supported by the Requester NF:
- Service-Map
- Enh-NF-Discovery

This IE may be included otherwise. | | +| realm-id | string | O | 0..1 | May be included if the target NF type is "UDSF". If included, this IE shall contain the realm-id for which a UDSF shall be discovered. | Query-Params-Ext4 | +| storage-id | string | O | 0..1 | May be included if the target NF type is "UDSF" and realm-id is included. If included, this IE shall contain the storage-id for the realm-id indicated in the realm-id IE for which a UDSF shall be discovered. | Query-Params-Ext4 | +| vsmf-support-ind | boolean | O | 0..1 | This IE may be included when the target NF type is "SMF".

- true: Target SMF(s) supporting V-SMF are preferred to be discovered;

- false: Shall be handled the same way as when this optional query parameter is not received.

(NOTE 15) | Query-Param-vSmf-Capability | +| ismf-support-ind | boolean | O | 0..1 | This IE may be included when the target NF type is "SMF".

- true: Target SMF(s) supporting I-SMF are preferred to be discovered;

- false: Shall be handled the same way as when this optional query parameter is not received.

(NOTE 15) | Query-Param-iSmf-Capability | +| nrf-disc-uri | Uri | C | 0..1 | If included, this IE shall contain the API URI of the NFDiscovery Service (see clause 6.2.1) of the NRF holding the NF Profile.

It shall be included if:
- the target-nf-instance-id or target-nf-instance-id-list is present;

- the NF Service Consumer has previously received such API URI in an earlier NF service discovery, i.e. if the target NF instance was provided in the nflInstanceList attribute in SearchResult (see clause 6.2.6.2.2) and the nrfDiscApiUri attribute was present in the NfInstanceInfo (see clause 6.2.6.2.7); and

- the service discovery request is addressed to a different NRF than the NRF holding the NF profile. | Enh-NF-Discovery | +| preferred-vendor-specific-features | map(map(array (VendorSpecific Feature))) | O | 1..N(
1..M(
1..L)) | When present, this IE indicates the list of preferred vendor-specific features supported by the target Network Function, as defined by the supportedVendorSpecificFeatures attribute in NFService (see clauses 6.1.6.2.3 and 6.2.6.2.4). NF profiles that support all the preferred features, or by default, NF profiles that contain at least one service supporting the preferred features, should be preferentially returned in the response; NF profiles in the response may not support the preferred features. | Query-SBIProtoc17 | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

The key of the external map is the ServiceName (see clause 6.1.6.3.11) for which the preferred vendor-specific features is indicated. Each element carries the preferred vendor-specific features for the service indicated by the key.

The key of the internal map is the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. The string used as key of the internal map shall contain 6 decimal digits; if the SMI code has less than 6 digits, it shall be padded with leading digits "0" to complete a 6-digit string value.

The value of each entry of the map shall be a list (array) of VendorSpecificFeature objects.

The NF profiles returned by the NRF shall include the full list of vendor-specific-features and not just the interclause of supported and preferred vendor-specific features.

| | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|---------------------------------------|-----------------------------------|---|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| preferred-vendor-specific-nf-features | map(array(VendorSpecificFeature)) | O | 1..N(1..M) |

When present, this IE indicates the list of preferred vendor-specific features supported by the target Network Function, as defined by the supportedVendorSpecificFeatures attribute in NF profile (see clause 6.1.6.2.2 and 6.2.6.2.3). NF profiles that support all the preferred features should be preferentially returned in the response. NF profiles in the response may not support the preferred features.

The key of the map is the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. The value of each entry of the map shall be a list (array) of VendorSpecificFeature objects.

The NF profiles returned by the NRF shall include the full list of vendor-specific features and not just the interclause of supported and preferred vendor-specific features.

| Query-SBIProtoc17 | +| required-pfcp-features | string | O | 0..1 |

List of features required to be supported by the target UPF or MB-UPF (when selecting a UPF or a MB-UPF), encoded as defined for the supportedPfcpFeatures attribute in UpfInfo (see clause 6.1.6.2.13).

(NOTE 16)

| Query-Upf-Pfcp | +| home-pub-key-id | integer | O | 0..1 |

When present, this IE shall indicate the Home Network Public Key ID which shall be able to be served by the NF instance. May be included if the target NF type is "AUSF" or "UDM". This query parameter may only be present if the routing-indicator query parameter is also present.

(NOTE 17)

| Query-SBIProtoc17 | +| prose-support-ind | boolean | O | 0..1 |

When present, this IE indicates whether supporting ProSe capability by PCF needs to be discovered.

  • - true: a PCF supporting ProSe capability is requested to be discovered;
  • - false: a PCF not supporting ProSe capability is requested to be discovered.
| Query-5G-ProSe | +| analytics-aggregation-ind | boolean | O | 0..1 |

This IE may be included when the target NF type is "NWDAF".

  • - true: An NF supporting analytics aggregation capability is requested to be discovered;
  • - false: Shall be handled the same way as when this optional query parameter is not received.
| Query-eNA-PH2 | +| analytics-metadata-prov-ind | boolean | O | 0..1 |

This IE may be included when the target NF type is "NWDAF".

  • - true: An NF supporting analytics metadata provisioning capability is requested to be discovered;
  • - false: Shall be handled the same way as when this optional query parameter is not received.
| Query-eNA-PH2 | +| serving-nf-set-id | NfSetId | O | 0..1 |

When present, this IE shall contain the NF Set ID that is served by the DCCF, NWDAF or MFAF. This IE may be included when the target NF type is "DCCF" or "NWDAF" or "MFAF".

| Query-eNA-PH2 | +| serving-nf-type | NFType | O | 0..1 |

When present, this IE shall contain the NF type that is served by the DCCF, NWDAF or MFAF. This IE may be included when the target NF type is "DCCF" or "NWDAF" or "MFAF".

| Query-eNA-PH2 | +| ml-analytics-info-list | array(MIAnalyticsInfo) | O | 1..N |

If present, this attribute shall contain the list of ML Analytics Filter information per Analytics ID(s) requested to be supported by the Nnwdaf_ModelProvision Service. The NRF shall return NWDAF profiles that support at least one of the MIAnalyticsInfo in this list.

| Query-eNA-PH2 | +| nsacf-capability | NsacfCapability | O | 0..1 |

When present, this IE indicates the service capability that the target NSACF needs to support.

| NSAC | +| mbs-session-id-list | array(MbsSessionId) | O | 1..N |

This IE may be present if the target NF type is "MB-SMF". When present, it shall contain the list of MBS Session ID(s) for which MB-SMF(s) are to be discovered.

| Query-MBS | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

When present, for each mbs-session-id in the list, the NRF shall determine whether an MB-SMF supporting the mbs-session-id and complying with the other query parameters (if any) exists. An MB-SMF shall be considered to support the mbs-session-id if:

  • - the mbs-session-id contains a TMGI that is part of a TMGI range (see tmgiRangeList attribute in clause 6.1.6.2.85) registered by the MB-SMF and, if the tai query parameter is present:
    • - if the TAI indicated in the tai query parameter can be served by the MB-SMF (see taiList and taiRangeList attributes in clause 6.1.6.2.85);

or

  • - the mbs-session-id contains a TMGI or an SSM address, that is part of the list of MBS sessions currently served by the MB-SMF (see mbsSessionList attribute in clause 6.1.6.2.85) and, if the tai query parameter is present and the MBS session is registered with an MBS Service Area (see mbsServiceArea in clause 6.1.6.2.90):
    • - if the TAI indicated in the tai query parameter is supported by the MBS Service Area of the MBS session.

If so, the NRF shall return the profile of this MB-SMF. If no MB-SMF supporting the mbs-session-id and complying with the other query parameters exists, the NRF shall return an empty response.

See clause 7.1.2 of 3GPP TS 23.247 [43].

| | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------------------|---------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| area-session-id | AreaSessionId | O | 0..1 | This IE may be present if the target NF type is "MB-SMF", the mbs-session-id-list IE is present and contains only one MBS Session ID.
When present, the IE shall contain the Area Session ID, for the MBS session indicated in the mbs-session-id-list IE, for which an MB-SMF is to be discovered.
When this IE is present, the NRF shall return an MB-SMF profile that currently serves the MBS Session ID and Area Session ID (see mbsSessionList attribute in clause 6.1.6.2.85).
If no MB-SMF supports the MBS Session ID and Area Session ID, the NRF shall return an empty response.
See clause 7.1.2 of 3GPP TS 23.247 [43]. | Query-MBS | +| gmlc-number | string | O | 0..1 | If included, this IE shall contain the GMLC Number of which should supported by the target GMLC. It may be included if the target NF type is "GMLC".

Pattern: "^[0-9]{5,15}\$" | Query-eLCS | +| upf-n6-ip | lpAddr | O | 0..1 | If included, this IE shall contain the N6 IP address of PSA UPF.

It may be included if the target NF type is "EASDF". | Query-eEDGE-5GC | +| tai-list | array(Tai) | O | 1..N | If included, this IE shall contain the Tracking Area Identities requested to be supported by the NFs being discovered. The NRF shall return NFs which support all the TAs in the list. It may be included if the target NF type is "NEF", "MB-SMF" or "AMF".
(NOTE 28) | Query-eEDGE-5GC | +| nf-tai-list-ind | boolean | O | 0..1 | This query parameter may be present with the value true if the tai-list query parameter is present and the NF service consumer supports receiving from the NRF a list of NFs supporting only a subset of the TAs included in the tai-list. (NOTE 28)

Presence of this IE with false value shall be prohibited. | Query-SBIProtoc18 | +| preferences-precedence | array(string) | O | 2..N | This IE may be present when multiple query parameters expressing a preference are included in the discovery request.

When present, this IE shall indicate the relative precedence of these query parameters (from higher precedence to lower precedence). The NRF shall use the indicated precedence to prioritize the candidate NFs in the search result, among the candidate NFs partially matching the different preference query parameters, candidate matching the higher precedence preference query parameter should have higher priority.

This IE may include any query parameter named "preferred-xxx" or "ext-preferred-xxx" (e.g. preferred-locality, preferred-tai).

Example:

preferences-precedence=[preferred-tai, preferred-vendor-specific-features]

The above value indicates that the "preferred-tai" parameter has higher precedence than the "preferred-vendor-specific-features" parameter. | Query-SBIProtoc17 | +| support-onboarding-capability | boolean | O | 0..1 | If present, this attribute indicates the target AMF or SMF instances support SNPN Onboarding. If the target is an SMF, this indicates the SMF also supports User Plane Remote Provisioning. This is used for the case of Onboarding of UEs for SNPNs (see 3GPP TS 23.501 [2], clauses 5.30.2.10 and 6.2.6.2).

  • - true: An NF supporting SNPN Onboarding is requested to be discovered;
  • - false: Shall be handled the same way as when this optional query parameter is not received.
| Query-ENPN | +| uas-nf- | boolean | O | 0..1 | This IE may be included when the target NF type is "NEF". | Query- | + +| | | | | | | +|------------------------------------|--------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| functionality-ind | | | |
  • - true: An NF supporting UAS NF functionality is requested to be discovered;
  • - false: Shall be handled the same way as when this optional query parameter is not received.
| ID_UAS | +| multi-member-af-session-qos-ind | boolean | O | 0..1 |

This IE may be included when the target NF type is "NEF".

  • - true: An NF supporting Multi-member AF session with required QoS functionality is requested to be discovered.

Presence of this IE with false value shall be prohibited.

| Query-AIMLsys | +| member-ue-selection-assistance-ind | boolean | O | 0..1 |

This IE may be included when the target NF type is "NEF".

  • - true: An NF supporting member UE selection assistance functionality is requested to be discovered;

Presence of this IE with false value shall be prohibited.

| Query-AIMLsys | +| v2x-capability | V2xCapability | O | 0..1 |

When present, this IE indicates the V2X capability that the target PCF needs to support.

When the v2x-capability is provided as the query parameter, NRF shall return the PCF instances which support all the V2X capabilities requested.

| Query-SBIProtoc17 | +| prose-capability | ProSeCapability | O | 0..1 |

When present, this IE indicates the ProSe capability that the target PCF needs to support.

When the prose-capability is provided as the query parameter, NRF shall return the PCF instances which support all the ProSe capabilities requested.

| Query-5G-ProSe | +| shared-data-id | SharedDataId | O | 0..1 | Identifies the shared data that is stored in the NF (UDR) to be discovered. May be included if the target NF type is "UDR" | Query-SBIProtoc17 | +| target-hni | Fqdn | O | 0..1 |

If included, this IE shall contain the Home Network Identifier. If CH/DCS is using AAA Server or AUSF and UDM for primary authentication and authorization (see clauses 5.30.2.9.2, 5.30.2.9.3 and 5.30.2.10.2.2 in 3GPP TS 23.501 [2]), the sender (AMF or AUSF) populates this IE with CH/DCS ID. See also clauses 4.17.4a and 4.17.5a in TS 23.502 [3].

If the target NF is AUSF or NSSAAF and the HNI belongs to a CH/DCS with AAA Server in another domain, i.e. not in this SNPN, the NRF returns back the AUSF or NSSAAF in the same SNPN, based on the NF profile as specified in clause 6.2.6.2 in 3GPP TS 23.501 [2].

| Query-ENPN | +| target-nw-resolution | boolean | O | 0..1 |

If included and set to true, the NRF shall determine the identity of the target PLMN to which the NFDiscovery request shall be directed, based on the MSISDN of the UE included in the "gpsi" query parameter, as described in 3GPP TS 23.540 [48].

If included and set to false, this IE shall be ignored.

| Query-Nw-Resolution | +| exclude-nfinst-list | array(NfInstanceId) | O | 1..N |

If included, this IE shall indicate the list of NF instances that should not be returned in the NF Discovery response. (NOTE 23)

| Query-SBIProtoc17-Ext1 | +| exclude-nfservinst-list | array(NfServiceInstance) | O | 1..N |

If included, this IE shall indicate the list of NF service instances that should not be returned in the NF Discovery response. (NOTE 23)

| Query-SBIProtoc17-Ext1 | +| exclude-nfserviceset-list | array(NfServiceSetId) | O | 1..N |

If included, this IE shall indicate the list of NF service sets of NF service instances that should not be returned in the NF Discovery response. (NOTE 23)

| Query-SBIProtoc17-Ext1 | +| exclude-nfset-list | array(NfSetId) | O | 1..N |

If included, this IE shall indicate the list of NF sets of NF instances that should not be returned in the NF Discovery response. (NOTE 23)

| Query-SBIProtoc17-Ext1 | +| preferred- | map(DurationS | O | 1..N | If included, this IE shall contain the preferred Analytics Delay. | Query- | + +| | | | | | | +|------------------------|------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| analytics-delays | ec) | | |

The key of the map is the EventId or Nwdafevent (as defined in 3GPP TS 29.520 [33]) for which the preferred Analytics Delay is related to. Each element carries the preferred Analytics Delay for the Analytics ID indicated by the key.

The NRF shall return the NWDAFs supports the Analytics ID with a supported Analytics Delay that is less than or equal to the preferred Analytics Delay, as described in clause 6.3.13 of 3GPP TS 23.501 [2]. The NRF may return NWDAFs in the response not matching the preferred Analytics Delay, e.g. if no NWDAF profile is found matching the preferred Analytics Delay.

| eNA-PH2-Ext1 | +| high-latency-com | boolean | O | 0..1 |

If present and set to true, this attribute indicates target AMF(s) instances supporting High Latency communication (e.g. for NR RedCap UE) are required. This is used by CP NF to discover AMF supporting High Latency communication (see 3GPP TS 23.501 [2], clause 6.3.5).

Presence of this IE with false value shall be prohibited.

| Query-HLC | +| nsac-sai | NsacSai | O | 0..1 |

If included, it shall indicate the NSAC service area which shall be supported by the target NSACF. It may be included if the target NF type is "NSACF".

For NSAC hierarchical or centralized architecture, if this IE is set to "ENTIRE_PLMN", this indicates the NF service consumer wants to discover a primary NSACF for the entire PLMN. This IE shall be set to "ENTIRE_PLMN" also in roaming scenarios to discover the HPLMN NSACF as clarified in clause 6.3.22 of 3GPP TS 23.501 [2].

| Query-eNS-PH2 | +| complete-profile | boolean | O | 0..1 |

This IE may be included by an SCP with the value true to request to discover the complete profile of NF Instances (including authorization attributes such as the "allowedXXX" attributes of NFProfile and NFService data types) matching the query parameters. See clause 5.3.2.2.2.

Presence of this IE with false value shall be prohibited.

| Complete-Profile-Discovery | +| n32-purposes | array(N32Purpose) | O | 1..N |

This IE may be included when the target NF type is "SEPP". When present, this IE shall indicate the requested N32 purposes to be supported by the SEPP. The NRF shall return SEPP profiles that support at least one requested N32 purpose.

| Query-SBIProtoc18 | +| preferred-features | map(SupportedFeatures) | O | 1..N |

List of features preferred to be supported by the target Network Function, as defined by the supportedFeatures attribute in NFService (see clauses 6.1.6.2.3 and 6.2.6.2.4).

The key of the map is the Service Name as specified in clause 6.1.6.3.11. Each element carries the preferred feature(s) to be supported by the target Network Function for the indicated service.

The NRF shall prioritize the NF candidates supporting the preferred features in the search result.

(NOTE 24)

| Query-SBIProtoc18 | +| remote-plmn-id-roaming | PlmnId | O | 0..1 |

If included, this IE shall indicate the remote PLMN that the target NF service producer can serve, i.e. the NF service producer can serve the roaming UEs which belong to the indicated remote PLMN. This IE may be included when the target NF type is "SMSF".

The NRF shall return the candidate NF service producer(s) in discovery result with the following order of preference:

  • - NF profiles explicitly indicated the support of roaming UE for the requested remote PLMN; then
  • - NF profiles indicated the support of roaming UE for any
| Query-SBIProtoc18 | + +| | | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | remote PLMN; then
  • - if none of above are available, NF profiles without indication of roaming UE support.
| | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|------------------------------------------|------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| pru-tai | Tai | O | 0..1 | This may be included if the target NF type is "LMF".

When present, this IE indicates whether LMF(s) serving a TAI with PRU(s) existence needs to be discovered. | Query-eLCS-PH3 | +| pru-support-ind | boolean | O | 0..1 | This IE may be included when the target NF type is "LMF".

When present, this IE indicates whether the LMF(s) supporting PRU function need(s) to be discovered.

true: target LMF(s) supporting PRU function are requested to be discovered;
false: target LMF(s) not supporting PRU function are requested to be discovered. | Query-eLCS-PH3 | +| preferred-up-positioning-ind | boolean | O | 0..1 | This IE may be included when the target NF type is "LMF".

When present, this IE indicates whether the LMF(s) supporting user plane positioning capability are desired to be discovered.

true: target LMF(s) supporting user plane positioning capability are desired to be discovered;

Presence of this IE with false value shall be prohibited. | Query-eLCS-PH3 | +| af-data | AfData | O | 0..1 | When present, this IE shall contain the event that is supported by the "AF" for trusted AF discovery. | Query-eLCS-PH3 | +| ml-accuracy-checking-ind | boolean | O | 0..1 | If present and set to true, this attribute indicates target NWDAF(s) instances containing MTLF with ML Model accuracy checking capability are required.

Presence of this IE with false value shall be prohibited. | Query-eNA-PH3 | +| analytics-accuracy-checking-ind | boolean | O | 0..1 | If present and set to true, this attribute indicates target NWDAF(s) instances containing AnLF with Analytics accuracy checking capability are required.

Presence of this IE with false value shall be prohibited. | Query-eNA-PH3 | +| ml-model-storage-ind | boolean | O | 0..1 | If present and set to true, this attribute indicates target ADRF(s) instances with ML model storage and retrieval capability are required.

Presence of this IE with false value shall be prohibited. | Query-eNA-PH3 | +| data-storage-ind | boolean | O | 0..1 | If present and set to true, this attribute indicates target ADRF(s) instances with data and analytics storage and retrieval capability are required.

Presence of this IE with false value shall be prohibited. | Query-eNA-PH3 | +| data-subscription-relocation-support-ind | boolean | O | 0..1 | If present and set to true, this attribute indicates target DCCF(s) instances with relocation of data subscription support are required.

Presence of this IE with false value shall be prohibited. | Query-eNA-PH3 | +| roaming-exchange-ind | boolean | O | 0..1 | This IE may be included when the target NF type is "NWDAF".

- true: An NF supporting roaming exchange capability is requested to be discovered.

Presence of this IE with false value shall be prohibited. | Query-eNA-PH3 | +| media-capability-list | array(MediaCapability) | O | 1..N | If present, this attribute shall contain the list of media capability that can be served by the NF instances to be discovered. The NRF shall return NF profiles of NFs which can serve all the media capabilities requested in this query parameter. | Query-NG-RTC | +| a2x-support-ind | boolean | O | 0..1 | When present, this IE indicates whether a PCF supporting A2X Policy/Parameter provisioning needs to be discovered.

true: a PCF supporting A2X Policy/Parameter provisioning is requested to be discovered;
false: a PCF not supporting A2X Policy/Parameter provisioning is requested to be discovered. | Query-A2X | + +| | | | | | | +|----------------------------|---------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| a2x-capability | A2xCapability | O | 0..1 | When present, this IE indicates the A2X capability that the target PCF needs to support.

When the a2x-capability is provided as the query parameter, NRF shall return the PCF instances which support all the A2X capabilities requested. | Query-A2X | +| ranging-sl-pos-support-ind | boolean | O | 0..1 | When present, this IE indicates whether supporting ranging and sidelink positioning capability by PCF/LMF needs to be discovered.

- true: a PCF/LMF supporting ranging and sidelink positioning capability is requested to be discovered

Presence of this IE with false value shall be prohibited. | Query-5G-Ranging SIPos | +| complete-search-result | boolean | O | 0..1 | This IE may be present with the value true to indicate that all the NF profiles or NF Instance IDs matching the query parameters are requested to be returned.
The presence of this IE with the value false shall be prohibited. (NOTE 29) | Query-SBIProtoc18 | + +- NOTE 1: If this parameter is present and no AMF supporting the requested GUAMI is available due to AMF Failure or planned AMF removal, the NRF shall return in the response AMF instances acting as a backup for AMF failure or planned AMF removal respectively for this GUAMI (see clause 6.1.6.2.11). The NRF can detect if an AMF has failed, using the Heartbeat procedure. The NRF will receive a de-registration request from an AMF performing a planned removal. +- NOTE 2: If the combined SMF/PGW-C is requested to be discovered, the NRF shall return in the response the SMF instances registered with the SmfInfo containing pgwFqdn. +- NOTE 3: If a UPF supporting interworking with EPS is requested to be discovered, the NRF shall return in the response the UPF instances registered with the upfInfo containing iwkEpsInd set to true. +- NOTE 4: This attribute has a different semantic than what is defined in clause 6.6.2 of 3GPP TS 29.500 [4], i.e. it is not used to signal optional features of the Nnrf\_NFDiscovery Service API supported by the requester NF. +- NOTE 5: The AMF may perform the SMF discovery based on the dnn, snssais and preferred-tai during a PDU session establishment procedure, and the NRF shall return the SMF profiles matching all if possible, or the SMF profiles only matching dnn and snssais. If the SMF profiles only matching dnn and snssais are returned, the AMF shall insert an I-SMF. An SMF may also perform a UPF discovery using this parameter. +- NOTE 6: The SMF may select the P-CSCF close to the UPF by setting the preferred-locality to the value of the locality of the UPF. +- NOTE 7: During EPS to 5GS idle mobility procedure, the Requester NF (i.e. SMF) discovers the anchor NEF for NIDD using the SCEF ID received from EPS as the value of the NEF ID, as specified in clause 4.11.1.3.3 of 3GPP TS 23.502 [3]. +- NOTE 8: The service consumer may include a list of preferred-nf-instance-ids in the query. If so, the NRF shall first check if the NF profiles of the preferred NF instances match the other query parameters, and if so, then the NRF shall return the corresponding NF profiles; otherwise, the NRF shall return a list of candidate NF profiles matching the query parameters other than the preferred-nf-instance-ids. For example, the target AMF may set this query parameter to the SMF Instance ID and I-SMF Instance ID during an inter AMF mobility procedure to select an I-SMF. +- NOTE 9: This parameter may be used by the SCP (with other query parameters) to discover and select a NF service consumer with a default notification subscription supporting the notification type of a notification request (see clause 6.10.3.3 of 3GPP TS 29.500 [4]). +- NOTE 10: An S-NSSAI value used in discovery request query parameters shall be considered as matching the S-NSSAI value in the NF Profile or NF Service of a given NF Instance if both the SST and SD components are identical (i.e. an S-NSSAI value where SD is absent, shall not be considered as matching an S-NSSAI where SD is present, regardless if SST is equal in both). +- NOTE 11: The dnn query parameter shall be considered as matching a DNN attribute in the NF Profile of a given NF Instance if: +- both contain the same Network Identifier and Operator Identifier; + - both contain the same Network Identifier and none contains an Operator Identifier; + - the dnn query parameter contains the Network Identifier only, the DNN value in the NF Profile contains both the Network Identifier and Operator Identifier, and both contain the same Network Identifier; or + - the dnn query parameter contains both the Network Identifier and Operator Identifier, the DNN value in the NF Profile contains the Network Identifier only, both contain the same Network Identifier and the Operator Identifier matches one PLMN of the NF (i.e. plmnList of the NF Profile). +- NOTE 12: Based on operator's policies, a discovery request not including the requester's information necessary to validate the authorization parameters in NF Profiles may be rejected or accepted but with only returning in the discovery response NF Instances whose authorization parameters allow any NF Service Consumer to access their services. The authorization parameters in NF Profile are those used by NRF to determine whether a given NF Instance / NF Service Instance can be discovered by an NF Service Consumer in order to consume its offered services (e.g. "allowedNfTypes", "allowedNfDomains", etc.). +- NOTE 13: Different UPF instances for data forwarding may be configured in the network e.g. for different serving areas. + +The SMF may use this query parameter together with others (like SMF Serving Area or TAI) in discovery to select the UPF candidate for data forwarding. + +- NOTE 14: For HR roaming, if the V-PLMN requires Deployments Topologies with specific SMF Service Areas (DTSSA) but no H-SMF can be selected supporting V-SMF change, AMF may use this query parameter to select a V-SMF serving the full VPLMN if available. +- NOTE 15: The AMF may perform discovery with this parameter to find V-SMF(s)/I-SMF(s), and the NRF shall return the SMF profiles that explicitly indicated support of V-SMF/I-SMF(s) capability. When performing discovery, the AMF shall use other query parameters together with this IE to ensure the required configurations and/or features are supported by the V-SMF/I-SMF(s), e.g. required Slice for the PDU session, support of DTSSA feature if V-SMF change is required for PDU Session, etc. If no SMF instances that explicitly indicated support of V-SMF/I-SMF(s) capability can be matched for the discovery, the NRF shall return matched SMF instances not indicating support of V-SMF/I-SMF(s) capability explicitly, i.e. the SMF instances not registered vsmfSupportInd/ismfSupportInd IE in the NF profile but matched to the rest query parameters, if available. +- NOTE 16: When required-pfcp-features is used as query parameter, the NRF shall return a list of candidate UPFs supporting all the required PFCP features. The NRF may also return UPF profiles not including the "SupportedPfcpFeatures" attribute (e.g. pre-Rel-17 UPFs) but matching the other query parameters. The NF Service Consumer, e.g. a SMF, when using required-pfcp-features as query parameter, shall also include the query parameter corresponding to the UPF features (atssss-capability, upf-ue-ip-addr-ind, redundant-gtpu) which correspond to the PFCP feature flags MPTCP and ATSSS\_LL, UEIP, and RTTL respectively, if the corresponding PFCP feature is required. For example an SMF, that wishes to select a UPF supporting UE IP Address Allocation by the UP function, shall set the UEIP flag to "1" in the required-pfcp-features and also include the upf-ue-ip-addr-ind parameter set to "true". +- NOTE 17: In this release, the usage of Home Network Public Key identifier for AUSF/UDM discovery is limited to the scenario where the AUSF/UDM NF consumers belong to the same PLMN as AUSF/UDM. +- NOTE 18: The NF service consumer may derive the serving scope from e.g. the TAI of the UE, using local configuration. This parameter may be used to discover any NF that registers to the NRF, e.g. a 5GC NF or a P-CSCF. +- NOTE 19: If the NRF supports the "Collocated-NF-Selection" feature and the NF service consumer has included the "preferred-collocated-nf-types" attribute, the NRF shall return a list of candidates NFs (for the target-nf-type) matching the discovery query parameters and preferentially supporting CollocatedNFType(s) as indicated in the preferred-collocated-nf-types. +- NOTE 20: If the NRF supports this IE and the NF service consumer has included this IE with the value "true" in discovery request, the NRF shall look up and return PGW-C+SMF instances matching the other query parameters. If no matching is found, the NRF shall return a list of standalone SMF instances matching the other query parameters. If the NRF supports this IE and the NF service consumer has included this IE with the value "false" in discovery request, the NRF shall look up and return standalone SMF instances matching the other query parameters. If no matching is found, the NRF shall return a list of PGW-C+SMF instances matching the other query parameters. +- NOTE 21: Either pgw-ind IE or preferred-pgw-ind IE may be included in the discovery request. +- NOTE 22: MB-SMF may use an NRF to discover the AMF(s) serving an MBS service area (see clause 7.3.1 in 3GPP TS 23.247 [43]). For this purpose, the MB-SMF may use query parameters specified in this table, e.g. 'tai' and 'service-names', or 'snssais', or any other parameters. +- NOTE 23: This parameter may be set by an NF service consumer or SCP to filter-out specific NF (service) instances or NF (service) sets from the NF Discovery response, e.g. when the NFc knows that an NF service producer is not responsive or overloaded. See the 3gpp-Sbi-Selection-Info header in clause 5.2.3.3.10 of 3GPP TS 29.500 [4]. +- NOTE 24: A feature shall not be included in both required-features IE and preferred-features IE in the same discovery request. +- NOTE 25: When Locality is configured in NSACF(s), an NSACF consumer, e.g. AMF or SMF, may use a locally configured NSACF Locality to discover the candidate NSACF, or otherwise may use its own Locality to discover the candidate NSACF. When Locality is configured in MRF(s) or MRFP(s), an MRF/MRFP consumer, e.g. IMS entity, may use a locally configured MRF/MRFP Locality to discover the candidate MRF/MRFP, or otherwise may use its own Locality to discover the candidate MRF/MRFP. When Locality is configured in MF, an MF consumer, e.g. IMS AS, may use a locally configured MF Locality to discover the candidate MF, or otherwise may use its own Locality to discover the candidate MF. +- NOTE 26: Only one of the target-nf-instance-id and target-nf-instance-id-list query parameters may be present in an NF Discovery Request. +- NOTE 27: When the query parameter "ue-ipv4-address" or "ue-ipv6-prefix" is used to discover a UPF as specified in clause 4.15.10 of 3GPP TS 23.502 [3], the NRF shall find a match by looking into either natedIpv4AddressRanges or natedIpv6PrefixRanges in the DnnUpfInfoItem. +- NOTE 28: If the NF service consumer includes a "tai-list" query parameter and the "nf-tai-list-ind" query parameter set to true, and if the NRF supports the same and the NRF is not able to find any NF supporting all TAs included in the tai-list, the NRF may return a list of NFs in the SearchResult where each NF supports at least one TA in the tai-list; in this case, the NRF should attempt to return a list of NFs that altogether support as many TAs from the tai-list as possible, and it should indicate in the SearchResultInfo attribute the list of TAs from the tai-list which are not supported by these NFs. +- NOTE 29: The NRF should return as many matching NF profiles and/or NF Instance IDs as possible in the NF Discovery Response. If all the NF profiles matching the query parameters cannot be returned in the NF + +Discovery response (e.g. due to the maximum payload size), the NRF may decide to store the complete search result for subsequent retrieval by the NRF consumer (see clause 6.2.3.4). Alternatively, the NRF may include all the NF instance IDs rather than NF profiles in the NF Discovery response (using the Enh-NF-Discovery feature, see clause 5.3.2.2.2). + +When certain query parameters in the discovery request are not supported by the NRF, the NRF shall ignore the unsupported query parameters and continue processing the request with the supported query parameters. The default logical relationship among the supported query parameters is logical "AND", i.e. all the provided query parameters shall be matched, with the exception of the "preferred-locality", "ext-preferred-locality", "preferred-nf-instances", "preferred-tai", "preferred-api-versions", "preferred-full-plmn", "preferred-collocated-nf-types", "preferred-pgw-ind", "preferred-analytics-delays", "preferred-features" and "mbs-session-id" query parameters (see Table 6.2.3.2.3.1-1). + +The NRF may support the Complex query expression as defined in 3GPP TS 29.501 [5] for the NF Discovery service. If the "complexQuery" query parameter is included, then the logical relationship among the query parameters contained in "complexQuery" query parameter is as defined in 3GPP TS 29.571 [7]. + +A NRF not supporting Complex query expression shall reject a NF service discovery request including a complexQuery parameter, with a ProblemDetails IE including the cause attribute set to INVALID\_QUERY\_PARAM and the invalidParams attribute indicating the complexQuery parameter. + +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. + +**Table 6.2.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SearchResult | M | 1 | 200 OK | The response body contains the result of the search over the list of registered NF Instances. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The response shall be used when the intermediate NRF redirects the service discovery request.
The NRF shall include in this response a Location header field containing a URI pointing to the resource located on the redirect target NRF. If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| ProblemDetails | O | 0..1 | 400 Bad Request | The response body contains the error reason of the request message.

If the query parameter used to match the authorization parameter is required but not provided in the NF discovery request, the "cause" attribute shall be set to "MANDATORY_QUERY_PARAM_MISSING", and the missing query parameter shall be indicated. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This response shall be returned if the Requester NF is not allowed to discover the NF Service(s) being queried. | +| ProblemDetails | O | 0..1 | 404 Not Found | This response shall be returned if the requested resource URI as defined in clause 6.2.3.2.2 (query parameter not considered) is not found in the server.

It may also be sent in hierarchical NRF deployments when the NRF needs to forward/redirect the request to another NRF but lacks information in the request to do so; similarly, the NRF shall return this response code when it is received from the upstream NRF. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | The response body contains the error reason of the request message. | + +**Table 6.2.3.2.3.1-4: Headers supported by the GET method on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|---------------------------------------------------------------------------------------| +| If-None-Match | string | C | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [40], clause 13.1.2 | + +**Table 6.2.3.2.3.1-5: Headers supported by the 200 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Cache-Control | string | C | 0..1 | Cache-Control containing max-age, described in IETF RFC 9111 [20], clause 5.2 | +| ETag | string | C | 0..1 | Entity Tag containing a strong validator, described in IETF RFC 9110 [40], clause 8.8.3 | + +**Table 6.2.3.2.3.1-6: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------| +| Location | string | M | 1 | The URI pointing to the resource located on the redirect target NRF | + +**Table 6.2.3.2.3.1-7: Links supported by the 200 Response Code on this endpoint** + +| Name | Resource name | HTTP method or custom operation | Parameters table | Description | +|----------------|-----------------------------------|---------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| search | Stored Search (Document) | GET | 6.2.3.2.3.1-8 | The 'searchId' parameter returned in the response can be used as the 'searchId' parameter in the GET request to '/searches/{searchId}' | +| completeSearch | Complete Stored Search (Document) | GET | 6.2.3.2.3.1-9 | The 'searchId' parameter returned in the response can be used as the 'searchId' parameter in the GET request to '/searches/{searchId}/complete' | + +## 6.2.3.2.4 Resource Custom Operations + +There are no resource custom operations for the Nnrf\_NFDiscovery service in this release of the specification. + +## 6.2.3.3 Resource: Stored Search (Document) + +### 6.2.3.3.1 Description + +This resource represents a search result (i.e. a number of discovered NF Instances), stored by NRF as a consequence of a prior search result. + +This resource is modelled as the Document resource archetype (see clause C.3 of 3GPP TS 29.501 [5]). + +### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-disc/v1/searches/{searchId} + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| searchId | string | Identifier of a stored search result, returned by NRF to the NF Consumer in the original response to the NF Discovery GET operation (see clause 6.2.6.2.2). | + +### 6.2.3.3.2.1 GET + +This method retrieves the NF Instances corresponding to a given stored search result. + +This method shall support the URI query parameters specified in table 6.2.3.3.2.1-1. + +**Table 6.2.3.3.2.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.2.1-2 and the response data structures and response codes specified in table 6.2.3.3.2.1-3. + +**Table 6.2.3.3.2.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.3.2.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|----------------|--------------------------------------------------------------------------------------------| +| StoredSearchResult | M | 1 | 200 OK | The response body contains the NF Instances corresponding to a given stored search result. | +| NOTE: | The mandatory HTTP error status codes for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). | | | | + +## 6.2.3.4 Resource: Complete Stored Search (Document) + +### 6.2.3.4.1 Description + +This resource represents a complete search result (i.e. a number of discovered NF Instances), stored by NRF as a consequence of a prior search result, but without applying any client restrictions in terms of the number of instances to be returned (i.e. "limit" or "max-payload-size" query parameters). + +This resource is modelled as the Document resource archetype (see clause C.3 of 3GPP TS 29.501 [5]). + +### 6.2.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-disc/v1/searches/{searchId}/complete + +This resource shall support the resource URI variables defined in table 6.2.3.4.2-1. + +**Table 6.2.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| searchId | string | Identifier of a stored search result, returned by NRF to the NF Consumer in the original response to the NF Discovery GET operation (see clause 6.2.6.2.2). | + +#### 6.2.3.4.2.1 GET + +This method retrieves the NF Instances corresponding to a given stored search result. + +This method shall support the URI query parameters specified in table 6.2.3.4.2.1-1. + +**Table 6.2.3.4.2.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.4.2.1-2 and the response data structures and response codes specified in table 6.2.3.4.3.1-3. + +**Table 6.2.3.4.2.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.4.2.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| StoredSearchResult | M | 1 | 200 OK | The response body contains the NF Instances corresponding to a given stored search result, but without applying any client restrictions in terms of the number of instances to be returned (i.e. "limit" or "max-payload-size" query parameters). | +| NOTE: The mandatory HTTP error status codes for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). | | | | | + +## 6.2.3.5 Resource: SCP Domain Routing Information (Document) + +### 6.2.3.5.1 Description + +This resource represents (local) SCP Domain Routing Information, calculated by NRF based on SCPs registered in the network (or in the producer NRF for local SCP Domain Routing Information). + +This resource is modelled as the Document resource archetype (see clause C.3 of 3GPP TS 29.501 [5]). + +### 6.2.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-disc/v1/scp-domain-routing-info + +This resource shall support the resource URI variables defined in table 6.2.3.5.2-1. + +**Table 6.2.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.2.1 | + +#### 6.2.3.5.2.1 GET + +This method retrieves the (local) SCP Domain Routing Information. + +This method shall support the URI query parameters specified in table 6.2.3.5.2.1-1. + +**Table 6.2.3.5.2.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| local | boolean | O | 0..1 | When present, this IE shall indicate whether local SCP Domain Routing Information is to be fetched:
- true: local SCP Domain Routing Information to be fetched.
- false (default): SCP Domain Routing Information to be fetched | + +This method shall support the request data structures specified in table 6.2.3.5.2.1-2 and the response data structure and response codes specified in table 6.2.3.5.2.1-3. + +**Table 6.2.3.5.2.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.5.2.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------| +| ScpDomainRoutingInfo | M | 1 | 200 OK | The response body contains SCP Domain Routing Information. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). | | | | | + +## 6.2.3.6 Resource: SCP Domain Routing Information Subscriptions (Collection) + +### 6.2.3.6.1 Description + +This resource represents a collection of subscriptions of (local) SCP Domain Routing Information. + +### 6.2.3.6.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-disc/v1/scp-domain-routing-info-subs + +This resource shall support the resource URI variables defined in table 6.2.3.6.2-1. + +**Table 6.1.3.6.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.2.1 | + +### 6.2.3.6.3 Resource Standard Methods + +#### 6.2.3.6.3.1 POST + +This method creates a new subscription. This method shall support the URI query parameters specified in table 6.2.3.6.3.1-1. + +**Table 6.2.3.6.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.6.3.1-2 and the response data structure and response codes specified in table 6.2.3.6.3.1-3. + +**Table 6.2.3.6.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------------|---|-------------|----------------------------------------------------------------------| +| ScpDomainRoutingInfoSubscription | M | 1 | The request body contains the input parameters for the subscription. | + +**Table 6.2.3.6.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ScpDomainRoutingInfoSubscription | M | 1 | 201 Created | This case represents the successful creation of a subscription.

Upon success, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). | | | | | + +**Table 6.2.3.6.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nnrf-disc/v1/scp-domain-routing-info-subs/{subscriptionId} | + +## 6.2.3.7 Resource: Individual SCP Domain Routing Information Subscription (Document) + +### 6.2.3.7.1 Description + +This resource represents an individual subscription of (local) SCP Domain Routing Information. + +### 6.2.3.7.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-disc/v1/scp-domain-routing-info-subs/{subscriptionID} + +This resource shall support the resource URI variables defined in table 6.2.3.7.2-1. + +**Table 6.2.3.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| subscriptionID | string | Represents a specific subscription | + +### 6.2.3.7.3 Resource Standard Methods + +#### 6.2.3.7.3.1 DELETE + +This method terminates an existing subscription. This method shall support the URI query parameters specified in table 6.2.3.7.3.1-1. + +**Table 6.2.3.7.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.7.3.1-2 and the response data structure and response codes specified in table 6.2.3.7.3.1-3. + +**Table 6.2.3.7.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.7.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|----------------|-------------| +| n/a | | | 204 No Content | | +| NOTE: | The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). | | | | + +## 6.2.4 Custom Operations without associated resources + +There are no custom operations defined without any associated resources for the Nnrf\_NFDiscovery service in this release of this specification. + +## 6.2.5 Notifications + +### 6.2.5.1 General + +This clause specifies the notifications provided by the Nnrf\_NFDiscovery service. + +The delivery of notifications shall be supported as specified in clause 6.2 of 3GPP TS 29.500 [4] for Server-initiated communication. + +**Table 6.2.5.1-1: Notifications overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|----------------------------------------------------|--------------------------------------------------------------------|---------------------------------|-------------------------------------------------------| +| SCP Domain Routing Information Change Notification | {callbackUri}
(NF Service Consumer provided callback reference) | POST | Notify about change of SCP Domain Routing Information | + +### 6.2.5.2 SCP Domain Routing Information Change Notification + +#### 6.2.5.2.1 Description + +The NF Service Consumer provides a callback URI for getting notified about change of (local) SCP Domain Routing Information, the NRF shall notify the NF Service Consumer, when the (local) SCP Domain Routing Information is updated. + +#### 6.2.5.2.2 Notification Definition + +The POST method shall be used for SCP Domain Routing Information Change Notification and the URI shall be the callback reference provided by the NF Service Consumer during the subscription to this notification. + +Resource URI: {callbackUri} + +Support of URI query parameters are specified in table 6.2.5.2.2-1. + +**Table 6.2.5.2.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.2.5.2.2-2, and support of response data structures and response codes is specified in table 6.2.5.2-3. + +**Table 6.2.5.2.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|----------------------------------|---|-------------|---------------------------------------------------------------------------| +| ScpDomainRoutingInfoNotification | M | 1 | Representation of the SCP Domain Routing Information Change Notification. | + +**Table 6.2.5.2.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|----------------|------------------------------------------------------------------------------------------| +| N/A | | | 204 No Content | This case represents a successful notification of SCP Domain Routing Information Change. | +| NOTE: | The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). | | | | + +## 6.2.6 Data Model + +### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nnrf service based interface protocol. + +**Table 6.2.6.1-1: Nnrf\_NFDiscovery specific Data Types** + +| Data type | Clause defined | Description | +|----------------------------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------| +| SearchResult | 6.2.6.2.2 | Contains the list of NF Profiles returned in a Discovery response. | +| NFProfile | 6.2.6.2.3 | Information of an NF Instance discovered by the NRF. | +| NFService | 6.2.6.2.4 | Information of a given NF Service Instance; it is part of the NFProfile of an NF Instance discovered by the NRF. | +| StoredSearchResult | 6.2.6.2.5 | Contains a complete search result (i.e. a number of discovered NF Instances), stored by NRF as a consequence of a prior search result. | +| PreferredSearch | 6.2.6.2.6 | Contains information on whether the returned NFProfiles match the preferred query parameters. | +| NFInstanceInfo | 6.2.6.2.7 | Contains information on an NF profile matching a discovery request. | +| ScpDomainRoutingInfo | 6.2.6.2.8 | SCP Domain Routing Information | +| ScpDomainConnectivity | 6.2.6.2.9 | SCP Domain Routing Information | +| ScpDomainRoutingInfoSubscription | 6.2.6.2.10 | SCP Domain Routing Information Subscription | +| ScpDomainRoutingInfoNotification | 6.2.6.2.11 | Notification for SCP Domain Routing Information Update | +| NFServiceInstance | 6.2.6.2.12 | NF service instance | +| NoProfileMatchInfo | 6.2.6.2.13 | No Profile Matching information | +| QueryParamCombination | 6.2.6.2.14 | Contains a list of query parameters | +| QueryParameter | 6.2.6.2.15 | Contains name and value of a query parameter | +| AfData | 6.2.6.2.16 | Contains information supported by the trusted AF. | +| SearchResultInfo | 6.2.6.2.17 | Contains additional information related to the SearchResult. | + +Table 6.2.6.1-2 specifies data types re-used by the Nnrf\_NFDiscovery 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 Nnrf\_NFDiscovery service-based interface. + +**Table 6.2.6.1-2: Nnrf\_NFDiscovery re-used Data Types** + +| Data type | Reference | Comments | +|---------------------------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Sns sai | 3GPP TS 29.571 [7] | | +| PimnId | 3GPP TS 29.571 [7] | | +| Dnn | 3GPP TS 29.571 [7] | | +| Tai | 3GPP TS 29.571 [7] | | +| SupportedFeatures | 3GPP TS 29.571 [7] | | +| NfInstanceId | 3GPP TS 29.571 [7] | Identifier (UUID) of the NF Instance. The hexadecimal letters of the UUID should be formatted by the sender as lower-case characters and shall be handled as case-insensitive by the receiver. | +| Uri | 3GPP TS 29.571 [7] | | +| Gpsi | 3GPP TS 29.571 [7] | | +| GroupId | 3GPP TS 29.571 [7] | | +| Guami | 3GPP TS 29.571 [7] | | +| IPv4Addr | 3GPP TS 29.571 [7] | | +| IPv6Addr | 3GPP TS 29.571 [7] | | +| UriScheme | 3GPP TS 29.571 [7] | | +| Dnai | 3GPP TS 29.571 [7] | | +| NfGroupId | 3GPP TS 29.571 [7] | Identifier of a NF Group | +| PduSessionType | 3GPP TS 29.571 [7] | | +| AtsssCapability | 3GPP TS 29.571 [7] | | +| PimnIdNid | 3GPP TS 29.571 [7] | | +| NfSetId | 3GPP TS 29.571 [7] | | +| NfServiceSetId | 3GPP TS 29.571 [7] | | +| ExtSns sai | 3GPP TS 29.571 [7] | | +| DurationSec | 3GPP TS 29.571 [7] | | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of the redirect response message. | +| MbsSessionId | 3GPP TS 29.571 [7] | MBS Session Identifier | +| IpAddr | 3GPP TS 29.571 [7] | IP Address | +| AreaSessionId | 3GPP TS 29.571 [7] | Area Session Identifier used for an MBS session with location dependent content | +| Fqdn | 3GPP TS 29.571 [7] | Fully Qualified Domain Name | +| EventId | 3GPP TS 29.520 [32] | Defined in Nnwdaf_AnalyticsInfo API. | +| NwdafEvent | 3GPP TS 29.520 [32] | Defined in Nnwdaf_EventsSubscription API. | +| ExtGroupId | 3GPP TS 29.503 [36] | | +| SharedDataId | 3GPP TS 29.503 [36] | | +| ExternalClientType | 3GPP TS 29.572 [33] | | +| SupportedGADShapes | 3GPP TS 29.572 [33] | Supported GAD Shapes | +| EventType | 3GPP TS 29.564 [49] | Event type supported by the UPF Event Exposure service | +| DefaultNotificationSubscription | 3GPP TS 29.510 | See clause 6.1.6.2.4 | +| IPEndPoint | 3GPP TS 29.510 | See clause 6.1.6.2.5 | +| NFType | 3GPP TS 29.510 | See clause 6.1.6.3.3 | +| UdrInfo | 3GPP TS 29.510 | See clause 6.1.6.2.6 | +| UdmInfo | 3GPP TS 29.510 | See clause 6.1.6.2.7 | +| AusfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.8 | +| SupiRange | 3GPP TS 29.510 | See clause 6.1.6.2.9 | +| AmfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.11 | +| SmfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.12 | +| UpfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.13 | +| PcfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.20 | +| BsfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.21 | +| ChfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.32 | +| NFServiceVersion | 3GPP TS 29.510 | See clause 6.1.6.2.19 | +| PimnSns sai | 3GPP TS 29.510 | See clause 6.1.6.2.44 | +| NwdafInfo | 3GPP TS 29.510 | See clause 6.1.6.2.45 | +| NFStatus | 3GPP TS 29.510 | See clause 6.1.6.3.7 | +| DataSetId | 3GPP TS 29.510 | See clause 6.1.6.3.8 | +| ServiceName | 3GPP TS 29.510 | See clause 6.1.6.3.11 | +| NFServiceStatus | 3GPP TS 29.510 | See clause 6.1.6.3.12 | +| LmfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.46 | +| GmlcInfo | 3GPP TS 29.510 | See clause 6.1.6.2.47 | +| NefInfo | 3GPP TS 29.510 | See clause 6.1.6.2.48 | +| PfdData | 3GPP TS 29.510 | See clause 6.1.6.2.49 | +| AfEventExposureData | 3GPP TS 29.510 | See clause 6.1.6.2.50 | +| PscsfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.53 | + +| | | | +|-------------------------|----------------|------------------------| +| HssInfo | 3GPP TS 29.510 | See clause 6.1.6.2.57 | +| ImsiRange | 3GPP TS 29.510 | See clause 6.1.6.2.58 | +| VendorSpecificFeature | 3GPP TS 29.510 | See clause 6.1.6.2.62 | +| ScpInfo | 3GPP TS 29.510 | See clause 6.1.6.2.65 | +| NefId | 3GPP TS 29.510 | See clause 6.1.6.3.2 | +| VendorId | 3GPP TS 29.510 | See clause 6.1.6.3.2 | +| AnNodeType | 3GPP TS 29.510 | See clause 6.1.6.3.13 | +| SuciInfo | 3GPP TS 29.510 | See clause 6.1.6.2.71 | +| SeppInfo | 3GPP TS 29.510 | See clause 6.1.6.2.72 | +| NsacfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.81 | +| NsacfCapability | 3GPP TS 29.510 | See clause 6.1.6.2.82 | +| MIAnalyticsInfo | 3GPP TS 29.510 | See clause 6.1.6.2.84 | +| MbSmfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.85 | +| TsctsInfo | 3GPP TS 29.510 | See clause 6.1.6.2.91 | +| MbUpfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.94 | +| TrustAfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.96 | +| CollocatedNfInstance | 3GPP TS 29.510 | See clause 6.1.6.2.99 | +| NssaaInfo | 3GPP TS 29.510 | See clause 6.1.6.2.104 | +| IwmscInfo | 3GPP TS 29.510 | See clause 6.1.6.2.108 | +| MnpfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.109 | +| LocalityDescriptionItem | 3GPP TS 29.510 | See clause 6.1.6.2.111 | +| LocalityDescription | 3GPP TS 29.510 | See clause 6.1.6.2.112 | +| DcsfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.114 | +| MrfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.117 | +| MrfpInfo | 3GPP TS 29.510 | See clause 6.1.6.2.118 | +| MfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.119 | +| LocalityType | 3GPP TS 29.510 | See clause 6.1.6.3.18 | +| AdrfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.122 | +| SelectionConditions | 3GPP TS 29.510 | See clause 6.1.6.2.123 | +| CallbackUriPrefixItem | 3GPP TS 29.510 | See clause 6.1.6.2.127 | + +## 6.2.6.2 Structured data types + +### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 6.2.6.2.2 Type: SearchResult + +**Table 6.2.6.2.2-1: Definition of type SearchResult** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|---------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| validityPeriod | integer | M | 1 | It shall contain the time in seconds during which the discovery result is considered valid and can be cached by the NF Service Consumer. This value shall be the same as the value contained in the "max-age" parameter of the "Cache-Control" header field sent in the HTTP response. | | +| nflnstances | array(NFProfile) | M | 0..N | It shall contain an array of NF Instance profiles, matching the search criteria indicated by the query parameters of the discovery request. If the nflnstancesList IE is absent, an empty array means there is no NF instance that can match the search criteria.
NF instance profiles included in this IE shall not contain authorization attributes (such as the "allowedXXX" attributes of the NFProfile or NFService data types). | | +| completeNflnstances | array(NFProfile) | C | 1..N | When present, it shall contain an array of complete NF Instance profiles (including authorization attributes such as the "allowedXXX" attributes of the NFProfile or NFService data types), matching the search criteria indicated by the query parameters of the discovery request.

This IE shall only be present if the NRF supports the "Complete-Profile-Discovery" feature, the "complete-profile" query parameter is present and set to true in the request (see clause 6.2.3.2.3.1) and if the requesting entity is authorized to discover the complete profile of NF instances. | | +| searchId | string | O | 0..1 | This IE may be present if the NRF stores the result of the current service discovery response in a given URL (server-side caching), to make it available in the future to NF Service Consumers without having to compute the whole search process again. | | +| numNflnstComplete | Uint32 | O | 0..1 | This IE may be present when the total number of NF Instances found by NRF, as the result of the service discovery process, is higher than the actual number of NF Instances included in the attribute nflnstances of the SearchResult object. This may happen due to the NF Service Consumer including in the discovery request parameters such as "limit" or "max-payload-size". | | +| preferredSearch | PreferredSearch | C | 0..1 | This IE shall be present to indicate whether all the returned NFProfiles match the preferred query parameters, if the discovery request contains any of the query parameter defined in the PreferredSearch data type. | | +| nrfSupportedFeatures | SupportedFeatures | C | 0..1 | Features supported by the NRF for the NFDiscovery service (see clause 6.2.9). This IE should be present if the NRF supports at least one feature. | | +| nflnstanceList | map(NflnstanceInfo) | O | 1..N | This IE may be present if the NF Discovery request indicated support of the Enh-NF-Discovery feature.
When present, this IE shall contain a map of NflnstanceInfo of NF instance profiles matching the search criteria indicated by the query parameters of the discovery request. The key of the map shall be the NF instance ID.
(NOTE 2) | | +| searchResultInfo | SearchResultInfo | C | 0..1 | This IE should be present if the NF Discovery Request includes a tai-list query parameter and the "nf-tai-list-ind" query parameter set to true, | Query-SBIProtoc18 | + +| | | | | | | +|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | when the NFs included in the nfinstances or nfinstanceList altogether support only a subset of TAs included in the tai-list. | | +| alteredPriorityInd | boolean | O | 0..1 |

This IE shall indicate whether the NRF altered the priority values returned in the search result or not. (NOTE 1, NOTE 3)

When present, this IE shall be set as following:
- true: NF instances with NRF altered priority are returned in the search result.
- false: the NRF has not altered priority values in any NF instance returned in the search result

| | +| noProfileMatchInfo | NoProfileMatchInfo | O | 0..1 |

This IE may be present if an empty array of nfinstances is conveyed and the nfinstancesList IE is absent; otherwise it shall be absent. If present, it shall indicate the specific reason for not finding any NF instance that can match the search criteria.

| | +| ignoredQueryParams | array(string) | O | 1..N |

This IE may be present when the NRF has ignored unsupported query parameters when processing the discovery request.

When present, this IE shall list the ignored unsupported query parameters for this discovery. Each array item shall uniquely indicate one ignored query parameter, with the query parameter name as specified in Table 6.2.3.2.3.1-1.

| | +| NOTE 1: | If NRF altered priority values are returned in the search result, when the NF consumer receives a different priority value in a subsequent NF Profile change notification for NF instance(s) returned in the search result, the NF consumer should not overwrite the NRF altered priority in the cached search result. | | | | | +| NOTE 2: | If the alteredPriorityInd IE is present and set to true and the nrfAlteredPriorities IE is not included for a certain NF instance of the nfinstanceList, the NF consumer shall apply the priorities retrieved in the corresponding NF profile for this NF instance when selecting a NF service producer for the corresponding NF Discovery request. | | | | | +| NOTE 3: | This IE shall be set if the NRF altered the priority values of one or more NF instances returned in the search result, regardless of whether the NF instances are returned in the nfinstances IE and/or nfinstanceList IE. | | | | | + +## 6.2.6.2.3 Type: NFProfile + +**Table 6.2.6.2.3-1: Definition of type NFProfile** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nflInstanceId | NflInstanceId | M | 1 | Unique identity of the NF Instance. | +| nfType | NFType | M | 1 | Type of Network Function | +| nfStatus | NFStatus | M | 1 | Status of the NF Instance | +| collocatedNfInstances | array(CollocatedNfInstance) | O | 1..N | Information related collocated NF type(s) and corresponding NF Instance(s) when the NF is collocated with NFs supporting other NF types | +| nflInstanceName | string | O | 0..1 | Human readable name of the NF Instance | +| plmnList | array(PlmnId) | C | 1..N | PLMN(s) of the Network Function (NOTE 5). This IE shall be present if this information is available for the NF. If neither the plmnList IE nor the snpnList IE were provided by the NF during registration, the NRF should return the list of PLMN ID(s) of the PLMN of the NRF. If both the plmnList IE and the snpnList IE are absent in the response, PLMN ID(s) of the PLMN of the NRF are assumed for the NF. | +| sNssais | array(ExtSnssai) | O | 1..N | S-NSSAIs of the Network Function.
If not provided, and if the perPlmnSnssaiList attribute is not present, the NF can serve any S-NSSAI.
If the sNssais attribute is provided in at least one NF Service, the sNssais attribute in the NF Profile shall be present and be the set or a superset of the sNssais of the NFService(s). | +| perPlmnSnssaiList | array(PlmnSnssai) | O | 1..N | The per-PLMN list of S-NSSAI(s) supported by the Network Function.
If the perPlmnSnssaiList attribute is provided in at least one NF Service, the perPlmnSnssaiList attribute in the NF Profile shall be present and be the set or a superset of the perPlmnSnssaiList of the NFService(s). | +| nsiList | array(string) | O | 1..N | List of NSIs of the Network Function.
If not provided, the NF can serve any NSI. | +| fqdn | Fqdn | C | 0..1 | FQDN of the Network Function (NOTE 1, NOTE 3, NOTE 11) | +| interPlmnFqdn | Fqdn | C | 0..1 | If the requester-plmn-list query parameter is absent in the NF Discovery request, or if is present and the requester's PLMN is the same as the PLMN of the discovered NF, then this attribute shall be included by the NRF and it shall contain the interPlmnFqdn value registered by the NF during NF registration (see clause 6.1.6.2.2), if the interPlmnFqdn attribute was registered in the NF profile.
This attribute shall be absent if the requester-plmn in the query parameter is different from the PLMN of the discovered NF.
(NOTE 3, NOTE 14) | +| ipv4Addresses | array(Ipv4Addr) | C | 1..N | IPv4 address(es) of the Network Function (NOTE 1, NOTE 11) | +| ipv6Addresses | array(Ipv6Addr) | C | 1..N | IPv6 address(es) of the Network Function (NOTE 1, NOTE 11) | +| allowedPlmns | array(PlmnId) | C | 1..N | PLMNs allowed to access the NF instance.

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

If not provided, any PLMN is allowed to access the NF. | +| allowedSnpns | array(PlmnIdNid) | C | 1..N | SNPNs allowed to access the NF instance.

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

If this attribute is present in the NFService and in the NF profile, the attribute from the NFService shall | + +| | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

prevail.

The absence of this attribute in both the NFService and in the NF profile indicates that no SNPN, other than the SNPN(s) registered in the snpnList attribute of the NF Profile (if the NF pertains to an SNPN), is allowed to access the service instance.

| +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|------------------|------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedNfTypes | array(NFType) | C | 1..N |

Type of the NFs allowed to access the NF instance.

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

If not provided, any NF type is allowed to access the NF.

| +| allowedNfDomains | array(string) | C | 1..N |

Pattern (regular expression according to the ECMA-262 dialect [8]) representing the NF domain names within the PLMN of the NRF allowed to access the NF instance.

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

If not provided, any NF domain is allowed to access the NF.

| +| allowedNssais | array(ExtSnssai) | C | 1..N |

S-NSSAI of the allowed slices to access the NF instance.

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

If not provided, any slice is allowed to access the NF.

| +| allowedRuleSet | map(RuleSet) | O | 1..N |

Map of rules specifying NF-Consumers allowed or denied to access NF-Producer. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.

This IE may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types) if the NF-Consumer supports Allowed-ruleset feature as specified in Clause 6.2.9. It shall not be present otherwise.

| +| capacity | integer | O | 0..1 |

Static capacity information within the range 0 to 65535, expressed as a weight relative to other NF instances of the same type; if capacity is also present in the nfServiceList parameters, those will have precedence over this value. (See NOTE 2)

| +| load | integer | O | 0..1 |

Latest known load information of the NF within the range 0 to 100 in percentage (See NOTE 4)

| +| loadTimeStamp | DateTime | O | 0..1 |

It indicates the point in time in which the latest load information of the NF Instance was sent from the NF to the NRF.

| +| locality | string | O | 0..1 |

Operator defined information about the location of the NF instance (e.g. geographic location, data center)

| +| extLocality | map(string) | O | 1..N |

Operator defined information about the location of the NF instance. (NOTE 3)

The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters, representing a type of locality as defined in clause 6.1.6.3.18.

Example:
{
  "DATA_CENTER": "dc-123",
  "CITY": "Los Angeles",
  "STATE": "California"
}

| + +| | | | | | +|--|--|--|--|--| +| | | | | | +|--|--|--|--|--| + +| | | | | | +|--------------|---------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| priority | integer | O | 0..1 |

Priority (relative to other NFs of the same type) within the range 0 to 65535, to be used for NF selection; lower values indicate a higher priority. Priority may or may not be present in the nfServiceList parameters, xxxInfo parameters and in this attribute. Priority in the nfServiceList has precedence over the priority in this attribute. (NOTE 2)

Priority in xxxInfo parameter shall only be used to determine the relative priority among NF instances with the same priority at NFPProfile/NFService.

| +| udrInfo | UdrInfo | O | 0..1 | Specific data for the UDR (ranges of SUPI, ...) | +| udrInfoList | map(UdrInfo) | O | 1..N |

Multiple entries of UdrInfo. This attribute provides additional information to the udrInfo. udrInfoList may be present even if the udrInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.

| +| udmInfo | UdmInfo | O | 0..1 | Specific data for the UDM | +| udmInfoList | map(UdmInfo) | O | 1..N |

Multiple entries of UdmInfo. This attribute provides additional information to the udmInfo. udmInfoList may be present even if the udmInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.

| +| ausfInfo | AusfInfo | O | 0..1 | Specific data for the AUSF | +| ausfInfoList | map(AusfInfo) | O | 1..N |

Multiple entries of AusfInfo. This attribute provides additional information to the ausfInfo. ausfInfoList may be present even if the ausfInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.

| +| amfInfo | AmfInfo | O | 0..1 | Specific data for the AMF (AMF Set ID, ...) | +| amfInfoList | map(AmfInfo) | O | 1..N |

Multiple entries of AmfInfo. This attribute provides additional information to the amfInfo. amfInfoList may be present even if the amfInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.

| +| smfInfo | SmfInfo | O | 0..1 | Specific data for the SMF (DNN's, ...). (NOTE 8) | +| smfInfoList | map(SmfInfo) | O | 1..N |

Multiple entries of SmfInfo. This attribute provides additional information to the smfInfo. smfInfoList may be present even if the smfInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. (NOTE 8)

| +| upfInfo | UpfInfo | O | 0..1 | Specific data for the UPF (S-NSSAI, DNN, SMF serving area, ...) | +| upfInfoList | map(UpfInfo) | O | 1..N |

Multiple entries of UpfInfo. This attribute provides additional information to the upfInfo. upfInfoList may be present even if the upfInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.

| +| pcfInfo | PcfInfo | O | 0..1 | Specific data for the PCF | +| pcfInfoList | map(PcfInfo) | O | 1..N |

Multiple entries of PcfInfo. This attribute provides additional information to the pcfInfo. pcfInfoList may be present even if the pcfInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.

| +| bsfInfo | BsfInfo | O | 0..1 | Specific data for the BSF | +| bsfInfoList | map(BsfInfo) | O | 1..N |

Multiple entries of BsfInfo. This attribute provides additional information to the bsfInfo. bsfInfoList may be present even if the bsfInfo is absent.

| + +| | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------| +| | | | | The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|----------------------------------|----------------------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| chfInfo | ChfInfo | O | 0..1 | Specific data for the CHF | +| chfInfoList | map(ChfInfo) | O | 1..N | Multiple entries of ChfInfo. This attribute provides additional information to the chfInfo. chfInfoList may be present even if the chfInfo is absent.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| udsInfo | UdsInfo | O | 0..1 | Specific data for the UDSF | +| udsInfoList | map(UdsInfo) | O | 1..N | Multiple entries of udsInfo. This attribute provides additional information to the udsInfo. udsInfoList may be present even if the udsInfo is absent.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| nefInfo | NefInfo | O | 0..1 | Specific data for the NEF | +| nwdaInfo | NwdaInfo | O | 0..1 | Specific data for the NWDAF | +| nwdaInfoList | map(NwdaInfo) | O | 1..N | Multiple entries of nwdaInfo. This attribute provides additional information to the nwdaInfo. nwdaInfoList may be present even if the nwdaInfo is absent.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| pcscfInfoList | map(PcscfInfo) | O | 1..N | Specific data for the P-CSCF.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.
(NOTE 7) | +| hssInfoList | map(HssInfo) | O | 1..N | Specific data for the HSS.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| customInfo | object | O | 0..1 | Specific data for custom Network Functions | +| recoveryTime | DateTime | O | 0..1 | Timestamp when the NF was (re)started | +| nfServicePersistence | boolean | O | 0..1 | - true: If present, and set to true, it indicates that the different service instances of a same NF Service in the NF instance, supporting a same API version, are capable to persist their resource state in shared storage and therefore these resources are available after a new NF service instance supporting the same API version is selected by a NF Service Consumer (see 3GPP TS 23.527 [27]).

- false (default): Otherwise, it indicates that the NF Service Instances of a same NF Service are not capable to share resource state inside the NF Instance. | +| nfServices | array(NFService) | O | 1..N | List of NF Service Instances.
(NOTE 10)

This attribute is deprecated; the attribute "nfServiceList" should be used instead. | +| nfServiceList | map(NFService) | O | 1..N | Map of NF Service Instances, where the "serviceInstanceId" attribute of the NFService object shall be used as the key of the map.
(NOTE 10) | +| defaultNotificationSubscriptions | array(DefaultNotificationSubscription) | O | 1..N | Notification endpoints for different notification types.
(NOTE 6)
(See also NOTE 10 in clause 6.1.6.2.2) | +| lmfInfo | LmfInfo | O | 0..1 | Specific data for the LMF | +| gmlcInfo | GmlcInfo | O | 0..1 | Specific data for the GMLC | +| snpnList | array(PlmnIdNid) | C | 1..N | SNPN(s) of the Network Function.
This IE shall be present if the NF pertains to one or more SNPNs. | +| nfSetIdList | array(NfSetId) | C | 1..N | NF Set ID defined in clause 28.12 of 3GPP TS 23.003 [12].
At most one NF Set ID shall be indicated per PLMN-ID or SNPN of the NF. At most one combination of an AMF region and an AMF Set ID shall be indicated | + +| | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------| +| | | | | per PLMN-ID or SNPN in an AMF profile.
This information shall be present if available. | +|--|--|--|--|-------------------------------------------------------------------------------------------| + +| | | | | | +|---------------------------------|-----------------------------------|---|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servingScope | array(string) | O | 1..N | The served area(s) of the NF instance.
The absence of this attribute does not imply the NF instance can serve every area. | +| lchSupportInd | boolean | O | 0..1 | This IE indicates whether the NF supports Load Control based on LCI Header (see clause 6.3 of 3GPP TS 29.500 [4]).
- true: the NF supports the feature.
- false (default): the NF does not support the feature. | +| olchSupportInd | boolean | O | 0..1 | This IE indicates whether the NF supports Overload Control based on OCI Header (see clause 6.4 of 3GPP TS 29.500 [4]).
- true: the NF supports the feature.
- false (default): the NF does not support the feature. | +| nfSetRecoveryTimeList | map(DateTime) | O | 1..N | Map of recovery time, where the key of the map is the NfSetId of NF Set(s) that the NF instance belongs to.

When present, the value of each entry of the map shall be the recovery time of the NF Set indicated by the key. | +| serviceSetRecoveryTimeList | map(DateTime) | O | 1..N | Map of recovery time, where the key of the map is the NfServiceSetId of the NF Service Set(s) configured in the NF instance.

When present, the value of each entry of the map shall be the recovery time of the NF Service Set indicated by the key. | +| scpDomains | array(string) | O | 1..N | When present, this IE shall carry the list of SCP domains the SCP belongs to, or the SCP domain the NF (other than SCP) or the SEPP belongs to. (NOTE 9) | +| scpInfo | ScpInfo | O | 0..1 | Specific data for the SCP. | +| seppInfo | SeppInfo | O | 0..1 | Specific data for the SEPP. | +| vendorId | VendorId | O | 0..1 | Vendor ID of the NF instance, according to the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. | +| supportedVendorSpecificFeatures | map(array(VendorSpecificFeature)) | O | 1..N(1..M) | Map of Vendor-Specific features, where the key of the map is the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. The string used as key of the map shall contain 6 decimal digits; if the SMI code has less than 6 digits, it shall be padded with leading digits "0" to complete a 6-digit string value.
The value of each entry of the map shall be a list (array) of VendorSpecificFeature objects. (NOTE 12) | +| aanfInfoList | map(AanfInfo) | O | 1..N | Specific data for the AAnF.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| mfaInfo | MfaInfo | O | 0..1 | Specific data for the MFAF. | +| eadfInfoList | map(EadfInfo) | O | 1..N | Specific data for the EASDF.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. (NOTE 13) | +| dcnfInfo | DcnfInfo | O | 0..1 | Specific data for the DCCF. | +| nsacfInfoList | map(NsacfInfo) | O | 1..N | Specific data for the NSACF.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| mbSmfInfoList | map(MbSmfInfo) | O | 1..N | MB-SMF specific data.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| tsctsInfoList | map(TsctsInfo) | O | 1..N | Specific data for the TSCTSF. | + +| | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------| +| | | | | The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbUpfInfoList | map(MbUpfInfo) | O | 1..N | MB-UPF specific data.

The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| trustAflnfo | TrustAflnfo | O | 0..1 | Specific data for the trusted AF. | +| nssaaflnfo | Nssaaflnfo | O | 0..1 | Specific data for the NSSAAF. | +| hniList | array(Fqdn) | C | 1..N | Identifications of Credentials Holder or Default Credentials Server.
This IE shall be present if the NFs are available for the case of access to an SNPN using credentials owned by a Credentials Holder or for the case of SNPN Onboarding using a DCS. | +| iwmscInfo | IwmscInfo | O | 0..1 | Specific data for the SMS-IWMSC. | +| mnpfInfo | MnpfInfo | O | 0..1 | Specific data for the MNPF. | +| smsfInfo | SmsfInfo | O | 0..1 | Specific data for the SMSF. | +| dcspfInfoList | map(DcsfInfo) | O | 1..N | DCSF specific data.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| mrfInfoList | map(MrfInfo) | O | 1..N | MRF specific data.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| mrfpInfoList | map(MrfpInfo) | O | 1..N | MRFP specific data.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| mflnfoList | map(MfInfo) | O | 1..N | MF specific data.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| adrfInfoList | map(AdrfInfo) | O | 1..N | ADRF specific data.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | +| selectionConditions | SelectionConditions | O | 0..1 | This IE is only applicable if the NFStatus is set to "CANARY_RELEASE".

If present, it includes the conditions under which an NF Instance with an NFStatus value set to "CANARY_RELEASE" shall be selected by an NF Service Consumer (e.g. if the UE belongs to a range of SUPIs) | +| NOTE 1: At least one of the addressing parameters (fqdn, ipv4address or ipv6address) shall be included in the NF Profile. See NOTE 1 of Table 6.2.6.2.4-1 for the use of these parameters. If multiple ipv4 addresses and/or ipv6 addresses are included in the NF Profile, the NF Service Consumer shall select one of these addresses randomly, unless operator defined local policy of IP address selection, in order to avoid overload for a specific ipv4 address and/or ipv6 address. | | | | | +| NOTE 2: The capacity and priority parameters, if present, are used for NF selection and load balancing. The priority and capacity attributes shall be used for NF selection in the same way that priority and weight are used for server selection as defined in IETF RFC 2782 [23]. | | | | | +| NOTE 3: If the requester-plmn in the query parameter is different from the PLMN of the discovered NF, then the fqdn attribute value shall contain the interPlmnFqdn value registered by the NF during NF registration (see clause 6.1.6.2.2). The requester-plmn is different from the PLMN of the discovered NF if it belongs to none of the PLMN ID(s) configured for the PLMN of the NRF. | | | | | +| NOTE 4: The usage of the load parameter by the NF service consumer is implementation specific, e.g. be used for NF selection and load balancing, together with other parameters. | | | | | +| NOTE 5: An NF may register multiple PLMN IDs in its profile within a PLMN comprising multiple PLMN IDs. If so, all the attributes of the NF Profile shall apply to each PLMN ID registered in the plmnList. As an exception, attributes including a PLMN ID, e.g. IMSI-based SUPI ranges, TAls and GUAMIs, are specific to one PLMN ID and the NF may register in its profile multiple occurrences of such attributes for different PLMN IDs (e.g. the UDM may register in its profile SUPI ranges for different PLMN IDs). | | | | | +| NOTE 6: For notification types that may be associated with a specific service of the NF Instance receiving the notification (see clause 6.1.6.3.4), if notification endpoints are present both in the profile of the NF instance (NFProfile) and in some of its NF Services (NFService) for a same notification type, the notification endpoint(s) of the NF Services shall be used for this notification type. | | | | | +| NOTE 7: The absence of the pcsfInfoList attribute in a P-CSCF profile indicates that the P-CSCF can be selected | | | | | + +for any DNN and Access Type, and that the P-CSCF Gm addressing information is the same as the addressing information registered in the fqdn, ipv4Addresses and ipv4Addresses attributes of the NF profile. + +- NOTE 8: The absence of both the smfInfo and smfInfoList attributes in an SMF profile indicates that the SMF can be selected for any S-NSSAI listed in the sNSSais and perPlmnSnssaiList IEs, or for any S-NSSAI if neither the sNSSais IE nor the perPlmnSnssaiList IE are present, and for any DNN, TAI and access type. +- NOTE 9: If an NF (other than a SCP or SEPP) includes this information in its profile, this indicates that the services produced by this NF should be accessed preferably via an SCP from the SCP domain the NF belongs to. +- NOTE 10: If the NF Service Consumer that issued the discovery request indicated support for the "Service-Map" feature, the NRF shall return in the discovery response the list of NF Service Instances in the "nfServiceList" map attribute. Otherwise, the NRF shall return the list of NF Service Instances in the "nfServices" array attribute. +- NOTE 11: For API URIs constructed with an FQDN, the NF Service Consumer may use the FQDN of the target URI to do a DNS query and obtain the IP address(es) to setup the TCP connection, and ignore the IP addresses that may be present in the NFProfile; alternatively, the NF Service Consumer may use those IP addresses to setup the TCP connection, if no service-specific FQDN or IP address is provided in the NFService data and if the NF Service Consumer supports to indicate specific IP address(es) to establish an HTTP/2 connection with an FQDN in the target URI. +- NOTE 12: When present, this attribute allows an NF requesting NF Discovery (e.g. an NF Service Consumer) to determine which vendor-specific extensions are supported in a given NF (e.g. an NF Service Producer), so as to select an appropriate NF with specific capability, or to include or not the vendor-specific attributes (see 3GPP TS 29.500 [4] clause 6.6.3) required for a given feature in subsequent messages towards a certain NF. One given vendor-specific feature shall not appear in both NF Profile and NF Service Profile. If one vendor-specific feature is service related, it shall only be included in the NF Service Profile. +- NOTE 13: The absence of the easdfnfoList attributes in an EASDF profile indicates that the EASDF can be selected for any S-NSSAI, DNN, DNAI or PSA UPF N6 IP address. +- NOTE 14: This attribute may be used by the requester NF or SCP e.g. to build the authority of the Location header in 3xx response or to set the 3gpp-Sbi-apiRoot header in a response message (see clause 6.10.4 of 3GPP TS 29.500 [4]), when the NF redirects a request issued by a consumer from a different PLMN towards the discovered NF, or when the SCP has reselected the discovered NF for such a request. + +#### 6.2.6.2.4 Type: NFService + +**Table 6.2.6.2.4-1: Definition of type NFService** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------|----------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| serviceInstanceId | string | M | 1 | Unique ID of the service instance within a given NF Instance | +| serviceName | ServiceName | M | 1 | Name of the service instance (e.g. "udm-sdm") | +| versions | array(NFServiceVersion) | M | 1..N | The API versions supported by the NF Service and if available, the corresponding retirement date of the NF Service.
The different array elements shall have distinct unique values for "apiVersionInUri", and consequently, the values of "apiFullVersion" shall have a unique first digit version number. | +| scheme | UriScheme | M | 1 | URI scheme (e.g. "http", "https") | +| nfServiceStatus | NFServiceStatus | M | 1 | Status of the NF Service Instance | +| fqdn | Fqdn | O | 0..1 | FQDN of the NF Service Instance (see NOTE 1, NOTE 3, NOTE 9).
The FQDN provided as part of the NFService information has precedence over the FQDN and IP addresses provided as part of the NFProfile information (see clause 6.1.6.2.2). | +| interPlmnFqdn | Fqdn | C | 0..1 | If the requester-plmn-list query parameter is absent in the NF Discovery request, or if is present and the requester's PLMN is the same as the PLMN of the discovered NF Service, then this attribute shall be included by the NRF and it shall contain the interPlmnFqdn value registered for the NF Service during NF registration (see clause 6.1.6.2.3), if the interPlmnFqdn attribute was registered for the NF Service in the NF profile.
This attribute shall be absent if the requester-plmn in the query parameter is different from the PLMN of the discovered NF Service.
(NOTE 3, NOTE 10) | +| ipEndPoints | array(IpEndPoint) | O | 1..N | IP address(es) and port information of the Network Function (including IPv4 and/or IPv6 address) where the service is listening for incoming service requests (see NOTE 1, NOTE 5, NOTE 6, NOTE 9).
IP addresses provided in ipEndPoints have precedence over IP addresses provided as part of the NFProfile information and, when using the HTTP scheme, over FQDN provided as part of the NFProfile information (see clause 6.2.6.2.3). | +| apiPrefix | string | O | 0..1 | Optional path segment(s) used to construct the {apiRoot} variable of the different API URIs, as described in 3GPP TS 29.501 [5], clause 4.4.1 (optional deployment-specific string that starts with a "/" character) | +| callbackUriPrefixList | array(CallbackUriPrefixItem) | O | 1..N | Optional path segment(s) used to construct the prefix of the Callback URIs during the reselection of an NF service consumer, as described in 3GPP TS 29.501 [5], clause 4.4.3.
When present, this IE shall contain callback URI prefix values to be used for specific notification types. | +| defaultNotificationSubscriptions | array(DefaultNotificationSubscription) | O | 1..N | Notification endpoints for different notification types. (See also NOTE 10 in clause 6.1.6.2.2) | +| allowedPlmns | array(PlmnId) | C | 1..N | PLMNs allowed to access the service instance (NOTE 12).

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

The absence of this attribute indicates that any PLMN is allowed to access the service instance.

When included, the allowedPlmns attribute needs not include the PLMN ID(s) registered in the | + +| | | | | | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | plmnList attribute of the NF Profile, i.e. the PLMN ID(s) registered in the NF Profile shall be considered to be allowed to access the service instance. | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|--------------------|-----------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedSnpons | array(PlmnIdNid) | C | 1..N |

SNPNs allowed to access the service instance.

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

If this attribute is present in the NFService and in the NF profile, the attribute from the NFService shall prevail.

The absence of this attribute in both the NFService and in the NF profile indicates that no SNPN, other than the SNPN(s) registered in the snpnList attribute of the NF Profile (if the NF pertains to an SNPN), is allowed to access the service instance.

When included, the allowedSnpons attribute needs not include the PLMN ID/NID(s) registered in the snpnList attribute of the NF Profile (if the NF pertains to an SNPN), i.e. the SNPNs registered in the NF Profile (if any) shall be considered to be allowed to access the service instance.

| +| allowedNfTypes | array(NFType) | C | 1..N |

Type of the NFs allowed to access the service instance (NOTE 12).

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

| +| allowedNfDomains | array(string) | C | 1..N |

Pattern (regular expression according to the ECMA-262 dialect [8]) representing the NF domain names within the PLMN of the NRF allowed to access the service instance (NOTE 12).

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

The absence of this attribute indicates that any NF domain is allowed to access the service instance.

| +| allowedNssais | array(ExtSnssai) | C | 1..N |

S-NSSAI of the allowed slices to access the service instance (NOTE 12).

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

The absence of this attribute indicates that any slice is allowed to access the service instance.

| +| capacity | integer | O | 0..1 | Static capacity information within the range 0 to 65535, expressed as a weight relative to other services of the same type. (See NOTE 2) | +| load | integer | O | 0..1 | Latest known load information of the NF Service, within the range 0 to 100 in percentage. (See NOTE 4) | +| loadTimeStamp | DateTime | O | 0..1 | It indicates the point in time in which the latest load information of the NF Service Instance was sent from the NF to the NRF. | +| priority | integer | O | 0..1 | Priority (relative to other services of the same type) within the range 0 to 65535, to be used for NF Service selection; lower values indicate a higher priority. (See NOTE 2) | +| recoveryTime | DateTime | O | 0..1 | Timestamp when the NF service was (re)started | +| supportedFeatures | SupportedFeatures | O | 0..1 | Supported Features of the NF Service instance | +| nfServiceSetIdList | array(NfServiceSetId) | C | 1..N | NF Service Set ID (see clause 28.13 of | + +| | | | | | +|--|----|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | d) | | | 3GPP TS 23.003 [12])
At most one NF Service Set ID shall be indicated per
PLMN-ID or SNPN of the NF.
This information shall be present if available. | +|--|----|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|---------------------------------|-----------------------------------|---|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssais | array(ExtSnssai) | O | 1..N | S-NSSAIs of the NF Service. This may be a subset of the S-NSSAIs supported by the NF (see sNssais attribute in NFProfile).
When present, this IE represents the list of S-NSSAIs supported by the NF Service in all the PLMNs listed in the plmnList IE and all the SNPNs listed in the snpnList. | +| perPlmnSnssaiList | array(PlmnSnssai) | O | 1..N | S-NSSAIs of the NF Service per PLMN. This may be a subset of the S-NSSAIs supported per PLMN by the NF (see perPlmnSnssaiList attribute in NFProfile).

This IE may be included when the list of S-NSSAIs supported by the NF Service for each PLMN it is supporting is different. When present, this IE shall include the S-NSSAIs supported by the NF Service for each PLMN. When present, this IE shall override the sNssais IE. | +| vendorId | VendorId | O | 0..1 | Vendor ID of the NF Service instance, according to the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. | +| supportedVendorSpecificFeatures | map(array(VendorSpecificFeature)) | O | 1..N(1..M) | Map of Vendor-Specific features, where the key of the map is the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. The string used as key of the map shall contain 6 decimal digits; if the SMI code has less than 6 digits, it shall be padded with leading digits "0" to complete a 6-digit string value.
The value of each entry of the map shall be a list (array) of VendorSpecificFeature objects.
(NOTE 7) | +| oauth2Required | boolean | O | 0..1 | It indicates whether the NF Instance requires Oauth2-based authorization.
Absence of this IE means that the NF Service Producer has not provided any indication about its usage of Oauth2 for authorization.
(See NOTE 11) | +| allowedOperationsPerNfType | map(array(string)) | C | 1..N(1..M) | Map of allowed operations on resources for each type of NF; the key of the map is the NF Type, and the value is an array of scopes.

The scopes shall be any of those defined in the API that defines the current service (identified by the "serviceName" attribute).

This IE should be present, if it is present in the registered NF service instance and if the map contains a key matching the requester's NF type. When present, this IE should only contain the key-value pair of the map matching the requester's NF type.

(NOTE 8) | +| allowedOperationsPerNfInstance | map(array(string)) | C | 1..N(1..M) | Map of allowed operations on resources for a given NF Instance; the key of the map is the NF Instance Id, and the value is an array of scopes.

The scopes shall be any of those defined in the API that defines the current service (identified by the "serviceName" attribute).

This IE should be present, if it is present in the registered NF service instance and if the map contains a key matching the requester's NF instance ID. When present, this IE should only contain the key-value pair of the map matching the requester's NF Instance ID. | + +| | | | | | +|--|--|--|--|----------| +| | | | | (NOTE 8) | +|--|--|--|--|----------| + +| | | | | | +|-----------------------------------------|---------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedOperationsPerNfInstanceOverrides | boolean | O | 0..1 |

This IE, when present and set to true, indicates that the scopes defined in attribute "allowedOperationsPerNfInstance" for a given NF Instance ID take precedence over the scopes defined in attribute "allowedOperationsPerNfType" for the corresponding NF type of the NF Instance associated to such NF Instance ID.

If the IE is not present, or set to false (default), it indicates that the allowed scopes are any of the scopes present either in "allowedOperationsPerNfType" or in "allowedOperationsPerNfInstance".

| +| allowedScopesRuleSet | map(RuleSet) | O | 1..N |

Map of rules specifying scopes allowed or denied for NF-Consumers. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.

This IE may be present when the NF-Consumer supports Allowed-ruleset feature as specified in clause 6.2.9.

When present, the IE should only contain the highest priority RuleSet matching the requester's NF Instance ID, nfType, PLMN-ID, SNPn-ID, NfDomain and S-NSSAI if any (see Annex C).

If the requesting entity included "complete-profile" query parameter in the request message, and the NRF authorized such a request (see clause 5.3.2.2.2), the complete IE shall be present in the discovery response.

| +| selectionConditions | SelectionConditions | O | 0..1 |

This IE is only applicable if the NFServiceStatus is set to "CANARY_RELEASE".

If present, it includes the conditions under which an NF Service Instance with an NFServiceStatus value set to "CANARY_RELEASE" shall be selected by an NF Service Consumer (e.g. if the UE belongs to a range of SUPIs)

| + +NOTE 1: The NF Service Consumer shall construct the API URLs of the service using: +- For intra-PLMN signalling: If TLS is used, the FQDN present in the NF Service Profile, if any; otherwise, the FQDN present in the NF Profile. If TLS is not used, the FQDN should be used if the NF Service Consumer uses Indirect Communication via an SCP; the FQDN or the IP address in the ipEndPoints attribute may be used if the NF Service Consumer uses Direct Communication. +- For inter-PLMN signalling: the FQDN present in the NF Service Profile, if any; otherwise, the FQDN present in the NF Profile (see NOTE 3). + +NOTE 2: The capacity and priority parameters, if present, are used for service selection and load balancing. The priority and capacity attributes shall be used for NF selection in the same way that priority and weight are used for server selection as defined in IETF RFC 2782 [23]. + +NOTE 3: If the requester-plmn in the query parameter is different from the PLMN of the discovered NF Service, then the fqdn attribute value, if included shall contain the interPlmnFqdn value registered by the NF Service during NF registration (see clause 6.1.6.2.3). The requester-plmn is different from the PLMN of the discovered NF Service if it belongs to none of the PLMN ID(s) configured for the PLMN of the NRF. + +NOTE 4: The usage of the load parameter by the NF service consumer is implementation specific, e.g. be used for NF service selection and load balancing, together with other parameters. + +NOTE 5: If the NF Service Consumer, based on the FQDN and IP address related attributes of the NFProfile and NFService, determines that it needs to use an FQDN to establish the HTTP connection with the NF Service Producer, it shall use such FQDN for DNS query and, in absence of any port information in the ipEndPoints attribute of the NF Service, it shall use the default HTTP port number, i.e. TCP port 80 for "http" URIs or TCP port 443 for "https" URIs as specified in IETF RFC 9113 [9] when invoking the service. + +NOTE 6: If multiple ipv4 addresses and/or ipv6 addresses are included in the NF Service, the NF Service Consumer shall select one of these addresses randomly, unless operator defined local policy of IP address selection, in order to avoid overload for a specific ipv4 address and/or ipv6 address. + +NOTE 7: When present, this attribute allows the NF requesting NF discovery (e.g. an NF Service Consumer) to determine which vendor-specific extensions are supported in a given NF (e.g. an Service Producer) in order to select an appropriate NF, or to include or not include the vendor-specific attributes (see + +3GPP TS 29.500 [4] clause 6.6.3) required for a given feature in subsequent service requests towards a certain service instance of the NF Service Producer. One given vendor-specific feature shall not appear in both NF Profile and NF Service Profile. If one vendor-specific feature is service related, it shall only be included in the NF Service Profile. + +- NOTE 8: These attributes are used by the NF Service Consumer in order to discover the additional scopes (resource/operation-level scopes) that might be required to invoke a certain service operation, based on the authorization information registered in NRF by the NF Service Producer in its NF profile. See also NOTE 11 of Table 6.1.6.2.3-1. +- NOTE 9: For API URIs constructed with an FQDN, the NF Service Consumer may use the FQDN in the target URI to do a DNS query and obtain the IP address(es) to setup the TCP connection, and ignore the IP addresses that may be present in the ipEndPoints attribute; alternatively, the NF Service Consumer may use those IP addresses to setup the TCP connection, if the NF Service Consumer supports to indicate specific IP address(es) to establish an HTTP/2 connection with an FQDN in the target URI. +- NOTE 10: This attribute may be used by the requester NF or SCP e.g. to build the authority of the Location header in 3xx response or to set the 3gpp-Sbi-apiRoot header in a response message (see clause 6.10.4 of 3GPP TS 29.500 [4]), when the NF redirects a request issued by a consumer from a different PLMN towards the discovered NF service, or when the SCP has reselected the discovered NF service for such a request. +- NOTE 11: If PLMN specific value is registered for the PLMN ID of the requester NF, the NRF shall set the oauth2Required attribute with the PLMN specific values (see description of perPlmnOauth2ReqList in clause 6.1.6.2.3). +- NOTE 12: If this attribute is present in the NFService and in the NF profile, the attribute from the NFService shall prevail. The absence of this attribute in the NFService and in the NFProfile indicates that there is no corresponding restriction to access the service instance. If this attribute is absent in the NF Service, but it is present in the NF Profile, the attribute from the NF Profile shall be applied. + +#### 6.2.6.2.5 Type: StoredSearchResult + +**Table 6.2.6.2.5-1: Definition of type StoredSearchResult** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nflInstances | array(NFProfile) | M | 0..N | An array of NF Instances corresponding to a given stored search result.
NF instance profiles included in this IE shall not contain authorization attributes (such as the "allowedXXX" attributes of the NFProfile or NFService data types). | +| completeNflInstances | array(NFProfile) | C | 1..N | When present, it shall contain an array of complete NF Instance profiles (including authorization attributes such as the "allowedXXX" attributes of the NFProfile or NFService data types), matching the search criteria indicated by the query parameters of the discovery request.
.
This IE shall only be present if the NRF supports the "Complete-Profile-Discovery" feature, the "complete-profile" query parameter is present and set to true in the request (see clause 6.2.3.2.3.1), and if the requesting entity is authorized to discover the complete profile of NF instances. | + +6.2.6.2.6 Type: PreferredSearch + +**Table 6.2.6.2.6-1: Definition of type PreferredSearch** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| preferredTaiMatchInd | boolean | C | 0..1 | Indicates whether all the returned NFProfiles match or do not match the query parameter preferred-tai.
true: Match
false (default): Not Match | +| preferredFullPlmnMatchInd | boolean | O | 0..1 | Indicates whether all the returned NFProfiles match or do not match the query parameter preferred-full-plmn.
true: Match
false (default): Not Match | +| preferredApiVersionsMatchInd | boolean | O | 0..1 | Indicates whether the search result includes at least one NF Profile that matches all the preferred API versions indicated in the query parameter preferred-api-versions.

true: Match
false: Not Match | +| otherApiVersionsInd | boolean | O | 0..1 | This IE may be present if the preferred-api-versions query parameter is provided in the discovery request.

When present, this IE indicates whether there is at least one NF Profile with other API versions, i.e. that does not match all the preferred API versions indicated in the preferred-api-versions, returned in the response or not.

true: Returned
false: Not returned | +| preferredLocalityMatchInd | boolean | O | 0..1 | Indicates whether the search result includes at least one NFProfile that match the query parameter preferred-locality or ext-preferred-locality.

true: Match
false (default): Not Match | +| otherLocalityInd | boolean | O | 0..1 | This IE may be present if the preferred-locality or ext-preferred-locality query parameter is provided in the discovery request.

When present, this IE indicates whether there is at least one NFProfile with another locality, i.e. not matching the preferred-locality or ext-preferred-locality, returned in the response or not.

true: Returned
false (default): Not returned | +| preferredVendorSpecificFeaturesInd | boolean | O | 0..1 | Indicates whether all the returned NFProfiles match (or do not match) the query parameter preferred-vendor-specific-features (i.e. whether they support all the preferred vendor-specific-features).
true: Match
false (default): Not Match | +| preferredCollocatedNfTypeInd | boolean | O | 0..1 | Indicates whether all the returned NFProfiles match (or do not match) the query parameter preferred-collocated-nf-types.
true: Match
false (default): Not Match | +| preferredPgwMatchInd | boolean | O | 0..1 | This IE may be present if preferred-pgw-ind query parameter is provided in the discovery request.

When present, this IE shall indicate whether all the returned NFProfiles match or do not match the query parameter preferred-pgw-ind.
true: Match
false: Not Match | +| preferredAnalyticsDelaysInd | boolean | C | 0..1 | This IE shall be present if preferred-analytics-delays query parameter is provided in the discovery request. | + +| | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | When present, this IE shall indicate whether all the returned NFProfiles match or do not match the query parameter preferred-analytics-delays.
true: Match
false: Not Match | +| preferredFeaturesMatchInd | boolean | O | 0..1 | Indicates whether the search result includes at least one NFProfile that supports all the preferred feature(s) indicated by the query parameter preferred-features.

true: Supported
false: Not supported | +| noPreferredFeaturesInd | boolean | O | 0..1 | Indicates whether the search result includes at least one NFProfile not supporting all the preferred feature(s) indicated by the query parameter preferred-features.

true: Returned
false: Not returned | +| NOTE: The PreferredSearch data type is used to encode the preferredSearch IE in SearchResult (see clause 6.2.6.2.2) and the preferredSearch IE in the NfInstanceInfo data type (see clause 6.2.6.2.7). The description of the IEs in the PreferredSearch data type is provided for the first case. For the latter case, these IEs shall be interpreted as indicating whether the NF profile of the NF instance ID returned in the nfInstanceList IE of SearchResult matches the preference parameters, and the otherApiVersionsInd IE and the otherLocalityInd IE shall be absent. | | | | | + +#### 6.2.6.2.7 Type: NfInstanceInfo + +**Table 6.2.6.2.7-1: Definition of type NfInstanceInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nrfDiscApiUri | Uri | C | 0..1 | This IE shall be present if the NRF holding the NF profile is not the NRF that received the NFDiscover request. It may be present otherwise.
When present, this IE shall contain the API URI of the Nnrf_NFDiscovery service of the NRF holding the NF profile. The API URI shall be formatted as specified in clause 6.2.1 | +| preferredSearch | PreferredSearch | O | 0..1 | This IE may be present to indicate whether the NF Profile matches the preferred query parameters, if the discovery request contains any of the query parameter defined in the PreferredSearch data type. This IE shall take precedence over the preferredSearch IE in the SearchResult, if any. | +| nrfAlteredPriorities | map(integer) | O | 1..N | This IE may be present if the NRF wishes to signal modified priorities for the NF instance.
The key of the map shall be the JSON Pointer (as specified in IETF RFC 6901 [14]) of the corresponding priority IE in the NFProfile data type defined in clause 6.2.6.2.3.
(NOTE) | +| nrfSupportedFeatures | SupportedFeatures | C | 0..1 | Features supported by the NRF for the NFDiscovery service (see clause 6.2.9).
This IE should be present if the nrfDiscApiUri IE is present and if the NRF holding the NF profile supports at least one feature.
When present, this IE shall indicate the features supported by the NRF holding the NF profile. | +| NOTE: If this IE is present, the requester NF should apply the NRF altered priorities when selecting a NF service producer for the corresponding NF Discovery request, instead of the priorities retrieved in the corresponding NF profile. | | | | | + +EXAMPLE: The following JSON object would represent an NfInstanceInfo where the NRF signals modified priorities for the NF instance, two NF service instances and two smfInfo instances. + +``` +{ + "nrfAlteredPriorities": { + "/priority": 1000, + "/nfServiceList/serviceinstance1/priority": 3000, + "/nfServiceList/serviceinstance2/priority": 5000, + "/smfInfo/priority": 20000, + "/smfInfoList/abcd/priority": 15000 + } +} +``` + +#### 6.2.6.2.8 Type: ScpDomainRoutingInformation + +**Table 6.1.6.2.8-1: Definition of type ScpDomainRoutingInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| scpDomainList | map(ScpDomainConnectivity) | M | 0..N | This IE shall contain map of SCP domain interconnection information, where the key of the map is a SCP domain. The value of each entry shall be the interconnectivity information of the SCP domain indicated by the key.

An empty map indicates that there is no SCP domain currently registered in the NRF. | + +EXAMPLE: The SCP Domain Routing Information is derived from the SCP domains registered by SCPs, e.g. if SCP x, SCP y and SCP z have registered in NRF with following SCP domains: + +SCP x Profile includes: { "scpDomains": [ "SCP\_Domain\_1", "SCP\_Domain\_2" ] } + +SCP y Profile includes: { "scpDomains": [ "SCP\_Domain\_2", "SCP\_Domain\_3" ] } + +SCP z Profile includes: { "scpDomains": [ "SCP\_Domain\_4" ] } + +then the SCP Domain Routing Information should be as following: + +``` +{ + "scpDomainList": { + "SCP_Domain_1": { "connectedScpDomainList": [ "SCP_Domain_2" ] }, + "SCP_Domain_2": { "connectedScpDomainList": [ "SCP_Domain_1", "SCP_Domain_3" ] }, + "SCP_Domain_3": { "connectedScpDomainList": [ "SCP_Domain_2" ] }, + "SCP_Domain_4": { "connectedScpDomainList": [ ] } + } +} +``` + +#### 6.2.6.2.9 Type: ScpDomainConnectivity + +**Table 6.2.6.2.9-1: Definition of type ScpDomainConnectivity** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| connectedScpDomainList | array(string) | M | 0..N | This IE shall contain the list of interconnected SCP domains.

An empty array indicates there is no SCP Domain currently interconnected. | + +## 6.2.6.2.10 Type: ScpDomainRoutingInfoSubscription + +Table 6.2.6.2.10-1: Definition of type ScpDomainRoutingInfoSubscription + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| callbackUri | Uri | M | 1 | Callback URI where the Service Consumer will receive the notifications from NRF. | +| validityTime | DateTime | C | 0..1 | Time instant after which the subscription becomes invalid. This parameter may be sent by the client, as a hint to the server, but it shall be always sent back by the server (regardless of the presence of the attribute in the request) in the response to the subscription creation request. | +| reqInstanceId | NfInstanceId | O | 0..1 | If present, this IE shall contain the NF instance id of the Service consumer. | +| localInd | boolean | O | 0..1 | When present, this IE shall indicate whether changes of local SCP Domain Routing Information to be notified:
- true: changes of local SCP Domain Routing Information to be notified.
- false (default): changes of SCP Domain Routing Information to be notified | + +## 6.2.6.2.11 Type: ScpDomainRoutingInfoNotification + +Table 6.2.6.2.11-1: Definition of type ScpDomainRoutingInfoNotification + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| routingInfo | ScpDomainRoutingInformation | M | 1 | This IE shall contain the SCP Domain Routing Information after the change. | +| localInd | boolean | O | 0..1 | When present, this IE shall indicate whether changes of local SCP Domain Routing Information is carried in the notification:
- true: changes of local SCP Domain Routing Information in the notification.
- false (default): changes of SCP Domain Routing Information in the notification. | + +## 6.2.6.2.12 Type: NfServiceInstance + +Table 6.2.6.2.12-1: Definition of type NfServiceInstance + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------|----------------|---|-------------|--------------------------------------------------------------| +| serviceInstanceId | string | M | 1 | Unique ID of the service instance within a given NF Instance | +| nflInstanceId | NfInstanceId | C | 0..1 | NF Instance ID of the NF service instance (NOTE) | +| nfServiceSetId | NfServiceSetId | C | 0..1 | NF Service Set ID of the NF Service instance (NOTE) | +| NOTE: Either the nflInstanceId IE or the nfServiceSetId IE shall be present. | | | | | + +## 6.2.6.2.13 Type: NoProfileMatchInfo + +**Table 6.2.6.2.13-1: Definition of type NoProfileMatchInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reason | NoProfileMatchReason | M | 1 | This IE shall indicate the specific reason for not finding any NF instance that can match the search criteria. | +| queryParamCombinationList | array(QueryParamCombination) | O | 1..N | This IE may be present if the reason IE is set to "QUERY_PARAMS_COMBINATION_NO_MATCH". If present each QueryParamCombination indicates that no NF Instance matching the QueryParamCombination has registered. | + +## 6.2.6.2.14 Type: QueryParamCombination + +**Table 6.2.6.2.14-1: Definition of type QueryParamCombination** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------|---|-------------|---------------------------------------------------| +| queryParams | array(QueryParameter) | M | 1..N | This IE shall contain a list of query parameters. | + +## 6.2.6.2.15 Type: QueryParameter + +**Table 6.2.6.2.15-1: Definition of type QueryParameter** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------| +| name | string | M | 1 | name of the query parameter | +| value | string | M | 1 | value of the query parameter | + +## 6.2.6.2.16 Type: AfData + +**Table 6.2.6.2.16-1: Definition of type AfData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| afEvents | array(AfEvent) | M | 1..N | AF Event(s) supported by the trusted AF. | +| tailList | array(Tai) | O | 1..N | This IE may be present if the AfEvent is set to "GNSS_ASSISTANCE_DATA". When present, this IE shall contain the list of TAIs the trusted AF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the trusted AF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | This IE may be present if the AfEvent is set to "GNSS_ASSISTANCE_DATA". When present, this IE shall contain the range of TAIs the trusted AF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the tailList attribute indicate that the trusted AF can be selected for any TAI in the serving network. | + +### 6.2.6.2.17 Type: SearchResultInfo + +**Table 6.2.6.2.17-1: Definition of type SearchResultInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| unsatisfiedTailList | array(Tai) | C | 1..N | This IE should be present if the NF Discovery Request includes a tai-list query parameter and the "nf-ta-list-ind" query parameter set to true, when the NFs included in the nfInstances or nfInstanceList altogether support only a subset of TAs included in the tai-list. When present, this IE shall include a list of TAs which are unsatisfied, i.e. the NFs included in the nfInstances or nfInstanceList do not support these TAs. | + +## 6.2.6.3 Simple data types and enumerations + +### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +**Table 6.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +### 6.2.6.3.3 Enumeration: NoProfileMatchReason + +The enumeration NoProfileMatchReason indicates the specific reason for not finding any NF instance that can match the search criteria. + +**Table 6.2.6.3.3-1: Enumeration NoProfileMatchReason** + +| Enumeration value | Description | +|-------------------------------------|------------------------------------------------------------------------| +| "REQUESTER_PLMN_NOT_ALLOWED" | NF profiles are not allowed to be discovered by the requester's PLMN | +| "TARGET_NF_SUSPENDED" | Target NF exists with NFStatus or NFServiceStatus "SUSPENDED" | +| "TARGET_NF_UNDISCOVERABLE" | Target NF exists with NFStatus or NFServiceStatus "UNDISCOVERABLE" | +| "QUERY_PARAMS_COMBINATION_NO_MATCH" | No NF instance matching the Query Parameter Combination has registered | +| "UNSPECIFIED" | Other reasons | + +## 6.2.7 Error Handling + +### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.2.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.2.7.3 Application Errors + +The application errors defined for the Nnrf\_NFDiscovery service are listed in Table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 6.2.8 Security + +As indicated in clause 13.3 of 3GPP TS 33.501 [15], when static authorization is not used, the access to the Nnrf\_NFDiscovery API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [16]), using the "Client Credentials" authorization grant, where the NRF plays the role of the authorization server. + +If OAuth2 authorization is used on the Nnrf\_NFDiscovery API, an NF Service Consumer, prior to consuming services offered by the Nnrf\_NFDiscovery API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF where the Nnrf\_NFDiscovery service is invoked by the NF Service Consumer. + +The Nnrf\_NFDiscovery API defines the following scopes for OAuth2 authorization: + +**Table 6.2.8-1: OAuth2 scopes defined in Nnrf\_NFDiscovery API** + +| Scope | Description | +|------------------------------------------------|---------------------------------------------------------------------------------------------------| +| "nnrf-disc" | Access to the Nnrf_NFDiscovery API | +| "nnrf-disc:scp-domain:read" | Access to read the scp-domain-routing-info resource | +| "nnrf-disc:scp-domain-subs:write" | Access to create/delete a scp-domain subscription resource | +| "nnrf-disc:nf-instances:read-complete-profile" | Access to the Nnrf_NFDiscovery API enabling the discovery of the complete profile of NF instances | + +## 6.2.9 Features supported by the NFDiscovery service + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [7]. + +The following features are defined for the Nnrf\_NFDiscovery service. + +**Table 6.2.9-1: Features of supportedFeatures attribute used by Nnrf\_NFDiscovery service** + +| Feature Number | Feature | M/O | Description | +|----------------|-----------------------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Complex-Query | O | Support of Complex Query expression (see clause 6.2.3.2.3.1) | +| 2 | Query-Params-Ext1 | O | Support of the following query parameters:
- limit
- max-payload-size
- required-features
- pdu-session-types | +| 3 | Query-Param-Analytics | O | Support of the query parameters for Analytics identifier:
- event-id-list
- nwdaf-event-list | +| 4 | MAPDU | O | This feature indicates whether the NRF supports selection of UPF with ATSSS capability. | +| 5 | Query-Params-Ext2 | O | Support of the following query parameters:
- requester-nf-instance-id
- upf-ue-ip-addr-ind
- pfd-data
- target-snpn
- af-ee-data
- w-agf-info
- tngf-info
- twif-info
- target-nf-set-id
- target-nf-service-set-id
- preferred-tai
- nef-id
- preferred-nf-instances
- notification-type
- serving-scope
- internal-group-identity
- preferred-api-versions
- v2x-support-ind
- redundant-gtpu
- redundant-transport
- lmf-id
- an-node-type
- rat-type
- ipups
- scp-domain-list
- address-domain
- ipv4-addr
- ipv6-prefix
- served-nf-set-id
- remote-plmn-id
- data-forwarding
- preferred-full-plmn
- requester-snpn-list
- max-payload-size-ext
- client-type | +| 6 | Service-Map | M | This feature indicates whether it is supported to identify the list of NF Service Instances as a map (i.e. the "nfServiceList" attribute of NFProfile is supported). | +| 7 | Query-Params-Ext3 | O | Support of the following query parameters:
- ims-private-identity
- ims-public-identity
- msisdn
- requester-plmn-specific-snssai-list
- n1-msg-class
- n2-info-class | +| 8 | Query-Params-Ext4 | O | Support of the following query parameters:
- realm-id
- storage-id | +| 9 | Query-Param-vSmf-Capability | O | Support of the query parameters for V-SMF Capability:
- vsmf-support-ind | +| 10 | Enh-NF-Discovery | O | Enhanced NF Discovery
This feature indicates whether it is supported to return the nfInstanceList IE in the NF Discovery response. | + +| | | | | +|----|-------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 11 | Query-SBIProtoc17 | O | Support of the following query parameters, for Service Based Interface Protocol Improvements defined in 3GPP Rel-17:
- preferred-vendor-specific-features
- preferred-vendor-specific-nf-features
- home-pub-key-id
- pgw-ip
- preferences-precedence
- preferred-pgw-ind
- v2x-capability
- shared-data-id | +| 12 | SCPDR | O | SCP Domain Routing Information

An NRF supporting this feature shall allow a service consumer (i.e. a SCP) to get the SCP Domain Routing Information and subscribe/unsubscribe to the change of SCP Domain Routing Information with following service operations:
- SCPDomainRoutingInfoGet (see clause 5.3.2.3)
- SCPDomainRoutingInfoSubscribe (see clause 5.3.2.4)
- SCPDomainRoutingInfoUnsubscribe (see clause 5.3.2.6)

A service consumer (i.e. a SCP) supporting this feature shall be able to handle SCPDomainRoutingInfoNotify as specified in clause 5.3.2.5, if subscribed to the change of SCP Domain Routing Information in the NRF. | +| 13 | Query-Upf-Pfcp | O | This feature indicates whether the NRF supports selection of UPF with required UP function features as defined in 3GPP TS 29.244 [21]. | +| 14 | Query-5G-ProSe | O | Support of the following query parameters, for Proximity based Services in 5GS defined in 3GPP Rel-17:
- prose-support-ind
- prose-capability | +| 15 | NSAC | O | This feature indicates the NSACF service capability.
Support of the following query parameters:
- nsacf-capability | +| 16 | Query-MBS | O | Support of the following query parameters, for Multicast and Broadcast Services defined in 3GPP Rel-17:
- mbs-session-id-list
- mbsmf-serving-area
- area-session-id | +| 17 | Query-eNA-PH2 | O | Support of the following query parameters, for Enhanced Network Automation Phase 2 defined in 3GPP Rel-17:
- analytics-aggregation-ind
- serving-nf-set-id
- serving-nf-type
- ml-analytics-info-list
- analytics-metadata-prov-ind | +| 18 | Query-eLCS | O | Support of the following query parameters, for 5G LCS service:
- gmlc-number | +| 19 | Query-eEDGE-5GC | O | Support of the following query parameters, for enhancement of support for Edge Computing in 5GC defined in 3GPP Rel-17:
- upf-n6-ip
- tai-list | +| 20 | Collocated-NF-Selection | O | Support of selecting a collocated NF supporting multiple NF types. | +| 21 | Query-ENPN | O | Support of the following query parameter for the enhanced support of Non-Public Networks defined in 3GPP Rel-17:
- support-onboarding-capability
- target-hni
- remote-snnpn-id | +| 22 | Query-ID_UAS | O | Support of the following query parameters, for remote Identification of Unmanned Aerial Systems defined in 3GPP Rel-17:
- uas-nf-functionality-ind | + +| | | | | +|----|-----------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 23 | NRFSET | O | NRF Set feature

An NRF supporting this feature shall allow a NF Service Consumer to get the NRF Set Information and subscribe/unsubscribe to the change of NRF Set Information:

A NF Service Consumer supporting this feature shall be able to handle Notify of the NRF status change, if subscribed to the change of NRF set information. | +| 24 | Query-Nw-Resolution | O | Support for the following query parameters:
- target-nw-resolution | +| 25 | Query-Param-iSmf-Capability | O | Support of the query parameters for I-SMF Capability:
- ismf-support-ind | +| 26 | Query-SBIProtoc17-Ext1 | O | Support of the following query parameters, for Service Based Interface Protocol Improvements defined in 3GPP Rel-17:
- exclude-nfinst-list
- exclude-nfservinst-list
- exclude-nfserviceset-list
- exclude-nfset-list | +| 27 | Query-Upf-IpIndex | O | Support of the query parameters for UPF selection with IpIndex:
- ipv4-index
- ipv6-index | +| 28 | Query-eNA-PH2-Ext1 | O | Support of the following query parameters, for extension of Enhanced Network Automation Phase 2 defined in 3GPP Rel-17:
- preferred-analytics-delays | +| 29 | Query-HLC | O | Support of the query parameters for AMF selection with High Latency Communication capability:
- high-latency-com | +| 30 | Query-SBIProtoc18 | O | Support of the following query parameters, for Service Based Interface Protocol Improvements defined in 3GPP Rel-18:
- ext-preferred-locality
- n32-purposes
- preferred-features
- sxa-ind
- remote-plmn-id-roaming
- nf-tai-list-ind
- complete-search-result
- additional-snssais | +| 31 | Complete-Profile-Discovery | O | Support discovery of complete NF profiles (including authorization attributes such as the "allowedXXX" attributes of NFProfile and NFService data types) of NF instances matching the query parameters. | +| 32 | Query-UPEAS | O | Support of the following query parameter, for UPF enhancement for Exposure and SBA defined in 3GPP Rel-18:
- upf-event-list | +| 33 | Enh-NF-Discovery-Ext1 | O | Support of the following query parameter defined in 3GPP Rel-18:
- target-nf-instance-id-list | +| 34 | Query-NG-RTC | O | Support of the following query parameters for NG_RTC defined in 3GPP Rel-18:
- ims-domain-name
- media-capability-list | +| 35 | Query-eLCS-PH3 | O | Support of the following query parameters, for 5G LCS Phase 3 service defined in 3GPP Rel-18:
- pru-tai
- af-data
- pru-support-ind
- preferred-up-positioning-ind | +| 36 | Query-eNA-PH3 | O | Support of the following query parameters, for Enhanced Network Automation Phase 3 defined in 3GPP Rel-18:
- ml-accuracy-checking-ind
- analytics-accuracy-checking-ind
- ml-model-storage-ind
- data-storage-ind
- data-subscription-relocation-support-ind
- roaming-exchange-ind | + +| | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 37 | Query-A2X | O | Support of the following query parameters, for A2X in 5GS defined in 3GPP Rel-18:
- a2x-support-ind
- a2x-capability | +| 38 | Allowed-ruleset | O | Support receiving ruleSets in NF (Service) profile | +| 39 | Query-AIMLsys | O | Support for the following query parameters, for System Support for AI/ML-based Services defined in 3GPP Rel-18:
- multi-mem-af-sess-qos-ind
- member-ue-sel-assist-ind | +| 40 | Canary-Release | O | Support of "CANARY_RELEASE" value for NFStatus and NFServiceStatus, used for canary testing.

The NRF shall not return, in the discovery response, NF Instances, or NF Service Instances, whose NFStatus or NFService status respectively is set to value "CANARY_RELEASE", unless the consumer of the discovery service has indicated support of the "Canary-Release" feature. | +| 41 | Query-UPF-Selection-N3GPP | O | Support of the following query parameters, for selection of preferred UPF for PDU sessions via non-3GPP access:
- upf-select-epdg-info

An NRF supporting this feature shall also support discovery of the preferred UPF(s) for a W-AGF/TNGF/TWIF using the following query parameters:
- w-agf-info
- tngf-info
- twif-info | +| 42 | Query-5G-RangingSIPos | O | Support of the following query parameter, for Ranging and Sidelink positioning in 5GS defined in 3GPP Rel-18:
- ranging-sl-pos-support-ind | +| 43 | Query-eNS-PH2 | O | Support of the following query parameters, for Enhanced Network Slice Phase 2 defined in 3GPP Rel-17 onwards:
- nsac-sai | +| 44 | RID-NfGroupId-Mapping | O | Support the capability of mapping between Routing Indicator and NF Group ID by the NRF.

If the consumer of the discovery service has not indicated support of the "RID-NfGroupId-Mapping" feature, the NRF shall not return in the discovery response NF instances (of UDMs and AUSFs) containing (in "UdmInfo" and "AusfInfo" respectively) an NF Group ID and no Routing Indicators to indicate that the mapping between both will be done by the NRF (see clauses 6.1.6.2.7 and 6.1.6.2.8). | +| Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1).
Feature: A short name that can be used to refer to the bit and to the feature.
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature.
NOTE 1: An NRF that advertises support of a given feature shall support all the query parameters associated with the feature. An NRF may support none or a subset of the query parameters of features that it does not advertise as supported.
NOTE 2: For a release under development, it is recommended to define new features for new query parameters by grouping them per 3GPP work item. Any definition of new query parameters in a frozen release requires a new feature definition. | | | | + +## 6.3 Nnrf\_AccessToken Service API + +### 6.3.1 General + +This API reuses the API endpoints and input / output parameters specified in IETF RFC 6749 [16] as a custom operation without resources. Hence this clause does not follow the 3GPP API specification guidelines described in 3GPP TS 29.501 [5]. + +## 6.3.2 API URI + +URIs of this API shall have the following root: + +{nrfApiRoot}/oauth2 + +where {nrfApiRoot} represents the concatenation of the "scheme" and "authority" components of the NRF, as defined in IETF RFC 3986 [17]. + +## 6.3.3 Usage of HTTP + +### 6.3.3.1 General + +HTTP/2, as defined in IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies this API shall comply with the OpenAPI [10] specification contained in Annex A. + +### 6.3.3.2 HTTP standard headers + +#### 6.3.3.2.1 General + +The HTTP headers as specified in clause 4.4 of IETF RFC 6749 [16] shall be supported, with the exception that there shall not be "Authorization" HTTP request header in the access token request. + +#### 6.3.3.2.2 Content type + +The following content types shall be supported: + +- The x-www-form-urlencoded format (see clause 17.13.4 of W3C HTML 4.01 Specification [26]). The use of the x-www-form-urlencoded format shall be signalled by the content type "application/x-www-form-urlencoded". +- The JSON format (IETF RFC 8259 [22]). The use of the JSON format shall be signalled by the content type "application/json". See also clause 5.4 of 3GPP TS 29.500 [4]. + +### 6.3.3.3 HTTP custom headers + +#### 6.3.3.3.1 General + +In this release of this specification, no custom headers specific to the OAuth2.0 Authorization Service API are defined. For 3GPP specific HTTP custom headers used across all service-based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.3.4 Custom Operations without associated resources + +### 6.3.4.1 Overview + +The /token endpoint as specified in IETF RFC 6749 [16] shall be supported. The "token endpoint" URI shall be: + +{nrfApiRoot}/oauth2/token + +where {nrfApiRoot} is defined in clause 6.3.2. + +Table 6.3.4.1-1 provides an overview of the endpoints and applicable HTTP methods. + +**Table 6.3.4.1-1: Custom operations without associated resources** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------------------|----------------------|--------------------|--------------------------------------------------------------------------------------------------------------------------| +| Get (Access Token Request) | /oauth2/token | POST | Access token request for obtaining OAuth2.0 access token. This operation maps to Nnrf_AccessToken_Get service operation. | + +### 6.3.4.2 Operation: Get (Access Token Request) + +#### 6.3.4.2.1 Description + +This custom operation represents the process for issuing the OAuth2.0 access token. + +#### 6.3.4.2.2 Operation Definition + +This operation returns an OAuth 2.0 access token based on the input parameters provided. This custom operation shall use the HTTP POST method. + +This method shall support the request data structures specified in table 6.3.4.2.2-1 and the response data structures and response codes specified in table 6.3.4.2.2-2. The data structure used for the POST request body shall be using x-www-form-urlencoded format as specified in clause 17.13.4 of W3C HTML 4.01 Specification [26]. + +**Table 6.3.4.2.2-1: Data structures supported by the POST Request Body on this endpoint** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| AccessTokenReq | M | 1 | This IE shall contain the request information for the access token request.
Content-Type: "application/x-www-form-urlencoded" | + +**Table 6.3.4.2.2-2: Data structures supported by the POST Response Body on this endpoint** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AccessTokenRsp | M | 1 | 200 OK | This IE shall contain the access token response information. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| AccessTokenErr | M | 1 | 400 Bad Request,
401 Unauthorized | See IETF RFC 6749 [16] clause 5.2.
The specific error shall be indicated in the "error" attribute of the AccessTokenErr data type, containing any of the values:
- invalid_request
- invalid_client
- invalid_grant
- unauthorized_client
- unsupported_grant_type
- invalid_scope | +| ProblemDetails | O | 0..1 | 400 Bad Request | This error shall only be returned by an SCP or SEPP for errors they originate. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This response shall be returned if the requester NF is not allowed to request token for the NF being requested, and the "cause" attribute shall be set to:
- "MISSING_PARAMETER" to indicate the missing requester's information.
The missing parameter shall be indicated in "invalidParams" attribute of ProblemDetails. | + +**Table 6.3.4.2.2-3: Headers supported by the 200 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|------------------| +| Cache-Control | string | M | 1 | Enum: "no-store" | +| Pragma | string | M | 1 | Enum: "no-cache" | + +**Table 6.3.4.2.2-4: Headers supported by the 400 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|------------------| +| Cache-Control | string | M | 1 | Enum: "no-store" | +| Pragma | string | M | 1 | Enum: "no-cache" | + +**Table 6.3.4.2.2-5: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.3.4.2.2-6: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +## 6.3.5 Data Model + +### 6.3.5.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.5.1-1 specifies the data types defined for the OAuth 2.0 Authorization Service API. The AccessTokenReq data structure shall be converted to the content type "application/x-www-form-urlencoded" when the OAuth 2.0 Access Token Request is invoked. + +**Table 6.3.5.1-1: OAuth 2.0 Authorization service specific Data Types** + +| Data type | Clause defined | Description | +|-------------------|----------------|-------------------------------------------------------------------| +| AccessTokenReq | 6.3.5.2.2 | Contains information related to the access token request. | +| AccessTokenRsp | 6.3.5.2.3 | Contains information related to the access token response. | +| AccessTokenClaims | 6.3.5.2.4 | The claims data structure for the access token. | +| AccessTokenErr | 6.3.5.2.5 | Contains error information returned in the access token response. | +| Audience | 6.3.5.4.1 | Contains the audience claim of the access token. | + +Table 6.3.5.1-2 specifies data types re-used by the OAuth 2.0 Authorization service from other specifications, including a reference to their respective specifications and when needed, a short description of their use. + +**Table 6.3.5.1-2: OAuth 2.0 Authorization service re-used Data Types** + +| Data type | Reference | Comments | +|------------------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NfInstanceId | 3GPP TS 29.571 [7] | Identifier (UUID) of the NF Instance. The hexadecimal letters of the UUID should be formatted by the sender as lower-case characters and shall be handled as case-insensitive by the receiver. | +| PlmnId | 3GPP TS 29.571 [7] | PLMN ID | +| NFType | 3GPP TS 29.510 | See clause 6.1.6.3.3 | +| Snssai | 3GPP TS 29.571 [7] | | +| NfSetId | 3GPP TS 29.571 [7] | NF Set ID (see clause 28.12 of 3GPP TS 23.003 [12]) | +| Uri | 3GPP TS 29.571 [7] | | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of the redirect response message. | +| Fqdn | 3GPP TS 29.571 [7] | Fully Qualified Domain Name | + +### 6.3.5.2 Structured data types + +#### 6.3.5.2.1 Introduction + +This clause defines the structures to be used in the APIs. + +### 6.3.5.2.2 Type: AccessTokenReq + +**Table 6.3.5.2.2-1: Definition of type AccessTokenReq** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| grant_type | string | M | 1 | This IE shall contain the grant type as "client_credentials".
Enum: "client_credentials" | +| nfInstanceId | NfInstanceId | M | 1 | This IE shall contain the NF instance id of the NF service consumer. | +| nfType | NfType | C | 0..1 | This IE shall be included when the access token request is for an NF type and not for a specific NF / NF service instance. When present, this IE shall contain the NF type of the NF service consumer. (NOTE 3) | +| targetNfType | NfType | C | 0..1 | This IE shall be included when the access token request is for an NF type and not for a specific NF / NF service instance. When present, this IE shall contain the NF type of the NF service producer. | +| scope | string | M | 1 | This IE shall contain the scopes requested by the NF service consumer.

The scopes shall consist of a list of NF service name(s) of the NF service producer(s) or resource/operation-level scopes defined by each service API, separated by whitespaces, as described in IETF RFC 6749 [16], clause 3.3.

The service name(s) included in this attribute shall be any of the services defined in the ServiceName enumerated type (see clause 6.1.6.3.11).

The resource/operation-level scopes shall be any of those defined in the "securitySchemes" clause of each service API.

pattern: '^[a-zA-Z0-9_-:]+( [a-zA-Z0-9_-:]+)*\$'

See NOTE 2. | +| targetNfInstanceId | NfInstanceId | C | 0..1 | This IE shall be included, if available and if it is an access token request for a specific NF Service Producer. When present this IE shall contain the NF Instance ID of the specific NF Service Producer for which the access token is requested. | +| requesterPlmn | PlmnId | C | 0..1 | This IE shall be included when the NF service consumer in one PLMN requests a service access authorization for an NF service producer from a different PLMN. It may be present when a service access authorization in the same PLMN need to be requested.
When present, this IE shall contain the PLMN ID of the requester NF service consumer. (NOTE 3) (NOTE 4) | +| requesterPlmnList | array(PlmnId) | C | 2..N | This IE shall be included when the NF service consumer serving a PLMN, with more than one PLMN ID, requests a service access authorization for an NF service producer from a different PLMN. It may be present when a service access authorization in the same PLMN, with more than one PLMN ID, need to be requested.
When present, this IE shall contain the PLMN IDs of the requester NF service consumer. (NOTE 4) | +| requesterSnssaiList | array(Snssai) | O | 1..N | When present, this IE shall contain the list of S-NSSAIs of the requester NF service consumer. If this IE is included in an Access Token Request sent towards a different PLMN, the requester NF shall provide S-NSSAI values of the target PLMN, that correspond to the S-NSSAI values of the requester NF.
This may be used by the NRF to validate that the requester NF service consumer is allowed to access | + +| | | | | | +|--|--|--|--|------------------------------------------| +| | | | | the target NF Service Producer. (NOTE 3) | +|--|--|--|--|------------------------------------------| + +| | | | | | +|----------------------|------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| requesterFqdn | Fqdn | O | 0..1 | When present, this IE shall contain the FQDN of the requester NF Service Consumer.
This may be used by the NRF to validate that the requester NF service consumer is allowed to access the target NF Service Producer. (NOTE 3) | +| requesterSnpnList | array(PlmnIdNid) | O | 1..N | When present, this IE shall contain the list of SNPNS the requester NF service consumer belongs to.
This may be used by the NRF to validate that the requester NF service consumer is allowed to access the target NF Service Producer. (NOTE 3) | +| targetPlmn | PlmnId | C | 0..1 | This IE shall be included when the NF service consumer in one PLMN or SNPN requests a service access authorization for an NF service producer from a different PLMN.
When present, this IE shall contain the PLMN ID of the target PLMN (i.e., PLMN ID of the NF service producer). | +| targetSnpn | PlmnIdNid | C | 0..1 | This IE shall be included when the NF service consumer in one PLMN or SNPN requests a service access authorization for an NF service producer from a different SNPN.
When present, this IE shall contain the SNPN ID of the target SNPN (i.e., SNPN ID of the NF service producer). | +| targetSnssaiList | array(SNSSAI) | O | 1..N | This IE may be included during an access token request for an NF type and not for a specific NF / NF service instance. When present, this IE shall contain the list of S-NSSAIs of the NF Service Producer. | +| targetNsiList | array(string) | O | 1..N | This IE may be included during an access token request for an NF type and not for a specific NF / NF service instance. When present, this IE shall contain the list of NSIs of the NF Service Producer. | +| targetNfSetId | NfSetId | O | 0..1 | This IE may be included during an access token request for an NF type and not for a specific NF / NF service instance. When present, this IE shall contain the NF Set ID of the NF Service Producer. | +| targetNfServiceSetId | NfServiceSetId | O | 0..1 | This IE may be included during an access token request for a specific NF / NF service instance. When present, this IE shall contain the NF Service Set ID of the NF Service Producer.
This may be used by the NRF to validate that the requester NF service consumer is allowed to access the target NF service instance. (NOTE 3) | +| hnrfAccessTokenUri | Uri | C | 0..1 | If included, this IE shall contain the API URI of the Access Token Service (see clause 6.3.2) of the NRF in home PLMN.

It shall be included during an access token request for an hSMF in the home routed roaming scenario, if it is returned from the NSSF in the home PLMN (see clause 6.1.6.2.11 of 3GPP TS 29.531 [42]). | +| sourceNfInstanceId | NfInstanceId | C | 0..1 | This IE shall be included, if available and if it is an access token request from the DCCF as NF Service Consumer request data from NF Service Producers on behalf of the source NF.
When present this IE shall contain the NF Instance ID of the source NF which intend to collect data from NF Service Producer. | + +NOTE 1: This data structure shall not be treated as a JSON object. It shall be treated as a key, value pair data structure to be encoded using x-www-form-urlencoded format as specified in clause 17.13.4 of W3C HTML 4.01 Specification [26]. + +NOTE 2: Though scope attribute is optional as per IETF RFC 6749 [16], it is mandatory for 3GPP as per 3GPP TS 33.501 [15]. + +NOTE 3: An access token request should be rejected if the requester NF is not allowed to access the target NF based on the authorization parameters in the NF profile of the target NF. The authorization parameters in NF Profile are those used by NRF to determine whether a given NF Instance / NF Service Instance can be discovered by an NF Service Consumer in order to consume its offered services (e.g. "allowedNfTypes", "allowedNfDomains", etc.). Based on operator's policies, an access token request not including the + +requester's information necessary to validate the authorization parameters in the target NF Profile may be rejected. + +NOTE 4: When the NF service consumer is serving a PLMN consisting of one PLMN ID, the attribute "requesterPlmn" shall be used; otherwise, if the NF service consumer is serving a PLMN consisting of more than one PLMN ID, the attribute "requesterPlmnList" shall be used. + +#### EXAMPLE: + +The following is an example of an Access Token Request message, with a request body encoded as x-www-form-urlencoded, with following input parameters: + +- NF Instance Id of the NF Service Consumer: 4e0b2760-0356-42c4-b739-8d6aaa491b63 +- NF Type of the NF Service Consumer: AMF +- NF Type of the NF Service Producer: UDM +- Requested scopes: "nudm-sdm", "nudm-uecm" and "nudm-ueau" +- PLMN ID of the NF Service Consumer: MCC=123, MNC=456 +- PLMN ID of the NF Service Producer: MCC=321, MNC=654 +- S-NSSAIs of the NF Service Producer: (SST=1, SD=A08923) and (SST=2) +- NSIs of the NF Service Producer: "Slice A, instance 1" and "Slice B, instance 2" + +Note that the URL-encoding of the request body requires to percent-encode the reserved characters ( [ ] { } " : , ) that appear in JSON-encoded structured input parameters (such as "requesterPlmn"), and in string input parameters (such as "scope", or "targetNsiList" array elements). Spaces are percent-encoded as '+'. + +The request body, *before URL-encoding*, and displayed in multiples lines only for illustration purposes, would be: + +``` +grant_type=client_credentials +&nfInstanceId=4e0b2760-0356-42c4-b739-8d6aaa491b63 +&nfType=AMF +&targetNfType=UDM +&scope=nudm-sdm nudm-uecm nudm-ueau +&requesterPlmn={"mcc":"123","mnc":"456"} +&targetPlmn={"mcc":"321","mnc":"654"} +&targetSnssaiList=[{"sst":1,"sd":"A08923"}, {"sst":2}] +&targetNsiList=Slice A, instance 1 +&targetNsiList=Slice B, instance 2 +``` + +The actual request message, *after URL-encoding*, and where all input parameters are contained into one single line in the request body, would be: + +``` +POST /oauth2/token +Content-Type: application/x-www-form-urlencoded +Accept: application/json + +grant_type=client_credentials&nfInstanceId=4e0b2760-0356-42c4-b739-8d6aaa491b63&nfType=AMF&targetNfType=UDM&scope=nudm-sdm+nudm-uecm+nudm-ueau&requesterPlmn=%7B%22mcc%22%3A%22123%22%2C%22mnc%22%3A%22456%22%7D&targetPlmn=%7B%22mcc%22%3A%22321%22%2C%22mnc%22%3A%22654%22%7D&targetSnssaiList=%5B%7B%22sst%22%3A%221%2C%22sd%22%3A%22A08923%22%7D%2C%7B%22sst%22%3A%222%7D%5D&targetNsiList=Slice+A%2C+instance+1&targetNsiList=Slice+B%2C+instance+2 +``` + +## 6.3.5.2.3 Type: AccessTokenRsp + +**Table 6.3.5.2.3-1: Definition of type AccessTokenRsp** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| access_token | string | M | 1 | This IE shall contain JWS Compact Serialized representation of the JWS signed JSON object containing AccessTokenClaims (see clause 6.3.5.2.4). | +| token_type | string | M | 1 | This IE shall contain the token type, set to value "Bearer".
Enum: "Bearer" | +| expires_in | integer | C | 0..1 | This IE when present shall contain the number of seconds after which the access token is considered to be expired.
As indicated in IETF RFC 6749 [16], this attribute should be included, unless the expiration time of the token is made available by other means (e.g. deployment-specific documentation). | +| scope | string | C | 0..1 | This IE when present shall contain the scopes granted to the NF service consumer.

The scopes shall consist of a list of NF service name(s) of the NF service producer(s) or resource/operation-level scopes defined by each service API, separated by whitespaces, as described in IETF RFC 6749 [16], clause 3.3.

The service name(s) included in this attribute shall be any of the services defined in the ServiceName enumerated type (see clause 6.1.6.3.11).

The resource/operation-level scopes shall be any of those defined in the "securitySchemes" clause of each service API.

As indicated in IETF RFC 6749 [16], this attribute shall be present if it is different than the scope included in the access token request; if it is the same as the requested scope, this attribute may be absent.

pattern: '^[a-zA-Z0-9_-:]+( [a-zA-Z0-9_-:]+)*\$' | + +#### 6.3.5.2.4 Type: AccessTokenClaims + +**Table 6.3.5.2.4-1: Definition of type AccessTokenClaims** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| iss | NfInstanceId | M | 1 | This IE shall contain NF instance id of the NRF. , corresponding to the standard "Issuer" claim described in IETF RFC 7519 [25], clause 4.1.1 | +| sub | NfInstanceId | M | 1 | This IE shall contain the NF instance ID of the NF service consumer, corresponding to the standard "Subject" claim described in IETF RFC 7519 [25], clause 4.1.2. | +| aud | Audience | M | 1 | This IE shall contain the NF service producer's NF instance ID(s) (if the exact NF instance(s) of the NF service producer is known) or the NF type of NF service producers for which the claim is applicable, corresponding to the standard "Audience" claim described in IETF RFC 7519 [25], clause 4.1.3. | +| scope | string | M | 1 | This IE shall contain the name of the NF services and the resource/operation-level scopes for which the access_token is authorized for use; this claim corresponds to a private claim, as described in IETF RFC 7519 [25], clause 4.3.

pattern: '^[a-zA-Z0-9_-:]+( [a-zA-Z0-9_-:]+)*\$' | +| exp | integer | M | 1 | This IE shall contain the expiration time after which the access_token is considered to be expired, corresponding to the standard "Expiration Time" claim described in IETF RFC 7519 [25], clause 4.1.4. | +| consumerPlmnId | PlmnId | C | 0..1 | This IE shall be included if the NRF supports providing PLMN ID of the NF service consumer in the access token claims, to be interpreted for subject (sub IE), as specified in clause 13.4.1.2 of 3GPP TS 33.501 [15]. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| consumerSnpnId | PlmnIdNid | C | 0..1 | This IE shall be included if the NRF supports providing SNPN ID of the NF service consumer in the access token claims, to be interpreted for subject (sub IE), as specified in clause 13.4.1.2 of 3GPP TS 33.501[15]. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| producerPlmnId | PlmnId | C | 0..1 | This IE shall be included if the access token is granted for an NF service producer belonging to an PLMN and the NRF supports providing PLMN ID of the NF service producer in the access token claims, to be interpreted for audience (aud IE), as specified in clause 13.4.1.2 of 3GPP TS 33.501 [15]. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| producerSnpnId | PlmnIdNid | C | 0..1 | This IE shall be included if the access token is granted for an NF service producer belonging to an SNPN and the NRF supports providing SNPN ID of the NF service producer in the access token claims, to be interpreted for audience (aud IE), as specified in clause 13.4.1.2 of 3GPP TS 33.501 [15]. When present, it shall contain the SNPN ID of the SNPN the target NF service producer belongs to. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| producerSnssaiList | array(SNSSAI) | O | 1..N | This IE may be included if the NRF supports providing list of S-NSSAIs of the NF service producer in the access token claims. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| producerNsiList | array(string) | O | 1..N | This IE may be included if the NRF supports | + +| | | | | | +|------------------------|----------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | providing list of NSIs of the NF service producer in the access token claims. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| producerNfSetId | NfSetId | O | 0..1 | This IE may be included if the NRF supports providing NF Set ID of the NF service producer in the access token claims and if the audience contains an NF type. When present, it shall indicate the NF Set ID of the NF service producer instances for which the claim is applicable. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| producerNfServiceSetId | NfServiceSetId | O | 0..1 | This IE may be included during an access token request for a specific NF / NF service instance, if the targetNfServiceSetId IE is present in the Access Token Request. When present, this IE shall contain the NF Service Set ID of the NF Service Producer for which the access token is applicable. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| sourceNfInstanceId | NfInstanceId | C | 0..1 | This IE shall be included if the NRF supports providing NF Instance ID of the source NF in the access token claims (if it is an access token request from the DCCF as NF Service Consumer request data from NF Service Producers on behalf of the source NF), to be interpreted for subject (sub IE), as specified in Annex X of 3GPP TS 33.501 [15]. | + +### 6.3.5.2.5 Type: AccessTokenErr + +**Table 6.3.5.2.5-1: Definition of type AccessTokenErr** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| error | string | M | 1 | This IE shall contain the error described in IETF RFC 6749 [16], clause 5.2.
Enum:
"invalid_request"
"invalid_client"
"invalid_grant"
"unauthorized_client"
"unsupported_grant_type"
"invalid_scope" | +| error_description | string | O | 0..1 | When present, this IE shall contain the human-readable additional information to indicate the error that occurred, as described in IETF RFC 6749 [16], clause 5.2. | +| error_uri | string | O | 0..1 | When present, this IE shall contain the URI identifying a human-readable additional information about the error, as described in IETF RFC 6749 [16], clause 5.2. | + +### 6.3.5.3 Simple data types and enumerations + +#### 6.3.5.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 6.3.5.3.2 Simple data types + +There are no specific simple data types defined in this version of this API. For the re-used data types from other specifications see clause 6.3.5.1 + +### 6.3.5.3.3 Void + +### 6.3.5.4 Data types describing alternative data types or combinations of data types + +#### 6.3.5.4.1 Type: Audience + +**Table 6.3.5.4.1-1: Definition of type Audience as a list of "non-exclusive alternatives"** + +| Data type | Cardinality | Description | Applicability | +|---------------------|-------------|--------------------------|---------------| +| NFType | 1 | NF type | | +| array(NfInstanceId) | 1..N | Array of NF Instance Ids | | + +## 6.3.6 Error Handling + +### 6.3.6.1 General + +HTTP error handling shall be supported as specified in IETF RFC 6749 [16] for errors returned by NRF as Oauth 2.0 authorization server, and also as specified in clause 5.2.7.4 of 3GPP TS 29.500 [4] for errors returned by SCP or SEPP. + +### 6.3.6.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.3.6.3 Application Errors + +The application errors defined for the Nnrf\_AccessToken service are listed in Table 6.3.6.3-1 and correspond to the values of the "error" attribute (see clause 6.3.5.2.5). + +**Table 6.3.6.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|------------------------|--------------------------------------|------------------------| +| invalid_request | 400 Bad Request | See IETF RFC 6749 [16] | +| invalid_client | 400 Bad Request,
401 Unauthorized | See IETF RFC 6749 [16] | +| invalid_grant | 400 Bad Request | See IETF RFC 6749 [16] | +| unauthorized_client | 400 Bad Request | See IETF RFC 6749 [16] | +| unsupported_grant_type | 400 Bad Request | See IETF RFC 6749 [16] | +| invalid_scope | 400 Bad Request | See IETF RFC 6749 [16] | + +## 6.4 Nnrf\_Bootstrapping Service API + +### 6.4.1 API URI + +URIs of this API shall have the following root: + +{nrfApiRoot} + +where {nrfApiRoot} represents the concatenation of the "scheme" and "authority" components of the NRF, as defined in IETF RFC 3986 [17]. + +## 6.4.2 Usage of HTTP + +### 6.4.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies this API shall comply with the OpenAPI [10] specification contained in Annex A. + +### 6.4.2.2 HTTP standard headers + +#### 6.4.2.2.1 General + +The mandatory standard HTTP headers as specified in clause 5.2.2.2 of 3GPP TS 29.500 [4] shall be supported. + +#### 6.4.2.2.2 Content type + +The following content types shall be supported: + +- The JSON format (IETF RFC 8259 [22]). The use of the JSON format shall be signalled by the content type "application/json". See also clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [11]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". +- The 3GPP hypermedia format as defined in 3GPP TS 29.501 [5]. The use of the 3GPP hypermedia format in a HTTP response body shall be signalled by the content type "application/3gppHal+json". + +#### 6.4.2.2.3 Cache-Control + +A "Cache-Control" header should be included in HTTP responses, as described in IETF RFC 9111 [20], clause 5.2. It shall contain a "max-age" value, indicating the amount of time in seconds after which the received response is considered stale. + +#### 6.4.2.2.4 ETag + +An "ETag" (entity-tag) header should be included in HTTP responses, as described in IETF RFC 9110 [40], clause 8.8.3. It shall contain a server-generated strong validator, that allows further matching of this value (included in subsequent client requests) with a given resource representation stored in the server or in a cache. + +#### 6.4.2.2.5 If-None-Match + +An NF Service Consumer should issue conditional GET requests towards the Nnrf\_Bootstrapping service, by including an If-None-Match header in HTTP requests, as described in IETF RFC 9110 [40], clause 13.1.2, containing one or several entity tags received in previous responses for the same resource. + +### 6.4.2.3 HTTP custom headers + +#### 6.4.2.3.1 General + +In this release of this specification, no custom headers specific to the Nnrf\_Bootstrapping Service API are defined. For 3GPP specific HTTP custom headers used across all service-based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.4.3 Resources + +### 6.4.3.1 Overview + +The structure of the Resource URIs of the Nnrf\_Bootstrapping service is shown in figure 6.4.3.1-1. + +![Diagram showing the resource URI structure for the Nnrf_Bootstrapping API. It consists of a root node '{nrfApiRoot}' connected to a child node '/bootstrapping'.](5a0427b4033881484e387d85b8d8fa77_img.jpg) + +``` + +graph TD + nrfApiRoot["{nrfApiRoot}"] --- bootstrapping["/bootstrapping"] + +``` + +Diagram showing the resource URI structure for the Nnrf\_Bootstrapping API. It consists of a root node '{nrfApiRoot}' connected to a child node '/bootstrapping'. + +**Figure 6.4.3.1-1: Resource URI structure of the Nnrf\_Bootstrapping API** + +Table 6.4.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.4.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------|----------------------------|---------------------------------|---------------------------------------------------------------------------| +| Bootstrapping (Document) | {nrfApiRoot}/bootstrapping | GET | Retrieve a collection of links pointing to other services exposed by NRF. | + +## 6.4.3.2 Resource: Bootstrapping (Document) + +### 6.4.3.2.1 Description + +This resource represents a collection of links pointing to other services exposed by NRF. + +This resource is modelled as the Document resource archetype (see clause C.3 of 3GPP TS 29.501 [5]). + +### 6.4.3.2.2 Resource Definition + +Resource URI: **{nrfApiRoot}/bootstrapping** + +This resource shall support the resource URI variables defined in table 6.4.3.2.2-1. + +**Table 6.4.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------| +| nrfApiRoot | See clause 6.4.1 | + +### 6.4.3.2.3 Resource Standard Methods + +#### 6.4.3.2.3.1 GET + +This method retrieves a list of links pointing to other services exposed by NRF. This method shall support the URI query parameters specified in table 6.4.3.2.3.1-1. + +**Table 6.4.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | n/a | | | | + +This method shall support the request data structures specified in table 6.4.3.2.3.1-2 and the response data structures and response codes specified in table 6.4.3.2.3.1-3. + +**Table 6.4.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.4.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BootstrappingInfo | M | 1 | 200 OK | The response body contains a "_links" object containing the URI of each service exposed by the NRF. The response may also contain the status of the NRF and the features supported by each NRF service. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). | | | | | + +## 6.4.4 Custom Operations without associated resources + +There are no custom operations defined without any associated resources for the Nnrf\_Bootstrapping service in this release of the specification. + +## 6.4.5 Notifications + +There are no notifications defined for the Nnrf\_Bootstrapping service in this release of the specification. + +## 6.4.6 Data Model + +### 6.4.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.4.6.1-1 specifies the data types defined for the Nnrf\_Bootstrapping service-based interface protocol. + +**Table 6.4.6.1-1: Nnrf\_Bootstrapping specific Data Types** + +| Data type | Clause defined | Description | +|-------------------|----------------|--------------------------------------------------------------------| +| BootstrappingInfo | 6.4.6.2.2 | Information returned by NRF in the bootstrapping response message. | +| Status | 6.4.6.3.2 | Overall status of the NRF. | + +Table 6.4.6.1-2 specifies data types re-used by the Nnrf\_Bootstrapping 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 Nnrf service-based interface. + +**Table 6.4.6.1-2: Nnrf\_Bootstrapping re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LinksValueSchema | 3GPP TS 29.571 [7] | 3GPP Hypermedia link | +| NfInstanceId | 3GPP TS 29.571 [7] | Identifier (UUID) of the NF Instance. The hexadecimal letters of the UUID should be formatted by the sender as lower-case characters and shall be handled as case-insensitive by the receiver. | +| ProblemDetails | 3GPP TS 29.571 [7] | | +| SupportedFeatures | 3GPP TS 29.571 [7] | | + +## 6.4.6.2 Structured data types + +### 6.4.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 6.4.6.2.2 Type: BootstrappingInfo + +**Table 6.4.6.2.2-1: Definition of type BootstrappingInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| status | Status | O | 0..1 | Status of the NRF (operative, non-operative, ...)
The NRF shall be considered as operative if this attribute is absent. | +| _links | map(LinksValueSchema) | M | 1..N | Map of LinksValueSchema objects, where the keys are the link relations, as described in Table 6.4.6.3.3.1-1, and the values are objects containing an "href" attribute, whose value is an absolute URI corresponding to each link relation. | +| nrfFeatures | map(SupportedFeatures) | O | 1..N | Map of features supported by the NRF, where the keys of the map are the NRF services (as defined in clause 6.1.6.3.11), and where the value indicates the features supported by the corresponding NRF services.
When present, the NRF shall indicate all the features of all the services it supports.
(NOTE) | +| oauth2Required | map(boolean) | O | 1..N | When present, this IE shall indicate whether the NRF requires OAuth2-based authorization for accessing its services.
The key of the map shall be the name of an NRF service, e.g. "nnrf-nfm" or "nnrf-disc".

The value of each entry of the map shall be encoded as follows:
- true: OAuth2 based authorization is required.

- false: OAuth2 based authorization is not required.

The absence of this IE means that the NRF has not provided any indication about its usage of OAuth2 for authorization. | +| nrfSetId | NfSetId | O | 0..1 | NRF Set Id | +| nrfInstanceId | NfInstanceId | O | 0..1 | NRF Instance Id | +| NOTE: The absence of the nrfFeatures attribute in the BootstrappingInfo shall not be interpreted as if the NRF does not support any feature. | | | | | + +## 6.4.6.3 Simple data types and enumerations + +### 6.4.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 6.4.6.3.2 Enumeration: Status + +**Table 6.4.6.3.2-1: Enumeration Status** + +| Enumeration value | Description | +|-------------------|--------------------------| +| "OPERATIVE" | The NRF is operative | +| "NON_OPERATIVE" | The NRF is not operative | + +### 6.4.6.3.3 Relation Types + +#### 6.4.6.3.3.1 General + +This clause describes the possible relation types defined within NRF API. See clause 4.7.5.2 of 3GPP TS 29.501 [5] for the description of the relation types. + +**Table 6.4.6.3.3.1-1: supported registered relation types** + +| Relation Name | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| self | The "href" attribute of the object associated to this relation type contains the URI of the same resource returned in the response body (i.e. the "bootstrapping" resource). | +| manage | The "href" attribute of the object associated to this relation type contains the URI of the resource used in the Nnrf_NFManagement API to register/deregister/update NF Instances profiles in the NRF (i.e. the "nf-instances" store resource).
(NOTE) | +| subscribe | The "href" attribute of the object associated to this relation type contains the URI of the resource used in the Nnrf_NFManagement API to manage subscriptions to the NRF (i.e. the "subscriptions" collection resource).
(NOTE) | +| discover | The "href" attribute of the object associated to this relation type contains the URI of the resource used in the Nnrf_NFDiscovery API (i.e. the "nf-instances" collection resource). | +| authorize | The "href" attribute of the object associated to this relation type contains the URI of the Oauth2 Access Token Request endpoint, used to request authorization to other APIs in the 5G Core Network. | +| NOTE: The URIs of the "manage" and "subscribe" "href" attributes shall have the same apiRoot (i.e. authority and prefix) since these service operations belong to the same service. | | + +--- + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Nnrf Service API(s). It consists of OpenAPI 3.0.0 specifications, in YAML format. + +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). + +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. + +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 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [31] clause 5B). + +--- + +## A.2 Nnrf\_NFManagement API + +``` +openapi: 3.0.0 + +info: + version: '1.3.0-alpha.6' + title: 'NRF NFManagement Service' + description: | + NRF NFManagement Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.510 V18.5.0; 5G System; Network Function Repository Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' + +servers: + - url: '{apiRoot}/nnrf-nfm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + +paths: + /nf-instances: + get: + summary: Retrieves a collection of NF Instances + operationId: GetNFInstances + tags: + - NF Instances (Store) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instances:read + parameters: + - name: nf-type +``` + +``` +in: query +description: Type of NF +required: false +schema: + $ref: '#/components/schemas/NFType' +- name: limit +in: query +description: How many items to return at one time +required: false +schema: + type: integer + minimum: 1 +- name: page-number +in: query +description: Page number where the response shall start +required: false +schema: + type: integer + minimum: 1 +- name: page-size +in: query +description: Maximum number of items in each returned page +schema: + type: integer + minimum: 1 +responses: + '200': + description: Expected response to a valid request + content: + application/3gppHal+json: + schema: + $ref: '#/components/schemas/UriList' + headers: + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +``` + +``` +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +options: + summary: Discover communication options supported by NRF for NF Instances + operationId: OptionsNFInstances + tags: + - NF Instances (Store) + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/OptionsResponse' + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '204': + description: No Content + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +``` +/nf-instances/{nfInstanceID}: + get: + summary: Read the profile of a given NF Instance + operationId: GetNFInstance + tags: + - NF Instance ID (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instances:read + parameters: + - name: nfInstanceID + in: path + description: Unique ID of the NF Instance + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + - name: requester-features + in: query + description: Features supported by the NF Service Consumer + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + headers: + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NFProfile' + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Register a new NF Instance + operationId: RegisterNFInstance + tags: + - NF Instance ID (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instance:write + parameters: + - name: nfInstanceID + in: path + required: true + description: Unique ID of the NF Instance to register + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NFProfile' + required: true + responses: + '200': + description: OK (Profile Replacement) + content: + application/json: + schema: + $ref: '#/components/schemas/NFProfile' + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/NFProfile' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nnrf-nfm/v1/nf-instances/{nfInstanceId} +``` + +``` + required: true + schema: + type: string + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string +'307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string +'308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Update NF Instance profile + operationId: UpdateNFInstance + tags: + - NF Instance ID (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instance:write + parameters: + - name: nfInstanceID +``` + +``` +in: path +required: true +description: Unique ID of the NF Instance to update +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +- name: Content-Encoding +in: header +description: Content-Encoding, described in IETF RFC 9110 +schema: + type: string +- name: Accept-Encoding +in: header +description: Accept-Encoding, described in IETF RFC 9110 +schema: + type: string +- name: If-Match +in: header +description: Validator for conditional requests, as described in IETF RFC 9110, 13.1.1 +schema: + type: string +requestBody: +content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 +required: true +responses: +'200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/NFProfile' + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string +'204': + description: Expected response with empty body + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string +'307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string +'308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF +``` + +``` + + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '412': + $ref: 'TS29571_CommonData.yaml#/components/responses/412' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Deregisters a given NF Instance + operationId: DeregisterNFInstance + tags: + - NF Instance ID (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instance:write + parameters: + - name: nfInstanceID + in: path + required: true + description: Unique ID of the NF Instance to deregister + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + responses: + '204': + description: Expected response to a successful deregistration + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions: + post: + summary: Create a new subscription + operationId: CreateSubscription + tags: + - Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:subscriptions:subs-complete-profile + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nnrf-nfm/v1/subscriptions/{subscriptionId} + required: true + schema: + type: string + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + +``` + +``` + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string +'308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + onNFStatusEvent: + "{ $request.body#/nfStatusNotificationUri }": + post: + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + description: Notification content + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationData' + responses: + '204': + description: Expected response to a successful callback processing + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: > + The URI pointing to the resource located on another NF service + consumer instance + required: true + schema: +``` + +``` + + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: > + The URI pointing to the resource located on another NF service + consumer instance + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionID}: + patch: + summary: Updates a subscription + operationId: UpdateSubscription + tags: + - Subscription ID (Document) + parameters: + - name: subscriptionID + in: path + required: true + description: Unique ID of the subscription to update + schema: + type: string + pattern: '^(?:[0-9]{5,6}-(x3Lf57A:nid=[A-Fa-f0-9]{11}:)?)?[^\-]+\+$' + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + +``` + +``` + + $ref: '#/components/schemas/SubscriptionData' +headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string +'204': + description: No Content + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string +'307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string +'308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Deletes a subscription + operationId: RemoveSubscription + tags: + - Subscription ID (Document) + parameters: + - name: subscriptionID + in: path + required: true + description: Unique ID of the subscription to remove + schema: + type: string + pattern: '^[0-9]{5,6}-(x3Lf57A:nid=[A-Fa-f0-9]{11}:)?[^-]+\+$' + responses: + '204': + +``` + +``` + + description: Expected response to a successful subscription removal + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '/oauth2/token' + scopes: + nnrf-nfm: Access to the Nnrf_NFManagement API + nnrf-nfm:nf-instances:read: > + Access to read the nf-instances resource, or an individual NF Instance ID resource + nnrf-nfm:subscriptions:subs-complete-profile: > + Access to subscribe to the complete profile of NF instances + nnrf-nfm:nf-instance:write: > + Access to write (create, update, delete) an individual NF Instance ID resource + +schemas: + + NFProfile: + description: Information of an NF Instance registered in the NRF + type: object + required: + - nfInstanceId + - nfType + - nfStatus + anyOf: + - required: [ fqdn ] + +``` + +``` +- required: [ ipv4Addresses ] +- required: [ ipv6Addresses ] +properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfInstanceName: + type: string + nfType: + $ref: '#/components/schemas/NFType' + nfStatus: + $ref: '#/components/schemas/NFStatus' + collocatedNfInstances: + type: array + items: + $ref: '#/components/schemas/CollocatedNfInstance' + minItems: 1 + heartBeatTimer: + type: integer + minimum: 1 + plmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + snpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + sNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnsai' + minItems: 1 + perPlmnSnsaiList: + type: array + items: + $ref: '#/components/schemas/PlmnSnsai' + minItems: 1 + nsiList: + type: array + items: + type: string + minItems: 1 + fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + ipv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + allowedPlmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + allowedSnpns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + allowedNfTypes: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + allowedNfDomains: + type: array + items: + type: string + minItems: 1 +``` + +``` +allowedNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +allowedRuleSet: + description: A map (list of key-value pairs) where a valid JSON pointer Id serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/RuleSet' + minProperties: 1 +priority: + type: integer + minimum: 0 + maximum: 65535 +capacity: + type: integer + minimum: 0 + maximum: 65535 +load: + type: integer + minimum: 0 + maximum: 100 +loadTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +locality: + type: string +extLocality: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string serves + as key representing a type of locality + type: object + additionalProperties: + type: string + minProperties: 1 +udrInfo: + $ref: '#/components/schemas/UdrInfo' +udrInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdrInfo + type: object + additionalProperties: + $ref: '#/components/schemas/UdrInfo' + minProperties: 1 +udmInfo: + $ref: '#/components/schemas/UdmInfo' +udmInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdmInfo + type: object + additionalProperties: + $ref: '#/components/schemas/UdmInfo' + minProperties: 1 +ausfInfo: + $ref: '#/components/schemas/AusfInfo' +ausfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AusfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/AusfInfo' + minProperties: 1 +amfInfo: + $ref: '#/components/schemas/AmfInfo' +amfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AmfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/AmfInfo' + minProperties: 1 +smfInfo: + $ref: '#/components/schemas/SmfInfo' +smfInfoList: +``` + +``` +description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of SmfInfo +type: object +additionalProperties: + $ref: '#/components/schemas/SmfInfo' +minProperties: 1 +upfInfo: + $ref: '#/components/schemas/UpfInfo' +upfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UpfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/UpfInfo' + minProperties: 1 +pcfInfo: + $ref: '#/components/schemas/PcfInfo' +pcfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of PcfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/PcfInfo' + minProperties: 1 +bsfInfo: + $ref: '#/components/schemas/BsfInfo' +bsfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of BsfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/BsfInfo' + minProperties: 1 +chfInfo: + $ref: '#/components/schemas/ChfInfo' +chfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of ChfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/ChfInfo' + minProperties: 1 +nefInfo: + $ref: '#/components/schemas/NefInfo' +nrfInfo: + $ref: '#/components/schemas/NrfInfo' +udsfInfo: + $ref: '#/components/schemas/UdsfInfo' +udsfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdsfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/UdsfInfo' + minProperties: 1 +nwdafInfo: + $ref: '#/components/schemas/NwdafInfo' +nwdafInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of NwdafInfo + additionalProperties: + $ref: '#/components/schemas/NwdafInfo' + minProperties: 1 +pcscfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of PcscfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/PcscfInfo' +``` + +``` + minProperties: 1 + hssInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of HssInfo + type: object + additionalProperties: + $ref: '#/components/schemas/HssInfo' + minProperties: 1 + customInfo: + type: object + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + nfServicePersistence: + type: boolean + default: false + nfServices: + deprecated: true + type: array + items: + $ref: '#/components/schemas/NFService' + minItems: 1 + nfServiceList: + description: > + A map (list of key-value pairs) where serviceInstanceId serves as key of NFService + type: object + additionalProperties: + $ref: '#/components/schemas/NFService' + minProperties: 1 + nfProfileChangesSupportInd: + type: boolean + default: false + writeOnly: true + nfProfilePartialUpdateChangesSupportInd: + type: boolean + default: false + writeOnly: true + nfProfileChangesInd: + type: boolean + default: false + readOnly: true + defaultNotificationSubscriptions: + type: array + items: + $ref: '#/components/schemas/DefaultNotificationSubscription' + lmfInfo: + $ref: '#/components/schemas/LmfInfo' + gmlcInfo: + $ref: '#/components/schemas/GmlcInfo' + nfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + servingScope: + type: array + items: + type: string + minItems: 1 + lchSupportInd: + type: boolean + default: false + olchSupportInd: + type: boolean + default: false + nfSetRecoveryTimeList: + description: A map (list of key-value pairs) where NfSetId serves as key of DateTime + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minProperties: 1 + serviceSetRecoveryTimeList: + description: > + A map (list of key-value pairs) where NfServiceSetId serves as key of DateTime + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minProperties: 1 +``` + +``` +scpDomains: + type: array + items: + type: string + minItems: 1 +scpInfo: + $ref: '#/components/schemas/ScpInfo' +seppInfo: + $ref: '#/components/schemas/SeppInfo' +vendorId: + $ref: '#/components/schemas/VendorId' +supportedVendorSpecificFeatures: + description: > + The key of the map is the IANA-assigned SMI Network Management Private Enterprise Codes + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 +aanfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AanfInfo + additionalProperties: + $ref: '#/components/schemas/AanfInfo' + minProperties: 1 +5gDdnmfInfo: + $ref: '#/components/schemas/5GDdnmfInfo' +mfafInfo: + $ref: '#/components/schemas/MfafInfo' +easdfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of EasdfInfo + additionalProperties: + $ref: '#/components/schemas/EasdfInfo' + minProperties: 1 +dccfInfo: + $ref: '#/components/schemas/DccfInfo' +nsacfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of NsacfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/NsacfInfo' + minProperties: 1 +mbSmfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MbSmfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/MbSmfInfo' + minProperties: 1 +tsctsInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of TsctsInfo + additionalProperties: + $ref: '#/components/schemas/TsctsInfo' + minProperties: 1 +mbUpfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MbUpfInfo + additionalProperties: + $ref: '#/components/schemas/MbUpfInfo' + minProperties: 1 +trustAfInfo: + $ref: '#/components/schemas/TrustAfInfo' +nssaafInfo: +``` + +``` + $ref: '#/components/schemas/NssaafInfo' + hniList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + iwmscInfo: + $ref: '#/components/schemas/IwmscInfo' + mnpfInfo: + $ref: '#/components/schemas/MnpfInfo' + smsfInfo: + $ref: '#/components/schemas/SmsfInfo' + dcsfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of DcsfInfo + additionalProperties: + $ref: '#/components/schemas/DcsfInfo' + minProperties: 1 + mrfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MrfInfo + additionalProperties: + $ref: '#/components/schemas/MrfInfo' + minProperties: 1 + mrfpInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MrfpInfo + additionalProperties: + $ref: '#/components/schemas/MrfpInfo' + minProperties: 1 + mfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MfInfo + additionalProperties: + $ref: '#/components/schemas/MfInfo' + minProperties: 1 + adrfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AdrfInfo + additionalProperties: + $ref: '#/components/schemas/AdrfInfo' + minProperties: 1 + selectionConditions: + $ref: '#/components/schemas/SelectionConditions' + +NFService: + description: > + Information of a given NF Service Instance; it is part of the NFProfile of an NF Instance + type: object + required: + - serviceInstanceId + - serviceName + - versions + - scheme + - nfServiceStatus + properties: + serviceInstanceId: + type: string + serviceName: + $ref: '#/components/schemas/ServiceName' + versions: + type: array + items: + $ref: '#/components/schemas/NFServiceVersion' + minItems: 1 + scheme: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UriScheme' +``` + +``` +nfServiceStatus: + $ref: '#/components/schemas/NFServiceStatus' +fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +interPlmnFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +ipEndPoints: + type: array + items: + $ref: '#/components/schemas/IpEndPoint' + minItems: 1 +apiPrefix: + type: string +callbackUriPrefixList: + type: array + items: + $ref: '#/components/schemas/CallbackUriPrefixItem' + minItems: 1 +defaultNotificationSubscriptions: + type: array + items: + $ref: '#/components/schemas/DefaultNotificationSubscription' + minItems: 1 +allowedPlmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 +allowedSnpons: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 +allowedNfTypes: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 +allowedNfDomains: + type: array + items: + type: string + minItems: 1 +allowedNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +allowedOperationsPerNfType: + description: A map (list of key-value pairs) where NF Type serves as key + type: object + additionalProperties: + type: array + items: + type: string + minItems: 1 + minProperties: 1 +allowedOperationsPerNfInstance: + description: A map (list of key-value pairs) where NF Instance Id serves as key + type: object + additionalProperties: + type: array + items: + type: string + minItems: 1 + minProperties: 1 +allowedOperationsPerNfInstanceOverrides: + type: boolean + default: false +allowedScopesRuleSet: + description: A map (list of key-value pairs) where a valid JSON pointer Id serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/RuleSet' + minProperties: 1 +priority: + type: integer + minimum: 0 +``` + +``` + maximum: 65535 + capacity: + type: integer + minimum: 0 + maximum: 65535 + load: + type: integer + minimum: 0 + maximum: 100 + loadTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + nfServiceSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + minItems: 1 + sNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + perPlmnSnssaiList: + type: array + items: + $ref: '#/components/schemas/PlmnSnssai' + minItems: 1 + vendorId: + $ref: '#/components/schemas/VendorId' + supportedVendorSpecificFeatures: + description: > + A map (list of key-value pairs) where IANA-assigned SMI Network Management + Private Enterprise Codes serves as key + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 + oauth2Required: + type: boolean + perPlmnOAuth2ReqList: + $ref: '#/components/schemas/PlmnOAuth2' + selectionConditions: + $ref: '#/components/schemas/SelectionConditions' + +NFType: + description: NF types known to NRF + anyOf: + - type: string + enum: + - NRF + - UDM + - AMF + - SMF + - AUSF + - NEF + - PCF + - SMSF + - NSSF + - UDR + - LMF + - GMLC + - 5G_EIR + - SEPP + - UPF + - N3IWF + - AF + - UDSF + - BSF + - CHF + - NWDAF + - PCSCF + - CBCF +``` + +- HSS +- UCMF +- SOR\_AF +- SPAF +- MME +- SCSAS +- SCEF +- SCP +- NSSAAF +- ICSCF +- SCSF +- DRA +- IMS\_AS +- AANF +- 5G\_DDNMF +- NSACF +- MFAF +- EASDF +- DCCF +- MB\_SMF +- TSCTSF +- ADRF +- GBA\_BSF +- CEF +- MB\_UPF +- NSWOF +- PKMF +- MNPF +- SMS\_GMSC +- SMS\_IWMSC +- MBSF +- MBSTF +- PANF +- DCSF +- MRF +- MRFP +- MF +- SLPKMF +- type: string + +NefId: +description: Identity of the NEF +type: string + +IpEndPoint: +description: > +IP addressing information of a given NFService; +it consists on, e.g. IP address, TCP port, transport protocol... +type: object +not: +required: [ ipv4Address, ipv6Address ] +properties: +ipv4Address: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv4Addr' +ipv6Address: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv6Addr' +transport: +\$ref: '#/components/schemas/TransportProtocol' +port: +type: integer +minimum: 0 +maximum: 65535 + +SubscriptionData: +description: > +Information of a subscription to notifications to NRF events, +included in subscription requests and responses +type: object +required: +- nfStatusNotificationUri +- subscriptionId +properties: +nfStatusNotificationUri: +type: string +reqNfInstanceId: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/NfInstanceId' +subscrCond: +\$ref: '#/components/schemas/SubscrCond' + +``` + +subscriptionId: + type: string + pattern: '^(?:[0-9]{5,6}-(x3Lf57A:nid=[A-Fa-f0-9]{11}:)?)[^-]+$' + readOnly: true +validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +reqNotifEvents: + type: array + items: + $ref: '#/components/schemas/NotificationEventType' + minItems: 1 +plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +nid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Nid' +notifCondition: + $ref: '#/components/schemas/NotifCondition' +reqNfType: + $ref: '#/components/schemas/NFType' +reqNfFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +reqSnssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +reqPerPlmnSnssais: + type: array + items: + $ref: '#/components/schemas/PlmnSnssai' + minItems: 1 +reqPlmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 +reqSnpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 +servingScope: + type: array + items: + type: string + minItems: 1 +requesterFeatures: + writeOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +nrfSupportedFeatures: + readOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +hnrfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +onboardingCapability: + type: boolean + default: false +targetHni: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +preferredLocality: + type: string +extPreferredLocality: + description: > + A map (list of key-value pairs) where the key of the map represents the relative + priority, for the requester, of each locality description among the list of locality + descriptions in this query parameter, encoded as "1" (highest priority), "2", "3", ..., + "n" (lowest priority) + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/LocalityDescription' + minItems: 1 + minProperties: 1 +completeProfileSubscription: + type: boolean + +``` + +``` + default: false + writeOnly: true + +SubscrCond: + description: > + Condition to determine the set of NFs to monitor under a certain subscription in NRF + oneOf: + - $ref: '#/components/schemas/NfInstanceIdCond' + - $ref: '#/components/schemas/NfInstanceIdListCond' + - $ref: '#/components/schemas/NfTypeCond' + - $ref: '#/components/schemas/ServiceNameCond' + - $ref: '#/components/schemas/ServiceNameListCond' + - $ref: '#/components/schemas/AmfCond' + - $ref: '#/components/schemas/GuamiListCond' + - $ref: '#/components/schemas/NetworkSliceCond' + - $ref: '#/components/schemas/NfGroupCond' + - $ref: '#/components/schemas/NfGroupListCond' + - $ref: '#/components/schemas/NfSetCond' + - $ref: '#/components/schemas/NfServiceSetCond' + - $ref: '#/components/schemas/UpfCond' + - $ref: '#/components/schemas/ScpDomainCond' + - $ref: '#/components/schemas/NwdafCond' + - $ref: '#/components/schemas/NefCond' + - $ref: '#/components/schemas/DccfCond' + +NfInstanceIdCond: + description: Subscription to a given NF Instance Id + type: object + required: + - nfInstanceId + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +NfInstanceIdListCond: + description: Subscription to a list of NF Instances + type: object + required: + - nfInstanceIdList + properties: + nfInstanceIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + +NfTypeCond: + description: Subscription to a set of NFs based on their NF Type + type: object + required: + - nfType + not: + required: [ nfGroupId ] + properties: + nfType: + $ref: '#/components/schemas/NFType' + +ServiceNameCond: + description: Subscription to a set of NFs based on their support for a given Service Name + type: object + required: + - serviceName + properties: + serviceName: + $ref: '#/components/schemas/ServiceName' + +ServiceNameListCond: + description: > + Subscription to a set of NFs based on their support for a Service Name + in the Service Name list + type: object + required: + - conditionType + - serviceNameList + properties: + conditionType: + type: string + enum: [ SERVICE_NAME_LIST_COND ] +``` + +``` + serviceNameList: + type: array + items: + $ref: '#/components/schemas/ServiceName' + minItems: 1 + +AmfCond: + description: Subscription to a set of AMFs, based on AMF Set Id and/or AMF Region Id + type: object + anyOf: + - required: [ amfSetId ] + - required: [ amfRegionId ] + properties: + amfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfSetId' + amfRegionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId' + +GuamiListCond: + description: Subscription to a set of AMFs, based on their GUAMIs + type: object + required: + - guamiList + properties: + guamiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + +NetworkSliceCond: + description: Subscription to a set of NFs, based on the slices (S-NSSAI and NSI) they support + type: object + required: + - snssaiList + properties: + snssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + nsiList: + type: array + items: + type: string + +NfGroupCond: + description: Subscription to a set of NFs based on their Group Id + type: object + required: + - nfType + - nfGroupId + properties: + nfType: + type: string + enum: + - UDM + - AUSF + - UDR + - PCF + - CHF + - HSS + nfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + +NfGroupListCond: + description: Subscription to a set of NFs based on their Group Ids + type: object + required: + - conditionType + - nfType + - nfGroupIdList + properties: + conditionType: + type: string + enum: [ NF_GROUP_LIST_COND ] + nfType: + type: string + enum: + - UDM +``` + +``` + - AUSF + - UDR + - PCF + - CHF + - HSS + nfGroupIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + minItems: 1 + +NotifCondition: + description: > + Condition (list of attributes in the NF Profile) to determine whether a notification + must be sent by NRF + type: object + not: + required: [ monitoredAttributes, unmonitoredAttributes ] + properties: + monitoredAttributes: + type: array + items: + type: string + minItems: 1 + unmonitoredAttributes: + type: array + items: + type: string + minItems: 1 + +UdrInfo: + description: Information of an UDR NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + supportedDataSets: + type: array + items: + $ref: '#/components/schemas/DataSetId' + minItems: 1 + sharedDataIdRanges: + type: array + items: + $ref: '#/components/schemas/SharedDataIdRange' + minItems: 1 + +SharedDataIdRange: + description: A range of SharedDataIds based on regular-expression matching + type: object + properties: + pattern: + type: string + +SupiRange: + description: > + A range of SUPIs (subscriber identities), either based on a numeric range, + or based on regular-expression matching + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: +``` + +``` +start: + type: string + pattern: '^[0-9]+$' +end: + type: string + pattern: '^[0-9]+$' +pattern: + type: string + +IdentityRange: + description: > + A range of GPSIs (subscriber identities), either based on a numeric range, + or based on regular-expression matching + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + type: string + pattern: '^[0-9]+$' + end: + type: string + pattern: '^[0-9]+$' + pattern: + type: string + +InternalGroupIdRange: + description: > + A range of Group IDs (internal group identities), either based on a numeric range, + or based on regular-expression matching + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + end: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + pattern: + type: string + +DataSetId: + description: Types of data sets and subsets stored in UDR + anyOf: + - type: string + enum: + - SUBSCRIPTION + - POLICY + - EXPOSURE + - APPLICATION + - A_PFD + - A_AFTI + - A_AFQOS + - A_IPTV + - A_BDT + - A_SPD + - A_EASD + - A_AMI + - P_UE + - P_SCD + - P_BDT + - P_PLMNUE + - P_NSSCD + - P_PDTQ + - P_MBSCD + - P_GROUP + - type: string + +UdmInfo: + description: Information of an UDM NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array +``` + +``` + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + routingIndicators: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + internalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/InternalGroupIdRange' + minItems: 1 + suciInfos: + type: array + items: + $ref: '#/components/schemas/SuciInfo' + minItems: 1 + +AusfInfo: + description: Information of an AUSF NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + routingIndicators: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + suciInfos: + type: array + items: + $ref: '#/components/schemas/SuciInfo' + minItems: 1 + +AmfInfo: + description: Information of an AMF NF Instance + type: object + required: + - amfSetId + - amfRegionId + - guamiList + properties: + amfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfSetId' + amfRegionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId' + guamiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: +``` + +``` + $ref: '#/components/schemas/TaiRange' + minItems: 1 + backupInfoAmfFailure: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + backupInfoAmfRemoval: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + n2InterfaceAmfInfo: + $ref: '#/components/schemas/N2InterfaceAmfInfo' + amfOnboardingCapability: + type: boolean + default: false + highLatencyCom: + type: boolean + +SmfInfo: + description: Information of an SMF NF Instance + type: object + required: + - sNssaiSmfInfoList + properties: + sNssaiSmfInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiSmfInfoItem' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + pgwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pgwIpAddrList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + accessType: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + priority: + type: integer + minimum: 0 + maximum: 65535 + vsmfSupportInd: + type: boolean + pgwFqdnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + smfOnboardingCapability: + type: boolean + default: false + deprecated: true + ismfSupportInd: + type: boolean + smfUPRPCapability: + type: boolean + default: false + +SnssaiSmfInfoItem: + description: Set of parameters supported by SMF for a given S-NSSAI + type: object + required: +``` + +``` +- sNSSAI +- dnnSmfInfoList +properties: + sNSSAI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtS NSSAI' + dnnSmfInfoList: + type: array + items: + $ref: '#/components/schemas/DnnSmfInfoItem' + minItems: 1 + +DnnSmfInfoItem: + description: Set of parameters supported by SMF for a given DNN + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + dnaiList: + type: array + items: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + - $ref: '#/components/schemas/WildcardDnai' + minItems: 1 + +UpfInfo: + description: Information of an UPF NF Instance + type: object + required: + - sNSSAIUpfInfoList + properties: + sNSSAIUpfInfoList: + type: array + items: + $ref: '#/components/schemas/SNSSAIUpfInfoItem' + minItems: 1 + smfServingArea: + type: array + items: + type: string + minItems: 1 + interfaceUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 + iwkEpsInd: + type: boolean + default: false + sxaInd: + type: boolean + pduSessionTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + atsssCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AtsssCapability' + ueIpAddrInd: + type: boolean + default: false + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + wAgfInfo: + $ref: '#/components/schemas/WAgfInfo' + tngfInfo: +``` + +``` +$ref: '#/components/schemas/TngfInfo' +twifInfo: + $ref: '#/components/schemas/TwifInfo' +preferredEpdgInfoList: + type: array + items: + $ref: '#/components/schemas/EpdgInfo' + minItems: 1 +preferredWAgfInfoList: + type: array + items: + $ref: '#/components/schemas/WAgfInfo' + minItems: 1 +preferredTngfInfoList: + type: array + items: + $ref: '#/components/schemas/TngfInfo' + minItems: 1 +preferredTwifInfoList: + type: array + items: + $ref: '#/components/schemas/TwifInfo' + minItems: 1 +priority: + type: integer + minimum: 0 + maximum: 65535 +redundantGtpu: + type: boolean + default: false +ipups: + type: boolean + default: false +dataForwarding: + type: boolean + default: false +supportedPfcpFeatures: + type: string +upfEvents: + type: array + items: + $ref: 'TS29564_Nupf_EventExposure.yaml#/components/schemas/EventType' + minItems: 1 + +SnssaiUpfInfoItem: + description: Set of parameters supported by UPF for a given S-NSSAI + type: object + required: + - sNssai + - dnnUpfInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnUpfInfoList: + type: array + items: + $ref: '#/components/schemas/DnnUpfInfoItem' + minItems: 1 + redundantTransport: + type: boolean + default: false + interfaceUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 + +DnnUpfInfoItem: + description: Set of parameters supported by UPF for a given DNN + type: object + required: + - dnn + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + dnaIList: + type: array + items: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + pduSessionTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + ipv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + ipv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + natedIpv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + natedIpv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + ipv4IndexList: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpIndex' + minItems: 1 + ipv6IndexList: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpIndex' + minItems: 1 + networkInstance: + description: > + The N6 Network Instance associated with the S-NSSAI and DNN. + type: string + dnaiNwInstanceList: + description: > + Map of network instance per DNAI for the DNN, where the key of the map is the DNAI. + When present, the value of each entry of the map shall contain a N6 network instance + that is configured for the DNAI indicated by the key. + type: object + additionalProperties: + type: string + minProperties: 1 + interfaceUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 + not: + required: [ networkInstance, dnaiNwInstanceList ] + +InterfaceUpfInfoItem: + description: Information of a given IP interface of an UPF + type: object + required: + - interfaceType + anyOf: + - required: [ endpointFqdn ] + - required: [ ipv4EndpointAddresses ] + - required: [ ipv6EndpointAddresses ] + properties: + interfaceType: + $ref: '#/components/schemas/UPInterfaceType' + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddresses: + type: array + items: + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + endpointFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + networkInstance: + type: string + +UPInterfaceType: + description: Types of User-Plane interfaces of the UPF + anyOf: + - type: string + enum: + - N3 + - N6 + - N9 + - DATA_FORWARDING + - N3MB + - N6MB + - N19MB + - NMB9 + - S1U + - S5U + - S8U + - S11U + - S12 + - S2AU + - S2BU + - N3TRUSTEDN3GPP + - N3UNTRUSTEDN3GPP + - N9ROAMING + - SGI + - N19 + - SXAU + - SXBU + - N4U + - type: string + +WAgfInfo: + description: Information of the W-AGF end-points + type: object + anyOf: + - required: [ endpointFqdn ] + - required: [ ipv4EndpointAddresses ] + - required: [ ipv6EndpointAddresses ] + properties: + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + endpointFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + +TngfInfo: + description: Information of the TNGF endpoints + type: object + anyOf: + - required: [ endpointFqdn ] + - required: [ ipv4EndpointAddresses ] + - required: [ ipv6EndpointAddresses ] + properties: + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + endpointFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +``` + +``` +PcfInfo: + description: Information of a PCF NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + rxDiamHost: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + rxDiamRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + v2xSupportInd: + type: boolean + default: false + proseSupportInd: + type: boolean + default: false + proseCapability: + $ref: '#/components/schemas/ProSeCapability' + v2xCapability: + $ref: '#/components/schemas/V2xCapability' + a2xSupportInd: + type: boolean + default: false + a2xCapability: + $ref: '#/components/schemas/A2xCapability' + rangingSlPosSupportInd: + type: boolean + default: false + upPositioningInd: + description: user plane positioning capability is supported by the LMF + type: boolean + default: false + +BsfInfo: + description: Information of a BSF NF Instance + type: object + properties: + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + ipDomainList: + type: array + items: + type: string + minItems: 1 + ipv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + ipv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + rxDiamHost: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + rxDiamRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + groupId: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + +ChfInfo: + description: Information of a CHF NF Instance + type: object + not: + required: [ primaryChfInstance, secondaryChfInstance ] + properties: + supiRangeList: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRangeList: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + plmnRangeList: + type: array + items: + $ref: '#/components/schemas/PlmnRange' + minItems: 1 + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + primaryChfInstance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + secondaryChfInstance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +Ipv4AddressRange: + description: Range of IPv4 addresses + type: object + properties: + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + end: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + +Ipv6PrefixRange: + description: Range of IPv6 prefixes + type: object + properties: + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + end: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + +DefaultNotificationSubscription: + description: > + Data structure for specifying the notifications the NF service subscribes by default, + along with callback URI + type: object + required: + - notificationType + - callbackUri + properties: + notificationType: + $ref: '#/components/schemas/NotificationType' + callbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + interPlmnCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + n1MessageClass: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N1MessageClass' + n2InformationClass: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InformationClass' + versions: + +``` + +``` + type: array + items: + type: string + minItems: 1 + binding: + type: string + acceptedEncoding: + type: string + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + serviceInfoList: + description: > + A map of service specific information. The name of the corresponding service (as + specified in ServiceName data type) is the key. + type: object + additionalProperties: + $ref: '#/components/schemas/DefSubServiceInfo' + minProperties: 1 + callbackUriPrefix: + type: string + +NfSetCond: + description: Subscription to a set of NFs based on their Set Id + type: object + required: + - nfSetId + properties: + nfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + +NfServiceSetCond: + description: Subscription to a set of NFs based on their Service Set Id + type: object + required: + - nfServiceSetId + properties: + nfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + nfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + +UpfCond: + description: > + Subscription to a set of NF Instances (UPFs), able to serve a certain service area + (i.e. SMF serving area or TAI list) + type: object + required: + - conditionType + properties: + conditionType: + type: string + enum: [ UPF_COND ] + smfServingArea: + type: array + items: + type: string + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + +NwdafCond: + description: > + Subscription to a set of NF Instances (NWDAFs), identified by Analytics ID(s), + S-NSSAI(s) or NWDAF Serving Area information, i.e. list of TAIs for which the NWDAF + can provide analytics. + type: object + required: + - conditionType + properties: + conditionType: + type: string + enum: [ NWDAF_COND ] + analyticsIds: + type: array + items: +``` + +``` + + type: string + minItems: 1 + snssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + mlAnalyticsList: + type: array + items: + $ref: '#/components/schemas/MlAnalyticsInfo' + minItems: 1 + +NefCond: + description: > + Subscription to a set of NF Instances (NEFs), identified by Event ID(s) provided by AF, + S-NSSAI(s), AF Instance ID, Application Identifier, External Identifier, + External Group Identifier, or domain name. + type: object + required: + - conditionType + properties: + conditionType: + type: string + enum: [ NEF_COND ] + afEvents: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEvent' + minItems: 1 + snssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + pfdData: + $ref: '#/components/schemas/PfdData' + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + servedFqdnList: + type: array + items: + type: string + minItems: 1 + +NotificationType: + description: > + Types of notifications used in Default Notification URIs in the NF Profile of an NF Instance + anyOf: + - type: string + +``` + +``` + +enum: + - N1_MESSAGES + - N2_INFORMATION + - LOCATION_NOTIFICATION + - DATA_REMOVAL_NOTIFICATION + - DATA_CHANGE_NOTIFICATION + - LOCATION_UPDATE_NOTIFICATION + - NSSAA_REAUTH_NOTIFICATION + - NSSAA_REVOC_NOTIFICATION + - MATCH_INFO_NOTIFICATION + - DATA_RESTORATION_NOTIFICATION + - TSCTS_NOTIFICATION + - LCS_KEY_DELIVERY_NOTIFICATION + - UUAA_MM_AUTH_NOTIFICATION +- type: string + +TransportProtocol: + description: Types of transport protocol used in a given IP endpoint of an NF Service Instance + anyOf: + - type: string + enum: + - TCP + - type: string + +NotificationEventType: + description: Types of events sent in notifications from NRF to subscribed NF Instances + anyOf: + - type: string + enum: + - NF_REGISTERED + - NF_DEREGISTERED + - NF_PROFILE_CHANGED + - type: string + +NotificationData: + description: Data sent in notifications from NRF to subscribed NF Instances + type: object + required: + - event + - nfInstanceUri + allOf: + # + # Condition: If 'event' takes value 'NF_PROFILE_CHANGED', + # then one of 'nfProfile', 'profileChanges' or 'completeNfProfile' must be present + # + - anyOf: + - not: + properties: + event: + type: string + enum: + - NF_PROFILE_CHANGED + - oneOf: + - required: [ nfProfile ] + - required: [ profileChanges ] + - required: [ completeNfProfile ] + # + # Condition: If 'event' takes value 'NF_REGISTERED', + # then one of 'nfProfile' or 'completeNfProfile' must be present + # + - anyOf: + - not: + properties: + event: + type: string + enum: + - NF_REGISTERED + - oneOf: + - required: [ nfProfile ] + - required: [ completeNfProfile ] + properties: + event: + $ref: '#/components/schemas/NotificationEventType' + nfInstanceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nfProfile: + allOf: + - $ref: '#/components/schemas/NFProfile' + +``` + +``` + +- not: + required: [ allowedPlmns ] +- not: + required: [ allowedSnpns ] +- not: + required: [ allowedNfTypes ] +- not: + required: [ allowedNfDomains ] +- not: + required: [ allowedNssais ] +- properties: + nfServices: + type: array + items: + allOf: + - $ref: '#/components/schemas/NFService' + - not: + required: [ allowedPlmns ] + - not: + required: [ allowedSnpns ] + - not: + required: [ allowedNfTypes ] + - not: + required: [ allowedNfDomains ] + - not: + required: [ allowedNssais ] + nfServiceList: + type: object + additionalProperties: + allOf: + - $ref: '#/components/schemas/NFService' + - not: + required: [ allowedPlmns ] + - not: + required: [ allowedSnpns ] + - not: + required: [ allowedNfTypes ] + - not: + required: [ allowedNfDomains ] + - not: + required: [ allowedNssais ] +profileChanges: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChangeItem' + minItems: 1 +conditionEvent: + $ref: '#/components/schemas/ConditionEventType' +subscriptionContext: + $ref: '#/components/schemas/SubscriptionContext' +completeNfProfile: + $ref: '#/components/schemas/NFProfile' + +NFStatus: + description: Status of a given NF Instance stored in NRF + anyOf: + - type: string + enum: + - REGISTERED + - SUSPENDED + - UNDISCOVERABLE + - CANARY_RELEASE + - type: string + +NFServiceVersion: + description: Contains the version details of an NF service + type: object + required: + - apiVersionInUri + - apiFullVersion + properties: + apiVersionInUri: + type: string + apiFullVersion: + type: string + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +``` + +ServiceName: +description: Service names known to NRF +anyOf: +- type: string +enum: +- nnrf-nfm +- nnrf-disc +- nnrf-oauth2 +- nudm-sdm +- nudm-uecm +- nudm-ueau +- nudm-ee +- nudm-pp +- nudm-niddau +- nudm-mt +- nudm-ssau +- nudm-rsds +- nudm-ueid +- namf-comm +- namf-evts +- namf-mt +- namf-loc +- namf-mbs-comm +- namf-mbs-bc +- nsmf-pdusession +- nsmf-event-exposure +- nsmf-nidd +- nausf-auth +- nausf-sorprotection +- nausf-upuprotection +- nnef-pfdmanagement +- nnef-smcontext +- nnef-eventexposure +- nnef-eas-deployment-info +- nnef-dnai-mapping +- nnef-traffic-influence-data +- nnef-ecs-addr-cfg-info +- 3gpp-cp-parameter-provisioning +- 3gpp-device-triggering +- 3gpp-bdt +- 3gpp-traffic-influence +- 3gpp-chargeable-party +- 3gpp-as-session-with-qos +- 3gpp-msisdn-less-mo-sms +- 3gpp-service-parameter +- 3gpp-monitoring-event +- 3gpp-nidd-configuration-trigger +- 3gpp-nidd +- 3gpp-analyticsexposure +- 3gpp-racs-parameter-provisioning +- 3gpp-ecr-control +- 3gpp-applying-bdt-policy +- 3gpp-mo-lcs-notify +- 3gpp-time-sync +- 3gpp-am-influence +- 3gpp-am-policyauthorization +- 3gpp-akma +- 3gpp-eas-deployment +- 3gpp-iptvconfiguration +- 3gpp-mbs-tmgi +- 3gpp-mbs-session +- 3gpp-authentication +- 3gpp-asti +- 3gpp-pdtq-policy-negotiation +- 3gpp-musa +- npcf-am-policy-control +- npcf-smpolicycontrol +- npcf-policyauthorization +- npcf-bdtpolicycontrol +- npcf-eventexposure +- npcf-ue-policy-control +- npcf-am-policyauthorization +- npcf-pdtq-policy-control +- npcf-mbspolicycontrol +- npcf-mbspolicyauth +- nsmsf-sms +- nnssf-nsselection +- nnssf-nssaiavailability + +``` + + - nudr-dr + - nudr-group-id-map + - nlmf-loc + - n5g-eir-eic + - nbsf-management + - nchf-spendinglimitcontrol + - nchf-convergedcharging + - nchf-offlineonlycharging + - nnwdaf-eventssubscription + - nnwdaf-analyticsinfo + - nnwdaf-datamanagement + - nnwdaf-mlmodelprovision + - nnwdaf-mlmodeltraining + - nnwdaf-mlmodelmonitor + - ngmlc-loc + - nucmf-provisioning + - nucmf-uecapabilitymanagement + - nhss-sdm + - nhss-uecm + - nhss-ueau + - nhss-ee + - nhss-ims-sdm + - nhss-ims-uecm + - nhss-ims-ueau + - nhss-gba-sdm + - nhss-gba-ueau + - nsepp-telescopic + - nsoraf-sor + - nspaf-secured-packet + - nudsf-dr + - nudsf-timer + - nnssaa-nssaa + - nnssaa-aiw + - naanf-akma + - n5gddnmf-discovery + - nmfaf-3dadm + - nmfaf-3cdm + - neasdf-dnscontext + - neasdf-baselinednspattern + - ndccf-dm + - ndccf-cm + - nnsacf-nsac + - nnsacf-slice-ee + - nmbsmf-tmgi + - nmbsmf-mbsession + - nadrf-dm + - nadrf-mlmodelmanagement + - nbsp-gba + - ntsctsf-time-sync + - ntsctsf-qos-tscai + - ntsctsf-asti + - npkmf-keyreq + - npkmf-userid + - npkmf-discovery + - nmnpf-npstatus + - niwmsc-smsservice + - nmbsf-mbs-us + - nmbsf-mbs-ud-ingest + - nmbstf-distsession + - npanf-prosekey + - npanf-userid + - nupf-ee + - nupf-gueip + - naf-prose + - naf-eventexposure + - type: string + +N2InterfaceAmfInfo: + description: AMF N2 interface information + type: object + anyOf: + - required: [ ipv4EndPointAddress ] + - required: [ ipv6EndPointAddress ] + properties: + ipv4EndPointAddress: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + +``` + +``` + + minItems: 1 + ipv6EndpointAddress: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + amfName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfName' + +NFServiceStatus: + description: Status of a given NF Service Instance of an NF Instance stored in NRF + anyOf: + - type: string + enum: + - REGISTERED + - SUSPENDED + - UNDISCOVERABLE + - CANARY_RELEASE + - type: string + +TaiRange: + description: Range of TAIs (Tracking Area Identities) + type: object + required: + - plmnId + - tacRangeList + properties: + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + tacRangeList: + type: array + items: + $ref: '#/components/schemas/TacRange' + minItems: 1 + nid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Nid' + +TacRange: + description: Range of TACs (Tracking Area Codes) + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + type: string + pattern: '^([A-Fa-f0-9]{4}|[A-Fa-f0-9]{6})$' + end: + type: string + pattern: '^([A-Fa-f0-9]{4}|[A-Fa-f0-9]{6})$' + pattern: + type: string + +PlmnRange: + description: Range of PLMN IDs + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + type: string + pattern: '^[0-9]{3}[0-9]{2,3}$' + end: + type: string + pattern: '^[0-9]{3}[0-9]{2,3}$' + pattern: + type: string + +NrfInfo: + description: Information of an NRF NF Instance, used in hierarchical NRF deployments + type: object + properties: + servedUdrInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + +``` + +``` + - $ref: '#/components/schemas/UdrInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedUdrInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdrInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedUdmInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdmInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedUdmInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdmInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedAusfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AusfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedAusfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AusfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedAmfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedAmfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedSmfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object +``` + +``` +additionalProperties: + anyOf: + - $ref: '#/components/schemas/SmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' +minProperties: 1 +servedSmfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/SmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedUpfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UpfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedUpfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UpfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedPcfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/PcfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedPcfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/PcfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedBsfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/BsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedBsfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/BsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedChfInfo: +``` + +``` +description: A map (list of key-value pairs) where nfInstanceId serves as key +type: object +additionalProperties: + anyOf: + - $ref: '#/components/schemas/ChfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' +minProperties: 1 +servedChfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/ChfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedNefInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/NefInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +servedNwdaInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/NwdaInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +servedNwdaInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/NwdaInfo' + minProperties: 1 + minProperties: 1 +servedPscfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/PscfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedGmlcInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/GmlcInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +servedLmfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/LmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +servedNfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/NfInfo' +``` + +``` +minProperties: 1 +servedHssInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/HssInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedUdsfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +servedUdsfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedScpInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/ScpInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +servedSeppInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/SeppInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +servedAanfInfoList: + description: A map (list of key-value pairs) where NF Instance Id serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AanfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +served5gDdnmfInfo: + type: object + additionalProperties: + $ref: '#/components/schemas/5GDdnmfInfo' + minProperties: 1 +servedMfafInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/MfafInfo' + minProperties: 1 +servedEasdfInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: +``` + +``` + $ref: '#/components/schemas/EasdInfo' + minProperties: 1 + servedDccfInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/DccfInfo' + minProperties: 1 + servedMbSmfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/MbSmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedTsctsInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/TsctsInfo' + minProperties: 1 + minProperties: 1 + servedMbUpfInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/MbUpfInfo' + minProperties: 1 + minProperties: 1 + servedTrustAfInfo: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/TrustAfInfo' + minProperties: 1 + servedNssaafInfo: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/NssaafInfo' + minProperties: 1 + +PlmnSnssai: + description: List of network slices (S-NSSAIs) for a given PLMN ID + type: object + required: + - plmnId + - sNssaiList + properties: + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + sNssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + nid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Nid' + +NefInfo: + description: Information of an NEF NF Instance + type: object + properties: + nefId: + $ref: '#/components/schemas/NefId' + pfdData: + $ref: '#/components/schemas/PfdData' +``` + +``` +afEeData: + $ref: '#/components/schemas/AfEventExposureData' +gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 +externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 +servedFqdnList: + type: array + items: + type: string + minItems: 1 +taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 +taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 +dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 +unTrustAfInfoList: + type: array + items: + $ref: '#/components/schemas/UnTrustAfInfo' + minItems: 1 +uasNfFunctionalityInd: + type: boolean + default: false +multiMemAfSessQosInd: + type: boolean + default: false +memberUESelAssistInd: + type: boolean + default: false + +PfdData: + description: List of Application IDs and/or AF IDs managed by a given NEF Instance + type: object + properties: + appIds: + type: array + items: + type: string + minItems: 1 + afIds: + type: array + items: + type: string + minItems: 1 + +NwdafInfo: + description: Information of a NWDAF NF Instance + type: object + properties: + eventIds: + type: array + items: + $ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventId' + minItems: 1 + nwdafEvents: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + minItems: 1 + taiList: + type: array +``` + +``` + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + nwdafCapability: + $ref: '#/components/schemas/NwdafCapability' + analyticsDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + mlAnalyticsList: + type: array + items: + $ref: '#/components/schemas/MlAnalyticsInfo' + minItems: 1 + +LmfInfo: + description: Information of an LMF NF Instance + type: object + properties: + servingClientTypes: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType' + minItems: 1 + lmfId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + servingAccessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + servingAnNodeTypes: + type: array + items: + $ref: '#/components/schemas/AnNodeType' + minItems: 1 + servingRatTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + supportedGADShapes: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/SupportedGADShapes' + minItems: 1 + pruExistenceInfo: + $ref: '#/components/schemas/PruExistenceInfo' + pruSupportInd: + type: boolean + default: false + rangingslposSupportInd: + type: boolean + default: false +``` + +``` +GmlcInfo: + description: Information of a GMLC NF Instance + type: object + properties: + servingClientTypes: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType' + minItems: 1 + gmlcNumbers: + type: array + items: + type: string + pattern: '^[0-9]{5,15}$' + minItems: 1 + +AfEventExposureData: + description: AF Event Exposure data managed by a given NEF Instance + type: object + required: + - afEvents + properties: + afEvents: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEvent' + minItems: 1 + afIds: + type: array + items: + type: string + minItems: 1 + appIds: + type: array + items: + type: string + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + +PscfInfo: + description: Information of a P-CSCF NF Instance + type: object + properties: + accessType: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + gmFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + gmIpv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + gmIpv6Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + mwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + mwIpv4Addresses: + type: array +``` + +``` + + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + mwIpv6Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + servedIpv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + servedIpv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + +NfInfo: + description: Information of a generic NF Instance + type: object + properties: + nfType: + $ref: '#/components/schemas/NFType' + +HssInfo: + description: Information of an HSS NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + imsiRanges: + type: array + items: + $ref: '#/components/schemas/ImsiRange' + minItems: 1 + imsPrivateIdentityRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + imsPublicIdentityRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + msisdnRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + hssDiameterAddress: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/NetworkNodeDiameterAddress' + additionalDiamAddresses: + type: array + items: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/NetworkNodeDiameterAddress' + minItems: 1 + +ImsiRange: + description: > + A range of IMSIs (subscriber identities), either based on a numeric range, + or based on regular-expression matching + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + type: string + pattern: '^[0-9]+$' + end: + +``` + +``` + type: string + pattern: '[0-9]+$' + pattern: + type: string + + TwifInfo: + description: Addressing information (IP addresses, FQDN) of the TWIF + type: object + anyOf: + - required: [ endpointFqdn ] + - required: [ ipv4EndpointAddresses ] + - required: [ ipv6EndpointAddresses ] + properties: + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + endpointFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + + VendorId: + description: Vendor ID of the NF Service instance (Private Enterprise Number assigned by IANA) + type: string + pattern: '[0-9]{6}$' + + VendorSpecificFeature: + description: Information about a vendor-specific feature + type: object + required: + - featureName + - featureVersion + properties: + featureName: + type: string + featureVersion: + type: string + + AnNodeType: + description: Access Network Node Type (gNB, ng-eNB...) + anyOf: + - type: string + enum: + - GNB + - NG_ENB + - type: string + + UdsfInfo: + description: Information related to UDSF + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + storageIdRanges: + description: > + A map (list of key-value pairs) where realmId serves as key and each value in the map + is an array of IdentityRanges. Each IdentityRange is a range of storageIds. + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + minProperties: 1 + + ScpInfo: + description: Information of an SCP Instance + type: object +``` + +``` +properties: + scpDomainInfoList: + description: > + A map (list of key-value pairs) where the key of the map shall be the string + identifying an SCP domain + type: object + additionalProperties: + $ref: '#/components/schemas/ScpDomainInfo' + minProperties: 1 + scpPrefix: + type: string + scpPorts: + description: > + Port numbers for HTTP and HTTPS. The key of the map shall be "http" or "https". + type: object + additionalProperties: + type: integer + minimum: 0 + maximum: 65535 + minProperties: 1 + addressDomains: + type: array + items: + type: string + minItems: 1 + ipv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6Prefixes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + ipv4AddrRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + ipv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + servedNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + remotePlmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + remoteSnpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + ipReachability: + $ref: '#/components/schemas/IpReachability' + scpCapabilities: + type: array + items: + $ref: '#/components/schemas/ScpCapability' + +ScpDomainInfo: + description: SCP Domain specific information + type: object + properties: + scpFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + scpIpEndPoints: + type: array + items: + $ref: '#/components/schemas/IpEndPoint' + minItems: 1 +``` + +``` + scpPrefix: + type: string + scpPorts: + description: > + Port numbers for HTTP and HTTPS. The key of the map shall be "http" or "https". + type: object + additionalProperties: + type: integer + minimum: 0 + maximum: 65535 + minProperties: 1 + + ScpDomainCond: + description: > + Subscription to a set of NF or SCP or SEPP instances belonging to certain SCP domains + type: object + required: + - scpDomains + properties: + scpDomains: + type: array + items: + type: string + minItems: 1 + nfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + + OptionsResponse: + description: Communication options of the NRF sent in response content of OPTIONS method + type: object + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + ConditionEventType: + description: > + Indicates whether a notification is due to the NF Instance to start or stop + being part of a condition for a subscription to a set of NFs + anyOf: + - type: string + enum: + - NF_ADDED + - NF_REMOVED + - type: string + + SuciInfo: + description: SUCI information containing Routing Indicator and Home Network Public Key ID + type: object + properties: + routingInds: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + hNwPubKeyIds: + type: array + items: + type: integer + minItems: 1 + + SeppInfo: + description: Information of a SEPP Instance + type: object + properties: + seppPrefix: + type: string + seppPorts: + description: > + Port numbers for HTTP and HTTPS. The key of the map shall be "http" or "https". + type: object + additionalProperties: + type: integer + minimum: 0 + maximum: 65535 +``` + +``` + + minProperties: 1 + remotePlmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + remoteSnpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + n32Purposes: + description: N32 purposes supported by the SEPP + type: array + items: + $ref: 'TS29573_N32_Handshake.yaml#/components/schemas/N32Purpose' + minItems: 1 + + IpReachability: + description: Indicates the type(s) of IP addresses reachable via an SCP + anyOf: + - type: string + enum: + - IPV4 + - IPV6 + - IPV4V6 + - type: string + + UriList: + description: > + Represents a set of URIs following the 3GPP hypermedia format + (containing a "_links" attribute). + type: object + properties: + _links: + type: object + description: > + List of the URI of NF instances. It has two members whose names are item and self. + The item attribute contains an array of URIs. + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LinksValueSchema' + minProperties: 1 + totalItemCount: + type: integer + + AanfInfo: + description: Represents the information relative to an AAnF NF Instance. + type: object + properties: + routingIndicators: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + + 5GDdnmfInfo: + description: Information of an 5G DDNMF NF Instance + type: object + required: + - plmnId + properties: + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + + WildcardDnai: + description: Wildcard DNAI + type: string + pattern: '^[*]$' + + MfafInfo: + description: Information of a MFAF NF Instance + type: object + properties: + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + +``` + +``` + minItems: 1 + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + tailList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + +NwdafCapability: + description: Indicates the capability supported by the NWDAF + type: object + properties: + analyticsAggregation: + type: boolean + default: false + analyticsMetadataProvisioning: + type: boolean + default: false + mlModelAccuracyChecking: + type: boolean + default: false + analyticsAccuracyChecking: + type: boolean + default: false + roamingExchange: + type: boolean + default: false + +EasdfInfo: + description: Information of an EASDF NF Instance + type: object + properties: + sNssaiEasdfInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiEasdfInfoItem' + minItems: 1 + easdfN6IpAddressList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + upfN6IpAddressList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + +SnssaiEasdfInfoItem: + description: Set of parameters supported by EASDF for a given S-NSSAI + type: object + required: + - sNssai + - dnnEasdfInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnEasdfInfoList: + type: array + items: + $ref: '#/components/schemas/DnnEasdfInfoItem' + minItems: 1 + +DnnEasdfInfoItem: + description: Set of parameters supported by EASDF for a given DNN + type: object + required: + - dnn + properties: +``` + +``` +dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' +dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + +DccfInfo: + description: Information of a DCCF NF Instance + type: object + properties: + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + tailList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + dataSubsRelocInd: + type: boolean + default: false + +ScpCapability: + description: Indicates the capabilities supported by an SCP + anyOf: + - type: string + enum: + - INDIRECT_COM_WITH_DELEG_DISC + - type: string + +NsacfInfo: + description: Information of a NSACF NF Instance + type: object + required: + - nsacfCapability + properties: + nsacfCapability: + $ref: '#/components/schemas/NsacfCapability' + snssaiListForEntirePlmn: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + tailList: + deprecated: true + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + deprecated: true + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + nsacSaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NsacSai' + minItems: 1 + +NsacfCapability: +``` + +``` +description: > + NSACF service capabilities (e.g. to monitor and control the number of registered UEs + or established PDU sessions per network slice) +type: object +properties: + supportUeSAC: + description: | + Indicates the service capability of the NSACF to monitor and control the number of + registered UEs per network slice for the network slice that is subject to NSAC + true: Supported + false (default): Not Supported + type: boolean + default: false + supportPduSAC: + description: | + Indicates the service capability of the NSACF to monitor and control the number of + established PDU sessions per network slice for the network slice that is subject to NSAC + true: Supported + false (default): Not Supported + type: boolean + default: false + supportUeWithPduSAC: + description: | + Indicates the service capability of the NSACF to control the number of registered UEs + with at least one PDU session / PDN connection per network slice for the network slice + that is subject to NSAC, if EPS counting is supported by the NSACF. + true: Supported + false (default): Not Supported + type: boolean + default: false + +DccfCond: + description: > + Subscription to a set of NF Instances (DCCFs), identified by NF types, NF Set Id(s) + or DCCF Serving Area information, i.e. list of TAIs served by the DCCF + type: object + required: + - conditionType + properties: + conditionType: + type: string + enum: [ DCCF_COND ] + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + +MIAnalyticsInfo: + description: ML Analytics Filter information supported by the Nnwdaf_MLModelProvision service + type: object + properties: + mlAnalyticsIds: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEvent' + minItems: 1 + snssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + trackingAreaList: +``` + +``` +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' +minItems: 1 +mlModelInterInfo: + $ref: '#/components/schemas/MlModelInterInfo' +flCapabilityType: + $ref: '#/components/schemas/FlCapabilityType' +flTimeInterval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +nfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 +nfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + +MbSmfInfo: + description: Information of an MB-SMF NF Instance + type: object + properties: + sNssaiInfoList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/SnssaiMbSmfInfoItem' + minProperties: 1 + tmgiRangeList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/TmgiRange' + minProperties: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + mbsSessionList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/MbsSession' + minProperties: 1 + +TmgiRange: + description: Range of TMGIs + type: object + required: + - mbsServiceIdStart + - mbsServiceIdEnd + - plmnId + properties: + mbsServiceIdStart: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + mbsServiceIdEnd: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + nid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Nid' + +MbsSession: + description: MBS Session currently served by an MB-SMF + type: object + required: + - mbsSessionId + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' +``` + +``` +mbsAreaSessions: + description: A map (list of key-value pairs) where the key identifies an areaSessionId + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceAreaInfo' + minProperties: 1 + +SnssaiMbSmfInfoItem: + description: Parameters supported by an MB-SMF for a given S-NSSAI + type: object + required: + - sNssai + - dnnInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnInfoList: + type: array + items: + $ref: '#/components/schemas/DnnMbSmfInfoItem' + minItems: 1 + +DnnMbSmfInfoItem: + description: Parameters supported by an MB-SMF for a given DNN + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + +TsctsFInfo: + description: Information of a TSCTSF NF Instance + type: object + properties: + sNssaiInfoList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/SNSSAI_TsctsFInfoItem' + minProperties: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + internalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/InternalGroupIdRange' + minItems: 1 + +SnssaiTsctsFInfoItem: + description: Set of parameters supported by TSCTSF for a given S-NSSAI + type: object + required: + - sNssai + - dnnInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnInfoList: + type: array + items: + $ref: '#/components/schemas/DnnTsctsFInfoItem' + minItems: 1 + +DnnTsctsFInfoItem: +``` + +``` +description: Parameters supported by an TSCTSF for a given DNN +type: object +required: +- dnn +properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + +MbUpfInfo: +description: Information of an MB-UPF NF Instance +type: object +required: +- sNssaiMbUpfInfoList +properties: + sNssaiMbUpfInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiUpfInfoItem' + minItems: 1 + mbSmfServingArea: + type: array + items: + type: string + minItems: 1 + interfaceMbUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + priority: + type: integer + minimum: 0 + maximum: 65535 + supportedPfcpFeatures: + type: string + +UnTrustAfInfo: +description: Information of a untrusted AF Instance +type: object +required: +- afId +properties: + afId: + type: string + sNssaiInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiInfoItem' + minItems: 1 + mappingInd: + type: boolean + default: false + +TrustAfInfo: +description: Information of a trusted AF Instance +type: object +properties: + sNssaiInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiInfoItem' + minItems: 1 + afEvents: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEvent' +``` + +``` + minItems: 1 + appIds: + type: array + items: + type: string + minItems: 1 + internalGroupId: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + mappingInd: + type: boolean + default: false + tailList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + +SnssaiInfoItem: + description: > + Parameters supported by an NF for a given S-NSSAI Set of parameters supported by NF + for a given S-NSSAI + type: object + required: + - sNssai + - dnnInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnInfoList: + type: array + items: + $ref: '#/components/schemas/DnnInfoItem' + minItems: 1 + +DnnInfoItem: + description: Set of parameters supported by NF for a given DNN + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + +CollocatedNfInstance: + description: Information of an collocated NF Instance registered in the NRF + type: object + required: + - nfInstanceId + - nfType + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfType: + $ref: '#/components/schemas/CollocatedNfType' + +CollocatedNfType: + description: NF types for a collocated NF + anyOf: + - type: string + enum: + - UPF + - SMF + - MB_UPF + - MB_SMF + - type: string + +PlmnOAuth2: + description: OAuth2.0 required indication for a given PLMN ID +``` + +``` +type: object +properties: + oauth2RequiredPlmnIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + oauth2NotRequiredPlmnIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + +V2xCapability: + description: Indicate the supported V2X Capability by the PCF. + type: object + properties: + lteV2x: + type: boolean + default: false + nrV2x: + type: boolean + default: false + +NssaaInfo: + description: Information of a NSSAAF Instance + type: object + properties: + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + internalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/InternalGroupIdRange' + minItems: 1 + +ProSeCapability: + description: Indicate the supported ProSe Capability by the PCF. + type: object + properties: + proseDirectDiscover: + type: boolean + default: false + proseDirectCommunication: + type: boolean + default: false + proseL2UetoNetworkRelay: + type: boolean + default: false + proseL3UetoNetworkRelay: + type: boolean + default: false + proseL2RemoteUe: + type: boolean + default: false + proseL3RemoteUe: + type: boolean + default: false + proseL2UetoUeRelay: + type: boolean + default: false + proseL3UetoUeRelay: + type: boolean + default: false + proseL2EndUe: + type: boolean + default: false + proseL3EndUe: + type: boolean + default: false + +SubscriptionContext: + description: > + Context data related to a created subscription, to be included in notifications sent by NRF + type: object +``` + +``` + required: + - subscriptionId + properties: + subscriptionId: + type: string + subscrCond: + $ref: '#/components/schemas/SubscrCond' + + IwmscInfo: + description: Information of an SMS-IWMSC NF Instance + type: object + properties: + msisdnRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + scNumber: + type: string + pattern: '^[0-9]{5,15}$' + + MnpfInfo: + description: Information of an MNPF Instance + type: object + properties: + msisdnRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + required: + - msisdnRanges + + DefSubServiceInfo: + description: Service Specific information for Default Notification Subscription. + type: object + properties: + versions: + type: array + items: + type: string + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + LocalityDescriptionItem: + description: Locality description item + type: object + properties: + localityType: + $ref: '#/components/schemas/LocalityType' + localityValue: + type: string + required: + - localityType + - localityValue + + LocalityDescription: + description: Locality description + type: object + properties: + localityType: + $ref: '#/components/schemas/LocalityType' + localityValue: + type: string + addlLocDescItems: + type: array + items: +``` + +``` +$ref: '#/components/schemas/LocalityDescriptionItem' +minItems: 1 +required: +- localityType +- localityValue + +LocalityType: +description: > +Type of locality description. An operator may define custom locality type values other +than those listed in this enumeration. +anyOf: +- type: string +enum: +- DATA_CENTER +- CITY +- COUNTY +- DISTRICT +- STATE +- CANTON +- REGION +- PROVINCE +- PREFECTURE +- COUNTRY +- type: string + +SmsfInfo: +description: Specific Data for SMSF +type: object +properties: +roamingUeInd: +type: boolean +remotePlmnRangeList: +type: array +items: +$ref: '#/components/schemas/PlmnRange' +minItems: 1 + +DcsfInfo: +description: Information of a DCSF NF Instance +type: object +properties: +imsDomainNameList: +type: array +items: +$ref: '#/components/schemas/ImsDomainName' +imsiRanges: +type: array +items: +$ref: '#/components/schemas/ImsiRange' +minItems: 1 +imsPrivateIdentityRanges: +type: array +items: +$ref: '#/components/schemas/IdentityRange' +minItems: 1 +imsPublicIdentityRanges: +type: array +items: +$ref: '#/components/schemas/IdentityRange' +minItems: 1 +msisdnRanges: +type: array +items: +$ref: '#/components/schemas/IdentityRange' +minItems: 1 + +ImsDomainName: +description: IMS Domain Name +type: string + +MLModelInterInfo: +description: ML Model Interoperability Information +type: object +properties: +vendorList: +type: array +items: +$ref: '#/components/schemas/VendorId' +``` + +``` +minItems: 1 + +PruExistenceInfo: + description: PRU Existence Information + type: object + properties: + tailList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + +FlCapabilityType: + description: > + Type of Federated Learning Capability. + anyOf: + - type: string + enum: + - FL_SERVER + - FL_CLIENT + - FL_SERVER_AND_CLIENT + - type: string + +MrfInfo: + description: Information of a Mrf NF Instance + type: object + properties: + mediaCapabilityList: + type: array + items: + $ref: '#/components/schemas/MediaCapability' + minItems: 1 + +MrfpInfo: + description: Information of a Mrfp NF Instance + type: object + properties: + mediaCapabilityList: + type: array + items: + $ref: '#/components/schemas/MediaCapability' + minItems: 1 + +MfInfo: + description: Information of a MF NF Instance + type: object + properties: + mediaCapabilityList: + type: array + items: + $ref: '#/components/schemas/MediaCapability' + minItems: 1 + +EpdgInfo: + description: Information of the ePDG end-points + type: object + anyOf: + - required: [ ipv4EndpointAddresses ] + - required: [ ipv6EndpointAddresses ] + properties: + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + +MediaCapability: + description: media capability offered by NF instance +``` + +``` +type: string +pattern: '^[a-zA-Z0-9_-]+$' + +A2xCapability: + description: Indicate the supported A2X Capability by the PCF. + type: object + properties: + lteA2x: + type: boolean + default: false + nrA2x: + type: boolean + default: false + +RuleSet: + type: object + required: + - priority + - action + properties: + priority: + type: integer + minimum: 0 + maximum: 65535 + plmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + snpns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + nfTypes: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + nfDomains: + type: array + items: + type: string + minItems: 1 + nssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + nfInstances: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + scopes: + type: array + items: + type: string + minItems: 1 + action: + $ref: '#/components/schemas/RuleSetAction' + +RuleSetAction: + anyOf: + - type: string + enum: + - ALLOW + - DENY + - type: string + +AdrfInfo: + description: Information of an ADRF NF Instance + type: object + properties: + mlModelStorageInd: + type: boolean + default: false + dataStorageInd: + type: boolean +``` + +``` +default: false + +SelectionConditions: + description: > + It contains the set of conditions that shall be evaluated to determine whether a consumer + shall select a given producer. The producer shall only be selected if the evaluation of + the conditions is . The set of conditions can be represented by a single + ConditionItem or by a ConditionGroup, where the latter contains a (recursive) list of + conditions joined by the "and" or "or" logical relationships. + oneOf: + - $ref: '#/components/schemas/ConditionItem' + - $ref: '#/components/schemas/ConditionGroup' + +ConditionGroup: + description: > + List (array) of conditions (joined by the "and" or "or" logical relationship), + under which an NF Instance with an NFStatus or NFServiceStatus value set to "CANARY_RELEASE" + shall be selected by an NF Service Consumer. + type: object + oneOf: + - required: [ and ] + - required: [ or ] + properties: + and: + type: array + items: + $ref: '#/components/schemas/SelectionConditions' + minItems: 1 + or: + type: array + items: + $ref: '#/components/schemas/SelectionConditions' + minItems: 1 + +ConditionItem: + description: > + A ConditionItem consists of a number of attributes representing individual conditions + (e.g. a SUPI range, or a TAI list). If several attributes/conditions are present, + the evaluation of the ConditionItem is if all attributes/conditions are evaluated + as (i.e., it follows the AND logical relationship). + type: object + properties: + consumerNfTypes: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + serviceFeature: + type: integer + minimum: 1 + vsServiceFeature: + type: integer + minimum: 1 + supiRangeList: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRangeList: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + impuRangeList: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + impiRangeList: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + peiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + minItems: 1 +``` + +``` + + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + +CallbackUriPrefixItem: + description: callback URI prefix value to be used for specific notification types + type: object + properties: + callbackUriPrefix: + type: string + notificationTypes: + type: array + items: + type: string + required: + - callbackUriPrefix + - notificationTypes + +``` + +## A.3 Nnrf\_NFDiscovery API + +openapi: 3.0.0 + +``` + +info: + version: '1.3.0-alpha.6' + title: 'NRF NFDiscovery Service' + description: | + NRF NFDiscovery Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.510 V18.5.0; 5G System; Network Function Repository Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' + +servers: + - url: '{apiRoot}/nnrf-disc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnrf-disc + - oAuth2ClientCredentials: + - nnrf-disc + - nnrf-disc:nf-instances:read-complete-profile + +paths: + /nf-instances: + get: + summary: Search a collection of NF Instances + operationId: SearchNFInstances + tags: + - NF Instances (Store) + parameters: + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: target-nf-type + in: query + description: Type of the target NF + required: true + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + +``` + +- name: requester-nf-type +in: query +description: Type of the requester NF +required: true +schema: +\$ref: 'TS29510\_Nnrf\_NFManagement.yaml#/components/schemas/NFType' +- name: preferred-collocated-nf-types +in: query +description: collocated NF types that candidate NFs should preferentially support +schema: +type: array +items: +\$ref: 'TS29510\_Nnrf\_NFManagement.yaml#/components/schemas/CollocatedNFType' +minItems: 1 +style: form +explode: false +- name: requester-nf-instance-id +in: query +description: NfInstanceId of the requester NF +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/NfInstanceId' +- name: service-names +in: query +description: Names of the services offered by the NF +schema: +type: array +items: +\$ref: 'TS29510\_Nnrf\_NFManagement.yaml#/components/schemas/ServiceName' +minItems: 1 +uniqueItems: true +style: form +explode: false +- name: requester-nf-instance-fqdn +in: query +description: FQDN of the requester NF +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Fqdn' +- name: target-plmn-list +in: query +description: > +Id of the PLMN of either the target NF, or in SNPN scenario the Credentials Holder +in the PLMN +content: +application/json: +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/PlmnId' +minItems: 1 +- name: requester-plmn-list +in: query +description: Id of the PLMN where the NF issuing the Discovery request is located +content: +application/json: +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/PlmnId' +minItems: 1 +- name: target-nf-instance-id +in: query +description: Identity of the NF instance being discovered +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/NfInstanceId' +- name: target-nf-instance-id-list +in: query +description: Identities of the NF instances being discovered +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/NfInstanceId' +minItems: 2 +style: form +explode: false +- name: target-nf-fqdn +in: query +description: FQDN of the NF instance being discovered +schema: + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +- name: hnrf-uri + in: query + description: Uri of the home NRF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +- name: snssais + in: query + description: Slice info of the target NF + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + minItems: 1 +- name: additional-snssais + in: query + description: Additional Slices supported by the target NF (Service) instances + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +- name: requester-snssais + in: query + description: Slice info of the requester NF + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +- name: plmn-specific-snssai-list + in: query + description: PLMN specific Slice info of the target NF + content: + application/json: + schema: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PlmnSnssai' + minItems: 1 +- name: requester-plmn-specific-snssai-list + in: query + description: PLMN-specific slice info of the NF issuing the Discovery request + content: + application/json: + schema: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PlmnSnssai' + minItems: 1 +- name: dnn + in: query + description: Dnn supported by the BSF, SMF or UPF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +- name: ipv4-index + in: query + description: The IPv4 Index supported by the candidate UPF. + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpIndex' +- name: ipv6-index + in: query + description: The IPv6 Index supported by the candidate UPF. + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpIndex' +- name: nsi-list + in: query + description: NSI IDs that are served by the services being discovered +``` + +``` +schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false +- name: smf-serving-area + in: query + schema: + type: string +- name: mbsmf-serving-area + in: query + schema: + type: string +- name: tai + in: query + description: Tracking Area Identity + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' +- name: amf-region-id + in: query + description: AMF Region Identity + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId' +- name: amf-set-id + in: query + description: AMF Set Identity + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfSetId' +- name: guami + in: query + description: Guami used to search for an appropriate AMF + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' +- name: supi + in: query + description: SUPI of the user + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +- name: ue-ipv4-address + in: query + description: IPv4 address of the UE + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +- name: ip-domain + in: query + description: IP domain of the UE, which supported by BSF + schema: + type: string +- name: ue-ipv6-prefix + in: query + description: IPv6 prefix of the UE + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +- name: pgw-ind + in: query + description: Combined PGW-C and SMF or a standalone SMF + schema: + type: boolean +- name: preferred-pgw-ind + in: query + description: Indicates combined PGW-C+SMF or standalone SMF are preferred + schema: + type: boolean +- name: pgw + in: query + description: PGW FQDN of a combined PGW-C and SMF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +- name: pgw-ip + in: query + description: PGW IP Address of a combined PGW-C and SMF + content: +``` + +``` + + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddress' +- name: gpsi + in: query + description: GPSI of the user + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' +- name: external-group-identity + in: query + description: external group identifier of the user + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' +- name: internal-group-identity + in: query + description: internal group identifier of the user + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' +- name: pfd-data + in: query + description: PFD data + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PfdData' +- name: data-set + in: query + description: data set supported by the NF + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DataSetId' +- name: routing-indicator + in: query + description: routing indicator in SUCI + schema: + type: string + pattern: '^[0-9]{1,4}$' +- name: group-id-list + in: query + description: Group IDs of the NFs being discovered + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + minItems: 1 + style: form + explode: false +- name: dnai-list + in: query + description: Data network access identifiers of the NFs being discovered + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + style: form + explode: false +- name: pdu-session-types + in: query + description: list of PDU Session Type required to be supported by the target NF + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + style: form + explode: false +- name: event-id-list + in: query + description: > + Analytics event(s) requested to be supported by the Nnwdaf_AnalyticsInfo service + schema: + type: array + items: + $ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventId' + minItems: 1 + style: form + explode: false +- name: nwdaf-event-list + +``` + +``` +in: query +description: > + Analytics event(s) requested to be supported by the Nnwdaf_EventsSubscription service. +schema: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + minItems: 1 + style: form + explode: false +- name: upf-event-list + in: query + description: > + Event(s) requested to be supported by the Nupf_EventExposure service. + schema: + type: array + items: + $ref: 'TS29564_Nupf_EventExposure.yaml#/components/schemas/EventType' + minItems: 1 + style: form + explode: false +- name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: upf-iwk-eps-ind + in: query + description: UPF supporting interworking with EPS or not + schema: + type: boolean +- name: chf-supported-plmn + in: query + description: PLMN ID supported by a CHF + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +- name: preferred-locality + in: query + description: preferred target NF location + schema: + type: string +- name: ext-preferred-locality + in: query + description: > + preferred target NF location + A map (list of key-value pairs) where the key of the map represents the relative + priority, for the requester, of each locality description among the list of locality + descriptions in this query parameter, encoded as "1" (highest priority), "2", "3", ..., + "n" (lowest priority) + content: + application/json: + schema: + type: object + additionalProperties: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/LocalityDescription' + minItems: 1 + minProperties: 1 +- name: access-type + in: query + description: AccessType supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' +- name: limit + in: query + description: Maximum number of NFProfiles to return in the response + required: false + schema: + type: integer + minimum: 1 +- name: required-features + in: query + description: Features required to be supported by the target NF + schema: + type: array +``` + +``` +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +minItems: 1 +style: form +explode: false +- name: complex-query + in: query + description: the complex query condition expression + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ComplexQuery' +- name: max-payload-size + in: query + description: Maximum content size of the response expressed in kilo octets + required: false + schema: + type: integer + maximum: 2000 + default: 124 +- name: max-payload-size-ext + in: query + description: > + Extended query for maximum content size of the response expressed in kilo octets + required: false + schema: + type: integer + default: 124 +- name: atsss-capability + in: query + description: ATSSS Capability + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AtsssCapability' +- name: upf-ue-ip-addr-ind + in: query + description: UPF supporting allocating UE IP addresses/prefixes + schema: + type: boolean +- name: client-type + in: query + description: Requested client type served by the NF + content: + application/json: + schema: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType' +- name: lmf-id + in: query + description: LMF identification to be discovered + content: + application/json: + schema: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' +- name: an-node-type + in: query + description: Requested AN node type served by the NF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AnNodeType' +- name: rat-type + in: query + description: Requested RAT type served by the NF + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' +- name: preferred-tai + in: query + description: preferred Tracking Area Identity + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' +- name: preferred-nf-instances + in: query + description: preferred NF Instances +``` + +``` +schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + style: form + explode: false +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in IETF RFC 9110, 13.1.2 + schema: + type: string +- name: target-snpn + in: query + description: Target SNPN Identity, or the Credentials Holder in the SNPN + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' +- name: requester-snpn-list + in: query + description: SNPN ID(s) of the NF instance issuing the Discovery request + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 +- name: af-ee-data + in: query + description: NEF exposured by the AF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AfEventExposureData' +- name: w-agf-info + in: query + description: UPF collocated with W-AGF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/WAgfInfo' +- name: tngf-info + in: query + description: UPF collocated with TNGF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TngfInfo' +- name: twif-info + in: query + description: UPF collocated with TWIF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TwifInfo' +- name: upf-select-epdg-info + in: query + description: The ePDG information to find a preferred UPF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/EpdgInfo' +- name: target-nf-set-id + in: query + description: Target NF Set ID + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +- name: target-nf-service-set-id + in: query + description: Target NF Service Set ID + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' +- name: nef-id + in: query + description: NEF ID + schema: +``` + +``` + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NefId' +- name: notification-type + in: query + description: Notification Type + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NotificationType' +- name: n1-msg-class + in: query + description: N1 Message Class + schema: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N1MessageClass' +- name: n2-info-class + in: query + description: N2 Information Class + schema: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InformationClass' +- name: serving-scope + in: query + description: areas that can be served by the target NF + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false +- name: imsi + in: query + description: IMSI of the requester UE to search for an appropriate NF (e.g. HSS, DCSF) + schema: + type: string + pattern: '^[0-9]{5,15}$' +- name: ims-private-identity + in: query + description: IMPI of the requester UE to search for a target HSS or DCSF + schema: + type: string +- name: ims-public-identity + in: query + description: IMS Public Identity of the requester UE to search for a target HSS or DCSF + schema: + type: string +- name: msisdn + in: query + description: MSISDN of the requester UE to search for a target HSS or DCSF + schema: + type: string +- name: preferred-api-versions + in: query + description: Preferred API version of the services to be discovered + content: + application/json: + schema: + description: A map (list of key-value pairs) where ServiceName serves as key + type: object + additionalProperties: + type: string + minProperties: 1 +- name: v2x-support-ind + in: query + description: PCF supports V2X + schema: + type: boolean +- name: redundant-gtpu + in: query + description: UPF supports redundant gtp-u to be discovered + schema: + type: boolean +- name: redundant-transport + in: query + description: UPF supports redundant transport path to be discovered + schema: + type: boolean +- name: ipups + in: query + description: UPF which is configured for IPUPS functionality to be discovered + schema: + type: boolean +``` + +- name: sxa-ind +in: query +description: UPF which is configured to support sxa interface +schema: +type: boolean +- name: scp-domain-list +in: query +description: SCP domains the target SCP or SEPP belongs to +schema: +type: array +items: +type: string +minItems: 1 +style: form +explode: false +- name: address-domain +in: query +description: Address domain reachable through the SCP +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Fqdn' +- name: ipv4-addr +in: query +description: IPv4 address reachable through the SCP +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv4Addr' +- name: ipv6-prefix +in: query +description: IPv6 prefix reachable through the SCP +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv6Prefix' +- name: served-nf-set-id +in: query +description: NF Set ID served by the SCP +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/NfSetId' +- name: remote-plmn-id +in: query +description: Id of the PLMN reachable through the SCP or SEPP +content: +application/json: +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/PlmnId' +- name: remote-snpn-id +in: query +description: Id of the SNPN reachable through the SCP or SEPP +content: +application/json: +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/PlmnIdNid' +- name: data-forwarding +in: query +description: UPF Instance(s) configured for data forwarding are requested +schema: +type: boolean +- name: preferred-full-plmn +in: query +description: NF Instance(s) serving the full PLMN are preferred +schema: +type: boolean +- name: requester-features +in: query +description: > +Features supported by the NF Service Consumer that is invoking +the Nnrf\_NFDiscovery service +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: realm-id +in: query +description: realm-id to search for an appropriate UDSF +schema: +type: string +- name: storage-id +in: query +description: storage-id to search for an appropriate UDSF +schema: +type: string +- name: vsmf-support-ind +in: query + +``` + +description: V-SMF capability supported by the target NF instance(s) +schema: + type: boolean +- name: ismf-support-ind + in: query + description: I-SMF capability supported by the target NF instance(s) + schema: + type: boolean +- name: nrf-disc-uri + in: query + description: Uri of the NRF holding the NF profile of a target NF Instance + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +- name: preferred-vendor-specific-features + in: query + description: Preferred vendor specific features of the services to be discovered + content: + application/json: + schema: + description: A map (list of key-value pairs) where ServiceName serves as key + type: object + additionalProperties: + description: > + A map (list of key-value pairs) where IANA-assigned SMI Network Management + Private Enterprise Codes serves as key + type: object + additionalProperties: + type: array + items: + $ref: + 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 + maxProperties: 1 +- name: preferred-vendor-specific-nf-features + in: query + description: Preferred vendor specific features of the network function to be discovered + content: + application/json: + schema: + description: > + A map (list of key-value pairs) where IANA-assigned SMI Network Management Private + Enterprise Codes serves as key + type: object + additionalProperties: + type: array + items: + $ref: + 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 + maxProperties: 1 +- name: required-pfcp-features + in: query + description: PFCP features required to be supported by the target UPF + schema: + type: string +- name: home-pub-key-id + in: query + description: > + Indicates the Home Network Public Key ID which shall be able to be served + by the NF instance + schema: + type: integer +- name: prose-support-ind + in: query + description: PCF supports ProSe Capability + schema: + type: boolean +- name: analytics-aggregation-ind + in: query + description: analytics aggregation is supported by NWDAF or not + schema: + type: boolean +- name: serving-nf-set-id + in: query + description: NF Set Id served by target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + +``` + +- name: serving-nf-type +in: query +description: NF type served by the target NF +schema: +\$ref: 'TS29510\_Nnrf\_NFManagement.yaml#/components/schemas/NFType' +- name: ml-analytics-info-list +in: query +description: List of ML Analytics Filter information of Nnwdaf\_ModelProvision service +content: +application/json: +schema: +type: array +items: +\$ref: 'TS29510\_Nnrf\_NFManagement.yaml#/components/schemas/MLAnalyticsInfo' +minItems: 1 +- name: analytics-metadata-prov-ind +in: query +description: analytics metadata provisioning is supported by NWDAF or not +schema: +type: boolean +- name: nsacf-capability +in: query +description: the service capability supported by the target NSACF +schema: +\$ref: 'TS29510\_Nnrf\_NFManagement.yaml#/components/schemas/NsacfCapability' +- name: mbs-session-id-list +in: query +description: List of MBS Session ID(s) +content: +application/json: +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/MbsSessionId' +minItems: 1 +- name: area-session-id +in: query +description: Area Session ID +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/AreaSessionId' +- name: gmlc-number +in: query +description: The GMLC Number supported by the GMLC +schema: +type: string +pattern: '^[0-9]{5,15}\$' +- name: upf-n6-ip +in: query +description: N6 IP address of PSA UPF supported by the EASDF +content: +application/json: +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/IpAddress' +- name: tai-list +in: query +description: Tracking Area Identifiers of the NFs being discovered +content: +application/json: +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Tai' +minItems: 1 +- name: nf-tai-list-ind +in: query +description: the NF service consumer supports candidate nfs supporting a subset of TAIs +schema: +type: boolean +enum: +- true +- name: preferences-precedence +in: query +description: > +Indicates the precedence of the preference query parameters (from higher to lower) +schema: +type: array +items: +type: string + +``` + minItems: 2 + style: form + explode: false +- name: support-onboarding-capability + in: query + description: Indicating the support for onboarding. + schema: + type: boolean + default: false +- name: uas-nf-functionality-ind + in: query + description: UAS NF functionality is supported by NEF or not + schema: + type: boolean +- name: multi-mem-af-sess-qos-ind + in: query + description: Multi-member AF session with required QoS is supported by NEF or not + schema: + type: boolean + enum: + - true +- name: member-ue-sel-assist-ind + in: query + description: member UE selection assistance functionality is supported by NEF or not + schema: + type: boolean + enum: + - true +- name: v2x-capability + in: query + description: indicates the V2X capability that the target PCF needs to support. + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/V2xCapability' +- name: prose-capability + in: query + description: indicates the ProSe capability that the target PCF needs to support. + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ProSeCapability' +- name: shared-data-id + in: query + description: Identifier of shared data stored in the NF being discovered + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SharedDataId' +- name: target-hni + in: query + description: Home Network Identifier query. + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +- name: target-nw-resolution + in: query + description: Resolution of the identity of the target PLMN based on the GPSI of the UE + schema: + type: boolean +- name: exclude-nfinst-list + in: query + description: NF Instance IDs to be excluded from the NF Discovery procedure + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + style: form + explode: false +- name: exclude-nfservinst-list + in: query + description: NF service instance IDs to be excluded from the NF Discovery procedure + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NfServiceInstance' + minItems: 1 +- name: exclude-nfserviceset-list +``` + +``` +in: query +description: NF Service Set IDs to be excluded from the NF Discovery procedure +schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + minItems: 1 + style: form + explode: false +- name: exclude-nfset-list + in: query + description: NF Set IDs to be excluded from the NF Discovery procedure + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + style: form + explode: false +- name: preferred-analytics-delays + in: query + description: Preferred analytics delays supported by the NWDAF to be discovered + content: + application/json: + schema: + description: > + A map (list of key-value pairs) where EventId or NwdafEvent serves as key + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + minProperties: 1 +- name: high-latency-com + in: query + description: Indicating the support for High Latency communication. + schema: + type: boolean + enum: + - true +- name: nsac-sai + in: query + description: NSAC Service Area Identifier + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NsacSai' +- name: complete-profile + in: query + description: request to discover the complete profile of NF instances + schema: + type: boolean + enum: + - true +- name: n32-purposes + in: query + description: N32 purposes to be supported by the SEPP + schema: + type: array + items: + $ref: 'TS29573_N32_Handshake.yaml#/components/schemas/N32Purpose' + minItems: 1 + style: form + explode: false +- name: preferred-features + in: query + description: Preferred features to be supported by the target Network Function. + content: + application/json: + schema: + description: > + A map (list of key-value pairs) where Service Name serves as the key. + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + minProperties: 1 +- name: remote-plmn-id-roaming + in: query + description: Id of the remote PLMN served by the target NF service producer + content: + application/json: + schema: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +- name: pru-tai + in: query + description: LMF(s) serving the TAI with PRU(s) existence + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' +- name: pru-support-ind + in: query + description: Indicating the support of PRU function + schema: + type: boolean +- name: af-data + in: query + description: events supported by the trusted AFs being discovered + content: + application/json: + schema: + $ref: '#/components/schemas/AfData' +- name: ml-accuracy-checking-ind + in: query + description: Indicating the support for ML Model Accuracy checking. + schema: + type: boolean + enum: + - true +- name: analytics-accuracy-checking-ind + in: query + description: Indicating the support for Analytics Accuracy checking. + schema: + type: boolean + enum: + - true +- name: a2x-support-ind + in: query + description: PCF supports A2X + schema: + type: boolean +- name: a2x-capability + in: query + description: indicates the A2X capability that the target PCF needs to support. + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/A2xCapability' +- name: ml-model-storage-ind + in: query + description: Indicating the support for ML model storage and retrieval capability. + schema: + type: boolean + enum: + - true +- name: data-storage-ind + in: query + description: > + Indicating the support for data and analytics storage and retrieval capability. + schema: + type: boolean + enum: + - true +- name: data-subscription-relocation-support-ind + in: query + description: Indicating the support for relocation of data subscription. + schema: + type: boolean + enum: + - true +- name: ims-domain-name + in: query + description: Indicating the IMS domain name to search for a target DCSF. + schema: + type: string +- name: media-capability-list + in: query + description: Indicating the media capability list to search for a target MF, MRF or MRFP. + schema: + type: array +``` + +``` + + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MediaCapability' + minItems: 1 + style: form + explode: false +- name: roaming-exchange-ind + in: query + description: Indicating the support for roaming exchange. + schema: + type: boolean + enum: + - true +- name: ranging-sl-pos-support-ind + in: query + description: PCF or LMF supports ranging and sidelink positioning Capability + schema: + type: boolean + enum: + - true +- name: preferred-up-positioning-ind + in: query + description: LMF supporting user plane positioning capability + schema: + type: boolean + enum: + - true +- name: complete-search-result + in: query + description: > + Indicates that all the NF profiles or NF Instance IDs matching the query parameters + are requested to be returned + schema: + type: boolean + enum: + - true + +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SearchResult' + links: + search: + operationId: RetrieveStoredSearch + parameters: + searchId: $response.body#/searchId + description: > + The 'searchId' parameter returned in the response can be used as the + 'searchId' parameter in the GET request to '/searches/{searchId}' + completeSearch: + operationId: RetrieveCompleteSearch + parameters: + searchId: $response.body#/searchId + description: > + The 'searchId' parameter returned in the response can be used as the + 'searchId' parameter in the GET request to '/searches/{searchId}/complete' + headers: + Cache-Control: + description: Cache-Control containing max-age, described in IETF RFC 9111, 5.2 + schema: + type: string + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + +``` + +``` +headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string +'308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' +headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/searches/{searchId}: + get: + operationId: RetrieveStoredSearch + tags: + - Stored Search (Document) + parameters: + - $ref: '#/components/parameters/searchId' + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + responses: + '200': + $ref: '#/components/responses/200' + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' +``` + +``` + +headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + +/searches/{searchId}/complete: +get: + operationId: RetrieveCompleteSearch + tags: + - Complete Stored Search (Document) + parameters: + - $ref: '#/components/parameters/searchId' + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + responses: + '200': + $ref: '#/components/responses/200' + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + +/scp-domain-routing-info: +get: + operationId: SCPDomainRoutingInfoGet + tags: + - SCP Domain Routing Information (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-disc + - oAuth2ClientCredentials: + - nnrf-disc + - nnrf-disc:scp-domain:read + parameters: + - name: local + in: query + description: Indication of local SCP Domain Routing Information + required: false + schema: + type: boolean + default: false + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + +``` + +``` + + $ref: '#/components/schemas/ScpDomainRoutingInformation' +headers: + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string +'307': + description: Temporary Redirect + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/scp-domain-routing-info-subs: + post: + summary: Create a new subscription + operationId: ScpDomainRoutingInfoSubscribe + tags: + - SCP Domain Routing Information Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-disc + - oAuth2ClientCredentials: + - nnrf-disc + - nnrf-disc:scp-domain-subs:write + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScpDomainRoutingInfoSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ScpDomainRoutingInfoSubscription' + +``` + +``` + +headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nnrf-disc/v1/scp-domain-routing-info-subs/{subscriptionID} + required: true + schema: + type: string + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + onScpDomainRoutingInformationChange: + '{ $request.body#/callbackUri }': + post: + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + description: Notification content + content: + application/json: + schema: + $ref: '#/components/schemas/ScpDomainRoutingInfoNotification' +responses: + '204': + description: Expected response to a successful callback processing + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + +``` + +``` + + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/scp-domain-routing-info-subs/{subscriptionID}: + delete: + summary: Deletes a subscription + operationId: ScpDomainRoutingInfoUnsubscribe + tags: + - Individual SCP Domain Routing Information Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-disc + - oAuth2ClientCredentials: + - nnrf-disc + - nnrf-disc:scp-domain-subs:write + parameters: + - name: subscriptionID + in: path + required: true + description: Unique ID of the subscription to remove + schema: + type: string + responses: + '204': + description: Expected response to a successful subscription removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '/oauth2/token' + scopes: + nnrf-disc: Access to the Nnrf_NFDiscovery API + nnrf-disc:scp-domain:read: Access to read the scp-domain-routing-info resource + nnrf-disc:scp-domain-subs:write: Access to create/delete a scp-domain subscription + +resource: + + nnrf-disc:nf-instances:read-complete-profile: > + Access to the Nnrf_NFDiscovery API enabling the discovery of the complete profile + of NF instances + +parameters: + searchId: + +``` + +``` +name: searchId +in: path +description: Id of a stored search +required: true +schema: + type: string + +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/StoredSearchResult' + headers: + Cache-Control: + description: Cache-Control containing max-age, described in IETF RFC 9111, 5.2 + schema: + type: string + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + +schemas: + + SearchResult: + description: Contains the list of NF Profiles returned in a Discovery response + type: object + required: + - validityPeriod + - nfInstances + properties: + validityPeriod: + type: integer + nfInstances: + type: array + items: + $ref: '#/components/schemas/NFProfile' + completeNfInstances: + type: array + items: + $ref: '#/components/schemas/NFProfile' + minItems: 1 + searchId: + type: string + numNfInstComplete: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + preferredSearch: + $ref: '#/components/schemas/PreferredSearch' + nrfSupportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + nfInstanceList: + description: List of matching NF instances. The key of the map is the NF instance ID. + type: object + additionalProperties: + $ref: '#/components/schemas/NfInstanceInfo' + minProperties: 1 + searchResultInfo: + $ref: '#/components/schemas/SearchResultInfo' + alteredPriorityInd: + type: boolean + noProfileMatchInfo: + $ref: '#/components/schemas/NoProfileMatchInfo' + ignoredQueryParams: + type: array + items: + type: string + minItems: 1 + + StoredSearchResult: + description: > + Contains a complete search result (i.e. a number of discovered NF Instances), +``` + +``` + stored by NRF as a consequence of a prior search result +type: object +required: +- nfInstances +properties: + nfInstances: + type: array + items: + $ref: '#/components/schemas/NFProfile' + completeNfInstances: + type: array + items: + $ref: '#/components/schemas/NFProfile' + minItems: 1 + +NFProfile: + description: Information of an NF Instance discovered by the NRF + type: object + required: + - nfInstanceId + - nfType + - nfStatus + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfInstanceName: + type: string + nfType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + nfStatus: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFStatus' + collocatedNfInstances: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/CollocatedNfInstance' + minItems: 1 + plmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + sNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + perPlmnSnssaiList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PlmnSnssai' + minItems: 1 + nsiList: + type: array + items: + type: string + minItems: 1 + fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + ipv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + allowedPlmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + allowedSnpns: + type: array + items: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' +minItems: 1 +allowedNfTypes: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' +minItems: 1 +allowedNfDomains: + type: array + items: + type: string +minItems: 1 +allowedNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' +minItems: 1 +allowedRuleSet: + description: A map (list of key-value pairs) where a valid JSON pointer Id serves as key + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/RuleSet' + minProperties: 1 +capacity: + type: integer + minimum: 0 + maximum: 65535 +load: + type: integer + minimum: 0 + maximum: 100 +loadTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +locality: + type: string +extLocality: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string serves + as key representing a type of locality + type: object + additionalProperties: + type: string + minProperties: 1 +priority: + type: integer + minimum: 0 + maximum: 65535 +udrInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdrInfo' +udrInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdrInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdrInfo' + minProperties: 1 +udmInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdmInfo' +udmInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdmInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdmInfo' + minProperties: 1 +ausfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AusfInfo' +ausfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AusfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AusfInfo' + minProperties: 1 +amfInfo: +``` + +``` +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AmfInfo' +amfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AmfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AmfInfo' + minProperties: 1 +smfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SmfInfo' +smfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of SmfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SmfInfo' + minProperties: 1 +upfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UpfInfo' +upfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UpfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UpfInfo' + minProperties: 1 +pcfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PcfInfo' +pcfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of PcfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PcfInfo' + minProperties: 1 +bsfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/BsfInfo' +bsfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of BsfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/BsfInfo' + minProperties: 1 +chfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ChfInfo' +chfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of ChfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ChfInfo' + minProperties: 1 +udsfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdsfInfo' +udsfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdsfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdsfInfo' + minProperties: 1 +nwdafInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NwdafInfo' +nwdafInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of NwdafInfo + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NwdafInfo' +``` + +``` + minProperties: 1 + nefInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NefInfo' + pcscfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of PscsfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PscsfInfo' + minProperties: 1 + hssInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of HssInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/HssInfo' + minProperties: 1 + customInfo: + type: object + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + nfServicePersistence: + type: boolean + default: false + nfServices: + deprecated: true + type: array + items: + $ref: '#/components/schemas/NFService' + minItems: 1 + nfServiceList: + description: > + A map (list of key-value pairs) where serviceInstanceId serves as key of NFService + type: object + additionalProperties: + $ref: '#/components/schemas/NFService' + minProperties: 1 + defaultNotificationSubscriptions: + type: array + items: + $ref: +'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DefaultNotificationSubscription' + lmfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/LmfInfo' + gmlcInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/GmlcInfo' + snpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + nfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + servingScope: + type: array + items: + type: string + minItems: 1 + lcHSupportInd: + type: boolean + default: false + olcHSupportInd: + type: boolean + default: false + nfSetRecoveryTimeList: + description: A map (list of key-value pairs) where NfSetId serves as key of DateTime + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minProperties: 1 + serviceSetRecoveryTimeList: + description: > + A map (list of key-value pairs) where NfServiceSetId serves as key of DateTime +``` + +``` +type: object +additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +minProperties: 1 +scpDomains: +type: array +items: +type: string +minItems: 1 +scpInfo: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ScpInfo' +seppInfo: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SeppInfo' +vendorId: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorId' +supportedVendorSpecificFeatures: +description: > + The key of the map is the IANA-assigned SMI Network Management Private Enterprise Codes +type: object +additionalProperties: +type: array +items: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorSpecificFeature' +minItems: 1 +minProperties: 1 +aanfInfoList: +type: object +description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AanfInfo +additionalProperties: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AanfInfo' +minProperties: 1 +mfafInfo: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MfafInfo' +easdfInfoList: +type: object +description: > + A map(list of key-value pairs) where a (unique) valid JSON string + serves as key of EasdfInfo +additionalProperties: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/EasdfInfo' +minProperties: 1 +dccfInfo: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DccfInfo' +nsacfInfoList: +description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of NsacfInfo +type: object +additionalProperties: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NsacfInfo' +minProperties: 1 +mbSmfInfoList: +description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MbSmfInfo +type: object +additionalProperties: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MbSmfInfo' +minProperties: 1 +tsctsfInfoList: +type: object +description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of TsctsfInfo +additionalProperties: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TsctsfInfo' +minProperties: 1 +mbUpfInfoList: +description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MbUpfInfo +type: object +additionalProperties: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MbUpfInfo' +minProperties: 1 +trustAfInfo: +``` + +``` +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TrustAfInfo' +nssaafInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NssaafInfo' +hniList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 +iwmscInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IwmscInfo' +mnpfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MnpfInfo' +smssfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SmsfInfo' +dcssfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of DcsfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DcsfInfo' +mrfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MrfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MrfInfo' +mrfpInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MrfpInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MrfpInfo' +mfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MfInfo' +adrfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AdrfInfo + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AdrfInfo' + minProperties: 1 + selectionConditions: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SelectionConditions' + +NFService: + description: > + Information of a given NF Service Instance; it is part of the NFProfile + of an NF Instance discovered by the NRF + type: object + required: + - serviceInstanceId + - serviceName + - versions + - scheme + - nfServiceStatus + properties: + serviceInstanceId: + type: string + serviceName: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' + versions: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFServiceVersion' + minItems: 1 + scheme: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UriScheme' + nfServiceStatus: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFServiceStatus' +``` + +``` +fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +interPlmnFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +ipEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 +apiPrefix: + type: string +callbackUriPrefixList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/CallbackUriPrefixItem' + minItems: 1 +defaultNotificationSubscriptions: + type: array + items: + $ref: + 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DefaultNotificationSubscription' + minItems: 1 +allowedPlmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 +allowedSnpns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 +allowedNfTypes: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + minItems: 1 +allowedNfDomains: + type: array + items: + type: string + minItems: 1 +allowedNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +capacity: + type: integer + minimum: 0 + maximum: 65535 +load: + type: integer + minimum: 0 + maximum: 100 +loadTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +priority: + type: integer + minimum: 0 + maximum: 65535 +recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +nfServiceSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + minItems: 1 +sNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +perPlmnSnssaiList: + type: array + items: +``` + +``` +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PlmnSnssai' +minItems: 1 +vendorId: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorId' +supportedVendorSpecificFeatures: + description: > + The key of the map is the IANA-assigned SMI Network Management Private Enterprise Codes + type: object + additionalProperties: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 +oauth2Required: + type: boolean +allowedOperationsPerNfType: + description: A map (list of key-value pairs) where NF Type serves as key + type: object + additionalProperties: + type: array + items: + type: string + minItems: 1 + minProperties: 1 +allowedOperationsPerNfInstance: + description: A map (list of key-value pairs) where NF Instance Id serves as key + type: object + additionalProperties: + type: array + items: + type: string + minItems: 1 + minProperties: 1 +allowedOperationsPerNfInstanceOverrides: + type: boolean + default: false +allowedScopesRuleSet: + description: A map (list of key-value pairs) where a valid JSON pointer Id serves as key + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/RuleSet' + minProperties: 1 +selectionConditions: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SelectionConditions' + +PreferredSearch: + description: > + Contains information on whether the returned NFProfiles match the preferred query parameters + type: object + properties: + preferredTaiMatchInd: + type: boolean + default: false + preferredFullPlmnMatchInd: + type: boolean + default: false + preferredApiVersionsMatchInd: + type: boolean + otherApiVersionsInd: + type: boolean + preferredLocalityMatchInd: + type: boolean + default: false + otherLocalityInd: + type: boolean + default: false + preferredVendorSpecificFeaturesInd: + type: boolean + default: false + preferredCollocatedNfTypeInd: + type: boolean + default: false + preferredPgwMatchInd: + type: boolean + preferredAnalyticsDelaysInd: + type: boolean + preferredFeaturesMatchInd: +``` + +``` + type: boolean + noPreferredFeaturesInd: + type: boolean + +NfInstanceInfo: + description: Contains information on an NF profile matching a discovery request + type: object + properties: + nrfDiscApiUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + preferredSearch: + $ref: '#/components/schemas/PreferredSearch' + nrfAlteredPriorities: + description: > + The key of the map is the JSON Pointer of the priority IE in the NFProfile data type + that is altered by the NRF + type: object + additionalProperties: + type: integer + minimum: 0 + maximum: 65535 + minProperties: 1 + nrfSupportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +ScpDomainRoutingInformation: + description: SCP Domain Routing Information + type: object + required: + - scpDomainList + properties: + scpDomainList: + description: | + This IE shall contain a map of SCP domain interconnection information, where + the key of the map is a SCP domain. The value of each entry shall be the + interconnectivity information of the the SCP domain indicated by the key. + An empty map indicates that there is no SCP domain currently registered in + the NRF. + type: object + additionalProperties: + $ref: '#/components/schemas/ScpDomainConnectivity' + +ScpDomainConnectivity: + description: SCP Domain Connectivity Information + type: object + required: + - connectedScpDomainList + properties: + connectedScpDomainList: + type: array + items: + type: string + +ScpDomainRoutingInfoSubscription: + description: SCP Domain Routing Information Subscription + type: object + required: + - callbackUri + properties: + callbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + reqInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + localInd: + type: boolean + default: false + +ScpDomainRoutingInfoNotification: + description: SCP Domain Routing Information Notification + type: object + required: + - routingInfo + properties: + routingInfo: + $ref: '#/components/schemas/ScpDomainRoutingInformation' + localInd: +``` + +``` + type: boolean + default: false + +NfServiceInstance: + description: NF service instance + type: object + oneOf: + - required: [ nfInstanceId ] + - required: [ nfServiceSetId ] + properties: + serviceInstanceId: + type: string + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + +NoProfileMatchInfo: + description: Provides the reason for not finding NF matching the search criteria + type: object + required: + - reason + properties: + reason: + $ref: '#/components/schemas/NoProfileMatchReason' + queryParamCombinationList: + type: array + items: + $ref: '#/components/schemas/QueryParamCombination' + minItems: 1 + +QueryParamCombination: + description: Contains a list of Query Parameters + type: object + required: + - queryParams + properties: + queryParams: + type: array + items: + $ref: '#/components/schemas/QueryParam' + minItems: 1 + +QueryParam: + description: Contains the name and value of a query parameter + type: object + required: + - name + - value + properties: + name: + type: string + value: + type: string + +NoProfileMatchReason: + description: No Profile Match Reason + anyOf: + - type: string + enum: + - REQUESTER_PLMN_NOT_ALLOWED + - TARGET_NF_SUSPENDED + - TARGET_NF_UNDISCOVERABLE + - QUERY_PARAMS_COMBINATION_NO_MATCH + - UNSPECIFIED + - type: string + +AfData: + description: Contains information supported by the trusted AF + type: object + properties: + afEvents: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEvent' + minItems: 1 + tailList: + type: array +``` + +``` + + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TaiRange' + minItems: 1 + required: + - afEvents + +SearchResultInfo: + description: Contains additional information to the search result + type: object + properties: + unsatisfiedTaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + +``` + +## A.4 Nnrf\_AccessToken API (NRF OAuth2 Authorization) + +openapi: 3.0.0 + +``` + +info: + version: '1.3.0-alpha.1' + title: 'NRF OAuth2' + description: | + NRF OAuth2 Authorization. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` + +externalDocs: + description: 3GPP TS 29.510 V18.5.0; 5G System; Network Function Repository Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' + +``` + +``` + +paths: + /oauth2/token: + post: + summary: Access Token Request + operationId: AccessTokenRequest + tags: + - Access Token Request + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AccessTokenReq' + encoding: + requesterPlmn: + contentType: application/json + requesterPlmnList: + contentType: application/json + requesterSnssaiList: + contentType: application/json + requesterSnpnList: + contentType: application/json + targetPlmn: + contentType: application/json + targetSnpn: + contentType: application/json + targetSnssaiList: + contentType: application/json + +``` + +``` + targetNsList: + style: form + explode: true + required: true + responses: + '200': + description: Successful Access Token Request + content: + application/json: + schema: + $ref: '#/components/schemas/AccessTokenRsp' + headers: + Cache-Control: + $ref: '#/components/headers/cache-control' + Pragma: + $ref: '#/components/headers/pragma' + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '400': + description: Error in the Access Token Request + content: + application/json: + schema: + $ref: '#/components/schemas/AccessTokenErr' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + headers: + Cache-Control: + $ref: '#/components/headers/cache-control' + Pragma: + $ref: '#/components/headers/pragma' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +``` + +``` + + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + headers: + cache-control: + required: true + schema: + type: string + enum: + - no-store + pragma: + required: true + schema: + type: string + enum: + - no-cache + + schemas: + AccessTokenReq: + description: Contains information related to the access token request + type: object + required: + - grant_type + - nfInstanceId + - scope + properties: + grant_type: + type: string + enum: + - client_credentials + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + targetNFType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + scope: + type: string + pattern: '^([a-zA-Z0-9_-:]+)( [a-zA-Z0-9_-:]+)*$' + targetNfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + requesterPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + requesterPlmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 2 + requesterSnssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + requesterFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + requesterSnpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + targetPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + targetSnpn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + targetSnssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + targetNsiList: + type: array + items: + type: string + +``` + +``` + + minItems: 1 + targetNfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + targetNfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + hnrfAccessTokenUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + sourceNfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +AccessTokenRsp: + description: Contains information related to the access token response + type: object + required: + - access_token + - token_type + properties: + access_token: + type: string + description: > + JWS Compact Serialized representation of JWS signed JSON object (AccessTokenClaims) + token_type: + type: string + enum: + - Bearer + expires_in: + type: integer + scope: + type: string + pattern: '^([a-zA-Z0-9_-:]+)( [a-zA-Z0-9_-:]+)*$' + +AccessTokenClaims: + description: The claims data structure for the access token + type: object + required: + - iss + - sub + - aud + - scope + - exp + properties: + iss: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + sub: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + aud: + anyOf: + - $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + - type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + scope: + type: string + pattern: '^([a-zA-Z0-9_-:]+)( [a-zA-Z0-9_-:]+)*$' + exp: + type: integer + consumerPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + consumerSnpnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + producerPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + producerSnpnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + producerSnssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + producerNsiList: + type: array + items: + type: string + minItems: 1 + producerNfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + producerNfServiceSetId: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + sourceNfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +AccessTokenErr: + description: Error returned in the access token response message + type: object + required: + - error + properties: + error: + type: string + enum: + - invalid_request + - invalid_client + - invalid_grant + - unauthorized_client + - unsupported_grant_type + - invalid_scope + error_description: + type: string + error_uri: + type: string + +``` + +## A.5 Nnrf\_Bootstrapping API + +openapi: 3.0.0 + +``` + +info: + version: '1.2.0-alpha.1' + title: 'NRF Bootstrapping' + description: | + NRF Bootstrapping. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.510 V18.5.0; 5G System; Network Function Repository Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' + +paths: + /bootstrapping: + get: + summary: Bootstrapping Info Request + operationId: BootstrappingInfoRequest + tags: + - Bootstrapping Request + parameters: + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in IETF RFC 9110, 13.1.2 + schema: + type: string + responses: + '200': + description: Successful Bootstrapping Request + content: + application/3gppHal+json: + schema: + $ref: '#/components/schemas/BootstrappingInfo' + headers: + Cache-Control: + description: Cache-Control containing max-age, described in IETF RFC 9111, 5.2 + schema: + type: string + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' +headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string +'308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' +headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + schemas: + BootstrappingInfo: + description: Information returned by NRF in the bootstrapping response message + type: object + required: + - _links + properties: + status: + $ref: '#/components/schemas/Status' + _links: + type: object + description: > + Map of link objects where the keys are the link relations defined in + 3GPP TS 29.510 clause 6.4.6.3.3 + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LinksValueSchema' + minProperties: 1 + nrfFeatures: + type: object + description: > + Map of features supported by the NRF, where the keys are the NRF services + as defined in 3GPP TS 29.510 clause 6.1.6.3.11 + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + minProperties: 1 + oauth2Required: + type: object + description: > + Map indicating whether the NRF requires Oauth2-based authorization for accessing + its services. The key of the map shall be the name of an NRF service, + e.g. "nnrf-nfm" or "nnrf-disc" + additionalProperties: + type: boolean + minProperties: 1 + nrfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + nrfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + + Status: + description: Overall status of the NRF + anyOf: + - type: string + enum: + - OPERATIVE + - NON_OPERATIVE + - type: string + +``` + +--- + +## Annex B (normative): NF Profile changes in NFRegister and NFUpdate responses + +### B.1 General + +In the NFRegister and NFUpdate (NF Profile Complete Replacement and NF Profile Partial Update) service operations, a NF Service Consumer may indicate to the NRF that it supports receiving NF Profile changes in the response from the NRF, by including the `nfProfileChangesSupportInd` and/or the `nfProfilePartialUpdateChangesSupportInd` attributes set to "true" in the NFProfile it registers to or replaces in the NRF. + +NOTE 1: For NFRegister and NFUpdate (NF Profile Complete Replacement), the NF Service Consumer can indicate its support of the corresponding capability during the initial NFRegister operation or during the NF Profile Complete Replacement. + +NOTE 2: For NF Profile Partial Update (which uses the HTTP PATCH operation), the NF Service Consumer can indicate its support of the corresponding capability during the initial NFRegister operation, or during an NF Profile Complete Replacement (i.e., in the content of the corresponding HTTP PUT request), and can also indicate support of this capability after the initial registration, in a PATCH request, by setting to true the `nfProfilePartialUpdateChangesSupportInd` attribute. + +The NRF may return NF Profile changes, instead of the complete NF Profile, in NFRegister or NFUpdate responses, if the NF Service Consumer has indicated corresponding support in its NFProfile data. When doing so, the NRF shall include in the NF Profile returned in the response: + +- attributes that are mandatory to include in the NF Profile; if an optional IE is included (e.g. `nfServices`), attributes that are mandatory to include in this optional IE (e.g. `serviceInstanceId`) shall also be included; +- optional or conditional IEs that have been changed or added by the NRF; and +- the `nfProfileChangesInd` IE set to "true", indicating that the returned profile contains NF profile changes. + +EXAMPLE 1: The NRF does not change the NF Profile received in the request. + +The NRF response contains a NFProfile with just the following IEs: + +- `nfInstanceId`, `nfType`, `nfStatus`; and +- `nfProfileChangesInd` IE set to "true". + +EXAMPLE 2: The NRF modifies or adds the `heartbeatTimer` attribute to the NF Profile received in the request. + +The NRF response contains a NFProfile with just the following IEs: + +- `nfInstanceId`, `nfType`, `nfStatus`; +- `heartbeatTimer` with NRF chosen value; +- `nfProfileChangesInd` IE set to "true". + +--- + +## Annex C (normative): Enhanced Authorization Policy using RuleSets in NF (Service) Profile + +### C.1 General + +When scope of authorizations allowed to NF-Service-Consumers of different PLMNs, S-NSSAIs, SNPNS, NF-Domains etc. are different, it is not always possible for an NF (Service) Producer to register an authorization profile into NRF using allowedXXX parameters alone. The Allowed-ruleset feature addresses such requirements by extending the authorization policy with a prioritized list of RuleSets in the NF (Service) profile. + +This clause provides configuration examples and guidance on handling backward compatibility when the Allowed-ruleset feature is deployed. + +--- + +### C.2 Examples of NF-Producer profile only using RuleSets (i.e. without AllowedXXX parameters) in NF (Service) Profile + +This clause provides configuration examples of allowedScopesRuleSet parameter in the NF-Service profile (Clause 6.1.6.2.3). + +Following is an example of rules formed by para-phrasing the individual RuleSets registered by an NF-Service-Producer: + +*priority 1 plmns <> nfTypes <> nfInstances <> scopes <> allow* + +*priority 2 plmns <> nfTypes <> scopes <> allow* + +*priority 3 plmns <> nfTypes <> allow* + +*priority 100 deny* + +When a NF-Service-Consumer requests an access-token from NRF, the NRF matches the properties of the NF-Service-Consumer (PLMN, SNPNS, nfType, NfDomain, S-NSSAIs, NF-Instance Id etc.) against these rules in decreasing order of priority (1 being the highest). If a match is found, search stops, and the matching rule is applied to determine the scope to be granted. + +Consider 3 NF-Service Producers **p1**, **p2** and **p3** who need to register their NF-Service Profile into NRF. Each of these producers define operation level scopes Op1, Op2 and Op3 and the service-level scope. + +- NF-Service-Producer **p1** allows all NF-Service-Consumers with nfType=A to access its resources unrestricted. However NF-Service-Consumers with nfType=B are limited to Op1 and Op2. It may register, in the NF-Service-Profile: + +*priority 2 nfType {B} scopes {Op1, Op2, service level scope} allow* + +*priority 5 nfType {A} allow* + +*priority 100 deny* + +- NF-Service-Producer **p2** allows all NF-Service-Consumers with nfType=A to access its resources unrestricted. NF-Service-Consumers with nfType=B are limited to Op1 and Op2. It additionally wants to allow NF-Service-Consumer with NF-Instance-ID=X to Op3 only. It may register, in the NF-Service-Profile: + +*priority 2 nfInstance-id {X} scopes {Op3, service level scope} allow* + +``` + +priority 5 nfType {B} scopes {Op1, Op2, service level scope} allow +priority 10 nfType {A} allow +priority 100 deny + +``` + +- NF-Service-Producer **p3** allows all NF-Service-Consumers of PLMN1 of nfType=A or nfType=B to access its resources unrestricted. However, for the NFs of PLMN2, NF-Service-Consumers of nfType=A are allowed to access its resources unrestricted, but the NF-Service-Consumers of nfType=B are limited to Op1 and Op2. It may register, in the NF-Service-Profile: + +``` + +priority 2 plmn {plmn1} nfType {A,B} allow +priority 5 plmn {plmn2} nfType {A} allow +priority 10 plmn {plmn2} nfType {B} scopes {Op1, Op2, service level scope} allow +priority 100 deny + +``` + +Absence of scopes in a rule indicates that all service operations/all scopes are allowed. + +Rule with no identification of NF-Consumer (e.g. priority 100 rule in example above) indicates the rule applies to all. + +Similar examples apply to allowedRuleSet parameter in NF-Profile (Clause 6.1.6.2.2), however without the scopes parameter, as in the case of NF-Profile, the allowedRuleSet parameter is used to determine whether an NF-Consumer is allowed or not allowed to access the NF-Producer. + +### C.3 Example of NF-Producer profile using RuleSets and AllowedXXX parameters in NF (Service) Profile + +When a NF (Service) producer registers both the AllowedXXX parameters and the allowedScopesRuleSet parameter in the NF-Service Profile, the authorization scopes assigned to an NF-Consumer are determined by performing a logical OR operation of the two sets of parameters. This helps implementations to use Allowed-ruleset feature only when the authorization policy cannot be configured using the AllowedXXX parameters alone. + +This clause provides configuration examples with allowedScopesRuleSet parameter in the NF-Service profile (Clause 6.1.6.2.3) along with allowedXXX parameters. + +Consider the example of NF-Service-Producer **p3** in Annex C.2, which allows all NF-Service-Consumers of PLMN1 of nfType=A or nfType=B to access its resources unrestricted. However, for the NFs of PLMN2, NF-Service-Consumers of nfType=A are allowed to access its resources unrestricted, but the NF-Service-Consumers of nfType=B are limited to Op1 and Op2. This can be achieved by configuring the rules as: + +``` + +{ + allowedPLMNs = plmn1 + allowedNfTypes = A,B +} +OR +{ + priority 5 plmn {plmn2} nfType {A} allow + priority 10 plmn {plmn2} nfType {B} scopes {Op1, Op2, service level scope} allow +} + +``` + +Similar examples apply with allowedRuleSet parameter in NF-Profile (Clause 6.1.6.2.2), however without the scopes parameter, as in the case of NF-Profile, the allowedRuleSet parameter is used to determine whether an NF-Consumer is allowed or not allowed to access the NF-Producer. + +## C.4 Backward Compatibility + +This clause provides examples for addressing backward compatibility issues with the Allowed-ruleset feature. + +Consider an NF-Producer *p1* supporting Allowed-ruleset feature which registers its following NF-Service profile into NRF utilizing the new allowedScopesRuleSet parameter: + +``` +priority 2 nfInstance-id {X} scopes {Op3, service level scope} allow +priority 5 nfType {B} scopes {Op1, Op2, service level scope} allow +priority 10 nfType {A} allow +priority 15 nssais {1,2} scopes {Op1, service level scope} allow +priority 100 deny +``` + +Consider an NF-Consumer *c1* which does **not** support the Allowed-ruleset feature and discovers NF-Producer *p1* using Nnrf\_NFDiscovery service. + +- If the highest priority rule matching NF-Consumer *c1* is priority 2, the NRF may include, in the Nnrf\_NFDiscovery\_Get response, parameter *allowedOperationsPerNfInstance*, containing applicable scopes. +- If the highest priority rule matching NF-Consumer *c1* is priority 5, the NRF may include, in the Nnrf\_NFDiscovery\_Get response, parameter *allowedOperationsPerNfType*, containing applicable scopes. +- If the highest priority rule matching NF-Consumer *c1* is priority 10, the NRF may not include, in the Nnrf\_NFDiscovery\_Get response, the parameters *allowedOperationsPerNfInstance* and *allowedOperationsPerNfType*. +- If the highest priority rule matching NF-Consumer *c1* is priority 15, the NRF may include, in the Nnrf\_NFDiscovery\_Get response, any of the parameters *allowedOperationsPerNfInstance* or *allowedOperationsPerNfType*, containing applicable scopes. + +If entities (e.g. SCP) of a network are configured to use Complete Profile Subscription or Complete Profile Discovery feature, the Allowed-ruleset feature shall only be deployed if all these entities in the network have been upgraded to support and use the Allowed-ruleset feature. + +NF-Producers shall only be configured to use the Allowed-ruleset feature after NRFs in the network are upgraded and configured to use the Allowed-ruleset feature, as otherwise NF-Producers would need to translate RuleSets to existing service access control parameters (i.e. allowedPlmns, allowedSnpmns, allowedNfTypes etc.) which may not always be possible. + +## Annex D (normative): Support of "Canary Release" testing in the NRF + +This feature allows a network operator to deploy new software features in a Network Function (NF) in a controlled manner, by isolating the NF (Service) Instances that implement the new features, and steering solely a part of the traffic that, otherwise, would be sent towards such NF (Service) Instance producer. + +This is achieved by means of the following mechanisms: + +- Setting the NFStatus, or NFServiceStatus, of the NF service producer, to the value "CANARY\_RELEASE" +- Defining in the NFProfile or NFService of the NF service producer a set of selection conditions, that will be evaluated by an NF service consumer when attempting to select a candidate producer + +The set of conditions may include, e.g.: + +- The NF type of the consumer +- A feature number that is required by the consumer to select (and send traffic to) a producer +- A set of specific UEs (e.g. based on SUPI ranges, GPSI ranges, IMPU/IMPI ranges, list of PEIs) + +- Any UE camping on a TAI within a set of TAI ranges +- A list of DNNs + +In order to allow flexibility in the definition of the selection conditions, the above conditions can be combined by means of "and" / "or" logical operators. + +EXAMPLE: An SMF is deployed with a new software feature, and the operator wishes to test it by carrying traffic to it with the following conditions: + +- The SMF shall only be selected by an AMF, a NEF, or an NWDAF +- The SMF shall only be selected by the AMF when: + - its selection requires the support of the "ATSSS" feature (which corresponds with feature number #2 in the "nsmf-pdusession" service) + - the UE belongs to a certain range of SUPIs + - the UE is camping on a TAI belonging to a range of TAIs +- When the SMF is selected by the NEF, it shall only do it for a certain DNN +- When the SMF is selected by the NWDAF, it shall only do it when the UE is camping on a TAI belonging to a range of TAIs + +An example of the "selectionConditions" attribute could be as follows (note that there might be different logical expressions to encode the same logic): + +``` +"selectionConditions": { + "or": [ + { + "and": [ + { "consumerNfType": [ "AMF" ] }, + { "serviceFeature": 2 }, + { "supiRange": { "start": "1234511111", "end": "1234599999" } }, + { "taiRange": { + "plmnId": { "mcc": "123", "mnc": "45" }, + "tacRangeList": [ + { "start": "000011", "end": "0000ff" } + ] + } + } + ] + }, + { + "and": [ + { "consumerNfType": [ "NEF" ] }, + { "dnnList": [ "internet.operator.com" ] } + ] + }, + { + "and": [ + { "consumerNfType": [ "NWDAF" ] }, + { "taiRange": { + "plmnId": { "mcc": "123", "mnc": "45" }, + "tacRangeList": [ + { "start": "000011", "end": "000022" } + ] + } + } + ] + } + ] +} +``` + +or, alternatively, with a more simplified encoding, based on the fact that the individual conditions (attributes) inside ConditionItem (see clause 6.1.6.2.124) are evaluated following the "AND" logical operator: + +``` +"selectionConditions": { + "or": [ +``` + +``` + + { + "consumerNfType": [ "AMF" ], + "serviceFeature": 2, + "supiRange": { "start": "1234511111", "end": "1234599999" }, + "taiRange": { + "plmnId": { "mcc": "123", "mnc": "45" }, + "tacRangeList": [ + { "start": "000011", "end": "0000ff" } + ] + } + }, + { + "consumerNfType": [ "NEF" ], + "dnnList": [ "internet.operator.com" ] + }, + { + "consumerNfType": [ "NWDAF" ], + "taiRange": { + "plmnId": { "mcc": "123", "mnc": "45" }, + "tacRangeList": [ + { "start": "000011", "end": "000022" } + ] + } + } + ] +} + +``` + +Once the producer has defined the selection conditions in its NFProfile, registered at the NRF, the sequence of steps for selection an NF after it is deployed with a "canary" software release, would be as follows: + +1. NF Service Instance to be software-upgraded changes its status to "UNDISCOVERABLE", and potential consumers are notified +2. NF Service Instance gets progressively emptied of existing sessions, until no sessions remain +3. NF Service Instance may optionally change its status to "SUSPENDED", to ensure that no residual traffic is sent to the NF Service Instance, and potential consumers are notified +4. NF Service Instance is software-upgraded +5. NF Service Instance with new software registers in NRF with status "CANARY\_RELEASE" and includes the set of conditions for selection (e.g. a SUPI range) +6. Consumer NF sends discovery to NRF with usual discovery parameters and gets matching NF Instances containing NF Services with status "REGISTERED" or "CANARY\_RELEASE" +7. Consumer performs selection from the list of candidate NFs and, if the status of the producer NF is "CANARY\_RELEASE", such NF shall only be selected if the selection conditions match (e.g. it shall only be selected if the SUPI matches the SUPI range indicated by the producer NF). + +The selection of the candidate producers shall take into account the attributes of the discovered NFProfiles, and in addition, the consumer shall evaluate the attributes in the selection conditions, which shall take precedence over the attributes of the NFProfile of the producer, for those NF (Service) Instances in "CANARY\_RELEASE" status. + +If multiple candidate producers are available with NF (Service) status set to "REGISTERED" or "CANARY\_RELEASE", the consumer shall preferably select a producer in "CANARY\_RELEASE" status. + +For the case of Indirect Communication, the selection of a candidate producer may be done by the SCP. In that case, the SCP needs to be able to evaluate the selection conditions for those producers in "CANARY\_RELEASE" status. Since the SCP does not count with this information at its disposal (e.g. the different identities of the UE for which a service request is invoked via the SCP), it shall be provided by the consumer, e.g. by including the "3gpp-Sbi-Correlation-Info" HTTP header or by including the corresponding discovery headers ("3gpp-Sbi-Discovery") containing the UE identities involved in the specific traffic case. + +In certain cases, the operator may want to maintain the NF Instance fully operative (so it keeps serving traffic to any consumer), at the same time as testing the new software features; in such case, the operator may deploy distinct service instances, some of which may keep the old software version and keep the "REGISTERED" NFServiceStatus, while other service instances may be deployed with the new software version, and set the NFServiceStatus to "CANARY\_RELEASE", to ensure that it is only selected by consumers when the desired conditions are met. + +**Editor's Note:** It is FFS to consider if a more detailed description is needed of the scenario where an NF Instance is intended to be fully operational and, at the same time, be able to "canary test" some of its services. + +An SCP or SEPP Network Entities may set their NFStatus to "CANARY\_RELEASE" and define a set of selection conditions at NFProfile level to indicate to potential consumers that such Network Entity (SCP or SEPP) should only be selected if the selection conditions match. + +Given that there are no services defined for an SCP, it is not possible to have an SCP "operative" (i.e. to be able to serve traffic to any consumer) when the status is set to "CANARY\_RELEASE" and the consumers might not support the "CANARY\_RELEASE" feature. + +For a SEPP, the same considerations as with SCP apply, since there are no SEPP services per-se, in relation to the selection of SEPP instances, and the invocation of its N32-related message transfer capabilities. + +However, a SEPP Network Entity may set the NFServiceStatus of a "nsepp-telescopic" service instance (while keeping the NFStatus of the SEPP set to "REGISTERED"). In this case, it is possible to have several instances of this service deployed, where some of them have the NFServiceStatus set to "REGISTERED" (and any consumer may select them) and others set to "CANARY\_RELEASE", so consumers should only select such service instance when the selection conditions match. + +--- + +## Annex E (informative): Change history + +| Date | Meeting | TDoc. | CR | Rev | Cat | Subject/Comment | New | +|---------|---------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| 2017-10 | CT4#80 | C4-175271 | | | | Initial draft | 0.1.0 | +| 2017-10 | CT4#80 | C4-175395 | | | | Incorporation of agreed pCRs from CT4#80: C4-175109, C4-175272, C4-175274, C4-175363 | 0.2.0 | +| 2017-12 | CT4#81 | C4-176438 | | | | Incorporation of agreed pCRs from CT4#81: C4-176184, C4-176278, C4-176280, C4-176281, C4-176282 | 0.3.0 | +| 2018-01 | CT4#82 | C4-181392 | | | | Incorporation of agreed pCRs from CT4#82: C4-181348, C4-181351 | 0.4.0 | +| 2018-03 | CT4#83 | C4-182435 | | | | Incorporation of agreed pCRs from CT4#83: C4-182098, C4-182327, C4-182328, C4-182365, C4-182413 | 0.5.0 | +| 2018-04 | CT4#84 | C4-183517 | | | | Incorporation of agreed pCRs from CT4#84: C4-183450, C4-183451, C4-183452, C4-183487, C4-183488, C4-183490, C4-183491 | 0.6.0 | +| 2018-05 | CT4#85 | C4-184625 | | | | Incorporation of agreed pCRs from CT4#85: C4-184207, C4-184208, C4-184280, C4-184466, C4-184469, C4-184478, C4-184517, C4-184519, C4-184545, C4-184595, C4-184596, C4-184597, C4-184600, C4-184615, C4-184616, C4-184626 | 0.7.0 | +| 2018-06 | CT#80 | CP-181105 | | | | Presented for information and approval | 1.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80. | 15.0.0 | +| 2018-09 | CT#81 | CP-182012 | 0001 | 2 | F | Implementing the Indirect Delivery method for the GET method to retrieve NF instances | 15.1.0 | +| 2018-09 | CT#81 | CP-182093 | 0003 | 3 | F | Defining the range of the priority and capacity attributes and aligning their usage with SRV RFC 2782 | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0004 | - | F | Corrections to descriptions, references and SUPI parameter in Discovery Request | 15.1.0 | +| 2018-09 | CT#81 | CP-182047 | 0006 | 2 | F | SubscriptionData | 15.1.0 | +| 2018-09 | CT#81 | CP-182045 | 0008 | 2 | F | Error Cases | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0009 | 2 | F | Heart Beat Procedure | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0010 | 1 | B | Vendor-Specific NF Types | 15.1.0 | +| 2018-09 | CT#81 | CP-182044 | 0011 | 3 | F | Presence condition of service discovery query parameters | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0012 | 4 | F | Description of Inter-PLMN scenarios | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0013 | 1 | F | NF Service Versions | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0014 | 1 | B | Custom Headers | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0015 | 1 | F | Overall Clean-up | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0016 | - | F | Formatting of query parameters | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0017 | - | F | Editorial corrections | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0018 | 2 | F | Backup AMF | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0020 | 1 | B | NF Service Names | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0023 | - | F | CHF as service consumer | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0024 | 3 | B | Hierarchical NF discovery in recursion mode | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0025 | 2 | B | Hierarchical NF discovery in iteration mode | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0026 | - | F | Correction of Allowed NF Domains | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0027 | - | F | Correction of BsnInfo data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182161 | 0028 | 1 | F | IPv6 Prefix for NF / NF Service Address | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0030 | 1 | B | NF Set Id | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0031 | 1 | F | URI Scheme | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0032 | 2 | B | NRF service registration | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0034 | 2 | F | Discovery of combined SMF and PGW-C | 15.1.0 | +| 2018-09 | CT#81 | CP-182163 | 0035 | 3 | F | Support TAI Range for AMF/SMF and SUPI Range for PCF | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0036 | 1 | F | SUPI Range for PCF | 15.1.0 | +| 2018-09 | CT#81 | CP-182164 | 0037 | 3 | F | Scope for OAuth 2.0 Access Token Request | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0039 | 1 | F | Corrections to NotificationData and "supi" parameter in Discovery Request | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0040 | 1 | F | Group ID in Discovery Request | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0041 | 1 | F | Registering multiple Routing Indicators | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0045 | - | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0046 | 1 | F | Service names in Discovery Request | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0047 | 1 | F | Resource structure presentation | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0048 | - | B | Default Notifications for UDM | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0049 | - | F | Cell ID in Discovery Request | 15.1.0 | +| 2018-09 | CT#81 | CP-182046 | 0050 | 2 | F | NRF Subscription Data | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0051 | 1 | F | AMF Discovery by 5G-AN | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0052 | 1 | F | Detecting NF Failure and Restart using the NRF | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0053 | 2 | B | NRF Subscription Lifespan | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0054 | 1 | F | NRF servers clause in OpenAPI | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0056 | 2 | F | Default port number | 15.1.0 | +| 2018-09 | CT#81 | CP-182162 | 0057 | 1 | F | AMF Discovery Based on AMF Name | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0058 | - | F | API Version Update | 15.1.0 | +| 2018-12 | CT#82 | CP-183018 | 0060 | 4 | F | Heartbeat Timer | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0061 | 1 | F | Location Header | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0062 | 2 | F | NF Profile Addressing Parameters | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0063 | 1 | F | NRF Notifications | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0064 | - | F | Oauth2 Corrections | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0065 | 1 | F | Regular Expression Patterns | 15.2.0 | +| 2018-12 | CT#82 | CP-183183 | 0066 | 5 | F | Subscription Data | 15.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-------------------------------------------------------------------------------|--------| +| 2018-12 | CT#82 | CP-183147 | 0067 | 2 | F | UPF selection based on DNAI | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0068 | 5 | F | CHF registration and selection | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0069 | 1 | F | Clarify the NRF management functionality in the case of hierarchical NRFs | 15.2.0 | +| 2018-12 | CT#82 | CP-183149 | 0070 | 5 | F | OAuth2.0 Service Alignments and Corrections | 15.2.0 | +| 2018-12 | CT#82 | CP-183150 | 0071 | 1 | F | HTTP Basic Authentication For OAuth2.0 Access Token Request | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0072 | 1 | F | Multiple PLMNs support | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0075 | 2 | F | NFService attribute in NFProfile | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0076 | 1 | F | Corrections of ServiceName enumeration | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0077 | 4 | F | Indicating support of EPS interworking in UPF Profile | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0079 | 2 | F | Cardinality | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0081 | - | F | APIRoot Clarification | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0082 | 2 | F | Clarification on the reuse of the previous search results | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0083 | 1 | F | NF profile detail for hierarchical NRF | 15.2.0 | +| 2018-12 | CT#82 | CP-183235 | 0084 | 3 | F | Complex query | 15.2.0 | +| 2018-12 | CT#82 | CP-183152 | 0087 | 1 | F | SMF discovery based on S-NSSAI and DNN | 15.2.0 | +| 2018-12 | CT#82 | CP-183153 | 0088 | 2 | F | CHF discovery based on GPSI and SUPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183146 | 0089 | 3 | F | Add access type in SMF selection | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0090 | 2 | F | Hierarchical subscription with intermediate forwarding NRF | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0091 | 2 | F | Hierarchical subscription with intermediate redirecting NRF | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0093 | 1 | F | Notifications for subscriptions via intermediate NRF | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0096 | 1 | F | DNN and IP Domain in BSF Info | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0097 | 1 | F | PCF Information | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0100 | - | F | NF Service FQDN | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0101 | - | F | NRF Corrections | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0102 | 1 | F | Notification Data | 15.2.0 | +| 2018-12 | CT#82 | CP-183181 | 0103 | 2 | F | NRF OAuth Scopes | 15.2.0 | +| 2018-12 | CT#82 | CP-183182 | 0104 | 1 | F | NRF Subscription Handling | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0105 | - | F | NF Profile Change Notification | 15.2.0 | +| 2018-12 | CT#82 | CP-183171 | 0107 | - | F | UDM Group ID | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0108 | 2 | F | Preferred target NF Location in Discovery Request | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0109 | 1 | F | Telescopic FQDN for HNRF | 15.2.0 | +| 2018-12 | CT#82 | CP-183184 | 0112 | 1 | F | Description of NF instances/NF profile retrieval | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0113 | - | F | Content of the Subscription to notification response | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0115 | - | F | Adding new services in ServiceName enumeration | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0116 | - | F | NF Profile Service Instances | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0117 | - | F | API Version | 15.2.0 | +| 2018-12 | CT#82 | CP-183180 | 0118 | 1 | F | ExternalDocs Update | 15.2.0 | +| 2019-03 | CT#83 | CP-190023 | 0119 | 1 | F | AmfRegionId and AmfSetId | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0120 | 1 | F | Interpretation of absence of IEs in NF Profile | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0121 | 1 | F | Usage of FQDN and IP address related attributes from NF / NF Service profiles | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0122 | 1 | F | AMF Region and AMF Set in PLMNs supporting multiple PLMN Ids | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0123 | 1 | F | Encoding of GUAMI query parameter in NFDiscover Request | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0124 | 1 | F | Status for operative NF (service) not discoverable by other NFs | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0126 | 1 | F | Limiting the number of NFProfiles returned in NFDiscover response | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0127 | 2 | F | Maximum payload size of NFDiscover Response | 15.3.0 | +| 2019-03 | CT#83 | CP-190155 | 0128 | 2 | F | NF Profile Changes in NF Register / NFUpdate Response | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0129 | 1 | F | supported-features query parameter of NFDiscover Request | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0130 | 1 | F | OpenAPI Corrections | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0132 | 1 | F | OAuth2 Token Claims | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0133 | 1 | F | OAuth2 Token Type | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0134 | 1 | F | Authorization Attributes of NF Profile | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0135 | 2 | F | Features of NF Discovery service | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0136 | - | F | Subscription Authorization for Sets of NFs | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0137 | 1 | F | S-NSSAI per PLMN | 15.3.0 | +| 2019-03 | CT#83 | CP-190059 | 0138 | 4 | F | UPF selection based on PDUSessionType | 15.3.0 | +| 2019-03 | CT#83 | CP-190163 | 0139 | 2 | F | Service Names in URI Query Parameters | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0140 | 1 | F | GMLC URI for Namf_Location EventNotify | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0141 | 1 | F | Corrections on complex query | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0142 | 1 | F | NRF Notifications | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0143 | 1 | F | NRF Heart-Beat | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0144 | - | F | Addition of new Service Name | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0145 | - | F | API version update | 15.3.0 | +| 2019-06 | CT#84 | CP-191034 | 0146 | 3 | F | PLMN ID in Access Token Claims | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0147 | 1 | F | Content encodings supported in HTTP requests | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0156 | 3 | F | Correct the condition of the FQDN parameter of NFProfile and NFService | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0159 | 1 | F | NRF Service Description | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0161 | 1 | F | Slice Info in NRF | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0162 | 1 | F | Subscription Conditions | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0163 | 1 | F | Vendor-Specific IEs in NF Profile | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0165 | 2 | F | Target PLMN List in Inter-PLMN Service Discovery | 15.4.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|--------------------------------------------------------------------------------------------|--------| +| 2019-06 | CT#84 | CP-191034 | 0167 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0170 | - | F | Corrections on NFStatusUnSubscribe operation to take into account multiple NRFs | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0171 | 1 | F | Corrections on UpdateSubscription operation to take into account multiple NRFs | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0174 | 4 | F | Corrections on Nnrf_AccessToken Service for multiple NRFs | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0176 | - | F | LowerCamel Correction in Data Structures | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0177 | - | F | Removal of Basic Authentication | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0178 | 1 | F | Location header in redirect response | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0185 | 2 | F | Add HTTP error codes in 29.510 | 15.4.0 | +| 2019-09 | CT#85 | CP-192108 | 0192 | 4 | F | Add selection mechanism for multiple IP addresses in NFProfile | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0194 | 2 | F | Add retrieval of the NF profile using the URI | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0195 | 1 | F | Add the update of subscription in a different PLMN | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0198 | 1 | F | PLMN-IDs in Discovery Response | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0202 | - | F | Copyright Note in YAML files | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0206 | - | F | 3GPP TS 29.510 API version update | 15.4.0 | +| 2019-06 | CT#84 | CP-191052 | 0148 | 7 | B | NWDAF Discovery and Selection | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0149 | 4 | B | Multiple entries of pcfInfo | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0150 | 3 | B | Multiple entries of bsfInfo | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0151 | 3 | B | Multiple entries of smfInfo | 16.0.0 | +| 2019-06 | CT#84 | CP-191051 | 0154 | 5 | B | ATSSS Capability for UPF Selection | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0175 | 1 | B | GPSI range in pcfInfo | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0180 | 2 | B | Multiple entries of xxxInfo (generalized) | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0186 | 2 | F | Add the name of NF Instance | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0187 | 3 | B | Add requester nfnstanceId parameter in NFStatusSubscribe and NFDiscovery operations | 16.0.0 | +| 2019-06 | CT#84 | CP-191034 | 0196 | 2 | F | Correct The subscription notification procedure under the exception case | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0199 | 1 | B | PCF Group ID | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0200 | 1 | B | Number of NF Instances | 16.0.0 | +| 2019-06 | CT#84 | CP-191050 | 0201 | 1 | B | NIDDAAU Service Name | 16.0.0 | +| 2019-06 | CT#84 | CP-191054 | 0204 | 1 | B | UE IP address allocation by UPF | 16.0.0 | +| 2019-06 | CT#84 | CP-191048 | 0205 | - | B | 3GPP TS 29.510 API version update | 16.0.0 | +| 2019-09 | CT#85 | CP-192033 | 0207 | 3 | C | CBCF as Network Function | 16.1.0 | +| 2019-09 | CT#85 | CP-192127 | 0208 | 1 | F | callbackUri the same as nfStatusNotificationUri | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0210 | 1 | B | Extensions for I-SMF and I-UPF selection | 16.1.0 | +| 2019-09 | CT#85 | CP-192194 | 0211 | 2 | B | NF Set and NF Service Set | 16.1.0 | +| 2019-09 | CT#85 | CP-192034 | 0212 | 2 | B | Update NRF descriptions to support AF Available Data Registration as described in TS23.288 | 16.1.0 | +| 2019-09 | CT#85 | CP-192035 | 0213 | 3 | B | SMF Selection | 16.1.0 | +| 2019-09 | CT#85 | CP-192107 | 0215 | - | A | Expiration Time of AccessTokenClaims | 16.1.0 | +| 2019-09 | CT#85 | CP-192109 | 0217 | 1 | F | Requester PLMN ID in SubscriptionData | 16.1.0 | +| 2019-09 | CT#85 | CP-192127 | 0218 | - | F | Correct the conditions of the information included in the access token request | 16.1.0 | +| 2019-09 | CT#85 | CP-192107 | 0222 | - | A | Slice Information in Access Token Claims | 16.1.0 | +| 2019-09 | CT#85 | CP-192130 | 0223 | 1 | B | UPF collocated with W-AGF | 16.1.0 | +| 2019-09 | CT#85 | CP-192127 | 0224 | 2 | F | URI in Location header for subscription to NF Instances in a different PLMN | 16.1.0 | +| 2019-09 | CT#85 | CP-192249 | 0226 | 5 | A | Support of Static IP Address | 16.1.0 | +| 2019-09 | CT#85 | CP-192133 | 0228 | 1 | B | Network Identifier for Stand-alone Non-Public Networks | 16.1.0 | +| 2019-09 | CT#85 | CP-192127 | 0229 | 1 | F | SMF profile without the smfInfo attribute | 16.1.0 | +| 2019-09 | CT#85 | CP-192107 | 0231 | - | A | Authorization Attributes in NF Service | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0232 | - | B | Handling of authorization parameters | 16.1.0 | +| 2019-09 | CT#85 | CP-192136 | 0233 | 1 | B | P-CSCF Discovery | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0235 | - | B | GPSI support for PCF Query | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0236 | - | B | LMF and GMLC Info | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0238 | 1 | B | NEF discovery information for PFD | 16.1.0 | +| 2019-09 | CT#85 | CP-192135 | 0239 | - | B | Services invoked by NWDAF | 16.1.0 | +| 2019-09 | CT#85 | CP-192127 | 0240 | 1 | F | Regulation of load update notifications | 16.1.0 | +| 2019-09 | CT#85 | CP-192120 | 0242 | - | F | 3GPP TS 29.510 API version update | 16.1.0 | +| 2019-10 | | | | | | Corrupted references fixed | 16.1.1 | +| 2019-12 | CT#86 | CP-193063 | 0244 | - | B | Missing NFs information in NrfInfo | 16.2.0 | +| 2019-12 | CT#86 | CP-193059 | 0245 | 2 | B | P-CSCF Discovery based on preferred-locality | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0247 | 2 | B | NEF ID | 16.2.0 | +| 2019-12 | CT#86 | CP-193042 | 0248 | - | F | ExternalDocs Clause | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0250 | 3 | F | Support of Static IP Address | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0251 | 3 | B | NRF Bootstrapping | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0252 | 3 | B | I-SMF selection in a mobility procedure | 16.2.0 | +| 2019-12 | CT#86 | CP-193283 | 0253 | 3 | B | UCMF Registration in NRF | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0254 | 1 | B | Handling of default notification subscriptions with Delegated Discovery | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0255 | 1 | B | Support of different priorities in SMF/UPF profiles for different TAs | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0256 | 1 | A | External Group ID | 16.2.0 | +| 2019-12 | CT#86 | CP-193053 | 0257 | 2 | B | Internal Group Identifier in UdmInfo | 16.2.0 | +| 2019-12 | CT#86 | CP-193054 | 0258 | 1 | B | HSS Service Discovery | 16.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-------------------------------------------------------------------------|--------| +| 2019-12 | CT#86 | CP-193063 | 0259 | 1 | B | NF serving scope | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0260 | 1 | A | S-NSSAI Discovery Parameter | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0261 | 1 | F | NF discovery based on DNN | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0262 | 1 | F | S-NSSAI for SMF or UPF selection | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0264 | 2 | B | GMLC Location service | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0265 | - | F | Error code 404 for Hierarchical NRFs | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0266 | 3 | B | Preferred API Version | 16.2.0 | +| 2019-12 | CT#86 | CP-193042 | 0267 | 3 | F | Clarification on Backup AMF Info | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0269 | - | B | Location Update Notification Default Subscription | 16.2.0 | +| 2019-12 | CT#86 | CP-193044 | 0273 | - | F | 3GPP TS 29.510 API version update | 16.2.0 | +| 2020-03 | CT#87 | CP-200025 | 0274 | 1 | B | 3GPP Rel-16 LOLC implications on Nnrf service | 16.3.0 | +| 2020-03 | CT#87 | CP-200039 | 0275 | 2 | F | Add Corresponding API descriptions in clause 5.1 | 16.3.0 | +| 2020-03 | CT#87 | CP-200016 | 0277 | 3 | F | Service Discovery in a different PLMN using 3gpp-Sbi-Target-apiRoot | 16.3.0 | +| 2020-03 | CT#87 | CP-200134 | 0278 | 3 | B | Data Type Descriptions | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0279 | 1 | D | Editorial corrections in clause headings | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0280 | 2 | B | Service Names | 16.3.0 | +| 2020-03 | CT#87 | CP-200029 | 0281 | 1 | B | SoR Application Function | 16.3.0 | +| 2020-03 | CT#87 | CP-200035 | 0282 | 3 | B | N3 terminations of TWIF for UPF selection | 16.3.0 | +| 2020-03 | CT#87 | CP-200044 | 0283 | 1 | F | Correcting relevant typing errors | 16.3.0 | +| 2020-03 | CT#87 | CP-200016 | 0284 | 3 | B | CHF Group ID | 16.3.0 | +| 2020-03 | CT#87 | CP-200101 | 0285 | 4 | B | S-NSSAIs of an NF Service | 16.3.0 | +| 2020-03 | CT#87 | CP-200021 | 0286 | 2 | F | NFtype enumeration values for MME, SCEF and SCS/AS | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0287 | 3 | F | DNN encoding in NRF APIs | 16.3.0 | +| 2020-03 | CT#87 | CP-200047 | 0288 | 2 | F | Content type of Access Token Request | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0289 | 2 | F | Registering the AccessToken service in another NRF | 16.3.0 | +| 2020-03 | CT#87 | CP-200039 | 0290 | 3 | D | Editorial corrections | 16.3.0 | +| 2020-03 | CT#87 | CP-200039 | 0291 | 2 | F | Correction - formatting consistency | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0293 | 1 | B | 29510 CR optionality of ProblemDetails | 16.3.0 | +| 2020-03 | CT#87 | CP-200016 | 0294 | 1 | F | Wrong reference | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0295 | 1 | B | Subscription Condition for UPF | 16.3.0 | +| 2020-03 | CT#87 | CP-200026 | 0297 | 1 | B | OTAF | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0298 | 1 | B | Supported DNN of the I-SMF | 16.3.0 | +| 2020-03 | CT#87 | CP-200036 | 0299 | - | B | PCF selection for V2X | 16.3.0 | +| 2020-03 | CT#87 | CP-200023 | 0300 | 2 | B | UPF selection for redundant transmission | 16.3.0 | +| 2020-03 | CT#87 | CP-200016 | 0302 | 1 | B | Service access authorization of a NF Set | 16.3.0 | +| 2020-03 | CT#87 | CP-200028 | 0307 | 3 | B | UDSF registration with NRF | 16.3.0 | +| 2020-03 | CT#87 | CP-200016 | 0308 | - | F | API versions supported for default notification subscriptions | 16.3.0 | +| 2020-03 | CT#87 | CP-200044 | 0309 | - | F | NF Discovery with intermediate forwarding NRF | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0310 | - | F | Modifications in the NRF service APIs for the support of compression | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0311 | 1 | B | Vendor ID in NF Profile | 16.3.0 | +| 2020-03 | CT#87 | CP-200177 | 0312 | 3 | B | LMF selection | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0313 | 1 | B | Load Time Stamp | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0314 | 1 | B | Security Settings | 16.3.0 | +| 2020-03 | CT#87 | CP-200016 | 0315 | 1 | B | NFType for SCP | 16.3.0 | +| 2020-03 | CT#87 | CP-200092 | 0316 | - | F | 3GPP TS 29.510 API Version Update | 16.3.0 | +| 2020-07 | CT#88 | CP-201050 | 0317 | 1 | B | Support of IPUPS Functionality | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0318 | 1 | F | Authorization parameters in roaming scenarios | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0319 | 1 | F | Missing attributes in NrfInfo data type | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0320 | - | F | Slice Differentiator Ranges and Wildcard | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0321 | 1 | F | Undiscoverable NF service | 16.4.0 | +| 2020-07 | CT#88 | CP-201057 | 0322 | 2 | F | Supported Headers and Links Tables | 16.4.0 | +| 2020-07 | CT#88 | CP-201030 | 0323 | 1 | B | Recovery Time for NF Service Set and NF Set | 16.4.0 | +| 2020-07 | CT#88 | CP-201022 | 0324 | 1 | A | Requester-snsais | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0325 | 2 | B | Resource-Level Authorization | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0326 | - | B | Data type descriptions | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0327 | - | B | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0331 | 1 | B | Subscription Condition for a List of NF Instances | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0334 | - | B | Serving Scope for NF Subscriptions | 16.4.0 | +| 2020-07 | CT#88 | CP-201046 | 0335 | 1 | B | SMF NIDD Service | 16.4.0 | +| 2020-07 | CT#88 | CP-201057 | 0336 | 1 | F | Datatype column in Resource URI variables Table | 16.4.0 | +| 2020-07 | CT#88 | CP-201041 | 0338 | 2 | F | ServiceName nudsf-dr missing from yaml | 16.4.0 | +| 2020-07 | CT#88 | CP-201030 | 0341 | 1 | F | Presence condition of Set IDs | 16.4.0 | +| 2020-07 | CT#88 | CP-201047 | 0342 | 1 | B | AMF Callback URIs for NSSAA | 16.4.0 | +| 2020-07 | CT#88 | CP-201047 | 0343 | 1 | B | Introduce NSSAAF | 16.4.0 | +| 2020-07 | CT#88 | CP-201201 | 0345 | 2 | F | SCP profile registration and discovery | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0347 | 1 | F | Bootstrapping API | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0348 | 1 | F | Defining xxxInfoExt data types as maps | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0349 | - | F | Requester's information in Access Token Request | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0350 | - | F | Discovery or subscription requests with missing requester's information | 16.4.0 | +| 2020-07 | CT#88 | CP-201030 | 0354 | 1 | F | Supplement to NefInfo | 16.4.0 | +| 2020-07 | CT#88 | CP-201070 | 0355 | 1 | B | UPF for Data Forwarding | 16.4.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-----------------------------------------------------------------------------------------------------------|--------| +| 2020-07 | CT#88 | CP-201031 | 0356 | 1 | B | V-SMF Selection for Serving Full PLMN | 16.4.0 | +| 2020-07 | CT#88 | CP-201045 | 0357 | - | F | NRF Additional Authorization Parameters | 16.4.0 | +| 2020-07 | CT#88 | CP-201183 | 0359 | 2 | F | NRF Notifications | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0360 | - | F | NF Services Map | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0361 | 1 | B | NRF Notification Data | 16.4.0 | +| 2020-07 | CT#88 | CP-201033 | 0364 | - | B | Service Name for Nhss_EE | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0365 | 1 | F | Maximum payload size | 16.4.0 | +| 2020-07 | CT#88 | CP-201073 | 0368 | - | F | 3GPP TS 29.510 API Version Update | 16.4.0 | +| 2020-09 | CT#89 | CP-202118 | 0370 | - | F | HSS NF Profile Update | 16.5.0 | +| 2020-09 | CT#89 | CP-202043 | 0371 | 1 | F | NF Group ID | 16.5.0 | +| 2020-09 | CT#89 | CP-202110 | 0372 | - | F | Handling of S-NSSAI per PLMN | 16.5.0 | +| 2020-09 | CT#89 | CP-202119 | 0375 | 1 | F | scpPrefix attribute in SCP profile | 16.5.0 | +| 2020-09 | CT#89 | CP-202119 | 0376 | 1 | F | Resolving Editor's notes on SCP profile registration and discovery | 16.5.0 | +| 2020-09 | CT#89 | CP-202110 | 0377 | - | F | NF Profile Retrieval procedure with NF Services Map | 16.5.0 | +| 2020-09 | CT#89 | CP-202118 | 0378 | - | F | Missing NF types for SBA interactions between IMS and 5GC | 16.5.0 | +| 2020-09 | CT#89 | CP-202088 | 0380 | - | F | supported-features query parameter | 16.5.0 | +| 2020-09 | CT#89 | CP-202088 | 0381 | 1 | F | Making reqNfType as Conditional IE in SubscriptionData | 16.5.0 | +| 2020-09 | CT#89 | CP-202119 | 0383 | 3 | F | Corrections on attributes for SCP | 16.5.0 | +| 2020-09 | CT#89 | CP-202119 | 0384 | 1 | F | Notification Binding for Default Subscription | 16.5.0 | +| 2020-09 | CT#89 | CP-202022 | 0385 | 2 | F | Message and Information class for Default Subscription | 16.5.0 | +| 2020-09 | CT#89 | CP-202110 | 0386 | 1 | F | Default TCP Port | 16.5.0 | +| 2020-09 | CT#89 | CP-202112 | 0387 | 1 | F | Corrections on definition of NotificationType | 16.5.0 | +| 2020-09 | CT#89 | CP-202096 | 0390 | - | F | 29.510 Rel-16 API version and External doc update | 16.5.0 | +| 2020-12 | CT#90 | CP-203034 | 0395 | 2 | F | Subscription Authorization parameters for NRF | 16.6.0 | +| 2020-12 | CT#90 | CP-203034 | 0396 | 2 | F | Add a condition to trigger NF_PROFILE_CHANGE notification from NRF for any change in allowedxxx parameter | 16.6.0 | +| 2020-12 | CT#90 | CP-203034 | 0397 | 2 | F | Replace the NFInstanceID with nfInstanceUri in Notification from NRF | 16.6.0 | +| 2020-12 | CT#90 | CP-203081 | 0398 | 4 | F | Supplement to SubscrCond | 16.6.0 | +| 2020-12 | CT#90 | CP-203070 | 0402 | 2 | F | SCP port information | 16.6.0 | +| 2020-12 | CT#90 | CP-203048 | 0404 | 1 | F | preferred-api-versions query parameter | 16.6.0 | +| 2020-12 | CT#90 | CP-203053 | 0405 | - | F | P-CSCF addresses | 16.6.0 | +| 2020-12 | CT#90 | CP-203054 | 0406 | 4 | F | Amendments for stateless NF support | 16.6.0 | +| 2020-12 | CT#90 | CP-203048 | 0408 | - | F | Storage of YAML files in GitLab | 16.6.0 | +| 2020-12 | CT#90 | CP-203048 | 0410 | - | F | Correction in NRF Bootstrapping | 16.6.0 | +| 2020-12 | CT#90 | CP-203052 | 0413 | - | F | UDSF Info | 16.6.0 | +| 2020-12 | CT#90 | CP-203054 | 0414 | 1 | F | SCP subscription | 16.6.0 | +| 2020-12 | CT#90 | CP-203034 | 0415 | 1 | F | NF Profile for NF as Service Consumer | 16.6.0 | +| 2020-12 | CT#90 | CP-203048 | 0416 | 1 | F | Preferred Locality Search Result | 16.6.0 | +| 2020-12 | CT#90 | CP-203034 | 0418 | 2 | F | V-SMF Capability | 16.6.0 | +| 2020-12 | CT#90 | CP-203048 | 0419 | - | F | Data Type Descriptions | 16.6.0 | +| 2020-12 | CT#90 | CP-203036 | 0420 | - | F | 29.510 Rel16 API version and External doc update | 16.6.0 | +| 2020-12 | CT#90 | CP-203064 | 0374 | 2 | B | NF Discovery procedure enhancements | 17.0.0 | +| 2020-12 | CT#90 | CP-203059 | 0392 | 1 | F | Discovery answer for no match of query parameter | 17.0.0 | +| 2020-12 | CT#90 | CP-203064 | 0399 | 1 | F | Issues with definition of heartBeatTimer attribute and limit Query-parameter in Open API specification | 17.0.0 | +| 2020-12 | CT#90 | CP-203071 | 0400 | 2 | B | Query parameter for preferred vendor-specific features | 17.0.0 | +| 2020-12 | CT#90 | CP-203064 | 0401 | 1 | F | Support of Wildcard DNN in SmfInfo | 17.0.0 | +| 2020-12 | CT#90 | CP-203064 | 0407 | 3 | B | Select a UP function to setup PFCP Association | 17.0.0 | +| 2020-12 | CT#90 | CP-203061 | 0409 | - | D | TS References | 17.0.0 | +| 2020-12 | CT#90 | CP-203064 | 0411 | - | F | IP addressing | 17.0.0 | +| 2020-12 | CT#90 | CP-203064 | 0412 | 2 | F | Default Notifications | 17.0.0 | +| 2020-12 | CT#90 | CP-203069 | 0417 | 4 | B | SCP Domain Routing Information | 17.0.0 | +| 2020-12 | CT#90 | CP-203055 | 0421 | - | F | 29.510 Rel17 API version and External doc update | 17.0.0 | +| 2021-03 | CT#91 | CP-210021 | 0369 | 3 | B | NF discovery based on SUCI information | 17.1.0 | +| 2021-03 | CT#91 | CP-210037 | 0423 | 1 | A | Add snssaiList, pfdData, gpsiRanges, externalGroupIdentifiersRanges, servedFqdnList to NefCond | 17.1.0 | +| 2021-03 | CT#91 | CP-210037 | 0425 | 1 | A | Add snssaiList, tailList and tailRangeList to NwdaFCond | 17.1.0 | +| 2021-03 | CT#91 | CP-210043 | 0428 | 1 | A | Encoding of Monitored and Unmonitored Attributes | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0429 | 2 | F | Vendor Specific Features at NF Level | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0430 | 1 | B | SEPP profile | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0431 | - | B | NRF supported features in Bootstrapping response | 17.1.0 | +| 2021-03 | CT#91 | CP-210043 | 0433 | - | A | Query parameters indicating a preference | 17.1.0 | +| 2021-03 | CT#91 | CP-210043 | 0435 | - | A | NFType value for DRA | 17.1.0 | +| 2021-03 | CT#91 | CP-210043 | 0438 | 2 | A | P-CSCF discovery based on UE IP address R17 | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0439 | 1 | F | P-CSCF discovery based on UE location | 17.1.0 | +| 2021-03 | CT#91 | CP-210053 | 0443 | - | A | Primary / Secondary CHF Instances | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0444 | 1 | B | Enhancements to BSF Info | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0445 | 2 | B | UPF TAI Ranges | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0446 | 1 | F | Editorial Corrections | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0447 | 2 | B | Enhancements to NFListRetrieval service operation | 17.1.0 | +| 2021-03 | CT#91 | CP-210022 | 0450 | - | F | Clarification of NF Set ID List | 17.1.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-----------------------------------------------------------------------------------------------------------------------------|--------| +| 2021-03 | CT#91 | CP-210021 | 0451 | - | F | IMSI Pattern | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0452 | - | F | Correction to Bootstrapping service description | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0453 | 2 | F | Discovery and Subscribe Operation on NF Service Set | 17.1.0 | +| 2021-03 | CT#91 | CP-210034 | 0454 | 1 | D | Correcting Figure 5.2.2.5.4-1 | 17.1.0 | +| 2021-03 | CT#91 | CP-210034 | 0455 | 1 | D | Correcting Figure 5.2.2.5.5-1 | 17.1.0 | +| 2021-03 | CT#91 | CP-210034 | 0456 | - | D | Correcting Figure 5.2.2.6.4-1 | 17.1.0 | +| 2021-03 | CT#91 | CP-210043 | 0458 | 1 | A | Essential correction to Subscription Condition data types | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0459 | - | F | Supported Vendor-Specific Features | 17.1.0 | +| 2021-03 | CT#91 | CP-210055 | 0461 | 1 | A | Conditional PATCH | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0464 | 1 | B | SCP Domain Routing Info Aggregation | 17.1.0 | +| 2021-03 | CT#91 | CP-210037 | 0466 | 4 | A | SCP Information | 17.1.0 | +| 2021-03 | CT#91 | CP-210055 | 0471 | 1 | A | SubscrCond for PCF and CHF | 17.1.0 | +| 2021-03 | CT#91 | CP-210026 | 0472 | 1 | B | AAnF discovery | 17.1.0 | +| 2021-03 | CT#91 | CP-210025 | 0473 | 1 | F | hNRF from NSSF in home PLMN | 17.1.0 | +| 2021-03 | CT#91 | CP-210029 | 0474 | - | F | 29.510 Rel-17 API version and External doc update | 17.1.0 | +| 2021-06 | CT#92 | CP-211028 | 0477 | - | B | UDSF Timer service | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0478 | 2 | B | Communication options information | 17.2.0 | +| 2021-06 | CT#92 | CP-211027 | 0479 | - | B | Non-3GPP TAI | 17.2.0 | +| 2021-06 | CT#92 | CP-211030 | 0480 | 1 | B | New NSACF NFtype added | 17.2.0 | +| 2021-06 | CT#92 | CP-211065 | 0483 | 1 | F | Usage of IPv6PrefixRange | 17.2.0 | +| 2021-06 | CT#92 | CP-211065 | 0485 | - | A | Smf Info Priority | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0486 | - | F | OpenAPI Reference | 17.2.0 | +| 2021-06 | CT#92 | CP-211065 | 0488 | 1 | A | Corrections to PFD Data attribute and query parameter | 17.2.0 | +| 2021-06 | CT#92 | CP-211039 | 0489 | 1 | B | Add 5G DDNMF | 17.2.0 | +| 2021-06 | CT#92 | CP-211071 | 0491 | 1 | A | Essential correction on UPF Info | 17.2.0 | +| 2021-06 | CT#92 | CP-211031 | 0492 | 2 | B | (I-)SMF discovery based on DNAI | 17.2.0 | +| 2021-06 | CT#92 | CP-211036 | 0493 | 1 | B | New services provided by NWDAF | 17.2.0 | +| 2021-06 | CT#92 | CP-211036 | 0494 | 2 | B | Analytics IDs per Service | 17.2.0 | +| 2021-06 | CT#92 | CP-211057 | 0496 | 1 | F | Description field for map data types | 17.2.0 | +| 2021-06 | CT#92 | CP-211059 | 0498 | 1 | A | Error Responses for Indirect Communication | 17.2.0 | +| 2021-06 | CT#92 | CP-211066 | 0500 | - | A | Event IDs supported by AF | 17.2.0 | +| 2021-06 | CT#92 | CP-211039 | 0501 | - | B | Add 5G DDNMF service | 17.2.0 | +| 2021-06 | CT#92 | CP-211039 | 0502 | 1 | B | PCF discovery with ProSe capability indication | 17.2.0 | +| 2021-06 | CT#92 | CP-211065 | 0504 | 1 | A | R17-Access token request verification | 17.2.0 | +| 2021-06 | CT#92 | CP-211036 | 0505 | 2 | B | NWDAF aggregation capability registration in the NRF | 17.2.0 | +| 2021-06 | CT#92 | CP-211036 | 0506 | 3 | B | New DCCF NF Registration and Discovery | 17.2.0 | +| 2021-06 | CT#92 | CP-211036 | 0507 | 2 | B | New MFAF NF Registration and Discovery | 17.2.0 | +| 2021-06 | CT#92 | CP-211036 | 0508 | 2 | B | NWDAF Registration and Discovery enhancement | 17.2.0 | +| 2021-06 | CT#92 | CP-211026 | 0509 | 1 | B | LMF discovery via TAI | 17.2.0 | +| 2021-06 | CT#92 | CP-211065 | 0512 | 3 | A | Remove unused GrantType | 17.2.0 | +| 2021-06 | CT#92 | CP-211034 | 0513 | 3 | B | NSI based SUPI/SUCI | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0514 | - | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the Nnrf_NFManagement API | 17.2.0 | +| 2021-06 | CT#92 | CP-211059 | 0515 | 1 | A | Redirect Responses | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0517 | 1 | F | Nested cardinality R17 | 17.2.0 | +| 2021-06 | CT#92 | CP-211057 | 0518 | 2 | B | NRF Content Encoding Information | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0519 | 2 | B | SCP capabilities | 17.2.0 | +| 2021-06 | CT#92 | CP-211031 | 0520 | - | B | EASDF Registration and Discovery | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0521 | - | F | Client-type query parameter alignment | 17.2.0 | +| 2021-06 | CT#92 | CP-211036 | 0522 | 1 | B | Analytics ID of Nnwdaf_MLModelProvision service | 17.2.0 | +| 2021-06 | CT#92 | CP-211057 | 0525 | 1 | F | Add ConditionEventType in Table 6.1.6.1-1 | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0528 | 1 | F | Supported Features for Default Subscription | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0529 | 1 | F | NRF Info | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0530 | - | F | Clarification of service-names query parameter | 17.2.0 | +| 2021-06 | CT#92 | CP-211026 | 0535 | 1 | B | LMF discovery via Supported GAD shapes | 17.2.0 | +| 2021-06 | CT#92 | CP-211039 | 0536 | - | B | Match Information Default Notification | 17.2.0 | +| 2021-06 | CT#92 | CP-211050 | 0537 | - | F | 29.510 Rel-17 API version and External doc update | 17.2.0 | +| 2021-09 | CT#93 | CP-212050 | 0539 | 1 | F | Multiple PGW FQDNs | 17.3.0 | +| 2021-09 | CT#93 | CP-212083 | 0541 | 2 | B | NSACF Profile | 17.3.0 | +| 2021-09 | CT#93 | CP-212030 | 0542 | 1 | B | NSACF discovery | 17.3.0 | +| 2021-09 | CT#93 | CP-212050 | 0543 | 1 | D | Editorial Corrections | 17.3.0 | +| 2021-09 | CT#93 | CP-212030 | 0544 | 1 | B | NSACF service name | 17.3.0 | +| 2021-09 | CT#93 | CP-212031 | 0547 | - | B | Local NEF discovery | 17.3.0 | +| 2021-09 | CT#93 | CP-212041 | 0548 | - | B | NFStatusSubscribe for DCCF | 17.3.0 | +| 2021-09 | CT#93 | CP-212041 | 0549 | 1 | B | NFStatusSubscribe for NWDAF | 17.3.0 | +| 2021-09 | CT#93 | CP-212026 | 0551 | 1 | F | Returning the interPlmnFqdn attribute in NFProfile in NF Discovery response | 17.3.0 | +| 2021-09 | CT#93 | CP-212094 | 0552 | 2 | B | MB-SMF registration and discovery | 17.3.0 | +| 2021-09 | CT#93 | CP-212095 | 0553 | 1 | B | TSCTSF NF registration and discovery | 17.3.0 | +| 2021-09 | CT#93 | CP-212031 | 0554 | - | F | Cardinality of servedEasdfInfoList in NrfInfo | 17.3.0 | +| 2021-09 | CT#93 | CP-212043 | 0556 | 1 | F | Clarification on primaryChfInstance and secondaryChfInstance | 17.3.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|---------------------------------------------------------------------------------|--------| +| 2021-09 | CT#93 | CP-212066 | 0558 | - | A | NFType enumeration value for IMS-AS | 17.3.0 | +| 2021-09 | CT#93 | CP-212060 | 0560 | - | A | 3xx description correction for SCP | 17.3.0 | +| 2021-09 | CT#93 | CP-212026 | 0561 | 1 | F | Rel-17 NFDiscovery features | 17.3.0 | +| 2021-09 | CT#93 | CP-212041 | 0562 | - | B | New ADRF NF Registration and Discovery | 17.3.0 | +| 2021-09 | CT#93 | CP-212041 | 0563 | - | B | NWDAF capability enhancement | 17.3.0 | +| 2021-09 | CT#93 | CP-212064 | 0565 | 1 | A | ScpInfo Data Type Definition | 17.3.0 | +| 2021-09 | CT#93 | CP-212029 | 0567 | - | B | GBA BSF NF Type and Service Name | 17.3.0 | +| 2021-09 | CT#93 | CP-212064 | 0569 | - | A | ScpDomainCond data type definition | 17.3.0 | +| 2021-09 | CT#93 | CP-212050 | 0570 | 1 | F | PGW IP Address | 17.3.0 | +| 2021-09 | CT#93 | CP-212036 | 0571 | - | F | Correct incorrect data type name of 5GDdnmflnfo | 17.3.0 | +| 2021-09 | CT#93 | CP-212026 | 0573 | 1 | F | Corrections to the API URI | 17.3.0 | +| 2021-09 | CT#93 | CP-212059 | 0575 | - | F | 29.510 Rel-17 API version and External doc update | 17.3.0 | +| 2021-12 | CT#94 | CP-213097 | 0577 | 2 | B | MB-SMF registration and discovery - Updates | 17.4.0 | +| 2021-12 | CT#94 | CP-213086 | 0579 | 2 | F | Correction on service operation description | 17.4.0 | +| 2021-12 | CT#94 | CP-213085 | 0581 | 1 | B | Discovering whether Oauth2 authorization is required for accessing NRF services | 17.4.0 | +| 2021-12 | CT#94 | CP-213108 | 0584 | 1 | B | BSF NF Profile definition for DCAMP | 17.4.0 | +| 2021-12 | CT#94 | CP-213108 | 0585 | 1 | B | New PCF Service Name for PCF AM Policy Authorization | 17.4.0 | +| 2021-12 | CT#94 | CP-213097 | 0586 | 1 | B | MB-UPF registration and discovery | 17.4.0 | +| 2021-12 | CT#94 | CP-213093 | 0587 | 1 | B | Support for Service Specific Authorization | 17.4.0 | +| 2021-12 | CT#94 | CP-213102 | 0588 | 3 | B | AF Slice and DNN registration via NEF | 17.4.0 | +| 2021-12 | CT#94 | CP-213096 | 0590 | - | B | LMFInfo update for SAT access | 17.4.0 | +| 2021-12 | CT#94 | CP-213093 | 0591 | 1 | B | EASDF discovery based on UPF N6 address | 17.4.0 | +| 2021-12 | CT#94 | CP-213093 | 0592 | 1 | B | Local NEF discovery based on list of TAs | 17.4.0 | +| 2021-12 | CT#94 | CP-213102 | 0593 | 1 | B | Trusted AF registration and discovery | 17.4.0 | +| 2021-12 | CT#94 | CP-213092 | 0595 | 1 | F | Correction of NSACF discovery | 17.4.0 | +| 2021-12 | CT#94 | CP-213085 | 0596 | - | F | Correction on ScpDomainInfo | 17.4.0 | +| 2021-12 | CT#94 | CP-213101 | 0597 | 2 | B | ServiceName data type extension to cover the missing TSCTSF and NEF services | 17.4.0 | +| 2021-12 | CT#94 | CP-213086 | 0599 | 1 | B | Precedence of Preferred Parameters | 17.4.0 | +| 2021-12 | CT#94 | CP-213193 | 0603 | 2 | A | GMLC-Number in GmlcInfo | 17.4.0 | +| 2021-12 | CT#94 | CP-213097 | 0606 | 1 | B | Selection of collocated MB-SMF/SMF and MB-UPF/UPF | 17.4.0 | +| 2021-12 | CT#94 | CP-213091 | 0608 | - | B | New Service Names for HSS GBA Services | 17.4.0 | +| 2021-12 | CT#94 | CP-213087 | 0609 | 1 | B | Group ranges in HSS Info | 17.4.0 | +| 2021-12 | CT#94 | CP-213093 | 0610 | - | B | EASDF Baseline DNS Pattern service | 17.4.0 | +| 2021-12 | CT#94 | CP-213097 | 0611 | - | B | New services for MBS | 17.4.0 | +| 2021-12 | CT#94 | CP-213116 | 0612 | - | F | Incorrect reference to NF Service Set ID definition in TS 23.003 | 17.4.0 | +| 2021-12 | CT#94 | CP-213116 | 0613 | - | F | requester-plmn-list query parameter | 17.4.0 | +| 2021-12 | CT#94 | CP-213088 | 0615 | 1 | F | NRF Hierarchy | 17.4.0 | +| 2021-12 | CT#94 | CP-213087 | 0617 | 1 | B | Discovery Result Change Notification | 17.4.0 | +| 2021-12 | CT#94 | CP-213131 | 0619 | 1 | F | NF Service Redundancy Level | 17.4.0 | +| 2021-12 | CT#94 | CP-213201 | 0623 | 2 | B | hNRF URI | 17.4.0 | +| 2021-12 | CT#94 | CP-213088 | 0625 | - | A | NFType value for CEF | 17.4.0 | +| 2021-12 | CT#94 | CP-213087 | 0626 | 1 | F | Subscription on SCP domain | 17.4.0 | +| 2021-12 | CT#94 | CP-213087 | 0627 | 1 | B | PLMN Specific attributes in NF profile | 17.4.0 | +| 2021-12 | CT#94 | CP-213121 | 0628 | - | F | 29.510 Rel-17 API version and External doc update | 17.4.0 | +| 2022-03 | CT#95 | CP-220047 | 0630 | 6 | B | SNPN impacts on NRF - DCS/CH identification | 17.5.0 | +| 2022-03 | CT#95 | CP-220047 | 0632 | - | F | SNPN impacts on NRF services - R17 | 17.5.0 | +| 2022-03 | CT#95 | CP-220267 | 0633 | 2 | F | SNPN impacts on NRF - OnboardingCapability | 17.5.0 | +| 2022-03 | CT#95 | CP-220023 | 0634 | 1 | F | Static Authorization | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0636 | 1 | B | MB-SMF discovery by AMF using MBS Session ID and Area Session ID | 17.5.0 | +| 2022-03 | CT#95 | CP-220088 | 0637 | - | F | AMF name in N2InterfaceAmfInfo | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0638 | 1 | B | Returning NRF altered priorities when using the Enhanced NF Discovery feature | 17.5.0 | +| 2022-03 | CT#95 | CP-220044 | 0639 | 1 | B | UAS Capability Indication for NEF | 17.5.0 | +| 2022-03 | CT#95 | CP-220044 | 0640 | - | B | UAS Service Name | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0642 | 2 | F | SUCI information corrections | 17.5.0 | +| 2022-03 | CT#95 | CP-220043 | 0643 | 3 | B | Add ProSe Capability in Pcflnfo | 17.5.0 | +| 2022-03 | CT#95 | CP-220056 | 0645 | 2 | B | Add V2X Capability | 17.5.0 | +| 2022-03 | CT#95 | CP-220057 | 0646 | 2 | B | NSSAAF registration and discovery | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0648 | 2 | F | Handling of PLMN ID in Subscription to NF Profile Change | 17.5.0 | +| 2022-03 | CT#95 | CP-220036 | 0649 | 1 | B | Data Restoration Default Notification | 17.5.0 | +| 2022-03 | CT#95 | CP-220023 | 0651 | - | F | NSACF Information | 17.5.0 | +| 2022-03 | CT#95 | CP-220047 | 0652 | - | B | NSSAAF AIW Service Name | 17.5.0 | +| 2022-03 | CT#95 | CP-220148 | 0653 | 4 | B | Subscription Context in Notifications | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0654 | 1 | B | Resource-based authorization on the NRF APIs | 17.5.0 | +| 2022-03 | CT#95 | CP-220092 | 0655 | - | F | NF (Service) Set Status Change | 17.5.0 | +| 2022-03 | CT#95 | CP-220023 | 0657 | 1 | B | Preferred PGW Query Parameter | 17.5.0 | +| 2022-03 | CT#95 | CP-220048 | 0658 | 1 | B | TSCTSF Discovery | 17.5.0 | +| 2022-03 | CT#95 | CP-220049 | 0659 | 1 | B | AF registration with support of mapping between UE IP address and UE ID | 17.5.0 | +| 2022-03 | CT#95 | CP-220092 | 0667 | - | F | ServiceName data type extension to cover the missing NEF services | 17.5.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-----------------------------------------------------------------------------------|--------| +| 2022-03 | CT#95 | CP-220053 | 0669 | 1 | B | NSWO NF | 17.5.0 | +| 2022-03 | CT#95 | CP-220025 | 0670 | 1 | F | UDR storing of non-subscriber related data | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0671 | - | B | UDR storing data sub-sets | 17.5.0 | +| 2022-03 | CT#95 | CP-220088 | 0672 | - | F | Subscription with GuamiListCond | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0673 | - | F | Bootstrapping headers | 17.5.0 | +| 2022-03 | CT#95 | CP-220084 | 0676 | - | A | Encoding of Access Token Request | 17.5.0 | +| 2022-03 | CT#95 | CP-220025 | 0677 | 1 | B | P-CSCF Restoration Enhancements | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0678 | - | F | HSS Type is missing for NfGroupCond | 17.5.0 | +| 2022-03 | CT#95 | CP-220049 | 0685 | 1 | B | Corrections to Authorization procedure for eNA scenario | 17.5.0 | +| 2022-03 | CT#95 | CP-220032 | 0686 | 1 | F | Subscription Id in message body | 17.5.0 | +| 2022-03 | CT#95 | CP-220025 | 0687 | 1 | F | Error responses to NRF OAuth 2.0 Access Token Request | 17.5.0 | +| 2022-03 | CT#95 | CP-220025 | 0688 | 1 | B | NRF Set support | 17.5.0 | +| 2022-03 | CT#95 | CP-220066 | 0689 | - | F | 29.510 Rel-17 API version and External doc update | 17.5.0 | +| 2022-06 | CT#96 | CP-221049 | 0692 | 6 | F | Adding ismfSupportInd to the SmfInfo | 17.6.0 | +| 2022-06 | CT#96 | CP-221028 | 0694 | 2 | F | Correction and clarification on NotificationType | 17.6.0 | +| 2022-06 | CT#96 | CP-221049 | 0698 | 1 | F | Supported PLMN for CHF Discovery | 17.6.0 | +| 2022-06 | CT#96 | CP-221043 | 0699 | - | B | PKMF Function and Service | 17.6.0 | +| 2022-06 | CT#96 | CP-221023 | 0700 | - | F | MBS Service Area Information for Location dependent MBS session | 17.6.0 | +| 2022-06 | CT#96 | CP-221028 | 0701 | 1 | A | SMF profile without smfInfo and smfInfoList attributes | 17.6.0 | +| 2022-06 | CT#96 | CP-221023 | 0702 | - | F | MBS NF types | 17.6.0 | +| 2022-06 | CT#96 | CP-221028 | 0703 | 1 | F | Description Fields | 17.6.0 | +| 2022-06 | CT#96 | CP-221029 | 0704 | 2 | F | Fqdn Data Type Definition | 17.6.0 | +| 2022-06 | CT#96 | CP-221031 | 0705 | - | B | Target Network Resolution | 17.6.0 | +| 2022-06 | CT#96 | CP-221031 | 0708 | 3 | B | Support of MNP | 17.6.0 | +| 2022-06 | CT#96 | CP-221027 | 0709 | - | F | Oauth2 scopes | 17.6.0 | +| 2022-06 | CT#96 | CP-221038 | 0710 | 1 | F | NWDAF Discovery | 17.6.0 | +| 2022-06 | CT#96 | CP-221036 | 0712 | - | B | Remote SNPNs reachable through an SCP or SEPP | 17.6.0 | +| 2022-06 | CT#96 | CP-221049 | 0714 | - | F | Delete the default value of vsmfSupportInd in A.2 | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0715 | 1 | B | MBSF/MB-STF profiles in NRF | 17.6.0 | +| 2022-06 | CT#96 | CP-221036 | 0716 | - | F | SMF UP remote provisioning capability | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0717 | 1 | F | MB-SMF discovering AMF(s) | 17.6.0 | +| 2022-06 | CT#96 | CP-221028 | 0718 | - | F | HSS Diameter Address | 17.6.0 | +| 2022-06 | CT#96 | CP-221028 | 0719 | - | F | Locality Based Priority | 17.6.0 | +| 2022-06 | CT#96 | CP-221028 | 0720 | - | F | Application Data Subsets | 17.6.0 | +| 2022-06 | CT#96 | CP-221038 | 0721 | - | F | Clarification of DCCF Info and NWDAF Info | 17.6.0 | +| 2022-06 | CT#96 | CP-221029 | 0722 | 1 | F | Encoding of Query Parameters | 17.6.0 | +| 2022-06 | CT#96 | CP-221037 | 0723 | - | F | New Service Names | 17.6.0 | +| 2022-06 | CT#96 | CP-221031 | 0724 | - | B | NF registration and discovery of SMS-IWMSC | 17.6.0 | +| 2022-06 | CT#96 | CP-221037 | 0725 | 1 | F | TSCTS Default Notification | 17.6.0 | +| 2022-06 | CT#96 | CP-221029 | 0726 | - | F | NRF Bootstrapping Headers | 17.6.0 | +| 2022-06 | CT#96 | CP-221051 | 0728 | - | F | 29.510 Rel-17 API version and External doc update | 17.6.0 | +| 2022-09 | CT#97 | CP-222026 | 0729 | - | F | Add seppPrefix attribute in SEPP profile | 17.7.0 | +| 2022-09 | CT#97 | CP-222037 | 0730 | - | F | CH/DCS using AAA-S vs AUSF/UDM | 17.7.0 | +| 2022-09 | CT#97 | CP-222027 | 0732 | 1 | F | nudm-rsds Service | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0734 | 1 | F | Removing an editor's note | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0738 | - | F | Clarifications to the definition of the PreferredSearch data type | 17.7.0 | +| 2022-09 | CT#97 | CP-222050 | 0739 | - | F | allowedOperationsPerNfType IE and allowedOperationsPerNfInstance IE in NFService | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0740 | - | F | Excluding NF (service) instances or NF (service) sets from NF Discovery procedure | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0741 | - | F | SD ranges and wildcard SD | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0742 | 1 | F | Clarification on Home Network Public Key used for Routing | 17.7.0 | +| 2022-09 | CT#97 | CP-222050 | 0744 | - | F | Extend AccessTokenClaim to include producerNfServiceSetId | 17.7.0 | +| 2022-09 | CT#97 | CP-222037 | 0745 | - | F | Extend AccessTokenReq and AccessTokenclaims to include SNPN-ID | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0746 | 2 | F | No Profile Match information | 17.7.0 | +| 2022-09 | CT#97 | CP-222037 | 0747 | 1 | F | SMF UPRP capability | 17.7.0 | +| 2022-09 | CT#97 | CP-222035 | 0748 | - | F | ProSe Anchor Function Support | 17.7.0 | +| 2022-09 | CT#97 | CP-222050 | 0749 | 1 | F | IP Index in UPF Information | 17.7.0 | +| 2022-09 | CT#97 | CP-222050 | 0750 | 1 | F | NRF Altered Priority for Enhanced NF Discovery | 17.7.0 | +| 2022-09 | CT#97 | CP-222050 | 0752 | 1 | F | Service Specific Info for Default Notification Subscription | 17.7.0 | +| 2022-09 | CT#97 | CP-222038 | 0753 | 2 | F | NWDAF discovery based on Analytics Delay | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0754 | 1 | F | Unknown NF Instance Id in subscription | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0755 | - | F | Clarification of NF Discovery Service Description | 17.7.0 | +| 2022-09 | CT#97 | CP-222058 | 0759 | - | F | 29.510 Rel-17 API version and External doc update | 17.7.0 | +| 2022-09 | CT#97 | CP-222021 | 0733 | - | B | Additional HSS Diameter Addresses in HssInfo | 18.0.0 | +| 2022-09 | CT#97 | CP-222021 | 0735 | 2 | B | Locality based NF Discovery enhancements | 18.0.0 | +| 2022-09 | CT#97 | CP-222021 | 0756 | 1 | B | Allowed Operations per NF Type or NF Instance | 18.0.0 | +| 2022-09 | CT#97 | CP-222025 | 0761 | - | F | 29.510 Rel-18 API version and External doc update | 18.0.0 | +| 2022-12 | CT#98 | CP-223029 | 0737 | 2 | B | SEPP registration and discovery with N32 purpose | 18.1.0 | +| 2022-12 | CT#98 | CP-223067 | 0765 | 1 | A | Notification Type for Delivery of Ciphering Key Information | 18.1.0 | +| 2022-12 | CT#98 | CP-223029 | 0766 | 3 | F | IP Ranges and IP Index | 18.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------------|--------| +| 2022-12 | CT#98 | CP-223027 | 0767 | 1 | F | Default network instance for a S-NSSAI and DNN | 18.1.0 | +| 2022-12 | CT#98 | CP-223029 | 0768 | 2 | B | UPF Selection | 18.1.0 | +| 2022-12 | CT#98 | CP-223088 | 0769 | 2 | B | Discovery by SCP of complete NF Profile | 18.1.0 | +| 2022-12 | CT#98 | CP-223044 | 0772 | 2 | A | NSACF Discovery with Locality | 18.1.0 | +| 2022-12 | CT#98 | CP-223090 | 0773 | 2 | B | Preferred Features | 18.1.0 | +| 2022-12 | CT#98 | CP-223029 | 0774 | 3 | B | SMSF For Roaming UEs | 18.1.0 | +| 2022-12 | CT#98 | CP-223027 | 0775 | - | F | Additional HSS Diameter Addresses in HssInfo | 18.1.0 | +| 2022-12 | CT#98 | CP-223027 | 0782 | 1 | F | OpenApi Semantic Checks | 18.1.0 | +| 2022-12 | CT#98 | CP-223027 | 0783 | - | F | Clarification of IpEndPoint | 18.1.0 | +| 2022-12 | CT#98 | CP-223029 | 0784 | 2 | F | Optimization of NF service discovery for avoiding duplicated signaling overhead | 18.1.0 | +| 2022-12 | CT#98 | CP-223033 | 0785 | - | F | 29.510 Rel-18 API version and External doc update | 18.1.0 | +| 2023-03 | CT#99 | CP-230077 | 0789 | 2 | F | Reusing tai-list URI query parameter for 5MBS | 18.2.0 | +| 2023-03 | CT#99 | CP-230029 | 0791 | 1 | F | Interpretation of False Value in Query Parameters | 18.2.0 | +| 2023-03 | CT#99 | CP-230085 | 0793 | 3 | A | AMF Support for High Latency Communication | 18.2.0 | +| 2023-03 | CT#99 | CP-230034 | 0794 | - | B | Registration and Discovery of UPF Event Exposure service | 18.2.0 | +| 2023-03 | CT#99 | CP-230029 | 0795 | 1 | B | Retrieving NF profiles of a list of target NF Instance IDs | 18.2.0 | +| 2023-03 | CT#99 | CP-230029 | 0796 | - | F | nfServiceList in NotificationData | 18.2.0 | +| 2023-03 | CT#99 | CP-230029 | 0797 | 1 | F | nfSetId in AMF profile | 18.2.0 | +| 2023-03 | CT#99 | CP-230057 | 0798 | - | F | allowedSnpons in NF profile and requester-snpon-list in NF Discovery Request | 18.2.0 | +| 2023-03 | CT#99 | CP-230057 | 0799 | - | F | plmnList IE in NF profile of an NF pertaining to an SNPN | 18.2.0 | +| 2023-03 | CT#99 | CP-230059 | 0800 | - | F | requesterSnssaiList IE in Access Token Request | 18.2.0 | +| 2023-03 | CT#99 | CP-230077 | 0802 | - | A | Errors in the definition of the collocatedNfInstances IE | 18.2.0 | +| 2023-03 | CT#99 | CP-230034 | 0805 | 1 | B | Discovery of the serving UPF for a PDU session using NATed IP address | 18.2.0 | +| 2023-03 | CT#99 | CP-230081 | 0807 | - | A | Nudm UE Identifier Service | 18.2.0 | +| 2023-03 | CT#99 | CP-230094 | 0810 | - | A | Essential Correction for Requester-Features Query Parameter | 18.2.0 | +| 2023-03 | CT#99 | CP-230029 | 0812 | - | F | Lower case of UUIDs in URIs | 18.2.0 | +| 2023-03 | CT#99 | CP-230064 | 0816 | 2 | F | URI scheme used for inter-PLMN signalling | 18.2.0 | +| 2023-03 | CT#99 | CP-230071 | 0817 | - | F | 29.510 Rel-18 API version and External doc update | 18.2.0 | +| 2023-06 | CT#100 | CP-231025 | 0819 | - | F | allowedNfTypes contradiction correction | 18.3.0 | +| 2023-06 | CT#100 | CP-231031 | 0820 | 1 | B | PRU serving LMF(s) discovery | 18.3.0 | +| 2023-06 | CT#100 | CP-231122 | 0821 | 2 | B | GNSS assistance data collection from AF | 18.3.0 | +| 2023-06 | CT#100 | CP-231047 | 0823 | 1 | B | NWDAF selection on support ML model sharing | 18.3.0 | +| 2023-06 | CT#100 | CP-231084 | 0827 | 1 | A | Align the description of Requester PLMN List IEs | 18.3.0 | +| 2023-06 | CT#100 | CP-231123 | 0828 | 1 | B | Enhancement of NRF services to support DCSF registration and discovery | 18.3.0 | +| 2023-06 | CT#100 | CP-231079 | 0832 | - | A | Handling of NRF Subscriptions in SNPN scenarios | 18.3.0 | +| 2023-06 | CT#100 | CP-231028 | 0833 | 1 | F | Content of Profile Update response messages | 18.3.0 | +| 2023-06 | CT#100 | CP-231035 | 0835 | 2 | F | Clarification for NATed IP Address | 18.3.0 | +| 2023-06 | CT#100 | CP-231035 | 0836 | 1 | B | Registration and Discovery of Nupf_GetPrivateUEIPaddr service | 18.3.0 | +| 2023-06 | CT#100 | CP-231050 | 0837 | 3 | B | NRF service enhancement to support MRF registration and discovery | 18.3.0 | +| 2023-06 | CT#100 | CP-231078 | 0840 | 1 | A | Add service Npanf_ResolveRemoteUserId | 18.3.0 | +| 2023-06 | CT#100 | CP-231078 | 0842 | 1 | A | Add service Npkmf_ResolveRemoteUserId | 18.3.0 | +| 2023-06 | CT#100 | CP-231042 | 0843 | - | B | Add PCF capability of supporting 5G ProSe UE-to-UE relay | 18.3.0 | +| 2023-06 | CT#100 | CP-231050 | 0844 | 3 | B | NRF service enhancement to support DCMF registration and discovery | 18.3.0 | +| 2023-06 | CT#100 | CP-231073 | 0846 | - | A | Default Notification for Inter-Plmn Access | 18.3.0 | +| 2023-06 | CT#100 | CP-231028 | 0847 | 1 | B | Indication of Ignored Query Parameters | 18.3.0 | +| 2023-06 | CT#100 | CP-231084 | 0849 | 1 | A | Unsupported Query Parameter Handling | 18.3.0 | +| 2023-06 | CT#100 | CP-231047 | 0850 | - | B | Accuracy checking capability in NWDAF | 18.3.0 | +| 2023-06 | CT#100 | CP-231047 | 0851 | 2 | B | NWDAF containing MTLF selection | 18.3.0 | +| 2023-06 | CT#100 | CP-231071 | 0854 | 2 | A | Removal of OpenAPI constraint for interPlmnFqdn in NotificationData | 18.3.0 | +| 2023-06 | CT#100 | CP-231028 | 0855 | - | D | Typo correction | 18.3.0 | +| 2023-06 | CT#100 | CP-231070 | 0856 | - | F | 29.510 Rel-18 API version and External doc update | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0770 | 5 | B | Enhancements to Authorization Policy in NF-Service Profile | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0852 | 4 | B | Support for Canary Testing via NRF | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0858 | - | F | NefInfo clarification | 18.4.0 | +| 2023-09 | CT#101 | CP-232050 | 0859 | 1 | B | NEF Registration and Discovery for Multi-member AF session capability | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0863 | 1 | B | Additional OAuth2 scope for the NRF Management API | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0864 | 1 | B | Prefix in Callback URIs | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0865 | - | F | Array cardinality correction | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0867 | 2 | B | NF Instances supporting at least one TA in the ta-list | 18.4.0 | +| 2023-09 | CT#101 | CP-232042 | 0868 | 2 | B | Extension of NWDAF registration information to reflect roaming exchange capability | 18.4.0 | +| 2023-09 | CT#101 | CP-232050 | 0869 | 1 | B | New PCF and NEF services | 18.4.0 | +| 2023-09 | CT#101 | CP-232050 | 0870 | - | B | New PDTQ related UDR PolicyData subset | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0871 | - | F | Removal of OpenAPI constraint for interPlmnFqdn in NotificationData | 18.4.0 | +| 2023-09 | CT#101 | CP-232046 | 0872 | - | B | PCF selection for A2X | 18.4.0 | +| 2023-09 | CT#101 | CP-232045 | 0873 | 1 | B | Missing ims-domain-name and media-capability-list in the OpenAPI of Nnrf_NFDiscovery Service API | 18.4.0 | +| 2023-09 | CT#101 | CP-232035 | 0874 | 1 | B | Support PRU function of LMF profile | 18.4.0 | +| 2023-09 | CT#101 | CP-232047 | 0876 | 1 | A | Default Notification Type for UUAA-MM | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0877 | 2 | B | Preferred UPF Selection for Non-3GPP PDU Session | 18.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------|--------| +| 2023-09 | CT#101 | CP-232078 | 0881 | 1 | A | Essential Correction on Notification Data for NF Instance Removed from NF Set | 18.4.0 | +| 2023-09 | CT#101 | CP-232042 | 0883 | 1 | B | ADRF registration and discovery | 18.4.0 | +| 2023-09 | CT#101 | CP-232042 | 0885 | 1 | B | Support for relocation of data subscription as a new capability of DCCF | 18.4.0 | +| 2023-09 | CT#101 | CP-232045 | 0886 | 3 | F | Change DCMF to MF | 18.4.0 | +| 2023-09 | CT#101 | CP-232049 | 0887 | 1 | B | Update on LMF selection for Ranging_SL | 18.4.0 | +| 2023-09 | CT#101 | CP-232049 | 0888 | 2 | B | Update on PCF selection for Ranging_SL | 18.4.0 | +| 2023-09 | CT#101 | CP-232060 | 0890 | - | F | 29.510 Rel-18 API version and External doc update | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0893 | 4 | B | NSACF Role Definition | 18.5.0 | +| 2023-12 | CT#102 | CP-233039 | 0895 | 1 | B | NSACF Capability for counting the number of UEs with at least one PDU session / PDN connection | 18.5.0 | +| 2023-12 | CT#102 | CP-233027 | 0896 | - | F | PGW IP addresses in SmfInfo | 18.5.0 | +| 2023-12 | CT#102 | CP-233028 | 0897 | 1 | B | Callback URI prefix | 18.5.0 | +| 2023-12 | CT#102 | CP-233027 | 0898 | - | F | Corrections of the service-names and validityPeriod IEs | 18.5.0 | +| 2023-12 | CT#102 | CP-233059 | 0900 | 1 | B | Mapping between Routing Indicator and NF Group ID | 18.5.0 | +| 2023-12 | CT#102 | CP-233027 | 0901 | - | B | Resolution of Editor's Note on Canary Release tests | 18.5.0 | +| 2023-12 | CT#102 | CP-233028 | 0902 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.5.0 | +| 2023-12 | CT#102 | CP-233030 | 0903 | 2 | F | Clarification of lpEndpoint data structure | 18.5.0 | +| 2023-12 | CT#102 | CP-233029 | 0904 | 1 | B | ProblemDetails RFC 7807 obsoleted by 9457 | 18.5.0 | +| 2023-12 | CT#102 | CP-233048 | 0906 | - | B | Remove EN for IP address and IP range used for MF registration and discovery | 18.5.0 | +| 2023-12 | CT#102 | CP-233045 | 0909 | - | F | Completing the description of roaming-exchange-ind | 18.5.0 | +| 2023-12 | CT#102 | CP-233045 | 0910 | 1 | B | Completion and alignment of ADRF information for registration and discovery | 18.5.0 | +| 2023-12 | CT#102 | CP-233037 | 0911 | 1 | B | User plane positioning capability of LMF | 18.5.0 | +| 2023-12 | CT#102 | CP-233031 | 0914 | 6 | B | Indication in NF registration for authorization based on sufficient slice information | 18.5.0 | +| 2023-12 | CT#102 | CP-233050 | 0915 | - | B | Update to support SLPKMF | 18.5.0 | +| 2023-12 | CT#102 | CP-233064 | 0918 | 6 | B | NSAC service area support for hplmn and vplmn NF consumers | 18.5.0 | +| 2023-12 | CT#102 | CP-233047 | 0919 | - | F | Missing DataSetIds in UdrInfo | 18.5.0 | +| 2023-12 | CT#102 | CP-233069 | 0921 | - | A | Service Name for Npkmf_Discovery Service | 18.5.0 | +| 2023-12 | CT#102 | CP-233031 | 0923 | 3 | B | S-NSSAIs in NF Discovery Result | 18.5.0 | +| 2023-12 | CT#102 | CP-233041 | 0925 | 1 | B | Discovering all the NF profiles or NF Instance IDs matching the query parameters | 18.5.0 | +| 2023-12 | CT#102 | CP-233032 | 0926 | - | B | Nnef_DNAIMapping service | 18.5.0 | +| 2023-12 | CT#102 | CP-233038 | 0927 | - | B | Nnef_TrafficInfluenceData and Nnef_ECSAddress services | 18.5.0 | +| 2023-12 | CT#102 | CP-233044 | 0928 | - | F | Naf_ProSe and Naf_EventExposure services | 18.5.0 | +| 2023-12 | CT#102 | CP-233044 | 0929 | - | F | Incorrect cardinality of the mbs-session-id-list query parameter | 18.5.0 | +| 2023-12 | CT#102 | CP-233063 | 0931 | - | A | MBS services and data set | 18.5.0 | +| 2023-12 | CT#102 | CP-233075 | 0932 | 1 | B | Additional User Plane Interfaces | 18.5.0 | +| 2023-12 | CT#102 | CP-233031 | 0933 | 2 | B | Traffic Separation at User Plane Interfaces | 18.5.0 | +| 2023-12 | CT#102 | CP-233048 | 0935 | 1 | B | Update the MediaCapability data type to string | 18.5.0 | +| 2023-12 | CT#102 | CP-233045 | 0936 | 3 | F | Corrections of the input parameters for discovery of NWDAF with FL capability | 18.5.0 | +| 2023-12 | CT#102 | CP-233050 | 0937 | - | F | Correction of query parameter Ranging-SI-Pos-Indication | 18.5.0 | +| 2023-12 | CT#102 | CP-233059 | 0938 | 4 | B | Simplifying the NF service discovery response of inter-PLMN | 18.5.0 | +| 2023-12 | CT#102 | CP-233046 | 0942 | 1 | B | Extending the description of sNSSAIs to SNPn | 18.5.0 | +| 2023-12 | CT#102 | CP-233032 | 0943 | 1 | B | Aligning the service name with stage-2 specification | 18.5.0 | +| 2023-12 | CT#102 | CP-233045 | 0945 | 1 | B | Adding new data analytics services in enumeration table | 18.5.0 | +| 2023-12 | CT#102 | CP-233060 | 0947 | - | F | 29.510 Rel-18 API version and External doc update | 18.5.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29517/raw.md b/raw/rel-18/29_series/29517/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..50a202fd31488b7bfe869bc5e4ee1d02576afa40 --- /dev/null +++ b/raw/rel-18/29_series/29517/raw.md @@ -0,0 +1,3022 @@ + + +# 3GPP TS 29.517 V18.4.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Application Function Event Exposure Service; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +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. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +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. + +3GPP logo + +## --- Keywords --- + +## **3GPP** + +## --- Postal address --- + +## 3GPP support office address --- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 +Intpp.org + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +## Contents + +| | | +|-----------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions of terms, symbols and abbreviations..... | 8 | +| 3.1 Terms..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Naf_EventExposure Service ..... | 9 | +| 4.1 Service Description ..... | 9 | +| 4.1.1 Overview ..... | 9 | +| 4.1.2 Service Architecture ..... | 10 | +| 4.1.3 Network Functions ..... | 10 | +| 4.1.3.1 Application Function (AF)..... | 10 | +| 4.1.3.2 NF Service Consumers ..... | 10 | +| 4.2 Service Operations ..... | 11 | +| 4.2.1 Introduction ..... | 11 | +| 4.2.2 Naf_EventExposure_Subscribe service operation..... | 11 | +| 4.2.2.1 General..... | 11 | +| 4.2.2.2 Creating a new subscription..... | 12 | +| 4.2.2.3 Modifying an existing subscription ..... | 16 | +| 4.2.3 Naf_EventExposure_Unsubscribe service operation ..... | 17 | +| 4.2.3.1 General..... | 17 | +| 4.2.3.2 Unsubscription from event notifications..... | 17 | +| 4.2.4 Naf_EventExposure_Notify service operation..... | 18 | +| 4.2.4.1 General..... | 18 | +| 4.2.4.2 Notification about subscribed events ..... | 18 | +| 5 Naf_EventExposure Service API..... | 20 | +| 5.1 Introduction ..... | 20 | +| 5.2 Usage of HTTP..... | 20 | +| 5.2.1 General ..... | 20 | +| 5.2.2 HTTP standard headers ..... | 21 | +| 5.2.2.1 General..... | 21 | +| 5.2.2.2 Content type..... | 21 | +| 5.2.3 HTTP custom headers ..... | 21 | +| 5.2.3.1 General..... | 21 | +| 5.3 Resources ..... | 21 | +| 5.3.1 Resource Structure..... | 21 | +| 5.3.2 Resource: Application Event Subscriptions ..... | 22 | +| 5.3.2.1 Description..... | 22 | +| 5.3.2.2 Resource definition..... | 22 | +| 5.3.2.3 Resource Standard Methods ..... | 22 | +| 5.3.2.3.1 POST ..... | 22 | +| 5.3.3 Resource: Individual Application Event Subscription ..... | 23 | +| 5.3.3.1 Description..... | 23 | +| 5.3.3.2 Resource definition..... | 23 | +| 5.3.3.3 Resource Standard Methods ..... | 23 | +| 5.3.3.3.1 GET ..... | 23 | +| 5.3.3.3.2 PUT ..... | 24 | +| 5.3.3.3.3 DELETE..... | 25 | +| 5.4 Custom Operations without associated resources ..... | 27 | +| 5.5 Notifications ..... | 27 | +| 5.5.1 General ..... | 27 | +| 5.5.2 Application Event Notification..... | 27 | +| 5.5.2.1 Description..... | 27 | + +| | | | +|--------------------------------------------------------|-------------------------------------------------|-----------| +| 5.5.2.2 | Target URI ..... | 27 | +| 5.5.2.3 | Standard Methods ..... | 27 | +| 5.5.2.3.1 | POST ..... | 27 | +| 5.6 | Data Model..... | 28 | +| 5.6.1 | General ..... | 28 | +| 5.6.2 | Structured data types ..... | 32 | +| 5.6.2.1 | Introduction..... | 32 | +| 5.6.2.2 | Type AfEventExposureSubsc ..... | 32 | +| 5.6.2.3 | Type AfEventExposureNotif ..... | 32 | +| 5.6.2.4 | Type EventsSubs..... | 33 | +| 5.6.2.5 | Type EventFilter ..... | 34 | +| 5.6.2.6 | Type AfEventNotification ..... | 36 | +| 5.6.2.7 | Type ServiceExperienceInfoPerApp ..... | 38 | +| 5.6.2.8 | Type ServiceExperienceInfoPerFlow ..... | 39 | +| 5.6.2.9 | Type SvcExperience ..... | 39 | +| 5.6.2.10 | Type UeMobilityCollection..... | 39 | +| 5.6.2.11 | Type UeCommunicationCollection ..... | 40 | +| 5.6.2.12 | Type UeTrajectoryCollection ..... | 40 | +| 5.6.2.13 | Type CommunicationCollection..... | 40 | +| 5.6.2.14 | Type ExceptionInfo ..... | 41 | +| 5.6.2.15 | Type UserDataCongestionCollection ..... | 41 | +| 5.6.2.16 | Type PerformanceDataCollection..... | 41 | +| 5.6.2.17 | Type PerformanceData ..... | 42 | +| 5.6.2.18 | Type AddrFqdn..... | 42 | +| 5.6.2.19 | Type CollectiveBehaviourFilter ..... | 43 | +| 5.6.2.20 | Type CollectiveBehaviourInfo ..... | 43 | +| 5.6.2.21 | Type DispersionCollection ..... | 44 | +| 5.6.2.22 | Type PerUeAttribute..... | 44 | +| 5.6.2.23 | Type MsQoeMetricsCollection..... | 44 | +| 5.6.2.24 | Type MsConsumptionCollection..... | 45 | +| 5.6.2.25 | Type MsNetAssInvocationCollection..... | 45 | +| 5.6.2.26 | Type MsDynPolicyInvocationCollection ..... | 45 | +| 5.6.2.27 | Type MSAccessActivityCollection ..... | 45 | +| 5.6.2.28 | Type DatVolTransTimeCollection ..... | 46 | +| 5.6.3 | Simple data types and enumerations ..... | 46 | +| 5.6.3.1 | Introduction..... | 46 | +| 5.6.3.2 | Simple data types..... | 46 | +| 5.6.3.3 | Enumeration: AfEvent ..... | 46 | +| 5.6.3.4 | Enumeration: CollectiveBehaviourFilterType..... | 47 | +| 5.7 | Error handling ..... | 48 | +| 5.7.1 | General ..... | 48 | +| 5.7.2 | Protocol Errors..... | 48 | +| 5.7.3 | Application Errors ..... | 48 | +| 5.8 | Feature negotiation..... | 48 | +| 5.9 | Security..... | 50 | +| Annex A (normative): OpenAPI specification..... | | 51 | +| A.1 | General..... | 51 | +| A.2 | Naf_EventExposure API..... | 51 | +| Annex B (informative): Change history ..... | | 67 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, certain modal verbs have the following meanings: + +**shall** indicates a mandatory requirement to do something + +**shall not** indicates an interdiction (prohibition) to do something + +NOTE 1: The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +NOTE 2: 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. + +**should** indicates a recommendation to do something + +**should not** indicates a recommendation not to do something + +**may** indicates permission to do something + +**need not** indicates permission not to do something + +NOTE 3: 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. + +**can** indicates that something is possible + +**cannot** indicates that something is impossible + +NOTE 4: The constructions "can" and "cannot" shall not to be used as substitutes for "may" and "need Not". + +**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 + +**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 + +**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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +NOTE 5: The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Application Function Event Exposure Service of the 5G System. It provides stage 3 protocol definitions, message flows and specifies the API for the Naf\_EventExposure service. + +The 5G System stage 2 architecture and the procedures are specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3], and 3GPP TS 23.288 [4]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [5] and 3GPP TS 29.501 [6]. + +The Application Function Event Exposure Service is provided by the Application Function (AF). This service exposes service experience events observed at the AF. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [5] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [6] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [7] IETF RFC 9113: "HTTP/2". +- [8] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] IETF RFC 9457: "Problem Details for HTTP APIs". +- [11] 3GPP TR 21.900: "Technical Specification Group working methods". +- [12] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [13] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [14] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [15] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [16] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". + +- [17] 3GPP TS 29.122: "T8 reference point for northbound Application Programming Interfaces (APIs)". +- [18] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [19] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [20] Void. +- [21] IETF RFC 9112: "HTTP/1.1". +- [22] IETF RFC 9110: "HTTP Semantics". +- [23] Void. +- [24] Void. +- [25] IETF RFC 9111: "HTTP Caching". +- [26] Void. +- [27] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [28] 3GPP TS 26.531: "Data Collection and Reporting; General Description and Architecture". +- [29] 3GPP TS 26.501: "5G Media Streaming (5GMS); General description and architecture". +- [30] 3GPP TS 26.512: "5G Media Streaming (5GMS); Protocols". +- [31] 3GPP TS 29.591: "5G System; Network Exposure Function Southbound Services; Stage 3". +- [32] 3GPP TS 23.273: "5G System (5GS) Location Services (LCS); Stage 2". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +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]. + +(None) + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +(None) + +## 3.3 Abbreviations + +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]. + +| | | +|------|----------------------------------------| +| 5GMS | 5G Media Streaming | +| AF | Application Function | +| ASP | Application Service Provider | +| DCCF | Data Collection Coordination Function | +| DNAI | DN Access Identifier | +| GPSI | Generic Public Subscription Identifier | +| LCS | LoCation Services | + +| | | +|-------|--------------------------------------| +| LMF | Location Management Function | +| MFAF | Messaging Framework Adaptor Function | +| NEF | Network Exposure Function | +| NF | Network Function | +| NWDAF | Network Data Analytics Function | +| SUPI | Subscription Permanent Identifier | +| URI | Uniform Resource Identifier | + +# --- 4 Naf\_EventExposure Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The Application Function Exposure Service, as defined in 3GPP TS 23.502 [3] and 3GPP TS 23.288 [4], is provided by the Application Function (AF). When the UE Application data is collected via the Data Collection AF, the Application Function Exposure Service, as defined in 3GPP TS 26.531 [28], 3GPP TS 26.501 [29], and 3GPP TS 26.512 [30], is provided by the Data Collection AF instantiated in 5GMS AF for the Event Consumer AF instantiated in 5GMS ASP. + +This service: + +- allows NF service consumers to subscribe, modify and unsubscribe for application events; and +- notifies NF service consumers with a corresponding subscription about observed events on the AF. + +The types of observed events include: + +AF application events exposed by AF: + +- Service Experience information for an application; +- UE mobility information; +- UE communication information; +- Exceptions information; +- User Data Congestion information; +- Collective Behaviour information; +- Dispersion information; and +- Performance Data information; +- GNSS Assistance Data information + +UE application events exposed via Data Collection AF: + +- Media Streaming QoE metrics; +- Media Streaming Consumption reports; +- Media Streaming Network Assistance invocation; +- Media Streaming Dynamic Policy invocation; and +- Media Streaming access activity. + +When the event to which the NF service consumer has subscribed occurs, the AF reports the requested information to the NF service consumer based on the event reporting information definition requested by the NF service consumer (see 3GPP TS 23.502 [3]). + +### 4.1.2 Service Architecture + +The Data Analytics Architecture is defined in 3GPP TS 23.288 [4]. The Media Streaming UE application data collection via the Data Collection AF is defined in 3GPP TS 26.531 [28]. The architecture for GNSS Assistance Data Collection for LCS is defined in 3GPP TS 23.273 [27]. + +The Application Function Exposure Service (Naf\_EventExposure) is part of the Naf service-based interface exhibited by the Application Function (AF). + +The known NF service consumers of the Naf\_EventExposure service are the Network Exposure Function (NEF), the Network Data Analytics Function (NWDAF), the Location Management Function (LMF), the Data Collection Coordination Function (DCCF), the Messaging Framework Adaptor Function (MFAF), or the Event Consumer AF in the 5GMS ASP. + +The Naf\_EventExposure service is provided by the AF and consumed by NF service consumers (e.g. NEF, NWDAF, DCCF, MFAF, Event Consumer AF), as shown in figure 4.1.2-1 for the SBI representation model and in figure 4.1.2-2 for reference point representation model. + +![Figure 4.1.2-1: Naf_EventExposure service Architecture, SBI representation. This diagram shows the Service Based Interface (SBI) representation. At the top, a box labeled 'AF' contains an oval labeled 'Naf'. Below this, a vertical line descends to a horizontal line labeled 'Naf_EventExposure'. From this horizontal line, six vertical lines descend to a row of six boxes: 'Event Consumer AF', 'NWDAF', 'DCCF', 'MFAF', 'NEF', and 'LMF'.](54fabc351eda5228d2fa28cd9ba07971_img.jpg) + +Figure 4.1.2-1: Naf\_EventExposure service Architecture, SBI representation. This diagram shows the Service Based Interface (SBI) representation. At the top, a box labeled 'AF' contains an oval labeled 'Naf'. Below this, a vertical line descends to a horizontal line labeled 'Naf\_EventExposure'. From this horizontal line, six vertical lines descend to a row of six boxes: 'Event Consumer AF', 'NWDAF', 'DCCF', 'MFAF', 'NEF', and 'LMF'. + +Figure 4.1.2-1: Naf\_EventExposure service Architecture, SBI representation + +![Figure 4.1.2-2: Naf_EventExposure service Architecture, reference point representation. This diagram shows the reference point representation. At the top, a box labeled 'AF' has six lines radiating downwards to a row of six boxes: 'Event Consumer AF', 'NWDAF', 'DCCF', 'MFAF', 'NEF', and 'LMF'. Each line has a small horizontal tick mark near the top box.](b0211cee4b20034939d883ac0d70f696_img.jpg) + +Figure 4.1.2-2: Naf\_EventExposure service Architecture, reference point representation. This diagram shows the reference point representation. At the top, a box labeled 'AF' has six lines radiating downwards to a row of six boxes: 'Event Consumer AF', 'NWDAF', 'DCCF', 'MFAF', 'NEF', and 'LMF'. Each line has a small horizontal tick mark near the top box. + +Figure 4.1.2-2: Naf\_EventExposure service Architecture, reference point representation + +### 4.1.3 Network Functions + +#### 4.1.3.1 Application Function (AF) + +The AF is a functional element that provides service or application related information to NF service consumers. + +The AF allows NF service consumers to subscribe to and unsubscribe from periodic notifications and/or notifications related to the detection of subscribed event. + +#### 4.1.3.2 NF Service Consumers + +The Network Data Analytics Function (NWDAF), the Data Collection Coordination Function (DCCF), and the Messaging Framework Adaptor Function (MFAF): + +- supports (un)subscribing to notifications of event(s) as described in clause 4.2.2.1; +- supports receiving the notifications of subscribed event(s) from the AF. + +The Network Exposure Function (NEF): + +- supports (un)subscribing to notifications of event(s) as described in clause 4.2.2.1; +- supports receiving the notifications of subscribed event(s) from the AF. + +The Event Consumer Application Function (Event Consumer AF): + +- supports (un)subscribing to notifications of event(s) as described in clause 4.2.2.1; +- supports receiving the notifications of subscribed event(s) from the Data Collection AF. + +The Location Management Function (LMF): + +- supports (un)subscribing to notifications of event(s) as described in clause 4.2.2.1; +- supports receiving the notifications of subscribed event(s) from the AF. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +Service operations defined for the Naf\_EventExposure Service are shown in table 4.2.1-1. + +**Table 4.2.1-1: Naf\_EventExposure Service Operations** + +| Service Operation Name | Description | Initiated by | +|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------| +| Naf_EventExposure_Subscribe | This service operation is used by an NF service consumer to subscribe to, or modify a subscription in the AF for event notifications on a specified application related event for one or more UE(s) or any UE. | NF Consumer (NWDAF, NEF, Event Consumer AF) | +| Naf_EventExposure_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe from event notifications. | NF Consumer (NWDAF, NEF, Event Consumer AF) | +| Naf_EventExposure_Notify | This service operation is used by the AF to report application related event(s) to the NF service consumer which has subscribed to the event report service. | AF/Data Collection AF | + +### 4.2.2 Naf\_EventExposure\_Subscribe service operation + +#### 4.2.2.1 General + +This service operation is used by an NF service consumer to subscribe for event notifications on specific event(s), or to modify an existing subscription. + +The following are the types of events for which a subscription can be made by the NWDAF, DCCF, MFAF, or NEF as the NF service consumer: + +- Service Experience information for an application; +- UE mobility information; +- UE communication information; +- Exceptions information; + +- User Data Congestion information; +- Collective Behaviour information; +- Dispersion information; and +- Performance Data information. +- End-to-end data volume transfer time information. + +The following are the types of events for which a subscription can be made by the NWDAF, DCCF, MFAF, Event Consumer AF, or NEF as the NF service consumer: + +- Media Streaming QoE metrics. + +The following are the types of events for which a subscription can be made by the Event Consumer AF or NEF as the NF service consumer: + +- Media Streaming Consumption reports; +- Media Streaming Network Assistance invocation; +- Media Streaming Dynamic Policy invocation; and +- Media Streaming access activity. + +The following are the types of events for which a subscription can be made by the LMF or NEF as the NF service consumer: + +- GNSS Assistance Data information + +The following procedures using the Naf\_EventExposure\_Subscribe service operation are supported: + +- creating a new subscription; +- modifying an existing subscription. + +#### 4.2.2.2 Creating a new subscription + +Figure 4.2.2.2-1 illustrates the creation of a subscription. + +![Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to an AF, and the AF responds with a 201 Created status.](426efb7efdc753a13f2fa16f7bff9429_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant AF + Note right of NF service consumer: 1. POST .../subscriptions + NF service consumer->>AF: Request + Note left of AF: 2. "201 Created" + AF-->>NF service consumer: Response +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to an AF, and the AF responds with a 201 Created status. + +**Figure 4.2.2.2-1: Creation of a subscription** + +To subscribe to event notifications, the NF service consumer shall send an HTTP POST request to the AF with: "{apiRoot}/naf-eventexposure//subscriptions" as request URI as shown in step 1 of figure 4.2.2.2-1, and the "AfEventExposureSubsc" data structure as request body. + +The "AfEventExposureSubsc" data structure shall include: + +- description of subscribed event information as "eventsSubs" attribute by using one or more "EventsSubs" data; + +- description of the event reporting information as "eventsRepInfo" attribute; +- a URI where to receive the requested notifications as "notifUri" attribute; +- a Notification Correlation Identifier assigned by the NF service consumer for the requested notifications as "notifId" attribute. + +The "AfEventExposureSubsc" data may include: + +- a specific Authorization AS provisioned Data Access Profile Identifier as "dataAccProfId" attribute, if the feature "DataAccProfileId" is supported and the subscribed events including "MS\_QOE\_METRICS", "MS\_CONSUMPTION", "MS\_NET\_ASSIST\_INVOCATION", "MS\_DYN\_POLICY\_INVOCATION", and/or "MS\_ACCESS\_ACTIVITY". + +NOTE 1: The optional Data Access Profile Identifier provisioned by the Authorization AS procedures are specified in clause 5.8 of 3GPP TS 26.531 [28]. + +The "EventsSubs" data shall include: + +- a event to subscribe as a "event" attribute; and +- event filter information as "eventFilter" attribute associated with the event. + +The "eventsRepInfo" attribute may include: + +- event notification method (periodic, one time, on event detection) as "notifMethod" attribute; +- Maximum Number of Reports as "maxReportNbr" attribute; +- Monitoring Duration as "monDur" attribute; +- repetition period for periodic reporting as "repPeriod" attribute; +- immediate reporting indication as "immRep" attribute; +- sampling ratio as "sampRatio" attribute; +- partitioning criteria for partitioning the UEs before performing sampling as "partitionCriteria" attribute if the EneNA feature is supported; +- group reporting guard time as "grpRepTime" attribute; +- a notification flag as "notifFlag" attribute if the EneNA feature is supported; and/or +- notification muting exception instructions within the "notifFlagInstruc" attribute, if the EnhDataMgmt feature is supported and the "notifFlag" attribute is provided and set to "DEACTIVATE". + +The "eventFilter" shall include: + +- identification of target UE(s) to which the subscription applies via : + - 1) identification of individual UE(s) via "gpsi" attribute or "supi" attribute; or + - 2) identification of group(s) of UE(s) via "exterGroupIds" attribute or "interGroupIds" attribute; or + - 3) identification of any UE via "anyUeInd" attribute; or + - 4) identification of a UE with a specific IP address via the "uelpAddr" attribute; + +NOTE 2: It is assumed that the AF is provisioned with the list of UE IDs (GPSIs or SUPIs) belonging to an External or Internal Group ID. + +Depending on the event type: + +- if the feature "ServiceExperience" is supported and the event is "SVC\_EXPERIENCE", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + +- 2) an area of interest via "locArea" attribute. +- if the feature "Exceptions" is supported and the event is "EXCEPTIONS", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute; +- if the feature "UeCommunication" is supported and the event is "UE\_COMM", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "UeMobility" is supported and the event is "UE\_MOBILITY", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "UserDataCongestion" is supported and the event is "USER\_DATA\_CONGESTION", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "PerformanceData" is supported and the event is "PERF\_DATA", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "CollectiveBehaviour" is supported and the event is "COLLECTIVE\_BEHAVIOUR", the "eventFilter" attribute may provide: + - 1) collective attributes information via "collAttrs" attribute; + - 2) an area of interest via "locArea" attribute + - 3) identification of application to which the subscription applies via "appIds" attribute. +- if the feature "Dispersion" is supported and the event is "DISPERSION", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "MSQoeMetrics" is supported and the event is "MS\_QOE\_METRICS", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "MSConsumption" is supported and the event is "MS\_CONSUMPTION", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "MSNetAssInvocation" is supported and the event is "MS\_NET\_ASSIST\_INVOCATION", the "eventFilter" attribute may provide: + +- 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "MSDynPolicyInvocation" is supported and the event is "MS\_DYN\_POLICY\_INVOCATION", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. + - if the feature "MSAccessActivity" is supported and the event is "MS\_ACCESS\_ACTIVITY", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. + - if the feature "DataVolTransferTime" is supported and the event is "E2E\_DATA\_VOL\_TRANS\_TIME", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. + +If the AF cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the AF shall send the HTTP error response as specified in clause 5.7. + +Upon successful reception of the HTTP POST request with "{apiRoot}/naf-eventexposure//subscriptions" as request URI and "AfEventExposureSubsc" data structure as request body, the AF shall create a new "Individual Application Event Subscription" resource, store the subscription and send an HTTP "201 Created" response as shown in step 2 of figure 4.2.2.2-1, containing: + +- a Location header field; and +- an "AfEventExposureSubsc" data type in the content. + +The Location header field shall contain the URI of the created individual application session context resource i.e. "{apiRoot}/naf-eventexposure//subscriptions/{subscriptionId}". + +The "AfEventExposureSubsc" data type content shall contain the representation of the created "Individual Application Event Subscription". + +When the "monDur" attribute is included in the response by the AF, it represents AF selected expiry time that is equal or less than the expiry time received in the request. + +When the "immRep" attribute is included and sets to "true" in the subscription and the subscribed events are available, the AF shall include the reports of the events subscribed, if available, in the HTTP POST response. + +When the sampling ratio as, "sampRatio" attribute, is included in the subscription without a "partitionCriteria" attribute, the AF shall select a random subset of UEs among the target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. If the "partitionCriteria" attribute is additionally included, then the AF shall first partition the UEs according to the value of the "partitionCriteria" attribute and then select a random subset of UEs from each partition according to the sampling ratio and only report the event(s) related to the selected subsets of UEs. + +When the group reporting guard time as the "grpRepTime" attribute is included in the subscription, the AF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then the AF shall notify the NF service consumer using the Naf\_EventExposure\_Notify service operation, as described in clause 4.2.4.2. + +When the "notifFlag" attribute is included and set to "DEACTIVATE" in the request, the AF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the "notifFlag" attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer). When a muting exception occurs, the AF may consider the contents of the "notifFlagInstruct" attribute (if provided) and/or local configuration to determine its actions. + +If the EnhDataMgmt feature is supported and the AF accepts the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it may indicate the applied muting notification settings within the "mutingSetting" attribute in the response. If the AF does not accept the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "MUTING\_INSTR\_NOT\_ACCEPTED". + +#### 4.2.2.3 Modifying an existing subscription + +Figure 4.2.2.3-1 illustrates the modification of an existing subscription. + +![Sequence diagram showing the modification of an existing subscription. The NF service consumer sends a PUT request to the AF. The AF responds with either a 200 OK or a 204 No Content.](41a438d7e4adc17c3a4005e7c9500091_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant AF as AF + Note right of NF: 1. PUT .../subscriptions/{subscriptionId} + NF->>AF: Request + Note left of AF: 2a. 200 OK +2b. 204 No Content + AF-->>NF: Response + +``` + +Sequence diagram showing the modification of an existing subscription. The NF service consumer sends a PUT request to the AF. The AF responds with either a 200 OK or a 204 No Content. + +Figure 4.2.2.3-1: Modification of an existing subscription + +To modify an existing subscription to event notifications, the NF service consumer shall send an HTTP PUT request with: "{apiRoot}/naf-eventexposure//subscriptions/{subscriptionId}" as request URI, as shown in step 1 of figure 4.2.2.3-1, where "{subscriptionId}" is the subscription correlation ID of the existing subscription. The "AfEventExposureSubsc" data structure is included as request body as described in clause 4.2.2.2. + +NOTE 1: An alternate NF service consumer than the one that requested the generation of the subscription resource can send the PUT request. + +NOTE 2: The "notifUri" attribute within the AfEventExposureSubsc data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +NOTE 3: The "monDur" attribute within the AfEventExposureSubsc data structure can be modified to extend the expiry time to keep receiving notifications. + +If the AF cannot successfully fulfil the received HTTP PUT request due to an internal error or an error in the HTTP PUT request, the AF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the AF determines the received HTTP PUT request needs to be redirected, the AF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +Upon successful reception of an HTTP PUT request with: "{apiRoot}/naf-eventexposure//subscriptions/{subscriptionId}" as request URI and "AfEventExposureSubsc" data structure as request body, the AF shall update the subscription and send either a HTTP "200 OK" response with the "AfEventExposureSubsc" data structure as response body containing the representation of the modified "Individual Application Event Subscription", or an HTTP "204 No Content" response, as shown in step 2 of figure 4.2.2.3-1. + +When the "monDur" attribute is included in the response by the AF, it represents AF selected expiry time that is equal or less than the expiry time received in the request. + +When the "immRep" attribute is included and sets to "true" in the subscription and the subscribed events are available, the AF shall include the reports of the events subscribed, if available, in the HTTP PUT response. + +When the sampling ratio, as "sampRatio" attribute, is included in the subscription without a "partitionCriteria" attribute, the AF shall select a random subset of UEs among the target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. If the "partitionCriteria" attribute is additionally included, then the AF shall first partition the UEs according to the value of the "partitionCriteria" attribute and then select a random subset of + +UEs from each partition according to the sampling ratio and only report the event(s) related to the selected subsets of UEs. + +When the group reporting guard time, as "grpRepTime" attribute, is included in the subscription, the AF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then, the AF shall notify the NF service consumer using the Naf\_EventExposure\_Notify service operation, as described in clause 4.2.4.2. + +When the "notifFlag" attribute is included, and set to "DEACTIVATE" in the request, the AF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the "notifFlag" attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer). When a muting exception occurs, the AF may consider the contents of the "notifFlagInstruct" attribute (if provided) and/or local configuration to determine its actions; if the "notifFlag" attribute is set to "RETRIEVAL" in the request, the AF shall send the stored events to the NF service consumer, and mute the event notification again and store available events; if the "notifFlag" attribute is set to "ACTIVATE" and the event notifications are muted (due to a previously received "DEACTIVATE" value), the AF shall unmute the event notification, i.e. start sending again notifications for available events. + +If the EnhDataMgmt feature is supported and the AF accepts the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it may indicate the applied muting notification settings within the "mutingSetting" attribute in the response. If the AF does not accept the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "MUTING\_INSTR\_NOT\_ACCEPTED". + +### 4.2.3 Naf\_EventExposure\_Unsubscribe service operation + +#### 4.2.3.1 General + +This service operation is used by an NF service consumer to unsubscribe from event notifications. + +The following procedure using the Naf\_EventExposure\_Unsubscribe service operation is supported: + +- unsubscribe from event notifications. + +#### 4.2.3.2 Unsubscription from event notifications + +Figure 4.2.3.2-1 illustrates the unsubscription from event notifications. + +![Sequence diagram showing the unsubscription process between an NF service consumer and an AF.](4aa740e8119817a3f9b9f72d06eaa53d_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant AF + Note right of NF service consumer: 1. DELETE .../subscriptions/{subscriptionId} + NF service consumer->>AF: 1. DELETE .../subscriptions/{subscriptionId} + Note left of AF: 2. "204 No Content" + AF-->>NF service consumer: 2. "204 No Content" +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and an AF. The first message, labeled '1. DELETE .../subscriptions/{subscriptionId}', is sent from the NF service consumer to the AF. The second message, labeled '2. "204 No Content"', is sent from the AF back to the NF service consumer. + +Sequence diagram showing the unsubscription process between an NF service consumer and an AF. + +Figure 4.2.3.2-1: Unsubscription from event notifications + +To unsubscribe from event notifications, the NF service consumer shall send an HTTP DELETE request with "{apiRoot}/naf-eventexposure//subscriptions/{subscriptionId}" as request URI, as shown in step 1 of figure 4.2.3.2-1, where "{subscriptionId}" is the subscription correlation identifier of the existing resource subscription that is to be deleted. + +If the AF cannot successfully fulfil the received HTTP DELETE request due to an internal error or an error in the HTTP DELETE request, the AF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the AF determines the received HTTP DELETE request needs to be redirected, the AF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +Upon successful reception of the HTTP DELETE request with: "{apiRoot}/naf-eventexposure//subscriptions/{subscriptionId}" as request URI, the AF shall remove the corresponding subscription and send an HTTP "204 No Content" response as shown in step 2 of figure 4.2.3.2-1. + +### 4.2.4 Naf\_EventExposure\_Notify service operation + +#### 4.2.4.1 General + +The Naf\_EventExposure\_Notify service operation enables the AF to notify to the NF service consumer(s) that the previously subscribed application related event occurred. + +The following procedure using the Naf\_EventExposure\_Notify service operation is supported: + +- notification about subscribed events. + +#### 4.2.4.2 Notification about subscribed events + +Figure 4.2.4.2-1 illustrates the notification about subscribed events. + +![Sequence diagram showing the notification process between an AF and an NF service consumer.](aa9441a5971655a79987d70fc551b26a_img.jpg) + +``` +sequenceDiagram + participant AF + participant NF as NF service consumer + Note right of AF: 1. POST {notifUri} + AF->>NF: + Note left of NF: 2. "204 No Content" + NF->>AF: +``` + +The diagram illustrates a sequence of two messages between an AF (Application Function) and an NF service consumer. The AF sends a POST request to the NF service consumer, labeled "1. POST {notifUri}". The NF service consumer responds with a "204 No Content" message, labeled "2. '204 No Content'". + +Sequence diagram showing the notification process between an AF and an NF service consumer. + +Figure 4.2.4.2-1: Notification about subscribed events + +If the AF observes application related event(s) for which an NF service consumer has subscribed, the AF shall send an HTTP POST request as shown in step 1 of figure 4.2.4.2-1, with the "{notifUri}" as request URI containing the value previously provided by the NF service consumer within the corresponding subscription, and the "AfEventExposureNotif" data structure. + +The "AfEventExposureNotif" data structure shall include: + +- the notification correlation ID provided by the NF service consumer during the subscription as "notifId" attribute; and +- information about the observed event(s) within the "eventNotifs" attribute that shall contain for each observed event an "AfEventNotification" data structure that shall include: + - the application related event as "event" attribute; + - the time at which the event was observed encoded as "timeStamp" attribute; + - if the "event" attribute is "SVC\_EXPERIENCE": + - service experience information about the application involved in the reported event in the "svcExprcInfos" attribute; + - if the "event" attribute is "UE\_MOBILITY": + +- UE mobility information associated with the application as "ueMobilityInfos" attribute; +- 5) if the "event" attribute is "UE\_COMM": + - application communication information associated with the application as "ueCommInfos" attribute; +- 6) if the "event" attribute is "EXCEPTIONS": + - exceptions information associated with a service flow as "excepInfos" attribute; +- 7) if the "event" attribute is "COLLECTIVE\_BEHAVIOUR": + - collective behaviour information associated with the UEs and its applications as "collBhvrInfos" attribute; +- 8) if the "event" attribute is "PERF\_DATA": + - performance data information associated with the application as "perfDataInfos" attribute; +- 9) if the "event" attribute is "USER\_DATA\_CONGESTION": + - user data congestion information collected for an AF application as "congestionInfos" attribute; and +- 10) if the "event" attribute is "DISPERSION": + - UE dispersion information collected for an AF application as "dispersionInfos" attribute. +- 11) if the "event" attribute is "MS\_QOE\_METRICS": + - Media Streaming QoE metrics information collected for an UE application via the Data Collection AF as "msQoeMetrInfos" attribute. This attribute is deprecated; the attribute "msQoeMetrics" should be used instead. + - if the "MSEventExposure" feature is supported, the Media Streaming QoE metrics information collected for an UE application via the Data Collection AF as "msQoeMetrics" attribute. +- 12) if the "event" attribute is "MS\_CONSUMPTION": + - Media Streaming Consumption reports collected for an UE application via the Data Collection AF as "msConsumpInfos" attribute. This attribute is deprecated; the attribute "msConsumpRpts" should be used instead. + - if the "MSEventExposure" feature is supported, the Media Streaming Consumption reports collected for an UE application via the Data Collection AF as "msConsumpRpts" attribute. +- 13) if the "event" attribute is "MS\_NET\_ASSIST\_INVOCATION": + - Media Streaming Network Assistance invocation collected for an UE application via the Data Collection AF as "msNetAssInvInfos" attribute. This attribute is deprecated; the attribute "msNetAssistInvs" should be used instead. + - if the "MSEventExposure" feature is supported, the Media Streaming Network Assistance invocation collected for an UE application via the Data Collection AF as "msNetAssistInvs" attribute. +- 14) if the "event" attribute is "MS\_DYN\_POLICY\_INVOCATION": + - Media Streaming Dynamic Policy invocation collected for an UE application via the Data Collection AF as "msDynPlyInvInfos" attribute. This attribute is deprecated; the attribute "msDynPlyInvs" should be used instead. + - if the "MSEventExposure" feature is supported, the Media Streaming Dynamic Policy invocation collected for an UE application via the Data Collection AF as "msDynPlyInvs" attribute. +- 15) if the "event" attribute is "MS\_ACCESS\_ACTIVITY": + - Media Streaming access activity collected for an UE application via the Data Collection AF as "msAccActInfos" attribute. This attribute is deprecated; the attribute "msAccesses" should be used instead. + +- if the "MSEventExposure" feature is supported, the Media Streaming access activity collected for an UE application via the Data Collection AF as "msAccesses" attribute. + +16) if the "event" attribute is "GNSS\_ASSISTANCE\_DATA": + +- GNSS Assistance Data information within the "gnssAssistDataInfo" attribute; + +17) if the "event" attribute is "E2E\_DATA\_VOL\_TRANS\_TIME": + +- data volume transfer information associated with the application as "datVolTransTimeInfos" attribute. + +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.7. + +If the feature "ES3XX" is supported, and 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 6.10.9 of 3GPP TS 29.500 [5]. + +Upon successful reception of the HTTP POST request with "{notifiUri}" as request URI and "AfEventExposureNotif" data structure as request body, the NF service consumer shall send a "204 No Content" HTTP response, as shown in step 2 of figure 4.2.4.2-1. + +# --- 5 Naf\_EventExposure Service API + +## 5.1 Introduction + +The Naf\_EventExposure Service shall use the Naf\_EventExposure API. + +The API URI of the Naf\_EventExposure API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the AF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [6], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "naf-eventexposure". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +If the AF is untrusted, support of HTTP/1.1 (IETF RFC 9112 [21], IETF RFC 9110 [22] and IETF RFC 9111[25] over TLS is mandatory and support of HTTP/2 (IETF RFC 9113 [7]) over TLS is recommended. TLS shall be used as specified in clause 12.3 and clause 13.1 of 3GPP TS 33.501 [14]. + +If the AF is trusted, HTTP/2, IETF RFC 9113 [7], shall be used as specified in clause 5.2 of 3GPP TS 29.500 [5]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [5]. + +The OpenAPI [8] specification of HTTP messages and content bodies for the Naf\_EventExposure is contained in Annex A. + +### 5.2.2 HTTP standard headers + +#### 5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [5] for the usage of HTTP standard headers. + +#### 5.2.2.2 Content type + +JSON, IETF RFC 8259 [9], 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 [5]. The use of the JSON format shall be signalled by the content type "application/json". + +"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 [10]. + +### 5.2.3 HTTP custom headers + +#### 5.2.3.1 General + +The Naf\_EventExposure API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [5] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4]. + +In this Release of the specification, no specific custom headers are defined for the Naf\_EventExposure API. + +## 5.3 Resources + +### 5.3.1 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.3.1-1 depicts the resource URIs structure for the Naf\_EventExposure API. + +![Diagram showing the resource URI structure for the Naf_EventExposure API. The root URI is {apiRoot}/naf-eventexposure/. It branches to /subscriptions, which in turn branches to /{subscriptionId}.](c42e926097d01653b793c04b49e764b2_img.jpg) + +``` +graph TD; Root["{apiRoot}/naf-eventexposure/"] --- Subscriptions["/subscriptions"]; Subscriptions --- SubscriptionId["/{subscriptionId}"]; +``` + +Diagram showing the resource URI structure for the Naf\_EventExposure API. The root URI is {apiRoot}/naf-eventexposure/. It branches to /subscriptions, which in turn branches to /{subscriptionId}. + +**Figure 5.3.1-1: Resource URI structure of the Naf\_EventExposure API** + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +Table 5.3.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------------------|---------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| Application Event Subscriptions | /subscriptions | POST | Subscription to the notification of application events and creation of an Individual Application Event Subscription resource. | +| Individual Application Event Subscription | /subscriptions/{subscriptionId} | GET | Reads an Individual Application Event Subscription resource. | +| | | PUT | Modifies an Individual Application Event Subscription. | +| | | DELETE | Cancels an individual subscription to notifications of application event. | + +### 5.3.2 Resource: Application Event Subscriptions + +#### 5.3.2.1 Description + +The Application Event Subscriptions resource represents all subscriptions of the Naf\_EventExposure service at a given AF. + +#### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/naf-eventexposure//subscriptions + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +Table 5.3.2.2-1: Resource URI variables for this resource + +| Name | Data type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 5.1 | + +#### 5.3.2.3 Resource Standard Methods + +##### 5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------| +| AfEventExposure Subsc | M | 1 | Contains the information required for the creation of a new individual application event subscription. | + +**Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|----------------|----------------------------------------------------------------------------------------| +| AfEventExposure Subsc | M | 1 | 201 Created | Contains the representation of the Individual Application Event Subscription resource. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: Failure cases are described in clause 5.7. + +**Table 5.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/naf-eventexposure//subscriptions/{subscriptionId} | + +### 5.3.3 Resource: Individual Application Event Subscription + +#### 5.3.3.1 Description + +The Individual Application Event Subscription resource represents a single subscription of the Naf\_EventExposure service at a given AF. + +#### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/naf-eventexposure//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.3.3.2-1. + +**Table 5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|-------------------------------------------------------------| +| apiRoot | string | See clause 5.1 | +| subscriptionId | string | Identifies a subscription to the AF event exposure service. | + +#### 5.3.3.3 Resource Standard Methods + +##### 5.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.3.3.1-1. + +**Table 5.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.1-3. + +**Table 5.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|----------|--------------------|------------------------|---------------------------------------------------------------------------------------------------------------------------| +| AfEventExposureSubsc | M | 1 | 200 OK | Contains the representation of the Individual Application Event Subscription resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. Applicable if the feature "ES3XX" is supported.
(NOTE 2, NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. Applicable if the feature "ES3XX" is supported.
(NOTE 2, NOTE 3) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: If the AF is untrusted, the Redirection handling described in clause 5.2.10 of 3GPP TS 29.122 [17] should apply. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|------------------|----------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target AF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|------------------|----------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target AF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 5.3.3.3.2-1. + +**Table 5.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.2-3. + +Table 5.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|---------------------------------------------------------------------------| +| AfEventExposureSubsc | M | 1 | Modifies the existing Individual Application Event Subscription resource. | + +Table 5.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| AfEventExposureSubsc | M | 1 | 200 OK | Successful case.
The Individual Application Event Subscription resource was modified and a representation is returned. | +| n/a | | | 204 No Content | Successful case.
The Individual Application Event Subscription resource was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription modification.
Applicable if the feature "ES3XX" is supported.

(NOTE 2, NOTE 4) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription modification.
Applicable if the feature "ES3XX" is supported.

(NOTE 2, NOTE 4) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 3) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: If the AF is untrusted, the Redirection handling described in clause 5.2.10 of 3GPP TS 29.122 [17] should apply. +NOTE 3: Failure cases are described in clause 5.7. +NOTE 4: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +Table 5.3.3.3.2-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target AF (service) instance towards which the request is redirected. | + +Table 5.3.3.3.2-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target AF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.3.3.3.3-1. + +**Table 5.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.3-2 and the response data structures and response codes specified in table 5.3.3.3.3-3. + +**Table 5.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The Individual Application Event Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription termination. Applicable if the feature "ES3XX" is supported.
(NOTE 2, NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription termination. Applicable if the feature "ES3XX" is supported.
(NOTE 2, NOTE 3) | + +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 [5] also apply. +NOTE 2: If the AF is untrusted, the Redirection handling described in clause 5.2.10 of 3GPP TS 29.122 [17] should apply. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target AF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target AF (service) instance towards which the request is redirected. | + +## 5.4 Custom Operations without associated resources + +No custom operation is defined in this Release of the specification. + +## 5.5 Notifications + +### 5.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [5] and clause 4.6.2.3 of 3GPP TS 29.501 [6]. + +**Table 5.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------|--------------|---------------------------------|------------------------------------------------------| +| Application Event Notification | {notifUri} | POST | Notification of application related event reporting. | + +### 5.5.2 Application Event Notification + +#### 5.5.2.1 Description + +The Application Event Notification is used by the AF to report one or several observed application related events to the NF service consumer that has subscribed to such notifications. + +#### 5.5.2.2 Target URI + +The callback URI "{notifUri}" shall be used with the callback URI variables defined in table 5.5.2.2-1. + +**Table 5.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned by the NF service consumer during the subscription service operation and described within the AfEventExposureSubsc data type (see table 5.6.2.2-1). | + +#### 5.5.2.3 Standard Methods + +##### 5.5.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.2.3.1-1. + +**Table 5.5.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.2.3.1-2 and the response data structures and response codes specified in table 5.5.2.3.1-3. + +**Table 5.5.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------------| +| AfEventExposureNotif | M | 1 | Provides Information about observed application related events. | + +**Table 5.5.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification.
Applicable if the feature "ES3XX" is supported.

(NOTE 2, NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification
Applicable if the feature "ES3XX" is supported.

(NOTE 2, NOTE 3) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply. +NOTE 2: If the AF is untrusted, the Redirection handling described in clause 5.2.10 of 3GPP TS 29.122 [17] should apply. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +**Table 5.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.6 Data Model + +### 5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6.1-1 specifies the data types defined for the Naf\_EventExposure service based interface protocol. + +Table 5.6.1-1: Naf\_EventExposure specific Data Types + +| Data type | Section defined | Description | Applicability | +|---------------------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------| +| AddrFqdn | 5.6.2.18 | IP address and/or FQDN. | PerformanceData
ServiceExperienceExt
DataVolTransferTime | +| AfEvent | 5.6.3.3 | Represents Application Events. | | +| AfEventExposureSubsc | 5.6.2.2 | Represents an Individual Application Event Subscription resource. | | +| AfEventExposureNotif | 5.6.2.3 | Describes notifications about application event that occurred in an Individual Application Event Subscription resource. | | +| AfEventNotification | 5.6.2.6 | Represents information related to an event to be reported. | | +| CollectiveBehaviourFilter | 5.6.2.19 | Contains the parameter type and value pair to express the collective behaviour event filters. | CollectiveBehaviour | +| CollectiveBehaviourFilterType | 5.6.3.4 | | CollectiveBehaviour | +| CollectiveBehaviourInfo | 5.6.2.20 | Contains the collective behaviour analytics information. | CollectiveBehaviour | +| CommunicationCollection | 5.6.2.13 | Contains communication information. | UeCommunication | +| DataProcessingType | 5.6.3.5 | Represents a type of data processing. | ExtEventFilters | +| DatVolTransTimeCollection | 5.6.2.28 | Contains data volume transfer time information. | DataVolTransferTime | +| DispersionCollection | 5.6.2.21 | Contains Dispersion information collected. | Dispersion | +| EventFilter | 5.6.2.5 | Represents event filter information. | | +| EventsSubs | 5.6.2.4 | Represents an event to be subscribed and the related event filter information. | | +| ExceptionInfo | 5.6.2.14 | Describes the exceptions information provided by AF. | Exceptions | +| MSAccessActivityCollection | 5.6.2.27 | Represents the Media Streaming access activities of UE Application collected via Data Collection AF. | MSAccessActivity | +| MsConsumptionCollection | 5.6.2.24 | Represents the Media Streaming Consumption reports of UE Application collected via Data Collection AF. | MSConsumption | +| MsDynPolicyInvocationCollection | 5.6.2.26 | Represents the Media Streaming Dynamic Policy invocation of UE Application collected via Data Collection AF. | MSDynPolicyInvocation | +| MsQoeMetricsCollection | 5.6.2.23 | Represents the Media Streaming QoE Metrics of UE Application collected via Data Collection AF. | MSQoeMetrics | +| MsNetAssInvocationCollection | 5.6.2.25 | Represents the Media Streaming Network Assistance invocation of UE Application collected via Data Collection AF. | MSNetAssInvocation | +| PerformanceData | 5.6.2.17 | Indicates the performance data. | PerformanceData | +| PerformanceDataCollection | 5.6.2.16 | Represents the performance data information collected for an AF application. | PerformanceData | +| PerUeAttribute | 5.6.2.22 | UE application data collected per UE. | CollectiveBehaviour | +| ServiceExperienceInfoPerApp | 5.6.2.7 | Contains service experience associated with the application. | ServiceExperience | +| ServiceExperienceInfoPerFlow | 5.6.2.8 | Contains service experience associated with the service flow. | ServiceExperience | +| SvcExperience | 5.6.2.9 | Contains a mean opinion score with the customized range. | ServiceExperience | +| UeCommunicationCollection | 5.6.2.11 | Contains UE communication information associated with the application. | UeCommunication | +| UeMobilityCollection | 5.6.2.10 | Contains UE mobility information associated with the application. | UeMobility | +| UeTrajectoryCollection | 5.6.2.12 | Contains UE trajectory information associated with the application. | UeMobility | +| UserDataCongestionCollection | 5.6.2.15 | Contains User Data Congestion Analytics related | UserDataCong | + +| | | | | +|---|--|------------------------|--------| +| n | | information collected. | estion | +|---|--|------------------------|--------| + +Table 5.6.1-2 specifies data types re-used by the Naf\_EventExposure 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\_EventExposure service based interface. + +Table 5.6.1-2: Naf\_EventExposure re-used Data Types + +| Data type | Reference | Comments | Applicability | +|----------------------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| ApplicationId | 3GPP TS 29.571 [13] | Application Identifier. | | +| BitRate | 3GPP TS 29.571 [13] | String representing a bit rate that shall be formatted as follows:

pattern: " ^ d+(\.\d+)?
(bps Kbps Mbps Gbps Tbps)\$"
Examples:
"125 Mbps", "0.125 Gbps", "125000 Kbps". | UserDataCongestion
CollectiveBehaviour | +| ConsumptionReportingUnitsCollection | 3GPP TS 26.512 [30] | Represents the collection of Media Streaming Consumption event records. | MSEventExposure | +| CpParameterSet | 3GPP TS 29.122 [17] | The Expected UE Behaviour parameters. | UeCommunicationExt eNA | +| DateTime | 3GPP TS 29.571 [13] | Contains a date and a time. | | +| Dnai | 3GPP TS 29.571 [13] | Identifies a DNAI. | | +| DurationSec | 3GPP TS 29.571 [13] | Indicates a period of time in units of seconds. | Dispersion | +| DynamicPolicy | 3GPP TS 26.512 [30] | Represents the Media Streaming Dynamic Policy. | MSDynPolicyInvocation | +| DynamicPolicyInvocationsCollection | 3GPP TS 26.512 [30] | Represents the collection of Media Streaming Dynamic Policy invocation event records. | MSEventExposure | +| EthFlowDescription | 3GPP TS 29.514 [18] | Defines a packet filter for an Ethernet flow. | | +| Exception | 3GPP TS 29.520 [19] | Describes the Exception information. | | +| ExtGroupId | 3GPP TS 29.503 [27] | External Group Identifier for a user group. | | +| Float | 3GPP TS 29.571 [13] | Number with format "float" as defined in OpenAPI Specification [8]. | | +| FlowDescription | 3GPP TS 29.514 [18] | Only IP 5-tuple (protocol, source and destination IP address, Source and destination port) is applicable. | Dispersion | +| FlowInfo | 3GPP TS 29.122 [17] | Represents flow information. | | +| GNSSAssistDataInfo | 3GPP TS 29.591 [31] | Represents GNSS Assistance Data information. | GNSSAssistData | +| Gpsi | 3GPP TS 29.571 [13] | Identifies a GPSI. | | +| GroupId | 3GPP TS 29.571 [13] | Contains a Group identifier. | | +| IpAddr | 3GPP TS 29.571 [13] | Identifies IP address. | Dispersion
EnPerformanceData | +| LocationArea5G | 3GPP TS 29.122 [17] | Represents a user location area when the UE is attached to 5G. | | +| MediaStreamingAccessesCollection | 3GPP TS 26.512 [30] | Represents the collection of Media Streaming access event records. | MSEventExposure | +| MediaStreamingAccessRecord | 3GPP TS 26.512 [30] | Represents the Media Streaming Access activity record. | MSAccessActivity | +| NetworkAssistanceInvocationsCollection | 3GPP TS 26.512 [30] | Represents the collection of Media Streaming Network Assistance invocation event records. | MSEventExposure | +| NetworkAssistanceSession | 3GPP TS 26.512 [30] | Represents the Media Streaming Network Assistance Session Recommendation. | MSNetAssInvocation | +| PacketDelBudget | 3GPP TS 29.571 [13] | Indicates average Packet Delay. | PerformanceData | +| PacketLossRate | 3GPP TS 29.571 [13] | Indicates average Loss Rate. | PerformanceData | +| QoEMetricsCollection | 3GPP TS 26.512 [30] | Represents the collection of Media Streaming QoE metrics event records. | MSEventExposure | +| RedirectResponse | 3GPP TS 29.571 [13] | Contains redirection related information. | ES3XX | +| ReportingInformation | 3GPP TS 29.523 [12] | Represents the requirements of reporting the subscription. | | +| Supi | 3GPP TS 29.571 [13] | Contains a SUPI. | | +| SupportedFeatures | 3GPP TS 29.571 [13] | Indicates the features supported. | | +| TimeWindow | 3GPP TS 29.122 [17] | Represents a time window identified by a start time and a stop time. | | +| UInteger | 3GPP TS 29.571 [13] | Unsigned integer. | ServiceExperienceExt2_eNA | +| Uri | 3GPP TS 29.571 [13] | Contains a URI. | | +| UsageThreshold | 3GPP TS 29.122 [17] | data volume during the period | Dispersion | +| Volume | 3GPP TS 29.122 [17] | Unsigned integer identifying a volume in units | | + +| | | | | +|--|--|-----------|--| +| | | of bytes. | | +|--|--|-----------|--| + +### 5.6.2 Structured data types + +#### 5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 5.6.2.2 Type AfEventExposureSubsc + +**Table 5.6.2.2-1: Definition of type AfEventExposureSubsc** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| dataAccProfileId | string | O | 0..1 | Represents a unique identifier for the Data Access Profile. | DataAccProfileId | +| eventsSubs | array(EventsSubs) | M | 1..N | Subscribed events and the related event filters. | | +| eventsRepInfo | ReportingInformation | M | 1 | Represents the reporting requirements of the subscription. (NOTE 2) | | +| notifUri | Uri | M | 1 | Notification URI for event reporting. | | +| notifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| eventNotifs | array(AfEventNotification) | C | 1..N | Represents the Events to be reported.
Shall only be present if the immediate reporting indication in the "immRep" attribute within the "eventsRepInfo" attribute sets to true in the event subscription, and the reports are available. | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.8.
Shall be present in the HTTP POST request/response; or in the HTTP GET response if the "suppFeat" attribute query parameter is included in the HTTP GET request. (NOTE 1) | | + +NOTE 1: In the HTTP POST request it represents the set of NF service consumer supported features. In the HTTP POST and GET responses it represents the set of features supported by both the NF service consumer and the AF. + +NOTE 2: The "eventsRepInfo" attribute may include muting instructions within the "notifFlagInstruct" attribute and/or muting notifications settings within the "mutingSetting" attribute only if the EnhDataMgmt feature is supported. + +#### 5.6.2.3 Type AfEventExposureNotif + +**Table 5.6.2.3-1: Definition of type AfEventExposureNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------|---------------| +| notifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| eventNotifs | array(AfEventNotification) | M | 1..N | Represents the Events to be reported according to the subscription corresponding to the Notification Correlation ID. | | + +#### 5.6.2.4 Type EventsSubs + +**Table 5.6.2.4-1: Definition of type EventsSubs** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|---------------------------------------------------------------------|---------------| +| event | AfEvent | M | 1 | Subscribed event. | | +| eventFilter | EventFilter | M | 1 | Represents the event filter information associated with each event. | | + +#### 5.6.2.5 Type EventFilter + +Table 5.6.2.5-1: Definition of type EventFilter + +| Attribute name | Data type | P | Cardinality | Description | Applicability
(NOTE 4) | +|----------------|----------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| gpsi | array(Gpsi) | O | 1..N | Each element represents external UE identifier.
(NOTE 1, NOTE 2) | | +| supi | array(Supi) | O | 1..N | Each element represents a SUPI identifying a UE (NOTE 1, NOTE 2) | | +| exterGroupIds | array(ExtGroupId) | O | 1..N | Each element represents a group of UEs identified by an External Group Identifier.
(NOTE 1, NOTE 2) | | +| interGroupIds | array(GroupId) | O | 1..N | Each element represents a group of UEs identified by an Internal Group Identifier.
(NOTE 1, NOTE 2) | | +| anyUeInd | boolean | O | 0..1 | Identifies whether the request applies to any UE.
This attribute shall set to "true" if applicable for any UE, otherwise, set to "false".
May only be present and sets to "true" if "AfEvent" sets to "SVC_EXPERIENCE", "EXCEPTIONS" or "USER_DATA_CONGESTION".
(NOTE 2) | ServiceExperience
Exceptions
UserDataCongestion | +| ueIpAddr | IpAddr | O | 0..1 | Identifies the UE IP address.
(NOTE 2) | EnPerformanceData | +| appIds | array(ApplicationId) | O | 1..N | Each element indicates an application identifier.
If absent, the EventFilter data applies to any application (i.e. all applications).
(NOTE 3) | ServiceExperience
UeMobility
UeCommunication
Exceptions
UserDataCongestion
PerformanceData
Dispersion
CollectiveBehaviour
MSQoeMetrics
MSConsumption
MSNetAssInvocation
MSDynPolicyInvocation
MSAccessActivity
DataVoITransferTime | +| locArea | LocationArea5G | O | 0..1 | Represents area of interest.
(NOTE 5) | ServiceExperience
UeMobility
UeCommunication
Exceptions
UserDataCongestion
PerformanceData
Dispersion
CollectiveBehaviour
MSQoeMetrics
MSConsumption
MSNetAssInvocation
MSDynPolicyInvocation
MSAccessActivity
DataVoITransferTime | +| collAttrs | array(CollectiveBehaviourFilter) | O | 1..N | Each element indicates a collective attribute parameter type and value.
This attribute may be included when the subscribed event is | CollectiveBehaviour | + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| | | | | "COLLECTIVE_BEHAVIOUR". | | +| exceptionReqs | array(Exception) | O | 1..N | Each element indicates an Exception Id with associated threshold. This attribute may be included when the subscribed event is "EXCEPTIONS".
(NOTE 6) | EnPerformanceData | +| NOTE 1: For untrusted AF, only gpsi and exterGroupIds are applicable. For trusted AF, only supis and interGroupIds are applicable.
NOTE 2: For an applicable feature, only one attribute identifying the target UE shall be provided.
NOTE 3: For event "UE_COMM", "UE_MOBILITY", "EXCEPTIONS" and "PERF_DATA", the "applds" attribute, if present, shall include only one element.
NOTE 4: Properties marked with a feature as defined in clause 5.8 are applicable as described in clause 6.6 of 3GPP TS 29.500 [5]. If no features are indicated, the related property applies for all the features.
NOTE 5: The NetworkAreaInfo data within the LocationArea5G data is only applicable for trusted AF. In addition, for event "SVC_EXPERIENCE", only the "tais" attribute within the NetworkAreaInfo data is applicable for the trusted AF.
NOTE 6: Only "excepId" and "excepLevel" attributes within the Exception data type are applicable to this attribute. | | | | | | + +Editor's note: Futher event filter information is FFS. + +#### 5.6.2.6 Type AfEventNotification + +Table 5.6.2.6-1: Definition of type AfEventNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| event | AfEvent | M | 1 | Represents the reported application related event. | | +| timeStamp | DateTime | M | 1 | Time at which the event is observed. | | +| svcExprcInfos | array(ServiceExperienceInfoPerApp) | C | 1..N | Contains the service experience information.
Shall be present if the "event" attribute sets to "SVC_EXPERIENCE". | ServiceExperience | +| ueMobilityInfos | array(UeMobilityCollection) | C | 1..N | Contains the UE mobility information.
Shall be present if the "event" attribute sets to "UE_MOBILITY". | UeMobility | +| ueCommInfos | array(UeCommunicationCollection) | C | 1..N | Contains the application communication information.
Shall be present if the "event" attribute sets to "UE_COMM". | UeCommunication | +| excepInfos | array(ExceptionInfo) | C | 1..N | Each element represents the exception information for a service flow.
Shall be present if the "event" attribute sets to "EXCEPTIONS". | Exceptions | +| congestionInfos | array(UserDataCongestionCollection) | C | 1..N | Each element represents the user data congestion information collected for an AF application.
Shall be present if the "event" attribute sets to "USER_DATA_CONGESTION". | UserDataCongestion | +| perfDataInfos | array(PerformanceDataCollection) | C | 1..N | Each element represents the performance data information collected for an AF application.
Shall be present if the "event" attribute sets to "PERF_DATA". | PerformanceData | +| collBhvrInfos | array(CollectiveBehaviourInfo) | C | 1..N | Each element represents the collective behaviour information related to a set of UEs, applications. Shall be present if the "event" attribute sets to "COLLECTIVE_BEHAVIOUR". | CollectiveBehaviour | +| dispersionInfos | array(DispersionCollection) | C | 1..N | Each element represents the UE dispersion information collected for an AF application.
Shall be present if the "event" attribute sets to "DISPERSION". | Dispersion | +| msQoeMetrInfos | array(MsQoeMetricsCollection) | C | 1..N | Each element represents the Media Streaming QoE metrics information collected for an UE application via the Data Collection AF.
Shall be present if the "event" attribute sets to "MS_QOE_METRICS".

This attribute is deprecated; the attribute "msQoeMetrics" should be used instead. | MSQoeMetrics | +| msQoeMetrics | array(QoEMetricsCollection) | C | 1..N | Each element represents the Media Streaming QoE metrics event record.
Shall be present if the "event" attribute sets to "MS_QOE_METRICS". | MSEventExposure | + +| | | | | | | +|------------------|-----------------------------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| | | | | This attribute deprecates "msQoeMetrInfos" attribute. | | +| msConsumpInfos | array(MsConsumptionCollection) | C | 1..N | Each element represents the Media Streaming Consumption information collected for an UE application via the Data Collection AF.
Shall be present if the "event" attribute sets to "MS_CONSUMPTION".

This attribute is deprecated; the attribute "msConsumpRpts" should be used instead. | MSConsumption | +| msConsumpRpts | array(ConsumptionReportingUnits Collection) | C | 1..N | Each element represents the Media Streaming Consumption event record.
Shall be present if the "event" attribute sets to "MS_CONSUMPTION".

This attribute deprecates "msConsumpInfos" attribute. | MSEventExposure | +| msNetAssInvInfos | array(MsNetAssInvocationCollection) | C | 1..N | Each element represents the Media Streaming Network Assistance invocation information collected for an UE application via the Data Collection AF.
Shall be present if the "event" attribute sets to "NET_ASSIST_INVOCATION".

This attribute is deprecated; the attribute "msNetAssistInvs" should be used instead. | MSNetAssInvocation | +| msNetAssistInvs | array(NetworkAssistanceInvocationsCollection) | C | 1..N | Each element represents the Media Streaming Network Assistance invocation event record.
Shall be present if the "event" attribute sets to "NET_ASSIST_INVOCATION".

This attribute deprecates "msNetAssInvInfos" attribute. | MSEventExposure | +| msDynPlyInvInfos | array(MsDynPolicyInvocationCollection) | C | 1..N | Each element represents the Media Streaming Dynamic Policy invocation information collected for an UE application via the Data Collection AF.
Shall be present if the "event" attribute sets to "MS_DYN_POLICY_INVOCATION".

This attribute is deprecated; the attribute "msDynPlyInvs" should be used instead. | MSDynPolicyInvocation | +| msDynPlyInvs | array(DynamicPolicyInvocationsCollection) | C | 1..N | Each element represents the Media Streaming Dynamic Policy invocation event record.
Shall be present if the "event" attribute sets to "MS_DYN_POLICY_INVOCATION".

This attribute deprecates | MSEventExposure | + +| | | | | | | +|----------------------|-----------------------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| | | | | "msDynPlyInvInfos" attribute. | | +| msAccActInfos | array(MSAccessActivityCollection) | C | 1..N | Each element represents the Media Streaming access activity collected for an UE application via the Data Collection AF. Shall be present if the "event" attribute sets to "MS_ACCESS_ACTIVITY".

This attribute is deprecated; the attribute "msAccesses" should be used instead. | MSAccessActivity | +| msAccesses | array(MediaStreamingAccessesCollection) | C | 1..N | Each element represents the Media Streaming access eventrecord. Shall be present if the "event" attribute sets to "MS_ACCESS_ACTIVITY".

This attribute deprecates "msAccActInfos" attribute. | MSEventExposure | +| gnssAssistDataInfo | GNSSAssistDataInfo | C | 0..1 | Represents the GNSS Assistance data information.

This attribute shall be present only if the "event" attribute is set to "GNSS_ASSISTANCE_DATA". | GNSSAssistData | +| datVolTransTimeInfos | array(DatVolTransTimeCollection) | C | 1..N | Each element represents the data volume transfer time information related to a UE. Shall be present if the "event" attribute sets to "DATA_VOLUME_TRANSFER_TIME". | DataVolTransferTime | + +#### 5.6.2.7 Type ServiceExperienceInfoPerApp + +**Table 5.6.2.7-1: Definition of type ServiceExperienceInfoPerApp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| appId | ApplicationId | C | 0..1 | Indicates an application identifier. Shall be present if the AF event exposure service request applies to more than one application. | | +| appServerIns | AddrFqdn | O | 0..1 | Represents the Application Server Instance (IP address or FQDN of the Application Server). | ServiceExperienceExt | +| svcExpPerFlows | array(ServiceExperienceInfoPerFlow) | M | 1..N | Each element represents service experience for each service flow. | | +| gpsi | array(Gpsi) | O | 1..N | Each element represents external UE identifier. (NOTE) | | +| supi | array(Supi) | O | 1..N | SUPI identifying a UE. (NOTE) | | +| contrWeights | array(UInteger) | C | 1..N | Indicates the Service Experience Contribution Weights of a list of UEs in the same sequence as in the presented gpsi or supi list of UEs. The weights indicate the relative importance among the elements of this array. The higher the number, the higher the importance. | ServiceExperienceExt2_eNA | +| NOTE: Either "gpsi" or "supi" shall be present. For untrusted AF, only "gpsi" is applicable. For trusted AF, only "supi" is applicable. | | | | | | + +#### 5.6.2.8 Type ServiceExperienceInfoPerFlow + +**Table 5.6.2.8-1: Definition of type ServiceExperienceInfoPerFlow** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|--------------------|---|-------------|-------------------------------------------------------------------------------------------|---------------| +| svcExprc | SvcExperience | M | 1 | Service experience. | | +| timeIntev | TimeWindow | M | 1 | Represents a start and stop time of the measurement period for the AF service experience. | | +| dnai | Dnai | O | 0..1 | Indicates the DN Access Identifiers representing location of the service flow. | | +| ipTrafficFilter | FlowInfo | O | 0..1 | Identifies IP packet filter.(NOTE) | | +| ethTrafficFilter | EthFlowDescription | O | 0..1 | Identifies Ethernet packet filter.(NOTE) | | + +NOTE: Either "ipTrafficFilter" or "ethTrafficFilter" shall be provided. + +#### 5.6.2.9 Type SvcExperience + +**Table 5.6.2.9-1: Definition of type SvcExperience** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------------------|---------------| +| mos | Float | M | 1 | Mean opinion score. | | +| upperRange | Float | M | 1 | The upper value within the rating scale range. | | +| lowerRange | Float | M | 1 | The lower value within the rating scale range. | | + +#### 5.6.2.10 Type UeMobilityCollection + +**Table 5.6.2.10-1: Definition of type UeMobilityCollection** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| gpsi | Gpsi | O | 0..1 | Identifies a UE. (NOTE 1) | | +| supi | Supi | O | 0..1 | SUPI identifying a UE. (NOTE 1) | | +| appld | ApplicationId | M | 1 | Identifies an application identifier. | | +| allAppInd | boolean | O | 0..1 | Indicates applicable to all applications if set to "true", otherwise set to "false". Default value is "false" if omitted. (NOTE 2) | AllApplications | +| ueTrajs | array(UeTrajectory Collection) | M | 1..N | Identifies a list of UE moving trajectories. | | +| areas | array(LocationArea 5G) | O | 1..N | Indicates a list of areas used by the AF for the application service. | UeMobilityExt_AIML | + +NOTE 1: Either gpsi or supi shall be present. For untrusted AF, only gpsi is applicable. For trusted AF, only supi is applicable. + +NOTE 2: If the "allAppInd" attribute is present and set to "true", then the value in the "appld" shall be ignored, which indicates the collected UE mobility information is applicable to all the applications for the UE. + +#### 5.6.2.11 Type UeCommunicationCollection + +Table 5.6.2.11-1: Definition of type UeCommunicationCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|--------------------------------|---|-------------|--------------------------------------------------------------|------------------------| +| gpsi | Gpsi | O | 0..1 | Identifies a UE. (NOTE 1) | | +| supi | Supi | O | 0..1 | SUPI identifying a UE. (NOTE 1) | | +| exterGroupId | ExtGroupId | O | 0..1 | Identifies an external group of UEs. (NOTE 2) | | +| interGroupId | GroupId | O | 0..1 | Identifies an internal group of UEs. (NOTE 2) | | +| appId | ApplicationId | M | 1 | Identifies an application identifier. | | +| expectedUeBehavePara | CpParameterSet | O | 0..1 | Indicates the Expected UE Behaviour parameters. (NOTE 3) | UeCommunicationExt_eNA | +| comms | array(CommunicationCollection) | M | 1..N | This attribute contains a list of communication information. | | + +NOTE 1: Either "gpsi" or "supi" shall be present. For untrusted AF, only "gpsi" is applicable. For trusted AF, only "supi" is applicable. +NOTE 2: "interGroupId" attribute only applies to trusted AF and "exterGroupId" only applies to untrusted AF. +NOTE 3: The "setId", "self" and "validityTime" attributes included in CpParameterSet data type are not applicable to this attribute. + +#### 5.6.2.12 Type UeTrajectoryCollection + +Table 5.6.2.12-1: Definition of type UeTrajectoryCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|--------------------------------------------------------------------------|---------------| +| ts | DateTime | M | 1 | This attribute identifies the timestamp when the UE enters the location. | | +| locArea | LocationArea5G | M | 1 | This attribute includes the location information of the UE. | | + +#### 5.6.2.13 Type CommunicationCollection + +Table 5.6.2.13-1: Definition of type CommunicationCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------|---------------| +| startTime | DateTime | M | 1 | Identifies the timestamp this communication starts. | | +| endTime | DateTime | M | 1 | Identifies the timestamp this communication stops. | | +| ulVol | Volume | O | 0..1 | Identifies the uplink traffic volume. (NOTE) | | +| dlVol | Volume | O | 0..1 | Identifies the downlink traffic volume. (NOTE) | | + +NOTE: At least one of "ulVol" or "dlVol" shall be provided. + +#### 5.6.2.14 Type ExceptionInfo + +Table 5.6.2.14-1: Definition of type ExceptionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|--------------------|---|-------------|-------------------------------------------------------------------------|---------------| +| ipTrafficFilter | FlowInfo | C | 0..1 | Identifies IP flow. (NOTE 1) | | +| ethTrafficFilter | EthFlowDescription | C | 0..1 | Identifies Ethernet flow. (NOTE 1) | | +| excepts | array(Exception) | M | 1..N | Contains the description of one or more exception information. (NOTE 2) | | + +NOTE 1: Either "ipTrafficFilter" or "ethTrafficFilter" shall be provided. +NOTE 2: Only "excepId", "excepLevel" and "excepTrend" within the Exception data type as defined in 3GPP TS 29.520 [19] apply to the ExceptionInfo data type. + +#### 5.6.2.15 Type UserDataCongestionCollection + +Table 5.6.2.15-1: Definition of type UserDataCongestionCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------|---------------| +| appld | ApplicationId | C | 0..1 | Indicates an application identifier. (NOTE) | | +| ipTrafficFilter | FlowInfo | C | 0..1 | Identifies IP packet filter. (NOTE) | | +| timeInterv | TimeWindow | O | 0..1 | Represents a start and stop time interval of the measurement period for the AF application. | | +| thrputUl | BitRate | O | 0..1 | Indicates the average uplink throughput over the measurement period. | | +| thrputDl | BitRate | O | 0..1 | Indicates the average downlink throughput over the measurement period. | | +| thrputPkUl | BitRate | O | 0..1 | Indicates the peak uplink throughput over the measurement period. | | +| thrputPkDl | BitRate | O | 0..1 | Indicates the peak uplink throughput over the measurement period. | | + +NOTE: Either "appld" or "ipTrafficFilter" shall be provided. + +#### 5.6.2.16 Type PerformanceDataCollection + +Table 5.6.2.16-1: Definition of type PerformanceDataCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|-----------------------------------------------------------------------|---------------| +| appld | ApplicationId | O | 0..1 | Indicates an application identifier. | | +| uelpAddr | IpAddr | O | 0..1 | Identifies the IP address of an UE. | | +| ipTrafficFilter | FlowInfo | O | 0..1 | Identifies IP packet filter. | | +| ueLoc | LocationArea5G | O | 0..1 | Represents the UE location. | | +| appLocs | array(Dnai) | O | 1..N | Represents the application locations. | | +| asAddr | AddrFqdn | O | 0..1 | Represents the IP address or FQDN of the Application Server. (NOTE 1) | | +| perfData | PerformanceData | M | 1 | Indicates the performance data. (NOTE 2) | | +| timeStamp | DateTime | M | 1 | It defines the timestamp when the provided data is generated. | | + +NOTE 1: If the "asAddr" attribute is included, either the "ipAddr" attribute or the "fqdn" attribute in the AddrFqdn data type shall be provided. +NOTE 2: If the feature "PerformanceDataExt\_AIML" is supported, the attribute "perfData" indicates the UL/DL performance data. + +#### 5.6.2.17 Type PerformanceData + +Table 5.6.2.17-1: Definition of type PerformanceData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|--------------------------------------------|--------------------------| +| pdb | PacketDelBudget | O | 0..1 | Indicates average Packet Delay. | | +| pdbDI | PacketDelBudget | O | 0..1 | Indicates average downlink Packet Delay. | PerformanceData Ext_AIML | +| maxPdbUI | PacketDelBudget | O | 0..1 | Indicates Maximum uplink Packet Delay. | PerformanceData Ext_AIML | +| maxPdbDI | PacketDelBudget | O | 0..1 | Indicates Maximum downlink Packet Delay. | PerformanceData Ext_AIML | +| plr | PacketLossRate | O | 0..1 | Indicates average Loss Rate. | | +| plrDI | PacketLossRate | O | 0..1 | Indicates average downlink Loss Rate. | PerformanceData Ext_AIML | +| maxPlrUI | PacketLossRate | O | 0..1 | Indicates Maximum uplink Loss Rate. | PerformanceData Ext_AIML | +| maxPlrDI | PacketLossRate | O | 0..1 | Indicates Maximum downlink Loss Rate. | PerformanceData Ext_AIML | +| thrputUI | BitRate | O | 0..1 | Indicates the average uplink throughput. | | +| maxThrputUI | BitRate | O | 0..1 | Indicates the Maximum uplink throughput. | PerformanceData Ext_AIML | +| minThrputUI | BitRate | O | 0..1 | Indicates the Minimum uplink throughput. | PerformanceData Ext_AIML | +| thrputDI | BitRate | O | 0..1 | Indicates the average downlink throughput. | | +| maxThrputDI | BitRate | O | 0..1 | Indicates the Maximum downlink throughput. | PerformanceData Ext_AIML | +| minThrputDI | BitRate | O | 0..1 | Indicates the Minimum downlink throughput. | PerformanceData Ext_AIML | + +#### 5.6.2.18 Type AddrFqdn + +Table 5.6.2.18-1: Definition of type AddrFqdn + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------|---------------| +| ipAddr | IpAddr | O | 0..1 | Indicates an IP address. | | +| fqdn | string | O | 0..1 | Indicates an FQDN. | | + +#### 5.6.2.19 Type CollectiveBehaviourFilter + +Table 5.6.2.19-1: Definition of type CollectiveBehaviourFilter + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| type | CollectiveBehaviourFilterType | M | 1 | Parameter type for collective behaviour information event filter. | | +| value | string | M | 1 | Value of the parameter type as in "type" attribute. | | +| collBehAttr | array(PerUeAttribute) | O | 1..N | Contains values of collective behaviour attributes, at least one of which shall match for an AF event to be sent. If provided, the attributes "type" and "value" may be ignored. | ExtEventFilters | +| dataProcType | DataProcessingType | O | 0..1 | Contains the type of processing that shall have been performed on the data for an AF event to be sent. If provided, the attributes "type" and "value" may be ignored. | ExtEventFilters | +| listOfUeInd | boolean | O | 0..1 | Indicates whether request list of UE IDs that fulfil a collective behaviour within the area of interest.
This attribute shall set to "true" if request the list of UE IDs, otherwise, set to "false". | | + +#### 5.6.2.20 Type CollectiveBehaviourInfo + +Table 5.6.2.20-1: Definition of type CollectiveBehaviourInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| colAttrib | array(PerUeAttribute) | M | 1..N | The list of collective attribute values. If the "colAttrib" attribute contains multiple entries, then a UE is considered to fulfil the behaviour if it fulfils the behaviour described by at least one of the elements of the array. | | +| noOfUes | integer | O | 0..1 | Identifies the total number of UEs that fulfil a collective behaviour within the area of interest. | | +| appIds | array(ApplicationId) | O | 1..N | Indicates the identifiers of the applications providing this information. | | +| extUeIds | array(Gpsi) | C | 1..N | Gpsi information of the UEs that fulfil the collective behaviour with in the area of the interest. May only be present if the "listOfUe" attribute is subscribed and sets to "true".
(NOTE) | | +| ueIds | array(Supi) | C | 1..N | Supis of UEs that fulfil the collective behaviour with in the area of the interest. May only be present if the "listOfUe" attribute is subscribed and sets to "true".
(NOTE) | | + +NOTE: Only one of "extUeIds" or "ueIds" shall be provided. "ueIds" attribute may only be provided by trusted AF. + +#### 5.6.2.21 Type DispersionCollection + +**Table 5.6.2.21-1: Definition of type DispersionCollection** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | C | 0..1 | Indicates external UE identifier. (NOTE 1) | | +| supi | Supi | C | 0..1 | Indicates internal UE identifier, represents a SUPI identifying a UE. (NOTE 1) | | +| ueAddr | IpAddr | C | 0..1 | Indicates UE IP address. (NOTE 1) | | +| timeStamp | DateTime | C | 0..1 | It defines the time stamp when the data volume information is generated.
Shall be present if available. | EnhDataMgmt | +| dataUsage | UsageThreshold | M | 1 | Data volume exchanged for the UE. (NOTE 3) | | +| flowDesc | FlowDescription | C | 0..1 | Represents IP 5-tuple with protocol, IP address and port for UL/DL application traffic. (NOTE 2) | | +| appId | ApplicationId | C | 0..1 | Indicates an Application Identifier. (NOTE 2) | | +| dnais | array(Dnai) | O | 1..N | Indicates the DN Access Identifiers representing location of the service flow.
May only be provided if the "ueAddr" attribute is provided. | | +| appDur | DurationSec | O | 0..1 | Indicates the duration for the application. | | + +NOTE 1: One of the "supi", "gpsi" or "ueAddr" attribute shall be provided. + +NOTE 2: If the "ueAddr" attribute is provided, either the "appId" or "flowDesc" attribute shall be provided. + +NOTE 3: The "duration" attribute within the UsageThreshold data type is not applicable. + +#### 5.6.2.22 Type PerUeAttribute + +**Table 5.6.2.22-1: Definition of type PerUeAttribute** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------|---------------| +| ueDest | LocationArea5G | M | 1 | Expected final location of UE based on the route planned. | | +| route | string | O | 0..1 | Planned path of movement by a UE application (e.g. a navigation app).
The format is based on the SLA. | | +| avgSpeed | BitRate | O | 0..1 | Expected speed over the route planned by a UE application. | | +| timeOfArrival | DateTime | O | 0..1 | Expected Time of arrival to destination based on the route planned. | | + +#### 5.6.2.23 Type MsQoeMetricsCollection + +**Table 5.6.2.23-1: Definition of type MsQoeMetricsCollection** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| msQoeMetrics | array(string) | M | 1..N | Represents the Media Streaming Quality of Experience metrics with formatting as specified in clause 11.4.3 of 3GPP TS 26.512 [30], if required for the QoE metrics for Media Streaming UE Application. | | + +#### 5.6.2.24 Type MsConsumptionCollection + +Table 5.6.2.24-1: Definition of type MsConsumptionCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| msConsumps | array(string) | M | 1..N | Represents the Media Streaming Consumption reports with formatting as specified in clause 11.3.3 of 3GPP TS 26.512 [30], if required for Media Streaming UE Application. | | + +#### 5.6.2.25 Type MsNetAssInvocationCollection + +Table 5.6.2.25-1: Definition of type MsNetAssInvocationCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------|---------------| +| msNetAssInvocs | array(NetworkAssistanceSession) | M | 1..N | Indicate Media Streaming Network Assistance invocation information as specified in clause 11.6.3.1 of 3GPP TS 26.512 [30]. | | + +#### 5.6.2.26 Type MsDynPolicyInvocationCollection + +Table 5.6.2.26-1: Definition of type MsDynPolicyInvocationCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------|---------------| +| msDynPlyInvocs | array(DynamicPolicy) | M | 1..N | Represent the Media Streaming Dynamic Policy invocation as specified in clause 11.5.3.1 of 3GPP TS 26.512 [30]. | | + +#### 5.6.2.27 Type MSAccessActivityCollection + +Table 5.6.2.27-1: Definition of type MSAccessActivityCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------|---------------| +| msAccActs | array(MediaStreamingAccessRecord) | M | 1..N | Indicate Media Streaming access activities information as specified in clause 17.2 of 3GPP TS 26.512 [30]. | | + +#### 5.6.2.28 Type DatVolTransTimeCollection + +**Table 5.6.2.28-1: Definition of type DatVolTransTimeCollection** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-----------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | O | 0..1 | Identifier of the application at the AF. | | +| appServerInst | AddrFqdn | O | 0..1 | Represents the Application Server Instance (IP address/FQDN of the Application Server). | | +| gpsi | Gpsi | O | 0..1 | Each element represents a GPSI for a UE. | | +| supi | Supi | O | 0..1 | Each element represents a SUPI for a UE. | | +| ulTransVol | Volume | O | 0..1 | The volume of the uplink transmitted data. (NOTE 1) | | +| dlTransVol | Volume | O | 0..1 | The volume of the downlink transmitted data. (NOTE 1) | | +| ulTransTimeDur | TimeWindow | O | 0..1 | Indicates the start and end time for sending the volume of uplink data. (NOTE 2) | | +| dlTransTimeDur | TimeWindow | O | 0..1 | Indicates the start and end time for sending the volume of downlink data. (NOTE 2) | | + +NOTE 1: At least one of "ulTransVol" or "dlTransVol" shall be provided. +NOTE 2: At least one of "ulTransTimeDur" or "dlTransTimeDur" shall be provided. + +### 5.6.3 Simple data types and enumerations + +#### 5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 5.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. + +**Table 5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 5.6.3.3 Enumeration: AfEvent + +The enumeration AfEvent represents the application events that can be subscribed/notified. It shall comply with the provisions defined in table 5.6.3.3-1. + +**Table 5.6.3.3-1: Enumeration AfEvent** + +| Enumeration value | Description | Applicability | +|---------------------------|-----------------------------------------------------------------------------------------------------|-----------------------| +| SVC_EXPERIENCE | Indicates that the event subscribed/notified is service experience information for an application. | ServiceExperience | +| UE_MOBILITY | Indicates that the event subscribed/notified is UE mobility information. | UeMobility | +| UE_COMM | Indicates that the event subscribed/notified is UE communication information. | UeCommunication | +| EXCEPTIONS | Indicates that the event subscribed/notified is exceptions information. | Exceptions | +| USER_DATA_CONGESTION | Indicates that the event subscribed/notified is user data congestion analytics related information. | UserDataCongestion | +| PERF_DATA | Indicates that the event subscribed/notified is performance data information. | PerformanceData | +| COLLECTIVE_BEHAVIOUR | Indicates that the event subscribed/notified is collective behaviour information. | CollectiveBehaviour | +| DISPERSION | Indicates that the event subscribed/notified is dispersion information. | Dispersion | +| MS_QOE_METRICS | Indicates that the event subscribed/notified is Media Streaming QoE metrics. | MSQoeMetrics | +| MS_CONSUMPTION | Indicates that the event subscribed/notified is Media Streaming Consumption reports. | MSConsumption | +| MS_NET_ASSIST_INVOCATION | Indicates that the event subscribed/notified is Media Streaming Network Assistance invocation. | MSNetAssInvocation | +| MS_DYN_POLICY_INVOCATION | Indicates that the event subscribed/notified is Media Streaming Dynamic Policy invocation. | MSDynPolicyInvocation | +| MS_ACCESS_ACTIVITY | Indicates that the event subscribed/notified is Media Streaming access activity. | MSAccessActivity | +| GNSS_ASSISTANCE_DATA | Indicates that the subscribed/notified event is GNSS Assistance Data Collection. | GNSSAssistData | +| DATA_VOLUME_TRANSFER_TIME | Indicates that the event subscribed is data volume transfer time information. | DataVolTransferTime | + +#### 5.6.3.4 Enumeration: CollectiveBehaviourFilterType + +The enumeration CollectiveBehaviourFilterType represents the parameter type for collective behaviour information filtering. It shall comply with the provisions defined in table 5.6.3.4-1. + +**Table 5.6.3.4-1: Enumeration CollectiveBehaviourFilterType** + +| Enumeration value | Description | Applicability | +|----------------------|-------------------------------------------------------------|---------------| +| COLLECTIVE_ATTRIBUTE | Indicates that the parameter type is collective attributes. | | +| DATA_PROCESSING | Indicates that the parameter type is data processing. | | + +#### 5.6.3.5 Enumeration: DataProcessingType + +The enumeration DataProcessingType represents the type of data processing performed by the AF during UE data collection. It shall comply with the provisions defined in table 5.6.3.5-1. + +**Table 5.6.3.5-1: Enumeration DataProcessingType** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------|---------------| +| AGGREGATION | Used for aggregated data. | | +| NORMALIZATION | Used for normalized data. | | +| ANONYMIZATION | Used for anonymized data. | | + +## 5.7 Error handling + +### 5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [5]. + +For the Naf\_EventExposure API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [6]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [5] 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 [5]. + +In addition, the requirements in the following clauses are applicable for the Naf\_EventExposure API. + +### 5.7.2 Protocol Errors + +In this Release of the specification, there are no service specific protocol errors applicable for the Naf\_EventExposure API. + +### 5.7.3 Application Errors + +The application errors defined for the Naf\_EventExposure service are listed in table 5.7.3-1. + +**Table 5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------|------------------|------------------------------------------------------------------------------------------------| +| MUTING_INSTR_NOT_ACCEPTED | 403 Forbidden | Indicates that the muting instructions received by the NF service consumer cannot be accepted. | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Naf\_EventExposure API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [5]. + +Table 5.8-1: Supported Features + +| Feature number | Feature Name | Description | +|----------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ServiceExperience | This feature indicates support for the event related to service experience. | +| 2 | UeMobility | This feature indicates support for the event related to UE mobility. | +| 3 | UeCommunication | This feature indicates support for the event related to UE communication information. | +| 4 | Exceptions | This feature indicates support for the event related to exception information. | +| 5 | ES3XX | Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [5] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. | +| 6 | EneNA | This feature indicates support for the enhancements of network data analytics requirements. | +| 7 | UserDataCongestion | This feature indicates support for the event related to User Data Congestion Analytics related information. | +| 8 | PerformanceData | This feature indicates support for the event related to performance data information. | +| 9 | Dispersion | This feature indicates support for the event related to Dispersion Analytics related information. | +| 10 | CollectiveBehaviour | This feature indicates support for the event related to collective behaviour information. | +| 11 | ServiceExperienceExt | This feature indicates support for the extensions to the event related to service experience, including reporting Application Server Instance. Supporting this feature also requires the support of feature ServiceExperience. | +| 12 | MSQoeMetrics | This feature indicates support for the event related to Media Streaming QoE metrics for UE Application collected via the Data Collection AF. | +| 13 | MSConsumption | This feature indicates support for the event related to Media Streaming Consumption reports for UE Application collected via the Data Collection AF. | +| 14 | MSNetAssInvocation | This feature indicates support for the event related to Media Streaming Network Assistance invocation for UE Application collected via the Data Collection AF. | +| 15 | MSDynPolicyInvocation | This feature indicates support for the event related to Media Streaming Dynamic Policy invocation for UE Application collected via the Data Collection AF. | +| 16 | MSAccessActivity | This feature indicates support for the event related to Media Streaming access activity for UE Application collected via the Data Collection AF. | +| 17 | DataAccProfileId | This feature indicates support for Data Access Profile Identifier. | +| 18 | AllApplications | This feature indicates applicable to all the applications. | +| 19 | GNSSAssistData | This feature indicates the support of the GNSS Assistance Data Collection functionality as part of the enhancements to the 5G LCS functionality.

The following functionalities are supported:
- GNSS Assistance Data Collection. | +| 20 | PerformanceDataExt_AIML | This feature indicates the support for the extensions of the analytics related to DN performance supporting AIML, including support of Max/Min UL/DL data collection on packet delay, pack loss and throughput. Supporting this feature also requires the support of feature PerformanceData. | +| 21 | UeMobilityExt_AIML | This feature indicates support for further extensions to the event related to UE mobility supporting AIML including support of list of application service area collection. Supporting this feature also requires the support of feature UeMobility. | +| 22 | EnPerformanceData | This feature indicates support for the enhancements of performance data. This feature requires the support of the PerformanceData feature. | +| 23 | UeCommunicationExt_eNA | This feature indicates support for the enhancements of UE Communication, including support of ordering criterion. Supporting | + +| | | | +|----|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | this feature also requires the support of UeCommunication feature. | +| 24 | ServiceExperienceExt2_eNA | This feature indicates support for the extensions to the event related to service experience supporting eNA, including Service Experience Contribution Weights. Supporting this feature also requires the support of feature ServiceExperience. | +| 25 | EnhDataMgmt | Indicates the support of enhanced data management mechanisms. Supporting this feature also requires the support of feature EneNA. | +| 26 | ExtEventFilters | Indicates support of extended AF event filters. | +| 27 | DataVolTransferTime | This feature indicates support for the event related to data volume transfer time. | +| 28 | MSEventExposure | This feature indicates the support for Media Streaming event exposure.

This feature is recommended to be implemented to avoid the usage of the deprecated attributes. | + +## 5.9 Security + +TLS shall be used to support the security communication between the NF Service Consumer and the AF as defined in clause 12.3 and clause 13.1 of 3GPP TS 33.501 [14]. + +If the AF is trusted, as indicated in 3GPP TS 33.501 [14] and 3GPP TS 29.500 [5], the access to the Naf\_EventExposure API may be authorized by means of the OAuth 2.0 protocol (see IETF RFC 6749 [15]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [16]) plays the role of the authorization server. + +If OAuth 2.0 is used, an NF Service Consumer, prior to consuming services offered by the Naf\_EventExposure API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [16], clause 5.4.2.2. + +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 Naf\_EventExposure service. + +The Naf\_EventExposure API defines a single scope "naf-eventexposure" for the entire service, and it does not define any additional scopes at resource or operation level. + +If the AF is untrusted, the access to Naf\_EventExposure API shall be authorized by means of OAuth2 protocol (see IETF RFC 6749 [15]), based on local configuration, using the "Client Credentials" authorization grant. If OAuth2 is used, a NF Service Consumer (e.g. NEF), prior to consuming services offered by the Naf\_EventExposure API, shall obtain a "token" from the authorization server. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex is based on the OpenAPI Specification [8] and provides corresponding representations of all APIs defined in the present specification. + +NOTE 1: An OpenAPIs representation embeds JSON Schema representations of HTTP message bodies. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 2: 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. + +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 5B of the 3GPP TR 21.900 [11] and clause 5.3.1 of the 3GPP TS 29.501 [6] for further information). + +The security scheme defined below for the Naf\_EventExposure API shows the case when the AF is in untrusted domain and the "scopes" and "tokenUrl" are undefined. For the trusted AF, the "scopes" definition shall use "naf-eventexposure" and the "tokenUrl" definition shall use "{nrfApiRoot}/oauth2/token". + +## --- A.2 Naf\_EventExposure API + +``` +openapi: 3.0.0 + +info: + version: 1.3.0-alpha.5 + title: Naf_EventExposure + description: | + AF Event Exposure Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.517 V18.4.0; 5G System; Application Function Event Exposure Service; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.517/ + +servers: + - url: '{apiRoot}/naf-eventexposure/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /subscriptions: + post: + summary: Creates a new Individual Application Event Exposure Subscription resource + operationId: PostAfEventExposureSubsc + tags: + - Application Event Subscription (Collection) + requestBody: +``` + +``` + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureSubsc' +responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureSubsc' + headers: + Location: + description: > + Contains the URI of the created individual application event subscription resource + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + AfEventExposureNotif: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureNotif' + responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +``` + +``` + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + get: + summary: "Reads an existing Individual Application Event Subscription" + operationId: GetAfEventExposureSubsc + tags: + - Individual Application Event Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Application Event Subscription ID + required: true + schema: + type: string + - name: supp-feat + in: query + description: Features supported by the NF service consumer + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureSubsc' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + put: + summary: "Modifies an existing Individual Application Event Subscription " + operationId: PutAfEventExposureSubsc + tags: + - Individual Application Event Subscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureSubsc' + parameters: + - name: subscriptionId + in: path + description: Application Event Subscription ID + required: true + schema: + type: string + responses: + '200': +``` + +``` + description: OK. Resource was successfully modified and representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureSubsc' + '204': + description: No Content. Resource was successfully modified + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: "Cancels an existing Individual Application Event Subscription " + operationId: DeleteAfEventExposureSubsc + tags: + - Individual Application Event Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Application Event Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 +``` + +``` +flows: + clientCredentials: + tokenUrl: '{tokenUri}' + scopes: {} +description: > + For trusted AF, the 'naf-eventexposure' shall be used as 'scopes' and + '{nrfApiRoot}/oauth2/token' shall be used as 'tokenUri'. + +schemas: + AfEventExposureNotif: + description: > + Represents notifications on application event(s) that occurred for an Individual Application + Event Subscription resource. + type: object + properties: + notifId: + type: string + eventNotifs: + type: array + items: + $ref: '#/components/schemas/AfEventNotification' + minItems: 1 + required: + - notifId + - eventNotifs + + AfEventExposureSubsc: + description: Represents an Individual Application Event Subscription resource. + type: object + properties: + dataAccProfId: + type: string + eventsSubs: + type: array + items: + $ref: '#/components/schemas/EventsSubs' + minItems: 1 + eventsRepInfo: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifId: + type: string + eventNotifs: + type: array + items: + $ref: '#/components/schemas/AfEventNotification' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - eventsSubs + - eventsRepInfo + - notifId + - notifUri + + AfEventNotification: + description: Represents information related to an event to be reported. + type: object + properties: + event: + $ref: '#/components/schemas/AfEvent' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + svcExprcInfos: + type: array + items: + $ref: '#/components/schemas/ServiceExperienceInfoPerApp' + minItems: 1 + ueMobilityInfos: + type: array + items: + $ref: '#/components/schemas/UeMobilityCollection' + minItems: 1 + ueCommInfos: + type: array + items: + $ref: '#/components/schemas/UeCommunicationCollection' +``` + +``` + minItems: 1 + excepInfos: + type: array + items: + $ref: '#/components/schemas/ExceptionInfo' + minItems: 1 + congestionInfos: + type: array + items: + $ref: '#/components/schemas/UserDataCongestionCollection' + minItems: 1 + perfDataInfos: + type: array + items: + $ref: '#/components/schemas/PerformanceDataCollection' + minItems: 1 + dispersionInfos: + type: array + items: + $ref: '#/components/schemas/DispersionCollection' + minItems: 1 + collBhvrInfos: + type: array + items: + $ref: '#/components/schemas/CollectiveBehaviourInfo' + minItems: 1 + msQoeMetrInfos: + type: array + items: + $ref: '#/components/schemas/MsQoeMetricsCollection' + minItems: 1 + deprecated: true + msQoeMetrics: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/QoEMetricsCollection' + minItems: 1 + description: Represents the Media Streaming QoE metrics event records. + msConsumpInfos: + type: array + items: + $ref: '#/components/schemas/MsConsumptionCollection' + minItems: 1 + deprecated: true + msConsumpRpts: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/ConsumptionReportingUnitsCollection' + minItems: 1 + description: Represents the Media Streaming Consumption event records. + msNetAssInvInfos: + type: array + items: + $ref: '#/components/schemas/MsNetAssInvocationCollection' + minItems: 1 + deprecated: true + msNetAssistInvs: + type: array + items: + $ref: + 'TS26512_EventExposure.yaml#/components/schemas/NetworkAssistanceInvocationsCollection' + minItems: 1 + description: > + Represents the Media Streaming Network Assistance Invocations event records. + msDynPlyInvInfos: + type: array + items: + $ref: '#/components/schemas/MsDynPolicyInvocationCollection' + minItems: 1 + deprecated: true + msDynPlyInvs: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/DynamicPolicyInvocationsCollection' + minItems: 1 + description: Represents the Media Streaming Dynamic Policy Invocations event records. + msAccActInfos: + type: array +``` + +``` + items: + $ref: '#/components/schemas/MSAccessActivityCollection' + minItems: 1 + deprecated: true + msAccesses: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/MediaStreamingAccessesCollection' + minItems: 1 + description: Represents the Media Streaming access event records. + gnssAssistDataInfo: + $ref: 'TS29591_Nnef_EventExposure.yaml#/components/schemas/GNSSAssistDataInfo' + datVolTransTimeInfos: + type: array + items: + $ref: '#/components/schemas/DatVolTransTimeCollection' + minItems: 1 + required: + - event + - timeStamp + +EventsSubs: + description: Represents an event to be subscribed and the related event filter information. + type: object + properties: + event: + $ref: '#/components/schemas/AfEvent' + eventFilter: + $ref: '#/components/schemas/EventFilter' + required: + - event + - eventFilter + +EventFilter: + description: Represents event filter information for an event. + type: object + properties: + gpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + exterGroupIds: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + minItems: 1 + interGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + anyUeInd: + type: boolean + ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + locArea: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + collAttrs: + type: array + items: + $ref: '#/components/schemas/CollectiveBehaviourFilter' + minItems: 1 + exceptionReqs: + type: array + items: + $ref: 'TS29520_Nnwdf_EventsSubscription.yaml#/components/schemas/Exception' + minItems: 1 + oneOf: +``` + +- required: [gpsis] +- required: [supis] +- required: [exterGroupIds] +- required: [interGroupIds] +- required: [anyUeInd] +- required: [ueIpAddr] + +### **ServiceExperienceInfoPerApp:** + +description: Contains service experience information associated with an application. + +type: object + +#### properties: + +appId: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/ApplicationId' +appServerIns: +\$ref: '#/components/schemas/AddrFqdn' +svcExpPerFlows: +type: array +items: +\$ref: '#/components/schemas/ServiceExperienceInfoPerFlow' +minItems: 1 +gpsis: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Gpsi' +minItems: 1 +supis: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Supi' +minItems: 1 +contrWeights: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/UInteger' +minItems: 1 +required: +- svcExpPerFlows + +### **ServiceExperienceInfoPerFlow:** + +description: Contains service experience information associated with a service flow. + +type: object + +#### properties: + +svcExprc: +\$ref: '#/components/schemas/SvcExperience' +timeIntev: +\$ref: 'TS29122\_CommonData.yaml#/components/schemas/TimeWindow' +dnai: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Dnai' +ipTrafficFilter: +\$ref: 'TS29122\_CommonData.yaml#/components/schemas/FlowInfo' +ethTrafficFilter: +\$ref: 'TS29514\_Npcf\_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + +### **SvcExperience:** + +description: Contains a mean opinion score with the customized range. + +type: object + +#### properties: + +mos: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Float' +upperRange: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Float' +lowerRange: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Float' + +### **UeMobilityCollection:** + +description: > + +Contains UE mobility information associated with an application. If the allAppInd attribute is present and set to true, then the value in the appId shall be ignored, which indicates the collected UE mobility information is applicable to all the applications for the UE. + +type: object + +#### properties: + +gpsi: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Gpsi' +supi: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Supi' +appId: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/ApplicationId' +allAppInd: + +``` +type: boolean +description: > + Indicates applicable to all applications if set to true, otherwise set to false. + Default value is false if omitted. +ueTrajs: + type: array + items: + $ref: '#/components/schemas/UeTrajectoryCollection' + minItems: 1 +areas: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + minItems: 1 +required: +- appId +- ueTrajs + +UeCommunicationCollection: +description: Contains UE communication information associated with an application. +type: object +properties: + gpsI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupI' + exterGroupId: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + expectedUeBehavePara: + $ref: 'TS29122_CpProvisioning.yaml#/components/schemas/CpParameterSet' + comms: + type: array + items: + $ref: '#/components/schemas/CommunicationCollection' + minItems: 1 +required: +- appId +- comms + +UeTrajectoryCollection: +description: Contains UE trajectory information associated with an application. +type: object +properties: + ts: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + locArea: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' +required: +- ts +- locArea + +CommunicationCollection: +description: Contains communication information. +type: object +properties: + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ulVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + dlVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' +required: +- startTime +- endTime +- ulVol +- dlVol + +ExceptionInfo: +description: Represents the exceptions information provided by the AF. +type: object +properties: + ipTrafficFilter: +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + ethTrafficFilter: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + excepts: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/Exception' + minItems: 1 + required: + - excepts + oneOf: + - required: [ipTrafficFilter] + - required: [ethTrafficFilter] + +UserDataCongestionCollection: + description: Contains User Data Congestion Analytics related information collection. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ipTrafficFilter: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + timeInterv: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + thrputUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + thrputDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + thrputPkUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + thrputPkDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + oneOf: + - required: [appId] + - required: [ipTrafficFilter] + +PerformanceDataCollection: + description: Contains Performance Data Analytics related information collection. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + ipTrafficFilter: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + ueLoc: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + appLocs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + asAddr: + $ref: '#/components/schemas/AddrFqdn' + perfData: + $ref: '#/components/schemas/PerformanceData' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - perfData + - timeStamp + +PerformanceData: + description: Contains Performance Data. + type: object + properties: + pdb: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + pdbDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + maxPdbUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + maxPdbDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + plr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + plrDl: + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + maxPlrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + maxPlrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + thrputUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxThrputUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + minThrputUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + thrputDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxThrputDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + minThrputDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + +AddrFqdn: + description: IP address and/or FQDN. + type: object + properties: + ipAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + fqdn: + type: string + description: Indicates an FQDN. + +DispersionCollection: + description: Contains the dispersion information collected for an AF. + type: object + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + ueAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + dataUsage: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + flowDesc: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + dnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + appDur: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + required: + - dataUsage + oneOf: + - required: [gpsi] + - required: [supi] + - required: [ueAddr] + +CollectiveBehaviourFilter: + description: Contains the collective behaviour filter information to be collected from UE. + type: object + properties: + type: + $ref: '#/components/schemas/CollectiveBehaviourFilterType' + value: + type: string + description: Value of the parameter type as in the type attribute. + collBehAttr: + type: array + items: + $ref: '#/components/schemas/PerUeAttribute' + minItems: 1 + description: > + Contains the values of collective behaviour attributes at least one of which shall + match for an AF event to be sent. + dataProcType: +``` + +``` +$ref: '#/components/schemas/DataProcessingType' +listOfUeInd: + type: boolean + description: > + Indicates whether request list of UE IDs that fulfill a collective behaviour within the + area of interest. This attribute shall set to "true" if request the list of UE IDs, + otherwise, set to "false". May only be present and sets to "true" if "AfEvent" sets to + "COLLECTIVE_BEHAVIOUR". +required: +- type +- value + +CollectiveBehaviourInfo: + description: Contains the collective behaviour information to be reported to the subscriber. + type: object + properties: + colAttrib: + type: array + items: + $ref: '#/components/schemas/PerUeAttribute' + minItems: 1 + noOfUes: + type: integer + description: Total number of UEs that fulfil a collective within the area of interest. + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + extUeIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + ueIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + required: + - colAttrib + oneOf: + - required: [extUeIds] + - required: [ueIds] + +PerUeAttribute: + description: UE application data collected per UE. + type: object + properties: + ueDest: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + route: + type: string + avgSpeed: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + timeOfArrival: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +MsQoeMetricsCollection: + description: > + Contains the Media Streaming QoE metrics information collected for an UE Application via AF. + type: object + properties: + msQoeMetrics: + type: array + items: + type: string + minItems: 1 + required: + - msQoeMetrics + +MsConsumptionCollection: + description: > + Contains the Media Streaming Consumption information collected for an UE Application via AF. + type: object + properties: + msConsumps: + type: array +``` + +``` + items: + type: string + description: > + Represents the Media Streaming Consumption reports with formatting as specified in + clause 11.3.3 of 3GPP TS 26.512 [30], if required for Media Streaming UE Application. + minItems: 1 + required: + - msConsumps + +MsNetAssInvocationCollection: + description: > + Contains the Media Streaming Network Assistance invocation collected for an UE Application + via AF. + type: object + properties: + msNetAssInvocs: + type: array + items: + $ref: 'TS26512_M5_NetworkAssistance.yaml#/components/schemas/NetworkAssistanceSession' + minItems: 1 + required: + - msNetAssInvocs + +MsDynPolicyInvocationCollection: + description: > + Contains the Media Streaming Dynamic Policy invocation collected for an UE + Application via AF. + type: object + properties: + msDynPlyInvocs: + type: array + items: + $ref: 'TS26512_M5_DynamicPolicies.yaml#/components/schemas/DynamicPolicy' + minItems: 1 + required: + - msDynPlyInvocs + +MSAccessActivityCollection: + description: Contains Media Streaming access activity collected for an UE Application via AF. + type: object + properties: + msAccActs: + type: array + items: + $ref: 'TS26512_R4_DataReporting.yaml#/components/schemas/MediaStreamingAccessRecord' + minItems: 1 + required: + - msAccActs + +DatVolTransTimeCollection: + description: Contains the collective data volume transfer time information to be reported to +the subscriber. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + appServerInst: + $ref: '#/components/schemas/AddrFqdn' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + ulTransVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + dlTransVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + ulTransTimeDur: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + dlTransTimeDur: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + anyOf: + - anyOf: + - required: [ulTransVol] + - required: [dlTransVol] + - anyOf: + - required: [ulTransTimeDur] + - required: [dlTransTimeDur] +``` + +# Simple data types and Enumerations + +``` +AfEvent: + anyOf: + - type: string + enum: + - SVC_EXPERIENCE + - UE_MOBILITY + - UE_COMM + - EXCEPTIONS + - USER_DATA_CONGESTION + - PERF_DATA + - DISPERSION + - COLLECTIVE_BEHAVIOUR + - MS_QOE_METRICS + - MS_CONSUMPTION + - MS_NET_ASSIST_INVOCATION + - MS_DYN_POLICY_INVOCATION + - MS_ACCESS_ACTIVITY + - GNSS_ASSISTANCE_DATA + - DATA_VOLUME_TRANSFER_TIME + - type: string + description: > + 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. + description: | + Represents an application's event. + Possible values are: + - SVC_EXPERIENCE: Indicates that the subscribed/notified event is service experience + information for an application. + - UE_MOBILITY: Indicates that the subscribed/notified event is UE mobility information. + - UE_COMM: Indicates that the subscribed/notified event is UE communication information. + - EXCEPTIONS: Indicates that the subscribed/notified event is exceptions information. + - USER_DATA_CONGESTION: Indicates that the subscribed/notified event is user data congestion + analytics related information. + - PERF_DATA: Indicates that the subscribed/notified event is performance data information. + - DISPERSION: Indicates that the subscribed/notified event is dispersion information. + - COLLECTIVE_BEHAVIOUR: Indicates that the subscribed/notified event is collective behaviour + information. + - MS_QOE_METRICS: Indicates that the subscribed/notified event is Media Streaming QoE + metrics. + - MS_CONSUMPTION: Indicates that the subscribed/notified event is Media Streaming + consumption reports. + - MS_NET_ASSIST_INVOCATION: Indicates that the subscribed/notified event is Media Streaming + network assistance invocation. + - MS_DYN_POLICY_INVOCATION: Indicates that the subscribed/notified event is Media Streaming + dynamic policy invocation. + - MS_ACCESS_ACTIVITY: Indicates that the subscribed/notified event is Media Streaming access + activity. + - GNSS_ASSISTANCE_DATA: Indicates that the subscribed/notified event is GNSS Assistance Data + Collection. + +CollectiveBehaviourFilterType: + anyOf: + - type: string + enum: + - COLLECTIVE_ATTRIBUTE + - DATA_PROCESSING + - type: string + description: > + 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. + description: | + Represents the parameter type for collective behaviour information filtering. + Possible values are: + - COLLECTIVE_ATTRIBUTE: Indicates that the parameter type is collective attributes. + - DATA_PROCESSING: Indicates that the parameter type is data processing. + +DataProcessingType: + description: Represents a type of data processing. + anyOf: + - type: string + enum: + - AGGREGATION + - NORMALIZATION + - ANONYMIZATION + - type: string + description: > +``` + +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. + + + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|----------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-03 | | | | | | TS skeleton of Application Function Event Exposure Service | 0.0.0 | +| 2019-04 | CT3#102 | | | | | Inclusion of C3-191230, C3-191374 and editorial change from Rapporteur. | 0.1.0 | +| 2019-05 | CT3#103 | | | | | Inclusion of C3-192194, C3-192393, C3-192260 and C3-192261. | 0.2.0 | +| 2019-08 | CT3#105 | | | | | Inclusion of C3-193373, C3-193440, C3-193441 and C3-193446. | 0.3.0 | +| 2019-10 | CT3#106 | | | | | Inclusion of C3-194263, C3-194264, C3-194393 and C3-194439. | 0.4.0 | +| 2019-11 | CT3#107 | | | | | Inclusion of C3-195068, C3-195226, C3-195238. | 0.5.0 | +| 2019-12 | CT#86 | CP-193178 | | | | Presented for information | 1.0.0 | +| 2019-12 | CT#86 | CP-193295 | | | | A title corrected | 1.0.1 | +| 2020-02 | CT3#108e | | | | | Inclusion of C3-201297, C3-201369, C3-201385, C3-201399, C3-201440 and C3-201466. | 1.1.0 | +| 2020-03 | CT#87e | CP-200188 | | | | TS sent to plenary for approval | 2.0.0 | +| 2020-03 | CT#87e | CP-200188 | | | | TS approved by plenary | 16.0.0 | +| 2020-06 | CT#88e | CP-201234 | 0001 | | F | Update service operation for Ue Communication | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0002 | | F | Corrections in TS 29.517 | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0003 | | F | Definition of AfEventExposureSubsc in OpenAPI | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0004 | 1 | D | Unsubscribe service operation | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0005 | 1 | F | Correction to event description | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0006 | 1 | F | Correction to target UE description | 16.1.0 | +| 2020-06 | CT#88e | CP-201244 | 0007 | 1 | F | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0008 | | F | Service operation description for UE mobility | 16.1.0 | +| 2020-06 | CT#88e | CP-201256 | 0009 | 1 | F | URI of the Naf_EventExposure service | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0010 | | F | Support of immediate reporting | 16.1.0 | +| 2020-06 | CT#88e | CP-201077 | 0012 | 1 | F | Supported features definition | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0013 | 1 | F | Target UE information | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0014 | 1 | F | Supported headers, Resource Data type and yaml mapping | 16.1.0 | +| 2020-06 | CT#88e | CP-201255 | 0015 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.1.0 | +| 2020-09 | CT#89e | CP-202066 | 0017 | 1 | F | Missed data type definition | 16.2.0 | +| 2020-09 | CT#89e | CP-202066 | 0018 | | F | Corrections on UE Mobility | 16.2.0 | +| 2020-09 | CT#89e | CP-202066 | 0019 | | F | Missed response code | 16.2.0 | +| 2020-09 | CT#89e | CP-202066 | 0020 | 1 | F | Any UE indication applies to EXCEPTIONS | 16.2.0 | +| 2020-12 | CT#90e | CP-203139 | 0021 | 1 | F | Essential Corrections and alignments | 16.3.0 | +| 2020-12 | CT#90e | CP-203139 | 0022 | | F | Storage of YAML files in 3GPP Forge | 16.3.0 | +| 2020-12 | CT#90e | CP-203129 | 0023 | 1 | F | Removal of trailing forward slash in resource URI | 16.3.0 | +| 2020-12 | CT#90e | CP-203139 | 0024 | 1 | F | Callback URI correction | 16.3.0 | +| 2020-12 | CT#90e | CP-203152 | 0027 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2020-12 | CT#90e | CP-203130 | 0025 | 1 | F | Corrections to location area usage | 17.0.0 | +| 2021-03 | CT#91e | CP-210206 | 0029 | | A | Correction to anyUeInd attribute | 17.1.0 | +| 2021-03 | CT#91e | CP-210191 | 0031 | 1 | A | Support Stateless NFs | 17.1.0 | +| 2021-03 | CT#91e | CP-210218 | 0032 | | F | OpenAPI reference | 17.1.0 | +| 2021-03 | CT#91e | CP-210219 | 0033 | | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.1.0 | +| 2021-03 | CT#91e | CP-210220 | 0034 | | F | Optional header clarification | 17.1.0 | +| 2021-03 | CT#91e | CP-210206 | 0036 | | F | Resource URI correction | 17.1.0 | +| 2021-03 | CT#91e | CP-210240 | 0038 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-06 | CT#92e | CP-211221 | 0039 | 1 | B | Partitioning criteria for applying sampling in specific UE partitions in AF exposure | 17.2.0 | +| 2021-06 | CT#92e | CP-211221 | 0040 | | B | Support of Mute reporting | 17.2.0 | +| 2021-06 | CT#92e | CP-211200 | 0041 | 1 | A | Redirection responses | 17.2.0 | +| 2021-06 | CT#92e | CP-211221 | 0043 | 1 | B | Extensions to User Data Congestion Analytics | 17.2.0 | +| 2021-06 | CT#92e | CP-211265 | 0045 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-09 | CT#93e | CP-212203 | 0046 | 2 | B | Support of Performance Data event | 17.3.0 | +| 2021-09 | CT#93e | CP-212220 | 0047 | | F | Resource URI correction on Naf_EventExposure API | 17.3.0 | +| 2021-09 | CT#93e | CP-212203 | 0048 | 1 | B | Collective Behaviour analytics | 17.3.0 | +| 2021-09 | CT#93e | CP-212203 | 0049 | 2 | B | Support UE data volume dispersion collection | 17.3.0 | +| 2021-09 | CT#93e | CP-212223 | 0050 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2021-12 | CT#94e | CP-213227 | 0052 | 1 | B | Updates to UE data volume dispersion collection | 17.4.0 | +| 2021-12 | CT#94e | CP-213256 | 0055 | | B | Collective Behaviour Analytics update | 17.4.0 | +| 2021-12 | CT#94e | CP-213227 | 0051 | 1 | F | Updates to User Data Congestion | 17.4.0 | +| 2021-12 | CT#94e | CP-213227 | 0053 | | F | Adding collective behaviour analytics feature | 17.4.0 | +| 2021-12 | CT#94e | CP-213227 | 0054 | 2 | F | Update of notification procedure with description of USER_DATA_CONGESTION and DISPERSION events | 17.4.0 | +| 2021-12 | CT#94e | CP-213220 | 0056 | | B | Alignment with SA3 supported TLS profiles | 17.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------------|--------| +| 2021-12 | CT#94e | CP-213246 | 0057 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.4.0 | +| 2022-03 | CT#95e | CP-220190 | 0058 | 1 | B | Update UE Application collective behaviour for NF Load analytics | 17.5.0 | +| 2022-03 | CT#95e | CP-220190 | 0059 | 1 | F | type attribute in CollectiveBehaviourFilter data type | 17.5.0 | +| 2022-03 | CT#95e | CP-220190 | 0060 | 1 | F | Miscellaneous corrections | 17.5.0 | +| 2022-03 | CT#95e | CP-220191 | 0062 | 1 | F | Formatting of description fields | 17.5.0 | +| 2022-03 | CT#95e | CP-220201 | 0061 | 1 | F | Corrections to Data Model of AF Event Exposure service | 17.5.0 | +| 2022-03 | CT#95e | CP-220194 | 0063 | | F | Update of info and externalDocs field | 17.5.0 | +| 2022-06 | CT#96 | CP-221131 | 0064 | 1 | B | Add Application duration for Dispersion | 17.6.0 | +| 2022-06 | CT#96 | CP-221131 | 0065 | 1 | B | Add Application Server Instance for Service Experience | 17.6.0 | +| 2022-06 | CT#96 | CP-221155 | 0068 | 1 | F | Remove the apiVersion placeholder from the resource URI variables table | 17.6.0 | +| 2022-06 | CT#96 | CP-221133 | 0066 | - | F | Muting notifications correction | 17.6.0 | +| 2022-06 | CT#96 | CP-221134 | 0067 | - | F | Presence condition on the data types of Naf_EventExposure service | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0069 | 1 | B | Support UE Application event exposure via Data Collection AF | 17.6.0 | +| 2022-06 | CT#96 | CP-221296 | 0070 | 1 | B | Support QoE metrics in AF Event Exposure | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0071 | 1 | B | Support Consumption reports in AF Event Exposure | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0072 | 1 | B | Support Network Assistance invocations in AF Event Exposure | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0073 | 1 | B | Support Charging and Policy invocations in AF Event Exposure | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0074 | 1 | B | Support Media Streaming access activity in AF Event Exposure | 17.6.0 | +| 2022-06 | CT#96 | CP-221151 | 0075 | - | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-09 | CT#97e | CP-222101 | 0083 | - | F | clarification on dataUsage in DispersionCollection | 17.7.0 | +| 2022-09 | CT#97e | CP-222103 | 0084 | 1 | F | Add NOTE for 3xx response codes | 17.7.0 | +| 2022-09 | CT#97e | CP-222102 | 0085 | 1 | F | Missing description field for enumeration data types | 17.7.0 | +| 2022-09 | CT#97e | CP-222103 | 0082 | 1 | F | Correcting the events to which certain event consumers can subscribe | 17.7.0 | +| 2022-09 | CT#97e | CP-222110 | 0076 | 1 | B | Updates to Media Streaming QoE metrics Event | 17.7.0 | +| 2022-09 | CT#97e | CP-222110 | 0077 | 1 | F | Updates to Media Streaming Consumption Event | 17.7.0 | +| 2022-09 | CT#97e | CP-222110 | 0078 | 1 | F | Updates to Media Streaming Network Assistance Invocation Event | 17.7.0 | +| 2022-09 | CT#97e | CP-222110 | 0079 | 1 | F | Updates to Media Streaming Dynamic Policy Invocation Event | 17.7.0 | +| 2022-09 | CT#97e | CP-222110 | 0080 | 1 | F | Updates to Media Streaming Access Event | 17.7.0 | +| 2022-09 | CT#97e | CP-222121 | 0086 | - | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-12 | CT#98e | C3-225534 | 0088 | 1 | F | Corrections to procedures of MS Event Exposure | 17.8.0 | +| 2022-12 | CT#98e | CP-223191 | 0087 | - | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0089 | 1 | F | Corrections to UE Mobility event | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0090 | 1 | F | Correct the name of the data structure | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0091 | - | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230145 | 0093 | 1 | A | Adding DCCF and MFAF to the NF service consumers | 18.1.0 | +| 2023-03 | CT#99 | CP-230134 | 0094 | 1 | B | Update to Data Type PerformanceData for DN Performance | 18.1.0 | +| 2023-03 | CT#99 | CP-230134 | 0095 | 1 | B | Updates to Data Type UeMobilityCollection for UE Mobility | 18.1.0 | +| 2023-03 | CT#99 | CP-230134 | 0096 | 1 | B | Enhance the performance data collection for DN performance | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0097 | 1 | B | Enhance the filter for performance data collection | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0098 | 1 | B | Support of collecting expected UE behaviour parameters from AF | 18.1.0 | +| 2023-03 | CT#99 | CP-230125 | 0100 | 1 | B | Updates to support GNSS assistance data collection from AF via NEF | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0101 | - | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231124 | 0099 | 2 | B | Improving the Correctness of Service Experience Analytics with Contribution Weights | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0102 | 1 | B | Adding UE address to the target UE information | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0103 | - | F | Missing feature dependency for performance data | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0104 | 1 | B | Event muting enhancements for AF event exposure | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0105 | 1 | B | Implementing required AF event filters | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0107 | 1 | F | Corrections to the description fields of the Naf_EventExposure API enumerations | 18.2.0 | +| 2023-06 | CT#100 | CP-231166 | 0109 | 1 | F | Changing the feature name for the GNSS Assistance Data Collection functionality | 18.2.0 | +| 2023-06 | CT#100 | CP-231166 | 0110 | - | B | Continuing the definition of the content of the GNSS Assistance Data Collection information | 18.2.0 | +| 2023-06 | CT#100 | CP-231249 | 0112 | 1 | B | Update to Naf_EventExposure API for E2E Data Volume Transfer Time Analytics | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0114 | - | F | Corrections to the redirection mechanism description | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0115 | - | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232097 | 0116 | 1 | B | Support of providing the time stamp for the data volume dispersion information | 18.3.0 | +| 2023-09 | CT#101 | CP-232109 | 0117 | | F | Corrections to GNSS Assistance Data Collection | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0118 | 1 | F | Adding missing feature for appIds and locArea attributes | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0119 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233262 | 0120 | 1 | B | Complete the definition of the content of the GNSS Assistance Data Collection information | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0121 | 1 | B | HTTP RFC uplifting | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0122 | - | F | corrections to CollectiveBehaviour | 18.4.0 | +| 2023-12 | CT#102 | CP-233229 | 0124 | 1 | B | Updating the obsoleted IETF HTTP RFCs | 18.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------|--------| +| 2023-12 | CT#102 | CP-233247 | 0125 | 1 | B | Update the data types of the Media Steaming attributes | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 0126 | - | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29526/raw.md b/raw/rel-18/29_series/29526/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..3df460ad87c83dbc426043a3596b60f126b80edd --- /dev/null +++ b/raw/rel-18/29_series/29526/raw.md @@ -0,0 +1,2412 @@ + + +# 3GPP TS 29.526 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Network Slice-Specific and SNPN Authentication and Authorization services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +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. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'P' has a red signal wave icon at its base. + +3GPP logo + +A GLOBAL INITIATIVE + +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. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions, abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 9 | +| 4 Overview..... | 9 | +| 4.1 Introduction ..... | 9 | +| 5 Services offered by the NSSAAF ..... | 10 | +| 5.1 Introduction ..... | 10 | +| 5.2 NnssAAF_NSSAA Service..... | 10 | +| 5.2.1 Service Description ..... | 10 | +| 5.2.2 Service Operations..... | 10 | +| 5.2.2.1 Introduction..... | 10 | +| 5.2.2.2 Authenticate ..... | 11 | +| 5.2.2.2.1 General ..... | 11 | +| 5.2.2.3 Re-Authentication Notification..... | 13 | +| 5.2.2.3.1 General ..... | 13 | +| 5.2.2.4 Revocation Notification..... | 15 | +| 5.2.2.4.1 General ..... | 15 | +| 5.3 NnssAAF_AIW Service..... | 16 | +| 5.3.1 Service Description ..... | 16 | +| 5.3.2 Service Operations..... | 16 | +| 5.3.2.1 Introduction..... | 16 | +| 5.3.2.2 Authenticate ..... | 16 | +| 5.3.2.2.1 General ..... | 16 | +| 6 API Definitions ..... | 18 | +| 6.1 NnssAAF_NSSAA Service API ..... | 18 | +| 6.1.1 Introduction ..... | 18 | +| 6.1.2 Usage of HTTP..... | 19 | +| 6.1.2.1 General..... | 19 | +| 6.1.2.2 HTTP standard headers..... | 19 | +| 6.1.2.2.1 General ..... | 19 | +| 6.1.2.2.2 Content type ..... | 19 | +| 6.1.2.3 HTTP custom headers..... | 19 | +| 6.1.3 Resources..... | 19 | +| 6.1.3.1 Overview..... | 19 | +| 6.1.3.2 Resource: slice-authentications (Collection) ..... | 20 | +| 6.1.3.2.1 Description ..... | 20 | +| 6.1.3.2.2 Resource Definition..... | 20 | +| 6.1.3.2.3 Resource Standard Methods..... | 20 | +| 6.1.3.2.4 Resource Custom Operations..... | 22 | +| 6.1.3.3 Resource: slice-authentication (Document)..... | 22 | +| 6.1.3.3.1 Description ..... | 22 | +| 6.1.3.3.2 Resource Definition..... | 22 | +| 6.1.3.3.3 Resource Standard Methods..... | 22 | +| 6.1.3.3.4 Resource Custom Operations..... | 24 | +| 6.1.4 Custom Operations without associated resources ..... | 24 | +| 6.1.4.1 Overview..... | 24 | +| 6.1.5 Notifications ..... | 24 | +| 6.1.5.1 General..... | 24 | +| 6.1.5.2 Re-authentication Notification..... | 24 | +| 6.1.5.2.1 Description ..... | 24 | +| 6.1.5.2.2 Target URI..... | 24 | + +| | | | +|-----------|----------------------------------------------------------------------------------|----| +| 6.1.5.2.3 | Standard Methods..... | 24 | +| 6.1.5.3 | Revocation Notification..... | 25 | +| 6.1.5.3.1 | Description ..... | 25 | +| 6.1.5.3.2 | Target URI..... | 25 | +| 6.1.5.3.3 | Standard Methods..... | 25 | +| 6.1.6 | Data Model ..... | 26 | +| 6.1.6.1 | General ..... | 26 | +| 6.1.6.2 | Structured data types..... | 27 | +| 6.1.6.2.1 | Introduction ..... | 27 | +| 6.1.6.2.2 | Type: SliceAuthInfo..... | 28 | +| 6.1.6.2.3 | Type: SliceAuthContext..... | 28 | +| 6.1.6.2.4 | Type: SliceAuthConfirmationData ..... | 28 | +| 6.1.6.2.5 | Type: SliceAuthConfirmationResponse..... | 29 | +| 6.1.6.2.6 | Type: SliceAuthReauthNotification..... | 29 | +| 6.1.6.2.7 | Type: SliceAuthRevocNotification..... | 29 | +| 6.1.6.3 | Simple data types and enumerations..... | 29 | +| 6.1.6.3.1 | Introduction ..... | 29 | +| 6.1.6.3.2 | Simple data types ..... | 29 | +| 6.1.6.3.3 | Enumeration: SliceAuthNotificationType..... | 29 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 30 | +| 6.1.6.5 | Binary data ..... | 30 | +| 6.1.7 | Error Handling ..... | 30 | +| 6.1.7.1 | General ..... | 30 | +| 6.1.7.2 | Protocol Errors ..... | 30 | +| 6.1.7.3 | Application Errors..... | 30 | +| 6.1.8 | Feature negotiation ..... | 30 | +| 6.1.9 | Security ..... | 31 | +| 6.1.10 | HTTP redirection..... | 31 | +| 6.2 | Nnssaaaf_AIW Service API..... | 31 | +| 6.2.1 | Introduction ..... | 31 | +| 6.2.2 | Usage of HTTP..... | 32 | +| 6.2.2.1 | General ..... | 32 | +| 6.2.2.2 | HTTP standard headers..... | 32 | +| 6.2.2.2.1 | General ..... | 32 | +| 6.2.2.2.2 | Content type ..... | 32 | +| 6.2.2.3 | HTTP custom headers..... | 32 | +| 6.2.3 | Resources..... | 32 | +| 6.2.3.1 | Overview..... | 32 | +| 6.2.3.2 | Resource: authentications (Collection)..... | 33 | +| 6.2.3.2.1 | Description ..... | 33 | +| 6.2.3.2.2 | Resource Definition..... | 33 | +| 6.2.3.2.3 | Resource Standard Methods..... | 33 | +| 6.2.3.3 | Resource: authentication (Document) ..... | 35 | +| 6.2.3.3.1 | Description ..... | 35 | +| 6.2.3.3.2 | Resource Definition..... | 35 | +| 6.2.3.3.3 | Resource Standard Methods..... | 35 | +| 6.2.4 | Custom Operations without associated resources ..... | 37 | +| 6.2.5 | Notifications ..... | 37 | +| 6.2.6 | Data Model ..... | 37 | +| 6.2.6.1 | General ..... | 37 | +| 6.2.6.2 | Structured data types..... | 37 | +| 6.2.6.2.1 | Introduction ..... | 37 | +| 6.2.6.2.2 | Type: AuthInfo..... | 38 | +| 6.2.6.2.3 | Type: AuthContext..... | 38 | +| 6.2.6.2.4 | Type: AuthConfirmationData ..... | 38 | +| 6.2.6.2.5 | Type: AuthConfirmationResponse..... | 39 | +| 6.2.6.3 | Simple data types and enumerations..... | 39 | +| 6.2.6.3.1 | Introduction ..... | 39 | +| 6.2.6.3.2 | Simple data types ..... | 39 | +| 6.2.7 | Error Handling ..... | 39 | +| 6.2.7.1 | General ..... | 39 | +| 6.2.7.2 | Protocol Errors ..... | 39 | + +| | | | +|-------------------------------|------------------------------------|-----------| +| 6.2.7.3 | Application Errors..... | 39 | +| 6.2.8 | Feature negotiation ..... | 40 | +| 6.2.9 | Security ..... | 40 | +| 6.2.10 | HTTP redirection..... | 40 | +| Annex A (normative): | OpenAPI specification ..... | 41 | +| A.1 | General..... | 41 | +| A.2 | Nnssaaaf_NSSAA API ..... | 41 | +| A.3 | Nnssaaaf_AIW API ..... | 46 | +| Annex B (informative): | Change history..... | 50 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# 1 Scope + +The present document specifies the stage 3 protocol and data model for the NnssAAF Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the NSSAAF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +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]. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] IETF RFC 4648: "The Base16, Base32 and Base64 Data Encodings". +- [15] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [16] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [17] 3GPP TS 29.536: "5G System; Network Slice Admission Control Services; Stage 3". +- [18] 3GPP TS 29.509: "5G System; Authentication Server Services; Stage 3". +- [19] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". + +# 3 Definitions, abbreviations + +## 3.1 Definitions + +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]. + +## 3.2 Abbreviations + +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]. + +| | | +|--------|---------------------------------------------------------------------------| +| NSSAA | Network Slice-Specific Authentication and Authorization | +| NSSAAF | Network Slice-specific and SNPN Authentication and Authorization Function | +| SNPN | Standalone Non-Public Network | + +# 4 Overview + +## 4.1 Introduction + +Within the 5GC, the NSSAAF offers services to the AMF and the AUSF via the Nnssaaf service-based interface. + +The AMF shall make use of the NSSAAF service when it needs to invoke network slice-specific authentication and authorization for a specific UE and a specific S-NSSAI (see 3GPP TS 23.502 [3] clause 4.2.9.2, and 3GPP TS 33.501 [14] clause 16.2 and 16.3). + +The NSSAAF service shall also be used by the AMF to receive slice re-authentication notification or slice authorization revocation notification sent from the AAA-S (see 3GPP TS 23.502 [3] clause 4.2.9.3, 4.2.9.4 and 3GPP TS 33.501 [14] clause 16.3 and 16.4). + +The AUSF shall make use of the NSSAAF service when it needs to invoke a primary authentication in SNPN with Credentials holder using AAA server; the AUSF shall also make use of this service during the UE onboarding procedure in SNPN scenarios, when the Default Credentials Server (DCS) uses an AAA server for primary authentication. + +Figure 4.1-1 provides the reference model with focus on the NSSAAF. + +![Reference model diagram showing AMF and AUSF connected to NSSAAF via the Nnssaaf interface.](a92b1fdf37a74b707e9f03087c8f1377_img.jpg) + +``` +graph LR; AMF[AMF] --- Nnssaaf((Nnssaaf)); AUSF[AUSF] --- Nnssaaf; Nnssaaf --- NSSAAF[NSSAAF]; style NSSAAF fill:#90EE90,stroke:#000 +``` + +The diagram illustrates the reference model for the NSSAAF. On the left, two rectangular boxes represent the AMF (Access and Management Function) and the AUSF (Authentication Server Function). Lines from both boxes converge to a central point labeled 'Nnssaaf', which is represented by a small circle. From this circle, a line extends to a larger rectangular box on the right labeled 'NSSAAF', which is highlighted with a light green fill. + +Reference model diagram showing AMF and AUSF connected to NSSAAF via the Nnssaaf interface. + +Figure 4.1-1: Reference model – NSSAAF + +# 5 Services offered by the NSSAAF + +## 5.1 Introduction + +The NSSAAF offers the following services via the Nnssaaf interface: + +- Nnssaaf\_NSSAA Service +- Nnssaaf\_AIW Service + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------|--------|---------------------------------------------------------|----------------------------|---------------|-------| +| Nnssaaf_NSSAA | 5.2 | Slice-specific authentication and authorization service | TS29526_Nnssaaf_NSSAA.yaml | nnssaaf-nssaa | A.2 | +| Nnssaaf_AIW | 5.x | AAA Interworking service | TS29526_Nnssaaf_AIW.yaml | nnssaaf-aiw | A.3 | + +## 5.2 Nnssaaf\_NSSAA Service + +### 5.2.1 Service Description + +The Nnssaaf\_NSSAA service provides slice-specific authentication and authorization for a given UE. The NSSAAF is acting as NF Service Producer, while the AMF is the NF Service Consumer. + +Following functionalities are provided by the Nnssaaf\_NSSAA service: + +- Perform slice-specific authentication and authorization for a given UE; +- Trigger slice-specific re-authentication to a given UE; +- Revoke the slice-specific authentication and authorization for a given UE. + +The Nnssaaf\_NSSAA service supports the following service operations. + +**Table 5.2.1-1: Service operations supported by the Nnssaaf\_NSSAA service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------------------|----------------------------------------------------------------------------------------------|---------------------|---------------------| +| Authenticate | Perform slice-specific authentication and authorization for a given UE. | Request/Response | AMF | +| Re-Authentication Notification | Request slice-specific re-authentication and re-authorization for a given UE. | Callback | AMF | +| Revocation Notification | Request revocation of slice-specific authentication and authorization result for a given UE. | Callback | AMF | + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +See Table 5.2.1-1 for an overview of the service operations supported by the Nnssaaf\_NSSAA service. + +#### 5.2.2.2 Authenticate + +##### 5.2.2.2.1 General + +The Authenticate service operation permits the NF Service Consumer (i.e. the AMF) to initiate slice-specific authentication and authorization, e.g. during a UE Registration procedure or upon reception of a re-authentication notification from the NSSAAF (see clause 5.2.2.3). The NSSAAF may relay the EAP message to an AAA-S and collect the result of slice-specific authentication and authorization from the AAA-S, as specified in clause 4.2.9.2 of 3GPP TS 23.502 [3], and clause 16.3 of 3GPP TS 33.501 [8]. + +The NF Service Consumer (i.e. the AMF) shall send a POST request to the resource representing slice authentication collection (i.e. .../slice-authentications) to request the NSSAAF to create the corresponding resource context and perform slice-specific authentication and authorization. + +![Sequence diagram for Slice-Specific Authentication and Authorization between NF Service Consumer and NSSAAF.](8e14350b4b669119a3bdfca7869110ca_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSAAF + Note right of NSSAAF: AAA-S + Note right of NSSAAF: AAA-S + + Note left of NF Service Consumer: 1. POST .../slice-authentications (SliceAuthInfo) + NF Service Consumer->>NSSAAF: 1. POST .../slice-authentications (SliceAuthInfo) + Note right of NSSAAF: 2. Forward EAP ID to AAA-S + NSSAAF-->>AAA-S: 2. Forward EAP ID to AAA-S + Note right of AAA-S: -3a. 201 Created (SliceAuthContext) + AAA-S-->>NSSAAF: -3a. 201 Created (SliceAuthContext) + Note right of AAA-S: -3b. 4xx/5xx (ProblemDetails) + AAA-S-->>NSSAAF: -3b. 4xx/5xx (ProblemDetails) + Note right of AAA-S: -3c. 3xx (RedirectResponse) + AAA-S-->>NSSAAF: -3c. 3xx (RedirectResponse) + Note left of NF Service Consumer: 4. PUT .../slice-authentications/{authCtxId}/confirmation(SliceAuthConfirmationData) + NF Service Consumer->>NSSAAF: 4. PUT .../slice-authentications/{authCtxId}/confirmation(SliceAuthConfirmationData) + Note right of NSSAAF: 5. Forward EAP message to AAA-S + NSSAAF-->>AAA-S: 5. Forward EAP message to AAA-S + Note right of AAA-S: -6a. 200 OK (SliceAuthConfirmationResponse) + AAA-S-->>NSSAAF: -6a. 200 OK (SliceAuthConfirmationResponse) + Note right of AAA-S: -6b. 4xx/5xx (ProblemDetails) + AAA-S-->>NSSAAF: -6b. 4xx/5xx (ProblemDetails) + Note right of AAA-S: -6c. 3xx (RedirectResponse) + AAA-S-->>NSSAAF: -6c. 3xx (RedirectResponse) + Note left of NF Service Consumer: 7. PUT .../slice-authentications/{authCtxId}/confirmation(SliceAuthConfirmationData) + NF Service Consumer->>NSSAAF: 7. PUT .../slice-authentications/{authCtxId}/confirmation(SliceAuthConfirmationData) + Note right of NSSAAF: 8. Forward EAP message to AAA-S + NSSAAF-->>AAA-S: 8. Forward EAP message to AAA-S + Note right of AAA-S: -9a. 200 OK (SliceAuthConfirmationResponse) + AAA-S-->>NSSAAF: -9a. 200 OK (SliceAuthConfirmationResponse) + Note right of AAA-S: -9b. 4xx/5xx (ProblemDetails) + AAA-S-->>NSSAAF: -9b. 4xx/5xx (ProblemDetails) + Note right of AAA-S: -9c. 3xx (RedirectResponse) + AAA-S-->>NSSAAF: -9c. 3xx (RedirectResponse) + +``` + +Sequence diagram for Slice-Specific Authentication and Authorization between NF Service Consumer and NSSAAF. + +**Figure 5.2.2.2.1-1: Slice-Specific Authentication and Authorization** + +1. The NF Service Consumer (AMF) shall send a POST request to the NSSAAF, targeting the resource of slice authentication collection (i.e. .../slice-authentications), to perform slice-specific authentication and authorization. + +The HTTP content shall contain the slice authentication information, which includes: + +- UE ID (i.e. GPSI), if multiple GPSIs received from the UDM, the NF Service Consumer shall include any one of the GPSIs. +- S-NSSAI +- EAP ID Response message (if it is received from the UE), or the EAP ID Response message with EAP ID stored, or the EAP ID Response message with Null value (if EAP ID is not requested or received); +- optionally, the callback URI of the AMF to receive re-authentication notification from the NSSAAF; + +- optionally, the callback URI of the AMF to receive revocation notification from the NSSAAF. + +Based on local policy, the AMF may determine to provide callback URI(s) for receiving re-authentication notification or revocation notification. For example, the callback URIs are provided for an UE identified with low mobility characteristic. + +If Slice-Specific Authentication and Authorization is triggered by the AMF during a Registration procedure as described in clause 4.2.9.2 of 3GPP TS 23.502 [3], the AMF shall set "status" attribute for the given slice listed in "nssaaStatusList" attribute to "PENDING" (See 3GPP TS 29.518 [16]). + +2. The NSSAAF creates slice authentication context for the UE, and starts the slice-specific authentication and authorization procedure. If the AAA-S is involved in slice-specific authentication and authorization procedure, the NSSAAF shall forward the EAP ID Response message to the AAA-S if the EAP ID Response message does not contain the Null value. Depending on the result, either step 3a or step 3b is performed. The NSSAAF obtains the AAA-S address from local configuration, based on S-NSSAI. +- 3a. On success, "201 Created" shall be returned. The "Location" header shall contain the URI of the created resource (e.g. .../slice-authentications/{authCtxId}). The content shall contain the slice authentication context, which includes the EAP message generated by the NSSAAF or from the AAA-S. The NF Service Consumer (i.e. the AMF) shall forward the received EAP message to the UE in NAS message, as specified in clause 4.2.9.2 of 3GPP TS 23.502 [3]. +- 3b. On failure, one of the HTTP status code listed in Table 6.1.7.3-1 shall be returned. For a 4xx/5xx response, the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.7.3-1. If the slice is not authorized, the NSSAAF shall use the "SLICE\_AUTH\_REJECTED" application error code. +- 3c. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned. A RedirectResponse IE may be included in the content of POST response, as specified in table 6.1.3.2.3.1-3. +4. Once receiving EAP message from the UE, the NF Service Consumer (i.e. the AMF) shall send a PUT request to the NSSAAF, targeting the resource of the slice authentication context (i.e. .../slice-authentications/{authCtxId}). + +The HTTP content shall carry the slice authentication confirmation data which includes: + +- UE ID (i.e. GPSI) +- S-NSSAI +- AAA-S address +- EAP Message (which is received from the UE) + +5. The NSSAAF checks and confirms the slice-specific authentication and authorization. If the AAA-S is involved, the NSSAAF shall forward the EAP Message to the AAA-S to confirm the slice-specific authentication and authorization. Depending on the result, either step 6a or step 6b is performed. +- 6a. On success, "200 OK" shall be returned. The content shall contain the slice authentication confirmation response, which includes the EAP message (e.g. EAP success/failure message) generated by the NSSAAF or from the AAA-S. The NF Service Consumer (i.e. the AMF) shall forward the EAP message to the UE in NAS message. + +If the UE is authenticated, the NSSAAF shall set the "authResult" attribute to "EAP\_SUCCESS". If failed to authenticate the UE, the "authResult" attribute shall be set to "EAP\_FAILURE". + +If subsequent EAP message exchange is needed between the UE and the NSSAAF(AAA-S), the NSSAAF shall not include SliceAuthResult in the response message. + +- 6b. On failure, one of the HTTP status codes listed in Table 6.1.7.3-1 shall be returned. For a 4xx/5xx response, the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.7.3-1. +- 6c. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned. A RedirectResponse IE may be included in the content of POST response, as specified in table 6.1.3.3.3.1-3. + +- 7-9. If subsequent EAP message exchange is needed between the UE and the NSSAAF to finish the EAP based authentication, step 7-9 are performed. On failure, one of the HTTP status codes listed in Table 6.1.7.3-1 shall be returned. For a 4xx/5xx response, the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.7.3-1. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned, and a RedirectResponse IE may be included in the message body, as specified in table 6.1.3.3.1-3. + +In above steps, if the AAA-S is involved in the slice-specific authentication and authorization procedure while there is no expected response from the AAA-S in the case of time out, the NSSAAF shall return HTTP status code "504 Gateway Timeout", with the message body containing a ProblemDetails structure with the "cause" attribute set to "TIMED\_OUT\_REQUEST". + +After the completion of slice-specific authentication and authorization procedure, it is up to implementation whether the NSSAAF stores the slice authentication context and related resources for a configured period, or deletes the context and resource immediately, e.g. depending on the potential need for AAA-S initiated slice-specific re-authentication/revocation notification. + +If the slice-specific authentication and authorization was successful (i.e. "authResult" attribute received from NSSAAF in step 6a is set to "EAP\_SUCCESS"), the AMF shall set "status" attribute for the given slice listed in "nssaaStatusList" attribute to "EAP\_SUCCESS" (see 3GPP TS 29.518 [16]). + +If the slice-specific authentication and authorization finally fails (i.e. "authResult" attribute received from NSSAAF in step 6a is set to "EAP\_FAILURE"), the AMF shall set "status" attribute for the given slice listed in "nssaaStatusList" attribute to "EAP\_FAILURE" (see 3GPP TS 29.518 [16]). In this case, if there are PDU sessions previously established corresponding to the S-NSSAIs required to be authenticated, the AMF should additionally trigger the release of those PDU sessions. + +If the slice-specific authentication and authorization cannot be completed, then: + +- If it is due to receiving a response with HTTP status code "504 Gateway Timeout" or due to lack of response from the NSSAAF during an NSSAA procedure, the AMF may later re-initiate slice-specific authentication and authorization procedure based on its policy. The AMF should wait for a configured period before re-initiating slice-specific authentication and authorization procedure. If the retry attempts are exhausted, the AMF stops the slice-specific authentication and authorization procedure. + +NOTE 1: It is recommended to limit the number of retry attempts as described in 3GPP TS 29.500 [4]. + +- If it is due to the UE becoming unreachable during an NSSAA procedure, the AMF stops the slice-specific authentication and authorization procedure. +- If the AMF stops the slice-specific authentication and authorization procedure (i.e. after exhausting the retry attempts or when the UE becomes unreachable), the AMF shall keep the "status" attribute set to "PENDING", for the given slice(s) listed in "nssaaStatusList" attribute (see 3GPP TS 29.518 [16]). + +NOTE 2: The AMF initiates the slice-specific authentication and authorization for S-NSSAIs in "PENDING" status at next UE uplink activity. + +If an S-NSSAI subject to the NSSAA is rejected due to Network Slice Admission Control as the total number of UEs exceeds the maximum number of UEs allowed to be registered to this slice as specified in clause 5.2.2.2.2 of 3GPP TS 29.536 [17]), the AMF shall keep the "status" attribute stored as not impacted (see clause 4.2.9.1 of 3GPP TS 23.502 [3] and 3GPP TS 29.518 [16]). + +#### 5.2.2.3 Re-Authentication Notification + +##### 5.2.2.3.1 General + +The Re-Authentication Notification service operation shall be used by the NSSAAF to notify the AMF to re-initiate slice-specific authentication and authorization for a given UE, as specified in clause 4.2.9.3 of 3GPP TS 23.502 [3], and clause 16.4 of 3GPP TS 33.501 [8]. + +If there are two different AMFs serving the UE (e.g. the NSSAAF retrieves two different AMFs from the UDM), the NSSAAF may determine to send the re-authentication notification to both AMFs. Or, the NSSAAF may first send re-authentication notification to one of the AMF, and then send revocation notification to another AMF if EAP authentication fails in first AMF. If EAP authentication succeeds in first AMF then NSSAAF does not notify the other AMF. + +Upon receiving the Network Slice-Specific Re-authentication and Re-authorization from an AAA-S, the NSSAAF shall verify whether the AAA-S is authorized to request the procedure, by checking its local configuration. If the AAA-S is authorized to request the re-authentication, the NSSAAF shall notify the NF Service Consumer (i.e. the AMF) by using the HTTP POST method as shown in Figure 5.2.2.3.1-1. + +![Sequence diagram showing the Re-authentication Notification process between an NF Service Consumer and an NSSAAF. The NSSAAF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with one of three possible status codes: 2a. 204 No Content, 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse).](bd671b21db63e6fdb2196e9b18502aac_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSAAF + Note right of NSSAAF: 1. POST {reauthNotifUri} (SliceAuthReauthNotification) + NSSAAF->>NF Service Consumer: + Note left of NF Service Consumer: -2a. 204 No Content + NF Service Consumer-->>NSSAAF: + Note left of NF Service Consumer: -2b. 4xx/5xx (ProblemDetails) + NF Service Consumer-->>NSSAAF: + Note left of NF Service Consumer: -2c. 3xx (RedirectResponse) + NF Service Consumer-->>NSSAAF: + +``` + +Sequence diagram showing the Re-authentication Notification process between an NF Service Consumer and an NSSAAF. The NSSAAF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with one of three possible status codes: 2a. 204 No Content, 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse). + +**Figure 5.2.2.3.1-1: Re-authentication Notification** + +1. The NSSAAF shall send a POST request to the callback URI used to receiving re-authentication notification, which is either provided by the NF Service Consumer (i.e. the AMF), or retrieved from the AMF profile stored in the NRF (in default notification subscription for "NSSAA\_REAUTH\_NOTIFICATION" notification type). If the NF Service Consumer is located in a different PLMN (i.e. the AMF in VPLMN for a roaming UE), the NSSAAF shall use the inter-PLMN callback URI to deliver the notification if the inter-PLMN callback URI is present in the default notification subscription. + +The content of the POST request shall contain the SliceAuthReauthNotification data structure, within which: + +- the notificationType set to the SliceAuthNotificationType of "SLICE\_RE\_AUTH"; +- the gpsi set to the GPSI of the given UE required to be re-authenticated; +- the snssai set to the S-NSSAI required to be re-authenticated; +- the supi set to the SUPI of the given UE required to be re-authenticated. + +NOTE: The NSSAAF can obtain the SUPI of the UE in the response of a previous Nudm\_UECM\_Get used by the NSSAAF to retrieve the AMF ID. + +- 2a. On success, "204 No Content" shall be returned and the content of the POST response shall be empty. + +After responding the request, the NF Service Consumer (i.e. the AMF) shall send NAS message to the UE to trigger re-authentication and re-authorization for the given slice. + +The AMF then decides to execute the Slice-Specific Authentication and Authorization if needed as described in clause 5.2.2.2.1. + +If the S-NSSAI is not in the Mapping Of Allowed NSSAI, the AMF removes any status of the corresponding S-NSSAI subject to Slice-Specific Authentication and Authorization in the UE context it may have kept, so that an Slice-Specific Authentication and Authorization procedure is executed next time the UE requests to register with the S-NSSAI. + +- 2b. On failure, one of the HTTP status code (e.g. "404 Not Found") listed in Table 6.1.7.3-1 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 error listed in Table 6.1.7.3-1. + +- 2c. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned. A RedirectResponse IE may be included in the POST response, as specified in table 6.1.5.2.3.1-2. + +If the NF Service Consumer (i.e. the AMF) is not able to handle the request, but knows that another NF Service Consumer (i.e. the AMF) is able to handle it, it shall reply with an HTTP 3xx redirect response pointing to the URI of the new NF Service Consumer (i.e. the AMF). + +#### 5.2.2.4 Revocation Notification + +##### 5.2.2.4.1 General + +The Revocation Notification service operation shall be used by the NSSAAF to notify the AMF to revoke slice-specific authentication and authorization result, as specified in clause 4.2.9.4 of 3GPP TS 23.502 [3], and clause 16.5 of 3GPP TS 33.501 [8], and may trigger the AMF to release the corresponding PDU sessions associated to the indicated slice. + +If there are two different AMFs serving the UE (e.g. the NSSAAF retrieves two different AMFs from the UDM), the NSSAAF may determine to send revocation notification to both AMFs. + +Upon receiving the Network Slice-Specific Authorization Revocation procedure from an AAA-S, the NSSAAF shall verify whether the AAA-S is authorized to request the procedure, by checking its local configuration. If the AAA-S is authorized to request the revocation, the NSSAAF shall notify the NF Service Consumer (i.e. the AMF) by using the HTTP POST method as shown in Figure 5.2.2.4.1-1. + +![Sequence diagram showing the Revocation Notification process between an NF Service Consumer and an NSSAAF. The NSSAAF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content, 2b. 4xx/5xx (ProblemDetails) or 3xx, or 2c. 3xx (RedirectResponse).](c67d21fb3d9042e88cdc669f071b4e7c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSAAF + Note left of NF Service Consumer: NF Service Consumer + Note right of NSSAAF: NSSAAF + NSSAAF->>NF Service Consumer: 1. POST {revocNotifUri} (SliceAuthRevocNotification) + NF Service Consumer-->>NSSAAF: 2a. 204 No Content + NF Service Consumer-->>NSSAAF: 2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>NSSAAF: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the Revocation Notification process between an NF Service Consumer and an NSSAAF. The NSSAAF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content, 2b. 4xx/5xx (ProblemDetails) or 3xx, or 2c. 3xx (RedirectResponse). + +Figure 5.2.2.4.1-1: Revocation Notification + +- The NSSAAF shall send a POST request to the revocation notification callback URI, which is either provided by the NF Service Consumer (i.e. the AMF), or retrieved from the AMF profile stored in the NRF (in default notification subscription for "NSSAA\_REVOC\_NOTIFICATION" notification type). If the NF Service Consumer is located in a different PLMN (i.e. the AMF in VPLMN for a roaming UE), the NSSAAF shall use the inter-PLMN callback URI to deliver the notification if the inter-PLMN callback URI is present in the default notification subscription. + +The content of the POST request shall contain the SliceAuthRevocNotification data structure, within which: + +- the notificationType set to the SliceAuthNotificationType of "SLICE\_REVOCATION"; +- the gpsi set to the GPSI of the given UE for whom the slice-specific authorization revocation is required; +- the snssai set to the S-NSSAI for which the slice-specific authorization revocation is required; +- the supi set to the SUPI of the given UE for whom the slice-specific authorization revocation is required. + +NOTE: The NSSAAF can obtain the SUPI of the UE in the response of a previous Nudm\_UECM\_Get used by the NSSAAF to retrieve the AMF ID. + +- On success, "204 No Content" shall be returned and the content of the POST response shall be empty. + +On receiving the request, the NF Service Consumer (i.e. the AMF) shall revoke the slice-specific authentication and authorization result for the given UE. If there is PDU session associated to the given slice, the AMF shall trigger the PDU session release to the SMF, with appropriate cause value. + +The AMF shall remove the "status" for the given slice in "nssaaStatusList" attribute (see 3GPP TS 29.518 [16]). + +- On failure, one of the HTTP status code (e.g. "404 Not Found") listed in Table 6.1.7.3-1 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 error listed in Table 6.1.7.3-1. + +- 2c. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned. A RedirectResponse IE may be included in the content of POST response, as specified in table 6.1.5.3.3.1-2. + +If the NF Service Consumer (i.e. the AMF) is not able to handle the request, but knows that another NF Service Consumer (i.e. the AMF) is able to handle it, it shall reply with an HTTP 307/308 redirect response pointing to the URI of the new NF Service Consumer (i.e. the AMF). + +## 5.3 Nnssaaaf\_AIW Service + +### 5.3.1 Service Description + +The Nnssaaaf\_AIW service provides primary Authentication and Authorization service to the consumer NF (AUSF) by relaying EAP or EAP-TTLS inner method messages towards an AAA Server and performing related protocol conversion as needed. The NSSAAF is acting as NF Service Producer, while the AUSF is the NF Service Consumer. + +Following functionalities are provided by the Nnssaaaf\_AIW service: + +- Perform primary authentication and authorization for a given UE towards an AAA Server. + +The Nnssaaaf\_AIW service supports the following service operations. + +**Table 5.3.1-1: Service operations supported by the Nnssaaaf\_AIW service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|----------------------------------------------------------------------------------------|---------------------|---------------------| +| Authenticate | Perform primary authentication and authorization for a given UE towards an AAA Server. | Request/Response | AUSF | + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +See Table 5.3.1-1 for an overview of the service operations supported by the Nnssaaaf\_AIW service. + +#### 5.3.2.2 Authenticate + +##### 5.3.2.2.1 General + +The Authenticate service operation permits the NF Service Consumer (i.e., the AUSF) to perform authentication and authorization for a given UE towards an AAA Server. + +The NF Service Consumer (i.e., the AUSF) shall send a POST request to the resource representing authentication collection (i.e., .../authentications) to request the NSSAAF to create the corresponding resource context and perform primary authentication and authorization. + +![Sequence diagram showing AAA Interworking Authentication and Authorization between NF Service Consumer and NSSAAF. The diagram includes 9 steps: 1. POST .../authentications (AuthInfo) from Consumer to NSSAAF; 2. Forward EAP ID to AAA-S (dashed box); 3a. 201 Created (AuthContext) and 3b. 4xx/5xx (ProblemDetails) from NSSAAF to Consumer; 4. PUT .../authentications/{authCtxId}/confirmation (AuthConfirmationData) from Consumer to NSSAAF; 5. Forward EAP message to AAA-S (dashed box); 6a. 200 OK (AuthConfirmationResponse) and 6b. 4xx/5xx (ProblemDetails) or 3xx from NSSAAF to Consumer; 7. PUT .../authentications/{authCtxId}/confirmation (AuthConfirmationData) from Consumer to NSSAAF; 8. Forward EAP message to AAA-S (dashed box); 9a. 200 OK (AuthConfirmationResponse) and 9b. 4xx/5xx (ProblemDetails) or 3xx from NSSAAF to Consumer.](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer + participant NSSAAF + Note right of NSSAAF: 2. Forward EAP ID to AAA-S + Consumer->>NSSAAF: 1. POST .../authentications (AuthInfo) + NSSAAF-->>Consumer: 3a. 201 Created (AuthContext) + Note right of NSSAAF: 5. Forward EAP message to AAA-S + NSSAAF-->>Consumer: 3b. 4xx/5xx (ProblemDetails) + Consumer->>NSSAAF: 4. PUT .../authentications/{authCtxId}/confirmation (AuthConfirmationData) + Note right of NSSAAF: 8. Forward EAP message to AAA-S + NSSAAF-->>Consumer: 6a. 200 OK (AuthConfirmationResponse) + Consumer->>NSSAAF: 7. PUT .../authentications/{authCtxId}/confirmation (AuthConfirmationData) + NSSAAF-->>Consumer: 6b. 4xx/5xx (ProblemDetails) or 3xx + NSSAAF-->>Consumer: 9a. 200 OK (AuthConfirmationResponse) + NSSAAF-->>Consumer: 9b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing AAA Interworking Authentication and Authorization between NF Service Consumer and NSSAAF. The diagram includes 9 steps: 1. POST .../authentications (AuthInfo) from Consumer to NSSAAF; 2. Forward EAP ID to AAA-S (dashed box); 3a. 201 Created (AuthContext) and 3b. 4xx/5xx (ProblemDetails) from NSSAAF to Consumer; 4. PUT .../authentications/{authCtxId}/confirmation (AuthConfirmationData) from Consumer to NSSAAF; 5. Forward EAP message to AAA-S (dashed box); 6a. 200 OK (AuthConfirmationResponse) and 6b. 4xx/5xx (ProblemDetails) or 3xx from NSSAAF to Consumer; 7. PUT .../authentications/{authCtxId}/confirmation (AuthConfirmationData) from Consumer to NSSAAF; 8. Forward EAP message to AAA-S (dashed box); 9a. 200 OK (AuthConfirmationResponse) and 9b. 4xx/5xx (ProblemDetails) or 3xx from NSSAAF to Consumer. + +**Figure 5.3.2.2.1-1: AAA Interworking Authentication and Authorization** + +- The NF Service Consumer (AUSF) shall send a POST request (AuthInfo) to the NSSAAF, targeting the resource of authentication collection (i.e. .../authentications), to perform authentication and authorization. + +The payload of the body shall contain the authentication information, which may include: + +- UE ID (i.e. SUPI) + - EAP-ID Response message + - EAP-TTLS Inner Method Container +- The NSSAAF creates an authentication context for the UE and starts the authentication and authorization procedure. The NSSAAF shall send an authentication request message to the AAA-S. Depending on the result, either step 3a or step 3b is performed. The NSSAAF obtains the AAA-S address from local configuration. + - On success, "201 Created" shall be returned (AuthContext). The "Location" header shall contain the URI of the created resource (e.g. .../authentications/{authCtxId}). The payload body shall contain the authentication context, which includes the EAP message generated by the AAA-S. + - On failure, one of the HTTP status code listed in Table 6.2.7.3-1 shall be returned with the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.7.3-1. + +4. Once receiving EAP message from the UE, the NF Service Consumer (i.e., the AUSF) shall send a PUT request (AuthConfirmationData) to the NSSAAF, targeting the resource of the authentication context (i.e. .../authentications/{authCtxId}). + +The payload body shall carry the authentication confirmation data which includes: + +- UE ID (i.e., SUPI) + - EAP Message (which is received from the UE) +5. The NSSAAF shall forward the EAP Message to the AAA-S to confirm the authentication and authorization. Depending on the result, either step 6a or step 6b is performed. + - 6a. On success, "200 OK" shall be returned (AuthConfirmationResponse). The payload body shall contain the authentication confirmation response, which includes the EAP message (e.g., EAP success/failure message) generated by the AAA-S. + +If the UE is authenticated, the NSSAAF shall set the "authResult" attribute to "EAP\_SUCCESS"; the response message shall contain the MSK received from the AAA-S and may contain the address of the SNPN UE onboarding Provisioning Servers (PVS). + +If failed to authenticate the UE, the "authResult" attribute shall be set to "EAP\_FAILURE". + +If subsequent EAP message exchange is needed between the UE and the NSSAAF (AAA-S), the NSSAAF shall not include AuthResult in the response message. + +- 6b. On failure or redirection, one of the HTTP status codes listed in Table 6.2.7.3-1 shall be returned with the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.7.3-1. +- 7-9. If subsequent EAP message exchange is needed between the UE and the NSSAAF to finish the EAP based authentication, steps 7-9 are performed. On failure or redirection, one of the HTTP status codes listed in Table 6.2.7.3-1 shall be returned with the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.7.3-1. + +In above steps, if there is no expected response from the AAA-S in the case of time out, the NSSAAF shall return HTTP status code "504 Gateway Timeout", with the message body containing a ProblemDetails structure with the "cause" attribute set to "TIMED\_OUT\_REQUEST". + +# --- 6 API Definitions + +## 6.1 Nnssaaf\_NSSAA Service API + +### 6.1.1 Introduction + +The Nnssaaf\_NSSAA service shall use the Nnssaaf\_NSSAA API. + +The API URI of the Nnssaaf\_NSSAA API shall be: + +**{apiRoot}/** + +The request URIs used in HTTP request 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.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nnssaaf-nssaa". + +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nnssaaaf\_NSSAA API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +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". + +"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]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +The structure of the Resource URIs of the Nnssaaaf\_NSSAA service is shown in Figure 6.1.3.1-1 + +![Diagram showing the Resource URI structure of the NSSAA API. The root URI is ///nnssaaaf-nssaa/. It branches to /slice-authentications, which further branches to //.](262a3a1913ff07a5129940d6903b53f1_img.jpg) + +``` +graph TD; Root["///nnssaaaf-nssaa/"] --- SliceAuth["/slice-authentications"]; SliceAuth --- AuthCtxId["//"]; +``` + +Diagram showing the Resource URI structure of the NSSAA API. The root URI is ///nnssaaaf-nssaa/. It branches to /slice-authentications, which further branches to //. + +**Figure 6.1.3.1-1: Resource URI structure of the NSSAA API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------------|-------------------------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------| +| slice-authentications (Collection) | //slice-authentications | POST | Initiate the slice-specific authentication and authorization process by providing inputs related to the UE and a specific slice. | +| slice-authentication (Document) | //slice-authentications/{authCtxId} | PUT | Put the UE response from the EAP process. | + +#### 6.1.3.2 Resource: slice-authentications (Collection) + +##### 6.1.3.2.1 Description + +This resource represents a collection of the slice-authentication resources generated by the NSSAAF. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnsaaf-nssaa //slice-authentications + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +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. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-------------------------------------------------------------------| +| SliceAuthInfo | M | 1 | Contains the GPSI, S-NSSAI, and EAP ID Response from the UE, etc. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SliceAuthContext | M | 1 | 201 Created | This case indicates the corresponding resource has been created by the NSSAAF for the requested slice-specific authentication and authorization, and further EAP process is required.
The HTTP response shall include a "Location" header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | This case represents the failure to start slice-specific authentication and authorization because of input parameter error. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents when the UE or the slice is not allowed to be authenticated.
The "cause" attribute may be used to indicate one of the following application errors:
- SLICE_AUTH_REJECTED | +| ProblemDetails | O | 0..1 | 404 Not Found | This case represents the user or user context is not found.
The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 504 Gateway Time out | This case represents network error or remote peer (i.e. AAA-S) error, e.g. not reachable, no response and time out.
The "cause" attribute may be used to indicate one of the following application errors:
- NETWORK_FAILURE
- UPSTREAM_SERVER_ERROR
- TIME_OUT_REQUEST | + +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. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.3.1-4: Headers supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +**Table 6.1.3.2.3.1-5: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------| +| Location | URI | M | 1 | URI of created resource for the slice authentication context.
The URI structure is defined in clause 6.1.3.3.1. | + +**Table 6.1.3.2.3.1-6: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request should be sent.
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]. | + +**Table 6.1.3.2.3.1-7: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request should be sent.
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]. | + +##### 6.1.3.2.4 Resource Custom Operations + +There is no Resource Custom Operations in the current version of this API. + +#### 6.1.3.3 Resource: slice-authentication (Document) + +##### 6.1.3.3.1 Description + +The sub-resource "slice-authentication" is generated by the NSSAAF. This subresource should not persist after the slice-specific authentication and authorization process finishes. + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nssaaaf-nssaa//slice-authentications/{authCtxId} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|--------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1 | +| authCtxId | string | The slice authentication context ID, which is of data type SliceAuthCtxId defined in clause 6.1.6.3.2. | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +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. + +**Table 6.1.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|-----------------------------------------------------------------------| +| SliceAuthConfirmationData | M | 1 | Contains the EAP message generated by the UE and provided to the AMF. | + +Table 6.1.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SliceAuthConfirmationResponse | M | 1 | 200 OK | This case indicates that the NSSAAF has performed the slice-specific authentication. The response body shall contain the result of the slice-specific authentication and authorization. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | This case represents a slice-specific authentication failure because of input parameter error. This indicates that the NSSAAF was not able to process the slice-specific authentication. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents when the UE or the slice is not allowed to be authenticated.
The "cause" attribute may be used to indicate one of the following application errors:
- SLICE_AUTH_REJECTED | +| ProblemDetails | O | 0..1 | 404 Not Found | This case represents the UE or UE related context is not found.
The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 504 Gateway Time out | This case represents network error or remote peer (i.e. AAA-S) error, e.g. not reachable, no response when time out.
The "cause" attribute may be used to indicate one of the following application errors:
- NETWORK_FAILURE
- UPSTREAM_SERVER_ERROR
- TIMED_OUT_REQUEST | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +Table 6.1.3.3.3.1-4: Headers supported by the PUT method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Table 6.1.3.3.3.1-5: Headers supported by the 200 response code on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Table 6.1.3.3.3.1-6: Headers supported by the 307 Response Code on this endpoint + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request should be sent.
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]. | + +**Table 6.1.3.3.3.1-7: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request should be sent.
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]. | + +##### 6.1.3.3.4 Resource Custom Operations + +There is no Resource Custom Operations in the current version of this API. + +### 6.1.4 Custom Operations without associated resources + +#### 6.1.4.1 Overview + +There is no Custom Operation in the current version of this API. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------|-----------------------------------------------------------------------|---------------------------------|---------------------------------| +| Re-authentication Notification | {reauthNotifUri}
(NF Service Consumer provided callback reference) | POST | Re-authentication Notification | +| Revocation Notification | {revocNotifUri}
(NF Service Consumer provided callback reference) | POST | Revocation Notification | + +#### 6.1.5.2 Re-authentication Notification + +##### 6.1.5.2.1 Description + +The Re-authentication Notification is used by the NSSAAF to trigger the NF Service Consumer (i.e. the AMF) to re-initiate slice-specific authentication and authorization for a given UE. + +##### 6.1.5.2.2 Target URI + +The Notification URI "{reauthNotifUri}" shall be used with the resource URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|-------------------------------------------------------------------------------| +| reauthNotifUri | String formatted as URI which carries the re-authentication notification URI. | + +##### 6.1.5.2.3 Standard Methods + +###### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-2. + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------| +| SliceAuthReauthNotification | M | 1 | SliceAuthReauthNotification which carries the re-authentication notification for a given UE. | + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------| +| n/a | | | 204 No Content | Successful notification of the re-authentication. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. 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]. | + +**Table 6.1.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. 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]. | + +#### 6.1.5.3 Revocation Notification + +##### 6.1.5.3.1 Description + +The Revocation Notification is used by the NSSAAF to trigger the NF Service Consumer (i.e. the AMF) to revoke the slice-specific authentication and authorization result for a given UE. + +##### 6.1.5.3.2 Target URI + +The Notification URI "{revocNotifUri}" shall be used with the resource URI variables defined in table 6.1.5.3.2-1. + +**Table 6.1.5.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------------|------------------------------------------------------------------------| +| revocNotifUri | String formatted as URI which carries the revocation notification URI. | + +##### 6.1.5.3.3 Standard Methods + +###### 6.1.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.3.3.1-1 and the response data structures and response codes specified in table 6.1.5.3.3.1-2. + +**Table 6.1.5.3.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|--------------------------------------------------------------------------------------| +| SliceAuthRevocNotification | M | 1 | SliceAuthRevocNotification which carries the revocation notification for a given UE. | + +**Table 6.1.5.3.3.1-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------| +| n/a | | | 204 No Content | Successful notification of the revocation. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. 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]. | + +**Table 6.1.5.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. 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]. | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nnssaaaf service based interface protocol. + +**Table 6.1.6.1-1: Nnssaaaf specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------------|----------------|-------------------------------------------------------------------------------------------------------|---------------| +| SliceAuthInfo | 6.1.6.2.2 | Contains the GPSI, S-NSSAI, EAP ID Response, etc. | | +| SliceAuthContext | 6.1.6.2.3 | Contains the information of the resource created for slice-specific authentication and authorization. | | +| SliceAuthConfirmationData | 6.1.6.2.4 | Contains the EAP message from the UE for EAP process. | | +| SliceAuthConfirmationResponse | 6.1.6.2.5 | Contains the slice-specific authentication and authorization result from the NSSAAF to the UE. | | +| SliceAuthReauthNotification | 6.1.6.2.6 | Contains the re-authentication notification for slice-specific authentication and authorization. | | +| SliceAuthRevocNotification | 6.1.6.2.7 | Contains the revocation notification for slice-specific authentication and authorization. | | +| SliceAuthCtxId | 6.1.6.3.2 | Contains the resource ID of slice authentication context. | | +| EapMessage | 6.1.6.3.2 | Contains the string formatted EAP message. | | +| SliceNotificationType | 6.1.6.3.3 | Notification type of slice-specification authentication and authorization. | | + +Table 6.1.6.1-2 specifies data types re-used by the Nnssaaaf 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 Nnssaaaf service based interface. + +**Table 6.1.6.1-2: Nnssaaaf re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------|---------------------|------------------------------------------|---------------| +| ProblemDetails | 3GPP TS 29.571 [16] | Common Data Type used in response bodies | | +| RedirectResponse | 3GPP TS 29.571 [16] | Redirect Response | | +| Gpsi | 3GPP TS 29.571 [16] | GPSI | | +| Snssai | 3GPP TS 29.571 [16] | S-NSSAI | | +| AuthStatus | 3GPP TS 29.571 [16] | Slice Authentication Status | | +| Supi | 3GPP TS 29.571 [16] | SUPI of the UE | | + +#### 6.1.6.2 Structured data types + +The following clause defines the structures to be used in resource representations. + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: SliceAuthInfo + +Table 6.1.6.2.2-1: Definition of type SliceAuthInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| eapIdRsp | EapMessage | M | 1 | Contains the EAP ID Responses message from the UE.
If no EAP ID Responses message is received or requested, it shall contain the Null value. | | +| amfInstanceId | NfInstanceId | O | 0..1 | This IE may be present, if the AMF determines to provide the re-authentication/revocation notification URI to the NSSAAF.
When present, it shall contain the NF Instance Id of the AMF. | | +| reauthNotifUri | Uri | O | 0..1 | This IE may be present, e.g. if the AMF determines the UE with low mobility characteristic.
When present, it shall contain the re-authentication notification URI. | | +| revocNotifUri | Uri | O | 0..1 | This IE may be present, e.g. if the AMF determines the UE with low mobility characteristic.
When present, it shall contain the revocation notification URI. | | + +##### 6.1.6.2.3 Type: SliceAuthContext + +Table 6.1.6.2.3-1: Definition of type SliceAuthContext + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-----------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| authCtxId | SliceAuthCtxId | M | 1 | Indicates the resource ID uniquely identifying the slice authentication context, generated by the NSSAAF. | | +| eapMessage | EapMessage | M | 1 | Contains the EAP message to be sent to the UE. | | + +##### 6.1.6.2.4 Type: SliceAuthConfirmationData + +Table 6.1.6.2.4-1: Definition of type SliceAuthConfirmationData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| eapMessage | EapMessage | M | 1 | Contains the EAP message received from the UE. | | + +##### 6.1.6.2.5 Type: SliceAuthConfirmationResponse + +Table 6.1.6.2.5-1: Definition of type SliceAuthConfirmationResponse + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|------------------------------------------------------------------------------------------------|---------------| +| gps | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| eapMessage | EapMessage | M | 1 | Contains the EAP success/failure message needs to be sent to the UE. | | +| authResult | AuthStatus | O | 0..1 | When present, it shall indicate the result of slice-specific authentication and authorization. | | + +##### 6.1.6.2.6 Type: SliceAuthReauthNotification + +Table 6.1.6.2.6-1: Definition of type SliceAuthReauthNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------|---|-------------|----------------------------------------------------------------|---------------| +| notificationType | SliceAuthNotificationType | M | 1 | Indicate the type of slice authentication notification. | | +| gps | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| supi | Supi | C | 0..1 | This IE should be sent by the NSSAAF to the AMF, if available. | | + +##### 6.1.6.2.7 Type: SliceAuthRevocNotification + +Table 6.1.6.2.7-1: Definition of type SliceAuthRevocNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------|---|-------------|----------------------------------------------------------------|---------------| +| notificationType | SliceAuthNotificationType | M | 1 | Indicate the type of slice authentication notification. | | +| gps | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| supi | Supi | C | 0..1 | This IE should be sent by the NSSAAF to the AMF, if available. | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +Table 6.1.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|----------------|-----------------|--------------------------------------------------------------------------------------------------------------|---------------| +| SliceAuthCtxId | string | The resource ID uniquely identifying the slice authentication context, generated by the NSSAAF. | | +| EapMessage | string | The EAP packet is encoded using base64 (see IETF RFC 4648 [14]) and represented as a String.
Format: byte | | + +##### 6.1.6.3.3 Enumeration: SliceAuthNotificationType + +The enumeration SliceAuthNotificationType represents the notification type of slice-specific authentication and authorization. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration SliceAuthNotificationType** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------------------------------------|---------------| +| SLICE_RE_AUTH | This value is used to indicate the re-authentication is needed | | +| SLICE_REVOCATION | This value is used to indicate the previous slice-specific authentication and authorization shall be revoked. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +There is no alternative data types defined in this specification. + +#### 6.1.6.5 Binary data + +There is no binary data type defined in this specification. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nnssaaaf\_NSSAA 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]. + +In addition, the requirements in the following clauses are applicable for the Nnssaaaf\_NSSAA API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nnssaaaf\_NSSAA service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nnssaaaf\_NSSAA service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RESOURCE_TEMP_MOVED | 307 Temporary Redirect | Indicates that the NSSAAF is not able to handle the request, but points to the URI of another NSSAAF. | +| RESOURCE_MOVED | 308 Permanent Redirect | Indicates that the NSSAAF is not able to handle the request, but points to the URI of another NSSAAF. | +| SLICE_AUTH_REJECTED | 403 Forbidden | The user cannot be authenticated, e.g. authentication request rejected by the AAA-S. | +| CONTEXT_NOT_FOUND | 404 Not Found | The NSSAAF cannot find the resource corresponding to the URI provided by the NF Service Consumer, i.e. the resource identified by the authCtxId does not exist in the NSSAAF. | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN. | +| UPSTREAM_SERVER_ERROR | 504 Gateway Timeout | Error happens in reaching the remote peer (i.e. the AAA-S). | +| NETWORK_FAILURE | 504 Gateway Timeout | The request is rejected due to a network problem. | +| TIMED_OUT_REQUEST | 504 Gateway Timeout | No response is received from the remote peer (i.e. the AAA-S) when time out. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nnssaaaf\_NSSAA API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +Table 6.1.8-1: Supported Features + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nnssaaf\_NSSAA 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. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnssaaf\_NSSAA 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. + +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 Nnssaaf\_NSSAA service. + +The Nnssaaf\_NSSAA API defines a single scope "nnssaaf-nssaa" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different NSSAAF service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different NSSAAF producer instance will return the NF Instance ID of the new NSSAAF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an NSSAAF redirects a service request to a different NSSAAF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new NSSAAF 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]. + +## 6.2 Nnssaaf\_AIW Service API + +### 6.2.1 Introduction + +The Nnssaaf\_AIW service shall use the Nnssaaf\_AIW API. + +The API URI of the Nnssaaf\_AIW API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP request 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.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nnssaaf-aiw". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nnssaaaf\_AIW API is contained in Annex A. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.2.2.2.2 Content type + +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". + +"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]. + +#### 6.2.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +The structure of the Resource URIs of the Nnssaaaf\_AIW service is shown in Figure 6.2.3.1-1 + +![Diagram showing the Resource URI structure of the AIW API. The root URI is {apiRoot}/nnssaaaf-aiw/. A line branches down to a box containing /authentications. From this box, another line branches down to a box containing /{authCtxId}.](a04d24ddad7620a923d3895a834d71a8_img.jpg) + +``` +graph TD; Root["{apiRoot}/nnssaaaf-aiw/"] --> Auth["/authentications"]; Auth --> AuthCtxId["/{authCtxId}"]; +``` + +Diagram showing the Resource URI structure of the AIW API. The root URI is {apiRoot}/nnssaaaf-aiw/. A line branches down to a box containing /authentications. From this box, another line branches down to a box containing /{authCtxId}. + +**Figure 6.2.3.1-1: Resource URI structure of the AIW API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------|------------------------------|---------------------------------|----------------------------------------------------------------------------------------------| +| authentications (Collection) | /authentications | POST | Initiate the authentication and authorization process by providing inputs related to the UE. | +| authentication (Document) | /authentications/{authCtxId} | PUT | Put the UE response from the EAP process. | + +#### 6.2.3.2 Resource: authentications (Collection) + +##### 6.2.3.2.1 Description + +This resource represents a collection of the authentication resources generated by the NSSAAF. + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nssaaaf-aiw//authentications + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|------------------| +| apiRoot | string | See clause 6.2.1 | +| apiVersion | string | See clause 6.2.1 | + +##### 6.2.3.2.3 Resource Standard Methods + +###### 6.2.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|------------------------------------------------------| +| AuthInfo | M | 1 | Contains the SUPI, EAP ID Response from the UE, etc. | + +Table 6.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthContext | M | 1 | 201 Created | This case indicates the corresponding resource has been created by the NSSAAF for the requested authentication and authorization, and further EAP process is required. The HTTP response shall include a "Location" header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | This case represents the failure to start authentication and authorization because of input parameter error. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents when the UE is not allowed to be authenticated. | +| ProblemDetails | O | 0..1 | 404 Not Found | This case represents the user or user context is not found. The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 504 Gateway Time out | This case represents network error or remote peer (i.e. AAA-S) error, e.g. not reachable, no response and time out. The "cause" attribute may be used to indicate one of the following application errors:
- NETWORK_FAILURE
- UPSTREAM_SERVER_ERROR
- TIME_OUT_REQUEST | + +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. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +Table 6.2.3.2.3.1-4: Headers supported by the POST method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Table 6.2.3.2.3.1-5: Headers supported by the 201 response code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| Location | URI | M | 1 | URI of created resource for the authentication context. The URI structure is defined in clause 6.2.3.3.1. | + +Table 6.2.3.2.3.1-6: Headers supported by the 307 Response Code on this endpoint + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request should be sent. 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]. | + +**Table 6.2.3.2.3.1-7: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request should be sent.
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]. | + +#### 6.2.3.3 Resource: authentication (Document) + +##### 6.2.3.3.1 Description + +The sub-resource "authentication" is generated by the NSSAAF. This subresource should not persist after the authentication and authorization process finishes. + +##### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nnssaaf-aiw//authentications/{authCtxId} + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|---------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| apiVersion | string | See clause 6.2.1 | +| authCtxId | string | The authentication context ID, which is of data type AuthCtxId defined in clause 6.2.6.3.2. | + +##### 6.2.3.3.3 Resource Standard Methods + +###### 6.2.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.2.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|------------------------------------------------------------------------| +| AuthConfirmation Data | M | 1 | Contains the EAP message generated by the UE and provided to the AUSF. | + +Table 6.2.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthConfirmationResponse | M | 1 | 200 OK | This case indicates that the NSSAAF has performed the authentication. The response body shall contain the result of the authentication and authorization. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | This case represents an authentication failure because of input parameter error. This indicates that the NSSAAF was not able to process the authentication. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents when the UE is not allowed to be authenticated. | +| ProblemDetails | O | 0..1 | 404 Not Found | This case represents the UE or UE related context is not found.
The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 504 Gateway Time out | This case represents network error or remote peer (i.e. AAA-S) error, e.g. not reachable, no response when time out.
The "cause" attribute may be used to indicate one of the following application errors:
- NETWORK_FAILURE
- UPSTREAM_SERVER_ERROR
- TIMED_OUT_REQUEST | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +Table 6.2.3.3.3.1-4: Headers supported by the PUT method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Table 6.2.3.3.3.1-5: Headers supported by the 200 response code on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Table 6.2.3.3.3.1-6: Headers supported by the 307 Response Code on this endpoint + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request should be sent.
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]. | + +Table 6.2.3.3.3.1-7: Headers supported by the 308 Response Code on this endpoint + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request should be sent.
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]. | + +### 6.2.4 Custom Operations without associated resources + +There are no Custom Operation in the current version of this API. + +### 6.2.5 Notifications + +There are no Notifications in the current version of this API. + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the NnssAAF service based interface protocol. + +**Table 6.2.6.1-1: NnssAAF\_AIW specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|--------------------------|----------------|----------------------------------------------------------------------------------------|---------------| +| AuthInfo | 6.2.6.2.2 | Contains the SUPI, EAP ID Response, etc. | | +| AuthContext | 6.2.6.2.3 | Contains the information of the resource created for authentication and authorization. | | +| AuthConfirmationData | 6.2.6.2.4 | Contains the EAP message from the UE for EAP process. | | +| AuthConfirmationResponse | 6.2.6.2.5 | Contains the authentication and authorization result from the NSSAAF to the UE. | | +| AuthCxtId | 6.2.6.3.2 | Contains the resource ID of authentication context. | | + +Table 6.2.6.1-2 specifies data types re-used by the NnssAAF\_AIW service based interface from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the NnssAAF\_AIW service based interface. + +**Table 6.2.6.1-2: NnssAAF re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|-----------------------------------------------------------------|---------------| +| ProblemDetails | 3GPP TS 29.571 [16] | Common Data Type used in response bodies | | +| RedirectResponse | 3GPP TS 29.571 [16] | Redirect Response | | +| AuthStatus | 3GPP TS 29.571 [16] | Authentication Status | | +| Supi | 3GPP TS 29.571 [16] | SUPI of the UE | | +| SupportedFeatures | 3GPP TS 29.571 [16] | Supported Features | | +| ServerAddressingInfo | 3GPP TS 29.571 [16] | Addressing information (FQDNs and/or IP addresses) of a server. | | +| EapMessage | 3GPP TS 29.526 | See clause 6.1.6.3.2 | | +| Msk | 3GPP TS 29.509 [18] | | | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.2.6.2.2 Type: AuthInfo + +Table 6.2.6.2.2-1: Definition of type AuthInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | Contains the SUPI of the UE. | | +| eapIdRsp | EapMessage | C | 0..1 | Contains the EAP Identity Response message. (NOTE) | | +| ttlsInnerMethodContainer | EapMessage | C | 0..1 | Contains the EAP-TTLS inner method messages. It is included when EAP-TTLS is used, after the initial EAP-TLS exchange. (NOTE) | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.9 is supported. | | + +NOTE: Either eapIdRsp or ttlInnerMethodContainer shall be present, but not both. + +##### 6.2.6.2.3 Type: AuthContext + +Table 6.2.6.2.3-1: Definition of type AuthContext + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | Contains the SUPI of the UE. | | +| authCtxId | AuthCtxId | M | 1 | Indicates the resource ID uniquely identifying the authentication context, generated by the NSSAAF. | | +| eapMessage | EapMessage | C | 0..1 | Contains the EAP message to be sent to the UE. (NOTE) | | +| ttlsInnerMethodContainer | EapMessage | C | 0..1 | Contains the EAP-TTLS inner method messages. It is included when EAP-TTLS is used, after the initial EAP exchange. (NOTE) | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.9 is supported. | | + +NOTE: Either eapIdRsp or ttlInnerMethodContainer shall be present, but not both. + +##### 6.2.6.2.4 Type: AuthConfirmationData + +Table 6.2.6.2.4-1: Definition of type AuthConfirmationData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | Contains the SUPI of the UE. | | +| eapMessage | EapMessage | M | 1 | Contains the EAP message received from the UE. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.9 is supported. | | + +##### 6.2.6.2.5 Type: AuthConfirmationResponse + +Table 6.2.6.2.5-1: Definition of type AuthConfirmationResponse + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | Contains the SUPI of the UE. | | +| eapMessage | EapMessage | M | 1 | Contains the EAP success/failure message needs to be sent to the UE. | | +| authResult | AuthStatus | O | 0..1 | When present, it shall indicate the result of authentication and authorization. | | +| pvsInfo | array(ServerAddressingInfo) | O | 1..N | When present, it shall contain the FQDN(s) and/or IP address(es) of the SNPn UE onboarding Provisioning Servers. | | +| msk | Msk | C | 0..1 | This IE shall be present if MSK is received from AAA-S after successful authentication, as specified in clause I.2.2.2 of 3GPP TS 33.501 [8]. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.9 is supported. | | + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +Table 6.2.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------------------------------------------------------------------------------------|---------------| +| AuthCtxId | string | The resource ID uniquely identifying the authentication context, generated by the NSSAAF. | | + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +For the Nnssaaaf\_AIW 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]. + +In addition, the requirements in the following clauses are applicable for the Nnssaaaf\_AIW API. + +#### 6.2.7.2 Protocol Errors + +No specific procedures for the Nnssaaaf\_AIW service are specified. + +#### 6.2.7.3 Application Errors + +The application errors defined for the Nnssaaaf\_AIW service are listed in Table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RESOURCE_TEMP_MOVED | 307 Temporary Redirect | Indicates that the NSSAAF is not able to handle the request, but points to the URI of another NSSAAF. | +| RESOURCE_MOVED | 308 Permanent Redirect | Indicates that the NSSAAF is not able to handle the request, but points to the URI of another NSSAAF. | +| CONTEXT_NOT_FOUND | 404 Not Found | The NSSAAF cannot find the resource corresponding to the URI provided by the NF Service Consumer, i.e. the resource identified by the authCtxId does not exist in the NSSAAF. | +| USER_NOT_FOUND | 404 Not Found | The user does not exist. | +| UPSTREAM_SERVER_ERROR | 504 Gateway Timeout | Error happens in reaching the remote peer (i.e., the AAA-S). | +| NETWORK_FAILURE | 504 Gateway Timeout | The request is rejected due to a network problem. | +| TIMED_OUT_REQUEST | 504 Gateway Timeout | No response is received from the remote peer (i.e., the AAA-S) when time out. | + +### 6.2.8 Feature negotiation + +The optional features in table 6.2.8-1 are defined for the NnssAAF\_AIW API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the NnssAAF\_AIW 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. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the NnssAAF\_AIW 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. + +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 NnssAAF\_AIW service. + +The NnssAAF\_AIW API defines a single scope "nnssAAF-aiw" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different NSSAAF service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different NSSAAF producer instance will return the NF Instance ID of the new NSSAAF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an NSSAAF redirects a service request to a different NSSAAF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new NSSAAF 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]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +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). + +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. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository hosted, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Nnssaaf\_NSSAA API + +``` +openapi: 3.0.0 + +info: + title: Nnssaaf_NSSAA + version: 1.2.0-alpha.2 + description: | + Network Slice-Specific Authentication and Authorization Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS29.526, NSSAA Service, version 18.3.0. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.526/ + +servers: + - url: '{apiRoot}/nnssaaf-nssaa/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnssaaf-nssaa + +paths: + /slice-authentications: + post: + summary: Create slice authentication context + operationId: CreateSliceAuthenticationContext + tags: + - Slice Authentication Context Creation + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthInfo' + required: true + responses: + '201': + description: SliceAuthContext + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthContext' + headers: + Location: +``` + +``` + + description: 'Contains the URI of the newly created resource according to the +structure: {apiRoot}/nnssaaaf-nssaa//slice-authentications/{authCtxId}' + required: true + schema: + type: string +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + description: Bad Request from the AMF + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + description: Forbidden due to slice authentication rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'404': + description: User does not exist + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +'504': + description: Network error or remote peer error + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +callbacks: + reauthenticationNotification: + '{request.body#/reauthNotifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthReauthNotification' +responses: +'204': + description: slice re-authentication notification response +'307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' +headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' + required: true + schema: + type: string +'308': + description: Permanent Redirect + content: + application/json: + +``` + +``` + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + revocationNotification: + '{request.body#/revocNotifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthRevocNotification' + responses: + '204': + description: slice revocation notification response + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +``` + +``` + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/slice-authentications/{authCtxId}: + put: + summary: Confirm the slice authentication result + operationId: ConfirmSliceAuthentication + tags: + - Confirm Slice Authentication + parameters: + - name: authCtxId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthConfirmationData' + responses: + '200': + description: Request processed (EAP success or Failure) + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthConfirmationResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: Bad Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + description: Internal Server Error + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + description: Network error or remote peer error + content: + application/problem+json: + schema: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnssaaf-nssaa: Access to the nnssaaf-nssaa API + +schemas: + +# +# COMPLEX TYPES: +# + +SliceAuthInfo: + type: object + properties: + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + eapIdRsp: + $ref: '#/components/schemas/EapMessage' + amfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + reauthNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + revocNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + required: + - gsi + - snssai + - eapIdRsp + +SliceAuthContext: + type: object + properties: + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + authCtxId: + $ref: '#/components/schemas/SliceAuthCtxId' + eapMessage: + $ref: '#/components/schemas/EapMessage' + required: + - gsi + - snssai + - authCtxId + - eapMessage + +SliceAuthConfirmationData: + type: object + properties: + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + eapMessage: + $ref: '#/components/schemas/EapMessage' + required: + - gsi + - snssai + - eapMessage + +SliceAuthConfirmationResponse: + type: object + properties: + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + eapMessage: + $ref: '#/components/schemas/EapMessage' +``` + +``` + + authResult: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AuthStatus' + required: + - gpsi + - snssai + - eapMessage + +SliceAuthReauthNotification: + type: object + properties: + notifType: + $ref: '#/components/schemas/SliceAuthNotificationType' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + required: + - notifType + - gpsi + - snssai + +SliceAuthRevokeNotification: + type: object + properties: + notifType: + $ref: '#/components/schemas/SliceAuthNotificationType' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + required: + - notifType + - gpsi + - snssai + +# +# SIMPLE TYPES: +# + +SliceAuthCtxId: + type: string + description: contains the resource ID of slice authentication context + nullable: false + +EapMessage: + type: string + format: byte + description: contains an EAP packet + nullable: true + +# +# ENUMS: +# + +SliceAuthNotificationType: + type: string + enum: + - SLICE_RE_AUTH + - SLICE_REVOCATION + +``` + +## A.3 Nnssaaaf\_AIW API + +openapi: 3.0.0 + +``` + +info: + title: Nnssaaaf_AIW + version: 1.1.0-alpha.2 + description: | + AAA Interworking Authentication and Authorization Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` +externalDocs: + description: 3GPP TS29.526, NSSAA Service, version 18.3.0. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.526/ + +servers: + - url: '{apiRoot}/nnssaaf-aiw/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnssaaf-aiw + +paths: + /authentications: + post: + summary: Create authentication context + operationId: CreateAuthenticationContext + tags: + - Authentications (Collections) + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthInfo' + required: true + responses: + '201': + description: AuthContext successfully created + content: + application/json: + schema: + $ref: '#/components/schemas/AuthContext' + headers: + Location: + description: 'Contains the URI of the newly created resource according to the +structure: {apiRoot}/nnssaaf-aiw//authentications/{authCtxId}' + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + + /authentications/{authCtxId}: + put: + summary: Confirm the authentication result + operationId: ConfirmAuthentication + tags: +``` + +``` +- Authentication (Document) +parameters: +- name: authCtxId + in: path + required: true + schema: + type: string +requestBody: +content: + application/json: + schema: + $ref: '#/components/schemas/AuthConfirmationData' +responses: +'200': + description: Request processed (EAP success or Failure) + content: + application/json: + schema: + $ref: '#/components/schemas/AuthConfirmationResponse' +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +'504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnssaaf-aiw: Access to the nnssaaf-aiw API + +schemas: + +# +# COMPLEX TYPES: +# + +AuthInfo: + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + eapIdRsp: + $ref: 'TS29526_Nnssaaf_NSSAA.yaml#/components/schemas/EapMessage' + ttlsInnerMethodContainer: + $ref: 'TS29526_Nnssaaf_NSSAA.yaml#/components/schemas/EapMessage' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supi +``` + +``` +AuthContext: + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + authCtxId: + $ref: '#/components/schemas/AuthCtxId' + eapMessage: + $ref: 'TS29526_Nnssaaaf_NSSAA.yaml#/components/schemas/EapMessage' + ttlsInnerMethodContainer: + $ref: 'TS29526_Nnssaaaf_NSSAA.yaml#/components/schemas/EapMessage' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supi + - authCtxId + +AuthConfirmationData: + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + eapMessage: + $ref: 'TS29526_Nnssaaaf_NSSAA.yaml#/components/schemas/EapMessage' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supi + - eapMessage + +AuthConfirmationResponse: + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + eapMessage: + $ref: 'TS29526_Nnssaaaf_NSSAA.yaml#/components/schemas/EapMessage' + authResult: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AuthStatus' + pvsInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServerAddressingInfo' + minItems: 1 + msk: + $ref: 'TS29509_Nausf_UEAuthentication.yaml#/components/schemas/Msk' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supi + - eapMessage + +# +# SIMPLE TYPES: +# + +AuthCtxId: + type: string + description: contains the resource ID of authentication context + nullable: false + +# +# ENUMS: +# +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|---------------------------------------------------------------|------|-----|-----|---------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2020-06 | CT4#98E | C4-203683 | | | | TS skeleton. | 0.1.0 | +| 2020-06 | CT4#98E | C4-202084
C4-202085
C4-202086
C4-203709
C4-203710 | | | | Implementation of pCRs agreed in CT4#98E | 0.2.0 | +| 2020-06 | CT#88e | CP-201193 | | | | TS presented for information and approval. | 1.0.0 | +| 2020-06 | CT#88e | | | | | TS approved at CT#88e | 16.0.0 | +| 2020-09 | CT#89 | CP-202104 | 0005 | 1 | F | Update References | 16.1.0 | +| 2020-09 | CT#89 | CP-202104 | 0007 | 1 | F | Release PDU Session if NSSAA Re-Authentication and Re-Authorization Fails | 16.1.0 | +| 2020-09 | CT#89 | CP-202104 | 0008 | 1 | F | NSSAA status management | 16.1.0 | +| 2020-12 | CT#90 | CP-203054 | 0009 | 2 | F | Amendments for stateless NF support | 16.2.0 | +| 2020-12 | CT#90 | CP-203040 | 0010 | - | F | Remove Editor's Notes on AAA Server Address | 16.2.0 | +| 2020-12 | CT#90 | CP-203048 | 0011 | 1 | F | Storage of YAML files in 3GPP Forge | 16.2.0 | +| 2020-12 | CT#90 | CP-203040 | 0012 | 1 | F | AMF behaviour for NSSAA procedure due to temporal NW failure | 16.2.0 | +| 2020-12 | CT#90 | CP-203036 | 0013 | - | F | API version and External doc update | 16.2.0 | +| 2021-03 | CT#91 | CP-210049 | 0014 | - | F | Incorrect Media Type | 16.3.0 | +| 2021-03 | CT#91 | CP-210054 | 0016 | - | F | 29.526 Rel-16 API version and External doc update | 16.3.0 | +| 2021-03 | CT#91 | CP-210034 | 0015 | 1 | F | OpenAPI Reference | 17.0.0 | +| 2021-06 | CT#92 | CP-211068 | 0018 | 1 | F | Unsuccessful cases for handling of NSSAA status in AMF | 17.1.0 | +| 2021-06 | CT#92 | CP-211028 | 0019 | - | F | TS Clean-up | 17.1.0 | +| 2021-06 | CT#92 | CP-211068 | 0021 | 1 | F | SUPI in Notifications from NSSAAF | 17.1.0 | +| 2021-06 | CT#92 | CP-211059 | 0023 | 1 | F | Redirect Response | 17.1.0 | +| 2021-06 | CT#92 | CP-211050 | 0024 | - | F | 29.526 Rel-17 API version and External doc update | 17.1.0 | +| 2021-09 | CT#93 | CP-212045 | 0026 | 1 | F | Attack from AAA-S | 17.2.0 | +| 2021-09 | CT#93 | CP-212070 | 0028 | 1 | F | NSSAA procedure from two different AMFs | 17.2.0 | +| 2021-09 | CT#93 | CP-212060 | 0031 | - | F | 3xx description correction for SCP | 17.2.0 | +| 2021-09 | CT#93 | CP-212026 | 0032 | - | F | Base64 Encoding of binary attributes in JSON objects | 17.2.0 | +| 2021-09 | CT#93 | CP-212045 | 0033 | - | F | Re-authentication Request when S-NSSAI is not in use | 17.2.0 | +| 2021-09 | CT#93 | CP-212059 | 0034 | - | F | 29.526 Rel-17 API version and External doc update | 17.2.0 | +| 2021-09 | CT#94 | CP-213139 | 0036 | 2 | F | Remove AMF behaviour related to back-off timer from NSSAA procedure | 17.3.0 | +| 2021-12 | CT#94 | CP-213085 | 0037 | - | F | Miscellaneous corrections | 17.3.0 | +| 2021-12 | CT#94 | CP-213139 | 0039 | 1 | F | Correction to Re-Authentication / Revocation Notification Procedure | 17.3.0 | +| 2021-12 | CT#94 | CP-213092 | 0041 | 1 | F | Clarification of NSAC and exposure service | 17.3.0 | +| 2021-12 | CT#94 | CP-213120 | 0042 | - | F | 307/308 redirection | 17.3.0 | +| 2022-12 | CT#95 | CP-220047 | 0043 | 1 | F | Changing the Title of the TS 29.526 | 17.4.0 | +| 2022-03 | CT#95 | CP-220047 | 0051 | 3 | B | AIW Service | 17.4.0 | +| 2022-03 | CT#95 | CP-220026 | 0053 | 1 | F | 3xx Redirect Response | 17.4.0 | +| 2022-03 | CT#95 | CP-220075 | 0055 | 1 | F | Incorrect Service Name | 17.4.0 | +| 2022-03 | CT#95 | CP-220025 | 0057 | - | F | EAP ID Response message | 17.4.0 | +| 2022-03 | CT#95 | CP-220066 | 0058 | - | F | 29.526 Rel-17 API version and External doc update | 17.4.0 | +| 2022-06 | CT#96 | CP-221051 | 0061 | - | F | 29.526 Rel-17 API version and External doc update | 17.5.0 | +| 2022-09 | CT#97 | CP-222056 | 0063 | - | F | Multiple GPSIs | 17.6.0 | +| 2022-12 | CT#98 | CP-223049 | 0066 | 1 | F | MSK in Primary Authentication Successful Response | 17.7.0 | +| 2022-12 | CT#98 | CP-223066 | 0068 | - | F | 29.526 Rel-17 API version and External doc update | 17.7.0 | +| 2022-12 | CT#98 | CP-223028 | 0065 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0067 | - | F | 29.526 Rel-18 API version and External doc update | 18.0.0 | +| 2023-03 | CT#99 | CP-230066 | 0070 | 1 | F | Corrections on the reference number | 18.1.0 | +| 2023-06 | CT#100 | CP-231027 | 0069 | 4 | F | Location header and missing Redirection clause | 18.2.0 | +| 2023-06 | CT#100 | CP-231073 | 0074 | 1 | F | Default Notification for Inter-PLMN Access | 18.2.0 | +| 2023-09 | CT#101 | CP-232058 | 0075 | - | F | Major API version | 18.3.0 | +| 2023-09 | CT#101 | CP-232271 | 0076 | 1 | F | 29.526 Rel-18 API version and External doc update | 18.3.0 | +| 2023-12 | CT#102 | CP-233027 | 0077 | - | F | Obsoleted HTTP/2 RFCs | 18.4.0 | +| 2023-12 | CT#102 | CP-233027 | 0078 | - | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29544/raw.md b/raw/rel-18/29_series/29544/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..77b8ff81de65568d065b4700f8cb3d57749c4ca2 --- /dev/null +++ b/raw/rel-18/29_series/29544/raw.md @@ -0,0 +1,767 @@ + + +# 3GPP TS 29.544 V18.1.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Secured Packet Application Function (SP-AF) Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +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. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +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. + +3GPP logo + +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. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Terms..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 4.1 Introduction ..... | 8 | +| 5 Services offered by the SP-AF..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Nspaf_SecuredPacket Service..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 Provide ..... | 9 | +| 5.2.2.2.1 General ..... | 9 | +| 5.2.2.2.2 Secured Packet Retrieval..... | 9 | +| 6 API Definitions ..... | 10 | +| 6.1 Nspaf_SecuredPacket Service API ..... | 10 | +| 6.1.1 Introduction ..... | 10 | +| 6.1.2 Usage of HTTP..... | 10 | +| 6.1.2.1 General..... | 10 | +| 6.1.2.2 HTTP standard headers..... | 11 | +| 6.1.2.2.1 General ..... | 11 | +| 6.1.2.2.2 Content type ..... | 11 | +| 6.1.2.3 HTTP custom headers..... | 11 | +| 6.1.3 Resources..... | 11 | +| 6.1.3.1 Overview..... | 11 | +| 6.1.3.2 Resource: SecuredPacket..... | 12 | +| 6.1.3.2.1 Description ..... | 12 | +| 6.1.3.2.2 Resource Definition..... | 12 | +| 6.1.3.2.3 Resource Standard Methods..... | 12 | +| 6.1.3.2.4 Resource Custom Operations..... | 12 | +| 6.1.3.2.4.2.1 Description..... | 12 | +| 6.1.3.2.4.2.2 Operation Definition ..... | 12 | +| 6.1.4 Custom Operations without associated resources ..... | 13 | +| 6.1.5 Notifications ..... | 13 | +| 6.1.6 Data Model ..... | 13 | +| 6.1.6.1 General..... | 13 | +| 6.1.6.2 Structured data types..... | 13 | +| 6.1.6.2.1 Introduction ..... | 13 | +| 6.1.6.2.2 Type: UiccConfigurationParameter ..... | 14 | +| 6.1.6.2.3 Type: ExtendedSteeringContainer ..... | 14 | +| 6.1.6.3 Simple data types and enumerations..... | 14 | +| 6.1.6.3.1 Introduction ..... | 14 | +| 6.1.6.3.2 Simple data types ..... | 14 | +| 6.1.7 Error Handling..... | 15 | +| 6.1.7.1 General..... | 15 | +| 6.1.7.2 Protocol Errors ..... | 15 | +| 6.1.7.3 Application Errors..... | 15 | +| 6.1.8 Feature negotiation ..... | 15 | +| 6.1.9 Security..... | 15 | + +**Annex A (normative): OpenAPI specification ..... 16** +A.1 General..... 16 +A.2 Nspaf\_SecuredPacket API..... 16 +**Annex B (informative): Change history..... 19** + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nspaf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the SP-AF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +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]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 29.503: "Unified Data Management Services"; Stage 3. +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [16] 3GPP TS 31.115: "Secured packet structure for (Universal) Subscriber Identity Module (U)SIM Toolkit applications". +- [17] 3GPP TS 29.509: "Authentication Server Services; Stage 3". +- [18] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)" +- [19] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Terms + +Void. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +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]. + +| | | +|--------|------------------------------------------| +| OTA | Over The Air | +| SOR-AF | Steering Of Roaming Application Function | +| SP-AF | Secured Packet Application Function | +| UDM | Unified Data Management | + +# 4 Overview + +## 4.1 Introduction + +Within the 5GC, the SP-AF offers services to the UDM and to the SOR-AF via the Nspaf service based interface. + +The UDM or SOR-AF shall make use of the SP-AF services when it needs to protect UE parameters for which the final consumer is the USIM (see 3GPP TS 33.501 [8] clause 6.15.2.1). + +Figure 4.1-1 provides the reference model with focus on the SP-AF. + +NOTE: The generation of the secured packet and the definition of the storage and handling of OTA keys or other sensitive data are out of scope of this document. For more details, refer to 3GPP TS 23.040 [18] and 3GPP TS 31.115 [16]. + +![Reference model diagram showing UDM and SOR-AF connected to SP-AF via the Nspaf interface.](6078636a87fbe0e699aab4a6fddd15d7_img.jpg) + +The diagram illustrates the reference model for the SP-AF. On the left, there are two rectangular boxes labeled 'UDM' and 'SOR-AF'. Lines from both boxes converge to a single point labeled 'Nspaf'. From this point, a line connects to a large green rectangular box on the right labeled 'SP-AF'. + +Reference model diagram showing UDM and SOR-AF connected to SP-AF via the Nspaf interface. + +Figure 4.1-1: Reference model – SP-AF + +# 5 Services offered by the SP-AF + +## 5.1 Introduction + +The SP-AF offers the following services via the Nspaf interface: + +- Nspaf\_SecuredPacket Service + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------------|--------|------------------------------|-----------------------------------|----------------------|-------| +| Nspaf_SecuredPacket | 6.1 | Nspaf Secured Packet Service | TS29544_Nspaf_SecuredPacket .yaml | nspaf-secured-packet | A.2 | + +## 5.2 Nspaf\_SecuredPacket Service + +### 5.2.1 Service Description + +The Nspaf\_SecuredPacket Service may be consumed by the NF consumer (e.g. UDM or SOR-AF) when it has detected that a UICC configuration parameter (e.g. Routing ID data or Steering of Roaming information) needs to be updated, and the new value is not available in secured packet format. + +For the list of service operations see clause 5.2.2.1 + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nspaf\_SecuredPacket service the following service operations are defined: + +- Provide + +The Nspaf\_SecuredPacket Service is used by Consumer NFs (e.g. UDM or SOR-AF) to request the SP-AF to provide a secured packet that contains an UICC configuration parameter as sent in the request by means of the Provide service operation + +#### 5.2.2.2 Provide + +##### 5.2.2.2.1 General + +This service operation is used by the NF Service Consumer (e.g. UDM or SOR-AF) to request construction of a secured packet that contains the provided UICC configuration information (e.g. Routing Indicator or Steering of Roaming information). + +The following procedures using the Provide service operation are supported: + +- Secured Packet Retrieval + +##### 5.2.2.2.2 Secured Packet Retrieval + +Figure 5.2.2.2.2-1 shows a scenario where the NF consumer (e.g. UDM or SOR-AF) sends a request to the SP-AF to provide a secured packet. + +The request contains the UE's identity (/{supi}) and the UICC configuration parameter. + +![Sequence diagram showing the interaction between an NF-consumer and an SP-AF. The NF-consumer sends a POST request to the SP-AF. The SP-AF responds with either a 200 OK (SecuredPacket) or a 404 Not Found.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant NF-consumer + participant SP-AF + Note right of NF-consumer: 1. POST.../{supi}/provide-secured-packet (UiccConfigurationParameter) + NF-consumer->>SP-AF: Request + Note left of SP-AF: 2a. 200 OK (SecuredPacket) + SP-AF-->>NF-consumer: Response 2a + Note left of SP-AF: 2b. 404 Not Found + SP-AF-->>NF-consumer: Response 2b + +``` + +Sequence diagram showing the interaction between an NF-consumer and an SP-AF. The NF-consumer sends a POST request to the SP-AF. The SP-AF responds with either a 200 OK (SecuredPacket) or a 404 Not Found. + +**Figure 5.2.2.2.2-1: NF consumer requests the SP-AF to provide a secured packet** + +1. The NF consumer sends a POST request (custom method: provide-secured-packet) to the resource representing the SUPI. +- 2a. On success, the SP-AF responds with "200 OK", containing the requested SecuredPacket. +- 2b. If the resource does not exist (the supi is unknown in the SP-AF), the SP-AF returns the HTTP status code "404 Not Found", and additional error information should be included in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +# 6 API Definitions + +## 6.1 Nspaf\_SecuredPacket Service API + +### 6.1.1 Introduction + +The Nspaf\_SecuredPacket service shall use the Nspaf\_SecuredPacket API. + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nspaf-secured-packet". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nspaf\_SecuredPacket API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +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". + +"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]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +![Diagram showing the hierarchical structure of the nspaf-secured-packet API URI. The root is {apiRoot}/nspaf-secured-packet/. It branches to /{supi}, which in turn branches to /provide-secured-packet (indicated by a dashed box).](ca7c7526ec57cd5a2f278c194c0a6a00_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nspaf-secured-packet/"] --> Supi["/{supi}"] + Supi --> Packet["/provide-secured-packet"] + style Packet stroke-dasharray: 5 5 + +``` + +Diagram showing the hierarchical structure of the nspaf-secured-packet API URI. The root is {apiRoot}/nspaf-secured-packet/. It branches to /{supi}, which in turn branches to /provide-secured-packet (indicated by a dashed box). + +**Figure 6.1.3.1-1: Resource URI structure of the nspaf-secured-packet API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------------|--------------------------------|---------------------------------|--------------------------------------------------------------------------------------------| +| SecuredPacket (Custom operation) | /{supi}/provide-secured-packet | Provide-secured-packet (POST) | The SP-AF generates a secured packet containing the presented UICC configuration parameter | + +#### 6.1.3.2 Resource: SecuredPacket + +##### 6.1.3.2.1 Description + +This resource represents the information that is needed to construct secured packets for the SUPI. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nspaf-secured-packet/v1/{supi}/provide-secured-packet + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|--------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "^(imsi-[0-9]{5,15} nai-.[+.]\$)" | + +##### 6.1.3.2.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +##### 6.1.3.2.4 Resource Custom Operations + +###### 6.1.3.2.4.1 Overview + +**Table 6.1.3.2.4.1-1: Custom operations** + +| Custom operation URI | Mapped HTTP method | Description | +|-------------------------|--------------------|-------------------------------------------------------------------------------------------------------------| +| /provide-secured-packet | POST | The SP-AF generates a secured packet for the SUPI that contains the presented UICC configuration parameter. | + +###### 6.1.3.2.4.2 Operation: provide-secured-packet + +###### 6.1.3.2.4.2.1 Description + +This custom operation is used by the NF service consumer (e.g. UDM) to request a secured packet for the SUPI containing the presented UICC configuration parameter. The returned secured packet shall be constructed as an SMS-Deliver as specified in 3GPP TS 23.040 [18] and protected as specified in 3GPP TS 31.115 [16]. + +###### 6.1.3.2.4.2.2 Operation Definition + +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. + +**Table 6.1.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|----------------------------------------------------------| +| UiccConfiguration Parameter | M | 1 | Contains the parameter that is to be updated in the UICC | + +**Table 6.1.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------| +| SecuredPacket | M | 1 | 200 OK | Upon success, a response body containing the generated secured packet shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to convey the following application error:
- USER NOT FOUND | +| 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. | | | | | + +### 6.1.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nspaf\_SecuredPacket Service. + +### 6.1.5 Notifications + +In this release of this specification, no notifications are defined for the Nspaf\_SecuredPacket Service. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nspaf service based interface protocol. + +**Table 6.1.6.1-1: Nspaf specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------------------|----------------|-----------------------------------------------------------------------------------------|---------------| +| UiccConfigurationParameter | 6.1.6.2.2 | UICC Configuration Parameters | | +| RoutingId | 6.1.6.3.2 | Routing ID | | +| ExtendedSteeringContainer | 6.1.6.2.3 | Extended Steering Container (including the contents of Steering Container and SOR-CMCI) | | + +Table 6.1.6.1-2 specifies data types re-used by the Nspaf 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 Nspaf service based interface. + +**Table 6.1.6.1-2: Nspaf re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------|---------------------|-----------------------------------------------------|---------------| +| SecuredPacket | 3GPP TS 29.503 [14] | Secured Packet | | +| ProblemDetails | 3GPP TS 29.571 [15] | | | +| SteeringInfo | 3GPP TS 29.509 [17] | Steering Information | | +| SorCmci | 3GPP TS 29.503 [14] | Contains SOR-CMCI as defined in 3GPP TS 24.501 [19] | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: UiccConfigurationParameter + +Table 6.1.6.2.2-1: Definition of type UiccConfigurationParameter + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| routingId | RoutingId | C | 0..1 | The Routing Id that needs to be updated in the USIM. | | +| steeringContainer | array(SteeringInfo) | C | 1..N | List of PLMN/AccessTechnologies combinations that need to be updated in the USIM. | | +| extendedSteeringContainer | ExtendedSteeringContainer | C | 0..1 | Extended Steering Container that includes list of PLMN/AccessTechnologies combinations with the SOR-CMCI that need to be updated in the USIM | | + +Note: Exactly one attribute shall be present + +##### 6.1.6.2.3 Type: ExtendedSteeringContainer + +Table 6.1.6.2.3-1: Definition of type ExtendedSteeringContainer + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|---------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| steeringContainer | array(SteeringInfo) | C | 1..N | List of PLMN/AccessTechnologies combinations that need to be updated in the USIM. | | +| sorCmci | SorCmci | C | 0..1 | When present, provides the SOR-CMCI values as defined in 3GPP TS 24.501 [19] | | +| storeSorCmciInMe | boolean | C | 0..1 | When present, indicates "Store the SOR-CMCI in the ME", i.e. whether to instruct UE to store SOR-CMCI in the ME as defined in 3GPP TS 23.122 [14] and 3GPP TS 24.501 [27].

- True: Indicates to store the SOR-CMCI in the ME
- False or absent: Indicates storing the SOR-CMCI in the ME is not required | | + +NOTE: At least one attribute shall be present. If no additional attributes than steeringContainer is included, then use of steeringContainer can be considered instead of using ExtendedSteeringContainer. + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------------------|---------------| +| RoutingId | string | Pattern: "[0-9]{1,4}\$" | | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nspaf\_SecuredPacket 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]. + +In addition, the requirements in the following clauses are applicable for the Nspaf\_SecuredPacket API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nspaf\_SecuredPacket service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nspaf\_SecuredPacket service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nspaf\_SecuredPacket API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nspaf\_SecuredPacket 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. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nspaf\_SecuredPacket 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. + +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 Nspaf\_SecuredPacket service. + +The Nspaf\_SecuredPacket API defines a single scope "nspaf-secured-packet" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +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). + +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. + +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 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Nspaf\_SecuredPacket API + +``` +openapi: 3.0.0 +info: + title: 'Nspaf_SecuredPacket' + version: '1.2.0-alpha.1' + description: | + Nspaf Secured Packet Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 29.544, SP-AF Services, version V18.0.0 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.544/ +servers: + - url: '{apiRoot}/nspaf-secured-packet/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +security: + - {} + - oAuth2ClientCredentials: + - nspaf-secured-packet +paths: + /{supi}/provide-secured-packet: + post: + summary: request generation of a secured packet + operationId: ProvideSecuredPacket + tags: + - SecuredPacket Generation (Custom Operation) + parameters: + - name: supi + in: path + description: SUPI of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UiccConfigurationParameter' + responses: + '200': + description: Success + content: +``` + +``` + + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SecuredPacket' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nspaf-secured-packet: Access to the nspaf-secured-packet API + schemas: + +# COMPLEX TYPES: + +UiccConfigurationParameter: + description: Represents UICC Configuration Parameters. + type: object + oneOf: + - required: [routingId ] + - required: [steeringContainer ] + - required: [extendedSteeringContainer ] + properties: + routingId: + $ref: '#/components/schemas/RoutingId' + steeringContainer: + type: array + items: + $ref: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SteeringInfo' + minItems: 1 + extendedSteeringContainer: + $ref: '#/components/schemas/ExtendedSteeringContainer' + +ExtendedSteeringContainer: + description: Represents Extended Steering Containers. + type: object + properties: + steeringContainer: + type: array + items: + $ref: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SteeringInfo' + minItems: 1 + sorCmci: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SorCmci' + storeSorCmciInMe: + type: boolean + +# SIMPLE TYPES: + +RoutingId: + description: Represents a routing indicator. + type: string + +``` + +pattern: '^[0-9]{1,4}\$' + +# ENUMS: + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-10 | CT4#94 | C4-194013 | | | | Initial Draft. | 0.1.0 | +| 2019-10 | CT4#94 | C4-194367 | | | | Notaf Overview | 0.2.0 | +| 2019-10 | CT4#94 | C4-194488 | | | | Notaf_SecuredPacket-Provide service operation | 0.2.0 | +| 2019-10 | CT4#94 | C4-194492 | | | | Resources | 0.2.0 | +| 2019-10 | CT4#94 | C4-194516 | | | | Data Model | 0.2.0 | +| 2019-10 | CT4#94 | C4-194490 | | | | OpenAPI Specification | 0.2.0 | +| 2019-11 | CT4#95 | C4-195481 | | | | Clean Up | 0.3.0 | +| 2019-12 | CT#86 | CP-193071 | | | | TS presented for information | 1.0.0 | +| 2019-12 | CT#86 | CP-193285 | | | | A title updated | 1.0.1 | +| 2020-03 | CT4#96e | C4-201119 | | | | Pseudo-CR on SOR | 1.1.0 | +| 2020-03 | CT4#96e | C4-201123 | | | | Pseudo-CR on Clean Up | 1.1.0 | +| 2020-03 | CT4#96e | C4-201217 | | | | Pseudo-CR on the necessary modifications to change OTAF NF name to SP-AF | 1.1.0 | +| 2020-03 | CT4#96e | C4-201314 | | | | Pseudo-CR on API descriptions table in clause 5.1 | 1.1.0 | +| 2020-03 | CT#87e | CP-200062 | | | | TS presented for approval | 2.0.0 | +| 2020-03 | CT#87e | | | | | Approved at CT#87e | 16.0.0 | +| 2020-07 | CT#88e | CP-201040 | 0001 | 1 | C | Clarification on Secured Packet format provided by SP-AF | 16.1.0 | +| 2020-07 | CT#88e | CP-201040 | 0002 | | F | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-07 | CT#88e | CP-201040 | 0003 | 1 | F | Miscellaneous Corrections | 16.1.0 | +| 2020-07 | CT#88e | CP-201073 | 0005 | | F | 3GPP TS 29.544 API Version and External doc Update | 16.1.0 | +| 2020-09 | CT#89e | CP-202110 | 0006 | 1 | F | Miscellaneous corrections | 16.2.0 | +| 2020-09 | CT#89e | CP-202096 | 0007 | | F | API version and External doc update | 16.2.0 | +| 2020-12 | CT#90e | CP-203048 | 0008 | | F | Storage of yaml files | 16.3.0 | +| 2021-06 | CT#92e | CP-211051 | 0011 | | F | OpenAPI Reference | 17.0.0 | +| 2021-06 | CT#92e | CP-211028 | 0012 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the Nspaf_SecuredPacket API | 17.0.0 | +| 2021-06 | CT#92e | CP-211050 | 0013 | | F | 29.544 Rel-17 API version and External doc update | 17.0.0 | +| 2021-12 | CT#94e | CP-213197 | 0014 | 2 | B | SOR-CMCI support | 17.1.0 | +| 2021-12 | CT#94e | CP-213121 | 0015 | | F | 29.544 Rel-17 API version and External doc update | 17.1.0 | +| 2022-03 | CT#95e | CP-220041 | 0016 | | B | Addition of SOR-CMCI related attribute as input to SP-AF | 17.2.0 | +| 2022-03 | CT#95e | CP-220066 | 0017 | | F | API version and External doc update | 17.2.0 | +| 2022-06 | CT#96 | CP-221300 | 0018 | 1 | F | API version and External doc update | 17.3.0 | +| 2022-12 | CT#98e | CP-223027 | 0020 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98e | CP-223033 | 0021 | | F | 29.544 Rel-18 API version and External doc update | 18.0.0 | +| 2023-12 | CT#102 | CP-233028 | 0022 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.1.0 | +| 2023-12 | CT#102 | CP-233029 | 0023 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.1.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29562/00504fc688ebcf131ccbeff94dfc9939_img.jpg b/raw/rel-18/29_series/29562/00504fc688ebcf131ccbeff94dfc9939_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1f8e7ed9826b327793d3c0426fda01a7dc2aeccc --- /dev/null +++ b/raw/rel-18/29_series/29562/00504fc688ebcf131ccbeff94dfc9939_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4cb8708c3c61b268e6643c1efa66d52c9240b1d53c3e910310fcbd42ce3c0257 +size 28707 diff --git a/raw/rel-18/29_series/29562/042af54276c75e7b7b48a3af1f0a84e5_img.jpg b/raw/rel-18/29_series/29562/042af54276c75e7b7b48a3af1f0a84e5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f977978f3c25688169c7f3a1d3e2ca44fe905132 --- /dev/null +++ b/raw/rel-18/29_series/29562/042af54276c75e7b7b48a3af1f0a84e5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:936df267cbb97fc12beb81885a208346fdd74bd8050e40060d0ea63e2b6e6a55 +size 25809 diff --git a/raw/rel-18/29_series/29562/04dc3838022e96d8d5548bb1b777b38c_img.jpg b/raw/rel-18/29_series/29562/04dc3838022e96d8d5548bb1b777b38c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3971902f6f55e1aa2a5eae107a5ea02b29afa893 --- /dev/null +++ b/raw/rel-18/29_series/29562/04dc3838022e96d8d5548bb1b777b38c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:af8a72a8d9f581866b31c1057269293bfdcae4523811f2ef9c93c88ab18178e9 +size 34429 diff --git a/raw/rel-18/29_series/29562/052543d8c9c0643b05b3ce45c6decca1_img.jpg b/raw/rel-18/29_series/29562/052543d8c9c0643b05b3ce45c6decca1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6702f63d8590542e325ad7f491705457997719b0 --- /dev/null +++ b/raw/rel-18/29_series/29562/052543d8c9c0643b05b3ce45c6decca1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a722fbacf4a9b0669ffbe867085343414697dac1cc9c593ddc79a4d8fdbc1342 +size 32178 diff --git a/raw/rel-18/29_series/29562/05eb72d372e4bf78e3d6a64949d77bcc_img.jpg b/raw/rel-18/29_series/29562/05eb72d372e4bf78e3d6a64949d77bcc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d457747e8248a6f77b29b976568a8caaf45f62c1 --- /dev/null +++ b/raw/rel-18/29_series/29562/05eb72d372e4bf78e3d6a64949d77bcc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2dc2b67963ac1b057811819a34e66819863013dd27e52fbe3310ed201267119a +size 26256 diff --git a/raw/rel-18/29_series/29562/0977b81510f7649846289ee785d20e74_img.jpg b/raw/rel-18/29_series/29562/0977b81510f7649846289ee785d20e74_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c4b9815f18f554b38e31f76b3c13aaf9bf5b78f1 --- /dev/null +++ b/raw/rel-18/29_series/29562/0977b81510f7649846289ee785d20e74_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:77975b38542bc001d8cb6d4508538e760e000dae06dba62ff7388f8e4b56ff18 +size 32656 diff --git a/raw/rel-18/29_series/29562/10d81b2cc455e3563e3e562a7f451124_img.jpg b/raw/rel-18/29_series/29562/10d81b2cc455e3563e3e562a7f451124_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d2b79774289e205a579425b13b6e3213c5dcd666 --- /dev/null +++ b/raw/rel-18/29_series/29562/10d81b2cc455e3563e3e562a7f451124_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:306f472315cabaef4248d78a2bc4602f6f2d9a17a812ff6e79dee7b6ca19c08a +size 37856 diff --git a/raw/rel-18/29_series/29562/32ff77da4286b58c4778033acaa10836_img.jpg b/raw/rel-18/29_series/29562/32ff77da4286b58c4778033acaa10836_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..09d6e0561caa6f04bb25b89bab731c89d2bf6a50 --- /dev/null +++ b/raw/rel-18/29_series/29562/32ff77da4286b58c4778033acaa10836_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:06bd1b6f26ec6e55a0ddfe5841e5355f97b7120c892bf3ee0de8c0dbf69f666d +size 42371 diff --git a/raw/rel-18/29_series/29562/3337af75dfee8af7687b4f49914d6c93_img.jpg b/raw/rel-18/29_series/29562/3337af75dfee8af7687b4f49914d6c93_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..265f2aa03c0b4f25316e652a003d2bc2820687d5 --- /dev/null +++ b/raw/rel-18/29_series/29562/3337af75dfee8af7687b4f49914d6c93_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:50f56acc8157408fe41762e7eb91e5b94f58442bb4fdfc1e4050e0aff38cf031 +size 39797 diff --git a/raw/rel-18/29_series/29562/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg b/raw/rel-18/29_series/29562/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..042a387d08e3df4cd029fa705dce27610b83e1c3 --- /dev/null +++ b/raw/rel-18/29_series/29562/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8c947b61a54933114427a1324bafb053e2e4927905503ee7751c07d6689a8c97 +size 35373 diff --git a/raw/rel-18/29_series/29562/34e9ca4d52796527c375f4bc187080f8_img.jpg b/raw/rel-18/29_series/29562/34e9ca4d52796527c375f4bc187080f8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..915cd4add0a3588c3b421a16dac5315fa2cf9595 --- /dev/null +++ b/raw/rel-18/29_series/29562/34e9ca4d52796527c375f4bc187080f8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e9ed5c189f17db37331413d0146689b8876b3266c171a8bf9059ea77a58f3a45 +size 27550 diff --git a/raw/rel-18/29_series/29562/4356776ca004ecba5d599667a155d7d4_img.jpg b/raw/rel-18/29_series/29562/4356776ca004ecba5d599667a155d7d4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..df4cd15e3ba27f0c8dd776729c054b17822fc5fc --- /dev/null +++ b/raw/rel-18/29_series/29562/4356776ca004ecba5d599667a155d7d4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:77185ef4716ec08b10418413c5ffda5459373944bab8117a0e14bcfcaac90a2b +size 25782 diff --git a/raw/rel-18/29_series/29562/4767b6e106f34fe8b63a6838810bf913_img.jpg b/raw/rel-18/29_series/29562/4767b6e106f34fe8b63a6838810bf913_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..da72d0ee69adef642624689aa9435f061cf25f9f --- /dev/null +++ b/raw/rel-18/29_series/29562/4767b6e106f34fe8b63a6838810bf913_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:09c8648ad3c81acab3b31ccd1c7d386167a1be15d7c5cd6ade99d7f34eba2082 +size 34474 diff --git a/raw/rel-18/29_series/29562/4c9ba399ca7df11cbe9b6322cd9aee0a_img.jpg b/raw/rel-18/29_series/29562/4c9ba399ca7df11cbe9b6322cd9aee0a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3e45ba80bf5dae4f3cad84bda354732350ca102f --- /dev/null +++ b/raw/rel-18/29_series/29562/4c9ba399ca7df11cbe9b6322cd9aee0a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:85745399c9b582f5cb2537c3aece5c832c780822446f83e4d675abcfc86efe73 +size 37094 diff --git a/raw/rel-18/29_series/29562/5bd8085079508bb158cfc55b1007a459_img.jpg b/raw/rel-18/29_series/29562/5bd8085079508bb158cfc55b1007a459_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3b73a634ee7ea7ab12a6edb9c3b42f691411884b --- /dev/null +++ b/raw/rel-18/29_series/29562/5bd8085079508bb158cfc55b1007a459_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:29ce968c4b211e6926fd6759afc3f0dba3e2b60f2b6f223efd372a0dcaaec336 +size 19463 diff --git a/raw/rel-18/29_series/29562/5c6787bac31274e2dc992efeca74b303_img.jpg b/raw/rel-18/29_series/29562/5c6787bac31274e2dc992efeca74b303_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1b2d1d99a75072ea385982a366ceab15c1c163e4 --- /dev/null +++ b/raw/rel-18/29_series/29562/5c6787bac31274e2dc992efeca74b303_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e30457280bc9056192ea08c9b283fdaf3afd14918c87cc466e44d94e855732d6 +size 35446 diff --git a/raw/rel-18/29_series/29562/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29562/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c953d2ae8f6ab27e4f9d751dad1c66f129192ebf --- /dev/null +++ b/raw/rel-18/29_series/29562/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f8f9a8e3bbaffa3899f4e5812a3ee8479c8b87ff268b1210b69c4487dcfee91d +size 9500 diff --git a/raw/rel-18/29_series/29562/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29562/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3d0a8805a773b0a70489efe7a63879231133f784 --- /dev/null +++ b/raw/rel-18/29_series/29562/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:04359c2d6fc27b70059e6423de3626ad8c2e4393d5a7c2e251b8d45fafe10e28 +size 5500 diff --git a/raw/rel-18/29_series/29562/6f31cdb576d2f15c35c3f266e5f59211_img.jpg b/raw/rel-18/29_series/29562/6f31cdb576d2f15c35c3f266e5f59211_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e981b056d09fed0cd86e09c6b14a6e8a5a0d91a3 --- /dev/null +++ b/raw/rel-18/29_series/29562/6f31cdb576d2f15c35c3f266e5f59211_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:281acf80b342a27f402df3f1a05c72a90ffd0a3b66565ea76031ba3016b77fa2 +size 23684 diff --git a/raw/rel-18/29_series/29562/73b28b0f5e3be628bb5a3d6bd1d79d21_img.jpg b/raw/rel-18/29_series/29562/73b28b0f5e3be628bb5a3d6bd1d79d21_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1d70ea4cba96216d00273e776e8ba036a71e21cd --- /dev/null +++ b/raw/rel-18/29_series/29562/73b28b0f5e3be628bb5a3d6bd1d79d21_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b331bc7c9b8a1a42a8f0b0b3f616c477301224fa10c44938ae894ab46740650e +size 39574 diff --git a/raw/rel-18/29_series/29562/745261f385368efa3f2259c8681874e9_img.jpg b/raw/rel-18/29_series/29562/745261f385368efa3f2259c8681874e9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8e07b69bdb1b09108a67606404cc8cd929c8e288 --- /dev/null +++ b/raw/rel-18/29_series/29562/745261f385368efa3f2259c8681874e9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4a6c427ae2057444e25a1c58a6437115fed772ce538a71913c103fcb23020249 +size 27044 diff --git a/raw/rel-18/29_series/29562/753e6cc5dcad1a478caa2c7ec3a6c0a3_img.jpg b/raw/rel-18/29_series/29562/753e6cc5dcad1a478caa2c7ec3a6c0a3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f14ff76fed6f4a57a204709ee1f0a6d9b258e674 --- /dev/null +++ b/raw/rel-18/29_series/29562/753e6cc5dcad1a478caa2c7ec3a6c0a3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4831277418bf14a84fe23cd4f8cdb60a8a09f81ae824834f81ff862c98876b73 +size 34738 diff --git a/raw/rel-18/29_series/29562/772cc583a60eeb058cc19de48269ad22_img.jpg b/raw/rel-18/29_series/29562/772cc583a60eeb058cc19de48269ad22_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..61322131c8a506e72252d3ee8caa606976998ef3 --- /dev/null +++ b/raw/rel-18/29_series/29562/772cc583a60eeb058cc19de48269ad22_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ebdf8df78650c54fb3020227c1b52fb6449eb35760864f05ef964dc029799397 +size 31466 diff --git a/raw/rel-18/29_series/29562/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg b/raw/rel-18/29_series/29562/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b9217f94cb105665ab7c44f91a082469a1f07274 --- /dev/null +++ b/raw/rel-18/29_series/29562/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:01b27df6ff8c8083b8eee12b1615e69b310eaf1eec79d1b68e611015645145fe +size 28341 diff --git a/raw/rel-18/29_series/29562/7a02de7ed198501f7a4f6ca37c3f28c5_img.jpg b/raw/rel-18/29_series/29562/7a02de7ed198501f7a4f6ca37c3f28c5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..91ad00b12715f8a392c719fb34201ad67606a718 --- /dev/null +++ b/raw/rel-18/29_series/29562/7a02de7ed198501f7a4f6ca37c3f28c5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9db167790ce811b84574a0b14fba782c06f6ac42c56176d46efd2dc05bd25e27 +size 30505 diff --git a/raw/rel-18/29_series/29562/7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg b/raw/rel-18/29_series/29562/7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f12e6bcfff7dd2a4f4f3a4fadcb7038c0707c566 --- /dev/null +++ b/raw/rel-18/29_series/29562/7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4549ff0557e394ba6b841182a5c7b450dddb894cd4210b8ba1c8de75b54601c3 +size 34642 diff --git a/raw/rel-18/29_series/29562/88a6d9692a52989caa6b208a1ba70dc0_img.jpg b/raw/rel-18/29_series/29562/88a6d9692a52989caa6b208a1ba70dc0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bc2be75168b5c843e5cf8e89f15aaf7f03df9acc --- /dev/null +++ b/raw/rel-18/29_series/29562/88a6d9692a52989caa6b208a1ba70dc0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:89451f3b895335440581b97fb8888f5aed5dcb433f27d664e08300258e5fdc6f +size 24477 diff --git a/raw/rel-18/29_series/29562/8a8517bfa4f6191c52c47697716255a9_img.jpg b/raw/rel-18/29_series/29562/8a8517bfa4f6191c52c47697716255a9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9008c845bcd1ad9533b6db712fecf184d9e494fa --- /dev/null +++ b/raw/rel-18/29_series/29562/8a8517bfa4f6191c52c47697716255a9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:795b271a20322a5c61d2fdd3ed6fb7646401d7a51354d4c39a951e2091857745 +size 28118 diff --git a/raw/rel-18/29_series/29562/92171b3c1fa1c46db587486e1a4a260f_img.jpg b/raw/rel-18/29_series/29562/92171b3c1fa1c46db587486e1a4a260f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..071612da5bf10d18e10f040523d74b6d5ceeeb0a --- /dev/null +++ b/raw/rel-18/29_series/29562/92171b3c1fa1c46db587486e1a4a260f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3b3f23e168bcbac03299570119996a3801e47ae3abc4347a1ff86903fe26644d +size 24383 diff --git a/raw/rel-18/29_series/29562/9252ccfbbe9e34cb108f0060f2b563f1_img.jpg b/raw/rel-18/29_series/29562/9252ccfbbe9e34cb108f0060f2b563f1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..54e4a705874ab550436786b3a0100314747f39b7 --- /dev/null +++ b/raw/rel-18/29_series/29562/9252ccfbbe9e34cb108f0060f2b563f1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6e441294eabbf246bc74f94c27f53fb9bea35b055186a99306e331570e461827 +size 37166 diff --git a/raw/rel-18/29_series/29562/9c1d3678db4a12d5864cb2a4def1135d_img.jpg b/raw/rel-18/29_series/29562/9c1d3678db4a12d5864cb2a4def1135d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..de863764cdd852d4ffd85eb8eb719842d0c8fb3c --- /dev/null +++ b/raw/rel-18/29_series/29562/9c1d3678db4a12d5864cb2a4def1135d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d725064c62012ef9c21a05c5115a091a930ac6b461e40190293832e12470a2d6 +size 39981 diff --git a/raw/rel-18/29_series/29562/9e8ebf03cae78f4f81b697548c2d7250_img.jpg b/raw/rel-18/29_series/29562/9e8ebf03cae78f4f81b697548c2d7250_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..19962b7c69b78145139ece5cb06706a7556542a2 --- /dev/null +++ b/raw/rel-18/29_series/29562/9e8ebf03cae78f4f81b697548c2d7250_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:35875ac9c3a2d4e71c820f8c4a64936fc8c40d003ba0a9586d42b574aa4a2dba +size 26849 diff --git a/raw/rel-18/29_series/29562/a5b9392ecb96e6b5e0b4ee0664210f72_img.jpg b/raw/rel-18/29_series/29562/a5b9392ecb96e6b5e0b4ee0664210f72_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..26efa60f6b0b8d635a6188c3b5bfd7a2c35043c6 --- /dev/null +++ b/raw/rel-18/29_series/29562/a5b9392ecb96e6b5e0b4ee0664210f72_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:40c13c06663c5d1af2893e0a4433c18340879e7a830364c33fc1ee4a8cd11531 +size 26734 diff --git a/raw/rel-18/29_series/29562/b5987d63203a5fa601921039922ac520_img.jpg b/raw/rel-18/29_series/29562/b5987d63203a5fa601921039922ac520_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c54d17c2b856d619fdae29a94a0a5c962a2485a5 --- /dev/null +++ b/raw/rel-18/29_series/29562/b5987d63203a5fa601921039922ac520_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3d374acccadd8c9ce5c51e3dabc55b08f875cbe886c22b01ae3ebbbfc3297e57 +size 34279 diff --git a/raw/rel-18/29_series/29562/c07e21a8d65991db04263322f859c94f_img.jpg b/raw/rel-18/29_series/29562/c07e21a8d65991db04263322f859c94f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..800d42324acb3857f56da54ee4c48a84e51b560a --- /dev/null +++ b/raw/rel-18/29_series/29562/c07e21a8d65991db04263322f859c94f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8808b34c83825b1594842b6a651115b63a520207d65f7fbedaef48e038ac5b76 +size 105513 diff --git a/raw/rel-18/29_series/29562/c5a20f7bae219fc4c31f7376b7eb11e1_img.jpg b/raw/rel-18/29_series/29562/c5a20f7bae219fc4c31f7376b7eb11e1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..141fddb1a844fec947ff275b6d279784f3ef9a9d --- /dev/null +++ b/raw/rel-18/29_series/29562/c5a20f7bae219fc4c31f7376b7eb11e1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bdb53d162cfe33087afef07ea38cd64096edf7c89bfb36f92f2f888309d1bb6c +size 26800 diff --git a/raw/rel-18/29_series/29562/cc6f9dbfc36aa5821d9749ca84861f93_img.jpg b/raw/rel-18/29_series/29562/cc6f9dbfc36aa5821d9749ca84861f93_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..efe31dd1a387b4000f3d9929a8cc84211149041c --- /dev/null +++ b/raw/rel-18/29_series/29562/cc6f9dbfc36aa5821d9749ca84861f93_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0c3f1436c5c833dfebbff28a96bd3b788b67ce305be9c4a1964ffee9b2299e2c +size 31621 diff --git a/raw/rel-18/29_series/29562/d4ed35f72863013455b8f015e0f2e47e_img.jpg b/raw/rel-18/29_series/29562/d4ed35f72863013455b8f015e0f2e47e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a1efdf91509355272c9900b250a8af7ff724f2ce --- /dev/null +++ b/raw/rel-18/29_series/29562/d4ed35f72863013455b8f015e0f2e47e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0312df586d1acdccd7993fee45a027ab32d04e2c4514d8f4329816f1e4e024f3 +size 36916 diff --git a/raw/rel-18/29_series/29562/d8698aacaeead6dfed9a1e448670a2e4_img.jpg b/raw/rel-18/29_series/29562/d8698aacaeead6dfed9a1e448670a2e4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c4f12f48e45150b839f8abe6f8a2ca27390c247d --- /dev/null +++ b/raw/rel-18/29_series/29562/d8698aacaeead6dfed9a1e448670a2e4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:779255e3fcd7ce86151a9e62f67c7e227f88c127736422fabb4f51ccf0fe31ad +size 26696 diff --git a/raw/rel-18/29_series/29562/ddfa5b18550d1a022a941e3c31843814_img.jpg b/raw/rel-18/29_series/29562/ddfa5b18550d1a022a941e3c31843814_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cda6c7e774bf476fe95cdad23284a0165ea31d72 --- /dev/null +++ b/raw/rel-18/29_series/29562/ddfa5b18550d1a022a941e3c31843814_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b8ca4cb6bf1585107079b3121d1577e966b6844c7b7be83ecb6bdde912788518 +size 33846 diff --git a/raw/rel-18/29_series/29562/dfaa8b98082261913dac00eae86b2889_img.jpg b/raw/rel-18/29_series/29562/dfaa8b98082261913dac00eae86b2889_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5390951b542e174e395c6a5d181cba106f242522 --- /dev/null +++ b/raw/rel-18/29_series/29562/dfaa8b98082261913dac00eae86b2889_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:16ed8e3f40d77bfc580f5c132b1b3308409cd391762f2598924a15acc31c01dd +size 27382 diff --git a/raw/rel-18/29_series/29562/ea49c15f36ffb089d44f1d793f013778_img.jpg b/raw/rel-18/29_series/29562/ea49c15f36ffb089d44f1d793f013778_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ca163d6e919078c33ae8e1d7e02bd0e43f3b9142 --- /dev/null +++ b/raw/rel-18/29_series/29562/ea49c15f36ffb089d44f1d793f013778_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d7a97df9ec74077ce53e1a27fb8ee8c1a67a624d781d1b0e56a07807f8541ead +size 24799 diff --git a/raw/rel-18/29_series/29562/f0a97d0d3818a253c1d2a009966081b1_img.jpg b/raw/rel-18/29_series/29562/f0a97d0d3818a253c1d2a009966081b1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a29d09f76946b47e77eb57bb18bbd0b8b79b9b77 --- /dev/null +++ b/raw/rel-18/29_series/29562/f0a97d0d3818a253c1d2a009966081b1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7425a46a3d2a4053519e27f4f69bc3d64ba1edc48718b35e86bc6a0fb05d5e8f +size 30358 diff --git a/raw/rel-18/29_series/29562/f10dc32e3673e1392029a49e958a9d6c_img.jpg b/raw/rel-18/29_series/29562/f10dc32e3673e1392029a49e958a9d6c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..add4c225182b7e2226e42a047820e035263021f6 --- /dev/null +++ b/raw/rel-18/29_series/29562/f10dc32e3673e1392029a49e958a9d6c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20cd7da6b282f16f865271143c71d52551f9558543f4111a7005c12bd28cc9bc +size 24920 diff --git a/raw/rel-18/29_series/29562/f732d3320afe06d979aabbd366184254_img.jpg b/raw/rel-18/29_series/29562/f732d3320afe06d979aabbd366184254_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..faf0dec46dffaf82aac2f5d3b496f8f610b0f2d7 --- /dev/null +++ b/raw/rel-18/29_series/29562/f732d3320afe06d979aabbd366184254_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a3021ab788cf220efb8443fa6aa3fd0dc84f2694e395a826951a03a021ebf233 +size 29951 diff --git a/raw/rel-18/29_series/29565/15906392337ec83a921988b52f102a44_img.jpg b/raw/rel-18/29_series/29565/15906392337ec83a921988b52f102a44_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d7e1b872e6befb78d6edefc3314eb9c8bf5ed5db --- /dev/null +++ b/raw/rel-18/29_series/29565/15906392337ec83a921988b52f102a44_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a38d80ddea2698f8b6eb3f7ea62d068b7a702827870737774cbc046e30a31e11 +size 30349 diff --git a/raw/rel-18/29_series/29565/17a1ba23b641c01871b08f0a4f08ef48_img.jpg b/raw/rel-18/29_series/29565/17a1ba23b641c01871b08f0a4f08ef48_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5d084f2373d004cb2304705747cef46ddb6e570e --- /dev/null +++ b/raw/rel-18/29_series/29565/17a1ba23b641c01871b08f0a4f08ef48_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7f1c39018ed3ee497caceb05a556d1550434a327bba8415cc0fb326c9e4a749a +size 30309 diff --git a/raw/rel-18/29_series/29565/18003425d0e8638dde4acc9c5c468c5c_img.jpg b/raw/rel-18/29_series/29565/18003425d0e8638dde4acc9c5c468c5c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1f87722fbdc2bfe3f630d9dbe57e20db4fa1f613 --- /dev/null +++ b/raw/rel-18/29_series/29565/18003425d0e8638dde4acc9c5c468c5c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:85a66febf2775f20a2f10041a8ef504fb75b87321d5434b925ecf59230b0488f +size 28069 diff --git a/raw/rel-18/29_series/29565/1c29dadab94c3fa552d270434db09c81_img.jpg b/raw/rel-18/29_series/29565/1c29dadab94c3fa552d270434db09c81_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..75bfca95b2b71e709e47e9ee909222ed13806bf5 --- /dev/null +++ b/raw/rel-18/29_series/29565/1c29dadab94c3fa552d270434db09c81_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a48898a8086a7c12abed589a9193133a564f699ec811743576f21f42334c3602 +size 36172 diff --git a/raw/rel-18/29_series/29565/27c9c38b326b85de631d54a9ff1e2bd4_img.jpg b/raw/rel-18/29_series/29565/27c9c38b326b85de631d54a9ff1e2bd4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2fd5425e3ba4daf5201a31364a600bc66fc4689f --- /dev/null +++ b/raw/rel-18/29_series/29565/27c9c38b326b85de631d54a9ff1e2bd4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0ce50bb179f580d00ea7bdb7a854e9b624ca64a61ee1a9a89d660e8fc018bac3 +size 11772 diff --git a/raw/rel-18/29_series/29565/2834bdd6eb8540277e609decbb924003_img.jpg b/raw/rel-18/29_series/29565/2834bdd6eb8540277e609decbb924003_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3c0c533006c2f62cffc1d3be0f38ced73735f6d0 --- /dev/null +++ b/raw/rel-18/29_series/29565/2834bdd6eb8540277e609decbb924003_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f14c1caee1e46d8e6106fdcc982c420c3b2af289a260eb97ebaaba34f7884a2d +size 28780 diff --git a/raw/rel-18/29_series/29565/329c96049bb432e9c2cbda4e224a0c9c_img.jpg b/raw/rel-18/29_series/29565/329c96049bb432e9c2cbda4e224a0c9c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..385e8827235a2bced38379a1db34cab2029a55e7 --- /dev/null +++ b/raw/rel-18/29_series/29565/329c96049bb432e9c2cbda4e224a0c9c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2042255c40ab90da2c8a303359a7fb4ffb6dc88b264b0307ca710446b3d65669 +size 33831 diff --git a/raw/rel-18/29_series/29565/40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg b/raw/rel-18/29_series/29565/40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dcbd300bbd8540951e0a87e3bfb553be0ccb6f54 --- /dev/null +++ b/raw/rel-18/29_series/29565/40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2156e182400927e9ca3a4ec838a607774d5570ca259d716d0f40705c72870b26 +size 36941 diff --git a/raw/rel-18/29_series/29565/414cf5c0e2959c558de57a9fb5c2134a_img.jpg b/raw/rel-18/29_series/29565/414cf5c0e2959c558de57a9fb5c2134a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cb8b795d294542a4cd8b686633eb39a5f1b7ac21 --- /dev/null +++ b/raw/rel-18/29_series/29565/414cf5c0e2959c558de57a9fb5c2134a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:33f2095188eb970f104e702b5c27e39ed2f6423f43e814d4d41247ae6e36de7b +size 33243 diff --git a/raw/rel-18/29_series/29565/4842f073775fb1e84d101c02fd74e59e_img.jpg b/raw/rel-18/29_series/29565/4842f073775fb1e84d101c02fd74e59e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..65190b8d70a6d1b6f1a26f3a475307205446dc3f --- /dev/null +++ b/raw/rel-18/29_series/29565/4842f073775fb1e84d101c02fd74e59e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:28a5059a32ebd5de1a7b2149c1dd33180f9296889c8209648cb52b6888ec9fea +size 33048 diff --git a/raw/rel-18/29_series/29565/4b8c5ecb492fd759c766fe8950fafe67_img.jpg b/raw/rel-18/29_series/29565/4b8c5ecb492fd759c766fe8950fafe67_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eec69620c50fa65fcfced091d83d658e38cf4983 --- /dev/null +++ b/raw/rel-18/29_series/29565/4b8c5ecb492fd759c766fe8950fafe67_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a341360e5fbeab2ad106f4cd1909ee0884b6e8d4616ff793c669989d2ce0e9bc +size 34179 diff --git a/raw/rel-18/29_series/29565/4cd9eeaee1deb05bf88a8abf02ff7d7f_img.jpg b/raw/rel-18/29_series/29565/4cd9eeaee1deb05bf88a8abf02ff7d7f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..58a0f69a81d287dfe15c79be8b05b6fbce6e165a --- /dev/null +++ b/raw/rel-18/29_series/29565/4cd9eeaee1deb05bf88a8abf02ff7d7f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:06455066b7e4a1883c5b86a23c43ff1ad12d0c1c4510ac55ae00bea5dfbe7723 +size 30351 diff --git a/raw/rel-18/29_series/29565/56a5265d174ce056c1dbe5e7a60839fc_img.jpg b/raw/rel-18/29_series/29565/56a5265d174ce056c1dbe5e7a60839fc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c4979d3ffd853acb29be336e7e67a334a09eae8d --- /dev/null +++ b/raw/rel-18/29_series/29565/56a5265d174ce056c1dbe5e7a60839fc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7190a4eff2ee32ebd570006b7aaa81f82164c67e34ed3648fd2cccef35476da5 +size 30995 diff --git a/raw/rel-18/29_series/29565/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29565/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2507a0a06d6de15a0d4b726acbf7d1c3eb87e602 --- /dev/null +++ b/raw/rel-18/29_series/29565/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bfaa744bd6522efadb5eeb6f7442a7091a3c4e68da887a07c8b1cb9dc8a1e266 +size 9482 diff --git a/raw/rel-18/29_series/29565/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29565/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..efefb731eb72ad3a11bf625c5ba65d1462017e29 --- /dev/null +++ b/raw/rel-18/29_series/29565/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d280e808d63407d5e9f7e5bb26b788743d737260b056bef379c57335f8e99c10 +size 5492 diff --git a/raw/rel-18/29_series/29565/65e8c0628536d6d4245e9ab46ba070c3_img.jpg b/raw/rel-18/29_series/29565/65e8c0628536d6d4245e9ab46ba070c3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e7fcd8982736ec8cc0d246b4a36a4719dfdbb73f --- /dev/null +++ b/raw/rel-18/29_series/29565/65e8c0628536d6d4245e9ab46ba070c3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1d5995897e672c880ab1b91b88e28cc37ce7144d9b1235ecc1097d5ab7a28864 +size 32406 diff --git a/raw/rel-18/29_series/29565/6f659142d4789aa889184459f884787e_img.jpg b/raw/rel-18/29_series/29565/6f659142d4789aa889184459f884787e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d3dbcc2810ae33f1cba46ad7ae01b2d8ab5f85f6 --- /dev/null +++ b/raw/rel-18/29_series/29565/6f659142d4789aa889184459f884787e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9b08276f36c5ff08586077aa435a62e0ead776c98080b0befbe6123c88241846 +size 21942 diff --git a/raw/rel-18/29_series/29565/8e80de0cac529b2c3775d677c5203133_img.jpg b/raw/rel-18/29_series/29565/8e80de0cac529b2c3775d677c5203133_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..93b90947a51999ba24a43e39dc18c6c513a51748 --- /dev/null +++ b/raw/rel-18/29_series/29565/8e80de0cac529b2c3775d677c5203133_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:82ba30793a301b46b9ea7854675dc668731aace112e56886884ab7ba916e6d78 +size 36175 diff --git a/raw/rel-18/29_series/29565/9e4f582a5d5f6742d1372956db0f8f0b_img.jpg b/raw/rel-18/29_series/29565/9e4f582a5d5f6742d1372956db0f8f0b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f823500e3c1a37170205c6328ff3e22650788c97 --- /dev/null +++ b/raw/rel-18/29_series/29565/9e4f582a5d5f6742d1372956db0f8f0b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:317c48f054d9d51b68cec873897a66888c483785cba7c3a993525853fdb7fb7a +size 35787 diff --git a/raw/rel-18/29_series/29565/a003ffe7299e0a48bceb7f1e45a4f1a3_img.jpg b/raw/rel-18/29_series/29565/a003ffe7299e0a48bceb7f1e45a4f1a3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..079c5655748f3cd42ce56fcf870e21303f0827b5 --- /dev/null +++ b/raw/rel-18/29_series/29565/a003ffe7299e0a48bceb7f1e45a4f1a3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5f56fa4adac1b2db5267ca88dcc4b67ec451fbc483cf97eed146f7eb88478ae0 +size 29060 diff --git a/raw/rel-18/29_series/29565/a26e142d3df5bef41a84a9dd099d7825_img.jpg b/raw/rel-18/29_series/29565/a26e142d3df5bef41a84a9dd099d7825_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bd28acde38359d69a530bd14a88265de311abebc --- /dev/null +++ b/raw/rel-18/29_series/29565/a26e142d3df5bef41a84a9dd099d7825_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eca3e99caa1d439f3c7b9747d7c430ba66577f037ed725d7d42857318e438811 +size 8916 diff --git a/raw/rel-18/29_series/29565/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/raw/rel-18/29_series/29565/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..772a064d714684db45f8a114f62f8a23f3219610 --- /dev/null +++ b/raw/rel-18/29_series/29565/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:532db5a208267f44d28af793e267a4ca5e16065f4b502192ff55582b0197243c +size 13658 diff --git a/raw/rel-18/29_series/29565/b5335262987c819d7f71ce40f99cb71b_img.jpg b/raw/rel-18/29_series/29565/b5335262987c819d7f71ce40f99cb71b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..045f22f6806ab1069f77adc1dbf3bf16fd56ecd3 --- /dev/null +++ b/raw/rel-18/29_series/29565/b5335262987c819d7f71ce40f99cb71b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c52ceb46f60491b18cc926c1ef2ef68d1ddd67699b71381b8d239832e546ed8c +size 29071 diff --git a/raw/rel-18/29_series/29565/be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg b/raw/rel-18/29_series/29565/be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..28a07b3aae14f009d7180b47a15365896534fabe --- /dev/null +++ b/raw/rel-18/29_series/29565/be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f0f681108469310bf803082b7cfc9e2c9e79f78f404b6e704fd8baa0809a2fee +size 30441 diff --git a/raw/rel-18/29_series/29565/da85343976fdbb19f866d9ddbdad0eae_img.jpg b/raw/rel-18/29_series/29565/da85343976fdbb19f866d9ddbdad0eae_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7161d7d4f6266fd2a3e3a1b0fb5dc2442330a90e --- /dev/null +++ b/raw/rel-18/29_series/29565/da85343976fdbb19f866d9ddbdad0eae_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fb3f1d33d67b6a4e6566b25cc607d9a1704ed460070e349cee007b4a3d23ea91 +size 22534 diff --git a/raw/rel-18/29_series/29565/e636d7ccca0ad14c6b95201404324823_img.jpg b/raw/rel-18/29_series/29565/e636d7ccca0ad14c6b95201404324823_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7e1850b131d98041e8b4d85eabf2b26fca4c0d47 --- /dev/null +++ b/raw/rel-18/29_series/29565/e636d7ccca0ad14c6b95201404324823_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fc47cf931de9f23b67f9a53e330894ab09953cd9c3f02fdbc4910298e5af267b +size 34241 diff --git a/raw/rel-18/29_series/29565/f1fbb1287d999c7034742de35bdab836_img.jpg b/raw/rel-18/29_series/29565/f1fbb1287d999c7034742de35bdab836_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..62be640831e6e4019d6fbd272ee06c4071165b47 --- /dev/null +++ b/raw/rel-18/29_series/29565/f1fbb1287d999c7034742de35bdab836_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f522708bdd0c4a1cc66e09929b934f55d3c5f954e86dd46308b7c69d35b89651 +size 37349 diff --git a/raw/rel-18/29_series/29565/fcc757566216206ceddbd6c775e8db02_img.jpg b/raw/rel-18/29_series/29565/fcc757566216206ceddbd6c775e8db02_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d3d56a92586357c00860ba3f183e385d041cf837 --- /dev/null +++ b/raw/rel-18/29_series/29565/fcc757566216206ceddbd6c775e8db02_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fc2bd6b7ed0ac2b90fc80931a48e2e3858d15aaf5461cc33949e05ab4c76f6f2 +size 35797 diff --git a/raw/rel-18/29_series/29572/raw.md b/raw/rel-18/29_series/29572/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..9162c8072a73739369486328ae35f7083fb12f73 --- /dev/null +++ b/raw/rel-18/29_series/29572/raw.md @@ -0,0 +1,6110 @@ + + +# 3GPP TS 29.572 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Location Management Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring the text "5G" in a bold, black font with a green signal wave icon above the letter "G". The word "ADVANCED" is written in smaller, black, uppercase letters to the right of the "G". + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The logo for 3GPP, featuring the text "3GPP" in a bold, black font. The letter "P" is stylized with a red signal wave icon below it. Below the logo, the text "A GLOBAL INITIATIVE" is written in smaller, black, uppercase letters. + +3GPP logo + +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. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis + +Valbonne - FRANCE + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------------------|----| +| Foreword ..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions and abbreviations ..... | 10 | +| 3.1 Definitions..... | 10 | +| 3.2 Abbreviations ..... | 10 | +| 4 Overview..... | 11 | +| 5 Services Offered by the LMF..... | 11 | +| 5.1 Introduction ..... | 11 | +| 5.2 Nlmf_Location Service ..... | 12 | +| 5.2.1 Service Description ..... | 12 | +| 5.2.2 Service Operations..... | 12 | +| 5.2.2.1 Introduction..... | 12 | +| 5.2.2.2 DetermineLocation ..... | 12 | +| 5.2.2.2.1 General ..... | 12 | +| 5.2.2.2.2 Retrieve UE Location..... | 12 | +| 5.2.2.2.3 Retrieve UE Location for 5G-MO-LR ..... | 13 | +| 5.2.2.3 EventNotify..... | 14 | +| 5.2.2.3.1 General ..... | 14 | +| 5.2.2.3.2 Periodic or Triggered Event Notification ..... | 14 | +| 5.2.2.3.3 Intermediate location reporting Event Notification ..... | 15 | +| 5.2.2.4 CancelLocation ..... | 16 | +| 5.2.2.4.1 General ..... | 16 | +| 5.2.2.4.2 Cancel Periodic or Triggered Location ..... | 16 | +| 5.2.2.5 LocationContextTransfer..... | 16 | +| 5.2.2.5.1 General ..... | 16 | +| 5.2.2.5.2 Transfer Location Context ..... | 16 | +| 5.2.2.6 MeasurementData ..... | 17 | +| 5.2.2.6.1 General ..... | 17 | +| 5.2.2.6.2 Location Measurements ..... | 17 | +| 5.2.2.7 UPSubscribe..... | 18 | +| 5.2.2.7.1 General ..... | 18 | +| 5.2.2.7.2 Subscribe to Notification of LCS-UP connection ..... | 18 | +| 5.2.2.8 UPNotify..... | 18 | +| 5.2.2.8.1 General ..... | 18 | +| 5.2.2.8.2 Notification of LCS-UP connection ..... | 18 | +| 5.2.2.9 UPConfig ..... | 19 | +| 5.2.2.9.1 General ..... | 19 | +| 5.2.2.9.2 Set up LCS-UP connection ..... | 19 | +| 5.3 Nlmf_Broadcast Service ..... | 20 | +| 5.3.1 Service Description ..... | 20 | +| 5.3.2 Service Operations..... | 20 | +| 5.3.2.1 Introduction..... | 20 | +| 5.3.2.2 CipheringKeyData ..... | 20 | +| 5.3.2.2.1 General ..... | 20 | +| 5.3.2.2.2 Request Ciphering Key Information ..... | 20 | +| 5.3.2.2.3 Provide Ciphering Key Information..... | 21 | +| 6 API Definitions ..... | 21 | +| 6.1 Nlmf_Location Service API..... | 21 | +| 6.1.1 API URI..... | 21 | +| 6.1.2 Usage of HTTP..... | 22 | +| 6.1.2.1 General..... | 22 | +| 6.1.2.2 HTTP Standard Headers ..... | 22 | + +| | | | +|------------|----------------------------------------------------------|----| +| 6.1.2.2.1 | General ..... | 22 | +| 6.1.2.2.2 | Content type ..... | 22 | +| 6.1.2.3 | HTTP custom headers..... | 22 | +| 6.1.2.3.1 | General ..... | 22 | +| 6.1.2.4 | HTTP multipart messages..... | 23 | +| 6.1.3 | Resources..... | 23 | +| 6.1.3.1 | Overview..... | 23 | +| 6.1.4 | Custom Operations without associated resources ..... | 24 | +| 6.1.4.1 | Overview..... | 24 | +| 6.1.4.2 | Operation: determine-location ..... | 24 | +| 6.1.4.2.1 | Description ..... | 24 | +| 6.1.4.2.2 | Operation Definition ..... | 24 | +| 6.1.4.3 | Operation: cancel-location..... | 26 | +| 6.1.4.3.1 | Description ..... | 26 | +| 6.1.4.3.2 | Operation Definition ..... | 26 | +| 6.1.4.4 | Operation: location-context-transfer..... | 27 | +| 6.1.4.4.1 | Description ..... | 27 | +| 6.1.4.4.2 | Operation Definition ..... | 27 | +| 6.1.4.5 | Operation: location-measure..... | 28 | +| 6.1.4.5.1 | Description ..... | 28 | +| 6.1.4.5.2 | Operation Definition ..... | 28 | +| 6.1.4.6 | Operation: up-subscription ..... | 29 | +| 6.1.4.6.1 | Description ..... | 29 | +| 6.1.4.6.2 | Operation Definition ..... | 29 | +| 6.1.4.7 | Operation: up-configure..... | 30 | +| 6.1.4.7.1 | Description ..... | 30 | +| 6.1.4.7.2 | Operation Definition ..... | 30 | +| 6.1.5 | Notifications ..... | 31 | +| 6.1.5.1 | EventNotify..... | 32 | +| 6.1.5.1.1 | Description ..... | 32 | +| 6.1.5.1.2 | Notification Definition ..... | 32 | +| 6.1.5.1.3 | Notification Standard Methods ..... | 32 | +| 6.1.5.2 | UPNNotify ..... | 33 | +| 6.1.5.2.1 | Description ..... | 33 | +| 6.1.5.2.2 | Notification Definition ..... | 33 | +| 6.1.5.2.3 | Notification Standard Methods ..... | 33 | +| 6.1.6 | Data Model ..... | 34 | +| 6.1.6.1 | General..... | 34 | +| 6.1.6.2 | Structured data types..... | 38 | +| 6.1.6.2.1 | Introduction ..... | 38 | +| 6.1.6.2.2 | Type: InputData..... | 39 | +| 6.1.6.2.3 | Type: LocationData..... | 44 | +| 6.1.6.2.4 | Type: GeographicalCoordinates..... | 47 | +| 6.1.6.2.5 | Type: GeographicArea ..... | 47 | +| 6.1.6.2.6 | Type: Point..... | 47 | +| 6.1.6.2.7 | Type: PointUncertaintyCircle ..... | 48 | +| 6.1.6.2.8 | Type: PointUncertaintyEllipse ..... | 48 | +| 6.1.6.2.9 | Type: Polygon ..... | 48 | +| 6.1.6.2.10 | Type: PointAltitude ..... | 48 | +| 6.1.6.2.11 | Type: PointAltitudeUncertainty ..... | 49 | +| 6.1.6.2.12 | Type: EllipsoidArc ..... | 49 | +| 6.1.6.2.13 | Type: LocationQoS ..... | 50 | +| 6.1.6.2.14 | Type: CivicAddress..... | 51 | +| 6.1.6.2.15 | Type: PositioningMethodAndUsage ..... | 53 | +| 6.1.6.2.16 | Type: GnssPositioningMethodAndUsage ..... | 54 | +| 6.1.6.2.17 | Type: VelocityEstimate ..... | 54 | +| 6.1.6.2.18 | Type: HorizontalVelocity..... | 54 | +| 6.1.6.2.19 | Type: HorizontalWithVerticalVelocity..... | 54 | +| 6.1.6.2.20 | Type: HorizontalVelocityWithUncertainty ..... | 55 | +| 6.1.6.2.21 | Type: HorizontalWithVerticalVelocityAndUncertainty ..... | 55 | +| 6.1.6.2.22 | Type: UncertaintyEllipse..... | 55 | +| 6.1.6.2.23 | Type: UeLcsCapability ..... | 55 | + +| | | | +|------------|------------------------------------------------|----| +| 6.1.6.2.24 | Type: PeriodicEventInfo ..... | 56 | +| 6.1.6.2.25 | Type: AreaEventInfo ..... | 57 | +| 6.1.6.2.26 | Type: ReportingArea ..... | 57 | +| 6.1.6.2.27 | Type: MotionEventInfo ..... | 58 | +| 6.1.6.2.28 | Void ..... | 58 | +| 6.1.6.2.29 | Type: CancelLocData ..... | 58 | +| 6.1.6.2.30 | Type: LocContextData ..... | 59 | +| 6.1.6.2.31 | Type: EventReportMessage ..... | 60 | +| 6.1.6.2.32 | Type: EventReportingStatus ..... | 60 | +| 6.1.6.2.33 | Type: UELocationInfo ..... | 60 | +| 6.1.6.2.34 | Type: EventNotifyData ..... | 61 | +| 6.1.6.2.35 | Type: UeConnectivityState ..... | 64 | +| 6.1.6.2.36 | Type: LocalOrigin ..... | 64 | +| 6.1.6.2.37 | Type: RelativeCartesianLocation ..... | 64 | +| 6.1.6.2.38 | Type: Local2dPointUncertaintyEllipse ..... | 65 | +| 6.1.6.2.39 | Type: Local3dPointUncertaintyEllipsoid ..... | 65 | +| 6.1.6.2.40 | Type: UncertaintyEllipsoid ..... | 65 | +| 6.1.6.2.41 | Type: LocalArea ..... | 66 | +| 6.1.6.2.42 | Type: UeAreaIndication ..... | 66 | +| 6.1.6.2.43 | Type: MinorLocationQoS ..... | 66 | +| 6.1.6.2.44 | Type: MbsrInfo ..... | 66 | +| 6.1.6.2.45 | Type: LocMeasurementReq ..... | 67 | +| 6.1.6.2.46 | Type: LocMeasurementResp ..... | 67 | +| 6.1.6.2.47 | Type: LocMeasurements ..... | 67 | +| 6.1.6.2.48 | Type: HighAccuracyGnssMetrics ..... | 68 | +| 6.1.6.2.49 | Type: UpNotifyData ..... | 68 | +| 6.1.6.2.50 | Type: UpSubscription ..... | 68 | +| 6.1.6.2.52 | Type: UpConfig ..... | 69 | +| 6.1.6.2.58 | Type: LocationDataExt ..... | 70 | +| 6.1.6.2.59 | Type: EventNotifyDataExt ..... | 70 | +| 6.1.6.2.60 | Type: MappedLocationQoSEps ..... | 70 | +| 6.1.6.2.61 | Type: AdditionalUeInfo ..... | 70 | +| 6.1.6.3 | Simple data types and enumerations ..... | 71 | +| 6.1.6.3.1 | Introduction ..... | 71 | +| 6.1.6.3.2 | Simple data types ..... | 71 | +| 6.1.6.3.3 | Enumeration: ExternalClientType ..... | 74 | +| 6.1.6.3.4 | Enumeration: SupportedGADShapes ..... | 75 | +| 6.1.6.3.5 | Enumeration: ResponseTime ..... | 75 | +| 6.1.6.3.6 | Enumeration: PositioningMethod ..... | 76 | +| 6.1.6.3.7 | Enumeration: PositioningMode ..... | 76 | +| 6.1.6.3.8 | Enumeration: GnssId ..... | 77 | +| 6.1.6.3.9 | Enumeration: Usage ..... | 77 | +| 6.1.6.3.10 | Enumeration: LcsPriority ..... | 77 | +| 6.1.6.3.11 | Enumeration: VelocityRequested ..... | 77 | +| 6.1.6.3.12 | Enumeration: AccuracyFulfilmentIndicator ..... | 78 | +| 6.1.6.3.13 | Enumeration: VerticalDirection ..... | 78 | +| 6.1.6.3.14 | Enumeration: LdrType ..... | 78 | +| 6.1.6.3.15 | Enumeration: ReportingAreaType ..... | 78 | +| 6.1.6.3.16 | Enumeration: OccurrenceInfo ..... | 78 | +| 6.1.6.3.17 | Enumeration: ReportingAccessType ..... | 79 | +| 6.1.6.3.18 | Enumeration: EventClass ..... | 79 | +| 6.1.6.3.19 | Enumeration: ReportedEventType ..... | 79 | +| 6.1.6.3.20 | Enumeration: TerminationCause ..... | 80 | +| 6.1.6.3.21 | Enumeration: LcsQosClass ..... | 80 | +| 6.1.6.3.22 | Enumeration: UeLocationServiceInd ..... | 80 | +| 6.1.6.3.23 | Enumeration: IndoorOutdoorInd ..... | 80 | +| 6.1.6.3.24 | Enumeration: FixType ..... | 80 | +| 6.1.6.3.25 | Enumeration: LosNlosMeasureInd ..... | 80 | +| 6.1.6.3.26 | Enumeration: UpConnectionStatus ..... | 80 | +| 6.1.6.3.27 | Enumeration: RangingSIResult ..... | 81 | +| 6.1.6.3.28 | Enumeration: RelatedUETYPE ..... | 81 | +| 6.1.6.3.29 | Enumeration: LcsUpConnectionInd ..... | 81 | + +| | | | +|------------|------------------------------------------------------|----| +| 6.1.6.3.30 | Enumeration: UeUpPositioningCapabilities ..... | 82 | +| 6.1.6.4 | Binary data ..... | 82 | +| 6.1.6.4.1 | Introduction ..... | 82 | +| 6.1.6.4.2 | LPP Message ..... | 82 | +| 6.1.7 | Error Handling ..... | 82 | +| 6.1.7.1 | General ..... | 82 | +| 6.1.7.2 | Protocol Errors ..... | 82 | +| 6.1.7.3 | Application Errors ..... | 82 | +| 6.1.8 | Security ..... | 83 | +| 6.1.9 | Feature Negotiation ..... | 83 | +| 6.1.10 | HTTP redirection ..... | 84 | +| 6.2 | Nlmf_Broadcast Service API ..... | 84 | +| 6.2.1 | API URI ..... | 84 | +| 6.2.2 | Usage of HTTP ..... | 85 | +| 6.2.2.1 | General ..... | 85 | +| 6.2.2.2 | HTTP Standard Headers ..... | 85 | +| 6.2.2.2.1 | General ..... | 85 | +| 6.2.2.2.2 | Content type ..... | 85 | +| 6.2.2.3 | HTTP custom headers ..... | 85 | +| 6.2.2.3.1 | General ..... | 85 | +| 6.2.3 | Resources ..... | 85 | +| 6.2.3.1 | Overview ..... | 85 | +| 6.2.4 | Custom Operations without associated resources ..... | 86 | +| 6.2.4.1 | Overview ..... | 86 | +| 6.2.4.4 | Operation: cipher-key-data ..... | 86 | +| 6.2.4.4.1 | Description ..... | 86 | +| 6.2.4.4.2 | Operation Definition ..... | 86 | +| 6.2.5 | Notifications ..... | 87 | +| 6.2.5.1 | CipheringKeyData ..... | 87 | +| 6.2.5.1.1 | Description ..... | 87 | +| 6.2.5.1.2 | Notification Definition ..... | 87 | +| 6.2.5.1.3 | Notification Standard Methods ..... | 87 | +| 6.2.6 | Data Model ..... | 88 | +| 6.2.6.1 | General ..... | 88 | +| 6.2.6.2 | Structured data types ..... | 89 | +| 6.2.6.2.1 | Introduction ..... | 89 | +| 6.2.6.2.2 | Type: CipheringKeyInfo ..... | 89 | +| 6.2.6.2.3 | Type: CipheringKeyResponse ..... | 90 | +| 6.2.6.2.4 | Type: CipheringDataSet ..... | 91 | +| 6.2.6.2.5 | Type: CipheringSetReport ..... | 96 | +| 6.2.6.2.6 | Type: CipherRequestData ..... | 97 | +| 6.2.6.2.7 | Type: CipherResponseData ..... | 97 | +| 6.2.6.3 | Simple data types and enumerations ..... | 97 | +| 6.2.6.3.1 | Introduction ..... | 97 | +| 6.2.6.3.2 | Simple data types ..... | 97 | +| 6.2.6.3.3 | Enumeration: StorageOutcome ..... | 97 | +| 6.2.6.3.4 | Enumeration: DataAvailability ..... | 97 | +| 6.2.7 | Error Handling ..... | 98 | +| 6.2.7.1 | General ..... | 98 | +| 6.2.7.2 | Protocol Errors ..... | 98 | +| 6.2.7.3 | Application Errors ..... | 98 | +| 6.2.8 | Security ..... | 98 | +| 6.2.9 | Feature Negotiation ..... | 98 | +| 6.2.10 | HTTP redirection ..... | 99 | + +| | | | +|-------------------------------|------------------------------------|------------| +| Annex A (normative): | OpenAPI specification ..... | 99 | +| A.1 | General ..... | 99 | +| A.2 | Nlmf_Location API..... | 99 | +| A.3 | Nlmf_Broadcast API..... | 128 | +| Annex B (informative): | Change history ..... | 132 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +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: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +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. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +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. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- 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 +- 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 +- 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 + +**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 + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nlmf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the LMF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +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]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- 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*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] IETF RFC 4776: "Dynamic Host Configuration Protocol (DHCPv4 and DHCPv6) Option for Civic Addresses Configuration Information". +- [7] IETF RFC 5139: "Revised Civic Location Format for Presence Information Data Format Location Object (PIDF-LO)". +- [8] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [9] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [10] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [11] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [12] IETF RFC 9113: "HTTP/2". +- [13] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". + +- [14] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0", . +- [15] IETF RFC 9457: "Problem Details for HTTP APIs". +- [16] 3GPP TR 21.900: "Technical Specification Group working methods". +- [17] 3GPP TS 22.071: "Location Services (LCS); Service description; Stage 1". +- [18] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [19] 3GPP TS 23.273: "5G System (5GS) Location Services (LCS); Stage 2". +- [20] 3GPP TS 24.080: "Mobile radio interface layer 3 Supplementary services specification; Formats and coding". +- [21] 3GPP TS 37.355: " LTE Positioning Protocol (LPP)". +- [22] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [23] 3GPP TS 29.518: "Access and Mobility Management Services". +- [24] 3GPP TS 29.171: "Location Services (LCS); LCS Application Protocol (LCS-AP) between the Mobile Management Entity (MME) and Evolved Serving Mobile Location Centre (E-SMLC); SLs interface". +- [25] IETF RFC 4119: "A Presence-based GEOPRIV Location Object Format". +- [26] 3GPP TS 33.256: "Security aspects of Uncrewed Aerial Systems (UAS)". +- [27] 3GPP TS 29.515: "5G System; Gateway Mobile Location Services Stage 3". +- [28] 3GPP TS 29.515: "5G System; Gateway Mobile Location Services Stage 3". +- [29] 3GPP TS 29.122: "T8 reference point for Northbound APIs". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +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]. + +## 3.2 Abbreviations + +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]. + +| | | +|-------|-----------------------------------------| +| LDR | Location Deferred Request | +| LIR | Location Immediate Request | +| LMF | Location Management Function | +| LPHAP | Low Power and High Accuracy Positioning | + +# 4 Overview + +The Location Management Function (LMF) is the network entity in the 5G Core Network (5GC) supporting the following functionality: + +- Supports location determination for a UE. +- Obtains downlink location measurements or a location estimate from the UE. +- Obtains uplink location measurements from the NG RAN. +- Obtains non-UE associated assistance data from the NG RAN. +- Provides broadcast assistance data to UEs and forwards associated ciphering keys to an AMF. + +Other functions of an LMF are listed in clause 4.3.8 of 3GPP TS 23.273 [19]. + +Figure 4-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the LMF: + +![Figure 4-1: Reference model – LMF. The diagram shows two network functions, LMF and AMF, connected to a central LMF entity. The LMF on the left is connected via the NL7 interface to the central LMF. The AMF on the left is connected via the NL1 interface to the central LMF. The central LMF is represented by a large rectangle with a small circle on its left side, labeled Nlmf, indicating a service based interface.](c78c2eefd86269d1740ab85a916f24f2_img.jpg) + +Figure 4-1: Reference model – LMF. The diagram shows two network functions, LMF and AMF, connected to a central LMF entity. The LMF on the left is connected via the NL7 interface to the central LMF. The AMF on the left is connected via the NL1 interface to the central LMF. The central LMF is represented by a large rectangle with a small circle on its left side, labeled Nlmf, indicating a service based interface. + +Figure 4-1: Reference model – LMF + +# 5 Services Offered by the LMF + +## 5.1 Introduction + +The LMF offers to other NFs the following services: + +- Nlmf\_Location +- Nlmf\_Broadcast + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|----------------|--------|-----------------------|-----------------------------|----------------|-------| +| Nlmf_Location | 6.1 | LMF Location Service | TS29572_Nlmf_Location.yaml | nlmf-loc | A.2 | +| Nlmf_Broadcast | 6.2 | LMF Broadcast Service | TS29572_Nlmf_Broadcast.yaml | nlmf-broadcast | A.3 | + +## 5.2 Nlmf\_Location Service + +### 5.2.1 Service Description + +The Nlmf\_Location service enables an NF to request location determination (current geodetic and optionally local and/or civic location) for a target UE or to request periodic or triggered location for a target UE. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The service operations defined for the Nlmf\_Location service are as follows: + +- DetermineLocation: It provides UE location information to the consumer NF. +- EventNotify: It notifies the consumer NF of an event for periodic or triggered location for a target UE, or cumulative event report for the location reporting over user plane from the UE. +- CancelLocation: It enables a consumer NF to cancel an ongoing periodic or triggered location for a target UE. +- LocationContextTransfer: It enables a consumer NF to transfer location context information for periodic or triggered location of a target UE to a new LMF. +- MeasurementData: It enables a consumer NF to request the PRU location measurements from PRU serving LMFs. +- UPSubscribe: It enables a consumer NF to subscribe about status of a secure LCS-UP connection for a target UE. +- UPNotify: It notifies the consumer NF of the status or modification of a secure LCS-UP connection for a target UE. +- UPConfig: It enables a consumer NF to set up, modify or terminate a secure LCS-UP connection for a target UE. + +#### 5.2.2.2 DetermineLocation + +##### 5.2.2.2.1 General + +The following procedures are defined, using the "DetermineLocation" service operation: + +- Retrieve UE Location +- Retrieve UE Location for 5G-MO-LR +- Retrieve UE Location for Ranging and Sidelink Positioning + +##### 5.2.2.2.2 Retrieve UE Location + +This procedure allows a consumer NF to request the location information (geodetic location and, optionally, local and/or civic location) for a target UE or to activate periodic or triggered deferred location for a target UE. + +![Sequence diagram showing the DetermineLocation Request procedure between an NF Service Consumer and an LMF. The NF Service Consumer sends a POST request to the LMF. The LMF responds with either a 200 OK (LocationData) or a 4xx/5xx (ProblemDetails) or 3xx status code.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: 1. POST ../determine-location (InputData) + NF Service Consumer->>LMF: 1. POST ../determine-location (InputData) + Note right of LMF: 2a. 200 OK (LocationData) + Note right of LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + LMF-->>NF Service Consumer: 2a. 200 OK (LocationData) + LMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the DetermineLocation Request procedure between an NF Service Consumer and an LMF. The NF Service Consumer sends a POST request to the LMF. The LMF responds with either a 200 OK (LocationData) or a 4xx/5xx (ProblemDetails) or 3xx status code. + +**Figure 5.2.2.2.2-1: DetermineLocation Request** + +1. The NF Service Consumer shall send an HTTP POST request to the resource URI associated with the "determine-location" custom operation. The input parameters for the request (external client type, LCS correlation identifier, serving cell identifier, location QoS, mapped location QoS applicable to EPS, supported GAD shapes, LDR Type, H-GMLC address, LDR Reference, UE connectivity state per access type, TNAP identifier, TWAP identifier, scheduled location time, LpHapType, UE User Plane Positioning Capability, reporting indication, MBSR Info, Additional UE Info, integrity requirements, requested ranging\_SL location results, related UEs ...) may be included in the HTTP POST request body; + +If UE geographical area identified by the country, area within a country or international area needs to be determined, the NF Service Consumer shall include UE geographical area determination indication for PLMN selection verification in the request; + +If UE Unaware Positioning is required, the NF Service Consumer shall include UE unaware indication in the request; + +If UE LCS Capability is received in the request indicating LPP is not supported by the UE, the LMF shall not send LPP messages to the UE in subsequent positioning procedures. + +During 5GC-MT-LR multiple location procedure for regulatory location service, the AMF shall also include the indication of acceptance for intermediate response and the maximum response time, the GMLC callback address and the LIR reference number, if received from the GMLC. The AMF may overwrite the received maximum response time (e.g. to avoid HTTP service request timeout) when passing it to the LMF. + +For deferred periodic or triggered 5GC-MT-LR procedures, if the NF Service Consumer requests the location reporting over user plane, the NF Service Consumer shall include the endpoint address of the location reporting over user plane, the cumulative event report timer, or the maximum number of location reports over user plane. + +- 2a. On success, "200 OK" shall be returned. The response body shall contain the parameters related to the determined position of the UE if any (geodetic position, local location, civic location, positioning methods, LOS/NLOS measurement indication, ...); + +If the NF service consumer has requested to determine UE country, area within a country or international area, the LMF shall also include ueAreaInd. + +If the indication of acceptance for intermediate response was received in the request, the LMF shall perform positioning procedures and determines multiple location estimates within the maximum response time. The LMF shall include the FINAL location in the content of this response message. If any intermediate location(s) are determined, the LMF shall send intermediate location reporting event notification(s) to the GMLC (see clause 5.2.2.3.3). + +During deferred periodic or triggered 5GC-MT-LR procedures, if the mapped location QoS applicable to EPS was received in the request and if the access type allowed for the UE for event reporting includes "E-UTRAN connected to EPC", the LMF shall forward the mapped location QoS applicable to EPS to the UE. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.4.2.2-2. + +##### 5.2.2.2.3 Retrieve UE Location for 5G-MO-LR + +This procedure allows a consumer NF (i.e. an AMF) to request the location information or location assistance data for a target UE which initiates MO-LR procedure (see 3GPP TS 23.273 [19]). + +![Sequence diagram showing the DetermineLocation Request for 5G-MO-LR. The NF Service Consumer sends a POST .../determine-location (InputData) request to the LMF. The LMF responds with 2a. 200 OK (LocationDataExt) or 204 No Content, and 2b. 4xx/5xx (ProblemDetails) or 3xx.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: + NF Service Consumer->>LMF: 1. POST .../determine-location (InputData) + Note right of LMF: + LMF-->>NF Service Consumer: 2a. 200 OK (LocationDataExt) or 204 No Content + LMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the DetermineLocation Request for 5G-MO-LR. The NF Service Consumer sends a POST .../determine-location (InputData) request to the LMF. The LMF responds with 2a. 200 OK (LocationDataExt) or 204 No Content, and 2b. 4xx/5xx (ProblemDetails) or 3xx. + +**Figure 5.2.2.2.3-1: DetermineLocation Request for 5G-MO-LR** + +The same requirements in clause 5.2.2.2.2 shall be applied with following modifications: + +1. Same as step 1 of figure 5.2.2.2.2-1, the request body shall include the following additional information: + - The indication received from UE indicating whether a location estimate or location assistance data is required. + - The LPP messages if received in MO-LR Request from UE + - UE's subscribed assistance data for 5GC-MO-LR if received from UDM. +- 2a. Same as step 2a of figure 5.2.2.2.2-1 if a consumer NF requests the location information for a target UE. If a NF consumer requests location assistance data for a target UE and LMF has successfully delivered location assistance data to the UE, 204 No Content shall be returned. +- 2b. Same as step 2b of figure 5.2.2.2.2-1. + +This procedure is also used to retrieve UE Location for Ranging and Sidelink Positioning. + +#### 5.2.2.3 EventNotify + +##### 5.2.2.3.1 General + +The following procedures are defined, using the "EventNotify" service operation: + +- Periodic or Triggered Event Notification + +##### 5.2.2.3.2 Periodic or Triggered Event Notification + +This procedure notifies the NF Service Consumer (i.e. GMLC) about event information related to periodic or triggered location of a target UE. The notification is delivered to: + +- the callback URI of an H-GMLC received (from an AMF) during an earlier DetermineLocation service operation if still available and if the LMF is configured for direct access to the H-GMLC; +- the callback URI of an H-GMLC received (from another LMF) during an earlier LocationContextTransfer service operation if still available and if the LMF is configured for direct access to the H-GMLC; +- the callback URI of an H-GMLC received (from the target UE) in a supplementary services event report if the LMF is configured for direct access to the H-GMLC; + +otherwise (if not available), + +- the callback URI of a V-GMLC registered in the NRF, if the V-GMLC registered to the NRF with notification endpoints for periodic or triggered event notifications; or + +otherwise (if not available), + +- the URI of a V-GMLC locally provisioned in the LMF. + +![Sequence diagram for Figure 5.2.2.3.2-1: EventNotify Request. The diagram shows a request from LMF to NF Service Consumer, followed by a success (2a) or failure (2b) response.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +sequenceDiagram + participant LMF + participant NF Service Consumer + Note left of LMF: 1. POST {hgmlcCallBackURI}(EventNotifyDataExt) + LMF->>NF Service Consumer: 1. POST {hgmlcCallBackURI}(EventNotifyDataExt) + Note right of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>LMF: 2a. 204 No Content + Note right of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +Sequence diagram for Figure 5.2.2.3.2-1: EventNotify Request. The diagram shows a request from LMF to NF Service Consumer, followed by a success (2a) or failure (2b) response. + +**Figure 5.2.2.3.2-1: EventNotify Request** + +1. The LMF shall send a POST request to the GMLC callback URI determined as described above. The request body shall include a notification correlation ID (LDR reference), the UE identification (SUPI and if available GPSI), the type of event and may include a geodetic location, local location, civic location, position methods used, and other available parameters related to the position if any (e.g. Velocity, Altitude etc.), H-GMLC callback URI (if the NF consumer is a V-GMLC), serving LMF identification, LOS/NLOS measurement indication, and the statistics on the location reporting over user plane. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, one of the appropriate HTTP status code listed in Table 6.1.5.1.3.1-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure indicating appropriate additional error information. + +##### 5.2.2.3.3 Intermediate location reporting Event Notification + +This procedure notifies the NF Service Consumer (i.e. GMLC) about event information related to intermediate location of a target UE. The notification is delivered to: + +- the callback URI of the GMLC for multiple location request received (from an AMF) during an earlier DetermineLocation service operation (see clause 5.2.2.2.2). + +![Sequence diagram for Figure 5.2.2.3.3-1: Intermediate location reporting Event Notification Request. The diagram shows a request from LMF to NF Service Consumer, followed by a success (2a) or failure (2b) response.](a7c51c18111139f9aca2805114108565_img.jpg) + +``` +sequenceDiagram + participant LMF + participant NF Service Consumer + Note left of LMF: 1. POST {lirGmlcCallBackURI}(EventNotifyDataExt) + LMF->>NF Service Consumer: 1. POST {lirGmlcCallBackURI}(EventNotifyDataExt) + Note right of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>LMF: 2a. 204 No Content + Note right of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +Sequence diagram for Figure 5.2.2.3.3-1: Intermediate location reporting Event Notification Request. The diagram shows a request from LMF to NF Service Consumer, followed by a success (2a) or failure (2b) response. + +**Figure 5.2.2.3.3-1: Intermediate location reporting Event Notification Request** + +1. The LMF shall send a POST request to the GMLC callback URI determined as described above. The request body shall include the associated LIR reference number, the UE identification (SUPI and if available GPSI), the type of event ("INTERMEDIATE\_EVENT") and the intermediate location of the UE (geodetic location, local location, civic location, position methods used), and other available parameters related to the position if any (e.g. Velocity, Altitude etc.). +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, one of the appropriate HTTP status code listed in Table 6.1.5.1.3.1-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure indicating appropriate additional error information. + +#### 5.2.2.4 CancelLocation + +##### 5.2.2.4.1 General + +The following procedures are defined, using the "CancelLocation" service operation: + +- Cancel Periodic or Triggered Location + +##### 5.2.2.4.2 Cancel Periodic or Triggered Location + +This procedure allows a consumer NF to cancel periodic or triggered location for a target UE. The cancellation is delivered to a resource URI on the serving LMF identified by the serving LMF identification provided to the consumer NF (i.e. AMF) by a V-GMLC or H-GMLC (see 3GPP TS 23.273 [19]). + +![Sequence diagram for CancelLocation Request. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'LMF' on the right. A solid arrow labeled '1. POST {servingLMFURI} (CancelLocData)' points from the consumer to the LMF. From the LMF, two dashed arrows point back to the consumer: '2a. 204 No Content' and '2b. 4xx/5xx (ProblemDetails) or 3xx'.](6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: + NF Service Consumer->>LMF: 1. POST {servingLMFURI} (CancelLocData) + Note right of LMF: + LMF-->>NF Service Consumer: 2a. 204 No Content + LMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +Sequence diagram for CancelLocation Request. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'LMF' on the right. A solid arrow labeled '1. POST {servingLMFURI} (CancelLocData)' points from the consumer to the LMF. From the LMF, two dashed arrows point back to the consumer: '2a. 204 No Content' and '2b. 4xx/5xx (ProblemDetails) or 3xx'. + +**Figure 5.2.2.4.2-1: CancelLocation Request** + +1. The NF Service Consumer shall send an HTTP POST request to the resource URI of "cancel-location" custom operation on the serving LMF. The request body shall include a notification correlation ID (LDR reference) and an H-GMLC callback URI. +- 2a. On success, "204 No content" shall be returned by the LMF. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.4.3.2-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.4.3.2-2. + +#### 5.2.2.5 LocationContextTransfer + +##### 5.2.2.5.1 General + +The following procedures are defined, using the "LocationContextTransfer" service operation: + +- Transfer Location Context + +##### 5.2.2.5.2 Transfer Location Context + +This procedure allows a NF service consumer (e.g. the old LMF) to transfer location context information for periodic or triggered location for a target UE (see clause 6.4 and clause 6.7.2 of 3GPP TS 23.273 [19]). The NF service consumer discovers the service URI of the new LMF by performing a discovery via NRF using: + +- the identification of the LMF received (from an AMF) during an earlier Namf\_Communication\_N1MessageNotify service operation to the consumer NF; +- otherwise (if not available), +- the identification of an LMF locally provisioned in the consumer NF. + +![Sequence diagram for Figure 5.2.2.5.2-1: LocationContextTransfer Request. The diagram shows an NF Service Consumer sending a POST request to an LMF. The request is '1. POST ../location-context-transfer (LocContextData)'. The LMF responds with '2a. 204 No Content' on success or '2b. 4xx/5xx (ProblemDetails) or 3xx' on failure or redirection.](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: 1. POST ../location-context-transfer (LocContextData) + NF Service Consumer->>LMF: Request + Note right of LMF: 2a. 204 No Content + LMF-->>NF Service Consumer: Success Response + Note right of LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + LMF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram for Figure 5.2.2.5.2-1: LocationContextTransfer Request. The diagram shows an NF Service Consumer sending a POST request to an LMF. The request is '1. POST ../location-context-transfer (LocContextData)'. The LMF responds with '2a. 204 No Content' on success or '2b. 4xx/5xx (ProblemDetails) or 3xx' on failure or redirection. + +**Figure 5.2.2.5.2-1: LocationContextTransfer Request** + +1. The NF Service Consumer shall send an HTTP POST request to the Custom operation URI ("/location-context-transfer") on the Service URI discovered as described above. The request body shall include an AMF identity, Deferred location type, Deferred location parameters, Notification Target Address (H-GMLC callback URI), Notification Correlation ID (LDR reference), an embedded event report message and may include an event reporting status, UE location information, scheduled location time and LOS/NLOS measurement indication, and shall include an indication of Control Plane CIoT 5GS Optimisation if N1 message is received from the UE with Control Plane CIoT 5GS Optimisation. If the location context information for periodic or triggered location for a target UE includes the endpoint address of the location reporting over user plane, the NF Service Consumer may include the cumulative event report timer, or the maximum number of location reports over user plane. +- 2a. On success, "204 No content" shall be returned by the LMF. +- 2b. On failure or redirection, one of the HTTP status codes listed in Table 6.1.4.4.2-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.4.4.2-2. + +#### 5.2.2.6 MeasurementData + +##### 5.2.2.6.1 General + +The following procedures are defined, using the "MeasurementData" service operation: + +- Location Measurements + +##### 5.2.2.6.2 Location Measurements + +This procedure allows a consumer NF (e.g. LMF) to request PRU location measurements from PRU serving LMF. + +![Sequence diagram for Figure 5.2.2.6.2-1: DetermineLocation Request. The diagram shows an NF Service Consumer sending a POST request to an LMF. The request is '1. POST ../location-measure (LocMeasurementReq)'. The LMF responds with '2a. 200 OK (LocMeasurementResp)' on success or '2b. 4xx/5xx (ProblemDetails) or 3xx' on failure or redirection.](9b62a616c7a1097c5da57f001ab6dd64_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: 1. POST ../location-measure (LocMeasurementReq) + NF Service Consumer->>LMF: Request + Note right of LMF: 2a. 200 OK (LocMeasurementResp) + LMF-->>NF Service Consumer: Success Response + Note right of LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + LMF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram for Figure 5.2.2.6.2-1: DetermineLocation Request. The diagram shows an NF Service Consumer sending a POST request to an LMF. The request is '1. POST ../location-measure (LocMeasurementReq)'. The LMF responds with '2a. 200 OK (LocMeasurementResp)' on success or '2b. 4xx/5xx (ProblemDetails) or 3xx' on failure or redirection. + +**Figure 5.2.2.6.2-1: DetermineLocation Request** + +1. The NF Service Consumer shall send an HTTP POST request to the resource URI associated with the "location-measure" custom operation. The request body shall include target UE cell ID and may include the Pre-calculated location of target UE. +- 2a. On success, "200 OK" shall be returned. The response body shall contain the parameters related to the location measurements of the PRU and the known location of the associated PRU. + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.4.5.2-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.4.5.2-2. + +#### 5.2.2.7 UPSubscribe + +##### 5.2.2.7.1 General + +The following procedures are defined, using the "UPSubscribe" service operation: + +- Subscribe to Notification of LCS-UP connection + +##### 5.2.2.7.2 Subscribe to Notification of LCS-UP connection + +This procedure allows a consumer NF to subscribe about status of a secure LCS-UP connection for a target UE. + +![Sequence diagram showing the interaction between an NF service consumer and an LMF for subscribing to notifications.](124c6108c63173818afb8ed49521e22d_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant LMF as LMF + Note left of NF: + NF->>LMF: 1. POST.../up-subscription (UpSubscription) + Note right of LMF: + LMF-->>NF: 2a. 204 No Content + Note right of LMF: + LMF-->>NF: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +The diagram illustrates a sequence of interactions between an 'NF service consumer' and an 'LMF'. The consumer sends a '1. POST.../up-subscription (UpSubscription)' request to the LMF. The LMF responds with '2a. 204 No Content' on success or '2b. 4xx/5xx (ProblemDetails) or 3xx' on failure or redirection. + +Sequence diagram showing the interaction between an NF service consumer and an LMF for subscribing to notifications. + +**Figure 5.2.2.7.2-1: NF service consumer subscribes to notifications** + +1. The NF Service Consumer shall send a POST request to the resource URI representing the "up-subscriptions" collection resource. +- 2a. On success, the LMF responds with "204 No Content". +- 2b. On failure or redirection, one of the HTTP status code listed in Table Table 6.1.4.6.2-2 shall be returned. For a 4xx/5xx response, the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table Table 6.1.4.6.2-2. + +#### 5.2.2.8 UPNotify + +##### 5.2.2.8.1 General + +The following procedures are defined, using the "UPNotify" service operation: + +- Notification of LCS-UP connection + +##### 5.2.2.8.2 Notification of LCS-UP connection + +This procedure notifies the NF Service Consumer (i.e. AMF) about status or modification of a secure LCS-UP connection for a target UE. + +![Sequence diagram for UPNotify. The LMF sends a POST {upNotifyCallBackURI}(UpNotifyData) request to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails) or 3xx.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +``` + +sequenceDiagram + participant LMF + participant NF Service Consumer + Note left of LMF: 1. POST {upNotifyCallBackURI}(UpNotifyData) + LMF->>NF Service Consumer: 1. POST {upNotifyCallBackURI}(UpNotifyData) + Note right of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>LMF: 2a. 204 No Content + Note right of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for UPNotify. The LMF sends a POST {upNotifyCallBackURI}(UpNotifyData) request to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails) or 3xx. + +Figure 5.2.2.8.2-1: UPNotify + +1. The LMF shall send a POST request to the upNotify callback URI determined as described above. The request body shall include a notification correlation ID (LDR reference), LCS-UP connection status and may include a target LMF identifier. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, one of the appropriate HTTP status code listed in Table 6.1.5.1.3.1-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure indicating appropriate additional error information. + +#### 5.2.2.9 UPConfig + +##### 5.2.2.9.1 General + +The following procedures are defined, using the "UPConfig" service operation: + +- LCS-UP connection + +##### 5.2.2.9.2 Set up LCS-UP connection + +This procedure allows a consumer NF to set up, modify or terminate a secure LCS-UP connection for a target UE. + +![Sequence diagram for LCS-UP connection. The NF service consumer sends a POST ../up-configure (UpConfig) request to the LMF. The LMF responds with either 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails) or 3xx.](f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant LMF + Note left of NF service consumer: 1. POST ../up-configure (UpConfig) + NF service consumer->>LMF: 1. POST ../up-configure (UpConfig) + Note right of LMF: 2a. 204 No Content + LMF-->>NF service consumer: 2a. 204 No Content + Note right of LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + LMF-->>NF service consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for LCS-UP connection. The NF service consumer sends a POST ../up-configure (UpConfig) request to the LMF. The LMF responds with either 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails) or 3xx. + +Figure 5.2.2.9.2-1: LCS-UP connection + +1. The NF Service Consumer shall send an HTTP POST request to the resource URI associated with the "up-configure" custom operation to set up, modify or terminate LCS-UP connection. +- 2a. On success, "204 No Content" shall be returned if no additional information needs to be returned in the response. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.4.7.2-2 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.4.7.2-2. + +## 5.3 Nlmf\_Broadcast Service + +### 5.3.1 Service Description + +The Nlmf\_Broadcast service enables an NF to obtain ciphering keys and associated parameters applicable to location assistance data that is broadcast to subscribed UEs in ciphered form. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +The service operations defined for the Nlmf\_Broadcast service are as follows: + +- CipheringKeyData: It provides the ciphering key information to the consumer NF. + +#### 5.3.2.2 CipheringKeyData + +##### 5.3.2.2.1 General + +The following procedures are defined, using the "CipheringKeyData" service operation: + +- Request Ciphering Key Information +- Provide Ciphering Key Information + +NOTE: The Request Ciphering Key procedure is included in order to provide a valid context in OpenAPI version 3 for the Provide Ciphering Key Information procedure. The Request Ciphering Key procedure is not used for support of ciphering key transfer in 3GPP TS 23.273 [19] and hence need not be supported by an NF Service Consumer or by an LMF. + +##### 5.3.2.2.2 Request Ciphering Key Information + +This procedure allows a consumer NF to request ciphering key information. + +![Sequence diagram for CipheringKeyData Request showing interaction between NF Service Consumer and LMF.](9a047c6501a487b3f18cfff971bcb33f_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: Request Ciphering Key Information + NF Service Consumer->>LMF: 1. POST .../cipher-key-data (CipherRequestData) + Note right of LMF: Response + LMF-->>NF Service Consumer: 2a. 200 OK (CipherResponseData) + Note right of LMF: Failure/Redirection + LMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +Sequence diagram for CipheringKeyData Request showing interaction between NF Service Consumer and LMF. + +**Figure 5.3.2.2.2-1: CipheringKeyData Request** + +1. The NF Service Consumer shall send an HTTP POST request to the resource URI associated with the "cipher-key-data" custom operation. The request body shall include a notification callback URI. +- 2a. On success, "200 OK" shall be returned. The response body shall indicate whether the LMF has ciphering key data. If the LMF has ciphering key data, the Provide Ciphering Key Information procedure is used to provide the ciphering key data to the NF Service Consumer. +- 2b. On failure or redirection, one of the HTTP status codes listed in Table 6.2.4.4.2-2 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.2.7.3-1. + +##### 5.3.2.2.3 Provide Ciphering Key Information + +This procedure notifies the NF Service Consumer (i.e. AMF) about updated ciphering key information applicable to broadcast of location assistance data in ciphered form to subscribed UEs. The notification is delivered to: + +- the callback URI of an AMF received during an earlier CipheringKeyData request service operation if still available; or +- a callback URI registered in the NRF, if the AMF registered to the NRF with notification endpoints for ciphering key data notifications; + +Otherwise (if not available), + +- an AMF callback URI locally provisioned in the LMF. + +The procedure is invoked by issuing a POST request to the callback URI of the NF Service Consumer. See figure 5.3.2.2.3-1. + +![Sequence diagram showing the interaction between LMF and NF Service Consumer for CipheringKeyData Notify. The LMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 200 OK (CipheringKeyResponse) or a 4xx/5xx (ProblemDetails) or 3xx status code.](608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg) + +``` + +sequenceDiagram + participant LMF + participant NFSC as NF Service Consumer + Note left of LMF: LMF + Note right of NFSC: NF Service Consumer + LMF->>NFSC: 1. POST {amfCallBackURI} (CipheringKeyInfo) + NFSC-->>LMF: 2a. 200 OK (CipheringKeyResponse) + NFSC-->>LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between LMF and NF Service Consumer for CipheringKeyData Notify. The LMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 200 OK (CipheringKeyResponse) or a 4xx/5xx (ProblemDetails) or 3xx status code. + +Figure 5.3.2.2.3-1: CipheringKeyData Notify + +1. The LMF shall send an HTTP POST request to the callback URI for the NF service consumer determined as described above. The request body shall include one or more ciphering keys and for each ciphering key may include a ciphering key value, ciphering key identifier, validity period and set of applicable types of broadcast assistance data. +- 2a. On success or partial success, "200 OK" shall be returned. The response body shall indicate which ciphering key information was successfully stored by the NF service consumer. +- 2b. On failure or redirection to store any ciphering key information, one of the HTTP status codes listed in table 6.2.5.1.3.1-2 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.2.5.1.3.1-2. + +# 6 API Definitions + +## 6.1 Nlmf\_Location Service API + +### 6.1.1 API URI + +The Nlmf\_Location service shall use the Nlmf\_Location API. + +The API URI of the Nlmf\_Location API shall be: + +**{apiRoot}//** + +The request URI 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.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nlmf-loc". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [12], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nlmf\_Location service shall comply with the OpenAPI [14] specification contained in Annex A. + +#### 6.1.2.2 HTTP Standard Headers + +##### 6.1.2.2.1 General + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [13], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [15]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +Multipart messages shall also be supported (see clause 6.1.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one or more binary body parts with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.1.2.2.2-1 shall be supported. + +**Table 6.1.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------| +| vnd.3gpp.lpp | Binary encoded payload, encoding LTE Positioning Protocol (LPP) IEs, as specified in 3GPP TS 37.355 [21]. | +| NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque payload (e.g. LPP information) without having to rely on metadata in the JSON payload. | | + +See clause 6.1.2.4 for the binary payloads supported in the binary body part of multipart messages. + +#### 6.1.2.3 HTTP custom headers + +##### 6.1.2.3.1 General + +The following HTTP custom headers shall be supported: + +- 3gpp-Sbi-Message-Priority: See 3GPP TS 29.500 [4], clause 5.2.3.2.2. + +This API does not define any new HTTP custom headers. + +#### 6.1.2.4 HTTP multipart messages + +HTTP multipart messages shall be supported, to transfer opaque LPP Information, in the following service operations (and HTTP messages): + +- DetermineLocation Request (POST); + +HTTP multipart messages shall include one JSON body part and one or more binary body parts comprising: + +- one LPP payload (see clause 6.1.6.4). + +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. + +The multipart message shall include a "type" parameter (see IETF RFC 2387 [9]) specifying the media type of the root body part, i.e. "application/json". + +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 [9]. 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. + +For each binary body part in a HTTP multipart message, the binary body part shall include a Content-ID header (see IETF RFC 2045 [10]), and the JSON body part shall include an attribute, defined with the RefToBinaryData type, that contains the value of the Content-ID header field of the referenced binary body part. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +The structure of the Resource URIs of the Nlmf\_Location service is shown in figure 6.1.3.1-1. + +![Figure 6.1.3.1-1: Resource URI structure of the Nlmf_Location API. The diagram shows a vertical hierarchy starting with {apiRoot}/nlmf-loc/. Six horizontal branches lead to resource paths: /determine-location, /cancel-location, /location-context-transfer, /location-measure, /up-subscription, and /up-configure. Each path is enclosed in a dashed rounded rectangle.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nlmf-loc/"] --> D["/determine-location"] + Root --> C["/cancel-location"] + Root --> L["/location-context-transfer"] + Root --> M["/location-measure"] + Root --> U["/up-subscription"] + Root --> P["/up-configure"] + style D stroke-dasharray: 5 5 + style C stroke-dasharray: 5 5 + style L stroke-dasharray: 5 5 + style M stroke-dasharray: 5 5 + style U stroke-dasharray: 5 5 + style P stroke-dasharray: 5 5 + +``` + +Figure 6.1.3.1-1: Resource URI structure of the Nlmf\_Location API. The diagram shows a vertical hierarchy starting with {apiRoot}/nlmf-loc/. Six horizontal branches lead to resource paths: /determine-location, /cancel-location, /location-context-transfer, /location-measure, /up-subscription, and /up-configure. Each path is enclosed in a dashed rounded rectangle. + +Figure 6.1.3.1-1: Resource URI structure of the Nlmf\_Location API + +### 6.1.4 Custom Operations without associated resources + +#### 6.1.4.1 Overview + +The URI structure for Custom Operations without associated resources is included as part of the Figure 6.1.3.1-1 + +Table 6.1.4.1-1: Custom operations without associated resources + +| Operation Name | Custom operation URI | Mapped HTTP method | Description (Service Operation) | +|---------------------------|----------------------------|--------------------|---------------------------------------------------| +| determine-location | /determine-location | POST | Determine Location | +| cancel-location | /cancel-location | POST | Cancel Location | +| location-context-transfer | /location-context-transfer | POST | Transfer Location Context | +| location-measure | /location-measure | POST | Location Measure | +| up-subscription | /up-subscription | POST | UpSubscribe | +| up-configure | /up-configure | POST | Create, Modify or Terminate the LCS-UP connection | + +#### 6.1.4.2 Operation: determine-location + +##### 6.1.4.2.1 Description + +This clause will describe the custom operation and what it is used for, and the custom operation's URI. + +##### 6.1.4.2.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 6.1.4.2.2-1 and 6.1.4.2.2-2. + +Table 6.1.4.2.2-1: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|--------------------------------------------------------| +| InputData | M | 1 | Input parameters to the "Determine Location" operation | + +Table 6.1.4.2.2-2: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LocationDataExt | M | 1 | 200 OK | This case represents the successful retrieval of the location of the UE or successful activation of periodic or triggered location in the UE.

Upon success, a response body is returned containing the different parameters of the location data with one or more corresponding UEs if obtained, such as:
  • - Geographic Area
  • - Civic Location
  • - Local location,
  • - Positioning methods
| +| n/a | | | 204 No Content | This case represents the successful delivery of location assistance data to the UE, during MO-LR requesting for location assistance data for the UE. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
  • - POSITIONING_DENIED
  • - UNSPECIFIED
  • - UNSUPPORTED_BY_UE
  • - PAGING_NOT_ALLOWED

See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | The "cause" attribute may be used to indicate the following application error:
  • - POSITIONING_FAILED

See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 504 Gateway Timeout | The "cause" attribute may be used to indicate the following application error:
  • - UNREACHABLE_USER

See table 6.1.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +Table 6.1.4.2.2-3: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. 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]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. 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]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.4.3 Operation: cancel-location + +##### 6.1.4.3.1 Description + +This clause describes the custom operation and what it is used for. + +##### 6.1.4.3.2 Operation Definition + +This operation shall support the request and response data structures and response codes specified in table 6.1.4.3.2-1 and table 6.1.4.3.2-2. + +**Table 6.1.4.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|------------------------------------------| +| CancelLocData | M | 1 | The information used to cancel location. | + +**Table 6.1.4.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents successful cancellation of location. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
  • - UNSPECIFIED
  • - LOCATION_SESSION_UNKNOWN
See table 6.1.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.4.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. 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]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.4.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. 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]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.4.4 Operation: location-context-transfer + +##### 6.1.4.4.1 Description + +This clause will describe the custom operation and what it is used for. + +##### 6.1.4.4.2 Operation Definition + +This operation shall support the request and response data structures and response codes specified in table 6.1.4.4.2-1 and table 6.1.4.4.2-2. + +**Table 6.1.4.4.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|---------------------------------------------------------------| +| LocContextData | M | 1 | Input parameters to the "Location Context Transfer" operation | + +**Table 6.1.4.4.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents successful transfer of the location context. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
  • - UNSPECIFIED
  • - LOCATION_TRANSFER_NOT_SUPPORTED
  • - INSUFFICIENT_RESOURCES
  • - EVENT_REPORT_UNRECOGNIZED
See table 6.1.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.4.4.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. 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]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.4.4.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. 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]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.4.5 Operation: location-measure + +##### 6.1.4.5.1 Description + +This clause will describe the custom operation and what it is used for, and the custom operation's URI. + +##### 6.1.4.5.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 6.1.4.5.2-1 and 6.1.4.5.2-2. + +**Table 6.1.4.5.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|------------------------------------------------------| +| LocMeasurement Req | M | 1 | Input parameters to the "Location Measure" operation | + +**Table 6.1.4.5.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LocMeasurementResp | M | 1 | 200 OK | This case represents the successful retrieval of the location measurements of the PRU. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
  • - UNSPECIFIED
  • - LOCATION_MEASUREMENT_UNKNOWN
See table 6.1.7.3-1 for the description of these errors. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.4.5.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.4.5.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.4.6 Operation: up-subscription + +##### 6.1.4.6.1 Description + +This clause will describe the custom operation and what it is used for, and the custom operation's URI. + +##### 6.1.4.6.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 6.1.4.6.2-1 and 6.1.4.6.2-2. + +**Table 6.1.4.6.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-------------------------------------------------| +| UpSubscription | M | 1 | Input parameters to the "UPSubscribe" operation | + +**Table 6.1.4.6.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents the successful delivery of location assistance data to the UE, during MO-LR requesting for location assistance data for the UE. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.4.6.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.4.6.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.4.7 Operation: up-configure + +##### 6.1.4.7.1 Description + +This clause will describe the custom operation and what it is used for, and the custom operation's URI. + +##### 6.1.4.7.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 6.1.4.7.2-1 and 6.1.4.7.2-2. + +Table 6.1.4.7.2-1: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------------------| +| UpConfig | M | 1 | Input parameters to the "UPConfig" operation | + +Table 6.1.4.7.2-2: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents the successful set up, modify or terminate LCS-UP connection. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
  • - UNSPECIFIED
See table 6.1.7.3-1 for the description of these errors. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +Table 6.1.4.7.2-3: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +Table 6.1.4.7.2-4: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.5 Notifications + +This clause specifies the notifications provided by the Nlmf\_Location service. + +Table 6.1.5.1-1: Notifications overview + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------|--------------------|---------------------------------|---------------------------------| +| EventNotify | {hgmlcCallBackURI} | POST | | + +#### 6.1.5.1 EventNotify + +##### 6.1.5.1.1 Description + +The EventNotify operation is used to notify the occurrence of periodic or triggered location event for a target UE to a consumer NF (e.g. GMLC). + +##### 6.1.5.1.2 Notification Definition + +Callback URI: {hgmlcCallBackURI} + +See clause 5.2.2.1.2 for the description of how the LMF obtains the Callback URI of the NF Service Consumer (e.g. GMLC). + +##### 6.1.5.1.3 Notification Standard Methods + +###### 6.1.5.1.3.1 POST + +This method sends a Location event notify to the NF Service Consumer. + +This method shall support the request and response data structures and response codes specified in table 6.1.5.1.3.1-1 and table 6.1.5.1.3.1-2. + +Table 6.1.5.1.3.1-1: Data structures supported by the POST Request Body + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------------------------| +| EventNotifyDataExt | M | 1 | Input parameters to the "Location Event Notify" operation | + +Table 6.1.5.1.3.1-2: Data structures supported by the POST Response Body + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents successful notification of the event. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
- UNSPECIFIED
- LOCATION_SESSION_UNKNOWN

See table 6.1.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.1.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. 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]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +**Table 6.1.5.1.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. 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]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +#### 6.1.5.2 UPNotify + +##### 6.1.5.2.1 Description + +The UPNotify operation is used to notify the status or modification of a secure LCS-UP connection for a target UE to a consumer NF (e.g. AMF). + +##### 6.1.5.2.2 Notification Definition + +Callback URI: {upNotifyCallBackURI} + +See clause 5.2.2.1.2 for the description of how the LMF obtains the Callback URI of the NF Service Consumer (e.g. AMF). + +##### 6.1.5.2.3 Notification Standard Methods + +###### 6.1.5.2.3.1 POST + +This method sends a Location event notify to the NF Service Consumer. + +This method shall support the request and response data structures and response codes specified in table 6.1.5.2.3.1-1 and table 6.1.5.2.3.1-2. + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|----------------------------------------------| +| UpNotifyData | M | 1 | Input parameters to the "UPNotify" operation | + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents successful notification of the event. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
- UNSPECIFIED
- LOCATION_SESSION_UNKNOWN

See table 6.1.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. 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]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +**Table 6.1.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. 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]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nlmf\_Location service based interface protocol. + +**Table 6.1.6.1-1: Nlmf\_Location specific Data Types** + +| Data type | Clause defined | Description | +|----------------------------------------------|----------------|---------------------------------------------------------------------------------------| +| InputData | 6.1.6.2.2 | Information within Determine Location Request | +| LocationData | 6.1.6.2.3 | Information within Determine Location Response | +| GeographicalCoordinates | 6.1.6.2.4 | Geographical coordinates | +| GeographicArea | 6.1.6.2.5 | Geographic area specified by different shape | +| Point | 6.1.6.2.6 | Ellipsoid Point | +| PointUncertaintyCircle | 6.1.6.2.7 | Ellipsoid point with uncertainty circle | +| PointUncertaintyEllipse | 6.1.6.2.8 | Ellipsoid point with uncertainty ellipse | +| Polygon | 6.1.6.2.9 | Polygon | +| PointAltitude | 6.1.6.2.10 | Ellipsoid point with altitude | +| PointAltitudeUncertainty | 6.1.6.2.11 | Ellipsoid point with altitude and uncertainty ellipsoid | +| EllipsoidArc | 6.1.6.2.12 | Ellipsoid Arc | +| LocationQoS | 6.1.6.2.13 | QoS of Location request | +| CivicAddress | 6.1.6.2.14 | Indicates a Civic address | +| PositioningMethodAndUsage | 6.1.6.2.15 | Indicates the usage of a positioning method | +| GnssPositioningMethodAndUsage | 6.1.6.2.16 | Indicates the usage of a Global Navigation Satellite System (GNSS) positioning method | +| VelocityEstimate | 6.1.6.2.17 | Velocity estimate | +| HorizontalVelocity | 6.1.6.2.18 | Horizontal velocity | +| HorizontalWithVerticalVelocity | 6.1.6.2.19 | Horizontal and vertical velocity | +| HorizontalVelocityWithUncertainty | 6.1.6.2.20 | Horizontal velocity with speed uncertainty | +| HorizontalWithVerticalVelocityAndUncertainty | 6.1.6.2.21 | Horizontal and vertical velocity with speed uncertainty | +| UncertaintyEllipse | 6.1.6.2.22 | Ellipse with uncertainty | +| UeLcsCapability | 6.1.6.2.23 | Indicates the LCS capability supported by the UE. | +| PeriodicEventInfo | 6.1.6.2.24 | Indicates the information of periodic event reporting | +| AreaEventInfo | 6.1.6.2.25 | Indicates the information of area based event reporting | +| ReportingArea | 6.1.6.2.26 | Indicates an area for event reporting | +| MotionEventInfo | 6.1.6.2.27 | Indicates the information of motion based event reporting | +| CancelLocData | 6.1.6.2.29 | Information within Cancel Location Request | +| LocContextData | 6.1.6.2.30 | Information within Transfer Location Context Request | +| EventReportMessage | 6.1.6.2.31 | Indicates an event report message | +| EventReportingStatus | 6.1.6.2.32 | Indicates the status of event reporting | +| UELlocationInfo | 6.1.6.2.33 | Indicates location information of a UE | +| EventNotifyData | 6.1.6.2.34 | Information within Event Notify Request | +| UeConnectivityState | 6.1.6.2.35 | Indicates the connectivity state of a UE | +| LocalOrigin | 6.1.6.2.36 | Indicates a Local origin in a reference system. | +| RelativeCartesianLocation | 6.1.6.2.37 | Relative Cartesian Location | +| Local2dPointUncertaintyEllipse | 6.1.6.2.38 | Local 2D point with uncertainty ellipse | +| Local3dPointUncertaintyEllipsoid | 6.1.6.2.39 | Local 3D point with uncertainty ellipsoid | +| UncertaintyEllipsoid | 6.1.6.2.40 | Ellipsoid with uncertainty | +| LocalArea | 6.1.6.2.41 | Local area specified by different shape | +| UeAreaIndication | 6.1.6.2.42 | UE area Indication | +| MinorLocationQoS | 6.1.6.2.43 | Minor Location QoS | +| MbsrInfo | 6.1.6.2.44 | MBSR Information | +| LocMeasurementReq | 6.1.6.2.45 | Location Measurement Request | +| LocMeasurementResp | 6.1.6.2.46 | Location Measurement Response | +| LocMeasurements | 6.1.6.2.47 | Location Measurements result | +| HighAccuracyGnssMetrics | 6.1.6.2.48 | High Accuracy GNSS Metrics | +| UpNotifyData | 6.1.6.2.49 | UP Notify Data | +| UpSubscription | 6.1.6.2.50 | UP Subscription | +| RelatedUE | 6.1.6.2.51 | Specifies information for related UE for ranging and sidelink positioning | +| UpConfig | 6.1.6.2.52 | UP Config | +| RangeDirection | 6.1.6.2.53 | Represents the range and direction between two points. | + +| | | | +|-----------------------------|------------|------------------------------------------------------------------------------------------------------| +| 2DRelativeLocation | 6.1.6.2.54 | Represents 2D local co-ordinates with origin corresponding to another known point. | +| 3DRelativeLocation | 6.1.6.2.55 | Represents 3D local co-ordinates with origin corresponding to another known point. | +| AddLocationDatas | 6.1.6.2.56 | Contains one or more LocationData. | +| AddEventNotifyDatas | 6.1.6.2.57 | Contains one or more EventNotifyData. | +| LocationDataExt | 6.1.6.2.58 | Represents location data with one or more corresponding UEs. | +| EventNotifyDataExt | 6.1.6.2.59 | Represents notified data with one or more corresponding UEs, containing one or more EventNotifyData. | +| MappedLocationQoSEps | 6.1.6.2.60 | Mapped Location QoS for EPS | +| AdditionalUeInfo | 6.1.6.2.61 | MBSR UE Information | +| Altitude | 6.1.6.3.2 | Indicates value of altitude | +| Angle | 6.1.6.3.2 | Indicates value of angle | +| Uncertainty | 6.1.6.3.2 | Indicates value of uncertainty | +| Orientation | 6.1.6.3.2 | Indicates value of orientation angle | +| Confidence | 6.1.6.3.2 | Indicates value of confidence | +| Accuracy | 6.1.6.3.2 | Indicates value of accuracy | +| InnerRadius | 6.1.6.3.2 | Indicates value of the inner radius | +| CorrelationID | 6.1.6.3.2 | LCS Correlation ID | +| AgeOfLocationEstimate | 6.1.6.3.2 | Indicates value of the age of the location estimate | +| HorizontalSpeed | 6.1.6.3.2 | Indicates value of horizontal speed | +| VerticalSpeed | 6.1.6.3.2 | Indicates value of vertical speed | +| SpeedUncertainty | 6.1.6.3.2 | Indicates value of speed uncertainty | +| BarometricPressure | 6.1.6.3.2 | Specifies the measured uncompensated atmospheric pressure | +| LcsServiceType | 6.1.6.3.2 | LCS service type | +| LdrReference | 6.1.6.3.2 | LDR Reference | +| LirReference | 6.1.6.3.2 | LIR Reference | +| ReportingAmount | 6.1.6.3.2 | Number of required periodic event reports | +| ReportingInterval | 6.1.6.3.2 | Event reporting periodic interval | +| MinimumInterval | 6.1.6.3.2 | Minimum interval between event reports | +| MaximumInterval | 6.1.6.3.2 | Maximum interval between event reports | +| SamplingInterval | 6.1.6.3.2 | Maximum time interval between consecutive evaluations by a UE of a trigger event | +| ReportingDuration | 6.1.6.3.2 | Maximum duration of event reporting | +| LinearDistance | 6.1.6.3.2 | Minimum straight line distance moved by a UE to trigger a motion event report | +| LMFIdentification | 6.1.6.3.2 | LMF identification | +| EventReportCounter | 6.1.6.3.2 | Number of event reports received from the target UE | +| EventReportDuration | 6.1.6.3.2 | Duration of event reporting | +| UePositioningCapabilities | 6.1.6.3.2 | Indicates the positioning capabilities supported by the UE. | +| ExternalClientType | 6.1.6.3.3 | Indicates types of External Clients | +| SupportedGADShapes | 6.1.6.3.4 | Indicates supported GAD shapes | +| ResponseTime | 6.1.6.3.5 | Indicates acceptable delay of location request | +| PositioningMethod | 6.1.6.3.6 | Indicates supported positioning methods | +| PositioningMode | 6.1.6.3.7 | Indicates supported modes used for positioning method | +| GnssId | 6.1.6.3.8 | Global Navigation Satellite System (GNSS) ID | +| Usage | 6.1.6.3.9 | Indicates usage made of the location measurement | +| LcsPriority | 6.1.6.3.10 | Indicates priority of the LCS client | +| VelocityRequested | 6.1.6.3.11 | Indicates velocity requirement | +| AccuracyFulfilmentIndicator | 6.1.6.3.12 | Indicates fulfilment of requested accuracy | +| VerticalDirection | 6.1.6.3.13 | Indicates direction of vertical speed | +| LdrType | 6.1.6.3.14 | Indicates LDR types | +| ReportingAreaType | 6.1.6.3.15 | Indicates type of event reporting area | +| OccurrenceInfo | 6.1.6.3.16 | Specifies occurrence of event reporting | +| ReportingAccessType | 6.1.6.3.17 | Specifies access types of event reporting | +| EventClass | 6.1.6.3.18 | Specifies event classes | + +| | | | +|-----------------------------|------------|------------------------------------------------------------------------| +| ReportedEventType | 6.1.6.3.19 | Specifies type of event reporting | +| TerminationCause | 6.1.6.3.20 | Specifies causes of event reporting termination | +| LcsQosClass | 6.1.6.3.21 | Specifies LCS QoS class | +| UeLocationServiceInd | 6.1.6.3.22 | Specifies location service types requested by UE | +| IndoorOutdoorInd | 6.1.6.3.23 | Indoor Outdoor Indication | +| FixType | 6.1.6.3.24 | Fix Type | +| LosNlosMeasureInd | 6.1.6.3.25 | LOS/NLOS measurement indication | +| UpConnectionStatus | 6.1.6.3.26 | UP Connection Status | +| RangingSIResult | 6.1.6.3.27 | Specifies result type for ranging and sidelink positioning | +| RelatedUEType | 6.1.6.3.28 | Specifies type of related UE for ranging and sidelink positioning | +| LcsUpConnectionInd | 6.1.6.3.29 | LCS UP Connection Indication | +| UeUpPositioningCapabilities | 6.1.6.3.30 | Indicates the user plane positioning capabilities supported by the UE. | + +Table 6.1.6.1-2 specifies data types re-used by the Nlmf\_Location 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 Nlmf\_Location service based interface. + +**Table 6.1.6.1-2: Nlmf\_Location re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------|---------------------|-------------------------------------------------------------------| +| Supi | 3GPP TS 29.571 [8] | Subscription Permanent Identifier | +| Pei | 3GPP TS 29.571 [8] | Permanent Equipment Identifier | +| Gpsi | 3GPP TS 29.571 [8] | Generic Public Subscription Identifier | +| Ecgi | 3GPP TS 29.571 [8] | E-UTRA Cell Identity | +| Ncgi | 3GPP TS 29.571 [8] | NR Cell Identity | +| NfInstanceId | 3GPP TS 29.571 [8] | Network Function Instance ID | +| Uri | 3GPP TS 29.571 [8] | Uniform Resource Identifier | +| RefToBinaryData | 3GPP TS 29.571 [8] | Reference to binary data | +| AccessType | 3GPP TS 29.571 [8] | Access type | +| CmState | 3GPP TS 29.518 [23] | Connection Management State | +| Guami | 3GPP TS 29.571 [8] | GUAMI | +| SupportedFeatures | 3GPP TS 29.571 [8] | Supported Features | +| RedirectResponse | 3GPP TS 29.571 [8] | Redirect Response | +| TwapId | 3GPP TS 29.571 [8] | TWAP identifier | +| TnapId | 3GPP TS 29.571 [8] | TNAP identifier | +| DateTime | 3GPP TS 29.571 [8] | Date and Time | +| DurationSec | 3GPP TS 29.571 [8] | Duration Second | +| LpHapType | 3GPP TS 29.518 [23] | Type of Low Power and/or High Accuracy Positioning | +| ReportingInd | 3GPP TS 29.515 [27] | Reporting indication | +| IntegrityRequirements | 3GPP TS 29.515 [28] | Integrity Requirements | +| UpLocRepAddrAfRm | 3GPP TS 29.122 [29] | Endpoint address for location reporting over user plane | +| UpCumEvtRptCriteria | 3GPP TS 29.515 [27] | Criteria for sending cumulative events reports over control plane | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: InputData + +**Table 6.1.6.2.2-1: Definition of type InputData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| externalClientType | ExternalClientType | O | 0..1 | When present, this IE shall carry the external client type of the requester. | | +| correlationID | CorrelationID | O | 0..1 | When present, this IE shall carry the correlation ID of the request. | | +| amfId | NfInstanceId | O | 0..1 | Indicates the AMF Instance serving the UE. LMF shall use the AMF Instance to forward LCS related N1/N2 messages to the UE/RAN. | | +| locationQoS | LocationQoS | O | 0..1 | When present, this IE shall carry the QoS of the location request. | | +| supportedGADShapes | array(SupportedGADShapes) | O | 1..N | When present, this IE shall carry the GAD shapes supported by the requester. | | +| supi | Supi | O | 0..1 | Indicates the SUPI of the target UE. | | +| pei | Pei | O | 0..1 | Indicates the PEI of the target UE. | | +| gpsi | Gpsi | O | 0..1 | Indicates the GPSI of the target UE. | | +| ecgi | Ecgi | O | 0..1 | When present, this IE shall indicate the identifier of the E-UTRAN cell serving the UE or the serving cell identifier of the Primary Cell in the Master RAN Node that is an E-UTRAN node on Dual Connectivity scenarios. (NOTE 2) | | +| ecgiOnSecondNode | Ecgi | O | 0..1 | When present, the serving cell identifier of the Primary Cell in the Secondary RAN Node that is an E-UTRAN node when available on Dual Connectivity scenarios. (NOTE 3) (NOTE 4) | | +| ncgi | Ncgi | O | 0..1 | When present, this IE shall indicate the identifier of the NR cell serving the UE or the serving cell identifier of the Primary Cell in the Master RAN Node that is a NR node on Dual Connectivity scenarios. (NOTE 2) | | +| ncgiOnSecondNode | Ncgi | O | 0..1 | When present, the serving cell identifier of the Primary Cell in the Secondary RAN Node that is a NR node when available on Dual Connectivity scenarios. (NOTE 3) (NOTE 4) | | +| priority | LcsPriority | O | 0..1 | When present, this IE shall indicate the priority of the location request. | | +| velocityRequested | VelocityRequested | O | 0..1 | When present, this IE shall indicate whether velocity is requested or not. | | +| ueLcsCap | UeLcsCapability | O | 0..1 | When present, this IE shall indicate the LCS capability supported by the UE. | | +| lcsServiceType | LcsServiceType | O | 0..1 | The LCS service type | | +| ldrType | LdrType | O | 0..1 | The type of LDR | | +| hgmlcCallBackURI | Uri | C | 0..1 | Callback URI of the H-GMLC

It shall be present, if attribute LdrType is present.

This IE shall also be present for location service in PNI-NPN with signalling optimisation, as specified in 3GPP TS 23.273 [42] clause 6.1.2. | | +| lirGmlcCallBackUri | Uri | C | 0..1 | This IE shall be present when the intermediateLocationInd IE is present with the value "true".

When present, this IE shall contain callback URI of the GMLC to receive the intermediate location reports. | | +| vgmlcAddress | Uri | C | 0..1 | V-GMLC address that corresponds to the V-GMLC that receives Location Request
It shall be present, if attribute LdrType is present and the target UE is in roaming case. | | + +| | | | | | | +|-----------------------|---------------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| ldrReference | LdrReference | C | 0..1 | LDR Reference Number

It shall be present, if attribute LdrType is present.

This IE shall be present for location service in PNI-NPN with signalling optimisation, as specified in 3GPP TS 23.273 [42] clause 6.1.2. | | +| lirReference | LirReference | C | 0..1 | This IE shall be present when the intermediateLocationInd IE is present with the value "true".

When present, this IE shall contain the LIR Reference Number for a multiple location request | | +| periodicEventInfo | PeriodicEventInfo | C | 0..1 | Information for periodic event reporting | | +| areaEventInfo | AreaEventInfo | C | 0..1 | Information for area event reporting | | +| motionEventInfo | MotionEventInfo | C | 0..1 | Information for motion event reporting | | +| reportingAccessTypes | array(ReportingAccessTypes) | O | 1..N | Allowed access types for event reporting | | +| ueConnectivityStates | array(UeConnectivityState) | O | 1..N | When present, this IE shall indicate the UE connectivity state per access type | | +| ueLocationServiceInd | UeLocationServiceInd | C | 0..1 | If UE sends an MO-LR Request message, this IE shall be present and indicate the request type for a 5GC-MO-LR. | | +| moAssistanceDataTypes | LcsBroadcastAssistanceTypesData | O | 0..1 | When present, this IE shall indicate a list of one or more types of location assistance data that UE subscribed. | | +| lppMessage | RefToBinaryData | C | 0..1 | If UE includes the first LPP message in MO-LR Request, this IE shall be present and Indicate the binary data of LPP message.
(NOTE 5) | | +| lppMessageExt | array(RefToBinaryData) | C | 1..N | If UE includes the additional LPP messages (maximum 3) in MO-LR Request, this IE shall be present and Indicates the binary data of LPP message.
(NOTE 5) | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | | +| uePositioningCap | UePositioningCapabilities | O | 0..1 | When present, this IE shall indicate the positioning capabilities supported by the UE. | | +| tnapId | TnapId | O | 0..1 | When present, this IE shall contain the TNAP Identifier.

This IE may be present for non-3GPP access. | | +| twapId | TwapId | O | 0..1 | When present, This IE shall contain the TWAP Identifier.
This IE may be present for non-3GPP access. | | +| ueCountryDetInd | boolean | O | 0..1 | When present, This IE shall contain an indication of determining the UE geographical area identified by the country, area within a country or international area indication where UE is located for PLMN selection verification. | SAT | +| scheduledLocTime | DateTime | O | 0..1 | When present, this IE shall contain the scheduled time (in UTC) that the UE needs to be located. | | +| reliableLocReq | boolean | C | 0..1 | This IE shall be included with the value true to indicate that reliable UE location information is required, as specified in 3GPP TS 33.256 [26] clause 5.3.2.

When present, this IE shall be set as following:
- true: the reliable UE location information is required
- false (default): the reliable UE location information is not required | | + +| | | | | | | +|--------------------------|-------------------------------------|---|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| evtRptAllowedAreas | array(ReportingArea) | O | 1..250 | When present, this IE shall contain a list of event report allowed areas, where UE is allowed to generate and send the event report to network during the deferred 5GC-MT-LR procedure for UE power saving purpose. | | +| ueUnawareInd | boolean | C | 0..1 | UE Unaware Positioning indication.

If the UE Unaware Positioning is required, as specified in 3GPP TS 23.273 [19] clause 5.12, this IE shall be included and set to true; otherwise, the IE shall be absent. | | +| intermediateLocationInd | boolean | C | 0..1 | This IE shall be included by the AMF if received from the GMLC, during a 5GC-MT-LR multiple location procedure for the regulatory location service (see clause 6.1.3 and clause 6.10.4 of 3GPP TS 23.273 [19]).

When present, this IE shall indicate the acceptance of intermediate location response at the GMLC:
- true: intermediate location response acceptable
- false (default): intermediate location response not acceptable | | +| maxRespTime | DurationSec | C | 0..1 | This IE shall be included by the AMF if received from the GMLC.

When present, this IE shall contain the maximum response time for the GMLC to receive the final location response.

The AMF may overwrite the received maximum response time when passing it to the LMF, e.g., to avoid timeout of the HTTP service request. | | +| lpHapType | LpHapType | C | 0..1 | This IE shall be included and set to "LOW_POW_HIGH_ACCU_POS" to request low power and high accuracy positioning, as specified in clause 6.1.2 of 3GPP TS 23.273 [19]. | | +| ueUpPosCaps | array(UeUpPositioning Capabilities) | O | 1..N | When present, this IE shall indicate the user plane positioning capabilities supported by the UE. | | +| reportingInd | ReportingInd | O | 0..1 | This IE may be present if the evtRptAllowedAreas IE is present.

When present, this IE shall indicate whether the UE is allowed to generate and send the reports inside or outside the event report allowed areas:
- Inside reporting (default)
- Outside reporting
(see 3GPP TS 23.273 [19] clause 5.14 and 6.3.1) | | +| mbsrInfo | MbsrInfo | O | 0..1 | Indicates that serving cell of the UE belongs to a MBSR | MBSR | +| additionalUeInfo | AdditionalUeInfo | O | 0..1 | When present, this IE indicates the serving cell of the MBSR UE (i.e., IAB UE) | MBSR | +| integrityRequirements | IntegrityRequirements | O | 0..1 | When present, this IE shall indicate the integrity requirements. | | +| requestedRangingSIResult | array(RangingSIResult ) | O | 1..N | This IE shall contain the type of result requested for ranging and sidelink positioning, such as absolute locations, relative locations or ranges and directions related to the UEs, etc. | | +| relatedUEs | array(RelatedUE) | O | 1..N | This IE contains a list of the information for the related UEs for the ranging and sidelink positioning. | | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| upLocRepAddrAf | UpLocRepAddrAfRm | O | 0..1 | This IE shall be present if the request is for the location reporting over user plane. | | +| upCumEvtRptCriteria | UpCumEvtRptCriteria | O | 0..1 | This IE may be present if the upLocRepAddrAf is present. | | +| relatedApplicationlayerId | ApplicationlayerId | O | 0..1 | Identifies the application layer ID of the related UE for ranging and sidelink positioning, such as located UE, reference UE, etc. | Ranging_SL | +| rangeDirection | RangeDirection | O | 0..1 | When present, this IE identifies a range and direction from a point A to a point B, comprising a range from point A to point B, an azimuth direction from point A to point B and an elevation direction from point A to point B. | Ranging_SL | +| 2dRelativeLocation | 2DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 2D location with uncertainty ellipse, characterised by a point described in 2D local co-ordinates with origin corresponding to another known point, distances r1 and r2 and an angle of orientation A. | Ranging_SL | +| 3dRelativeLocation | 3DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 3D location with uncertainty ellipsoid, characterised by a point described in 3D local co-ordinates with origin corresponding to another known point, distances r1 (the "semi-major uncertainty"), r2 (the "semi-minor uncertainty") and r3 (the "vertical uncertainty") and an angle of orientation A (the "angle of the major axis"). | Ranging_SL | +| relativeVelocity | VelocityEstimate | O | 0..1 | When present, this IE identifies UE velocity relative to the UE identified with relatedApplicationlayerId. | Ranging_SL | +| mappedQoSEps | MappedLocationQoSeps | C | 0..1 | This IE shall be present if the Multiple QoS Class is indicated in the locationQoS IE.

When present, this IE shall indicate the mapped Location QoS applicable to EPS ("BEST EFFORT" or "ASSURED") based on the Multiple Location QoS (see clause 6.19 of 3GPP TS 23.273 [19]). | | +| NOTE 1: At least one of the attributes defined in this table shall be present in the InputData structure. | | | | | | +| NOTE 2: Attribute "ecgi" and "ncgi" shall not be present at the same time. | | | | | | +| NOTE 3: Attribute "ecgiOnSecondNode" and "ncgiOnSecondNode" shall not be present at the same time. | | | | | | +| NOTE 4: Attribute "ecgiOnSecondNode" or "ncgiOnSecondNode" shall not be present if neither attribute "ecgi" nor "ncgi" is present. | | | | | | +| NOTE 5: If 3 LPP messages are received, then first LPP message shall be encoded in lppMessage IE and additional 2 LPP messages shall be encoded in lppMessageExt IE. | | | | | | + +##### 6.1.6.2.3 Type: LocationData + +**Table 6.1.6.2.3-1: Definition of type LocationData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|--------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| locationEstimate | GeographicArea | M | 1 | For a request for triggered location where location estimates are not required, the location estimate can be based on current serving cell. | | +| accuracyFulfilmentIndicator | AccuracyFulfilmentIndicator | O | 0..1 | When present, this IE shall indicate fulfilment of required accuracy. | | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | When present, this IE shall indicate age of the location estimate. | | +| timestampOfLocationEstimate | DateTime | O | 0..1 | When present, this IE shall indicate the estimated UTC time when the location estimate corresponded to the UE location (i.e. when the location estimate and the actual UE location was the same). | | +| velocityEstimate | VelocityEstimate | O | 0..1 | When present, this IE shall indicate velocity estimate. | | +| civicAddress | CivicAddress | O | 0..1 | When present, this IE shall indicate a civic address. | | +| localLocationEstimate | LocalArea | O | 0..1 | When present, this IE shall indicate a local area in reference system. | | +| positioningDataList | array(PositioningMethodAndUsage) | O | 1..N | When present, this IE shall include a list of data related to positioning methods. | | +| gnssPositioningDataList | array(GNSSPositioningMethodAndUsage) | O | 1..N | When present, this IE shall include a list of data related to GNSS positioning methods. | | +| ecgi | Ecgi | O | 0..1 | When present, this IE shall indicate the ID of the E-UTRAN cell serving the UE. | | +| ncgi | Ncgi | O | 0..1 | When present, this IE shall indicate the ID of the NR cell serving the UE. | | +| altitude | Altitude | O | 0..1 | Altitude of the positioning estimate. When the shape used in "locationEstimate" supports conveying the altitude parameter, this IE shall be absent. | | +| barometricPressure | BarometricPressure | O | 0..1 | If present, this IE contains the barometric pressure measurement as reported by the target UE. | | +| servingLMFIdentification | LMFIdentification | O | 0..1 | When present, this IE shall indicate the identity of the serving LMF | | +| uePositioningCap | UePositioningCapabilities | O | 0..1 | When present, this IE shall indicate the positioning capabilities supported by the UE. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | | + +| | | | | | | +|---------------------------|-------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| +| ueAreaInd | UeAreaIndication | O | 0..1 | When present, this IE shall contain a country, area in a country or international area indication where UE is located.

If UE is outside of the area of any known country, i.e. international area, then the LMF shall provide the International Area Indication without a country. | SAT | +| achievedQos | MinorLocationQoS | O | 0..1 | When present, this IE shall contain the achieved Location QoS Accuracy of the estimated location.

This IE may be present if the LCS QoS Class required in the request message is "MULTIPLE_QOS".

If it's absent, LCS QoS Class required in the request message is "MULTIPLE_QOS" and AccuracyFulfilmentIndicator is "REQUESTED_ACCURACY_FULFILLED", it indicates that the location QoS in the highest priority is achieved. | MUTIQOS | +| directReportInd | boolean | C | 0..1 | When present, this IE shall be set for the following value:
- true: location determination will be sent by LMF to GMLC directly
- false (default): location determination will not be sent by LMF to GMLC directly | | +| indoorOutdoorInd | IndoorOutdoorInd | O | 0..1 | When present, this IE shall indicate whether the UE is indoor or outdoor. | | +| acceptedPeriodicEventInfo | PeriodicEventInfo | C | 0..1 | This IE shall be present if PeriodicEventInfo was received in the request which includes reportingAmountInf IE and/or reportingIntervalMs IE.

When present, this IE shall provide the accepted periodic event reporting information. | | +| haGnssMetrics | HighAccuracyGnssMetrics | O | 0..1 | When present, this IE shall indicate the high accuracy GNSS metrics received from the device in the LPP HA-GNSS-Metrics-r17 IE as specified in 3GPP TS 37.355 [21]. | | +| losNlosMeasureInd | LosNlosMeasureInd | O | 0..1 | When present, this IE shall indicate whether LOS measurement or NLOS measurement is used. | | + +##### 6.1.6.2.4 Type: GeographicalCoordinates + +Table 6.1.6.2.4-1: Definition of type GeographicalCoordinates + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------| +| lon | number | M | 1 | Longitude (Double-precision float value):
Format: double
Minimum: -180
Maximum: 180 | +| lat | number | M | 1 | Latitude (Double-precision float value):
Format: double
Minimum: -90
Maximum: 90 | + +##### 6.1.6.2.5 Type: GeographicArea + +Table 6.1.6.2.5-1: Definition of type GeographicArea as a list of mutually exclusive alternatives + +| Data type | Cardinality | Discriminator property name | Discriminator mapping | Description | +|--------------------------|-------------|-----------------------------|----------------------------|----------------------------------------------------------------------------------------------| +| Point | 1 | shape | POINT | Geographical area consisting of a single point, represented by its longitude and latitude. | +| PointUncertaintyCircle | 1 | shape | POINT_UNCERTAINTY_CIRCLE | Geographical area consisting of a point and an uncertainty value. | +| PointUncertaintyEllipse | 1 | shape | POINT_UNCERTAINTY_ELLIPSE | Geographical area consisting of a point, plus an uncertainty ellipse and a confidence value. | +| Polygon | 1 | shape | POLYGON | Geographical area consisting of a list of points (between 3 to 15 points). | +| PointAltitude | 1 | shape | POINT_ALTITUDE | Geographical area consisting of a point and an altitude value. | +| PointAltitudeUncertainty | 1 | shape | POINT_ALTITUDE_UNCERTAINTY | Geographical area consisting of a point, an altitude value and an uncertainty value. | +| EllipsoidArc | 1 | shape | ELLIPSOID_ARC | Geographical area consisting of an ellipsoid arc. | + +NOTE: The "anyOf" keyword (instead of "oneOf" keyword which is normally used for mutually exclusive alternatives) is used for GeographicArea type in yaml file to avoid validation failure of OpenAPI. According to current definition, a PointUncertaintyCircle object will always pass the validation with both PointUncertaintyCircle and Point, which fails the qualification of "oneOf" keyword. + +##### 6.1.6.2.6 Type: Point + +Table 6.1.6.2.6-1: Definition of type Point + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POINT". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | + +##### 6.1.6.2.7 Type: PointUncertaintyCircle + +Table 6.1.6.2.7-1: Definition of type PointUncertaintyCircle + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POINT_UNCERTAINTY_CIRCLE". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | +| uncertainty | Uncertainty | M | 1 | Indicates the uncertainty value. | + +##### 6.1.6.2.8 Type: PointUncertaintyEllipse + +Table 6.1.6.2.8-1: Definition of type PointUncertaintyEllipse + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POINT_UNCERTAINTY_ELLIPSE". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | +| uncertaintyEllipse | UncertaintyEllipse | M | 1 | Indicates an uncertainty ellipse. | +| confidence | Confidence | M | 1 | Indicates the value of confidence. | + +##### 6.1.6.2.9 Type: Polygon + +Table 6.1.6.2.9-1: Definition of type Polygon + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------------------|---|-------------|----------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POLYGON". | +| pointList | array(GeographicalCoordinates) | M | 3..15 | Array with up to 15 items, where each item is a "point". | + +##### 6.1.6.2.10 Type: PointAltitude + +Table 6.1.6.2.10-1: Definition of type PointAltitude + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POINT_ALTITUDE". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | +| altitude | Altitude | M | 1 | Indicates the value of altitude. | + +##### 6.1.6.2.11 Type: PointAltitudeUncertainty + +Table 6.1.6.2.11-1: Definition of type PointAltitudeUncertainty + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POINT_ALTITUDE_UNCERTAINTY". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | +| altitude | Altitude | M | 1 | Indicates the value of altitude. | +| uncertaintyEllipse | UncertaintyEllipse | M | 1 | Indicates the uncertainty ellipse | +| uncertaintyAltitude | Uncertainty | M | 1 | Indicates the uncertainty of the altitude. | +| confidence | Confidence | M | 1 | Indicates the value of confidence. | + +##### 6.1.6.2.12 Type: EllipsoidArc + +Table 6.1.6.2.12-1: Definition of type EllipsoidArc + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "ELLIPSOID_ARC". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | +| innerRadius | InnerRadius | M | 1 | Indicates the value of inner radius of the Ellipsoid Arc. | +| uncertaintyRadius | Uncertainty | M | 1 | Indicates the uncertainty radius of the Ellipsoid Arc. | +| offsetAngle | Angle | M | 1 | Indicates the offset angle of the Ellipsoid Arc. | +| includedAngle | Angle | M | 1 | Indicates the included angle of the Ellipsoid Arc. | +| confidence | Confidence | M | 1 | Indicates the value of confidence. | + +##### 6.1.6.2.13 Type: LocationQoS + +Table 6.1.6.2.13-1: Definition of type LocationQoS + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| hAccuracy | Accuracy | O | 0..1 | Horizontal accuracy | | +| vAccuracy | Accuracy | O | 0..1 | Vertical accuracy | | +| vertRequested | boolean | O | 0..1 | Vertical accuracy requested (yes/no) | | +| responseTime | ResponseTime | O | 0..1 | No delay, Low delay or Delay tolerant | | +| minorLocQoses | array(MinorLocationQoS) | C | 1..2 | If present, this IE shall contain a list of MinorLocationQoS in priority order.

When the lcsQosClass sets to "MULTIPLE_QOS", this IE shall be present, and when lcsQosClass sets to either "BEST EFFORT" or "ASSURED" this IE shall be absent. | MUTIQOS | +| lcsQosClass | LcsQosClass | C | 0..1 | LCS QoS Class, see clause 4.1b of 3GPP TS 23.273 [19].
This IE shall be absent if neither hAccuracy nor vAccuracy is included. | | + +NOTE: If the lcsQosClass set to "MULTIPLE\_QOS", at least one of attributes hAccuracy, vAccuracy shall be present. + +6.1.6.2.14 Type: CivicAddress + +**Table 6.1.6.2.14-1: Definition of type CivicAddress** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------| +| country | string | M | 1 | The two-letter ISO 3166 country code in capital ASCII letters, e.g., DE or US
IETF RFC 4776 [6] | +| A1 | string | O | 0..1 | National subdivisions (state, canton, region, province, prefecture)
IETF RFC 4776 [6] | +| A2 | string | O | 0..1 | County, parish, gun (JP), district (IN)
IETF RFC 4776 [6] | +| A3 | string | O | 0..1 | City, township, shi (JP)
IETF RFC 4776 [6] | +| A4 | string | O | 0..1 | City division, borough, city district, ward, chou (JP)
IETF RFC 4776 [6] | +| A5 | string | O | 0..1 | Neighbourhood, block
IETF RFC 4776 [6] | +| A6 | string | O | 0..1 | Group of streets below the neighbourhood level
IETF RFC 4776 [6] | +| PRD | string | O | 0..1 | Leading street direction
IETF RFC 4776 [6] | +| POD | string | O | 0..1 | Trailing street suffix
IETF RFC 4776 [6] | +| STS | string | O | 0..1 | Street suffix or type
IETF RFC 4776 [6] | +| HNO | string | O | 0..1 | House number
IETF RFC 4776 [6] | +| HNS | string | O | 0..1 | House number suffix
IETF RFC 4776 [6] | +| LMK | string | O | 0..1 | Landmark or vanity address
IETF RFC 4776 [6] | +| LOC | string | O | 0..1 | Additional location information
IETF RFC 4776 [6] | +| NAM | string | O | 0..1 | Name (residence and office occupant)
IETF RFC 4776 [6] | +| PC | string | O | 0..1 | Postal/zip code
IETF RFC 4776 [6] | +| BLD | string | O | 0..1 | Building (structure)
IETF RFC 5139 [7] | +| UNIT | string | O | 0..1 | Unit (apartment, suite)
IETF RFC 5139 [7] | +| FLR | string | O | 0..1 | Floor
IETF RFC 4776 [6] | +| ROOM | string | O | 0..1 | Room
IETF RFC 5139 [7] | +| PLC | string | O | 0..1 | Place-type
IETF RFC 5139 [7] | +| PCN | string | O | 0..1 | Postal community name
IETF RFC 5139 [7] | +| POBOX | string | O | 0..1 | Post office box (P.O. box)
IETF RFC 5139 [7] | +| ADDCODE | string | O | 0..1 | Additional code
IETF RFC 5139 [7] | +| SEAT | string | O | 0..1 | Seat (desk, cubicle, workstation)
IETF RFC 5139 [7] | +| RD | string | O | 0..1 | Primary road or street
IETF RFC 5139 [7] | +| RDSEC | string | O | 0..1 | Road clause
IETF RFC 5139 [7] | +| RDBR | string | O | 0..1 | Road branch
IETF RFC 5139 [7] | +| RDSUBBR | string | O | 0..1 | Road sub-branch
IETF RFC 5139 [7] | +| PRM | string | O | 0..1 | Road pre-modifier
IETF RFC 5139 [7] | +| POM | string | O | 0..1 | Road post-modifier
IETF RFC 5139 [7] | + +| | | | | | +|------------|--------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------| +| usageRules | string | O | 0..1 | When present, this IE shall carry the value of "usage-rules" Element of the PIDL-LO XML document, with UTF-8 encoding.
IETF RFC 4119 [25] | +| method | string | O | 0..1 | When present, this IE shall contain the method token, carried by the "method" Element of the PIDL-LO XML document.
IETF RFC 4119 [25] | +| providedBy | string | O | 0..1 | When present, this IE shall carry the value of "provided-by" Element of the PIDL-LO XML document, with UTF-8 encoding.
IETF RFC 4119 [25] | + +EXAMPLE: The above structure follows the same label naming as in the XML schema shown in IETF RFC 5139 [7]. The same example shown in XML in that RFC, in clause 5, would be equivalent to the following JSON document: + +``` +{ + "country": "AU", + "A1": "NSW", + "A3": "Wollongong", + "A4": "North Wollongong", + "RD": "Flinders", + "STS": "Street", + "RDBR": "Campbell Street", + "LMK": "Gilligan's Island", + "LOC": "Corner", + "NAM": "Video Rental Store", + "PC": "2500", + "ROOM": "Westerns and Classics", + "PLC": "store", + "POBOX": "Private Box 15" +} +``` + +##### 6.1.6.2.15 Type: PositioningMethodAndUsage + +**Table 6.1.6.2.15-1: Definition of type PositioningMethodAndUsage** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| method | PositioningMethod | M | 1 | Indicates the related positioning method | +| mode | PositioningMode | M | 1 | Indicates the mode of the location measurement from the related positioning method. | +| usage | Usage | M | 1 | Indicates the usage of the location measurement from the related positioning method. | +| methodCode | integer | C | 0..1 | This IE shall be present when the method IE is with value "NETWORK_SPECIFIC".

When present, this IE shall carry the code value of the network specific positioning method in decimal which encodes the binary value "10000 to 11111" (bits 8-4 of " Positioning Method and Usage " IE within " Positioning Data " parameter, as specified in clause 7.4.13 of 3GPP TS 29.171 [24].)

Minimum: 16
Maximum: 31 | + +6.1.6.2.16 Type: GnssPositioningMethodAndUsage + +**Table 6.1.6.2.16-1: Definition of type GnssPositioningMethodAndUsage** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|---------------------------------------------------------------------------------------| +| mode | PositioningMode | M | 1 | Indicates the mode of location measurement from the related GNSS positioning method. | +| gnss | GnssId | M | 1 | Indicates the related GNSS positioning method | +| usage | Usage | M | 1 | Indicates the usage of the location measurement from related GNSS positioning method. | + +6.1.6.2.17 Type: VelocityEstimate + +**Table 6.1.6.2.17-1: Definition of type VelocityEstimate as a list of mutually exclusive alternatives** + +| Data type | Cardinality | Description | +|----------------------------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| HorizontalVelocity | 1 | Velocity estimate including horizontal speed and bearing. | +| HorizontalWithVerticalVelocity | 1 | Velocity estimate including horizontal speed and bearing, and also vertical speed and vertical direction. | +| HorizontalVelocityWithUncertainty | 1 | Velocity estimate including horizontal speed and bearing; it also includes an uncertainty value. | +| HorizontalWithVerticalVelocityAndUncertainty | 1 | Velocity estimate including horizontal speed and bearing, and also vertical speed and vertical direction; it also includes uncertainty value for horizontal and vertical speeds. | + +6.1.6.2.18 Type: HorizontalVelocity + +**Table 6.1.6.2.18-1: Definition of type HorizontalVelocity** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|----------------------------------------------------------| +| hSpeed | HorizontalSpeed | M | 1 | Horizontal speed in kilometres per hour. | +| bearing | Angle | M | 1 | Bearing angle in degrees, measured clockwise from North. | + +6.1.6.2.19 Type: HorizontalWithVerticalVelocity + +**Table 6.1.6.2.19-1: Definition of type HorizontalWithVerticalVelocity** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|----------------------------------------------------------| +| hSpeed | HorizontalSpeed | M | 1 | Horizontal speed in kilometres per hour. | +| bearing | Angle | M | 1 | Bearing angle in degrees, measured clockwise from North. | +| vSpeed | VerticalSpeed | M | 1 | Vertical Speed in kilometres per hour. | +| vDirection | VerticalDirection | M | 1 | Vertical Direction: upward or downward. | + +6.1.6.2.20 Type: HorizontalVelocityWithUncertainty + +**Table 6.1.6.2.20-1: Definition of type HorizontalVelocityWithUncertainty** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|----------------------------------------------------------| +| hSpeed | HorizontalSpeed | M | 1 | Speed in kilometres per hour. | +| bearing | Angle | M | 1 | Bearing angle in degrees, measured clockwise from North. | +| uncertainty | SpeedUncertainty | M | 1 | Uncertainty of horizontal speed in kilometres per hour. | + +6.1.6.2.21 Type: HorizontalWithVerticalVelocityAndUncertainty + +**Table 6.1.6.2.21-1: Definition of type HorizontalWithVerticalVelocityAndUncertainty** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|----------------------------------------------------------| +| hspeed | HorizontalSpeed | M | 1 | Speed in kilometres per hour. | +| bearing | Angle | M | 1 | Bearing angle in degrees, measured clockwise from North. | +| vSpeed | VerticalSpeed | M | 1 | Vertical Speed in kilometres per hour. | +| vDirection | VerticalDirection | M | 1 | Vertical Direction: upwards or downwards. | +| hUncertainty | SpeedUncertainty | M | 1 | Uncertainty of horizontal speed in kilometres per hour. | +| vUncertainty | SpeedUncertainty | M | 1 | Uncertainty of vertical speed in kilometres per hour. | + +6.1.6.2.22 Type: UncertaintyEllipse + +**Table 6.1.6.2.22-1: Definition of type UncertaintyEllipse** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------|---|-------------|-----------------------------------------------------------| +| semiMajor | Uncertainty | M | 1 | Indicates the semi-major axis of the uncertainty ellipse. | +| semiMinor | Uncertainty | M | 1 | Indicates the semi-minor axis of the uncertainty ellipse. | +| orientationMajor | Orientation | M | 1 | Indicates the orientation angle of the major axis. | + +6.1.6.2.23 Type: UeLcsCapability + +**Table 6.1.6.2.23-1: Definition of type UeLcsCapability** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lppSupport | boolean | O | 0..1 | Indicates whether the UE supports LPP or not.

- true (default): LPP supported by the UE
- false: LPP not supported by the UE | +| ciotOptimisation | boolean | O | 0..1 | Indicates whether the UE supports and is allowed to use Control Plane CIoT 5GS Optimisation to send an event report for periodic or triggered location or not. Refer to 3GPP TS 23.273 [19] clause 6.7 for more detail.

- true: Control Plane CIoT 5GS Optimisation is supported by the UE and allowed
- false (default): Control Plane CIoT 5GS Optimisation not supported by the UE or not allowed | + +##### 6.1.6.2.24 Type: PeriodicEventInfo + +Table 6.1.6.2.24-1: Definition of type PeriodicEventInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|---------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reportingAmount | ReportingAmount | M | 1 | Number of event reports | +| reportingInterval | ReportingInterval | M | 1 | Interval of event reports | +| reportingInfiniteInd | boolean | O | 0..1 |

When present, this IE shall be set to the value true, indicating that as many reports as possible to be generated during allowed duration (8639999 seconds).

When this IE is present in a request, the reportingAmount should be set to the largest possible value (see NOTE) for backward compatibility consideration. An LMF supporting this IE shall ignore the reportingAmount IE and an LMF not supporting this IE will use reportingAmount IE to generate indicated number of reports as legacy.

When this IE is present in a response, it indicates that this IE is supported and accepted by the LMF.

| +| reportingIntervalMs | ReportingIntervalMs | O | 0..1 |

When present, this IE shall indicate the Interval of event reports in milliseconds.

When this IE is present in a request, the reportingInterval is set to 1 for backward compatible consideration. An LMF supporting this IE shall ignore the reportingInterval IE; an LMF not supporting this IE will use reportingInterval IE to generate report with minimal interval as legacy, i.e. 1 second.

When this IE is present in a response, it indicates that this IE is supported by the LMF and it shall indicate the value accepted by the LMF.

| + +NOTE: reportingAmount x reportingInterval shall not exceed 8639999 (99 days, 23 hours, 59 minutes and 59 seconds) for compatibility with OMA MLP and RLP. + +##### 6.1.6.2.25 Type: AreaEventInfo + +Table 6.1.6.2.25-1: Definition of type AreaEventInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| areaDefinition | array(ReportingArea) | M | 1..250 | One or more reporting areas | +| occurrenceInfo | OccurrenceInfo | O | 0..1 | One time only report indication | +| minimumInterval | MinimumInterval | C | 0..1 | Minimum interval between event reports.
This IE shall not be included if occurrenceInfo is present and set to one time event. | +| maximumInterval | MaximumInterval | C | 0..1 | Maximum interval between event reports.
This IE shall not be included if occurrenceInfo is present and set to one time event. | +| samplingInterval | SamplingInterval | O | 0..1 | Maximum time interval between consecutive evaluations by a UE of a trigger event. | +| reportingDuration | ReportingDuration | O | 0..1 | Maximum duration of event reporting. | +| reportingLocationReq | boolean | C | 0..1 | This IE shall be present and set to true if a location estimate is required for each event report.

When present, it shall be set as follows:
- true: location report is required.

- false: location report is not required. | + +##### 6.1.6.2.26 Type: ReportingArea + +Table 6.1.6.2.26-1: Definition of type ReportingArea + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------| +| areaType | ReportingAreaType | M | 1 | Type of reporting area. | +| tai | Tai | C | 1 | TAI for EPS or 5GS.
This IE shall be present if the reporting area type is EPS TAI or 5GS TAI. | +| ecgi | Ecgi | C | 1 | ECGI.
This IE shall be present if the reporting area type is ECGI. | +| ncgi | Ncgi | C | 1 | NCGI.
This IE shall be present if the reporting area type is NCGI. | +| NOTE: One of tai, ecgi or ncgi shall be included. | | | | | + +##### 6.1.6.2.27 Type: MotionEventInfo + +Table 6.1.6.2.27-1: Definition of type MotionEventInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| linearDistance | LinearDistance | M | 1 | Minimum linear (straight line) distance for motion event reports. | +| occurrenceInfo | OccurrenceInfo | O | 0..1 | One time only report indication | +| minimumInterval | MinimumInterval | C | 0..1 | Minimum interval between event reports.
This IE shall not be included if occurrenceInfo is present and set to one time event. | +| maximumInterval | MaximumInterval | C | 0..1 | Maximum interval between event reports.
This IE shall not be included if occurrenceInfo is present and set to one time event. | +| samplingInterval | SamplingInterval | O | 0..1 | Maximum time interval between consecutive evaluations by a UE of a trigger event. | +| reportingDuration | ReportingDuration | O | 0..1 | Maximum duration of event reporting. | +| reportingLocationReq | boolean | C | 0..1 | This IE shall be present and set to true if a location estimate is required for each event report.

When present, it shall be set as follows:
- true: location report is required.

- false: location report is not required. | + +##### 6.1.6.2.28 Void + +##### 6.1.6.2.29 Type: CancelLocData + +Table 6.1.6.2.29-1: Definition of type CancelLocData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| hGMLCCallbackURI | Uri | M | 1 | Callback URI of the H-GMLC | +| LDRReference | LDRReference | M | 1 | LDR Reference | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | + +##### 6.1.6.2.30 Type: LocContextData + +Table 6.1.6.2.30-1: Definition of type LocContextData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| amfId | NfInstanceId | M | 1 | Indicates the AMF Instance serving the UE. LMF shall use the AMF Instance to forward LCS related N1/N2 messages to the UE/RAN. | +| locationQoS | LocationQoS | C | 0..1 | This IE shall contain the location QoS if available. | +| supportedGADShapes | array(SupportedGADShapes) | C | 0..N | This IE shall contain the supported GAD shapes if available. | +| supi | Supi | C | 0..1 | This IE shall contain the SUPI if available. | +| gpsi | Gpsi | C | 0..1 | This IE shall contain the GPSI if available. | +| ldrType | LdrType | M | 1 | The type of LDR | +| hgmlcCallbackURI | Uri | M | 1 | Callback URI of the H-GMLC | +| ldrReference | LdrReference | M | 1 | LDR Reference | +| periodicEventInfo | PeriodicEventInfo | C | 0..1 | Information for periodic event reporting | +| areaEventInfo | AreaEventInfo | C | 0..1 | Information for area event reporting | +| motionEventInfo | MotionEventInfo | C | 0..1 | Information for motion event reporting | +| eventReportMessage | EventReportMessage | M | 1 | Contains an embedded event report | +| eventReportingStatus | EventReportingStatus | O | 0..1 | Status of event reporting | +| ueLocationInfo | UELocationInfo | O | 0..1 | Location information for the target UE | +| cloT5GSOptimisation | boolean | C | 0..1 | This IE shall be present if it was received from AMF. When present, it shall be set as follows:
- true: Control Plane CLoT 5GS Optimisation was used and no signalling or data is currently pending for the UE at the AMF.
- false (default): Control Plane CLoT 5GS Optimisation was not used or signalling or data is currently pending for the UE at the AMF. | +| ecgi | Ecgi | C | 0..1 | When present, this IE shall indicate the identifier of the E-UTRAN cell serving the UE.
This IE shall be present if it was received from AMF. | +| ncgi | Ncgi | C | 0..1 | When present, this IE shall indicate the identifier of the NR cell serving the UE.
This IE shall be present if it was received from AMF | +| guami | Guami | C | 0..1 | This IE shall be present if it was received from AMF.

When present, it shall contain the GUAMI serving the UE. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | +| uePositioningCap | UePositioningCapabilities | O | 0..1 | When present, this IE shall indicate the positioning capabilities supported by the UE. | +| scheduledLocTime | DateTime | O | 0..1 | When present, this IE shall contain the scheduled time (in UTC) that the UE needs to be located. | +| indoorOutdoorInd | IndoorOutdoorInd | O | 0..1 | When present, this IE shall indicate whether the UE is indoor or outdoor. | +| losNlosMeasureInd | LosNlosMeasureInd | O | 0..1 | When present, this IE shall indicate whether LOS measurement or NLOS measurement is used. | +| upCumEvtRptCriteria | UpCumEvtRptCriteria | O | 0..1 | When present, this IE shall include the cumulative event report timer or the maximum number of location reporting over user plane or both. | + +NOTE: At least one of periodicEventInfo, areaEventInfo or motionEventInfo shall be present in the LocContextData structure. + +##### 6.1.6.2.31 Type: EventReportMessage + +Table 6.1.6.2.31-1: Definition of type EventReportMessage + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|------------------------------------------------------------------------------------------| +| eventClass | EventClass | M | 1 | This IE shall contain the event class for the message content specified in eventContent. | +| eventContent | RefToBinaryData | M | 1 | This IE shall reference the event report binary data corresponding to the eventClass. | + +##### 6.1.6.2.32 Type: EventReportingStatus + +Table 6.1.6.2.32-1: Definition of type EventReportingStatus + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|--------------------------------------------------------| +| eventReportCounter | EventReportCounter | O | 0..1 | This IE shall contain a count of event reports. | +| eventReportDuration | EventReportDuration | O | 0..1 | This IE shall contain the duration of event reporting. | + +##### 6.1.6.2.33 Type: UELocationInfo + +Table 6.1.6.2.33-1: Definition of type UELocationInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| locationEstimate | GeographicArea | O | 0..1 | Previous location estimate for the target UE. | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | Age of previous location estimate. | +| timestampOfLocationEstimate | DateTime | O | 0..1 | When present, this IE shall indicate the estimated UTC time when the location estimate corresponded to the UE location (i.e. when the location estimate and the actual UE location was the same). | +| velocityEstimate | VelocityEstimate | O | 0..1 | Previous velocity estimate for the target UE. | +| ageOfVelocityEstimate | AgeOfVelocityEstimate | O | 0..1 | Age of previous velocity estimate. | +| timestampOfVelocityEstimate | DateTime | O | 0..1 | When present, this IE shall indicate the estimated UTC time when the velocity estimate corresponded to the UE velocity (i.e. when the velocity estimate and the actual UE velocity was the same). | + +6.1.6.2.34 Type: EventNotifyData + +**Table 6.1.6.2.34-1: Definition of type EventNotifyData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|--------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| reportedEventType | ReportedEventType | M | 1 | This IE shall contain the type of event being reported. | | +| supi | Supi | C | 0..1 | This IE shall contain the SUPI if available. | | +| gpsi | Gpsi | C | 0..1 | This IE shall contain the GPSI if available. | | +| hgnlCallbackURI | Uri | C | 0..1 | Callback URI of the H-GMLC (NOTE 1) | | +| ldrReference | LdrReference | M | 1 | LDR Reference

When the ReportedEventType is "INTERMEDIATE_EVENT", the LMF shall set this IE to the value "NULL" and shall be ignored by the receiver. | | +| lirReference | LirReference | C | 0..1 | This IE shall be present when the ReportedEventType is set to the value "INTERMEDIATE_EVENT".

When present, this IE shall include the LIR Reference number received in the 5GC-MR-LR multiple location request. | | +| locationEstimate | GeographicArea | O | 0..1 | If present, this IE shall contain an estimate of the location of the UE in universal coordinates and the accuracy of the estimate. | | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | If present, this IE shall contain an indication of how long ago the location estimate was obtained. | | +| timestampOfLocationEstimate | DateTime | O | 0..1 | When present, this IE shall indicate the estimated UTC time when the location estimate corresponded to the UE location (i.e. when the location estimate and the actual UE location was the same). | | +| civicAddress | CivicAddress | O | 0..1 | If present, this IE shall contain a civic address. | | +| localLocationEstimate | LocalArea | O | 0..1 | When present, this IE shall indicate a local area in reference system. | | +| positioningDataList | array(PositioningMethodAndUsage) | O | 1..N | If present, this IE shall indicate the usage of each non-GNSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | | +| gnssPositioningDataList | array(GNSSPositioningMethodAndUsage) | O | 1..N | If present, this IE shall indicate the usage of each GNSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | | +| servingLMFIdentification | LMFIdentification | C | 0..1 | This IE shall be included to identify an LMF which acts as a serving LMF if a serving LMF is used. | | +| terminationCause | TerminationCause | C | 0..1 | This IE shall be included if event reporting has been terminated | | +| velocityEstimate | VelocityEstimate | O | 0..1 | If present, this IE shall contain an estimate of the velocity of the target UE, composed by horizontal speed, vertical speed, and their respective uncertainty. | | + +| | | | | | | +|---------------------------|-------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| altitude | Altitude | O | 0..1 | If present, this IE indicates the altitude of the positioning estimate. When the shape used in "locationEstimate" supports conveying the altitude parameter, this IE shall be absent. | | +| achievedQos | MinorLocationQoS | O | 0..1 | When present, this IE shall contain the achieved Location QoS
Accuracy of the estimated location.

This IE may be present if the required LCS QoS Class in the location request procedure is "MULTIPLE_QOS".

If it's absent, the required LCS QoS Class in the location request procedure is "MULTIPLE_QOS" and AccuracyFulfilmentIndicator is "REQUESTED_ACCURACY_FULFILLED", it indicates that the location QoS in the highest priority is achieved. | MUTIQOS | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | | +| indoorOutdoorInd | IndoorOutdoorInd | O | 0..1 | When present, this IE shall indicate whether the UE is indoor or outdoor. | | +| haGnssMetrics | HighAccuracyGnssMetrics | O | 0..1 | When present, this IE shall indicate the high accuracy GNSS metrics received from the device in the LPP HA-GNSS-Metrics-r17 IE as specified in 3GPP TS 37.355 [21]. | | +| losNlosMeasurement | LosNlosMeasurement | O | 0..1 | When present, this IE shall indicate whether LOS measurement or NLOS measurement is used. | | +| upLocRepStatAf | integer | O | 0..1 | When present, this IE contains the number of event reports have transferred over user plane. If the cumulative event report has been sent previously, this IE contains the number of event reports have transferred over user plane since the last cumulative event report was sent | | +| relatedApplicationLayerId | ApplicationLayerId | O | 0..1 | Identifies the application layer ID of the related UE for ranging and sidelink positioning, such as located UE, reference UE, etc. | Ranging_SL | +| rangeDirection | RangeDirection | O | 0..1 | When present, this IE identifies a range and direction from a point A to a point B, comprising a range from point A to point B, an azimuth direction from point A to point B and an elevation direction from point A to point B. | Ranging_SL | +| 2dRelativeLocation | 2DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 2D location with uncertainty ellipse, characterised by a point described in 2D local co-ordinates with origin corresponding to another known point, distances r1 and r2 and an angle of orientation A. | Ranging_SL | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------|--------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| 3dRelativeLocation | 3DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 3D location with uncertainty ellipsoid, characterised by a point described in 3D local co-ordinates with origin corresponding to another known point, distances r1 (the "semi-major uncertainty"), r2 (the "semi-minor uncertainty") and r3 (the "vertical uncertainty") and an angle of orientation A (the "angle of the major axis"). | Ranging_SL | +| relativeVelocity | VelocityEstimate | O | 0..1 | When present, this IE identifies UE velocity relative to the UE identified with relatedApplicationLayerId. | Ranging_SL | +| NOTE 1: If the reportedEventType is not "INTERMEDIATE_EVENT", the hgmlcCallBackURI shall be included when the consumer NF is not the H-GMLC. | | | | | | + +6.1.6.2.35 Type: UeConnectivityState + +**Table 6.1.6.2.35-1: Definition of type UeConnectivityState** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------|---|-------------|-----------------------------------------------------------------------------------------| +| accessType | AccessType | M | 1 | Shall indicate the access type of the UE. | +| connectivitystate | CmState | O | 0..1 | When present, it shall indicate the UE connectivity state in the indicated access type. | + +6.1.6.2.36 Type: LocalOrigin + +**Table 6.1.6.2.36-1: Definition of type LocalOrigin** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------|---|-------------|-------------------------------------------------------------------------------| +| coordinateId | string | M | 1 | This IE defines a known reference point which configured by the PLMN operator | +| point | GeographicalCoordinates | O | 0..1 | Indicates a geographic point represented by its longitude and latitude. | + +6.1.6.2.37 Type: RelativeCartesianLocation + +**Table 6.1.6.2.37-1: Definition of type RelativeCartesianLocation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| x | Float | M | 1 | Indicates the value (in the unit of meters) on x-axis of the relative location in the cartesian system.

Positive value represents easting from reference point (origin). | +| y | Float | M | 1 | Indicates the value (in the unit of meters) on y-axis of the relative location in the cartesian system.

Positive value represents northing from reference point (origin). | +| z | Float | O | 0..1 | Indicates the value (in the unit of meters) on z-axis of the relative location in the cartesian system for a 3D-Point.

Positive value represents height above reference point (origin). | + +6.1.6.2.38 Type: Local2dPointUncertaintyEllipse + +**Table 6.1.6.2.38-1: Definition of type Local2dPointUncertaintyEllipse** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|---------------------------|---|-------------|--------------------------------------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE". | +| localOrigin | LocalOrigin | M | 1 | Indicates the local origin in the local Cartesian co-ordinates system configured by the PLMN operator. | +| point | RelativeCartesianLocation | M | 1 | Indicates a 2D-point (specified by "x" and "y" coordinates) relative to origin in reference system. | +| uncertaintyEllipse | UncertaintyEllipse | M | 1 | Indicates an uncertainty ellipse. | +| confidence | Confidence | M | 1 | Indicates the value of confidence. | + +6.1.6.2.39 Type: Local3dPointUncertaintyEllipsoid + +**Table 6.1.6.2.39-1: Definition of type Local3dPointUncertaintyEllipsoid** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID". | +| localOrigin | LocalOrigin | M | 1 | Indicates the local origin in the local Cartesian co-ordinates system configured by the PLMN operator. | +| point | RelativeCartesianLocation | M | 1 | Indicates a 3D-point (specified by "x", "y" and "z" coordinates) relative to origin in reference system. | +| uncertaintyEllipsoid | UncertaintyEllipsoid | M | 1 | Indicates the uncertainty ellipsoid | +| confidence | Confidence | M | 1 | Indicates the value of confidence. | + +6.1.6.2.40 Type: UncertaintyEllipsoid + +**Table 6.1.6.2.40-1: Definition of type UncertaintyEllipsoid** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------|---|-------------|-------------------------------------------------------------| +| semiMajor | Uncertainty | M | 1 | Indicates the semi-major axis of the uncertainty ellipsoid. | +| semiMinor | Uncertainty | M | 1 | Indicates the semi-minor axis of the uncertainty ellipsoid. | +| vertical | Uncertainty | M | 1 | Indicates the vertical axis of the uncertainty ellipsoid. | +| orientationMajor | Orientation | M | 1 | Indicates the orientation angle of the major axis. | + +##### 6.1.6.2.41 Type: LocalArea + +Table 6.1.6.2.41-1: Definition of type LocalArea as a list of mutually exclusive alternatives + +| Data type | Cardinality | Discriminator property name | Discriminator mapping | Description | +|----------------------------------|-------------|-----------------------------|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local2dPointUncertaintyEllipse | 1 | shape | LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE | Local area consisting of a point described in 2D local coordinates relative to an origin in a reference system, plus an uncertainty ellipse and a confidence value. | +| Local3dPointUncertaintyEllipsoid | 1 | shape | LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID | Local area consisting of a point described in 3D local coordinates relative to an origin in a reference system, distances r1 (the "semi-major uncertainty"), r2 (the "semi-minor uncertainty") and r3 (the "vertical uncertainty") and an angle of orientation A (the "angle of the major axis"). | + +##### 6.1.6.2.42 Type: UeAreaIndication + +Table 6.1.6.2.42-1: Definition of type UeAreaIndication + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| country | string | C | 0..1 | This IE shall be present if the country or the area of country where the UE is located is determined. When present, this IE contains two-letter ISO 3166 country code in capital ASCII letters, e.g., DE or US IETF RFC 4776 [6] | +| internationalAreaInd | boolean | C | 0..1 | Indicates international area

When present, it shall be set as follows:
- true: UE is located in international area.

- false (default): UE is not located in international area. | + +NOTE: Either country or internationalAreaInd shall be present. + +##### 6.1.6.2.43 Type: MinorLocationQoS + +Table 6.1.6.2.43-1: Definition of type MinorLocationQoS + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------| +| hAccuracy | Accuracy | O | 0..1 | Horizontal accuracy | +| vAccuracy | Accuracy | O | 0..1 | Vertical accuracy | + +##### 6.1.6.2.44 Type: MbsrInfo + +Table 6.1.6.2.44-1: Definition of type MbsrInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|----------------------|---------------| +| ecgi | Ecgi | O | 0..1 | E-UTRA Cell Identity | | +| ncgi | Ncgi | O | 0..1 | NR Cell Identity | | + +6.1.6.2.45 Type: LocMeasurementReq + +**Table 6.1.6.2.45-1: Definition of type LocMeasurementReq** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------|----------------|---|-------------|---------------------------------------------------------------------| +| ecgi | Ecgi | O | 0..1 | E-UTRA Cell Identity (NOTE) | +| ncgi | Ncgi | O | 0..1 | NR Cell Identity (NOTE) | +| preCalcuLocEstimate | GeographicArea | O | 0..1 | Pre-calculated location estimate of target UE | +| timestampOfPreCalcULocEstimate | DateTime | O | 0..1 | Timestamp (in UTC) of pre-calculated location estimate of target UE | +| NOTE: Either the "ecgi" attribute or the "ncgi" attribute shall be included. | | | | | + +6.1.6.2.46 Type: LocMeasurementResp + +**Table 6.1.6.2.46-1: Definition of type LocMeasurementResp** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| locMeasurements | LocMeasurements | M | 1 | PRU Location Measurements | +| locationEstimate | GeographicArea | M | 1 | For a request for triggered location where location estimates are not required, the location estimate can be based on current serving cell. | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | When present, this IE shall indicate age of the location estimate. | +| timestampOfLocationEstimate | DateTime | O | 0..1 | When present, this IE shall indicate the estimated UTC time when the location estimate corresponded to the UE location (i.e. when the location estimate and the actual UE location was the same). | +| velocityEstimate | VelocityEstimate | O | 0..1 | When present, this IE shall indicate velocity estimate. | +| localLocationEstimate | LocalArea | O | 0..1 | When present, this IE shall indicate a local area in reference system. | + +6.1.6.2.47 Type: LocMeasurements + +**Table 6.1.6.2.47-1: Definition of type LocMeasurements** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------| +| rstd | Integer | O | 0..1 | Reference Signal Time Difference (RSTD), as specified in 3GPP TS 38.305 [3] | + +Editor's note: The details of LocMeasurements are based on Stage2's details and referred to TS 23.273 and TS 38.305. + +6.1.6.2.48 Type: HighAccuracyGnssMetrics + +**Table 6.1.6.2.48-1: Definition of type HighAccuracyGnssMetrics** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nrOfUsedSatellites | integer | M | 1 | Indicates the number of satellites used for the high accuracy GNSS positioning method.
Minimum: 0. Maximum: 64. | +| hdopi | Integer | O | 0..1 | When present, this IE shall indicate the horizontal dilution of precision for the location estimate, scale factor 0.1.
Minimum: 1. Maximum: 256. | +| pdopi | integer | O | 0..1 | When present, this IE shall indicate the 3D position dilution of precision, scale factor 0.1.
Minimum: 1. Maximum: 256. | +| age | integer | O | 0..1 | When present, this IE shall indicate the age of the most recent used assistance data for high accuracy GNSS, scale factor 0.1 second.
Minimum: 0. Maximum: 99. | +| fixType | FixType | O | 0..1 | When present, this IE shall indicate the the positioning fix type. | + +6.1.6.2.49 Type: UpNotifyData + +**Table 6.1.6.2.49-1: Definition of type UpNotifyData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| ldrReference | LdrReference | M | 1 | LDR Reference | +| upConnectionStatus | UpConnectionStatus | M | 1 | UP Connection Status | +| targetLMFIdentification | LMFIdentification | O | 0..1 | This IE shall be present if the UpConnectionStatus is set to "MOVE".
When present, this IE shall indicate Target LMF ID. | + +6.1.6.2.50 Type: UpSubscription + +**Table 6.1.6.2.50-1: Definition of type UpSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------|---|-------------|-----------------------------------------| +| upNotifyCallBackURL | Uri | M | 1 | Callback URI of the NF Service Consumer | +| supi | Supi | M | 1 | SUPI | +| gpsi | Gpsi | O | 0..1 | GPSI | + +6.1.6.2.51 Type: RelatedUE + +**Table 6.1.6.2.51-1: Definition of type RelatedUE** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| applicationlayerId | ApplicationlayerId | M | 1 | The application layer identification of the UE | +| relatedUETYPE | RelatedUETYPE | M | 1 | The type of the related UE for ranging and sidelink positioning, such as located UE, reference UE, etc. | + +##### 6.1.6.2.52 Type: UpConfig + +Table 6.1.6.2.52-1: Definition of type UpConfig + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------|--------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| upNotifyCallBackURI | Uri | M | 1 | Callback URI of the NF Service Consumer | +| supi | Supi | O | 0..1 | SUPI (NOTE) | +| gpsi | Gpsi | O | 0..1 | GPSI (NOTE) | +| amfReallocationInd | boolean | O | 0..1 | Indicates AMF reallocation indication.

When present, it shall be set as follows:
- true: AMF reallocated.

- false (default): AMF not reallocated. | +| lcsUpConnectionInd | LcsUpConnectionInd | O | 0..1 | LCS-UP connection indication | +| targetLMFIdentification | LMFIdentification | O | 0..1 | Target LMF ID | +| NOTE: At least one of the supi or gpsi shall be present in the UpConfig structure. | | | | | + +##### 6.1.6.2.53 Type: RangeDirection + +Table 6.1.6.2.53-1: Definition of type RangeDirection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-----------|---|-------------|-------------------------------------------------------------|---------------| +| range | number | O | 0..1 | Identifies the distance from point A to point B. | | +| azimuthDirection | Angle | O | 0..1 | Identifies the azimuth direction from point A to point B. | | +| elevationDirection | Angle | O | 0..1 | Identifies the elevation direction from point A to point B. | | + +##### 6.1.6.2.54 Type: 2DRelativeLocation + +Table 6.1.6.2.54-1: Definition of type 2DRelativeLocation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------|---|-------------|-----------------------------------------------------------|---------------| +| semiMinor | Uncertainty | M | 1 | Indicates the semi-major axis of the uncertainty ellipse. | | +| semiMajor | Uncertainty | M | 1 | Indicates the semi-minor axis of the uncertainty ellipse. | | +| orientationAngle | Angle | M | 1 | Identifies the angle of orientation A. | | + +##### 6.1.6.2.55 Type: 3DRelativeLocation + +Table 6.1.6.2.55-1: Definition of type 3DRelativeLocation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-------------|---|-------------|-----------------------------------------------------------|---------------| +| semiMinor | Uncertainty | M | 1 | Indicates the semi-major axis of the uncertainty ellipse. | | +| semiMajor | Uncertainty | M | 1 | Indicates the semi-minor axis of the uncertainty ellipse. | | +| verticalUncertainty | Uncertainty | M | 1 | Indicates the vertical uncertainty. | | +| orientationAngle | Angle | M | 1 | Identifies the angle of orientation A. | | + +6.1.6.2.56 Type: AddLocationDatas + +**Table 6.1.6.2.56-1: Definition of type AddLocationDatas** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------|---|-------------|------------------------------------|---------------| +| addLocationDatas | array(LocationData) | O | 1..N | Contains one or more LocationData. | | + +6.1.6.2.57 Type: AddEventNotifyDatas + +**Table 6.1.6.2.57-1: Definition of type AddEventNotifyDatas** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|---------------------------------------|---------------| +| addEventNotifyDatas | array(LocationData) | O | 1..N | Contains one or more EventNotifyData. | | + +6.1.6.2.58 Type: LocationDataExt + +**Table 6.1.6.2.58-1: Definition of type LocationDataExt as a list of data types to be combined** + +| Data type | Cardinality | Description | Applicability | +|------------------|-------------|--------------------------|---------------| +| LocationData | 1 | Location Data | | +| AddLocationDatas | 1 | Additional Location Data | | + +6.1.6.2.59 Type: EventNotifyDataExt + +**Table 6.1.6.2.59-1: Definition of type EventNotifyDataExt as a list of data types to be combined** + +| Data type | Cardinality | Description | Applicability | +|---------------------|-------------|----------------------------------------|---------------| +| EventNotifyData | 1 | Positioning event notify | | +| AddEventNotifyDatas | 1 | Additional positioning event(s) notify | | + +6.1.6.2.60 Type: MappedLocationQoSEps + +**Table 6.1.6.2.60-1: Definition of type MappedLocationQoSEps** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------|---------------| +| hAccuracy | Accuracy | M | 1 | Mapped Horizontal accuracy for EPS | | +| vAccuracy | Accuracy | O | 0..1 | Mapped Vertical accuracy for EPS | | + +6.1.6.2.61 Type: AdditionalUeInfo + +**Table 6.1.6.2.61-1: Definition of type AdditionalUeInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------------------|---------------| +| ecgi | Ecgi | O | 0..1 | E-UTRA Cell Identity of MBSR UE (i.e., IAB UE) | | +| ncgi | Ncgi | O | 0..1 | NR Cell Identity of MBSR UE (i.e., IAB UE) | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Altitude | number | Double-precision float value of the altitude, expressed in meters.
Minimum: -32767. Maximum: 32767.
Format: double. | +| Angle | integer | Integer value of the angle, expressed in degrees.
Minimum: 0. Maximum: 360. | +| Uncertainty | number | Float value of uncertainty, expressed in meters.
Minimum: 0
Format: float. | +| Orientation | integer | Integer value of the orientation angle, expressed in degrees.
Minimum: 0. Maximum: 180. | +| Confidence | integer | Integer value of the confidence, expressed in percentage value.
Minimum: 0. Maximum: 100. | +| Accuracy | number | Float value of accuracy, expressed in meters.
Minimum: 0
Format: float. | +| InnerRadius | integer | Integer value of the inner radius, expressed in meters.
Minimum: 0. Maximum: 327675.
Format: int32. | +| CorrelationID | string | LCS Correlation ID. The correlation ID shall be of a minimum length of 1 character and maximum length of 255 characters. | +| AgeOfLocationEstimate | integer | Integer value of the age of the location estimate, expressed in minutes.
Minimum: 0. Maximum: 32767. | +| HorizontalSpeed | number | Float value of horizontal speed, expressed in kilometres per hour.
Minimum: 0. Maximum: 2047.
Format: float. | +| VerticalSpeed | number | Float value of horizontal speed, expressed in kilometres per hour.
Minimum: 0. Maximum: 255.
Format: float. | +| SpeedUncertainty | number | Float value of speed uncertainty, expressed in kilometres per hour.
Minimum: 0. Maximum: 255.
Format: float. | +| BarometricPressure | integer | This IE specifies the measured uncompensated atmospheric pressure in units of Pascal (Pa).
Minimum: 30000. Maximum: 115000. | +| LcsServiceType | integer | The LCS service type as defined in 3GPP TS 22.071 [17] and clause 17.7.8 of 3GPP TS 29.002 [18].
Minimum: 0. Maximum: 127. | +| LdrReference | string | LDR Reference encoded as a string of hexadecimal characters. The LdrReference shall be of a minimum length of 2 characters and maximum length of 510 characters. | +| LirReference | string | LIR Reference encoded as a string of hexadecimal characters. The LdrReference shall be of a minimum length of 2 characters and maximum length of 510 characters. | +| ReportingAmount | integer | Number of required periodic event reports.
Minimum: 1. Maximum: 8639999. | + +| | | | +|---------------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ReportingInterval | integer | Event reporting periodic interval in seconds.
Minimum: 1. Maximum: 8639999.
ReportingInterval x ReportingAmount shall not exceed 8639999. | +| ReportingIntervalMs | integer | Event reporting periodic interval in milliseconds.
Minimum: 1. Maximum: 999. | +| MinimumInterval | integer | Minimum interval between event reports in seconds.
Minimum: 1. Maximum: 32767. | +| MaximumInterval | integer | Maximum interval between event reports in seconds.
Minimum: 1. Maximum: 86400. | +| SamplingInterval | integer | Maximum time interval between consecutive evaluations by a UE of a trigger event, in seconds.
Minimum: 1. Maximum: 3600 | +| ReportingDuration | integer | Maximum duration of event reporting, in seconds.
Minimum: 1. Maximum: 8640000. | +| LinearDistance | integer | The minimum straight line distance moved by a UE to trigger a motion event report, in meters.
Minimum: 1. Maximum: 10000. | +| LMFIdentification | string | The serving LMF identification as defined in 3GPP TS 23.273 [19], encoded as a string of hexadecimal characters. | +| EventReportCounter | integer | Number of event reports received from the target UE.
Minimum: 1. Maximum: 8640000.
Note: the current event report is included in the count. | +| EventReportDuration | integer | Duration of event reporting, in seconds.
Minimum: 0. Maximum: 8640000.
Note: the duration starts when event reporting is activated in the UE and extends to the current time. | +| UePositioningCapabilities | Bytes | Positioning capabilities supported by the UE.

String with format "byte" as defined in OpenAPI Initiative [14], i.e. base64-encoded characters, encoding the "ProvideCapabilities-r9-IEs" IE as specified in clause 6.3 of 3GPP TS 37.355 [21] (start from octet 1). | + +##### 6.1.6.3.3 Enumeration: ExternalClientType + +The enumeration ExternalClientType represents the different types of clients of the location service. + +**Table 6.1.6.3.3-1: Enumeration ExternalClientType** + +| Enumeration value | Description | +|-------------------------------------------|-------------------------------------------------------------| +| "EMERGENCY_SERVICES" | External client for emergency services | +| "VALUE_ADDED_SERVICES" | External client for value added services | +| "PLMN_OPERATOR_SERVICES" | External client for PLMN operator services | +| "LAWFUL_INTERCEPT_SERVICES" | External client for Lawful Intercept services | +| "PLMN_OPERATOR_BROADCAST_SERVICES" | External client for PLMN Operator Broadcast services | +| "PLMN_OPERATOR_OM" | External client for PLMN Operator O&M | +| "PLMN_OPERATOR_ANONYMOUS_STATISTICS" | External client for PLMN Operator anonymous statistics | +| "PLMN_OPERATOR_TARGET_MS_SERVICE_SUPPORT" | External client for PLMN Operator target MS service support | + +##### 6.1.6.3.4 Enumeration: SupportedGADShapes + +The enumeration SupportedGADShapes represents the different types, or shapes, of geographic areas supported by the system. + +**Table 6.1.6.3.4-1: Enumeration SupportedGADShapes** + +| Enumeration value | Description | +|----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "POINT" | Ellipsoid Point | +| "POINT_UNCERTAINTY_CIRCLE" | Ellipsoid point with uncertainty circle | +| "POINT_UNCERTAINTY_ELLIPSE" | Ellipsoid point with uncertainty ellipse | +| "POLYGON" | Polygon | +| "POINT_ALTITUDE" | Ellipsoid point with altitude | +| "POINT_ALTITUDE_UNCERTAINTY" | Ellipsoid point with altitude and uncertainty ellipsoid | +| "ELLIPSOID_ARC" | Ellipsoid Arc | +| "LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE" | Local 2D point with uncertainty ellipse | +| "LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID" | Local 3D point with uncertainty ellipsoid | +| "RANGE_DIRECTION" | Range and direction from a point A to a point B, comprising a range from point A to point B, an azimuth direction from point A to point B and an elevation direction from point A to point B | +| "RELATIVE_2D_LOCATION_UNCERTAINTY_ELLIPSE" | Relative 2D location with uncertainty ellipse, characterised by a point described in 2D local co-ordinates with origin corresponding to another known point, distances r1 and r2 and an angle of orientation A. | +| "RELATIVE_3D_LOCATION_UNCERTAINTY_ELLIPSOID" | Relative 3D location with uncertainty ellipsoid, characterised by a point described in 3D local co-ordinates with origin corresponding to another known point, distances r1 (the "semi-major uncertainty"), r2 (the "semi-minor uncertainty") and r3 (the "vertical uncertainty") and an angle of orientation A (the "angle of the major axis"). | + +##### 6.1.6.3.5 Enumeration: ResponseTime + +The enumeration ResponseTime represents the acceptable delay in the determination of the location of the UE. + +**Table 6.1.6.3.5-1: Enumeration ResponseTime** + +| Enumeration value | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------| +| "LOW_DELAY" | Location request is expected with low delay level. | +| "DELAY_TOLERANT" | Location request is delay tolerant. | +| "NO_DELAY " | Location request is expected with no delay (NOTE) | +| NOTE: The value is only used in the interface between GMLC and AF/LCS client via NEF, not further delivered to other NFs in the network. After receiving the enumeration value, the GMLC shall immediately return any location estimate, local location or civic location that it currently has. The GMLC shall return either the Initial or Last Known Location of the Target UE. If no location estimate or Dispatchable Location is available, the GLMC shall return the failure indication and may optionally initiate procedures to obtain a location estimate or Dispatchable Location (e.g. to be available for a later request). | | + +##### 6.1.6.3.6 Enumeration: PositioningMethod + +The enumeration PositioningMethod represents the method used to determine the location of the UE. + +**Table 6.1.6.3.6-1: Enumeration PositioningMethod** + +| Enumeration value | Description | +|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| "CELLID" | Cell ID positioning method | +| "ECID" | Enhanced cell ID methods based on LTE signals | +| "OTDOA" | Observed time difference of arrival positioning based on LTE signals | +| "BAROMETRIC_PRESSURE" | Positioning method based on barometric Pressure Sensor | +| "WLAN" | WLAN positioning | +| "BLUETOOTH" | Bluetooth positioning | +| "MBS" | Terrestrial Beacon System (TBS) positioning based on MBS signals | +| "MOTION_SENSOR" | Positioning method based on motion Sensor | +| "DL_TDOA" | Downlink Time Difference of Arrival (DL-TDOA) based on NR signals | +| "DL_AOD" | Downlink Angle-of-Departure (DL-AoD) based on NR signals | +| "MULTI-RTT" | Multi-Round Trip Time Positioning (Multi-RTT based on NR signals). | +| "NR_ECID" | NR enhanced cell ID methods (NR E-CID) based on NR signals. | +| "UL_TDOA" | Uplink Time Difference of Arrival (UL-TDOA) based on NR signals | +| "UL_AOA" | Uplink Angle of Arrival (UL-AoA), including the Azimuth of Arrival (A-AoA) and the Zenith of Arrival (Z-AoA) based on NR signals. | +| "NETWORK_SPECIFIC" | Network specific position methods. | + +##### 6.1.6.3.7 Enumeration: PositioningMode + +The enumeration PositioningMode represents the mode used to determine the location of the UE when a certain positioning method is used. + +**Table 6.1.6.3.7-1: Enumeration PositioningMode** + +| Enumeration value | Description | +|-------------------|-------------------| +| "UE_BASED" | UE-based mode | +| "UE_ASSISTED" | UE-assisted mode | +| "CONVENTIONAL" | Conventional mode | + +##### 6.1.6.3.8 Enumeration: GnssId + +The enumeration GnssId represents the different GNSS systems. + +**Table 6.1.6.3.8-1: Enumeration GnssId** + +| Enumeration value | Description | +|-------------------|--------------------------------------| +| "GPS" | GPS | +| "GALILEO" | Galileo | +| "SBAS" | Space Based Augmentation Systems | +| "MODERNIZED_GPS" | Modernized GPS | +| "QZSS" | Quasi Zenith Satellite System | +| "GLONASS" | Global Navigation Satellite System | +| "BDS" | BeiDou Navigation Satellite System | +| "NAVIC" | Navigation with Indian Constellation | + +##### 6.1.6.3.9 Enumeration: Usage + +The enumeration Usage represents the type of usage made of the location measurement from the UE. + +**Table 6.1.6.3.9-1: Enumeration Usage** + +| Enumeration value | Description | +|---------------------------------------------|----------------------------------------------------------| +| "UNSUCCESS" | Not successful | +| "SUCCESS_RESULTS_NOT_USED" | Successful result not used | +| "SUCCESS_RESULTS_USED_TO_VERIFY_LOCATION" | Successful result used to verify the location estimate | +| "SUCCESS_RESULTS_USED_TO_GENERATE_LOCATION" | Successful result used to generate the location estimate | +| "SUCCESS_METHOD_NOT_DETERMINED" | Successful method not determined | + +##### 6.1.6.3.10 Enumeration: LcsPriority + +The enumeration LcsPriority represents the priority of the LCS client. + +**Table 6.1.6.3.10-1: Enumeration LcsPriority** + +| Enumeration value | Description | +|--------------------|----------------------------------| +| "HIGHEST_PRIORITY" | LCS client with highest priority | +| "NORMAL_PRIORITY" | LCS client with normal priority | + +##### 6.1.6.3.11 Enumeration: VelocityRequested + +The enumeration VelocityRequested represents the indication of velocity requirement. + +**Table 6.1.6.3.11-1: Enumeration VelocityRequested** + +| Enumeration value | Description | +|-----------------------------|-----------------------------------| +| "VELOCITY IS NOT REQUESTED" | velocity estimate is required | +| "VELOCITY IS REQUESTED" | velocity estimate is not required | + +##### 6.1.6.3.12 Enumeration: AccuracyFulfilmentIndicator + +The enumeration AccuracyFulfilmentIndicator represents whether the requested accuracy was fulfilled or not. + +**Table 6.1.6.3.12-1: Enumeration AccuracyFulfilmentIndicator** + +| Enumeration value | Description | +|------------------------------------|-------------------------------------| +| "REQUESTED_ACCURACY_FULFILLED" | requested accuracy is fulfilled | +| "REQUESTED_ACCURACY_NOT_FULFILLED" | requested accuracy is not fulfilled | + +##### 6.1.6.3.13 Enumeration: VerticalDirection + +The enumeration VerticalDirection represents the direction (upward/downward) of the vertical speed. + +**Table 6.1.6.3.13-1: Enumeration VerticalDirection** + +| Enumeration value | Description | +|-------------------|----------------------------| +| "UPWARD" | Vertical speed is upward | +| "DOWNWARD" | Vertical speed is downward | + +##### 6.1.6.3.14 Enumeration: LdrType + +**Table 6.1.6.3.14-1: Enumeration LdrType** + +| Enumeration value | Description | +|----------------------|-------------------------| +| "UE_AVAILABLE" | UE available event | +| "PERIODIC" | Periodic event | +| "ENTERING_INTO_AREA" | Entering area event | +| "LEAVING_FROM_AREA" | Leaving area event | +| "BEING_INSIDE_AREA" | Being inside area event | +| "MOTION" | Motion event | + +##### 6.1.6.3.15 Enumeration: ReportingAreaType + +The enumeration ReportingAreaType indicates the type of a reporting area. + +**Table 6.1.6.3.15-1: Enumeration ReportingAreaType** + +| Enumeration value | Description | +|--------------------------------------|-------------| +| "EPS_TRACKING_AREA_IDENTITY" | EPS TAI | +| "E-UTRAN_CELL_GLOBAL_IDENTIFICATION" | ECGI | +| "5GS_TRACKING_AREA_IDENTITY" | 5GS TAI | +| "NR_CELL_GLOBAL_IDENTITY" | NCGI | + +##### 6.1.6.3.16 Enumeration: OccurrenceInfo + +The enumeration OccurrenceInfo indicates whether event reporting is one time. + +**Table 6.1.6.3.16-1: Enumeration AreaType** + +| Enumeration value | Description | +|-----------------------|-------------------------------------| +| "ONE_TIME_EVENT" | Event to be reported one-time only | +| "MULTIPLE_TIME_EVENT" | Event to be reported multiple times | + +##### 6.1.6.3.17 Enumeration: ReportingAccessType + +The enumeration ReportingAccessType indicates an allowed access type for event reporting. + +**Table 6.1.6.3.17-1: Enumeration ReportingAccessType** + +| Enumeration value | Description | +|-----------------------------|----------------------------------| +| "NR" | NG Radio access | +| "EUTRA_CONNECTED_TO_5GC" | E-UTRAN access connected to 5GC | +| "NON_3GPP_CONNECTED_TO_5GC" | Non-3GPP access connected to 5GC | +| "NR_LEO" | NR (LEO) satellite access | +| "NR_MEO" | NR (MEO) satellite access | +| "NR_GEO" | NR (GEO) satellite access | +| "NR_OTHER_SAT" | NR (OTHERSAT) satellite access | +| "EUTRA_CONNECTED_TO_EPC" | E-UTRAN access connected to EPC | + +##### 6.1.6.3.18 Enumeration: EventClass + +**Table 6.1.6.3.18-1: Enumeration EventClass** + +| Enumeration value | Description | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| "SUPPLEMENTARY_SERVICES" | A supplementary services message containing an argument for an lcs-EventReport operation as defined in 3GPP TS 24.080 [20]. | + +##### 6.1.6.3.19 Enumeration: ReportedEventType + +**Table 6.1.6.3.19-1: Enumeration ReportedEventType** + +| Enumeration value | Description | +|-------------------------------------|------------------------------------------------| +| "PERIODIC_EVENT" | Periodic reporting event | +| "ENTERING_AREA_EVENT" | Entering area reporting event | +| "LEAVING_AREA_EVENT" | Leaving area reporting event | +| "BEING_INSIDE_AREA_EVENT" | Being inside area reporting event | +| "MOTION_EVENT" | Motion reporting event | +| "MAXIMUM_INTERVAL_EXPIRATION_EVENT" | Expiration of maximum reporting interval event | +| "LOCATION_CANCELLATION_EVENT" | Cancellation of location reporting event | +| "INTERMEDIATE_EVENT" | Intermediate location reporting event | +| "DIRECT_REPORT_EVENT" | Direct location reporting event | +| "CUMULATIVE_EVENT_REPORT" | Cumulative event report for events reported | + +##### 6.1.6.3.20 Enumeration: TerminationCause + +Table 6.1.6.3.20-1: Enumeration TerminationCause + +| Enumeration value | Description | +|--------------------------|---------------------------------------| +| "TERMINATION BY_UE" | Event reporting terminated by UE | +| "TERMINATION BY_NETWORK" | Event reporting terminated by Network | +| "NORMAL_TERMINATION" | Normal Termination | + +###### 6.1.6.3.21 Enumeration: LcsQosClass + +Table 6.1.6.3.21-1: Enumeration LcsQosClass + +| Enumeration value | Description | +|-------------------|--------------------| +| "BEST_EFFORT" | Best Effort Class | +| "ASSURED" | Assured Class | +| "MULTIPLE_QOS" | Multiple QoS Class | + +MUTIQOS + +## 6.1.6.3.22 Enumeration: UeLocationServiceInd + +Table 6.1.6.3.22-1: Enumeration UeLocationServiceInd + +| Enumeration value | Description | +|----------------------------|----------------------------------| +| "LOCATION_ESTIMATE" | Request location estimate | +| "LOCATION_ASSISTANCE_DATA" | Request location assistance data | + +## 6.1.6.3.23 Enumeration: IndoorOutdoorInd + +Table 6.1.6.3.23-1: Enumeration IndoorOutdoorInd + +| Enumeration value | Description | +|-------------------|-------------| +| "INDOOR" | UE indoor. | +| "OUTDOOR" | UE outdoor. | + +## 6.1.6.3.24 Enumeration: FixType + +Table 6.1.6.3.24-1: Enumeration FixType + +| Enumeration value | Description | +|-----------------------|--------------------------------------------------------------| +| "CARRIER_PHASE_FLOAT" | Converging carrier phase floating point ambiguity resolution | +| "CARRIER_PHASE_FIX" | Converged carrier phase integer ambiguity resolution | + +## 6.1.6.3.25 Enumeration: LosNlosMeasureInd + +Table 6.1.6.3.25-1: Enumeration LosNlosMeasureInd + +| Enumeration value | Description | +|-------------------|-------------------| +| "LOS" | LOS measurement. | +| "NLOS" | NLOS measurement. | + +## 6.1.6.3.26 Enumeration: UpConnectionStatus + +The enumeration UpConnectionStatus indicates the UP Connection Status. + +**Table 6.1.6.3.26-1: Enumeration UpConnectionStatus** + +| Enumeration value | Description | +|-------------------|-------------------------------| +| "ESTABLISHED" | UP Connection Established | +| "RELEASED" | UP Connection Released | +| "MOVE" | UP Connection Move Indication | + +#### 6.1.6.3.27 Enumeration: RangingSIResult + +The enumeration RangingSIResult represents the type of result requested for ranging and sidelink positioning. + +**Table 6.1.6.3.27-1: Enumeration RangingSIResult** + +| Enumeration value | Description | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "ABSOLUTE_LOCATION" | This value indicates that the absolute location of the target UE is required. | +| "RELATIVE_LOCATION" | This value indicates that the position of the target UE relative to other UEs is required. | +| "RANGING_DIRECTION" | This value indicates that the distance between two UEs or more UEs and the direction of one UE (i.e. Target UE) from another UE (i.e. Reference UE) is required. | +| "RANGING" | This value indicates that the distance between two UEs or more UEs is required. | +| "DIRECTION" | This value indicates that the direction of one UE (i.e. Target UE) from another UE (i.e. Reference UE) is required. | +| "VELOCITY" | This value indicates that the velocities of the target UE is required. | +| "RELATIVE_VELOCITY" | This value indicates that the velocities of the target UE relative to other UEs is required. | + +#### 6.1.6.3.28 Enumeration: RelatedUEType + +The enumeration RelatedUEType represents the different roles of UE for ranging and sidelink positioning service. + +**Table 6.1.6.3.28-1: Enumeration RelatedUEType** + +| Enumeration value | Description | +|-------------------|---------------------------------------------------------------------| +| "LOCATED_UE" | UE as located UE for the ranging and sidelink positioning service | +| "REFERENCE_UE" | UE as reference UE for the ranging and sidelink positioning service | + +#### 6.1.6.3.29 Enumeration: LcsUpConnectionInd + +The enumeration LcsUpConnectionInd indicates the LCS UP Connection Indication. + +**Table 6.1.6.3.29-1: Enumeration LcsUpConnectionInd** + +| Enumeration value | Description | +|-------------------|---------------------------------------------| +| "TERMINATION" | LCS-UP connection termination indication | +| "SETUP" | LCS-UP connection set up request indication | + +#### 6.1.6.3.30 Enumeration: UeUpPositioningCapabilities + +The enumeration UeUpPositioningCapabilities represents the user plane positioning capabilities supported by the UE. + +**Table 6.1.6.3.30-1: UeUpPositioningCapabilities** + +| Enumeration value | Description | +|-------------------|--------------------------------------------------------------------| +| "LCS-UPP" | Indicates the capability to support LCS-UPP user plane positioning | +| "SUPL" | Indicates the capability to support SUPL user plane positioning | + +### 6.1.6.4 Binary data + +#### 6.1.6.4.1 Introduction + +This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see clauses 6.1.2.2.2 and 6.1.2.4). + +#### 6.1.6.4.2 LPP Message + +LPP Message shall encode a LPP message as specified in 3GPP TS 37.355 [21], using the vnd.3gpp.lpp content-type. + +## 6.1.7 Error Handling + +### 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.1.7.3 Application Errors + +The application errors defined for the Nlmf\_Location service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------|---------------------------|--------------------------------------------------------------------------| +| POSITIONING_DENIED | 403 Forbidden | The positioning procedure was denied. | +| UNSPECIFIED | 403 Forbidden | The request is rejected due to unspecified reasons. | +| UNSUPPORTED_BY_UE | 403 Forbidden | A request for periodic or triggered location is not supported by the UE. | +| PAGING_NOT_ALLOWED | 403 Forbidden | The UE cannot be paged during the UE Unaware Positioning procedure. | +| LOCATION_SESSION_UNKNOWN | 403 Forbidden | The location context was not found. | +| LOCATION_TRANSFER_NOT_SUPPORTED | 403 Forbidden | Transfer of a location context is not supported | +| INSUFFICIENT_RESOURCES | 403 Forbidden | Insufficient resources for location context transfer | +| EVENT_REPORT_UNRECOGNIZED | 403 Forbidden | The event report is unrecognizable or cannot be parsed. | +| LOCATION_MEASUREMENT_UNKNOWN | 403 Forbidden | The location measurements were not found. | +| POSITIONING_FAILED | 500 Internal Server Error | The positioning procedure failed. | +| UNREACHABLE_USER | 504 Gateway Timeout | The user could not be reached in order to perform positioning procedure. | + +## 6.1.8 Security + +As indicated in 3GPP TS 33.501 [9], the access to the Nlmf\_Location API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [10]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [11]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nlmf\_Location API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [11], clause 5.4.2.2. + +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 Nlmf\_Location service. + +The Nlmf\_Location API defines the following scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [9]: + +**Table 6.1.8-1: OAuth2 scopes defined in Nlmf\_Location API** + +| Scope | Description | +|---------------------------------------------|---------------------------------------| +| "nlmf-loc" | Access to the Nlmf_Location API. | +| "nlmf-loc:determine-location:invoke" | Access to invoke Determine Location | +| "nlmf-loc:cancel-location:invoke" | Access to invoke Cancel Location | +| "nlmf-loc:location-context-transfer:invoke" | Access to invoke Location Context | +| "nlmf-loc:location-measure:invoke" | Access to invoke Location Measurement | +| "nlmf-loc:up-subscription:invoke" | Access to invoke UP Subscription | +| "nlmf-loc:up-configure:invoke" | Access to invoke UP Config | + +## 6.1.9 Feature Negotiation + +The optional features in table 6.1.9-1 are defined for the Nlmf\_Location API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +Table 6.1.9-1: Supported Features + +| Feature number | Feature Name | M/O | Description | +|----------------|--------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Location service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | +| 2 | SAT | O | Satellite Access

Support of this feature implies the LMF shall be able to determine the geographical area identified by a country, area of a country or International area where UE is located for PLMN selection verification. | +| 3 | MUTIQOS | O | Support of Multiple Location QoSes.

This feature bit indicates whether the LMF support that more than one Location QoSes during consuming location service are required. | +| 4 | MBSR | O | Support of Mobile Base Station Relay.

This feature indicates whether the LMF support that location service capability for MBSR. | +| 5 | Ranging_SL | O | This feature supports the enhanced location exposure service (e.g. location information for ranging and sidelink positioning), and requires the support of eLCS feature.
The feature is not applicable to pre-5G (e.g. 4G). | + +## 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different LMF service instance, within the same LMF or a different LMF of an LMF set, e.g. when an LMF service instance is part of an LMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See also the ES3XX feature in clause 6.1.9. + +An SCP that reselects a different LMF producer instance will return the NF Instance ID of the new LMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an LMF within an LMF set redirects a service request to a different LMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new LMF 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]. + +## 6.2 Nlmf\_Broadcast Service API + +### 6.2.1 API URI + +The Nlmf\_Broadcast service shall use the Nlmf\_Broadcast API. + +The API URI of the Nlmf\_Broadcast API shall be: + +**{apiRoot}/** + +The request URI 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.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nlmf-broadcast". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +## 6.2.2 Usage of HTTP + +### 6.2.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [12], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nlmf\_Location service shall comply with the OpenAPI [14] specification contained in Annex A. + +### 6.2.2.2 HTTP Standard Headers + +#### 6.2.2.2.1 General + +#### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [13], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [15]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +### 6.2.2.3 HTTP custom headers + +#### 6.2.2.3.1 General + +The following HTTP custom headers shall be supported: + +- 3gpp-Sbi-Message-Priority: See 3GPP TS 29.500 [4], clause 5.2.3.2.2. + +This API does not define any new HTTP custom headers. + +## 6.2.3 Resources + +### 6.2.3.1 Overview + +The structure of the Resource URIs of the Nlmf\_Broadcast service is shown in figure 6.2.3.1-1. + +![Diagram showing the Resource URI structure of the Nlmf_Broadcast API. The base URI is {apiRoot}/nlmf-broadcast/. A line branches down from the base URI to a dashed box containing the resource path /cipher-key-data.](ebebcfd45155572c64483e069ed43320_img.jpg) + +``` +graph TD; A["{apiRoot}/nlmf-broadcast/"] --> B["/cipher-key-data"]; +``` + +Diagram showing the Resource URI structure of the Nlmf\_Broadcast API. The base URI is {apiRoot}/nlmf-broadcast/. A line branches down from the base URI to a dashed box containing the resource path /cipher-key-data. + +**Figure 6.2.3.1-1: Resource URI structure of the Nlmf\_Broadcast API** + +## 6.2.4 Custom Operations without associated resources + +### 6.2.4.1 Overview + +The URI structure for Custom Operations without associated resources is included as part of the Figure 6.2.3.1-1 + +**Table 6.2.4.1-1: Custom operations without associated resources** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|-----------------|----------------------|--------------------|--------------------| +| cipher-key-data | /cipher-key-data | POST | Ciphering Key Data | + +### 6.2.4.4 Operation: cipher-key-data + +#### 6.2.4.4.1 Description + +This clause describes the custom operation and what it is used for. + +#### 6.2.4.4.2 Operation Definition + +This operation shall support the request and response data structures and response codes specified in table 6.2.4.4.2-1 and table 6.2.4.4.2-2. + +**Table 6.2.4.4.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|--------------------------------------------------------| +| CipherRequestData | M | 1 | Input parameters to the "Ciphering Key Data" operation | + +**Table 6.2.4.4.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CipherResponseData | M | 1 | 200 OK | This case represents a successful request for ciphering key data.

Upon success, a response body is returned indicating whether the LMF has ciphering key data. The ciphering key data is returned separately in a CipheringKeyData notification. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be set to one of the following application errors:
- UNSPECIFIED
- BROADCAST_CIPHERING_KEYS_NOT_SUPPORTED

See table 6.2.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.4.4.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. 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]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.4.4.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. 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]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.2.5 Notifications + +### 6.2.5.1 CipheringKeyData + +#### 6.2.5.1.1 Description + +The CipheringKeyData operation is used to notify the occurrence of new ciphering key information to a consumer NF (e.g. AMF). + +#### 6.2.5.1.2 Notification Definition + +Callback URI: {amfCallBackURI} + +See clause 5.3.2.2.2 for the description of how the LMF obtains the Callback URI of the NF Service Consumer (i.e. AMF). + +#### 6.2.5.1.3 Notification Standard Methods + +##### 6.2.5.1.3.1 POST + +This method sends a ciphering key data notify to the NF Service Consumer. + +This method shall support the request and response data structures and response codes specified in table 6.2.5.1.3.1-1 and table 6.2.5.1.3.1-2. + +**Table 6.2.5.1.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------| +| CipheringKeyInfo | M | 1 | Input parameters to the "Ciphering Key Data" operation | + +**Table 6.2.5.1.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CipheringKeyResponse | M | 1 | 200 OK | This case represents successful or partially successful storage of ciphering key information by the service consumer NF.

A response body is returned containing the following parameters:
- List of Ciphering Set IDs successfully stored
- List of Ciphering Set IDs not successfully stored | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be set to one of the following application errors:
- UNSPECIFIED
- UNABLE_TO_STORE_CIPHERING_KEY_DATA

See table 6.2.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.5.1.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. 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]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +**Table 6.2.5.1.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. 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]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +## 6.2.6 Data Model + +### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nlmf\_Broadcast service based interface protocol. + +**Table 6.2.6.1-1: Nlmf\_Broadcast specific Data Types** + +| Data type | Clause defined | Description | +|----------------------|----------------|-------------------------------------------------------------| +| CipheringKeyInfo | 6.2.6.2.2 | Information within Ciphering Key Data Notification request | +| CipheringKeyResponse | 6.2.6.2.3 | Information within Ciphering Key Data Notification Response | +| CipheringDataSet | 6.2.6.2.4 | Represents a Ciphering Data Set | +| CipheringSetReport | 6.2.6.2.5 | Represents a report of Ciphering Data Set storage | +| Cipher requestData | 6.2.6.2.6 | Information within Ciphering Key Data request | +| Cipher responseData | 6.2.6.2.7 | Information within Ciphering Key Data Response | +| CipheringSetID | 6.2.6.3.2 | Ciphering Data Set ID | +| CipheringKey | 6.2.6.3.2 | Ciphering Key | +| C0 | 6.2.6.3.2 | First component of the initial ciphering counter | +| ValidityDuration | 6.2.6.3.2 | Validity Duration of the Ciphering Data Set | +| StorageOutcome | 6.2.6.3.3 | Indicates the result of Ciphering Data Set storage | +| DataAvailability | 6.2.6.3.4 | Indicates availability of ciphering key data at an LMF | + +Table 6.2.6.1-2 specifies data types re-used by the Nlmf\_Broadcast 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 Nlmf\_Broadcast service based interface. + +**Table 6.2.6.1-2: Nlmf\_Broadcast re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|--------------------|--------------------------------------------------| +| Bytes | 3GPP TS 29.571 [8] | Binary data encoded as a base64 character string | +| DateTime | 3GPP TS 29.571 [8] | Date and Time | +| Uri | 3GPP TS 29.571 [8] | Uniform Resource Identifier | +| SupportedFeatures | 3GPP TS 29.571 [8] | Supported Features | +| RedirectResponse | 3GPP TS 29.571 [8] | Redirect Response | + +## 6.2.6.2 Structured data types + +### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 6.2.6.2.2 Type: CipheringKeyInfo + +**Table 6.2.6.2.2-1: Definition of type CipheringKeyInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| cipheringData | array(CipheringDataSet) | M | 1..N | This IE contains one or more ciphering data sets, where each ciphering data set contains information for one ciphering key. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.9 is supported. | + +## 6.2.6.2.3 Type: CipheringKeyResponse + +**Table 6.2.6.2.3-1: Definition of type CipheringKeyResponse** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| cipheringDataReport | Array(CipheringSetReport) | O | 1..N |

This IE indicates the ciphering data sets which were successfully stored or not stored.

The absence of this IE indicates that all ciphering data sets were successfully stored.

| + +6.2.6.2.4 Type: CipheringDataSet + +**Table 6.2.6.2.4-1: Definition of type CipheringDataSet** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------| +| cipheringSetID | CipheringSetID | M | 1 | Identification of a ciphering data set | +| cipheringKey | CipheringKey | M | 1 | A ciphering key value | +| c0 | C0 | M | 1 | First component of the initial ciphering counter as defined in clause 7.4.2 of 3GPP TS 37.355 [21] | + +| | | | | | +|----------------|-------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ltePosSibTypes | Bytes | O | 0..1 |

This IE contains a bitmap indicating the LTE positioning SIB types for which the ciphering data set is applicable:

  • - a bit set to 0 indicates that the ciphering data set is not applicable to the corresponding LTE positioning SIB type
  • - a bit set to 1 indicates that the ciphering data set is applicable to the corresponding LTE positioning SIB type

The mapping of the bits to the LTE positioning SIB types is as follows:

  • -- bit 8 in the first octet maps to positioning SIB Type 1-1
  • -- bit 7 in the first octet maps to positioning SIB Type 1-2
  • -- bit 6 in the first octet maps to positioning SIB Type 1-3
  • -- bit 5 in the first octet maps to positioning SIB Type 1-4
  • -- bit 4 in the first octet maps to positioning SIB Type 1-5
  • -- bit 3 in the first octet maps to positioning SIB Type 1-6
  • -- bit 2 in the first octet maps to positioning SIB Type 1-7
  • -- bit 1 in the first octet maps to positioning SIB Type 1-8

  • -- bit 8 in the second octet maps to positioning SIB Type 2-1
  • -- bit 7 in the second octet maps to positioning SIB Type 2-2
  • -- bit 6 in the second octet maps to positioning SIB Type 2-3
  • -- bit 5 in the second octet maps to positioning SIB Type 2-4
  • -- bit 4 in the second octet maps to positioning SIB Type 2-5
  • -- bit 3 in the second octet maps to positioning SIB Type 2-6
  • -- bit 2 in the second octet maps to positioning SIB Type 2-7
  • -- bit 1 in the second octet maps to positioning SIB Type 2-8

  • -- bit 8 in the third octet maps to positioning SIB Type 2-9
  • -- bit 7 in the third octet maps to positioning SIB Type 2-10
  • -- bit 6 in the third octet maps to positioning SIB Type 2-11
  • -- bit 5 in the third octet maps to positioning SIB Type 2-12
  • -- bit 4 in the third octet maps to positioning SIB Type 2-13
  • -- bit 3 in the third octet maps to positioning SIB Type 2-14
  • -- bit 2 in the third octet maps to positioning SIB Type 2-15
  • -- bit 1 in the third octet maps to positioning SIB Type 2-16

  • -- bit 8 in the fourth octet maps to
| +|----------------|-------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

positioning SIB Type 2-17

  • -- bit 7 in the fourth octet maps to positioning SIB Type 2-18
  • -- bit 6 in the fourth octet maps to positioning SIB Type 2-19
  • -- bit 5 in the fourth octet maps to positioning SIB Type 2-20
  • -- bit 4 in the fourth octet maps to positioning SIB Type 2-21
  • -- bit 3 in the fourth octet maps to positioning SIB Type 2-22
  • -- bit 2 in the fourth octet maps to positioning SIB Type 2-23
  • -- bit 1 in the fourth octet maps to positioning SIB Type 2-24
  • -- bit 8 in the fifth octet maps to positioning SIB Type 2-25
  • -- bit 7 in the fifth octet maps to positioning SIB Type 3-1
  • -- bit 6 in the fifth octet maps to positioning SIB Type 4-1
  • -- bit 5 in the fifth octet maps to positioning SIB Type 5-1

Any unassigned bits are spare and shall be coded as zero. Non-included bits shall be treated as being coded as zero.
(NOTE 1)

| +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|---------------|-------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nrPosSibTypes | Bytes | O | 0..1 |

This IE contains a bitmap indicating the NR positioning SIB types for which the ciphering data set is applicable:

  • - a bit set to 0 indicates that the ciphering data set is not applicable to the corresponding NR positioning SIB type
  • - a bit set to 1 indicates that the ciphering data set is applicable to the corresponding NR positioning SIB type

The mapping of the bits to the NR positioning SIB types is as follows:

  • -- bit 8 in the first octet maps to positioning SIB Type 1-1
  • -- bit 7 in the first octet maps to positioning SIB Type 1-2
  • -- bit 6 in the first octet maps to positioning SIB Type 1-3
  • -- bit 5 in the first octet maps to positioning SIB Type 1-4
  • -- bit 4 in the first octet maps to positioning SIB Type 1-5
  • -- bit 3 in the first octet maps to positioning SIB Type 1-6
  • -- bit 2 in the first octet maps to positioning SIB Type 1-7
  • -- bit 1 in the first octet maps to positioning SIB Type 1-8

  • -- bit 8 in the second octet maps to positioning SIB Type 2-1
  • -- bit 7 in the second octet maps to positioning SIB Type 2-2
  • -- bit 6 in the second octet maps to positioning SIB Type 2-3
  • -- bit 5 in the second octet maps to positioning SIB Type 2-4
  • -- bit 4 in the second octet maps to positioning SIB Type 2-5
  • -- bit 3 in the second octet maps to positioning SIB Type 2-6
  • -- bit 2 in the second octet maps to positioning SIB Type 2-7
  • -- bit 1 in the second octet maps to positioning SIB Type 2-8

  • -- bit 8 in the third octet maps to positioning SIB Type 2-9
  • -- bit 7 in the third octet maps to positioning SIB Type 2-10
  • -- bit 6 in the third octet maps to positioning SIB Type 2-11
  • -- bit 5 in the third octet maps to positioning SIB Type 2-12
  • -- bit 4 in the third octet maps to positioning SIB Type 2-13
  • -- bit 3 in the third octet maps to positioning SIB Type 2-14
  • -- bit 2 in the third octet maps to positioning SIB Type 2-15
  • -- bit 1 in the third octet maps to positioning SIB Type 2-16

  • -- bit 8 in the fourth octet maps to positioning SIB Type 2-17
| +|---------------|-------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|-----------------------------------------------------------------------------|------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

-- bit 7 in the fourth octet maps to positioning SIB Type 2-18

-- bit 6 in the fourth octet maps to positioning SIB Type 2-19

-- bit 5 in the fourth octet maps to positioning SIB Type 2-20

-- bit 4 in the fourth octet maps to positioning SIB Type 2-21

-- bit 3 in the fourth octet maps to positioning SIB Type 2-22

-- bit 2 in the fourth octet maps to positioning SIB Type 2-23

-- bit 1 in the fourth octet maps to positioning SIB Type 3-1


-- bit 8 in the fifth octet maps to positioning SIB Type 4-1

-- bit 7 in the fifth octet maps to positioning SIB Type 5-1

-- bit 6 in the fifth octet maps to positioning SIB Type 6-1

-- bit 5 in the fifth octet maps to positioning SIB Type 6-2

-- bit 4 in the fifth octet maps to positioning SIB Type 6-3


Any unassigned bits are spare and shall be coded as zero. Non-included bits shall be treated as being coded as zero.
(NOTE 1)

| +| validityStartTime | DateTime | M | 1 | This IE contains the UTC time when the ciphering data set becomes valid. | +| validityDuration | ValidityDuration | M | 1 | The validity duration of the ciphering data set. | +| tailList | Bytes | O | 0..1 |

This IE contains the TAIs of the tracking areas for which the ciphering data set is applicable. It is encoded as octets 2 to n of the 5GS tracking area identity list IE specified in clause 9.11.3.9 of 3GPP TS 24.501 [22].

If this IE is omitted, the ciphering data set is valid in the entire PLMN.

| +| NOTE 1: At least one of ltesibTypes IE and nrsibTypes IE shall be included. | | | | | + +#### 6.2.6.2.5 Type: CipheringSetReport + +**Table 6.2.6.2.5-1: Definition of CipheringSetReport** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|-----------------------------------------------------------------------------------------| +| cipheringSetID | CipheringSetID | M | 1 | Identification of a ciphering data set | +| storageOutcome | StorageOutcome | M | 1 | Indication of whether the ciphering data set was successfully stored or was not stored. | + +## 6.2.6.2.6 Type: CipherRequestData + +Table 6.2.6.2.6-1: Definition of CipherRequestData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| amfCallBackURI | Uri | M | 1 | Callback URI of the NF Service Consumer | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.9 is supported. | + +## 6.2.6.2.7 Type: CipherResponseData + +Table 6.2.6.2.7-1: Definition of CipherResponseData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| dataAvailability | DataAvailability | M | 1 | An indication of whether the LMF currently has ciphering key data applicable to the NF Service Consumer | + +## 6.2.6.3 Simple data types and enumerations + +## 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +Table 6.2.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | +|------------------|-----------------|-------------------------------------------------------------------| +| CipheringSetID | integer | The ciphering set ID
Minimum = 0. Maximum = 65535 | +| CipheringKey | Bytes | A 128 bit ciphering key encoded as a base64 character string | +| C0 | Bytes | A 128 bit value for C0 encoded as a base64 character string | +| ValidityDuration | integer | The validity duration in minutes.
Minimum = 1. Maximum = 65535 | + +## 6.2.6.3.3 Enumeration: StorageOutcome + +The enumeration StorageOutcome represents the outcome of cipher set data storage at the service consumer NF. + +Table 6.2.6.3.3-1: Enumeration StorageOutcome + +| Enumeration value | Description | +|----------------------|-----------------------------------------------------------| +| "STORAGE_SUCCESSFUL" | Indicates storage of Ciphering Data Set is successful | +| "STORAGE_FAILED" | Indicates storage of Ciphering Data Set is not successful | + +## 6.2.6.3.4 Enumeration: DataAvailability + +The enumeration DataAvailability represents the availability of ciphering key data at an LMF. + +**Table 6.2.6.3.4-1: Enumeration DataAvailability** + +| Enumeration value | Description | +|-----------------------------------|------------------------------------------------------| +| "CIPHERING_KEY_DATA_AVAILABLE" | Indicates Ciphering Data Set is available in LMF | +| CIPHERING_KEY_DATA_NOT_AVAILABLE" | Indicates Ciphering Data Set is not available in LMF | + +## 6.2.7 Error Handling + +### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.2.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.2.7.3 Application Errors + +The application errors defined for the Nlmf\_Broadcast service are listed in table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------|------------------|-----------------------------------------------------------------| +| UNSPECIFIED | 403
Forbidden | The request is rejected due to unspecified reasons. | +| UNABLE_TO_STORE_CIPHERING_KEY_DATA | 403
Forbidden | The service consumer NF was unable to store ciphering key data. | +| BROADCAST_CIPHERING_KEYS_NOT_SUPPORTED | 403
Forbidden | Ciphering keys for broadcast are not supported. | + +## 6.2.8 Security + +The Nlmf\_Broadcast API does not define service operations for which additional security is needed in this version of the specification. + +## 6.2.9 Feature Negotiation + +The optional features in table 6.2.9-1 are defined for the Nlmf\_Broadcast API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.9-1: Supported Features** + +| Feature number | Feature Name | M/O | Description | +|----------------|--------------|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Broadcast service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | + +## 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different LMF service instance, within the same LMF or a different LMF of an LMF set, e.g. when an LMF service instance is part of an LMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See also the ES3XX feature in clause 6.2.9. + +An SCP that reselects a different LMF producer instance will return the NF Instance ID of the new LMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an LMF within an LMF set redirects a service request to a different LMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new LMF 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]. + +--- + +## Annex A (normative): OpenAPI specification + +### A.1 General + +This Annex specifies the formal definition of the Nlmf Service APIs. It consists of an OpenAPI 3.0.0 specification, in YAML format. + +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). + +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. + +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 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +--- + +### A.2 Nlmf\_Location API + +``` +openapi: 3.0.0 + +info: + version: '1.3.0-alpha.5' + title: 'LMF Location' + description: | + LMF Location Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.572 V18.4.0; 5G System; Location Management Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.572/' + +servers: + - url: '{apiRoot}/nlmf-loc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc +``` + +``` +paths: + /determine-location: + post: + summary: Determine Location of an UE + operationId: DetermineLocation + tags: + - Determine Location + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:determine-location:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InputData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/InputData' + binaryDataLppMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataLppMessage: + contentType: application/vnd.3gpp.lpp + headers: + Content-Id: + schema: + type: string + binaryDataLppMessageExt1: + contentType: application/vnd.3gpp.lpp + headers: + Content-Id: + schema: + type: string + binaryDataLppMessageExt2: + contentType: application/vnd.3gpp.lpp + headers: + Content-Id: + schema: + type: string + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LocationDataExt' + '204': + description: Expected response for MO-LR requesting location assistance data. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +``` + +``` +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +'504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + EventNotify: + '{ $request.body#/htmlCallbackURI }': + post: + requestBody: + description: UE Event Notification + content: + application/json: + schema: + $ref: '#/components/schemas/EventNotifyDataExt' + responses: + '204': + description: Expected response to a valid notification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/up-subscription: + post: + summary: subscribe about status of a secure LCS-UP connection for a target UE + operationId: UpSubscription + tags: + - UP Subscribe + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:up-subscription:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpSubscription' + required: true + responses: + '204': + description: Expected response to successful UP Subscription + '307': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +'504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + UPNotify: + "{$request.body#/upNotifyCallBackURI}": + post: + requestBody: + description: UP Connection Status Notification + content: + application/json: + schema: + $ref: '#/components/schemas/UpNotifyData' + responses: + '204': + description: Expected response to a valid notification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/cancel-location: + post: + summary: request cancellation of periodic or triggered location + operationId: CancelLocation + tags: +``` + +``` + - Cancel Location + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:cancel-location:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelLocData' + required: true + responses: + '204': + description: Expected response to a successful cancellation + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/location-context-transfer: + post: + summary: transfer context information for periodic or triggered location + operationId: LocationContextTransfer + tags: + - Location Context Transfer + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:location-context-transfer:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocContextData' + required: true + responses: + '204': + description: Expected response to successful location context transfer + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +'504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/location-measure: + post: + summary: PRU location measurement + operationId: LocationMeasure + tags: + - Location Measure + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:location-measure:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocMeasurementReq' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LocMeasurementResp' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +``` + +/up-configure: + post: + summary: set up, modify or terminate a secure LCS-UP connection for a target UE + operationId: UpConfig + tags: + - UP Configure + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:up-configure:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpConfig' + required: true + responses: + '204': + description: Expected response to successful set up, modify or terminate LCS-UP +connection. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nlmf-loc: Access to the Nlmf_Location API + nlmf-loc:determine-location:invoke: Access to invoke Determine Location + nlmf-loc:cancel-location:invoke: Access to invoke Cancel Location + nlmf-loc:location-context-transfer:invoke: Access to invoke Location Context + nlmf-loc:location-measure:invoke: Access to invoke Location Measurement + nlmf-loc:up-subscription:invoke: Access to invoke UP Subscription + nlmf-loc:up-configure:invoke: Access to invoke UP Config + +schemas: +# +# COMPLEX TYPES +# + InputData: + description: Information within Determine Location Request. + type: object + not: + +``` + +``` +required: [ ecgi, ncgi ] +properties: + externalClientType: + $ref: '#/components/schemas/ExternalClientType' + correlationID: + $ref: '#/components/schemas/CorrelationID' + amfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + locationQoS: + $ref: '#/components/schemas/LocationQoS' + supportedGADShapes: + type: array + items: + $ref: '#/components/schemas/SupportedGADShapes' + minItems: 1 + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + requestedRangingSlResult: + type: array + items: + $ref: '#/components/schemas/RangingSlResult' + minItems: 1 + relatedUEs: + type: array + items: + $ref: '#/components/schemas/RelatedUE' + minItems: 1 + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ecgiOnSecondNode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ncgiOnSecondNode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + priority: + $ref: '#/components/schemas/LcsPriority' + velocityRequested: + $ref: '#/components/schemas/VelocityRequested' + ueLcsCap: + $ref: '#/components/schemas/UeLcsCapability' + lcsServiceType: + $ref: '#/components/schemas/LcsServiceType' + ldrType: + $ref: '#/components/schemas/LdrType' + hgmlcCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + lirGmlcCallBackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + vgmlcAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + lirReference: + $ref: '#/components/schemas/LirReference' + periodicEventInfo: + $ref: '#/components/schemas/PeriodicEventInfo' + areaEventInfo: + $ref: '#/components/schemas/AreaEventInfo' + motionEventInfo: + $ref: '#/components/schemas/MotionEventInfo' + reportingAccessTypes: + type: array + items: + $ref: '#/components/schemas/ReportingAccessType' + minItems: 1 + ueConnectivityStates: + $ref: '#/components/schemas/UeConnectivityState' + ueLocationServiceInd: + $ref: '#/components/schemas/UeLocationServiceInd' + moAssistanceDataTypes: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/LcsBroadcastAssistanceTypesData' + lppMessage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +``` + +``` +lppMessageExt: + description: Indicates the lpp message extension. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + uePositioningCap: + $ref: '#/components/schemas/UePositioningCapabilities' + tnapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TnapId' + twapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TwapId' + ueCountryDetInd: + type: boolean + scheduledLocTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + reliableLocReq: + type: boolean + default: false + evtRptAllowedAreas: + type: array + items: + $ref: '#/components/schemas/ReportingArea' + minItems: 1 + maxItems: 250 + ueUnawareInd: + type: boolean + enum: + - true + intermediateLocationInd: + type: boolean + default: false + maxRespTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + lpHapType: + $ref: 'TS29518_Namf_Location.yaml#/components/schemas/LpHapType' + ueUpPosCaps: + type: array + items: + $ref: '#/components/schemas/UeUpPositioningCapabilities' + minItems: 1 + reportingInd: + allOf: + - $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/ReportingInd' + default: INSIDE_REPORTING + mbsrInfo: + $ref: '#/components/schemas/MbsrInfo' + integrityRequirements: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/IntegrityRequirements' + upLocRepAddrAf: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/UpLocRepAddrAfRm' + upCumEvtRptCriteria: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UpCumEvtRptCriteria' + mappedQoSEps: + $ref: '#/components/schemas/MappedLocationQoSEps' + additionalUeInfo: + $ref: '#/components/schemas/AdditionalUeInfo' + +LocationDataExt: + description: Extended Location Data for UEs + allOf: + - $ref: '#/components/schemas/LocationData' + - $ref: '#/components/schemas/AddLocationDatas' + +LocationData: + description: Information within Determine Location Response. + type: object + required: + - locationEstimate + properties: + locationEstimate: + $ref: '#/components/schemas/GeographicArea' + accuracyFulfilmentIndicator: + $ref: '#/components/schemas/AccuracyFulfilmentIndicator' + ageOfLocationEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' +``` + +``` +timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +velocityEstimate: + $ref: '#/components/schemas/VelocityEstimate' +civicAddress: + $ref: '#/components/schemas/CivicAddress' +localLocationEstimate: + $ref: '#/components/schemas/LocalArea' +positioningDataList: + type: array + items: + $ref: '#/components/schemas/PositioningMethodAndUsage' + minItems: 1 +gnssPositioningDataList: + type: array + items: + $ref: '#/components/schemas/GnssPositioningMethodAndUsage' + minItems: 1 +ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' +ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' +altitude: + $ref: '#/components/schemas/Altitude' +barometricPressure: + $ref: '#/components/schemas/BarometricPressure' +servingLMFIdentification: + $ref: '#/components/schemas/LMFIdentification' +uePositioningCap: + $ref: '#/components/schemas/UePositioningCapabilities' +ueAreaInd: + $ref: '#/components/schemas/UeAreaIndication' +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +achievedQos: + $ref: '#/components/schemas/MinorLocationQoS' +directReportInd: + type: boolean + default: false +indoorOutdoorInd: + $ref: '#/components/schemas/IndoorOutdoorInd' +acceptedPeriodicEventInfo: + $ref: '#/components/schemas/PeriodicEventInfo' +haGnssMetrics: + $ref: '#/components/schemas/HighAccuracyGnssMetrics' +losNlosMeasureInd: + $ref: '#/components/schemas/LosNlosMeasureInd' +relatedApplicationlayerId: + type: string +rangeDirection: + $ref: '#/components/schemas/RangeDirection' +2dRelativeLocation: + $ref: '#/components/schemas/2DRelativeLocation' +3dRelativeLocation: + $ref: '#/components/schemas/3DRelativeLocation' +relativeVelocity: + $ref: '#/components/schemas/VelocityEstimate' + +GeographicArea: + description: Geographic area specified by different shape. + anyOf: + - $ref: '#/components/schemas/Point' + - $ref: '#/components/schemas/PointUncertaintyCircle' + - $ref: '#/components/schemas/PointUncertaintyEllipse' + - $ref: '#/components/schemas/Polygon' + - $ref: '#/components/schemas/PointAltitude' + - $ref: '#/components/schemas/PointAltitudeUncertainty' + - $ref: '#/components/schemas/EllipsoidArc' + +GADShape: + description: Common base type for GAD shapes. + type: object + required: + - shape + properties: + shape: + $ref: '#/components/schemas/SupportedGADShapes' +``` + +``` +discriminator: + propertyName: shape + mapping: + POINT: '#/components/schemas/Point' + POINT_UNCERTAINTY_CIRCLE: '#/components/schemas/PointUncertaintyCircle' + POINT_UNCERTAINTY_ELLIPSE: '#/components/schemas/PointUncertaintyEllipse' + POLYGON: '#/components/schemas/Polygon' + POINT_ALTITUDE: '#/components/schemas/PointAltitude' + POINT_ALTITUDE_UNCERTAINTY: '#/components/schemas/PointAltitudeUncertainty' + ELLIPSOID_ARC: '#/components/schemas/EllipsoidArc' + LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE: '#/components/schemas/Local2dPointUncertaintyEllipse' + LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID: + '#/components/schemas/Local3dPointUncertaintyEllipsoid' + +Point: + description: Ellipsoid Point. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + +PointUncertaintyCircle: + description: Ellipsoid point with uncertainty circle. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - uncertainty + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + uncertainty: + $ref: '#/components/schemas/Uncertainty' + +PointUncertaintyEllipse: + description: Ellipsoid point with uncertainty ellipse. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - uncertaintyEllipse + - confidence + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + uncertaintyEllipse: + $ref: '#/components/schemas/UncertaintyEllipse' + confidence: + $ref: '#/components/schemas/Confidence' + +Polygon: + description: Polygon. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - pointList + properties: + pointList: + $ref: '#/components/schemas/PointList' + +PointAltitude: + description: Ellipsoid point with altitude. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - altitude + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' +``` + +``` + altitude: + $ref: '#/components/schemas/Altitude' + +PointAltitudeUncertainty: + description: Ellipsoid point with altitude and uncertainty ellipsoid. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - altitude + - uncertaintyEllipse + - uncertaintyAltitude + - confidence + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + altitude: + $ref: '#/components/schemas/Altitude' + uncertaintyEllipse: + $ref: '#/components/schemas/UncertaintyEllipse' + uncertaintyAltitude: + $ref: '#/components/schemas/Uncertainty' + confidence: + $ref: '#/components/schemas/Confidence' + +EllipsoidArc: + description: Ellipsoid Arc. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - innerRadius + - uncertaintyRadius + - offsetAngle + - includedAngle + - confidence + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + innerRadius: + $ref: '#/components/schemas/InnerRadius' + uncertaintyRadius: + $ref: '#/components/schemas/Uncertainty' + offsetAngle: + $ref: '#/components/schemas/Angle' + includedAngle: + $ref: '#/components/schemas/Angle' + confidence: + $ref: '#/components/schemas/Confidence' + +LocalOrigin: + description: Indicates a Local origin in a reference system + type: object + properties: + coordinateId: + type: string + point: + $ref: '#/components/schemas/GeographicalCoordinates' + +RelativeCartesianLocation: + description: Relative Cartesian Location + type: object + required: + - x + - y + properties: + x: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + y: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + z: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + +LocalArea: + description: Local area specified by different shape +``` + +``` +oneOf: + - $ref: '#/components/schemas/Local2dPointUncertaintyEllipse' + - $ref: '#/components/schemas/Local3dPointUncertaintyEllipsoid' + +UeAreaIndication: + description: Indicates area (country, area in a country or international area) where UE is located + type: object + oneOf: + - required: + - country + - required: + - internationalAreaInd + properties: + country: + description: Indicates country or area in a country where UE is located + type: string + internationalAreaInd: + description: Indicates international area indication if UE is located in international +area + type: boolean + default: false + +Local2dPointUncertaintyEllipse: + description: Local 2D point with uncertainty ellipse + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - localOrigin + - point + - uncertaintyEllipse + - confidence + properties: + localOrigin: + $ref: '#/components/schemas/LocalOrigin' + point: + $ref: '#/components/schemas/RelativeCartesianLocation' + uncertaintyEllipse: + $ref: '#/components/schemas/UncertaintyEllipse' + confidence: + $ref: '#/components/schemas/Confidence' + +Local3dPointUncertaintyEllipsoid: + description: Local 3D point with uncertainty ellipsoid + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - localOrigin + - point + - uncertaintyEllipsoid + - confidence + properties: + localOrigin: + $ref: '#/components/schemas/LocalOrigin' + point: + $ref: '#/components/schemas/RelativeCartesianLocation' + uncertaintyEllipsoid: + $ref: '#/components/schemas/UncertaintyEllipsoid' + confidence: + $ref: '#/components/schemas/Confidence' + +GeographicalCoordinates: + description: Geographical coordinates. + type: object + required: + - lon + - lat + properties: + lon: + type: number + format: double + minimum: -180 + maximum: 180 + lat: + type: number + format: double +``` + +``` + minimum: -90 + maximum: 90 + +UncertaintyEllipse: + description: Ellipse with uncertainty. + type: object + required: + - semiMajor + - semiMinor + - orientationMajor + properties: + semiMajor: + $ref: '#/components/schemas/Uncertainty' + semiMinor: + $ref: '#/components/schemas/Uncertainty' + orientationMajor: + $ref: '#/components/schemas/Orientation' + +UncertaintyEllipsoid: + description: Ellipsoid with uncertainty + type: object + required: + - semiMajor + - semiMinor + - vertical + - orientationMajor + properties: + semiMajor: + $ref: '#/components/schemas/Uncertainty' + semiMinor: + $ref: '#/components/schemas/Uncertainty' + vertical: + $ref: '#/components/schemas/Uncertainty' + orientationMajor: + $ref: '#/components/schemas/Orientation' + +PointList: + description: List of points. + type: array + items: + $ref: '#/components/schemas/GeographicalCoordinates' + minItems: 3 + maxItems: 15 + +LocationQoS: + description: QoS of Location request. + type: object + properties: + hAccuracy: + $ref: '#/components/schemas/Accuracy' + vAccuracy: + $ref: '#/components/schemas/Accuracy' + verticalRequested: + type: boolean + responseTime: + $ref: '#/components/schemas/ResponseTime' + minorLocQoses: + type: array + items: + $ref: '#/components/schemas/MinorLocationQoS' + minItems: 1 + maxItems: 2 + lcsQoSClass: + $ref: '#/components/schemas/LcsQoSClass' + +PositioningMethodAndUsage: + description: Indicates the usage of a positioning method. + type: object + required: + - method + - mode + - usage + properties: + method: + $ref: '#/components/schemas/PositioningMethod' + mode: + $ref: '#/components/schemas/PositioningMode' + usage: +``` + +``` +$ref: '#/components/schemas/Usage' +methodCode: + type: integer + minimum: 16 + maximum: 31 + +GnssPositioningMethodAndUsage: + description: Indicates the usage of a Global Navigation Satellite System (GNSS) positioning +method. + type: object + required: + - mode + - gnss + - usage + properties: + mode: + $ref: '#/components/schemas/PositioningMode' + gnss: + $ref: '#/components/schemas/GnssId' + usage: + $ref: '#/components/schemas/Usage' + +CivicAddress: + description: Indicates a Civic address. + type: object + properties: + country: + type: string + A1: + type: string + A2: + type: string + A3: + type: string + A4: + type: string + A5: + type: string + A6: + type: string + PRD: + type: string + POD: + type: string + STS: + type: string + HNO: + type: string + HNS: + type: string + LMK: + type: string + LOC: + type: string + NAM: + type: string + PC: + type: string + BLD: + type: string + UNIT: + type: string + FLR: + type: string + ROOM: + type: string + PLC: + type: string + PCN: + type: string + POBOX: + type: string + ADDCODE: + type: string + SEAT: + type: string + RD: + type: string +``` + +``` +RDSEC: + type: string +RDBR: + type: string +RDSUBBR: + type: string +PRM: + type: string +POM: + type: string +usageRules: + type: string +method: + type: string +providedBy: + type: string + +VelocityEstimate: + description: Velocity estimate. + oneOf: + - $ref: '#/components/schemas/HorizontalVelocity' + - $ref: '#/components/schemas/HorizontalWithVerticalVelocity' + - $ref: '#/components/schemas/HorizontalVelocityWithUncertainty' + - $ref: '#/components/schemas/HorizontalWithVerticalVelocityAndUncertainty' + +HorizontalVelocity: + description: Horizontal velocity. + type: object + required: + - hSpeed + - bearing + properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + +HorizontalWithVerticalVelocity: + description: Horizontal and vertical velocity. + type: object + required: + - hSpeed + - bearing + - vSpeed + - vDirection + properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + vSpeed: + $ref: '#/components/schemas/VerticalSpeed' + vDirection: + $ref: '#/components/schemas/VerticalDirection' + +HorizontalVelocityWithUncertainty: + description: Horizontal velocity with speed uncertainty. + type: object + required: + - hSpeed + - bearing + - hUncertainty + properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + hUncertainty: + $ref: '#/components/schemas/SpeedUncertainty' + +HorizontalWithVerticalVelocityAndUncertainty: + description: Horizontal and vertical velocity with speed uncertainty. + type: object + required: + - hSpeed + - bearing + - vSpeed + - vDirection +``` + +``` +- hUncertainty +- vUncertainty +properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + vSpeed: + $ref: '#/components/schemas/VerticalSpeed' + vDirection: + $ref: '#/components/schemas/VerticalDirection' + hUncertainty: + $ref: '#/components/schemas/SpeedUncertainty' + vUncertainty: + $ref: '#/components/schemas/SpeedUncertainty' + +UeLcsCapability: + description: Indicates the LCS capability supported by the UE.. + type: object + properties: + lppSupport: + type: boolean + default: true + ciotOptimisation: + type: boolean + default: false + +PeriodicEventInfo: + description: Indicates the information of periodic event reporting. + type: object + required: + - reportingAmount + - reportingInterval + properties: + reportingAmount: + $ref: '#/components/schemas/ReportingAmount' + reportingInterval: + $ref: '#/components/schemas/ReportingInterval' + reportingInfiniteInd: + type: boolean + enum: + - true + reportingIntervalMs: + $ref: '#/components/schemas/ReportingIntervalMs' + +AreaEventInfo: + description: Indicates the information of area based event reporting. + type: object + required: + - areaDefinition + properties: + areaDefinition: + type: array + items: + $ref: '#/components/schemas/ReportingArea' + minItems: 1 + maxItems: 250 + occurrenceInfo: + $ref: '#/components/schemas/OccurrenceInfo' + minimumInterval: + $ref: '#/components/schemas/MinimumInterval' + maximumInterval: + $ref: '#/components/schemas/MaximumInterval' + samplingInterval: + $ref: '#/components/schemas/SamplingInterval' + reportingDuration: + $ref: '#/components/schemas/ReportingDuration' + reportingLocationReq: + type: boolean + default: true + +ReportingArea: + description: Indicates an area for event reporting. + type: object + required: + - areaType + properties: + areaType: +``` + +``` +$ref: '#/components/schemas/ReportingAreaType' +tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' +ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' +ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + +MotionEventInfo: + description: Indicates the information of motion based event reporting. + type: object + required: + - linearDistance + properties: + linearDistance: + $ref: '#/components/schemas/LinearDistance' + occurrenceInfo: + $ref: '#/components/schemas/OccurrenceInfo' + minimumInterval: + $ref: '#/components/schemas/MinimumInterval' + maximumInterval: + $ref: '#/components/schemas/MaximumInterval' + samplingInterval: + $ref: '#/components/schemas/SamplingInterval' + reportingDuration: + $ref: '#/components/schemas/ReportingDuration' + reportingLocationReq: + type: boolean + default: true + +CancelLocData: + description: Information within Cancel Location Request. + type: object + required: + - hgmlcCallBackURI + - ldrReference + properties: + hgmlcCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +LocContextData: + description: Information within Transfer Location Context Request. + type: object + required: + - amfId + - ldrType + - hgmlcCallBackURI + - ldrReference + - eventReportMessage + properties: + amfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + locationQoS: + $ref: '#/components/schemas/LocationQoS' + supportedGADShapes: + type: array + items: + $ref: '#/components/schemas/SupportedGADShapes' + minItems: 1 + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + ldrType: + $ref: '#/components/schemas/LdrType' + hgmlcCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + periodicEventInfo: + $ref: '#/components/schemas/PeriodicEventInfo' + areaEventInfo: + $ref: '#/components/schemas/AreaEventInfo' + motionEventInfo: +``` + +``` + $ref: '#/components/schemas/MotionEventInfo' + eventReportMessage: + $ref: '#/components/schemas/EventReportMessage' + eventReportingStatus: + $ref: '#/components/schemas/EventReportingStatus' + ueLocationInfo: + $ref: '#/components/schemas/UELocationInfo' + cIoT5GSOptimisation: + type: boolean + default: false + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + uePositioningCap: + $ref: '#/components/schemas/UePositioningCapabilities' + scheduledLocTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + indoorOutdoorInd: + $ref: '#/components/schemas/IndoorOutdoorInd' + losNlosMeasureInd: + $ref: '#/components/schemas/LosNlosMeasureInd' + upCumEvtRptCriteria: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UpCumEvtRptCriteria' + +EventReportMessage: + description: Indicates an event report message. + type: object + required: + - eventClass + - eventContent + properties: + eventClass: + $ref: '#/components/schemas/EventClass' + eventContent: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + +EventReportingStatus: + description: Indicates the status of event reporting. + type: object + properties: + eventReportCounter: + $ref: '#/components/schemas/EventReportCounter' + eventReportDuration: + $ref: '#/components/schemas/EventReportDuration' + +UELocationInfo: + description: Indicates location information of a UE. + type: object + properties: + locationEstimate: + $ref: '#/components/schemas/GeographicArea' + ageOfLocationEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + velocityEstimate: + $ref: '#/components/schemas/VelocityEstimate' + ageOfVelocityEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + timestampOfVelocityEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +EventNotifyDataExt: + description: Extended Event Notify Data for UEs + allOf: + - $ref: '#/components/schemas/EventNotifyData' + - $ref: '#/components/schemas/AddEventNotifyDatas' + +EventNotifyData: + description: Information within Event Notify Request. + type: object + required: + - reportedEventType +``` + +``` + - ldrReference +properties: + reportedEventType: + $ref: '#/components/schemas/ReportedEventType' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + hgmlcCallbackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + lirReference: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LirReference' + locationEstimate: + $ref: '#/components/schemas/GeographicArea' + ageOfLocationEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + civicAddress: + $ref: '#/components/schemas/CivicAddress' + localLocationEstimate: + $ref: '#/components/schemas/LocalArea' + positioningDataList: + type: array + items: + $ref: '#/components/schemas/PositioningMethodAndUsage' + minItems: 1 + gnssPositioningDataList: + type: array + items: + $ref: '#/components/schemas/GnssPositioningMethodAndUsage' + minItems: 1 + servingLMFIdentification: + $ref: '#/components/schemas/LMFIdentification' + terminationCause: + $ref: '#/components/schemas/TerminationCause' + velocityEstimate: + $ref: '#/components/schemas/VelocityEstimate' + altitude: + $ref: '#/components/schemas/Altitude' + achievedQoS: + $ref: '#/components/schemas/MinorLocationQoS' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + indoorOutdoorInd: + $ref: '#/components/schemas/IndoorOutdoorInd' + haGnssMetrics: + $ref: '#/components/schemas/HighAccuracyGnssMetrics' + losNlosMeasureInd: + $ref: '#/components/schemas/LosNlosMeasureInd' + upLocRepStatAf: + type: integer + relatedApplicationlayerId: + type: string + rangeDirection: + $ref: '#/components/schemas/RangeDirection' + 2dRelativeLocation: + $ref: '#/components/schemas/2DRelativeLocation' + 3dRelativeLocation: + $ref: '#/components/schemas/3DRelativeLocation' + relativeVelocity: + $ref: '#/components/schemas/VelocityEstimate' + +UeConnectivityState: + description: Indicates the connectivity state of a UE. + type: object + required: + - accessType + properties: + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + connectivitystate: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CmState' + +MinorLocationQoS: +``` + +``` +description: Contain Minor Location QoS. +type: object +properties: + hAccuracy: + $ref: '#/components/schemas/Accuracy' + vAccuracy: + $ref: '#/components/schemas/Accuracy' + +MbsrInfo: + description: MBSR Information + type: object + properties: + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + +LocMeasurementReq: + description: Location Measurement Request. + type: object + properties: + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + preCalcuLocEstimate: + $ref: '#/components/schemas/GeographicArea' + timestampOfPreCalcuLocEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +LocMeasurementResp: + description: Location Measurement Response. + type: object + required: + - locMeasurements + - locationEstimate + properties: + locMeasurements: + $ref: '#/components/schemas/LocMeasurements' + locationEstimate: + $ref: '#/components/schemas/GeographicArea' + ageOfLocationEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + velocityEstimate: + $ref: '#/components/schemas/VelocityEstimate' + localLocationEstimate: + $ref: '#/components/schemas/LocalArea' + +LocMeasurements: + description: PRU Location Measurements. + type: object + properties: + rstd: + type: integer + +HighAccuracyGnssMetrics: + description: High Accuracy GNSS Positioning Metrics. + type: object + properties: + nrOfUsedSatellites: + type: integer + minimum: 0 + maximum: 64 + hdopi: + type: integer + minimum: 1 + maximum: 256 + pdopi: + type: integer + minimum: 1 + maximum: 256 + age: + type: integer + minimum: 0 + maximum: 99 +``` + +``` +fixType: + $ref: '#/components/schemas/FixType' + +UpNotifyData: + description: UP Subscription + type: object + required: + - ldrReference + - upConnectionStatus + properties: + ldrReference: + $ref: '#/components/schemas/LdrReference' + upConnectionStatus: + $ref: '#/components/schemas/UpConnectionStatus' + targetLMFIdentification: + $ref: '#/components/schemas/LMFIdentification' + +UpSubscription: + description: UP Subscription + type: object + required: + - upNotifyCallBackURI + - supi + properties: + upNotifyCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + +RelatedUE: + description: Related UE Information + type: object + required: + - applicationlayerId + - relatedUEType + properties: + applicationlayerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationlayerId' + relatedUEType: + $ref: '#/components/schemas/RelatedUEType' + +UpConfig: + description: UP Config + type: object + required: + - upNotifyCallBackURI + properties: + upNotifyCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + amfReallocationInd: + type: boolean + default: false + lcsUpConnectionInd: + $ref: '#/components/schemas/LcsUpConnectionInd' + targetLMFIdentification: + $ref: '#/components/schemas/LMFIdentification' + +RangeDirection: + description: Represents a range and direction from a point A to a point B. + type: object + properties: + range: + type: number + azimuthDirection: + $ref: '#/components/schemas/Angle' + elevationDirection: + $ref: '#/components/schemas/Angle' + +2DRelativeLocation: + description: Represents a relative 2D location with uncertainty ellipse. + type: object + properties: +``` + +``` + semiMinor: + $ref: '#/components/schemas/Uncertainty' + semiMajor: + $ref: '#/components/schemas/Uncertainty' + orientationAngle: + $ref: '#/components/schemas/Angle' + +3DRelativeLocation: + description: Represents a relative 3D location with uncertainty ellipsoid. + type: object + properties: + semiMinor: + $ref: '#/components/schemas/Uncertainty' + semiMajor: + $ref: '#/components/schemas/Uncertainty' + verticalUncertainty: + $ref: '#/components/schemas/Uncertainty' + orientationAngle: + $ref: '#/components/schemas/Angle' + +AddLocationDatas: + type: object + properties: + addLocationDatas: + type: array + items: + $ref: '#/components/schemas/LocationData' + minItems: 1 + +AddEventNotifyDatas: + type: object + properties: + addEventNotifyDatas: + type: array + items: + $ref: '#/components/schemas/EventNotifyData' + minItems: 1 + +MappedLocationQoSEps: + description: Mapped Location QoS for EPS. + type: object + required: + - hAccuracy + properties: + hAccuracy: + $ref: '#/components/schemas/Accuracy' + vAccuracy: + $ref: '#/components/schemas/Accuracy' + +AdditionalUeInfo: + description: MBSR UE Information + type: object + properties: + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + +# +# +# SIMPLE TYPES +# +Altitude: + description: Indicates value of altitude. + type: number + format: double + minimum: -32767 + maximum: 32767 + +Angle: + description: Indicates value of angle. + type: integer + minimum: 0 + maximum: 360 + +Uncertainty: + description: Indicates value of uncertainty. +``` + +``` +type: number +format: float +minimum: 0 + +Orientation: + description: Indicates value of orientation angle. + type: integer + minimum: 0 + maximum: 180 + +Confidence: + description: Indicates value of confidence. + type: integer + minimum: 0 + maximum: 100 + +Accuracy: + description: Indicates value of accuracy. + type: number + format: float + minimum: 0 + +InnerRadius: + description: Indicates value of the inner radius. + type: integer + format: int32 + minimum: 0 + maximum: 327675 + +CorrelationID: + description: LCS Correlation ID. + type: string + minLength: 1 + maxLength: 255 + +AgeOfLocationEstimate: + description: Indicates value of the age of the location estimate. + type: integer + minimum: 0 + maximum: 32767 + +HorizontalSpeed: + description: Indicates value of horizontal speed. + type: number + format: float + minimum: 0 + maximum: 2047 + +VerticalSpeed: + description: Indicates value of vertical speed. + type: number + format: float + minimum: 0 + maximum: 255 + +SpeedUncertainty: + description: Indicates value of speed uncertainty. + type: number + format: float + minimum: 0 + maximum: 255 + +BarometricPressure: + description: Specifies the measured uncompensated atmospheric pressure. + type: integer + minimum: 30000 + maximum: 115000 + +LcsServiceType: + description: LCS service type. + type: integer + minimum: 0 + maximum: 127 + +LdrReference: + description: LDR Reference. + type: string + minLength: 2 +``` + +``` + maxLength: 510 + + LirReference: + description: LIR Reference. + type: string + minLength: 2 + maxLength: 510 + + ReportingAmount: + description: Number of required periodic event reports. + type: integer + minimum: 1 + maximum: 8639999 + + ReportingInterval: + description: Event reporting periodic interval in seconds. + type: integer + minimum: 1 + maximum: 8639999 + + ReportingIntervalMs: + description: Event reporting periodic interval in milliseconds. + type: integer + minimum: 1 + maximum: 999 + + MinimumInterval: + description: Minimum interval between event reports. + type: integer + minimum: 1 + maximum: 32767 + + MaximumInterval: + description: Maximum interval between event reports. + type: integer + minimum: 1 + maximum: 86400 + + SamplingInterval: + description: Maximum time interval between consecutive evaluations by a UE of a trigger event. + type: integer + minimum: 1 + maximum: 3600 + + ReportingDuration: + description: Maximum duration of event reporting. + type: integer + minimum: 1 + maximum: 8640000 + + LinearDistance: + description: Minimum straight line distance moved by a UE to trigger a motion event report. + type: integer + minimum: 1 + maximum: 10000 + + LMFIdentification: + description: LMF identification. + type: string + + EventReportCounter: + description: Number of event reports received from the target UE. + type: integer + minimum: 1 + maximum: 8640000 + + EventReportDuration: + description: Duration of event reporting. + type: integer + minimum: 1 + maximum: 8640000 + + UePositioningCapabilities: + description: Positioning capabilities supported by the UE. A string encoding the + "ProvideCapabilities-r9-IEs" IE as specified in clause 6.3 of 3GPP TS 37.355 (start from octet 1). + type: string + format: byte +``` + +``` +# +# ENUMS +# +ExternalClientType: + description: Indicates types of External Clients. + anyOf: + - type: string + enum: + - EMERGENCY_SERVICES + - VALUE_ADDED_SERVICES + - PLMN_OPERATOR_SERVICES + - LAWFUL_INTERCEPT_SERVICES + - PLMN_OPERATOR_BROADCAST_SERVICES + - PLMN_OPERATOR_OM + - PLMN_OPERATOR_ANONYMOUS_STATISTICS + - PLMN_OPERATOR_TARGET_MS_SERVICE_SUPPORT + - type: string + +SupportedGADShapes: + description: Indicates supported GAD shapes. + anyOf: + - type: string + enum: + - POINT + - POINT_UNCERTAINTY_CIRCLE + - POINT_UNCERTAINTY_ELLIPSE + - POLYGON + - POINT_ALTITUDE + - POINT_ALTITUDE_UNCERTAINTY + - ELLIPSOID_ARC + - LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE + - LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID + - RANGE_DIRECTION + - RELATIVE_2D_LOCATION_UNCERTAINTY_ELLIPSE + - RELATIVE_3D_LOCATION_UNCERTAINTY_ELLIPSOID + - type: string + +ResponseTime: + description: Indicates acceptable delay of location request. + anyOf: + - type: string + enum: + - LOW_DELAY + - DELAY_TOLERANT + - NO_DELAY + - type: string + +PositioningMethod: + description: Indicates supported positioning methods. + anyOf: + - type: string + enum: + - CELLID + - ECID + - OTDOA + - BAROMETRIC_PRESSURE + - WLAN + - BLUETOOTH + - MBS + - MOTION_SENSOR + - DL_TDOA + - DL_AOD + - MULTI-RTT + - NR_ECID + - UL_TDOA + - UL_AOA + - NETWORK_SPECIFIC + - type: string + +PositioningMode: + description: Indicates supported modes used for positioning method. + anyOf: + - type: string + enum: + - UE_BASED + - UE_ASSISTED + - CONVENTIONAL + - type: string +``` + +GnssId: +description: Global Navigation Satellite System (GNSS) ID. +anyOf: +- type: string +enum: +- GPS +- GALILEO +- SBAS +- MODERNIZED\_GPS +- QZSS +- GLONASS +- BDS +- NAVIC +- type: string + +Usage: +description: Indicates usage made of the location measurement. +anyOf: +- type: string +enum: +- UNSUCCESS +- SUCCESS\_RESULTS\_NOT\_USED +- SUCCESS\_RESULTS\_USED\_TO\_VERIFY\_LOCATION +- SUCCESS\_RESULTS\_USED\_TO\_GENERATE\_LOCATION +- SUCCESS\_METHOD\_NOT\_DETERMINED +- type: string + +LcsPriority: +description: Indicates priority of the LCS client. +anyOf: +- type: string +enum: +- HIGHEST\_PRIORITY +- NORMAL\_PRIORITY +- type: string + +VelocityRequested: +description: Indicates velocity requirement. +anyOf: +- type: string +enum: +- VELOCITY\_IS\_NOT\_REQUESTED +- VELOCITY\_IS\_REQUESTED +- type: string + +AccuracyFulfilmentIndicator: +description: Indicates fulfilment of requested accuracy. +anyOf: +- type: string +enum: +- REQUESTED\_ACCURACY\_FULFILLED +- REQUESTED\_ACCURACY\_NOT\_FULFILLED +- type: string + +VerticalDirection: +description: Indicates direction of vertical speed. +type: string +enum: +- UPWARD +- DOWNWARD + +LdrType: +description: Indicates LDR types. +anyOf: +- type: string +enum: +- UE\_AVAILABLE +- PERIODIC +- ENTERING\_INTO\_AREA +- LEAVING\_FROM\_AREA +- BEING\_INSIDE\_AREA +- MOTION +- type: string + +ReportingAreaType: +description: Indicates type of event reporting area. +anyOf: + +- type: string + - enum: + - EPS\_TRACKING\_AREA\_IDENTITY + - E-UTRAN\_CELL\_GLOBAL\_IDENTIFICATION + - 5GS\_TRACKING\_AREA\_IDENTITY + - NR\_CELL\_GLOBAL\_IDENTITY +- type: string + +OccurrenceInfo: + +description: Specifies occurrence of event reporting. + +anyOf: + +- type: string + - enum: + - ONE\_TIME\_EVENT + - MULTIPLE\_TIME\_EVENT +- type: string + +ReportingAccessType: + +description: Specifies access types of event reporting. + +anyOf: + +- type: string + - enum: + - NR + - EUTRA\_CONNECTED\_TO\_5GC + - NON\_3GPP\_CONNECTED\_TO\_5GC + - NR\_LEO + - NR\_MEO + - NR\_GEO + - NR\_OTHER\_SAT + - EUTRA\_CONNECTED\_TO\_EPC +- type: string + +EventClass: + +description: Specifies event classes. + +anyOf: + +- type: string + - enum: + - SUPPLEMENTARY\_SERVICES +- type: string + +ReportedEventType: + +description: Specifies type of event reporting. + +anyOf: + +- type: string + - enum: + - PERIODIC\_EVENT + - ENTERING\_AREA\_EVENT + - LEAVING\_AREA\_EVENT + - BEING\_INSIDE\_AREA\_EVENT + - MOTION\_EVENT + - MAXIMUM\_INTERVAL\_EXPIRATION\_EVENT + - LOCATION\_CANCELLATION\_EVENT + - INTERMEDIATE\_EVENT + - DIRECT\_REPORT\_EVENT + - CUMULATIVE\_EVENT\_REPORT +- type: string + +TerminationCause: + +description: Specifies causes of event reporting termination. + +anyOf: + +- type: string + - enum: + - TERMINATION\_BY\_UE + - TERMINATION\_BY\_NETWORK + - NORMAL\_TERMINATION +- type: string + +LcsQoSClass: + +description: Specifies LCS QoS class. + +anyOf: + +- type: string + - enum: + - BEST\_EFFORT + - ASSURED + - MULTIPLE\_QOS +- type: string + +UeLocationServiceInd: + +description: Specifies location service types requested by UE. +anyOf: +- type: string +enum: +- LOCATION\_ESTIMATE +- LOCATION\_ASSISTANCE\_DATA +- type: string + +IndoorOutdoorInd: +description: Specifies UE location indoor or outdoor. +anyOf: +- type: string +enum: +- INDOOR +- OUTDOOR +- type: string + +FixType: +description: Specifies the positioning fix type. +anyOf: +- type: string +enum: +- CARRIER\_PHASE\_FLOAT +- CARRIER\_PHASE\_FIX +- type: string + +LosNlosMeasureInd: +description: Specifies LOS measurement or NLOS measurement. +anyOf: +- type: string +enum: +- LOS +- NLOS +- type: string + +UpConnectionStatus: +description: UP Connection Status. +anyOf: +- type: string +enum: +- ESTABLISHED +- RELEASED +- MOVE +- type: string + +RangingSlResult: +description: Specifies the type of result requested for ranging and sidelink positioning. +anyOf: +- type: string +enum: +- ABSOLUTE\_LOCATION +- RELATIVE\_LOCATION +- RANGING\_DIRECTION +- RANGING +- DIRECTION +- VELOCITY +- RELATIVE\_VELOCITY +- type: string + +RelatedUEType: +description: Specifies the different roles of UE for ranging and sidelink positioning service. +anyOf: +- type: string +enum: +- LOCATED\_UE +- REFERENCE\_UE +- type: string + +LcsUpConnectionInd: +description: LCS UP Connection Indication. +anyOf: +- type: string +enum: +- TERMINATION +- SETUP +- type: string + +UeUpPositioningCapabilities: + +``` +description: User plane positioning capabilities supported by the UE. +anyOf: + - type: string + enum: + - LCS-UPP + - SUPL + - type: string +``` + +--- + +## A.3 Nlmf\_Broadcast API + +openapi: 3.0.0 + +``` +info: + version: '1.2.0-alpha.1' + title: 'LMF Broadcast' + description: | + LMF Broadcast Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +``` + +``` +externalDocs: + description: 3GPP TS 29.572 V18.0.0; 5G System; Location Management Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.572/' +``` + +``` +servers: + - url: '{apiRoot}/nlmf-broadcast/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +``` + +``` +paths: + /cipher-key-data: + post: + summary: Request ciphering key data + operationId: CipheringKeyData + tags: + - Request Ciphering Key Data + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Cipher requestData' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CipherResponseData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + CipheringKeyData: + '{ $request.body#/amfCallBackURI }': + post: + requestBody: + description: Ciphering Key Data Notification + content: + application/json: + schema: + $ref: '#/components/schemas/CipheringKeyInfo' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CipheringKeyResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + schemas: +# +# COMPLEX TYPES +# + CipheringKeyInfo: + description: Information within Ciphering Key Data Notification request. + type: object + required: + - cipheringData + properties: + cipheringData: + type: array + items: + $ref: '#/components/schemas/CipheringDataSet' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + CipheringKeyResponse: + description: Information within Ciphering Key Data Notification Response. + +``` + +``` +type: object +properties: + cipheringDataReport: + type: array + items: + $ref: '#/components/schemas/CipheringSetReport' + minItems: 1 + +CipheringDataSet: + description: Represents a Ciphering Data Set. + type: object + required: + - cipheringSetID + - cipheringKey + - c0 + - validityStartTime + - validityDuration + properties: + cipheringSetID: + $ref: '#/components/schemas/CipheringSetID' + cipheringKey: + $ref: '#/components/schemas/CipheringKey' + c0: + $ref: '#/components/schemas/C0' + ltePossSibTypes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + nrPossSibTypes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + validityStartTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + validityDuration: + $ref: '#/components/schemas/ValidityDuration' + tailList: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +CipheringSetReport: + description: Represents a report of Ciphering Data Set storage. + type: object + required: + - cipheringSetID + - storageOutcome + properties: + cipheringSetID: + $ref: '#/components/schemas/CipheringSetID' + storageOutcome: + $ref: '#/components/schemas/StorageOutcome' + +Cipher requestData: + description: Information within Ciphering Key Data request. + type: object + required: + - amfCallBackURI + properties: + amfCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +CipherResponseData: + description: Information within Ciphering Key Data Response. + type: object + required: + - dataAvailability + properties: + dataAvailability: + $ref: '#/components/schemas/DataAvailability' + +# +# +# SIMPLE TYPES +# + +CipheringSetID: + description: Ciphering Data Set Identifier. + type: integer + minimum: 0 + maximum: 65535 + +CipheringKey: + description: Ciphering Key. +``` + +format: byte +type: string + +C0: +description: First component of the initial ciphering counter. +format: byte +type: string + +ValidityDuration: +description: Validity Duration of the Ciphering Data Set. +type: integer +minimum: 1 +maximum: 65535 + +# + +# ENUMS + +# + +StorageOutcome: +description: Indicates the result of Ciphering Data Set storage. +anyOf: +- type: string +enum: +- STORAGE\_SUCCESSFUL +- STORAGE\_FAILED + +DataAvailability: +description: Indicates availability of ciphering key data at an LMF. +anyOf: +- type: string +enum: +- CIPHERING\_KEY\_DATA\_AVAILABLE +- CIPHERING\_KEY\_DATA\_NOT\_AVAILABLE + +--- + +## Annex B (informative): Change history + +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +|---------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------------------------------------|-------------| +| 2018-01 | CT4#82 | | | | | TS Skeleton agreed in CT4#82 | 0.0.0 | +| 2018-01 | CT4#82 | C4-181398 | | | | Initial draft (C4-181119)
Incorporation of agreed pCRs from CT4#82: C4-181121, C4-181233, C4-181234 | 0.1.0 | +| 2018-03 | CT4#83 | C4-182444 | | | | Incorporation of agreed pCRs from CT4#83: C4-182181, C4-182427 | 0.2.0 | +| 2018-03 | CT#79 | CP-180034 | | | | Presented for information | 1.0.0 | +| 2018-04 | CT4#84 | C4-183524 | | | | Incorporation of agreed pCRs from CT4#84: C4-183184, C4-183363, C4-183510 | 1.1.0 | +| 2018-05 | CT4#85 | C4-184640 | | | | Incorporation of agreed pCRs from CT4#85: C4-184195, C4-184197, C4-184198, C4-184199, C4-184202, C4-184443, C4-184446, C4-184547 | 1.2.0 | +| 2018-06 | CT#80 | CP-181111 | | | | Presented for approval | 2.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80 | 15.0.0 | +| 2018-09 | CT#81 | CP-182066 | 0002 | 2 | | Error Cases | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0003 | - | | Custom Headers | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0004 | - | | Overall Clean-up | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0005 | - | | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0006 | 1 | | Resource structure presentation | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0007 | 1 | | LMF servers clause in OpenAPI | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0008 | - | | API Version Update | 15.1.0 | +| 2018-12 | CT#82 | CP-183025 | 0010 | 1 | F | Cardinality | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0011 | - | F | APIRoot Clarification | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0012 | - | F | AMF Id | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0013 | - | F | Barometric Pressure in Location Data | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0014 | 1 | F | Clarify Serving Cell in Input Data | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0015 | 1 | F | Oauth2 Corrections | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0016 | - | F | API Version | 15.2.0 | +| 2018-12 | CT#82 | CP-183179 | 0017 | - | F | ExternalDocs Update | 15.2.0 | +| 2019-03 | CT#83 | CP-190030 | 0018 | 1 | F | OpenAPI Corrections | 15.3.0 | +| 2019-03 | CT#83 | CP-190030 | 0019 | 1 | F | Application Errors | 15.3.0 | +| 2019-03 | CT#83 | CP-190030 | 0020 | 1 | F | Essential Correction to InnerRadius | 15.3.0 | +| 2019-03 | CT#83 | CP-190030 | 0021 | 1 | F | Mandatory Response Codes | 15.3.0 | +| 2019-03 | CT#83 | CP-190030 | 0022 | 1 | F | Essential correction to OpenAPI definition of GeographicArea | 15.3.0 | +| 2019-03 | CT#83 | CP-190030 | 0023 | - | F | API version update | 15.3.0 | +| 2019-06 | CT#84 | CP-191042 | 0024 | 2 | F | UE Capabilities | 15.4.0 | +| 2019-06 | CT#84 | CP-191042 | 0025 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | +| 2019-06 | CT#84 | CP-191042 | 0027 | 1 | F | Copyright Note in OpenAPI Spec | 15.4.0 | +| 2019-06 | CT#84 | CP-191042 | 0028 | 1 | F | Major API version | 15.4.0 | +| 2019-06 | CT#84 | CP-191042 | 0030 | - | F | Open API Version | 15.4.0 | +| 2019-09 | CT#85 | CP-192113 | 0031 | 1 | F | Missing attribute FLR in Civic Address | 16.0.0 | +| 2019-09 | CT#85 | CP-192192 | 0033 | 2 | B | LMF service operations for a deferred 5GC-MT-LR | 16.0.0 | +| 2019-09 | CT#85 | CP-192192 | 0034 | 1 | B | LMF service operations for a commercial 5GC-MT-LR | 16.0.0 | +| 2019-09 | CT#85 | CP-192192 | 0035 | - | F | High Accuracy Support | 16.0.0 | +| 2019-09 | CT#85 | CP-192113 | 0037 | 1 | D | Correct type Polygon | 16.0.0 | +| 2019-09 | CT#85 | CP-192120 | 0039 | - | F | 3GPP TS 29.572 API version update | 16.0.0 | +| 2019-12 | CT#86 | CP-193033 | 0041 | 1 | A | Motion Sensor Position Method | 16.1.0 | +| 2019-12 | CT#86 | CP-193165 | 0042 | 3 | B | Addition of the LMF Broadcast Service Operations | 16.1.0 | +| 2019-12 | CT#86 | CP-193055 | 0043 | 1 | B | LCS QoS Class | 16.1.0 | +| 2019-12 | CT#86 | CP-193036 | 0045 | 1 | F | ExternalDoc Clause | 16.1.0 | +| 2019-12 | CT#86 | CP-193036 | 0046 | 1 | F | ProblemDetails Optional in Error Response | 16.1.0 | +| 2019-12 | CT#86 | CP-193044 | 0048 | - | F | 3GPP TS 29.572 API version update | 16.1.0 | +| 2020-03 | CT#87 | CP-200039 | 0049 | 2 | F | Add Corresponding API descriptions in clause 5.1 | 16.2.0 | +| 2020-03 | CT#87 | CP-200039 | 0050 | 2 | D | Editorial corrections | 16.2.0 | +| 2020-03 | CT#87 | CP-200039 | 0051 | 1 | F | Correction - formatting consistency | 16.2.0 | +| 2020-03 | CT#87 | CP-200018 | 0052 | | B | Connectivity state per access type | 16.2.0 | +| 2020-03 | CT#87 | CP-200018 | 0053 | | B | Primary Cell in the Secondary RAN node | 16.2.0 | +| 2020-03 | CT#87 | CP-200052 | 0055 | | F | 3GPP TS 29.572 Rel16 API External doc update | 16.2.0 | +| 2020-03 | CT#87 | CP-200180 | 0054 | 4 | B | Request Type and embedded LPP message | 16.2.0 | +| 2020-06 | CT#88e | CP-201060 | 0056 | 1 | F | Add a new Notifications Overview Table | 16.3.0 | +| 2020-06 | CT#88e | CP-201060 | 0057 | 1 | F | Add custom operation Name | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0058 | | F | Location Context Transfer | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0059 | 1 | B | Network Specific Positioning Methods | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0060 | | B | Positioning Methods Support | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0061 | 2 | F | Storage of YAML files in ETSI Forge | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0062 | 1 | F | Resolve Editor Notes | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0063 | 1 | F | LDRreference | 16.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------|--------| +| 2020-06 | CT#88e | CP-201032 | 0065 | 1 | F | Resolution of EN on NR positioning SIBs | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0068 | 1 | F | Adding ResponseTime enumeration value | 16.3.0 | +| 2020-06 | CT#88e | CP-201060 | 0069 | | F | Missing Descriptions | 16.3.0 | +| 2020-06 | CT#88e | CP-201073 | 0070 | | F | 29.572 Rel-16 API version and External doc update | 16.3.0 | +| 2020-09 | CT#89e | CP-202112 | 0071 | 1 | F | Optionality of ProblemDetails in TS29.572 cleanup | 16.4.0 | +| 2020-09 | CT#89e | CP-202112 | 0073 | 1 | F | Adding missing navigation satellite systems for positioning | 16.4.0 | +| 2020-09 | CT#89e | CP-202112 | 0074 | 1 | F | Including VGMLC address towards LMF when requesting LMF's Location service | 16.4.0 | +| 2020-09 | CT#89e | CP-202112 | 0075 | 1 | F | Corrections on EventNotify service operation | 16.4.0 | +| 2020-09 | CT#89e | CP-202043 | 0077 | 1 | F | Correct mismatch on GeographicArea between table and yaml | 16.4.0 | +| 2020-09 | CT#89e | CP-202096 | 0078 | - | F | 29.572 Rel-16 API version and External doc update | 16.4.0 | +| 2020-12 | CT#90e | CP-203050 | 0080 | 1 | F | Essential corrections in clause 5.2.2.4 CancelLocation | 16.5.0 | +| 2020-12 | CT#90e | CP-203050 | 0081 | 1 | F | Indication of control plane CLoT 5GS optimization in LocationContextTransfer | 16.5.0 | +| 2020-12 | CT#90e | CP-203035 | 0082 | 1 | F | YAML files in 3GPP Forge | 16.5.0 | +| 2020-12 | CT#90e | CP-203036 | 0085 | 1 | F | 29.572 Rel-16 API version and External doc update | 16.5.0 | +| 2021-03 | CT#91e | CP-210041 | 0087 | - | F | Missing PIDL-LO elements in Location Information | 17.0.0 | +| 2021-03 | CT#91e | CP-210037 | 0088 | 1 | F | HTTP 3xx redirection | 17.0.0 | +| 2021-03 | CT#91e | CP-210034 | 0089 | - | F | Reference change | 17.0.0 | +| 2021-03 | CT#91e | CP-210054 | 0091 | - | F | 29.572 Rel-16 API version and External doc update | 17.0.0 | +| 2021-06 | CT#92e | CP-211055 | 0092 | 1 | F | Resolving Warning in Nlmf_BroadCast API | 17.1.0 | +| 2021-06 | CT#92e | CP-211055 | 0093 | | F | Resolving Warning in Nlmf_Location API | 17.1.0 | +| 2021-06 | CT#92e | CP-211026 | 0094 | 1 | B | Add List of Assistance Data Types for MO-LR | 17.1.0 | +| 2021-06 | CT#92e | CP-211026 | 0095 | 3 | B | Add Local Coordinates | 17.1.0 | +| 2021-06 | CT#92e | CP-211051 | 0096 | | F | OpenAPI Reference | 17.1.0 | +| 2021-06 | CT#92e | CP-211059 | 0098 | | A | 3xx description correction for SCP | 17.1.0 | +| 2021-06 | CT#92e | CP-211059 | 0102 | 1 | A | Redirect Response | 17.1.0 | +| 2021-06 | CT#92e | CP-211050 | 0103 | | F | 29.572 Rel-17 API version and External doc update | 17.1.0 | +| 2021-09 | CT#93e | CP-212034 | 0105 | 1 | B | Add UE Positioning Capabilities | 17.2.0 | +| 2021-09 | CT#93e | CP-212034 | 0108 | 2 | B | Support for Area Decision of Satellite Access | 17.2.0 | +| 2021-09 | CT#93e | CP-212034 | 0109 | 1 | B | LMF Parameters Support for non-3GPP Access | 17.2.0 | +| 2021-09 | CT#93e | CP-212064 | 0111 | | A | Encoding of binary attributes in JSON objects | 17.2.0 | +| 2021-09 | CT#93e | CP-212034 | 0114 | 1 | B | Multiple QoS Class | 17.2.0 | +| 2021-09 | CT#93e | CP-212059 | 0115 | | F | 29.572 Rel-17 API version and External doc update | 17.2.0 | +| 2021-12 | CT#94e | CP-213096 | 0118 | 1 | B | Multiple LPP messages | 17.3.0 | +| 2021-12 | CT#94e | CP-213096 | 0119 | 1 | B | Higher Resolution Timestamp for Location Estimates | 17.3.0 | +| 2021-12 | CT#94e | CP-213096 | 0120 | | F | UE Positioning Capabilities Data Type | 17.3.0 | +| 2021-12 | CT#94e | CP-213096 | 0121 | 1 | B | Update allowed access type for event report | 17.3.0 | +| 2021-12 | CT#94e | CP-213118 | 0122 | | F | Resolve OpenAPI Warnings | 17.3.0 | +| 2021-12 | CT#94e | CP-213120 | 0123 | | F | 307/308 redirection | 17.3.0 | +| 2021-12 | CT#94e | CP-213121 | 0124 | | F | 29.572 Rel-17 API version and External doc update | 17.3.0 | +| 2022-03 | CT#95e | CP-220034 | 0128 | | F | Corrections on the RelativeCartesianLocation | 17.4.0 | +| 2022-03 | CT#95e | CP-220227 | 0130 | 1 | A | Corrections on attributes | 17.4.0 | +| 2022-03 | CT#95e | CP-220090 | 0131 | | F | Update incorrect table number | 17.4.0 | +| 2022-03 | CT#95e | CP-220217 | 0133 | | F | 29.572 Rel-17 API version and External doc update | 17.4.0 | +| 2022-06 | CT#96 | CP-221022 | 0135 | 1 | B | Schedule location time for LMF | 17.5.0 | +| 2022-06 | CT#96 | CP-221022 | 0136 | | F | Update the title of RelativeCartesianLocation | 17.5.0 | +| 2022-06 | CT#96 | CP-221051 | 0138 | | F | 29.572 Rel-17 API version and External doc update | 17.5.0 | +| 2022-09 | CT#97 | CP-222030 | 0139 | 1 | F | Alignment on the service name used with template | 17.6.0 | +| 2022-09 | CT#97 | CP-222036 | 0140 | 1 | F | Indication of Network Assisted Positioning method | 17.6.0 | +| 2022-09 | CT#97 | CP-222058 | 0141 | | F | 29.572 Rel-17 API version and External doc update | 17.6.0 | +| 2022-12 | CT#98 | CP-223028 | 0142 | 1 | F | Missing mandatory status codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98 | CP-223055 | 0143 | 1 | F | Correction on country verification for satellite access | 18.0.0 | +| 2022-12 | CT#98 | CP-223064 | 0146 | 1 | F | Boolean type IEs definition correction | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0147 | | F | 29.572 Rel-18 API version and External doc update | 18.0.0 | +| 2023-03 | CT#99 | CP-230032 | 0153 | 2 | B | Support of Event Report Allowed Area | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0154 | 2 | B | Support of UE Unaware Positioning | 18.1.0 | +| 2023-03 | CT#99 | CP-230324 | 0155 | 3 | B | Multiple location report for MT-LR Immediate Location Request for the regulatory service | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0158 | 2 | B | Location service in PNI-NPN with signalling optimisation | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0159 | 2 | B | Support of low power and high accuracy positioning | 18.1.0 | +| 2023-03 | CT#99 | CP-230071 | 0161 | | F | 29.572 Rel-18 API version and External doc update | 18.1.0 | +| 2023-06 | CT#100 | CP-231028 | 0160 | 4 | F | Location header description | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0164 | 2 | B | NWDAF assisted LMF positioning method determination | 18.2.0 | +| 2023-06 | CT#100 | CP-231075 | 0166 | 1 | A | Missing finer periodicities than 1s and an infinite reporting amount | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0168 | 1 | B | Support of UE User Plane Positioning Capability | 18.2.0 | +| 2023-06 | CT#100 | CP-231026 | 0172 | | B | OAuth2 scopes in the Nlmf_Location API | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0175 | 3 | B | Clarification of the location QoS mapping | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0176 | 2 | B | Add reporting indication | 18.2.0 | +| 2023-06 | CT#100 | CP-231055 | 0177 | 1 | B | Support of location service involving Mobile Base Station Relay | 18.2.0 | +| 2023-06 | CT#100 | CP-231070 | 0180 | | F | 29.572 Rel-18 API version and External doc update | 18.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------|--------| +| 2023-09 | CT#101 | CP-232035 | 0183 | 1 | F | Correction on Reporting Indication | 18.3.0 | +| 2023-09 | CT#101 | CP-232063 | 0185 | 1 | A | Missed HA GNSS Metrics Support over SBI | 18.3.0 | +| 2023-09 | CT#101 | CP-232154 | 0186 | 2 | B | The service operation of Nlmf_Location_MeasurementData | 18.3.0 | +| 2023-09 | CT#101 | CP-232035 | 0188 | 2 | B | Support on NLOS/LOS measurement indication | 18.3.0 | +| 2023-09 | CT#101 | CP-232155 | 0189 | 3 | B | Nlmf_Location_UPNotify service operation | 18.3.0 | +| 2023-09 | CT#101 | CP-232035 | 0190 | 2 | B | Nlmf_Location_UPSubscribe service operation | 18.3.0 | +| 2023-09 | CT#101 | CP-232062 | 0192 | 1 | A | Add GNSS integrity requirement | 18.3.0 | +| 2023-09 | CT#101 | CP-232178 | 0193 | 3 | B | Update on LMF service for MT procedures for ranging_SL | 18.3.0 | +| 2023-09 | CT#101 | CP-232060 | 0194 | | F | 29.572 Rel-18 API version and External doc update | 18.3.0 | +| 2023-12 | CT#102 | CP-233037 | 0182 | 3 | B | Periodic or triggered location events via user plane to an LCS Client or AF | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0196 | 1 | F | Addition of missing interface between LMF and GMLC | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0197 | 1 | B | Add the Nlmf_Location_UPConfig | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0198 | | F | Align with the SBI template | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0199 | | F | Correction on the description of scheduledLocTime | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0201 | | B | Update on UpNotifyData | 18.4.0 | +| 2023-12 | CT#102 | CP-233029 | 0203 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.4.0 | +| 2023-12 | CT#102 | CP-233294 | 0204 | 4 | B | Update on LMF service for ranging_SL | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0205 | 1 | F | Reporting Indication Definition Alignment to Stage 2 | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0206 | 2 | B | Multiple QoS for Deferred Location Service Continuation from 5GS to EPS | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0207 | 1 | B | Allowed Reporting Access Type for EUTRAN Connected to EPC | 18.4.0 | +| 2023-12 | CT#102 | CP-233030 | 0208 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233052 | 0209 | 1 | B | Addition of additional ULI of the MBSR UE | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0210 | | F | Correction on PRU Location Measurements | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0211 | 2 | B | Update user plane positioning capabilities | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 0214 | | F | Correction on OAuth Scopes Names | 18.4.0 | +| 2023-12 | CT#102 | CP-233060 | 0215 | 3 | F | 29.572 Rel-18 API version and External doc update | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29591/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/raw/rel-18/29_series/29591/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b1fbbf7db4e6d522af91d27cb96042ce9da3e63b --- /dev/null +++ b/raw/rel-18/29_series/29591/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a0ed3bf9d489ad4f157138f470c89739e6e058acc8dcac1b109330c76e885f94 +size 28978 diff --git a/raw/rel-18/29_series/29591/26d664119ad25250780f554633444e54_img.jpg b/raw/rel-18/29_series/29591/26d664119ad25250780f554633444e54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4108f1997db9cb2d73393ea28079d094fa6d9629 --- /dev/null +++ b/raw/rel-18/29_series/29591/26d664119ad25250780f554633444e54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:578d17d7c7c638c4e30c08afb7a585a2befd58bfa88f70a7c34c0fabd4a2428c +size 7103 diff --git a/raw/rel-18/29_series/29591/2876be3592c7b4878400b85f209b2b6a_img.jpg b/raw/rel-18/29_series/29591/2876be3592c7b4878400b85f209b2b6a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f24262e83d45353731d2b4add39f8af3ff29bb23 --- /dev/null +++ b/raw/rel-18/29_series/29591/2876be3592c7b4878400b85f209b2b6a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c28df74a198aaf45a461426e61ffee799263133d3eb1346565b9d4030e13d9f6 +size 32623 diff --git a/raw/rel-18/29_series/29591/2eb23c2210154279f8013a1594fbcc5a_img.jpg b/raw/rel-18/29_series/29591/2eb23c2210154279f8013a1594fbcc5a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6a2c2280da3144a2c9373a228867c358998a756a --- /dev/null +++ b/raw/rel-18/29_series/29591/2eb23c2210154279f8013a1594fbcc5a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4c723db006e2330a83eb3203223e57245a88fb42a860cbd1854332f160d2eb6c +size 34663 diff --git a/raw/rel-18/29_series/29591/382a9c9e4816bd229191ab4591424dd8_img.jpg b/raw/rel-18/29_series/29591/382a9c9e4816bd229191ab4591424dd8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f48fc0b84b954e59ca1e2e93323d54cda4b76e7d --- /dev/null +++ b/raw/rel-18/29_series/29591/382a9c9e4816bd229191ab4591424dd8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5df9ca03c05b5a5019ad12e45845f5984b6d05bc9ba7af68a80efb7c3f3793a9 +size 6780 diff --git a/raw/rel-18/29_series/29591/3db5d62ad46e33647ec2b1ad6d2703bb_img.jpg b/raw/rel-18/29_series/29591/3db5d62ad46e33647ec2b1ad6d2703bb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bcfaf5821ba921f66ec0a93cb9cdfac2af2d7e24 --- /dev/null +++ b/raw/rel-18/29_series/29591/3db5d62ad46e33647ec2b1ad6d2703bb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1d8bf84d9ec73b0ec60986f52bd6cd91cc9b3ad72a474ee7640f81ba45b5d0ef +size 32963 diff --git a/raw/rel-18/29_series/29591/51db757d054ce1ce83c436a3578b56ca_img.jpg b/raw/rel-18/29_series/29591/51db757d054ce1ce83c436a3578b56ca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dfd44cc0e29047e6553e284634a28928df225ffd --- /dev/null +++ b/raw/rel-18/29_series/29591/51db757d054ce1ce83c436a3578b56ca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:852ad0a47b10b530f655b5ce9788c3e149b9b6b376759ed8276318997c36687d +size 29390 diff --git a/raw/rel-18/29_series/29591/5478f70a6cef3e5672b2b22d28830cfb_img.jpg b/raw/rel-18/29_series/29591/5478f70a6cef3e5672b2b22d28830cfb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..00b7be95893e74bd932fb9034825605b2ee234f8 --- /dev/null +++ b/raw/rel-18/29_series/29591/5478f70a6cef3e5672b2b22d28830cfb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:395ab80b19c5597c3f56dfec300e8734f860cae095f55ec42a55afa17081095b +size 7420 diff --git a/raw/rel-18/29_series/29591/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29591/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eee23538f4331e41c90e17eb5aa6a4c88ef98700 --- /dev/null +++ b/raw/rel-18/29_series/29591/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:47c8598658b530b633a566998a2e83b6cf5e112ff74ddb78a1113d8336045669 +size 9324 diff --git a/raw/rel-18/29_series/29591/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29591/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a13eceea94dfdac733e5e2a2a32c83423e521829 --- /dev/null +++ b/raw/rel-18/29_series/29591/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4d982940701c38c80b9800c1db2ce2899587ee14e2c236c567b99808c074c606 +size 6272 diff --git a/raw/rel-18/29_series/29591/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg b/raw/rel-18/29_series/29591/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0a14346d4225901184f0f157612dc544a58caf0a --- /dev/null +++ b/raw/rel-18/29_series/29591/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3dd2b095e233f6fd1cd9791a3afd324ab67c46da82546302f5cbd8614f8fd2b2 +size 13041 diff --git a/raw/rel-18/29_series/29591/73da53f7da73c0e2ead71eb1e2f746fb_img.jpg b/raw/rel-18/29_series/29591/73da53f7da73c0e2ead71eb1e2f746fb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a00c2ebd3bd978414ad490f92d27b3be42668f6f --- /dev/null +++ b/raw/rel-18/29_series/29591/73da53f7da73c0e2ead71eb1e2f746fb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:90cdf9d624f97fd57d56f79dfa7efc7bbe2a0ee78a3ae1b0679f1aa79d940f6c +size 13418 diff --git a/raw/rel-18/29_series/29591/759c7d62402f0b4651ddce292be5bdef_img.jpg b/raw/rel-18/29_series/29591/759c7d62402f0b4651ddce292be5bdef_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..657c2828126d868ad811a88c12701e0a85be88f1 --- /dev/null +++ b/raw/rel-18/29_series/29591/759c7d62402f0b4651ddce292be5bdef_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dffd6cc8cd08f90aace017b84b5d471376b13caddd2ae867b1c289859c414908 +size 7658 diff --git a/raw/rel-18/29_series/29591/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg b/raw/rel-18/29_series/29591/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..763c3735674d6ed774f9fe4192219ac7a3e989a2 --- /dev/null +++ b/raw/rel-18/29_series/29591/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:66a14b501022cb925e3ac46520392f4f26ba983250c4b75093a1660e86fe5c23 +size 29711 diff --git a/raw/rel-18/29_series/29591/7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg b/raw/rel-18/29_series/29591/7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ffc7fdd41e44eb13af6c7a4636064cb9305bc315 --- /dev/null +++ b/raw/rel-18/29_series/29591/7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:65d09185a2ecb32b46f09d80a2167413c90818c1d6df056f47702f4164a9dcb9 +size 33985 diff --git a/raw/rel-18/29_series/29591/832a0ce332e784fe80289e9f00f56574_img.jpg b/raw/rel-18/29_series/29591/832a0ce332e784fe80289e9f00f56574_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b723acb4e02b7dde3263704bc57f2454965015ee --- /dev/null +++ b/raw/rel-18/29_series/29591/832a0ce332e784fe80289e9f00f56574_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a3fce099d21d644660462e7971b4872a8fc0924d5e961f16baeb979d1c7a3fd9 +size 21984 diff --git a/raw/rel-18/29_series/29591/84e5b251aa38db522f76f5cc3afcb853_img.jpg b/raw/rel-18/29_series/29591/84e5b251aa38db522f76f5cc3afcb853_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b062166063ab00141f61e360729cea26551d4f8c --- /dev/null +++ b/raw/rel-18/29_series/29591/84e5b251aa38db522f76f5cc3afcb853_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c53ef85ad52ca94e73b88196c53e2bb6fa09e04014fb8ce5ad8eb7ce3c2e436e +size 29304 diff --git a/raw/rel-18/29_series/29591/8ed7f57cc317f6574bec781d01ae6ad2_img.jpg b/raw/rel-18/29_series/29591/8ed7f57cc317f6574bec781d01ae6ad2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4fd62d9cf3a541a907fed3bb76862cd19cda9133 --- /dev/null +++ b/raw/rel-18/29_series/29591/8ed7f57cc317f6574bec781d01ae6ad2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5b8c41788a47ac26acd0fe81d25bcd1bf704d8f3d8f9a249cb9e3b00cf1d636d +size 28627 diff --git a/raw/rel-18/29_series/29591/9252ccfbbe9e34cb108f0060f2b563f1_img.jpg b/raw/rel-18/29_series/29591/9252ccfbbe9e34cb108f0060f2b563f1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ead9d64576413237686ad1c26811a5e362f29eaf --- /dev/null +++ b/raw/rel-18/29_series/29591/9252ccfbbe9e34cb108f0060f2b563f1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:266e9ee8d4be163b926621e820c9bf33dd55ad17f3e286b18b33f47edf749900 +size 9677 diff --git a/raw/rel-18/29_series/29591/9c1d3678db4a12d5864cb2a4def1135d_img.jpg b/raw/rel-18/29_series/29591/9c1d3678db4a12d5864cb2a4def1135d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aea3ffee7d9c6296293802b87a8e8f789a37f186 --- /dev/null +++ b/raw/rel-18/29_series/29591/9c1d3678db4a12d5864cb2a4def1135d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a97eca71a3a8ac0bf2f3a81bc45c5608c5f833088d0a2b6fcaf91da4a3673de2 +size 14445 diff --git a/raw/rel-18/29_series/29591/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg b/raw/rel-18/29_series/29591/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..31b3cb09fe68e7bf84803cec59932ea5b8f64ab4 --- /dev/null +++ b/raw/rel-18/29_series/29591/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:698a259a874155459d053b61b3ea03fc06a2a83055e825259eda0837678aab7c +size 24446 diff --git a/raw/rel-18/29_series/29591/b2ddf2a678bd20b1b491023eb1db6458_img.jpg b/raw/rel-18/29_series/29591/b2ddf2a678bd20b1b491023eb1db6458_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..54bae84ce70a034f44775f053c152b474b707fdc --- /dev/null +++ b/raw/rel-18/29_series/29591/b2ddf2a678bd20b1b491023eb1db6458_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:95ce72c1d27912712e3491d1724cf25dee756965cbc55ec6771597b07ba1c582 +size 33045 diff --git a/raw/rel-18/29_series/29591/b5335262987c819d7f71ce40f99cb71b_img.jpg b/raw/rel-18/29_series/29591/b5335262987c819d7f71ce40f99cb71b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..edffabbb8278c48d3df45a38921bdd68615b2d66 --- /dev/null +++ b/raw/rel-18/29_series/29591/b5335262987c819d7f71ce40f99cb71b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3ed5640aa40af36bbf5d969be1bc10313f9cb1af430c708dd105cdb1da283c1c +size 13410 diff --git a/raw/rel-18/29_series/29591/b560268ea8f6526970f23f0da225b099_img.jpg b/raw/rel-18/29_series/29591/b560268ea8f6526970f23f0da225b099_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b062166063ab00141f61e360729cea26551d4f8c --- /dev/null +++ b/raw/rel-18/29_series/29591/b560268ea8f6526970f23f0da225b099_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c53ef85ad52ca94e73b88196c53e2bb6fa09e04014fb8ce5ad8eb7ce3c2e436e +size 29304 diff --git a/raw/rel-18/29_series/29591/c64555b7f91435b01997807dbb4bcc4c_img.jpg b/raw/rel-18/29_series/29591/c64555b7f91435b01997807dbb4bcc4c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ec91317488163c4de1e0f5461c391f111f13bef8 --- /dev/null +++ b/raw/rel-18/29_series/29591/c64555b7f91435b01997807dbb4bcc4c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:db166f1fdf654913faf5d7e5b8a1045072bc6d45ae8554e2c47ea0c7e3b8a140 +size 22221 diff --git a/raw/rel-18/29_series/29591/c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg b/raw/rel-18/29_series/29591/c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..763c3735674d6ed774f9fe4192219ac7a3e989a2 --- /dev/null +++ b/raw/rel-18/29_series/29591/c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:66a14b501022cb925e3ac46520392f4f26ba983250c4b75093a1660e86fe5c23 +size 29711 diff --git a/raw/rel-18/29_series/29591/d4b3677f40009dd5bd8f9852463dc942_img.jpg b/raw/rel-18/29_series/29591/d4b3677f40009dd5bd8f9852463dc942_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..705181dcacb530a18fb030c9323096be0bc8b5a2 --- /dev/null +++ b/raw/rel-18/29_series/29591/d4b3677f40009dd5bd8f9852463dc942_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3dc5929275821a287f5d3ebac0c5f37bf654f56dfb3be250f95446dff2c1ad64 +size 9186 diff --git a/raw/rel-18/29_series/29591/d80af870e68195471418acd013389576_img.jpg b/raw/rel-18/29_series/29591/d80af870e68195471418acd013389576_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b44b13587537769c868ddfc3b08216ee40487579 --- /dev/null +++ b/raw/rel-18/29_series/29591/d80af870e68195471418acd013389576_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5dd4e2fda0075f961de2710e3a515565b73b46caf4e662c1295eae74c23df7b7 +size 22795 diff --git a/raw/rel-18/29_series/29591/ddd86d7df6cf14d68c0faf111c1e8fae_img.jpg b/raw/rel-18/29_series/29591/ddd86d7df6cf14d68c0faf111c1e8fae_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e667d431389ac0a45420c2873eb8babed4a3b361 --- /dev/null +++ b/raw/rel-18/29_series/29591/ddd86d7df6cf14d68c0faf111c1e8fae_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a9cece1aafaff1ff35714646b07a0a3e0fb8933453b1bba1eb50e93a91b0d777 +size 29021 diff --git a/raw/rel-18/29_series/29591/e05122559f56af5699789b7118d8fe87_img.jpg b/raw/rel-18/29_series/29591/e05122559f56af5699789b7118d8fe87_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..722054f615400ae2c5b11a14689349be71b76552 --- /dev/null +++ b/raw/rel-18/29_series/29591/e05122559f56af5699789b7118d8fe87_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:948eeffa1216b38f69ba332e5c2965a5660986b033ee09c0f45f53a3880682e3 +size 6745 diff --git a/raw/rel-18/29_series/29591/e05b36c0d46549e681ce6581422c66b2_img.jpg b/raw/rel-18/29_series/29591/e05b36c0d46549e681ce6581422c66b2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..36291056635bd111c353629090d14fefa5254d02 --- /dev/null +++ b/raw/rel-18/29_series/29591/e05b36c0d46549e681ce6581422c66b2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2699591e385a8db3ef6406872c09f15efb577bba5d4ce4cbf20fd7d2b30068b1 +size 31063 diff --git a/raw/rel-18/29_series/29591/e35f25e0b66752d4179a4cb108a3fb5a_img.jpg b/raw/rel-18/29_series/29591/e35f25e0b66752d4179a4cb108a3fb5a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8d17178b65b61d9f9699c4d0033c81ca6056dc12 --- /dev/null +++ b/raw/rel-18/29_series/29591/e35f25e0b66752d4179a4cb108a3fb5a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:59117635dbf5dbcd92ccbcd7ecb4876a331dc6a77b34c1b5ead612d73e0662c7 +size 21094 diff --git a/raw/rel-18/29_series/29591/eb1a67ebd688e354edaacb7ec2abf5ad_img.jpg b/raw/rel-18/29_series/29591/eb1a67ebd688e354edaacb7ec2abf5ad_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bcfaf5821ba921f66ec0a93cb9cdfac2af2d7e24 --- /dev/null +++ b/raw/rel-18/29_series/29591/eb1a67ebd688e354edaacb7ec2abf5ad_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1d8bf84d9ec73b0ec60986f52bd6cd91cc9b3ad72a474ee7640f81ba45b5d0ef +size 32963 diff --git a/raw/rel-18/29_series/29591/f64e1e0997695248c0cd4122c5b1a170_img.jpg b/raw/rel-18/29_series/29591/f64e1e0997695248c0cd4122c5b1a170_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4150856e7b3becd0a96fbfb157724e9f08ef043c --- /dev/null +++ b/raw/rel-18/29_series/29591/f64e1e0997695248c0cd4122c5b1a170_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:15c7d4c689bba9308b27600e4b84ece6d6c82b431a1cbe44ce4345287d3d0b3c +size 32563 diff --git a/raw/rel-18/29_series/29591/f732d3320afe06d979aabbd366184254_img.jpg b/raw/rel-18/29_series/29591/f732d3320afe06d979aabbd366184254_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9f7ec62d5eca92461afe759be1920049327e62bd --- /dev/null +++ b/raw/rel-18/29_series/29591/f732d3320afe06d979aabbd366184254_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0c4cbb3cff1d999497d66ca14d74d7f4e35d2ed943f656a6944d979508039dc0 +size 29719 diff --git a/raw/rel-18/29_series/29591/ff5f89b660edddb67971d7d3d4ce87ef_img.jpg b/raw/rel-18/29_series/29591/ff5f89b660edddb67971d7d3d4ce87ef_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..af085dbfff77fb0b2c4a56397e8c9b7fb0f956e8 --- /dev/null +++ b/raw/rel-18/29_series/29591/ff5f89b660edddb67971d7d3d4ce87ef_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c8eac08328ae680c9e9fb759ace84e33909b4e247225f4a3fa058e85f32b48e8 +size 22981 diff --git a/raw/rel-18/37_series/37213/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/37_series/37213/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7c96de11c2e607cb141727c7a695baee984487f0 --- /dev/null +++ b/raw/rel-18/37_series/37213/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2d804e3b74a3eb21d99f5733a7e0652936b16309f2924a96ae56ad800408879a +size 9635 diff --git a/raw/rel-18/37_series/37213/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/37_series/37213/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0ad8a42d305eb60ae0eae79213fe27530a56f816 --- /dev/null +++ b/raw/rel-18/37_series/37213/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:71b955a746a3029595390f481df96d57e030c236f73a499985b542a63c61430f +size 7171 diff --git a/raw/rel-18/37_series/37480/5e92d9e8e9ce204e405bff2367f88176_img.jpg b/raw/rel-18/37_series/37480/5e92d9e8e9ce204e405bff2367f88176_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bc2dbe00b246a30ef9703ca2a9cccd16a90ea06f --- /dev/null +++ b/raw/rel-18/37_series/37480/5e92d9e8e9ce204e405bff2367f88176_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:25176f7e0d8e54371246869d9f270587ddcccf5ab9da16e96a04ac49a65c5622 +size 22147 diff --git a/raw/rel-18/37_series/37480/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/37_series/37480/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..917c8de2f1986e8b73026afb0f29c045a2e899b6 --- /dev/null +++ b/raw/rel-18/37_series/37480/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2be5b5f8dc82b0ea46ce50f842a11e07152f697d75bb810f05723033b786ecfa +size 9581 diff --git a/raw/rel-18/37_series/37480/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/37_series/37480/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0d413d15cf046d46ac9b31cb3f5865ccc79639cb --- /dev/null +++ b/raw/rel-18/37_series/37480/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe03788647836c455985efd56c7805682d17e6975c29327d2fd6939a118f306e +size 8100 diff --git a/raw/rel-18/37_series/37877/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/37_series/37877/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..623b362cd02782b508a807030a378c0f620b9781 --- /dev/null +++ b/raw/rel-18/37_series/37877/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:317a36aa8274171a8ae2e15d647a9a2bcb36cb49fc408ed3c964eeae7d1a83af +size 9335 diff --git a/raw/rel-18/37_series/37877/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/37_series/37877/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..36c0b88af2dfdd519eab63f5dd43aee5eb8cef3c --- /dev/null +++ b/raw/rel-18/37_series/37877/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99a64ea3b7d5fbafbc4f7b6a07b346fa3ecc07479ea08dc72e5cc6da2a4aa3ca +size 5690 diff --git a/raw/rel-18/37_series/37878/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/37_series/37878/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ab63acb2ed4f50412ba51bdf756acb9daf8de042 --- /dev/null +++ b/raw/rel-18/37_series/37878/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:55fa5eecc6566f0f7f11bf9bf30066970efc60dca8652960fe5841000fa6ff5e +size 10046 diff --git a/raw/rel-18/37_series/37878/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/37_series/37878/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..965ead69cef12ba2d673705207be944ccbc76ea3 --- /dev/null +++ b/raw/rel-18/37_series/37878/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:87026c58388ccc3d09dd7e519808db9ff59a6e8274f091363cf84f74d5584f58 +size 5678