A.3 Nudr_GroupIDmap API

29.5043GPP5G SystemRelease 18Stage 3TSUnified Data Repository Services

openapi: 3.0.0

info:

version: 1.2.0-alpha.1

title: ‘Nudr_GroupIDmap’

description: |

Unified Data Repository Service for NF-Group ID retrieval.

© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

All rights reserved.

externalDocs:

description: 3GPP TS 29.504 V18.0.0; 5G System; Unified Data Repository Services; Stage 3

url: ‘https://www.3gpp.org/ftp/Specs/archive/29_series/29.504/’

servers:

– description: API root

url: ‘{apiRoot}/nudr-group-id-map/v1’

variables:

apiRoot:

default: https://example.com

security:

– {}

– oAuth2ClientCredentials:

– nudr-group-id-map

paths:

/nf-group-ids:

get:

summary: Retrieves NF-Group IDs for provided Subscriber and NF types

operationId: GetNfGroupIDs

tags:

– NF Group IDs (Document)

parameters:

– name: nf-type

in: query

description: Type of NF

required: true

style: form

explode: false

schema:

type: array

items:

$ref: ‘TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType’

minItems: 1

– name: subscriberId

# The name of this query parameter is left not following the naming convention as defined in 3GPP TS 29.501 due to backward compatibility consideration.

in: query

description: Identifier of the subscriber

required: true

schema:

$ref: ‘#/components/schemas/SubscriberId’

responses:

‘200’:

description: Expected response to a valid request

content:

application/json:

schema:

$ref: ‘#/components/schemas/NfGroupIdMapResult’

‘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:

description: Unexpected error

components:

securitySchemes:

oAuth2ClientCredentials:

type: oauth2

flows:

clientCredentials:

tokenUrl: ‘{nrfApiRoot}/oauth2/token’

scopes:

nudr-group-id-map: Access to the Nudr_GroupIDmap API

schemas:

# COMPLEX TYPES:

NfGroupIdMapResult:

description: Contains the NFGroupIds for the requested NF types. The NFType is the key of the map.

type: object

additionalProperties:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/NfGroupId’

minProperties: 1

# SIMPLE TYPES:

SubscriberId:

description: Represents the Subscription Identifier SUPI or GPSI or IMPI or IMPU.

type: string

pattern: ‘^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|impi-.+|impu-.+|.+)$’

# ENUMS:

Annex B (informative):
Change history

Change history

Date

Meeting

TDoc

CR

Rev

Cat

Subject/Comment

New version

2018-01

CT4#82

C4-181365

TS skeleton

0.0.0

2018-01

CT4#82

C4-181396

Inclusion of pCRs agreed at CT4#82, including C4-181366, C4-181367, C4-181323 and C4-181385.

0.1.0

2018-03

CT4#83

C4-182441

Inclusion of pCRs agreed at CT4#83, including C4-182337, C4-182429.

0.2.0

2018-04

CT4#84

C4-183522

Inclusion of pCRs agreed at CT4#84, including C4-183497, C4-183295, C4-183296, C4-183297, C4-183102, C4-183420, C4-183498.

0.3.0

2018-05

CT4#85

C4-184636

Inclusion of pCRs agreed at CT4#85, including C4-184482, C4-184484, C4-184167, C4-184168, C4-184489, C4-184564, C4-184637.

0.4.0

2018-06

CT#80

CP-181102

Presented for information and approval

1.0.0

2018-06

CT#80

Approved in CT#80.

15.0.0

2018-09

CT#81

CP-182057

0002

1

F

Service Name

15.1.0

2018-09

CT#81

CP-182057

0006

2

F

Supported Features Negotiation

15.1.0

2018-09

CT#81

CP-182057

0004

2

F

Error handling in UDR

15.1.0

2018-09

CT#81

CP-182211

0003

4

OpenAPI file for Nudr_DataRepository API

15.1.0

2018-10

CT#82

CP-183015

0008

F

Update the Reference point name

15.2.0

2018-10

CT#82

CP-183015

0009

F

Introduction of Barring of Roaming in 5GC

15.2.0

2018-10

CT#82

CP-183015

0010

1

F

Shared Data

15.2.0

2018-10

CT#82

CP-183015

0011

Get multiple datasets for ProvsionedData

15.2.0

2018-10

CT#82

CP-183015

0012

1

F

Definition of Authentication Data

15.2.0

2018-12

CT#82

CP-183015

0013

1

F

Adding headers for cache control and conditional request to the Nudr Services API

15.2.0

2018-12

CT#82

CP-183015

0014

APIRoot Clarification

15.2.0

2018-12

CT#82

CP-183015

0015

2

F

lifetime of subscription

15.2.0

2018-12

CT#82

CP-183015

0016

1

F

