5G Core Network APIs (OpenAPI 3)

The files in this repository have been created by 3GPP, and the master source can be found in the 3GPP site, as part of the official 3GPP Technical Specifications.

© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved.

API version: March 2019

The links below will open the Swagger Editor and auto-load the OpenAPI YAML file of each Network Function (NF) API:

NRF (NF Repository Function)

• NF Management
• NF Discovery
• Access Token (OAuth2)

LMF (Location Management Function)

• Location

AMF (Access and Mobility Management Function)

• Communication
• Event Exposure
• Location
• MT

SMF (Session Management Function)

• PDU Session
• Event Exposure

UDM (Unified Data Management)

• Subscriber Data Management
• UE Context Management
• UE Authentication
• Event Exposure
• Parameter Provisioning

UDR (Unified Data Repository)

• Data Repository
  • Subscription Data
  • Policy Data
  • Exposure Data
  • Application Data

AUSF (Authentication Server Function)

• UE Authentication
• SoR (Steering of Roaming) Protection
• UPU (UE Parameter Update) Protection

NSSF (Network Slice Selection Function)

• NSSAI Availability
• NS Selection

SMSF (SMS Function)

• SM Service

5G-EIR (5G Equipment Identity Register)

• Equipment Identity Check

NEF (Network Exposure Function)

• Packet Flow Description (PFD) Management

PCF (Policy Control Function)

• Policy Authorization
• Access and Mobility (AM) Policy Control
• Session Management (SM) Policy Control
• Background Data Transfer (BDT) Policy Control
• Policy Control Event Exposure
• UE Policy Control

BSF (Binding Support Function)

• Management

NWDAF (Network Data Analytics Function)

• Events Subscription
• Analytics Info

CHF (Charging Function)

• Spending Limit Control
• Converged Charging

Common Data Types

• Common Data

SEPP N32 APIs

• Handshake (N32-c)
• Forwarding (N32-f)

Northbound APIs (CAPIF)

• Discover Service
• Publish Service
• Events
• API Invoker Management
• Security
• Access Control Policy
• Logging API Invocation
• Auditing
• AEF Authentication

Northbound APIs (T8)

NEF (Network Exposure Function)

• Traffic Influence

SCEF (Service Capability Exposure Function)

NOTE: These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G SCEF to the SCS/AS

• Event Monitoring
• Resource Management of Background Data Transfer (BDT)
• Chargeable Party
• Non-IP Data Delivery (NIDD)
• Device Triggering
• Group Message Delivery via MBMS by MB2
• Group Message Delivery via MBMS by xMB
• Network Status Reporting
• Communication Patterns (CP) Parameters Provisioning
• Packet Flow Description (PFD) Management
• Enhanced Coverage Restriction Control
• Network Parameter Configuration
• Application Server (AS) Session with QoS
• MSISDN-less Mobile-Originated SMS
• Common Data