Dnn

string

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003 [7]; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 [7] clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3"). See NOTE 2.

DnnRm

string

This data type is defined in the same way as the "Dnn" data type, but with the OpenAPI "nullable: true" property.

WildcardDnn

string

String representing the Wildcard DNN.

It shall contain the string "*".

Pattern: ‘^[*]$’

WildcardDnnRm

string

This data type is defined in the same way as the "WildcardDnn" data type, but with the OpenAPI "nullable: true" property.

Gpsi

string

String identifying a Gpsi shall contain either an External Id or an MSISDN. It shall be formatted as follows:

-External Identifier: "extid-<extid>, where <extid> shall be formatted according to clause 19.7.2 of 3GPP TS 23.003 [7] that describes an External Identifier.

-MSISDN: "msisdn-<msisdn>, where <msisdn> shall be formatted according to clause 3.3 of 3GPP TS 23.003 [7] that describes an MSISDN.

Pattern: ‘^(msisdn-[0-9]{5,15}|extid-.+@.+|.+)$’

GpsiRm

string

This data type is defined in the same way as the "Gpsi" data type, but with the OpenAPI "nullable: true" property.

GroupId

string

String identifying a group of devices network internal globally unique ID which identifies a set of IMSIs, as specified in clause 19.9 of 3GPP TS 23.003 [7].

Pattern: ‘^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$’.

GroupIdRm

string

This data type is defined in the same way as the "GroupId" data type, but with the OpenAPI "nullable: true" property.

ExternalGroupId

string

String identifying External Group Identifier that identifies a group made up of one or more subscriptions associated to a group of IMSIs, as specified in clause 19.7.3 of 3GPP TS 23.003 [7].

Pattern: "^extgroupid-[^@]+@[^@]+$"

ExternalGroupIdRm

string

This data type is defined in the same way as the "ExternalGroupId" data type, but with the OpenAPI "nullable: true" property.

Pei

string

String representing a Permanent Equipment Identifier that may contain:

– an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003 [7];

– a MAC address for a 5G-RG or FN-RG via wireline access, with an indication that this address cannot be trusted for regulatory purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as specified in clause 4.7.7 of 3GPP TS 23.316 [30].

– an IEEE Extended Unique Identifier (EUI-64), for UEs not supporting any 3GPP access technologies, as defined in IEEE "Guidelines for Use of Extended Unique Identifier (EUI), Organizationally Unique Identifier (OUI), and Company ID (CID)" [38].

Pattern: ‘^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$’. See NOTE 1.

Examples:

imei-012345678901234

imeisv-0123456789012345

mac-00-00-5E-00-53-00

mac-00-00-5E-00-53-00-untrusted

eui-AC-DE-48-23-45-67-01-9F

PeiRm

string

This data type is defined in the same way as the "Pei" data type, but with the OpenAPI "nullable: true" property.

Supi

string

String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003 [7].

It shall be formatted as follows:

– for an IMSI "imsi-<imsi>", where <imsi> shall be formatted according to clause 2.2 of 3GPP TS 23.003 [7] that describes an IMSI.

– for a network specific identifier "nai-<nai>, where <nai> shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 [7] that describes an NAI.

– for a GCI: "gci-<gci>", where <gci> shall be formatted according to clause 28.15.2 of 3GPP TS 23.003 [7].

– for a GLI: "gli-<gli>", where <gli> shall be formatted according to clause 28.16.2 of 3GPP TS 23.003 [7].

To enable that the value is used as part of an URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501 [2].

Pattern: ‘^(imsi-[0-9]{5,15}|nai-.+| gci-.+|gli-.+|.+)$’

(NOTE 1).

SupiRm

string

This data type is defined in the same way as the "Supi" data type, but with the OpenAPI "nullable: true" property.

NfInstanceId

string

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122 [15].

(NOTE 3)

AmfId

string

String identifying the AMF ID composed of AMF Region ID (8 bits), AMF Set ID (10 bits) and AMF Pointer (6 bits) as specified in clause 2.10.1 of 3GPP TS 23.003 [7].

It is encoded as a string of 6 hexadecimal characters (i.e., 24 bits).

Pattern: ‘^[A-Fa-f0-9]{6}$’

AmfRegionId

string

String identifying the AMF Region ID (8 bits), as specified in clause 2.10.1 of 3GPP TS 23.003 [7].

It is encoded as a string of 2 hexadecimal characters (i.e. 8 bits).

Pattern: ‘^[A-Fa-f0-9]{2}$’

AmfSetId

string

String identifying the AMF Set ID (10 bits) as specified in clause 2.10.1 of 3GPP TS 23.003 [7].

It is encoded as a string of 3 hexadecimal characters where the first character is limited to values 0 to 3 (i.e. 10 bits).

Pattern: ‘^[0-3][A-Fa-f0-9]{2}$’

RfspIndex

integer

Unsigned integer representing the "Subscriber Profile ID for RAT/Frequency Priority" as specified in 3GPP TS 36.413 [16].

Minimum = 1. Maximum = 256.

RfspIndexRm

integer

This data type is defined in the same way as the "RfspIndex" data type, but with the OpenAPI "nullable: true" property.

NfGroupId

string

Identifier of a group of NFs

MtcProviderInformation

string

String uniquely identifying MTC provider information.

CagId

string

String containing a Closed Access Group Identifier.

Pattern: "^[A-Fa-f0-9]{8}$"

SupiOrSuci

string

String identifying a SUPI or a SUCI.

Pattern: "^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|suci-(0-[0-9]{3}-[0-9]{2,3}|[1-7]-.+)-[0-9]{1,4}-(0-0-.*|[a-fA-F1-9]-([1-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])-[a-fA-F0-9]+)|.+)$"

NOTE 1: The encoding of 3GPP defined identifiers (e.g. IMSI, NAI, IMEI, GCI, GLI) shall be prefixed with its corresponding prefix (e.g. ‘imsi-‘,’nai-‘, ‘imei-‘, ‘gci-‘, ‘gli-‘).

NOTE 2: Whether the Dnn data type contains just the DNN Network Identifier, or the Network Identifier plus the Operator Identifier, shall be documented in each API where this data type is used.

NOTE 3: NFs shall be able to receive a NF Instance Id in any UUID format.

plmnId

PlmnIdNid

M

1

PLMN Identity and Network Identity

amfId

AmfId

M

1

AMF Identity

mcc

Mcc

C

0..1

Mobile Country Code

mnc

Mnc

C

0..1

Mobile Network Code

NOTE: At least one MNC or MCC shall be included.