Content for TS 29.510 Word version: 18.0.0
6 API Definitions
6.1 Nnrf_NFManagement Service API
6.2 Nnrf_NFDiscovery Service API
6.3 Nnrf_AccessToken Service API
6.4 Nnrf_Bootstrapping Service API
6 API Definitions p. 47
6.1 Nnrf_NFManagement Service API p. 47
6.1.1 API URI p. 47
6.1.2 Usage of HTTP p. 47
6.1.2.1 General p. 47
6.1.2.2 HTTP standard headers p. 47
6.1.2.2.1 General p. 47
6.1.2.2.2 Content type p. 47
6.1.2.2.3 Accept-Encoding p. 48
6.1.2.2.4 ETag |R16| p. 48
6.1.2.2.5 If-Match |R16| p. 48
6.1.2.3 HTTP custom headers p. 48
6.1.2.3.1 General p. 48
6.1.3 Resources p. 48
6.1.3.1 Overview p. 48
6.1.3.2 Resource: nf-instances (Store) p. 50
6.1.3.2.1 Description p. 50
6.1.3.2.2 Resource Definition p. 50
6.1.3.2.3 Resource Standard Methods p. 50
6.1.3.2.4 Resource Custom Operations p. 54
6.1.3.3 Resource: nf-instance (Document) p. 54
6.1.3.3.1 Description p. 54
6.1.3.3.2 Resource Definition p. 54
6.1.3.3.3 Resource Standard Methods p. 55
6.1.3.4 Resource: subscriptions (Collection) p. 61
6.1.3.4.1 Description p. 61
6.1.3.4.2 Resource Definition p. 61
6.1.3.4.3 Resource Standard Methods p. 61
6.1.3.5 Resource: subscription (Document) p. 63
6.1.4 Custom Operations without associated resources p. 65
6.1.5 Notifications p. 65
6.1.6 Data Model p. 67
6.1.6.1 General p. 67
6.1.6.2 Structured data types p. 71
6.1.6.2.1 Introduction p. 71
6.1.6.2.2 Type: NFProfile p. 72
6.1.6.2.3 Type: NFService p. 80
6.1.6.2.4 Type: DefaultNotificationSubscription p. 85
6.1.6.2.5 Type: IpEndPoint p. 86
6.1.6.2.6 Type: UdrInfo p. 87
6.1.6.2.7 Type: UdmInfo p. 88
6.1.6.2.8 Type: AusfInfo p. 89
6.1.6.2.9 Type: SupiRange p. 89
6.1.6.2.10 Type: IdentityRange p. 90
6.1.6.2.11 Type: AmfInfo p. 90
6.1.6.2.12 Type: SmfInfo p. 92
6.1.6.2.13 Type: UpfInfo p. 94
6.1.6.2.14 Type: SnssaiUpfInfoItem p. 96
6.1.6.2.15 Type: DnnUpfInfoItem p. 96
6.1.6.2.16 Type: SubscriptionData p. 97
6.1.6.2.17 Type: NotificationData p. 100
6.1.6.2.18 Void
6.1.6.2.19 Type: NFServiceVersion p. 101
6.1.6.2.20 Type: PcfInfo p. 102
6.1.6.2.21 Type: BsfInfo p. 103
6.1.6.2.22 Type: Ipv4AddressRange p. 103
6.1.6.2.23 Type: Ipv6PrefixRange p. 104
6.1.6.2.24 Type: InterfaceUpfInfoItem p. 104
6.1.6.2.25 Type: UriList p. 104
6.1.6.2.26 Type: N2InterfaceAmfInfo p. 105
6.1.6.2.27 Type: TaiRange p. 105
6.1.6.2.28 Type: TacRange p. 105
6.1.6.2.29 Type: SnssaiSmfInfoItem p. 106
6.1.6.2.30 Type: DnnSmfInfoItem p. 106
6.1.6.2.31 Type: NrfInfo p. 107
6.1.6.2.32 Type: ChfInfo p. 110
6.1.6.2.33 Void
6.1.6.2.34 Type: PlmnRange p. 111
6.1.6.2.35 Type: SubscrCond p. 112
6.1.6.2.36 Type: NfInstanceIdCond p. 112
6.1.6.2.37 Type: NfTypeCond p. 113
6.1.6.2.38 Type: ServiceNameCond p. 113
6.1.6.2.39 Type: AmfCond p. 113
6.1.6.2.40 Type: GuamiListCond p. 113
6.1.6.2.41 Type: NetworkSliceCond p. 113
6.1.6.2.42 Type: NfGroupCond p. 114
6.1.6.2.43 Type: NotifCondition p. 114
6.1.6.2.44 Type: PlmnSnssai p. 114
6.1.6.2.45 Type: NwdafInfo |R16| p. 115
6.1.6.2.46 Type: LmfInfo |R16| p. 116
6.1.6.2.47 Type: GmlcInfo |R16| p. 117
6.1.6.2.48 Type: NefInfo |R16| p. 118
6.1.6.2.49 Type: PfdData |R16| p. 118
6.1.6.2.50 Type: AfEventExposureData |R16| p. 119
6.1.6.2.51 Type: WAgfInfo |R16| p. 119
6.1.6.2.52 Type: TngfInfo |R16| p. 119
6.1.6.2.53 Type: PcscfInfo |R16| p. 120
6.1.6.2.54 Type: NfSetCond |R16| p. 120
6.1.6.2.55 Type: NfServiceSetCond |R16| p. 121
6.1.6.2.56 Type: NfInfo |R16| p. 121
6.1.6.2.57 Type: HssInfo |R16| p. 121
6.1.6.2.58 Type: ImsiRange |R16| p. 122
6.1.6.2.59 Type: InternalGroupIdRange |R16| p. 122
6.1.6.2.60 Type: UpfCond |R16| p. 122
6.1.6.2.61 Type: TwifInfo |R16| p. 123
6.1.6.2.62 Type: VendorSpecificFeature |R16| p. 123
6.1.6.2.63 Type: UdsfInfo |R16| p. 123
6.1.6.2.64 Type: NfInstanceIdListCond |R16| p. 123
6.1.6.2.65 Type: ScpInfo |R16| p. 124
6.1.6.2.66 Type: ScpDomainInfo |R16| p. 126
6.1.6.2.67 Type: ScpDomainCond |R16| p. 126
6.1.6.2.68 Type: OptionsResponse |R16| p. 127
6.1.6.2.69 Type: NwdafCond |R16| p. 127
6.1.6.2.70 Type: NefCond |R16| p. 128
6.1.6.2.71 Type: SuciInfo |R17| p. 128
6.1.6.2.72 Type: SeppInfo |R17| p. 129
6.1.6.2.73 Type: AanfInfo |R17| p. 129
6.1.6.2.74 Type: 5GDdnmfInfo |R17| p. 129
6.1.6.2.75 Type: MfafInfo |R17| p. 130
6.1.6.2.76 Type: NwdafCapability |R17| p. 130
6.1.6.2.77 Type: EasdfInfo |R17| p. 130
6.1.6.2.78 Type: SnssaiEasdfInfoItem |R17| p. 131
6.1.6.2.79 Type: DnnEasdfInfoItem |R17| p. 131
6.1.6.2.80 Type: DccfInfo |R17| p. 131
6.1.6.2.81 Type: NsacfInfo |R17| p. 132
6.1.6.2.82 Type: NsacfCapability |R17| p. 132
6.1.6.2.83 Type: DccfCond |R17| p. 132
6.1.6.2.84 Type: MlAnalyticsInfo |R17| p. 133
6.1.6.2.85 Type: MbSmfInfo |R17| p. 133
6.1.6.2.86 Type: TmgiRange |R17| p. 134
6.1.6.2.87 Type: MbsSession |R17| p. 134
6.1.6.2.88 Type: SnssaiMbSmfInfoItem |R17| p. 134
6.1.6.2.89 Type: DnnMbSmfInfoItem |R17| p. 134
6.1.6.2.90 Void
6.1.6.2.91 Type: TsctsfInfo |R17| p. 135
6.1.6.2.92 Type: SnssaiTsctsfInfoItem |R17| p. 135
6.1.6.2.93 Type: DnnTsctsfInfoItem |R17| p. 135
6.1.6.2.94 Type: MbUpfInfo |R17| p. 136
6.1.6.2.95 Type: UnTrustAfInfo |R17| p. 137
6.1.6.2.96 Type: TrustAfInfo |R17| p. 137
6.1.6.2.97 Type: SnssaiInfoItem |R17| p. 137
6.1.6.2.98 Type: DnnInfoItem |R17| p. 138
6.1.6.2.99 Type: CollocatedNfInstance |R17| p. 138
6.1.6.2.100 Type: ServiceNameListCond |R17| p. 138
6.1.6.2.101 Type: NfGroupListCond |R17| p. 138
6.1.6.2.102 Type: PlmnOauth2 |R17| p. 139
6.1.6.2.103 Type: V2xCapability |R17| p. 139
6.1.6.2.104 Type: NssaafInfo |R17| p. 139
6.1.6.2.105 Type: ProSeCapability |R17| p. 140
6.1.6.2.106 Type: SharedDataIdRange |R17| p. 140
6.1.6.2.107 Type: SubscriptionContext |R17| p. 141
6.1.6.2.108 Type: IwmscInfo |R17| p. 141
6.1.6.2.109 Type: MnpfInfo |R17| p. 141
6.1.6.2.110 Type: DefSubServiceInfo |R17| p. 141
6.1.6.2.111 Type: LocalityDescriptionItem |R18| p. 142
6.1.6.2.112 Type: LocalityDescription |R18| p. 142
6.1.6.3 Simple data types and enumerations p. 142
6.1.6.3.1 Introduction p. 142
6.1.6.3.2 Simple data types p. 142
6.1.6.3.3 Enumeration: NFType p. 142
6.1.6.3.4 Enumeration: NotificationType p. 144
6.1.6.3.5 Enumeration: TransportProtocol p. 145
6.1.6.3.6 Enumeration: NotificationEventType p. 145
6.1.6.3.7 Enumeration: NFStatus p. 146
6.1.6.3.8 Enumeration: DataSetId p. 146
6.1.6.3.9 Enumeration: UPInterfaceType p. 147
6.1.6.3.10 Relation Types p. 147
6.1.6.3.11 Enumeration: ServiceName p. 148
6.1.6.3.12 Enumeration: NFServiceStatus p. 150
6.1.6.3.13 Enumeration: AnNodeType |R16| p. 150
6.1.6.3.14 Enumeration: ConditionEventType |R16| p. 150
6.1.6.3.15 Enumeration: IpReachability |R16| p. 150
6.1.6.3.16 Enumeration: ScpCapability |R17| p. 151
6.1.6.3.17 Enumeration: CollocatedNfType |R17| p. 151
6.1.6.3.18 Enumeration: LocalityType |R18| p. 151
6.1.7 Error Handling p. 151
6.1.8 Security p. 152
6.1.9 Features supported by the NFManagement service |R16| p. 152
6.2 Nnrf_NFDiscovery Service API p. 153
6.2.1 API URI p. 153
6.2.2 Usage of HTTP p. 153
6.2.2.1 General p. 153
6.2.2.2 HTTP standard headers p. 153
6.2.2.2.1 General p. 153
6.2.2.2.2 Content type p. 153
6.2.2.2.3 Cache-Control p. 153
6.2.2.2.4 ETag p. 154
6.2.2.2.5 If-None-Match p. 154
6.2.2.3 HTTP custom headers p. 154
6.2.2.3.1 General p. 154
6.2.3 Resources p. 154
6.2.3.1 Overview p. 154
6.2.3.2 Resource: nf-instances (Store) p. 155
6.2.3.2.1 Description p. 155
6.2.3.2.2 Resource Definition p. 155
6.2.3.2.3 Resource Standard Methods p. 155
6.2.3.2.4 Resource Custom Operations p. 171
6.2.3.3 Resource: Stored Search (Document) |R16| p. 171
6.2.3.3.1 Description p. 171
6.2.3.3.2 Resource Definition p. 171
6.2.3.4 Resource: Complete Stored Search (Document) |R16| p. 172
6.2.3.4.1 Description p. 172
6.2.3.4.2 Resource Definition p. 172
6.2.3.5 Resource: SCP Domain Routing Information (Document) |R17| p. 173
6.2.3.5.1 Description p. 173
6.2.3.5.2 Resource Definition p. 173
6.2.3.6 Resource: SCP Domain Routing Information Subscriptions (Collection) |R17| p. 174
6.2.3.6.1 Description p. 174
6.2.3.6.2 Resource Definition p. 174
6.2.3.6.3 Resource Standard Methods p. 174
6.2.3.7 Resource: Individual SCP Domain Routing Information Subscription (Document) |R17| p. 175
6.2.3.7.1 Description p. 175
6.2.3.7.2 Resource Definition p. 175
6.2.3.7.3 Resource Standard Methods p. 175
6.2.4 Custom Operations without associated resources p. 176
6.2.5 Notifications p. 176
6.2.5.1 General |R17| p. 176
6.2.5.2 SCP Domain Routing Information Change Notification |R17| p. 176
6.2.5.2.1 Description p. 176
6.2.5.2.2 Notification Definition p. 176
6.2.6 Data Model p. 177
6.2.6.1 General p. 177
6.2.6.2 Structured data types p. 179
6.2.6.2.1 Introduction p. 179
6.2.6.2.2 Type: SearchResult p. 180
6.2.6.2.3 Type: NFProfile p. 182
6.2.6.2.4 Type: NFService p. 188
6.2.6.2.5 Type: StoredSearchResult |R16| p. 191
6.2.6.2.6 Type: PreferredSearch |R16| p. 192
6.2.6.2.7 Type: NfInstanceInfo |R17| p. 193
6.2.6.2.8 Type: ScpDomainRoutingInformation |R17| p. 194
6.2.6.2.9 Type: ScpDomainConnectivity |R17| p. 194
6.2.6.2.10 Type: ScpDomainRoutingInfoSubscription |R17| p. 195
6.2.6.2.11 Type: ScpDomainRoutingInfoNotification |R17| p. 195
6.2.6.2.12 Type: NfServiceInstance |R17| p. 195
6.2.6.2.13 Type: NoProfileMatchInfo |R17| p. 196
6.2.6.2.14 Type: QueryParamCombination |R17| p. 196
6.2.6.2.15 Type: QueryParameter |R17| p. 196
6.2.6.3 Simple data types and enumerations p. 196
6.2.7 Error Handling p. 197
6.2.8 Security p. 197
6.2.9 Features supported by the NFDiscovery service p. 197
6.3 Nnrf_AccessToken Service API p. 201
6.3.1 General p. 201
6.3.2 API URI p. 201
6.3.3 Usage of HTTP p. 201
6.3.3.1 General p. 201
6.3.3.2 HTTP standard headers p. 202
6.3.3.2.1 General p. 202
6.3.3.2.2 Content type p. 202
6.3.3.3 HTTP custom headers p. 202
6.3.3.3.1 General p. 202
6.3.4 Custom Operations without associated resources p. 202
6.3.4.1 Overview p. 202
6.3.4.2 Operation: Get (Access Token Request) p. 202
6.3.4.2.1 Description p. 202
6.3.4.2.2 Operation Definition p. 203
6.3.5 Data Model p. 204
6.3.5.1 General p. 204
6.3.5.2 Structured data types p. 204
6.3.5.2.1 Introduction p. 204
6.3.5.2.2 Type: AccessTokenReq p. 205
6.3.5.2.3 Type: AccessTokenRsp p. 208
6.3.5.2.4 Type: AccessTokenClaims p. 209
6.3.5.2.5 Type: AccessTokenErr |R16| p. 210
6.3.5.3 Simple data types and enumerations p. 211
6.3.5.4 Data types describing alternative data types or combinations of data types p. 211
6.3.5.4.1 Type: Audience p. 211
6.3.6 Error Handling |R17| p. 211
6.4 Nnrf_Bootstrapping Service API |R16| p. 212
6.4.1 API URI p. 212
6.4.2 Usage of HTTP p. 212
6.4.2.1 General p. 212
6.4.2.2 HTTP standard headers p. 212
6.4.2.2.1 General p. 212
6.4.2.2.2 Content type p. 212
6.4.2.2.3 Cache-Control |R17| p. 212
6.4.2.2.4 ETag |R17| p. 212
6.4.2.2.5 If-None-Match |R17| p. 212
6.4.2.3 HTTP custom headers p. 213
6.4.2.3.1 General p. 213
6.4.3 Resources p. 213
6.4.3.1 Overview p. 213
6.4.3.2 Resource: Bootstrapping (Document) p. 213
6.4.3.2.1 Description p. 213
6.4.3.2.2 Resource Definition p. 213
6.4.3.2.3 Resource Standard Methods p. 214
6.4.4 Custom Operations without associated resources p. 214
6.4.5 Notifications p. 214
6.4.6 Data Model p. 214
6.4.6.1 General p. 214
6.4.6.2 Structured data types p. 215
6.4.6.2.1 Introduction p. 215
6.4.6.2.2 Type: BootstrappingInfo p. 215
6.4.6.3 Simple data types and enumerations p. 216