Authorized Event Types

15.2.0

2018-12

CT#82

CP-183015

0017

Group Subscription Path

15.2.0

2018-12

CT#82

CP-183177

0018

2

F

PLMN ID as key for UE data sets

15.2.0

2018-12

CT#82

CP-183241

0020

1

F

Correction to Nudr_DataRepository service OpenAPI

15.2.0

2019-03

CT#83

CP-190020

0021

1

CR 0018r2 was not implemented

15.3.0

2019-03

CT#83

CP-190020

0022

2

Corrections on openAPI

15.3.0

2019-03

CT#83

CP-190020

0023

UDR Application Errors

15.3.0

2019-03

CT#83

CP-190020

0025

1

Missing URLs in UDR API

15.3.0

2019-03

CT#83

CP-190172

0026

1

3GPP TS 29.504 API version update

15.3.0

2019-06

CT#84

CP-191031

0027

F

Content Type

15.4.0

2019-06

CT#84

CP-191031

0028

F

UE Parameter Update (UPU)

15.4.0

2019-06

CT#84

CP-191031

0030

1

F

Group Identifier Translation

15.4.0

2019-06

CT#84

CP-191031

0032

2

F

Storage of OpenAPI specification files

15.4.0

2019-06

CT#84

CP-191031

0034

1

F

Missing Context Path

15.4.0

2019-06

CT#84

CP-191031

0035

F

Copyright Note in YAML file

15.4.0

2019-06

CT#84

CP-191031

0038

F

3GPP TS 29.504 API version update

15.4.0

2019-06

CT#84

CP-191031

0036

1

F

Resource notification featurres for Policy and Exposure Data

15.4.0

2019-06

CT#84

CP-191048

0037

F

3GPP TS 29.504 API version update

16.0.0

2019-06

CT#84

CP-191051

0029

1

B

PFD extension for domain name

16.0.0

2019-09

CT#85

CP-192133

0040

 –

B

Closed Access Group

16.1.0

2019-09

CT#85

CP-192133

0041

 –

B

VN-Group parameter provisioning

16.1.0

2019-09

CT#85

CP-192123

0042

 –

B

Conditional POST / PUT / PATCH / DELETE requests

16.1.0

2019-09

CT#85

CP-192190

0048

1

B

New supported features for xBDT

16.1.0

2019-09

CT#85

CP-192123

0049

1

B

Support a set of MAC addresses in traffic filter

16.1.0

2019-09

CT#85

CP-192123

0050

1

B

Multiple temporal validity conditions for AF traffic influence

16.1.0

2019-09

CT#85

CP-192123

0039

1

B

Network Slicing Subscription Change

16.1.0

2019-09

CT#85

CP-192123

0044

1

F

UDR Application Errors

16.1.0

2019-09

CT#85

CP-192104

0054

1

A

Correction on Feature numbers

16.1.0

2019-09

CT#85

CP-192120

0056

 –

F

3GPP TS 29.504 API version update

16.1.0

2019-10

TS outlook fixed

16.1.1

2019-12

CT#86

CP-193028

0066

 

A

Wrong YAML Structure of OpenAPI ‘info’ Clause

16.2.0

2019-12

CT#86

CP-193028

0068

 

A

CR 0026r1 was not correctly implemented

16.2.0

2019-12

CT#86

CP-193039

0070

1

B

Update Application Data Resources

16.2.0

2019-12

CT#86

CP-193044

0073

 

F

3GPP TS 29.504 API version update

16.2.0

2019-12

CT#86

CP-193049

0069

1

B

NIDD Authorization Data

16.2.0

2019-12

CT#86

CP-193055

0060

1

B

LCS Private

16.2.0

2019-12

CT#86

CP-193055

0061

1

B

Mobile Originated Data

16.2.0

2019-12

CT#86

CP-193060

0058

1

B

Missed URLLC feature from Application Data

16.2.0

2019-12

CT#86

CP-193063

0059

 

B

Patch Report Feature

16.2.0

2019-12

CT#86

CP-193063

0057

2

F

Clarification on Implicit Subscriptions to Notifications

16.2.0

2019-12

CT#86

CP-193130

0064

2

B

Nudr_GroupIDmap Service

16.2.0

2019-12

CT#86

CP-193064

0063

1

B

Definition of SessionManagementPolicyDataPatch feature

16.2.0

2020-03

CT#87

CP-200020

0079

 

B

Mute Notifications

16.3.0

2020-03

CT#87

CP-200039

0074

2

F

Add Corresponding API descriptions in clause 5.1

16.3.0

2020-03

CT#87

CP-200020

0080

1

B

Definition of ConditionalSubscription and NotificationResourceFragment features

16.3.0

2020-03

CT#87

CP-200052

0082

 

F

3GPP TS 29.504 Rel16 API version and External doc update

16.3.0

2020-03

CT#87

CP-200098

0083

 

B

Definition of EnhancedInfluDataNotification feature

16.3.0

2020-06

CT#88-e

CP-201046

0084

B

Coverage restriction data resource

16.4.0

2020-06

CT#88-e

CP-201032

0086

B

Location information retrieval for GMLC

16.4.0

2020-06

CT#88-e

CP-201032

0087

B

Resource LcsPrivacySubscriptionData

16.4.0

2020-06

CT#88-e

CP-201071

0088

F

Storage of YAML files in ETSI Forge

16.4.0

2020-06

CT#88-e

CP-201020

0090

A

Definition of OpSpecDataMapNotification feature

16.4.0

2020-06

CT#88-e

CP-201049

0091

B

Correction on V2X Subscription data

16.4.0

2020-06

CT#88-e

CP-201034

0093

F

Cardinality of ProblemDetails

16.4.0

2020-06

CT#88-e

CP-201034

0094

B

Resource Level Authorization

16.4.0

2020-06

CT#88-e

CP-201033

0095

B

Support of SMSoIP

16.4.0

2020-06

CT#88-e

CP-201032

0096

F

Mobile Originated Data retrieval

16.4.0

2020-06

CT#88-e

CP-201034

0097

F

New feature of per UE per serving network authEvent

16.4.0

2020-06

CT#88-e

CP-201073

0098

F

29.504 Rel16 API version and External doc update

16.4.0

2020-09

CT#89-e

CP-202110

100

F

Scopes for Resource Level Authorization

16.5.0

2020-09

CT#89-e

CP-202112

104

F

Store Broadcast Location Assistance Data

16.5.0

2020-09

CT#89-e

CP-202110

105

1

F

Corrections with regard to references

16.5.0

2020-09

CT#89-e

CP-202096

107

F

API version and External doc update

16.5.0

2020-09

CT#89-e

CP-202123

101

B

Resource Level Authorization for Data Sets

17.0.0

2020-09

CT#89-e

CP-202123

102

B

Resource Level Authorization for registrations

17.0.0

2020-09

CT#89-e

CP-202120

106

B

API version and External doc update

17.0.0

2020-12

CT#90-e

CP-203049

0111

1

A

HSS can consume UDR services

17.1.0

2020-12

CT#90-e

CP-203042

0113

A

5G VN Groups

17.1.0

2020-12

CT#90-e

CP-203035

0115

A

Storage of YAML files in 3GPP Forge

17.1.0

2020-12

CT#90-e

CP-203061

0117

B

Data retrieval of multiple policy data sets

17.1.0

2020-12

CT#90-e

CP-203055

0119

F

Rel17 API version and External doc update

17.1.0

2021-03

CT#91-e

CP-210021

0120

F

SCP may consume Nudr service

17.2.0

2021-03

CT#91-e

CP-210043

0122

1

A

Incorrect NfGroupIds definition and missing UDR access paths

17.2.0

2021-03

CT#91-e

CP-210021

0123

1

B

Add Feature for Session Management Policy Data per PLMN

17.2.0

2021-03

CT#91-e

CP-210034

0124

1

F

OpenAPI Reference and description field for map data types

17.2.0

2021-03

CT#91-e

CP-210048

0126

A

SMF Events Storage Resource Path

17.2.0

2021-03

CT#91-e

CP-210029

0127

F

29.504 Rel-17 API version and External doc update

17.2.0

2021-06

CT#92-e

CP-211028

0130

1

F

Change Notification of Array to Stateless UDM

17.3.0

2021-06

CT#92-e

CP-211028

0142

 

F

Data Types Descriptions

17.3.0

2021-06

CT#92-e

CP-211031

0131

1

B

Support of User Plane Latency requirements

17.3.0

2021-06

CT#92-e

CP-211039

0132

 

B

Store ProSe Subscription Data

17.3.0

2021-06

CT#92-e

CP-211039

0144

 

B

Add new ProSe feature

17.3.0

2021-06

CT#92-e

CP-211045

0141

 

B

Correction to OSD Handling

17.3.0

2021-06

CT#92-e

CP-211045

0143

 

B

New feature ConditionalSubscriptionWithExcludeNotification

17.3.0

2021-06

CT#92-e

CP-211050

0145

 

F

29.504 Rel-17 API version and External doc update

17.3.0

2021-06

CT#92-e

CP-211059

0140

1

F

Correction to Charging Information

17.3.0

2021-06

CT#92-e

CP-211079

0134

 

A

Subscribed EE profile data for a group

17.3.0

2021-06

CT#92-e

CP-211079

0136

 

A

Subscribed PP profile data for 5g-VN-group

17.3.0

2021-06

CT#92-e

CP-211079

0138

 

A

Subscribed PP profile data

17.3.0

2021-09

CT#93-e

CP-212030

0148

1

B

New feature for NSAC

17.4.0

2021-09

CT#93-e

CP-212049

0150

1

B

Get the PP data of mutiple Afs

17.4.0

2021-09

CT#93-e

CP-212059

0151

 

F

29.504 Rel-17 API version and External doc update

17.4.0

2021-09

CT#93-e

CP-212064

0154

 

A

SharedDataId Resource

17.4.0

2021-12

CT#94-e

CP-213085

0156

 

B

UE Subscription Data Sets Retrieve

17.5.0

2021-12

CT#94-e

CP-213085

0157

 

F

Corrections to the API URI

17.5.0

2021-12

CT#94-e

CP-213085

0159

 

B

Share Session Management Subscription Data

17.5.0

2021-12

CT#94-e

CP-213086

0163

 

F

NIDD Authorization data storage

17.5.0

2021-12

CT#94-e

CP-213086

0167

 

F

Subscription update

17.5.0

2021-12

CT#94-e

CP-213087

0168

 

B

Update Roaming Status in EPC

17.5.0

2021-12

CT#94-e

CP-213087

0162

1

F

Consumer service logic

17.5.0

2021-12

CT#94-e

CP-213088

0166

1

A

Naming Convention

17.5.0

2021-12

CT#94-e

CP-213093

0155

1

B

Support for Service Specific Authorization

17.5.0

2021-12

CT#94-e

CP-213093

0164

B

Supported Features needed for the Enhanced Edge Computing functionality

17.5.0

2021-12

CT#94-e

CP-213097

0158

B

Store 5MBS Subscription Data

17.5.0

2021-12

CT#94-e

CP-213121

0169

F

29.504 Rel-17 API version and External doc update

17.5.0

2021-12

CT#94-e

CP-213136

0161

A

Path definitions

17.5.0

2022-03

CT#95-e

CP-220023

0176

F

Resource paths in Group Subscription Storage

17.6.0

2022-03

CT#95-e

CP-220031

0179

1

B

Handling of supported features for Edge Computing

17.6.0

2022-03

CT#95-e

CP-220036

0174

1

B

UDR restoration notification

17.6.0

2022-03

CT#95-e

CP-220041

0173

B

SOR-AF as NF consumer of UDR

17.6.0

2022-03

CT#95-e

CP-220042

0178

1

B

UDR features for TSC and DCAMP

17.6.0

2022-03

CT#95-e

CP-220047

0172

1

B

New value for 404 status code

17.6.0

2022-03

CT#95-e

CP-220049

0175

1

B

User Consent subscription

17.6.0

2022-03

CT#95-e

CP-220066

0181

F

29.504 Rel-17 API version and External doc update

17.6.0

2022-03

CT#95-e

CP-220090

0180

F

Update incorrect NOTE format

17.6.0

2022-06

CT#96-e

CP-221025

0191

1

F

UDR Restoration

17.7.0

2022-06

CT#96-e

CP-221028

0185

1

F

Logical Relationship of Query Parameters

17.7.0

2022-06

CT#96-e

CP-221028

0186

1

F

OAuth2 scopes for policy data

17.7.0

2022-06

CT#96-e

CP-221028

0189

F

OAuth2 scopes for exposure data

17.7.0

2022-06

CT#96-e

CP-221029

0188

1

F

OAuth2 scopes for application data

17.7.0

2022-06

CT#96-e

CP-221029

0190

1

F

UDM to support Optimized EventExposure Subscriptions Data access over Nudr

17.7.0

2022-06

CT#96-e

CP-221034

0184

1

F

Missing supported features in Nudr service

17.7.0

2022-06

CT#96-e

CP-221051

0193

F

29.504 Rel-17 API version and External doc update

17.7.0

2022-06

CT#96-e

CP-221052

0192

F

Update of description of feature ConditionalSubscriptionWithExcludeNotification

17.7.0

2022-06

CT#96-e

CP-221057

0183

F

FilterAnyUE feature

17.7.0

2022-09

CT#97-e

CP-222057

0194

F

PEI Information

17.8.0

2022-09

CT#97-e

CP-222058

0195

F

29.504 Rel-17 API version and External doc update

17.8.0

2022-12

CT#98-e

CP-223027

0198

B

Immediate reporting for policy data

18.0.0

2022-12

CT#98-e

CP-223027

0197

1

F

Missing Mandatory Status Codes in OpenAPI

18.0.0

2022-12

CT#98-e

CP-223029

0196

1

B

Immediate Report in subscribe response

18.0.0

2022-12

CT#98-e

CP-223033

0199

F

29.504 Rel-18 API version and External doc update

18.0.0