API docs by Redocly

Unified Data Repository Service API file for subscription data (-)

Download OpenAPI specification:

Unified Data Repository Service (subscription data).
The API version is defined in 3GPP TS 29.504.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

3GPP TS 29.505 V18.7.0; 5G System; Usage of the Unified Data Repository Service for subscription data; Stage 3

Authentication Data (Document)

Retrieves the authentication subscription data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "authenticationMethod": "5G_AKA",
  • "encPermanentKey": "string",
  • "protectionParameterId": "string",
  • "sequenceNumber": {
    },
  • "authenticationManagementField": "string",
  • "algorithmId": "string",
  • "encOpcKey": "string",
  • "encTopcKey": "string",
  • "vectorGenerationInHss": false,
  • "hssGroupId": "string",
  • "n5gcAuthMethod": "5G_AKA",
  • "rgAuthenticationInd": false,
  • "supi": "string",
  • "akmaAllowed": false,
  • "routingId": "string",
  • "nswoAllowed": false,
  • "5gKeyHierarSupp": true
}

Authentication Subscription (Document)

modify the authentication subscription data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Authentication Status (Document)

To store the Authentication Status data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

Request Body schema: application/json
required
nfInstanceId
required
string <uuid> (NfInstanceId)

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.

success
required
boolean (Success)
timeStamp
required
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

required
string or string (AuthType)

Indicates the authentication method.

servingNetworkName
required
string (ServingNetworkName) ^(5G:mnc[0-9]{3}[.]mcc[0-9]{3}[.]3gppnetwork[...
authRemovalInd
boolean
Default: false
nfSetId
string (NfSetId)

NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit shall be inserted at the left side to fill the 3 digits coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.

resetIds
Array of strings non-empty
dataRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

udrRestartInd
boolean
Default: false
nswoInd
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "success": true,
  • "timeStamp": "2019-08-24T14:15:22Z",
  • "authType": "5G_AKA",
  • "servingNetworkName": "string",
  • "authRemovalInd": false,
  • "nfSetId": "string",
  • "resetIds": [
    ],
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false,
  • "nswoInd": false
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

AuthEvent (Document)

Retrieves the Authentication Status of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "success": true,
  • "timeStamp": "2019-08-24T14:15:22Z",
  • "authType": "5G_AKA",
  • "servingNetworkName": "string",
  • "authRemovalInd": false,
  • "nfSetId": "string",
  • "resetIds": [
    ],
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false,
  • "nswoInd": false
}

To remove the Authentication Status of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Individual Authentication Status (Document)

To store the individual Authentication Status data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

servingNetworkName
required
string (ServingNetworkName) ^(5G:mnc[0-9]{3}[.]mcc[0-9]{3}[.]3gppnetwork[...

Serving Network Name

Request Body schema: application/json
required
nfInstanceId
required
string <uuid> (NfInstanceId)

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.

success
required
boolean (Success)
timeStamp
required
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

required
string or string (AuthType)

Indicates the authentication method.

servingNetworkName
required
string (ServingNetworkName) ^(5G:mnc[0-9]{3}[.]mcc[0-9]{3}[.]3gppnetwork[...
authRemovalInd
boolean
Default: false
nfSetId
string (NfSetId)

NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit shall be inserted at the left side to fill the 3 digits coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.

resetIds
Array of strings non-empty
dataRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

udrRestartInd
boolean
Default: false
nswoInd
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "success": true,
  • "timeStamp": "2019-08-24T14:15:22Z",
  • "authType": "5G_AKA",
  • "servingNetworkName": "string",
  • "authRemovalInd": false,
  • "nfSetId": "string",
  • "resetIds": [
    ],
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false,
  • "nswoInd": false
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Individual AuthEvent (Document)

Retrieves the Individual Authentication Status of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

servingNetworkName
required
string (ServingNetworkName) ^(5G:mnc[0-9]{3}[.]mcc[0-9]{3}[.]3gppnetwork[...

Serving Network Name

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "success": true,
  • "timeStamp": "2019-08-24T14:15:22Z",
  • "authType": "5G_AKA",
  • "servingNetworkName": "string",
  • "authRemovalInd": false,
  • "nfSetId": "string",
  • "resetIds": [
    ],
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false,
  • "nswoInd": false
}

To remove the Individual Authentication Status of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

servingNetworkName
required
string (ServingNetworkName) ^(5G:mnc[0-9]{3}[.]mcc[0-9]{3}[.]3gppnetwork[...

Serving Network Name

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

UE Update Confirmation (Document)

Retrieves the complete UE Update Confirmation data

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "sorData": {
    },
  • "upuData": {
    },
  • "nssaiAckData": {
    },
  • "cagAckData": {
    }
}

Authentication SoR (Document)

To store the SoR acknowledgement information of a UE, ME support of SOR CMCI, and ME support of SOR-SNPN-SI and ME support of SOR-SNPN-SI-LS.

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Request Body schema: application/json
required
provisioningTime
required
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

ueUpdateStatus
required
string (UeUpdateStatus)
Enum: "NOT_SENT" "SENT_NO_ACK_REQUIRED" "WAITING_FOR_ACK" "ACK_RECEIVED" "NEGATIVE_ACK_RECEIVED"

Status of the procedure.

sorXmacIue
string (SorMac) ^[A-Fa-f0-9]{32}$

MAC value for protecting SOR procedure (SoR-MAC-IAUSF and SoR-XMAC-IUE).

sorMacIue
string (SorMac) ^[A-Fa-f0-9]{32}$

MAC value for protecting SOR procedure (SoR-MAC-IAUSF and SoR-XMAC-IUE).

meSupportOfSorCmci
boolean
meSupportOfSorSnpnSi
boolean
Default: false
meSupportOfSorSnpnSiLs
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "provisioningTime": "2019-08-24T14:15:22Z",
  • "ueUpdateStatus": "NOT_SENT",
  • "sorXmacIue": "string",
  • "sorMacIue": "string",
  • "meSupportOfSorCmci": true,
  • "meSupportOfSorSnpnSi": false,
  • "meSupportOfSorSnpnSiLs": false
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Retrieves the SoR acknowledgement information of a UE, ME support of SOR CMCI ME support of SOR-SNPN-SI and ME support of SOR-SNPN-SI-LS

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "provisioningTime": "2019-08-24T14:15:22Z",
  • "ueUpdateStatus": "NOT_SENT",
  • "sorXmacIue": "string",
  • "sorMacIue": "string",
  • "meSupportOfSorCmci": true,
  • "meSupportOfSorSnpnSi": false,
  • "meSupportOfSorSnpnSiLs": false
}

Updates the ME support of SOR CMCI ME support of SOR-SNPN-SI and ME support of SOR-SNPN-SI-LS information of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Authentication UPU (Document)

To store the UPU acknowledgement information of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Request Body schema: application/json
required
provisioningTime
required
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

ueUpdateStatus
required
string (UeUpdateStatus)
Enum: "NOT_SENT" "SENT_NO_ACK_REQUIRED" "WAITING_FOR_ACK" "ACK_RECEIVED" "NEGATIVE_ACK_RECEIVED"

Status of the procedure.

upuXmacIue
string (UpuMac) ^[A-Fa-f0-9]{32}$

MAC value for protecting UPU procedure (UPU-MAC-IAUSF and UPU-MAC-IUE).

upuMacIue
string (UpuMac) ^[A-Fa-f0-9]{32}$

MAC value for protecting UPU procedure (UPU-MAC-IAUSF and UPU-MAC-IUE).

Responses

Request samples

Content type
application/json
{
  • "provisioningTime": "2019-08-24T14:15:22Z",
  • "ueUpdateStatus": "NOT_SENT",
  • "upuXmacIue": "string",
  • "upuMacIue": "string"
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Retrieves the UPU acknowledgement information of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "provisioningTime": "2019-08-24T14:15:22Z",
  • "ueUpdateStatus": "NOT_SENT",
  • "upuXmacIue": "string",
  • "upuMacIue": "string"
}

NSSAI update ack (Document)

To store the NSSAI update acknowledgement information of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Request Body schema: application/json
required
provisioningTime
required
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

ueUpdateStatus
required
string (UeUpdateStatus)
Enum: "NOT_SENT" "SENT_NO_ACK_REQUIRED" "WAITING_FOR_ACK" "ACK_RECEIVED" "NEGATIVE_ACK_RECEIVED"

Status of the procedure.

Responses

Request samples

Content type
application/json
{
  • "provisioningTime": "2019-08-24T14:15:22Z",
  • "ueUpdateStatus": "NOT_SENT"
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

NSSAI ACK (Document)

Retrieves the UPU acknowledgement information of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "provisioningTime": "2019-08-24T14:15:22Z",
  • "ueUpdateStatus": "NOT_SENT"
}

CAG update ack (Document)

To store the CAG update acknowledgement information of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Request Body schema: application/json
required
provisioningTime
required
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

ueUpdateStatus
required
string (UeUpdateStatus)
Enum: "NOT_SENT" "SENT_NO_ACK_REQUIRED" "WAITING_FOR_ACK" "ACK_RECEIVED" "NEGATIVE_ACK_RECEIVED"

Status of the procedure.

Responses

Request samples

Content type
application/json
{
  • "provisioningTime": "2019-08-24T14:15:22Z",
  • "ueUpdateStatus": "NOT_SENT"
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

CAG ACK (Document)

Retrieves the CAG acknowledgement information of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "provisioningTime": "2019-08-24T14:15:22Z",
  • "ueUpdateStatus": "NOT_SENT"
}

Provisioned Data (Document)

Retrieve multiple provisioned data sets of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

servingPlmnId
required
string (VarPlmnId) ^[0-9]{5,6}(-[A-Fa-f0-9]{11})?$

PLMN ID

query Parameters
Array of strings or strings (ProvisionedDatasetNames) non-empty unique

List of dataset names

Array of objects (PlmnId) non-empty

List of PLMNs adjacent to the UE's serving PLMN

object (Snssai)

single NSSAI

dnn
string (Dnn)

DNN

ext-group-ids
Array of strings (ExtGroupId) non-empty [ items^extgroupid-[^@]+@[^@]+$ ]

List of external VN group identifiers

string or string (UcPurpose)

User consent purpose

Responses

Response samples

Content type
application/json
{
  • "amData": {
    },
  • "smfSelData": {
    },
  • "smsSubsData": {
    },
  • "smData": [
    ],
  • "traceData": {
    },
  • "smsMngData": {
    },
  • "lcsPrivacyData": {
    },
  • "lcsMoData": {
    },
  • "lcsSubscriptionData": {
    },
  • "lcsBcaData": {
    },
  • "v2xData": {
    },
  • "proseData": {
    },
  • "odbData": {
    },
  • "eeProfileData": {
    },
  • "ppProfileData": {
    },
  • "niddAuthData": {
    },
  • "ucData": {
    },
  • "mbsSubscriptionData": {
    },
  • "ppData": {
    },
  • "a2xData": {
    },
  • "rangingSlPrivacyData": {
    }
}

Access And Mobility Subscription Data (Document)

Retrieves the access and mobility subscription data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

servingPlmnId
required
string (VarPlmnId) ^[0-9]{5,6}(-[A-Fa-f0-9]{11})?$

PLMN ID

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Array of objects (PlmnId) non-empty

List of PLMNs adjacent to the UE's serving PLMN

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.29110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.39110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "supportedFeatures": "string",
  • "gpsis": [
    ],
  • "hssGroupId": "string",
  • "internalGroupIds": [
    ],
  • "sharedVnGroupDataIds": {
    },
  • "subscribedUeAmbr": {
    },
  • "nssai": {
    },
  • "ratRestrictions": [
    ],
  • "forbiddenAreas": [
    ],
  • "serviceAreaRestriction": {
    },
  • "coreNetworkTypeRestrictions": [
    ],
  • "accessTypeRestrictions": [
    ],
  • "rfspIndex": 1,
  • "subsRegTimer": 0,
  • "ueUsageType": 0,
  • "mpsPriority": true,
  • "mcsPriority": true,
  • "activeTime": 0,
  • "sorInfo": {
    },
  • "sorInfoExpectInd": true,
  • "sorafRetrieval": false,
  • "sorUpdateIndicatorList": [
    ],
  • "upuInfo": {
    },
  • "routingIndicator": "string",
  • "micoAllowed": true,
  • "sharedAmDataIds": [
    ],
  • "odbPacketServices": "ALL_PACKET_SERVICES",
  • "subscribedDnnList": [
    ],
  • "serviceGapTime": 0,
  • "mdtUserConsent": "CONSENT_NOT_GIVEN",
  • "adjacentPlmnMdtUserConsents": {
    },
  • "mdtConfiguration": {
    },
  • "traceData": {
    },
  • "sharedTraceDataId": "string",
  • "cagData": {
    },
  • "stnSr": "string",
  • "cMsisdn": "string",
  • "nbIoTUePriority": 255,
  • "nssaiInclusionAllowed": false,
  • "rgWirelineCharacteristics": "string",
  • "aun3DeviceConnectivityAllowed": false,
  • "ecRestrictionDataWb": {
    },
  • "ecRestrictionDataNb": false,
  • "expectedUeBehaviourList": {
    },
  • "expectedUeBehaviourData": {
    },
  • "primaryRatRestrictions": [
    ],
  • "secondaryRatRestrictions": [
    ],
  • "edrxParametersList": [
    ],
  • "ptwParametersList": [
    ],
  • "iabOperationAllowed": false,
  • "adjacentPlmnRestrictions": {
    },
  • "wirelineForbiddenAreas": [
    ],
  • "wirelineServiceAreaRestriction": {
    },
  • "pcfSelectionAssistanceInfos": [
    ],
  • "aerialUeSubInfo": {
    },
  • "roamingRestrictions": {
    },
  • "remoteProvInd": false,
  • "3gppChargingCharacteristics": "string",
  • "timeSyncData": {
    },
  • "sharedDataList": [
    ],
  • "qmcConfigInfo": {
    },
  • "mbsrOperationAllowed": {
    },
  • "ncrOperationAllowed": false,
  • "ladnServiceAreas": {
    },
  • "ueLevelMeasurementsConfiguration": {
    }
}

SMF Selection Subscription Data (Document)

Retrieves the SMF selection subscription data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

servingPlmnId
required
string (VarPlmnId) ^[0-9]{5,6}(-[A-Fa-f0-9]{11})?$

PLMN ID

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.29110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.39110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "supportedFeatures": "string",
  • "subscribedSnssaiInfos": {
    },
  • "sharedSnssaiInfosId": "string",
  • "hssGroupId": "string"
}

Session Management Subscription Data

Retrieves the Session Management subscription data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

servingPlmnId
required
string (VarPlmnId) ^[0-9]{5,6}(-[A-Fa-f0-9]{11})?$

PLMN ID

query Parameters
object (Snssai)

single NSSAI

dnn
string (Dnn)

DNN

fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.29110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.39110, 13.1.3

Responses

Response samples

Content type
application/json
Example
[ ]

AMF 3GPP Access Registration (Document)

Retrieves the AMF context data of a UE using 3gpp access

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "amfInstanceId": "7e4f0d93-6733-4b66-bd15-e32f5d2e505f",
  • "supportedFeatures": "string",
  • "purgeFlag": true,
  • "pei": "string",
  • "imsVoPs": "HOMOGENEOUS_SUPPORT",
  • "deregCallbackUri": "string",
  • "amfServiceNameDereg": "nnrf-nfm",
  • "pcscfRestorationCallbackUri": "string",
  • "amfServiceNamePcscfRest": "nnrf-nfm",
  • "initialRegistrationInd": true,
  • "emergencyRegistrationInd": true,
  • "guami": {
    },
  • "backupAmfInfo": [
    ],
  • "drFlag": true,
  • "eps5GsMobilityWoN26": true,
  • "ratType": "NR",
  • "urrpIndicator": true,
  • "amfEeSubscriptionId": "string",
  • "epsInterworkingInfo": {
    },
  • "ueSrvccCapability": true,
  • "registrationTime": "2019-08-24T14:15:22Z",
  • "vgmlcAddress": {
    },
  • "contextInfo": {
    },
  • "noEeSubscriptionInd": true,
  • "supi": "string",
  • "ueReachableInd": "REACHABLE",
  • "reRegistrationRequired": true,
  • "adminDeregSubWithdrawn": true,
  • "dataRestorationCallbackUri": "string",
  • "resetIds": [
    ],
  • "disasterRoamingInd": false,
  • "ueMINTCapability": true,
  • "sorSnpnSiSupported": false,
  • "udrRestartInd": false,
  • "lastSynchronizationTime": "2019-08-24T14:15:22Z",
  • "ueSnpnSubscriptionInd": true
}

To store the AMF context data of a UE using 3gpp access in the UDR

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Request Body schema: application/json
required
amfInstanceId
required
string <uuid> (NfInstanceId)

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.

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

purgeFlag
boolean (PurgeFlag)

This flag indicates whether an AMF is deregistered. This attribute may be included in notifications sent by the UDR to the UDM if purgeFlag is also set to true in the same notification.

pei
string (Pei) ^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a...

String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003; 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 TS23.316. Examples are imei-012345678901234 or imeisv-0123456789012345.

string or string (ImsVoPs)

It represents the information indicating homogeneity of IMS Voice over PS Sessions support for the UE

deregCallbackUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

string or string (ServiceName)

Service names known to NRF

pcscfRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

string or string (ServiceName)

Service names known to NRF

initialRegistrationInd
boolean
emergencyRegistrationInd
boolean
required
object (Guami)

Globally Unique AMF Identifier constructed out of PLMN, Network and AMF identity.

Array of objects (BackupAmfInfo) non-empty
drFlag
boolean (DualRegistrationFlag)

This data type indicates that the UDM+HSS is requested not to send S6a-CLR to the registered MME/SGSN (if any).

eps5GsMobilityWoN26
boolean
required
string or string (RatType)

Indicates the radio access used.

urrpIndicator
boolean
amfEeSubscriptionId
string (Uri)

String providing an URI formatted according to RFC 3986.

object (EpsInterworkingInfo)

This information element contains the associations between APN/DNN and PGW-C+SMF selected by the AMF for EPS interworking.

ueSrvccCapability
boolean
registrationTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

object (VgmlcAddress)

This data type contains the address(es) of VGMLC. Depending on the names of Vgmlcaddress, it could indicate either VGMLC IPv4 or IPv6 address.

object (ContextInfo)

Context Information

noEeSubscriptionInd
boolean
supi
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

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. It shall be formatted as follows

  • for an IMSI "imsi-", where shall be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI.
  • for a network specific identifier "nai-, where shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI.
  • for a GCI "gci-", where shall be formatted according to clause 28.15.2 of 3GPP TS 23.003.
  • for a GLI "gli-", where shall be formatted according to clause 28.16.2 of 3GPP TS 23.003.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.
string or string (UeReachableInd)

UE Reachable Indication

reRegistrationRequired
boolean
adminDeregSubWithdrawn
boolean
dataRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

resetIds
Array of strings non-empty
disasterRoamingInd
boolean
Default: false
ueMINTCapability
boolean
sorSnpnSiSupported
boolean
Default: false
udrRestartInd
boolean
Default: false
lastSynchronizationTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

ueSnpnSubscriptionInd
boolean

Responses

Request samples

Content type
application/json
{
  • "amfInstanceId": "7e4f0d93-6733-4b66-bd15-e32f5d2e505f",
  • "supportedFeatures": "string",
  • "purgeFlag": true,
  • "pei": "string",
  • "imsVoPs": "HOMOGENEOUS_SUPPORT",
  • "deregCallbackUri": "string",
  • "amfServiceNameDereg": "nnrf-nfm",
  • "pcscfRestorationCallbackUri": "string",
  • "amfServiceNamePcscfRest": "nnrf-nfm",
  • "initialRegistrationInd": true,
  • "emergencyRegistrationInd": true,
  • "guami": {
    },
  • "backupAmfInfo": [
    ],
  • "drFlag": true,
  • "eps5GsMobilityWoN26": true,
  • "ratType": "NR",
  • "urrpIndicator": true,
  • "amfEeSubscriptionId": "string",
  • "epsInterworkingInfo": {
    },
  • "ueSrvccCapability": true,
  • "registrationTime": "2019-08-24T14:15:22Z",
  • "vgmlcAddress": {
    },
  • "contextInfo": {
    },
  • "noEeSubscriptionInd": true,
  • "supi": "string",
  • "ueReachableInd": "REACHABLE",
  • "reRegistrationRequired": true,
  • "adminDeregSubWithdrawn": true,
  • "dataRestorationCallbackUri": "string",
  • "resetIds": [
    ],
  • "disasterRoamingInd": false,
  • "ueMINTCapability": true,
  • "sorSnpnSiSupported": false,
  • "udrRestartInd": false,
  • "lastSynchronizationTime": "2019-08-24T14:15:22Z",
  • "ueSnpnSubscriptionInd": true
}

Response samples

Content type
application/json
{
  • "amfInstanceId": "7e4f0d93-6733-4b66-bd15-e32f5d2e505f",
  • "supportedFeatures": "string",
  • "purgeFlag": true,
  • "pei": "string",
  • "imsVoPs": "HOMOGENEOUS_SUPPORT",
  • "deregCallbackUri": "string",
  • "amfServiceNameDereg": "nnrf-nfm",
  • "pcscfRestorationCallbackUri": "string",
  • "amfServiceNamePcscfRest": "nnrf-nfm",
  • "initialRegistrationInd": true,
  • "emergencyRegistrationInd": true,
  • "guami": {
    },
  • "backupAmfInfo": [
    ],
  • "drFlag": true,
  • "eps5GsMobilityWoN26": true,
  • "ratType": "NR",
  • "urrpIndicator": true,
  • "amfEeSubscriptionId": "string",
  • "epsInterworkingInfo": {
    },
  • "ueSrvccCapability": true,
  • "registrationTime": "2019-08-24T14:15:22Z",
  • "vgmlcAddress": {
    },
  • "contextInfo": {
    },
  • "noEeSubscriptionInd": true,
  • "supi": "string",
  • "ueReachableInd": "REACHABLE",
  • "reRegistrationRequired": true,
  • "adminDeregSubWithdrawn": true,
  • "dataRestorationCallbackUri": "string",
  • "resetIds": [
    ],
  • "disasterRoamingInd": false,
  • "ueMINTCapability": true,
  • "sorSnpnSiSupported": false,
  • "udrRestartInd": false,
  • "lastSynchronizationTime": "2019-08-24T14:15:22Z",
  • "ueSnpnSubscriptionInd": true
}

To modify the AMF context data of a UE using 3gpp access in the UDR

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

AMF Non-3GPP Access Registration (Document)

Retrieves the AMF context data of a UE using non-3gpp access

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "amfInstanceId": "7e4f0d93-6733-4b66-bd15-e32f5d2e505f",
  • "supportedFeatures": "string",
  • "purgeFlag": true,
  • "pei": "string",
  • "imsVoPs": "HOMOGENEOUS_SUPPORT",
  • "deregCallbackUri": "string",
  • "amfServiceNameDereg": "nnrf-nfm",
  • "pcscfRestorationCallbackUri": "string",
  • "amfServiceNamePcscfRest": "nnrf-nfm",
  • "guami": {
    },
  • "backupAmfInfo": [
    ],
  • "ratType": "NR",
  • "urrpIndicator": true,
  • "amfEeSubscriptionId": "string",
  • "registrationTime": "2019-08-24T14:15:22Z",
  • "vgmlcAddress": {
    },
  • "contextInfo": {
    },
  • "noEeSubscriptionInd": true,
  • "supi": "string",
  • "reRegistrationRequired": true,
  • "adminDeregSubWithdrawn": true,
  • "dataRestorationCallbackUri": "string",
  • "resetIds": [
    ],
  • "disasterRoamingInd": false,
  • "sorSnpnSiSupported": false,
  • "udrRestartInd": false,
  • "lastSynchronizationTime": "2019-08-24T14:15:22Z",
  • "ueSnpnSubscriptionInd": true
}

To store the AMF context data of a UE using non-3gpp access in the UDR

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Request Body schema: application/json
required
amfInstanceId
required
string <uuid> (NfInstanceId)

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.

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

purgeFlag
boolean (PurgeFlag)

This flag indicates whether an AMF is deregistered. This attribute may be included in notifications sent by the UDR to the UDM if purgeFlag is also set to true in the same notification.

pei
string (Pei) ^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a...

String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003; 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 TS23.316. Examples are imei-012345678901234 or imeisv-0123456789012345.

required
string or string (ImsVoPs)

It represents the information indicating homogeneity of IMS Voice over PS Sessions support for the UE

deregCallbackUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

string or string (ServiceName)

Service names known to NRF

pcscfRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

string or string (ServiceName)

Service names known to NRF

required
object (Guami)

Globally Unique AMF Identifier constructed out of PLMN, Network and AMF identity.

Array of objects (BackupAmfInfo) non-empty
required
string or string (RatType)

Indicates the radio access used.

urrpIndicator
boolean
amfEeSubscriptionId
string (Uri)

String providing an URI formatted according to RFC 3986.

registrationTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

object (VgmlcAddress)

This data type contains the address(es) of VGMLC. Depending on the names of Vgmlcaddress, it could indicate either VGMLC IPv4 or IPv6 address.

object (ContextInfo)

Context Information

noEeSubscriptionInd
boolean
supi
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

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. It shall be formatted as follows

  • for an IMSI "imsi-", where shall be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI.
  • for a network specific identifier "nai-, where shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI.
  • for a GCI "gci-", where shall be formatted according to clause 28.15.2 of 3GPP TS 23.003.
  • for a GLI "gli-", where shall be formatted according to clause 28.16.2 of 3GPP TS 23.003.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.
reRegistrationRequired
boolean
adminDeregSubWithdrawn
boolean
dataRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

resetIds
Array of strings non-empty
disasterRoamingInd
boolean
Default: false
sorSnpnSiSupported
boolean
Default: false
udrRestartInd
boolean
Default: false
lastSynchronizationTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

ueSnpnSubscriptionInd
boolean

Responses

Request samples

Content type
application/json
{
  • "amfInstanceId": "7e4f0d93-6733-4b66-bd15-e32f5d2e505f",
  • "supportedFeatures": "string",
  • "purgeFlag": true,
  • "pei": "string",
  • "imsVoPs": "HOMOGENEOUS_SUPPORT",
  • "deregCallbackUri": "string",
  • "amfServiceNameDereg": "nnrf-nfm",
  • "pcscfRestorationCallbackUri": "string",
  • "amfServiceNamePcscfRest": "nnrf-nfm",
  • "guami": {
    },
  • "backupAmfInfo": [
    ],
  • "ratType": "NR",
  • "urrpIndicator": true,
  • "amfEeSubscriptionId": "string",
  • "registrationTime": "2019-08-24T14:15:22Z",
  • "vgmlcAddress": {
    },
  • "contextInfo": {
    },
  • "noEeSubscriptionInd": true,
  • "supi": "string",
  • "reRegistrationRequired": true,
  • "adminDeregSubWithdrawn": true,
  • "dataRestorationCallbackUri": "string",
  • "resetIds": [
    ],
  • "disasterRoamingInd": false,
  • "sorSnpnSiSupported": false,
  • "udrRestartInd": false,
  • "lastSynchronizationTime": "2019-08-24T14:15:22Z",
  • "ueSnpnSubscriptionInd": true
}

Response samples

Content type
application/json
{
  • "amfInstanceId": "7e4f0d93-6733-4b66-bd15-e32f5d2e505f",
  • "supportedFeatures": "string",
  • "purgeFlag": true,
  • "pei": "string",
  • "imsVoPs": "HOMOGENEOUS_SUPPORT",
  • "deregCallbackUri": "string",
  • "amfServiceNameDereg": "nnrf-nfm",
  • "pcscfRestorationCallbackUri": "string",
  • "amfServiceNamePcscfRest": "nnrf-nfm",
  • "initialRegistrationInd": true,
  • "emergencyRegistrationInd": true,
  • "guami": {
    },
  • "backupAmfInfo": [
    ],
  • "drFlag": true,
  • "eps5GsMobilityWoN26": true,
  • "ratType": "NR",
  • "urrpIndicator": true,
  • "amfEeSubscriptionId": "string",
  • "epsInterworkingInfo": {
    },
  • "ueSrvccCapability": true,
  • "registrationTime": "2019-08-24T14:15:22Z",
  • "vgmlcAddress": {
    },
  • "contextInfo": {
    },
  • "noEeSubscriptionInd": true,
  • "supi": "string",
  • "ueReachableInd": "REACHABLE",
  • "reRegistrationRequired": true,
  • "adminDeregSubWithdrawn": true,
  • "dataRestorationCallbackUri": "string",
  • "resetIds": [
    ],
  • "disasterRoamingInd": false,
  • "ueMINTCapability": true,
  • "sorSnpnSiSupported": false,
  • "udrRestartInd": false,
  • "lastSynchronizationTime": "2019-08-24T14:15:22Z",
  • "ueSnpnSubscriptionInd": true
}

To modify the AMF context data of a UE using non 3gpp access in the UDR

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

SMF Registrations (Collection)

Retrieves the SMF registration list of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SMF Registration (Document)

Retrieves the individual SMF registration of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

pduSessionId
required
integer (PduSessionId) [ 0 .. 255 ]

PDU session id

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "smfInstanceId": "881bd0af-715f-4bf9-a1cf-de5ece768908",
  • "smfSetId": "string",
  • "supportedFeatures": "string",
  • "pduSessionId": 255,
  • "singleNssai": {
    },
  • "dnn": "string",
  • "emergencyServices": true,
  • "pcscfRestorationCallbackUri": "string",
  • "plmnId": {
    },
  • "pgwFqdn": "string",
  • "pgwIpAddr": {
    },
  • "epdgInd": false,
  • "deregCallbackUri": "string",
  • "registrationReason": "SMF_CONTEXT_TRANSFERRED",
  • "registrationTime": "2019-08-24T14:15:22Z",
  • "contextInfo": {
    },
  • "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
  • "dataRestorationCallbackUri": "string",
  • "resetIds": [
    ],
  • "udrRestartInd": false,
  • "lastSynchronizationTime": "2019-08-24T14:15:22Z",
  • "pduSessionReActivationRequired": false,
  • "staleCheckCallbackUri": "string",
  • "udmStaleCheckCallbackUri": "string",
  • "wildcardInd": true
}

To create an individual SMF context data of a UE in the UDR

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

pduSessionId
required
integer (PduSessionId) [ 0 .. 255 ]

PDU session id

Request Body schema: application/json
required
smfInstanceId
required
string <uuid> (NfInstanceId)

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.

smfSetId
string (NfSetId)

NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit shall be inserted at the left side to fill the 3 digits coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

pduSessionId
required
integer (PduSessionId) [ 0 .. 255 ]

Unsigned integer identifying a PDU session, within the range 0 to 255, as specified in clause 11.2.3.1b, bits 1 to 8, of 3GPP TS 24.007. If the PDU Session ID is allocated by the Core Network for UEs not supporting N1 mode, reserved range 64 to 95 is used. PDU Session ID within the reserved range is only visible in the Core Network.

required
object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

dnn
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; 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 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").

emergencyServices
boolean
pcscfRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

required
object (PlmnId)

When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc".

pgwFqdn
string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?...

Fully Qualified Domain Name

object or object or object (IpAddress)

IP Address

epdgInd
boolean
Default: false
deregCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

string or string (RegistrationReason)

Indicates NF registration reason.

registrationTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

object (ContextInfo)

Context Information

pcfId
string <uuid> (NfInstanceId)

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.

dataRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

resetIds
Array of strings non-empty
udrRestartInd
boolean
Default: false
lastSynchronizationTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

pduSessionReActivationRequired
boolean
Default: false
staleCheckCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

udmStaleCheckCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

wildcardInd
boolean

Responses

Callbacks

Request samples

Content type
application/json
{
  • "smfInstanceId": "881bd0af-715f-4bf9-a1cf-de5ece768908",
  • "smfSetId": "string",
  • "supportedFeatures": "string",
  • "pduSessionId": 255,
  • "singleNssai": {
    },
  • "dnn": "string",
  • "emergencyServices": true,
  • "pcscfRestorationCallbackUri": "string",
  • "plmnId": {
    },
  • "pgwFqdn": "string",
  • "pgwIpAddr": {
    },
  • "epdgInd": false,
  • "deregCallbackUri": "string",
  • "registrationReason": "SMF_CONTEXT_TRANSFERRED",
  • "registrationTime": "2019-08-24T14:15:22Z",
  • "contextInfo": {
    },
  • "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
  • "dataRestorationCallbackUri": "string",
  • "resetIds": [
    ],
  • "udrRestartInd": false,
  • "lastSynchronizationTime": "2019-08-24T14:15:22Z",
  • "pduSessionReActivationRequired": false,
  • "staleCheckCallbackUri": "string",
  • "udmStaleCheckCallbackUri": "string",
  • "wildcardInd": true
}

Response samples

Content type
application/json
{
  • "smfInstanceId": "881bd0af-715f-4bf9-a1cf-de5ece768908",
  • "smfSetId": "string",
  • "supportedFeatures": "string",
  • "pduSessionId": 255,
  • "singleNssai": {
    },
  • "dnn": "string",
  • "emergencyServices": true,
  • "pcscfRestorationCallbackUri": "string",
  • "plmnId": {
    },
  • "pgwFqdn": "string",
  • "pgwIpAddr": {
    },
  • "epdgInd": false,
  • "deregCallbackUri": "string",
  • "registrationReason": "SMF_CONTEXT_TRANSFERRED",
  • "registrationTime": "2019-08-24T14:15:22Z",
  • "contextInfo": {
    },
  • "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
  • "dataRestorationCallbackUri": "string",
  • "resetIds": [
    ],
  • "udrRestartInd": false,
  • "lastSynchronizationTime": "2019-08-24T14:15:22Z",
  • "pduSessionReActivationRequired": false,
  • "staleCheckCallbackUri": "string",
  • "udmStaleCheckCallbackUri": "string",
  • "wildcardInd": true
}

Callback payload samples

Callback
POST: {$request.body#/udmStaleCheckCallbackUri}
Content type
application/json
{
  • "smfRegistrationList": [
    ]
}

To remove an individual SMF context data of a UE the UDR

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

pduSessionId
required
integer (PduSessionId) [ 0 .. 255 ]

PDU session id

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

To modify the SMF context data of a UE in the UDR

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

pduSessionId
required
integer (PduSessionId) [ 0 .. 255 ]

PDU session id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Operator-Specific Data Container (Document)

Retrieves the operator specific data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

To modify operator specific data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

To create an operator-specific data resource of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Request Body schema: application/json
required
additional property
object (OperatorSpecificDataContainer)

Container for operator specific data.

Responses

Request samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

To remove an operator-specific data resource of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

SMSF 3GPP Registration (Document)

Create the SMSF context data of a UE via 3GPP access

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Request Body schema: application/json
required
smsfInstanceId
required
string <uuid> (NfInstanceId)

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.

smsfSetId
string (NfSetId)

NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit shall be inserted at the left side to fill the 3 digits coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

required
object (PlmnId)

When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc".

smsfMAPAddress
string (E164Number) ^[0-9]{1,15}$

This data type mentions International E.164 number of the SMSF; shall be present if the SMSF supports MAP.

object (NetworkNodeDiameterAddress)

This data type is a part of smsfDiameterAddress and it should be present whenever smsf supports Diameter protocol.

registrationTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

object (ContextInfo)

Context Information

dataRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

resetIds
Array of strings non-empty
smsfSbiSupInd
boolean
Default: false
udrRestartInd
boolean
Default: false
lastSynchronizationTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

ueMemoryAvailableInd
boolean
Value: true

Responses

Request samples

Content type
application/json
{
  • "smsfInstanceId": "0677b6f5-ab34-4532-8536-47249665fba5",
  • "smsfSetId": "string",
  • "supportedFeatures": "string",
  • "plmnId": {
    },
  • "smsfMAPAddress": "string",
  • "smsfDiameterAddress": {
    },
  • "registrationTime": "2019-08-24T14:15:22Z",
  • "contextInfo": {
    },
  • "dataRestorationCallbackUri": "string",
  • "resetIds": [
    ],
  • "smsfSbiSupInd": false,
  • "udrRestartInd": false,
  • "lastSynchronizationTime": "2019-08-24T14:15:22Z",
  • "ueMemoryAvailableInd": true
}

Response samples

Content type
application/json
{
  • "smsfInstanceId": "0677b6f5-ab34-4532-8536-47249665fba5",
  • "smsfSetId": "string",
  • "supportedFeatures": "string",
  • "plmnId": {
    },
  • "smsfMAPAddress": "string",
  • "smsfDiameterAddress": {
    },
  • "registrationTime": "2019-08-24T14:15:22Z",
  • "contextInfo": {
    },
  • "dataRestorationCallbackUri": "string",
  • "resetIds": [
    ],
  • "smsfSbiSupInd": false,
  • "udrRestartInd": false,
  • "lastSynchronizationTime": "2019-08-24T14:15:22Z",
  • "ueMemoryAvailableInd": true
}

To remove the SMSF context data of a UE via 3GPP access

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Retrieves the SMSF context data of a UE using 3gpp access

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "smsfInstanceId": "0677b6f5-ab34-4532-8536-47249665fba5",
  • "smsfSetId": "string",
  • "supportedFeatures": "string",
  • "plmnId": {
    },
  • "smsfMAPAddress": "string",
  • "smsfDiameterAddress": {
    },
  • "registrationTime": "2019-08-24T14:15:22Z",
  • "contextInfo": {
    },
  • "dataRestorationCallbackUri": "string",
  • "resetIds": [
    ],
  • "smsfSbiSupInd": false,
  • "udrRestartInd": false,
  • "lastSynchronizationTime": "2019-08-24T14:15:22Z",
  • "ueMemoryAvailableInd": true
}

SMSF Non-3GPP Registration (Document)

Create the SMSF context data of a UE via non-3GPP access

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Request Body schema: application/json
required
smsfInstanceId
required
string <uuid> (NfInstanceId)

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.

smsfSetId
string (NfSetId)

NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit shall be inserted at the left side to fill the 3 digits coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

required
object (PlmnId)

When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc".

smsfMAPAddress
string (E164Number) ^[0-9]{1,15}$

This data type mentions International E.164 number of the SMSF; shall be present if the SMSF supports MAP.

object (NetworkNodeDiameterAddress)

This data type is a part of smsfDiameterAddress and it should be present whenever smsf supports Diameter protocol.

registrationTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

object (ContextInfo)

Context Information

dataRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

resetIds
Array of strings non-empty
smsfSbiSupInd
boolean
Default: false
udrRestartInd
boolean
Default: false
lastSynchronizationTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

ueMemoryAvailableInd
boolean
Value: true

Responses

Request samples

Content type
application/json
{
  • "smsfInstanceId": "0677b6f5-ab34-4532-8536-47249665fba5",
  • "smsfSetId": "string",
  • "supportedFeatures": "string",
  • "plmnId": {
    },
  • "smsfMAPAddress": "string",
  • "smsfDiameterAddress": {
    },
  • "registrationTime": "2019-08-24T14:15:22Z",
  • "contextInfo": {
    },
  • "dataRestorationCallbackUri": "string",
  • "resetIds": [
    ],
  • "smsfSbiSupInd": false,
  • "udrRestartInd": false,
  • "lastSynchronizationTime": "2019-08-24T14:15:22Z",
  • "ueMemoryAvailableInd": true
}

Response samples

Content type
application/json
{
  • "smsfInstanceId": "0677b6f5-ab34-4532-8536-47249665fba5",
  • "smsfSetId": "string",
  • "supportedFeatures": "string",
  • "plmnId": {
    },
  • "smsfMAPAddress": "string",
  • "smsfDiameterAddress": {
    },
  • "registrationTime": "2019-08-24T14:15:22Z",
  • "contextInfo": {
    },
  • "dataRestorationCallbackUri": "string",
  • "resetIds": [
    ],
  • "smsfSbiSupInd": false,
  • "udrRestartInd": false,
  • "lastSynchronizationTime": "2019-08-24T14:15:22Z",
  • "ueMemoryAvailableInd": true
}

To remove the SMSF context data of a UE via non-3GPP access

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Retrieves the SMSF context data of a UE using non-3gpp access

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "smsfInstanceId": "0677b6f5-ab34-4532-8536-47249665fba5",
  • "smsfSetId": "string",
  • "supportedFeatures": "string",
  • "plmnId": {
    },
  • "smsfMAPAddress": "string",
  • "smsfDiameterAddress": {
    },
  • "registrationTime": "2019-08-24T14:15:22Z",
  • "contextInfo": {
    },
  • "dataRestorationCallbackUri": "string",
  • "resetIds": [
    ],
  • "smsfSbiSupInd": false,
  • "udrRestartInd": false,
  • "lastSynchronizationTime": "2019-08-24T14:15:22Z",
  • "ueMemoryAvailableInd": true
}

IP-SM-GW Registration (Document)

Create the IP-SM-GW context data of a UE

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Request Body schema: application/json
required
Any of
ipSmGwMapAddress
required
string (E164Number) ^[0-9]{1,15}$

This data type mentions International E.164 number of the SMSF; shall be present if the SMSF supports MAP.

object (NetworkNodeDiameterAddress)

This data type is a part of smsfDiameterAddress and it should be present whenever smsf supports Diameter protocol.

ipsmgwIpv4
string (Ipv4Addr) ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2...

String identifying a IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166.

ipsmgwIpv6
string (Ipv6Addr) ^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((...

String identifying an IPv6 address formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation according to clause 5 of RFC5952 shall not be used.

ipsmgwFqdn
string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?...

Fully Qualified Domain Name

nfInstanceId
string <uuid> (NfInstanceId)

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.

unriIndicator
boolean
Default: false
resetIds
Array of strings non-empty
ipSmGwSbiSupInd
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "ipSmGwMapAddress": "string",
  • "ipSmGwDiameterAddress": {
    },
  • "ipsmgwIpv4": "198.51.100.1",
  • "ipsmgwIpv6": "2001:db8:85a3::8a2e:370:7334",
  • "ipsmgwFqdn": "string",
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "unriIndicator": false,
  • "resetIds": [
    ],
  • "ipSmGwSbiSupInd": false
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

To remove the IP-SM-GW context data of a UE

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Modify the IP-SM-GW context data of a UE

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Request Body schema: application/json-patch+json
required
Array (non-empty)
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Retrieves the IP-SM-GW context data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "ipSmGwMapAddress": "string",
  • "ipSmGwDiameterAddress": {
    },
  • "ipsmgwIpv4": "198.51.100.1",
  • "ipsmgwIpv6": "2001:db8:85a3::8a2e:370:7334",
  • "ipsmgwFqdn": "string",
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "unriIndicator": false,
  • "resetIds": [
    ],
  • "ipSmGwSbiSupInd": false
}

Message Waiting Data (Document)

Create the Message Waiting Data of the UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Request Body schema: application/json
required
Array of objects or objects (SmscData) non-empty

Responses

Request samples

Content type
application/json
{
  • "mwdList": [
    ]
}

Response samples

Content type
application/json
{
  • "mwdList": [
    ]
}

To remove the Message Waiting Data of the UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Modify the Message Waiting Data of the UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Request Body schema: application/json-patch+json
required
Array (non-empty)
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Retrieves the Message Waiting Data of the UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "mwdList": [
    ]
}

SMS Management Subscription Data (Document)

Retrieves the SMS management subscription data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

servingPlmnId
required
string (VarPlmnId) ^[0-9]{5,6}(-[A-Fa-f0-9]{11})?$

PLMN ID

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "supportedFeatures": "string",
  • "mtSmsSubscribed": true,
  • "mtSmsBarringAll": true,
  • "mtSmsBarringRoaming": true,
  • "moSmsSubscribed": true,
  • "moSmsBarringAll": true,
  • "moSmsBarringRoaming": true,
  • "sharedSmsMngDataIds": [
    ],
  • "traceData": {
    },
  • "sharedTraceDataId": "string"
}

SMS Subscription Data (Document)

Retrieves the SMS subscription data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

servingPlmnId
required
string (VarPlmnId) ^[0-9]{5,6}(-[A-Fa-f0-9]{11})?$

PLMN ID

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "smsSubscribed": true,
  • "sharedSmsSubsDataId": "string",
  • "supportedFeatures": "string"
}

Parameter Provision (Document)

Read the profile of a given UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

pp data for a UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "communicationCharacteristics": {
    },
  • "supportedFeatures": "string",
  • "expectedUeBehaviourParameters": {
    },
  • "expectedUeBehaviourExtension": {
    },
  • "ecRestriction": {
    },
  • "acsInfo": {
    },
  • "stnSr": "string",
  • "lcsPrivacy": {
    },
  • "sorInfo": {
    },
  • "5mbsAuthorizationInfo": {
    },
  • "dnnSnssaiSpecificGroup": {
    },
  • "mbsAssistanceInfo": {
    },
  • "appSpecificExpectedUeBehaviour": {
    },
  • "sliceUsageControlInfos": [
    ],
  • "rangingSlPrivacy": {
    }
}

ProvisionedParameterData (Document)

modify the provisioned parameter data

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

pp data for a UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Parameter Provision profile Data (Document)

Retrieves the parameter provision profile data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "allowedMtcProviders": {
    },
  • "supportedFeatures": "string"
}

ProvisionedParameterDataEntry (Document)

create a Provisioning Parameter Data Entry

Authorizations:
NoneNoneNone
path Parameters
required
VarUeId (string) or ExtGroupId (string) or string

Identifier of the UE

afInstanceId
required
string

Application Function Instance Identifier

Request Body schema: application/json
required
object or null (CommunicationCharacteristicsAF)
referenceId
integer (Uint64) [ 0 .. 18446744073709552000 ]

Integer where the allowed values correspond to the value range of an unsigned 64-bit integer.

validityTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

mtcProviderInformation
string (MtcProviderInformation)

String uniquely identifying MTC provider information.

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

object or null (EcsAddrConfigInfo)
Array of objects or null (EcsAddrConfigInfo) non-empty
object non-empty

A map (list of key-value pairs) where the key of the map is the serving PLMN id; and the value is an array of EcsAddrConfigInfo for that serving PLMN.

object or null (EcRestriction)
Array of objects or objects (SliceUsageControlInfo) non-empty

Responses

Request samples

Content type
application/json
{
  • "communicationCharacteristics": {
    },
  • "referenceId": 18446744073709552000,
  • "validityTime": "2019-08-24T14:15:22Z",
  • "mtcProviderInformation": "string",
  • "supportedFeatures": "string",
  • "ecsAddrConfigInfo": {
    },
  • "additionalEcsAddrConfigInfos": [
    ],
  • "ecsAddrConfigInfoPerPlmn": {
    },
  • "ecRestriction": {
    },
  • "sliceUsageControlInfos": [
    ]
}

Response samples

Content type
application/json
{
  • "communicationCharacteristics": {
    },
  • "referenceId": 18446744073709552000,
  • "validityTime": "2019-08-24T14:15:22Z",
  • "mtcProviderInformation": "string",
  • "supportedFeatures": "string",
  • "ecsAddrConfigInfo": {
    },
  • "additionalEcsAddrConfigInfos": [
    ],
  • "ecsAddrConfigInfoPerPlmn": {
    },
  • "ecRestriction": {
    },
  • "sliceUsageControlInfos": [
    ]
}

Delete a Provisioning Parameter Data Entry

Authorizations:
NoneNoneNone
path Parameters
required
VarUeId (string) or ExtGroupId (string) or string

Identifier of the UE

afInstanceId
required
string

Application Function Instance Identifier

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

get a Parameter Provisioning Data Entry

path Parameters
required
VarUeId (string) or ExtGroupId (string) or string

Identifier of the UE

afInstanceId
required
string

Application Function Instance Identifier

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Responses

Response samples

Content type
application/json
{
  • "communicationCharacteristics": {
    },
  • "referenceId": 18446744073709552000,
  • "validityTime": "2019-08-24T14:15:22Z",
  • "mtcProviderInformation": "string",
  • "supportedFeatures": "string",
  • "ecsAddrConfigInfo": {
    },
  • "additionalEcsAddrConfigInfos": [
    ],
  • "ecsAddrConfigInfoPerPlmn": {
    },
  • "ecRestriction": {
    },
  • "sliceUsageControlInfos": [
    ]
}

ProvisionedParameterDataEntries (Collection)

get a list of Parameter Provisioning Data Entries

path Parameters
required
VarUeId (string) or ExtGroupId (string) or string

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Responses

Response samples

Content type
application/json
{
  • "ppDataEntryList": [
    ],
  • "supportedFeatures": "string"
}

Event Exposure Subscriptions (Collection)

Retrieves the ee subscriptions of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Array of strings or strings (EventType) non-empty

Event Types

Array of objects (NfIdentifier) non-empty

NF Identifiers

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create individual EE subscription

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE ID

Request Body schema: application/json
required
callbackReference
required
string (Uri)

String providing an URI formatted according to RFC 3986.

required
object non-empty

A map (list of key-value pairs where ReferenceId serves as key) of MonitoringConfigurations

object (ReportingOptions)
supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

subscriptionId
string
object (ContextInfo)

Context Information

epcAppliedInd
boolean
Default: false
scefDiamHost
string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?...

Fully Qualified Domain Name

scefDiamRealm
string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?...

Fully Qualified Domain Name

notifyCorrelationId
string
secondCallbackRef
string (Uri)

String providing an URI formatted according to RFC 3986.

gpsi
string (Gpsi) ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$

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 that describes an External Identifier.

excludeGpsiList
Array of strings (Gpsi) non-empty [ items^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ ]
includeGpsiList
Array of strings (Gpsi) non-empty [ items^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ ]
dataRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

udrRestartInd
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "callbackReference": "string",
  • "monitoringConfigurations": {
    },
  • "reportingOptions": {
    },
  • "supportedFeatures": "string",
  • "subscriptionId": "string",
  • "contextInfo": {
    },
  • "epcAppliedInd": false,
  • "scefDiamHost": "string",
  • "scefDiamRealm": "string",
  • "notifyCorrelationId": "string",
  • "secondCallbackRef": "string",
  • "gpsi": "string",
  • "excludeGpsiList": [
    ],
  • "includeGpsiList": [
    ],
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false
}

Response samples

Content type
application/json
{
  • "callbackReference": "string",
  • "monitoringConfigurations": {
    },
  • "reportingOptions": {
    },
  • "supportedFeatures": "string",
  • "subscriptionId": "string",
  • "contextInfo": {
    },
  • "epcAppliedInd": false,
  • "scefDiamHost": "string",
  • "scefDiamRealm": "string",
  • "notifyCorrelationId": "string",
  • "secondCallbackRef": "string",
  • "gpsi": "string",
  • "excludeGpsiList": [
    ],
  • "includeGpsiList": [
    ],
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false
}

Event Exposure Subscription (Document)

Update an individual ee subscriptions of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string
Request Body schema: application/json
required
callbackReference
required
string (Uri)

String providing an URI formatted according to RFC 3986.

required
object non-empty

A map (list of key-value pairs where ReferenceId serves as key) of MonitoringConfigurations

object (ReportingOptions)
supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

subscriptionId
string
object (ContextInfo)

Context Information

epcAppliedInd
boolean
Default: false
scefDiamHost
string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?...

Fully Qualified Domain Name

scefDiamRealm
string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?...

Fully Qualified Domain Name

notifyCorrelationId
string
secondCallbackRef
string (Uri)

String providing an URI formatted according to RFC 3986.

gpsi
string (Gpsi) ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$

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 that describes an External Identifier.

excludeGpsiList
Array of strings (Gpsi) non-empty [ items^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ ]
includeGpsiList
Array of strings (Gpsi) non-empty [ items^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ ]
dataRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

udrRestartInd
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "callbackReference": "string",
  • "monitoringConfigurations": {
    },
  • "reportingOptions": {
    },
  • "supportedFeatures": "string",
  • "subscriptionId": "string",
  • "contextInfo": {
    },
  • "epcAppliedInd": false,
  • "scefDiamHost": "string",
  • "scefDiamRealm": "string",
  • "notifyCorrelationId": "string",
  • "secondCallbackRef": "string",
  • "gpsi": "string",
  • "excludeGpsiList": [
    ],
  • "includeGpsiList": [
    ],
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Deletes a eeSubscription

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string

Unique ID of the subscription to remove

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Modify an individual ee subscription of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

subsId
required
string
query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array (non-empty)
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Retrieve a eeSubscription

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string

Unique ID of the subscription to remove

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AMF Subscription Info (Document)

Create AmfSubscriptions for an individual ee subscriptions of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string
Request Body schema: application/json
required
Array (non-empty)
amfInstanceId
required
string <uuid> (NfInstanceId)

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.

subscriptionId
required
string (Uri)

String providing an URI formatted according to RFC 3986.

subsChangeNotifyCorrelationId
string
object (ContextInfo)

Context Information

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Event AMF Subscription Info (Document)

Deletes AMF Subscription Info for an eeSubscription

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Deletes AMF Subscription Info for an eeSubscription for a group of UEs or any UE

Authorizations:
NoneNoneNone
path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

UE group Id or any UE.

subsId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

AmfSubscriptionInfo (Document)

modify the AMF Subscription Info

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string
query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

modify the AMF Subscription Info

Authorizations:
NoneNoneNone
path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

UE group Id or any UE.

subsId
required
string
query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Query AMF Subscription Info (Document)

Retrieve AMF subscription Info

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve AMF subscription Info for a group of UEs or any UE

Authorizations:
NoneNoneNone
path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

UE group Id or any UE.

subsId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SMF Event Subscription Info (Document)

Create SMF Subscription Info

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string
Request Body schema: application/json
required
required
Array of objects (SmfSubscriptionItem) non-empty

Responses

Request samples

Content type
application/json
{
  • "smfSubscriptionList": [
    ]
}

Response samples

Content type
application/json
{
  • "smfSubscriptionList": [
    ]
}

Delete SMF Subscription Info

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Modify SMF Subscription Info

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string
query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Retrieve SMF Subscription Info

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string

Responses

Response samples

Content type
application/json
{
  • "smfSubscriptionList": [
    ]
}

Delete SMF Subscription Info for a group of UEs or any UE

Authorizations:
NoneNoneNone
path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

UE group Id or any UE.

subsId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Modify SMF Subscription Info for a group of UEs or any UE

Authorizations:
NoneNoneNone
path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

UE group Id or any UE.

subsId
required
string
query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Retrieve SMF Subscription Info for a group of UEs or any UE

Authorizations:
NoneNoneNone
path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

UE group Id or any UE.

subsId
required
string

Responses

Response samples

Content type
application/json
{
  • "smfSubscriptionList": [
    ]
}

HSS Event Subscription Info (Document)

Create HSS Subscription Info

path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string
Request Body schema: application/json
required
required
Array of objects (HssSubscriptionItem) non-empty

Responses

Request samples

Content type
application/json
{
  • "hssSubscriptionList": [
    ]
}

Response samples

Content type
application/json
{
  • "hssSubscriptionList": [
    ]
}

Delete HSS Subscription Info

path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Modify HSS Subscription Info

path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string
query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Retrieve HSS Subscription Info

path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string

Responses

Response samples

Content type
application/json
{
  • "smfSubscriptionList": [
    ]
}

Delete HSS Subscription Info

path Parameters
externalGroupId
required
string (ExtGroupId) ^extgroupid-[^@]+@[^@]+$

External Identifier of a group of UEs

subsId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Modify HSS Subscription Info

path Parameters
externalGroupId
required
string (ExtGroupId) ^extgroupid-[^@]+@[^@]+$

External Identifier of a group of UEs

subsId
required
string
query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Retrieve HSS Subscription Info

path Parameters
externalGroupId
required
string (ExtGroupId) ^extgroupid-[^@]+@[^@]+$

External Identifier of a group of UEs

subsId
required
string

Responses

Response samples

Content type
application/json
{
  • "hssSubscriptionList": [
    ]
}

Event Exposure Group Subscriptions (Collection)

Retrieves the ee subscriptions of a group of UEs or any UE

Authorizations:
NoneNoneNone
path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

Group of UEs or any UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create individual EE subscription for a group of UEs or any UE

Authorizations:
NoneNoneNone
path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

Group of UEs or any UE

Request Body schema: application/json
required
callbackReference
required
string (Uri)

String providing an URI formatted according to RFC 3986.

required
object non-empty

A map (list of key-value pairs where ReferenceId serves as key) of MonitoringConfigurations

object (ReportingOptions)
supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

subscriptionId
string
object (ContextInfo)

Context Information

epcAppliedInd
boolean
Default: false
scefDiamHost
string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?...

Fully Qualified Domain Name

scefDiamRealm
string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?...

Fully Qualified Domain Name

notifyCorrelationId
string
secondCallbackRef
string (Uri)

String providing an URI formatted according to RFC 3986.

gpsi
string (Gpsi) ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$

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 that describes an External Identifier.

excludeGpsiList
Array of strings (Gpsi) non-empty [ items^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ ]
includeGpsiList
Array of strings (Gpsi) non-empty [ items^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ ]
dataRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

udrRestartInd
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "callbackReference": "string",
  • "monitoringConfigurations": {
    },
  • "reportingOptions": {
    },
  • "supportedFeatures": "string",
  • "subscriptionId": "string",
  • "contextInfo": {
    },
  • "epcAppliedInd": false,
  • "scefDiamHost": "string",
  • "scefDiamRealm": "string",
  • "notifyCorrelationId": "string",
  • "secondCallbackRef": "string",
  • "gpsi": "string",
  • "excludeGpsiList": [
    ],
  • "includeGpsiList": [
    ],
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false
}

Response samples

Content type
application/json
{
  • "callbackReference": "string",
  • "monitoringConfigurations": {
    },
  • "reportingOptions": {
    },
  • "supportedFeatures": "string",
  • "subscriptionId": "string",
  • "contextInfo": {
    },
  • "epcAppliedInd": false,
  • "scefDiamHost": "string",
  • "scefDiamRealm": "string",
  • "notifyCorrelationId": "string",
  • "secondCallbackRef": "string",
  • "gpsi": "string",
  • "excludeGpsiList": [
    ],
  • "includeGpsiList": [
    ],
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false
}

Event Exposure Group Subscription (Document)

Update an individual ee subscription of a group of UEs or any UE

Authorizations:
NoneNoneNone
path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

UE group Id or any UE.

subsId
required
string
Request Body schema: application/json
required
callbackReference
required
string (Uri)

String providing an URI formatted according to RFC 3986.

required
object non-empty

A map (list of key-value pairs where ReferenceId serves as key) of MonitoringConfigurations

object (ReportingOptions)
supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

subscriptionId
string
object (ContextInfo)

Context Information

epcAppliedInd
boolean
Default: false
scefDiamHost
string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?...

Fully Qualified Domain Name

scefDiamRealm
string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?...

Fully Qualified Domain Name

notifyCorrelationId
string
secondCallbackRef
string (Uri)

String providing an URI formatted according to RFC 3986.

gpsi
string (Gpsi) ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$

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 that describes an External Identifier.

excludeGpsiList
Array of strings (Gpsi) non-empty [ items^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ ]
includeGpsiList
Array of strings (Gpsi) non-empty [ items^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ ]
dataRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

udrRestartInd
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "callbackReference": "string",
  • "monitoringConfigurations": {
    },
  • "reportingOptions": {
    },
  • "supportedFeatures": "string",
  • "subscriptionId": "string",
  • "contextInfo": {
    },
  • "epcAppliedInd": false,
  • "scefDiamHost": "string",
  • "scefDiamRealm": "string",
  • "notifyCorrelationId": "string",
  • "secondCallbackRef": "string",
  • "gpsi": "string",
  • "excludeGpsiList": [
    ],
  • "includeGpsiList": [
    ],
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Deletes a eeSubscription for a group of UEs or any UE

Authorizations:
NoneNoneNone
path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

UE group Id or any UE.

subsId
required
string

Unique ID of the subscription to remove

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Modify an individual ee subscription for a group of a UEs

Authorizations:
NoneNoneNone
path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

UE group Id or any UE.

subsId
required
string
query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array (non-empty)
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Retrieve a individual eeSubscription for a group of UEs or any UE

Authorizations:
NoneNoneNone
path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

UE group Id or any UE.

subsId
required
string

Unique ID of the subscription to remove

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Event Exposure Data for a group (Document)

Retrieves the ee profile data profile data of a group or anyUE

Authorizations:
NoneNoneNone
path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

Group of UEs or any UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "restrictedEventTypes": [
    ],
  • "allowedMtcProvider": {
    },
  • "supportedFeatures": "string",
  • "iwkEpcRestricted": false,
  • "extGroupId": "string",
  • "hssGroupId": "string"
}

Event Exposure Data (Document)

Retrieves the ee profile data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
fields
Array of strings

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "restrictedEventTypes": [
    ],
  • "supportedFeatures": "string",
  • "allowedMtcProvider": {
    },
  • "iwkEpcRestricted": false,
  • "imsi": "string",
  • "hssGroupId": "string"
}

SDM Subscriptions (Collection)

Retrieves the sdm subscriptions of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create individual sdm subscription

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE ID

Request Body schema: application/json
required
nfInstanceId
required
string <uuid> (NfInstanceId)

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.

implicitUnsubscribe
boolean
expires
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

callbackReference
required
string (Uri)

String providing an URI formatted according to RFC 3986.

string or string (ServiceName)

Service names known to NRF

monitoredResourceUris
required
Array of strings (Uri) non-empty
object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

dnn
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; 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 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").

subscriptionId
string
object (PlmnId)

When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc".

immediateReport
boolean
Default: false
SubscriptionDataSets (object) or Array of SharedData (objects) (schemas-ImmediateReport)

Contains the immediate report

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

object (ContextInfo)

Context Information

nfChangeFilter
boolean
Default: false
uniqueSubscription
boolean
resetIds
Array of strings non-empty
object (UeContextInSmfDataSubFilter)

UE Context In Smf Data Subscription Filter.

Array of objects (PlmnId) non-empty
disasterRoamingInd
boolean
Default: false
dataRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

udrRestartInd
boolean
Default: false
object non-empty

A map(list of key-value pairs) where a valid JSON pointer serves as key of expectedUeBehaviourThresholds

Responses

Request samples

Content type
application/json
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "implicitUnsubscribe": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "callbackReference": "string",
  • "amfServiceName": "nnrf-nfm",
  • "monitoredResourceUris": [
    ],
  • "singleNssai": {
    },
  • "dnn": "string",
  • "subscriptionId": "string",
  • "plmnId": {
    },
  • "immediateReport": false,
  • "report": {
    },
  • "supportedFeatures": "string",
  • "contextInfo": {
    },
  • "nfChangeFilter": false,
  • "uniqueSubscription": true,
  • "resetIds": [
    ],
  • "ueConSmfDataSubFilter": {
    },
  • "adjacentPlmns": [
    ],
  • "disasterRoamingInd": false,
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false,
  • "expectedUeBehaviourThresholds": {
    }
}

Response samples

Content type
application/json
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "implicitUnsubscribe": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "callbackReference": "string",
  • "amfServiceName": "nnrf-nfm",
  • "monitoredResourceUris": [
    ],
  • "singleNssai": {
    },
  • "dnn": "string",
  • "subscriptionId": "string",
  • "plmnId": {
    },
  • "immediateReport": false,
  • "report": {
    },
  • "supportedFeatures": "string",
  • "contextInfo": {
    },
  • "nfChangeFilter": false,
  • "uniqueSubscription": true,
  • "resetIds": [
    ],
  • "ueConSmfDataSubFilter": {
    },
  • "adjacentPlmns": [
    ],
  • "disasterRoamingInd": false,
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false,
  • "expectedUeBehaviourThresholds": {
    }
}

SDM Subscription (Document)

Update an individual sdm subscriptions of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string
Request Body schema: application/json
required
nfInstanceId
required
string <uuid> (NfInstanceId)

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.

implicitUnsubscribe
boolean
expires
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

callbackReference
required
string (Uri)

String providing an URI formatted according to RFC 3986.

string or string (ServiceName)

Service names known to NRF

monitoredResourceUris
required
Array of strings (Uri) non-empty
object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

dnn
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; 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 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").

subscriptionId
string
object (PlmnId)

When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc".

immediateReport
boolean
Default: false
SubscriptionDataSets (object) or Array of SharedData (objects) (schemas-ImmediateReport)

Contains the immediate report

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

object (ContextInfo)

Context Information

nfChangeFilter
boolean
Default: false
uniqueSubscription
boolean
resetIds
Array of strings non-empty
object (UeContextInSmfDataSubFilter)

UE Context In Smf Data Subscription Filter.

Array of objects (PlmnId) non-empty
disasterRoamingInd
boolean
Default: false
dataRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

udrRestartInd
boolean
Default: false
object non-empty

A map(list of key-value pairs) where a valid JSON pointer serves as key of expectedUeBehaviourThresholds

Responses

Request samples

Content type
application/json
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "implicitUnsubscribe": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "callbackReference": "string",
  • "amfServiceName": "nnrf-nfm",
  • "monitoredResourceUris": [
    ],
  • "singleNssai": {
    },
  • "dnn": "string",
  • "subscriptionId": "string",
  • "plmnId": {
    },
  • "immediateReport": false,
  • "report": {
    },
  • "supportedFeatures": "string",
  • "contextInfo": {
    },
  • "nfChangeFilter": false,
  • "uniqueSubscription": true,
  • "resetIds": [
    ],
  • "ueConSmfDataSubFilter": {
    },
  • "adjacentPlmns": [
    ],
  • "disasterRoamingInd": false,
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false,
  • "expectedUeBehaviourThresholds": {
    }
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Deletes a sdmsubscriptions

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string

Unique ID of the subscription to remove

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Modify an individual sdm subscription

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

subsId
required
string
query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array (non-empty)
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Retrieves a individual sdmSubscription identified by subsId

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string

Unique ID of the subscription to retrieve

Responses

Response samples

Content type
application/json
[
  • {
    }
]

HSS SDM Subscription Info (Document)

Create HSS SDM Subscription Info

path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string
Request Body schema: application/json
required
required
Array of objects (HssSubscriptionItem) non-empty

Responses

Request samples

Content type
application/json
{
  • "hssSubscriptionList": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Delete HSS SDM Subscription Info

path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Modify HSS SDM Subscription Info

path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string
query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Retrieve HSS SDM Subscription Info

path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

subsId
required
string

Responses

Response samples

Content type
application/json
{
  • "smfSubscriptionList": [
    ]
}

Retrieval of shared data

retrieve shared data

Authorizations:
NoneNoneNone
query Parameters
shared-data-ids
required
Array of strings (SharedDataIds) non-empty unique [ items^[0-9]{5,6}-.+$ ]

List of shared data ids

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieval of individual shared data

retrieve individual shared data

path Parameters
sharedDataId
required
string (SharedDataId) ^[0-9]{5,6}-.+$

Id of the Shared Data

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "sharedDataId": "string",
  • "sharedAmData": {
    },
  • "sharedSmsSubsData": {
    },
  • "sharedSmsMngSubsData": {
    },
  • "sharedDnnConfigurations": {
    },
  • "sharedTraceData": {
    },
  • "sharedSnssaiInfos": {
    },
  • "sharedVnGroupDatas": {
    },
  • "treatmentInstructions": {
    },
  • "sharedSmSubsData": {
    },
  • "sharedEcsAddrConfigInfo": {
    }
}

Subs To Notify (Collection)

Subscription data subscriptions

Authorizations:
NoneNoneNone
Request Body schema: application/json
required
ueId
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

callbackReference
required
string (Uri)

String providing an URI formatted according to RFC 3986.

originalCallbackReference
string (Uri)

String providing an URI formatted according to RFC 3986.

monitoredResourceUris
required
Array of strings (Uri)
expiry
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

object (SdmSubscription)

Contains SDM Subscriptions to Notifications

object (HssSubscriptionInfo)

Information related to active subscriptions at the HSS(s)

subscriptionId
string
uniqueSubscription
boolean
supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

immediateReport
boolean
Default: false
ProvisionedDataSets (object) or Array of SharedData (objects) (ImmediateReport)
Array of objects (AdditionalDataRef)

Responses

Callbacks

Request samples

Content type
application/json
{
  • "ueId": "string",
  • "callbackReference": "string",
  • "originalCallbackReference": "string",
  • "monitoredResourceUris": [
    ],
  • "expiry": "2019-08-24T14:15:22Z",
  • "sdmSubscription": {
    },
  • "hssSubscriptionInfo": {
    },
  • "subscriptionId": "string",
  • "uniqueSubscription": true,
  • "supportedFeatures": "string",
  • "immediateReport": false,
  • "report": {
    },
  • "additionalDataRefs": [
    ]
}

Response samples

Content type
application/json
{
  • "ueId": "string",
  • "callbackReference": "string",
  • "originalCallbackReference": "string",
  • "monitoredResourceUris": [
    ],
  • "expiry": "2019-08-24T14:15:22Z",
  • "sdmSubscription": {
    },
  • "hssSubscriptionInfo": {
    },
  • "subscriptionId": "string",
  • "uniqueSubscription": true,
  • "supportedFeatures": "string",
  • "immediateReport": false,
  • "report": {
    },
  • "additionalDataRefs": [
    ]
}

Callback payload samples

Callback
POST: {$request.body#/callbackReference}
Content type
application/json
{
  • "originalCallbackReference": [
    ],
  • "ueId": "string",
  • "notifyItems": [
    ],
  • "sdmSubscription": {
    },
  • "additionalSdmSubscriptions": [
    ],
  • "subscriptionDataSubscriptions": [
    ],
  • "additionalData": {
    }
}

Retrieves the list of subscriptions

Authorizations:
NoneNoneNone
query Parameters
ue-id
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes subscriptions identified by a given ue-id parameter

Authorizations:
NoneNoneNone
query Parameters
ue-id
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE ID

nf-instance-id
string <uuid> (NfInstanceId)

NF Instance ID

delete-all-nfs
boolean

Flag to delete subscriptions from all NFs

implicit-unsubscribe-indication
boolean

Implicit Unsubscribe Indication

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Subs To Notify (Document)

Deletes a subscriptionDataSubscriptions

Authorizations:
NoneNoneNone
path Parameters
subsId
required
string

Unique ID of the subscription to remove

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Modify an individual subscriptionDataSubscription

Authorizations:
NoneNoneNone
path Parameters
subsId
required
string
query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array (non-empty)
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
Example
{
  • "report": [
    ]
}

Retrieves a individual subscriptionDataSubscription identified by subsId

Authorizations:
NoneNoneNone
path Parameters
subsId
required
string

Unique ID of the subscription to retrieve

Responses

Response samples

Content type
application/json
{
  • "ueId": "string",
  • "callbackReference": "string",
  • "originalCallbackReference": "string",
  • "monitoredResourceUris": [
    ],
  • "expiry": "2019-08-24T14:15:22Z",
  • "sdmSubscription": {
    },
  • "hssSubscriptionInfo": {
    },
  • "subscriptionId": "string",
  • "uniqueSubscription": true,
  • "supportedFeatures": "string",
  • "immediateReport": false,
  • "report": {
    },
  • "additionalDataRefs": [
    ]
}

Trace Data (Document)

Retrieves the trace configuration data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

servingPlmnId
required
string (VarPlmnId) ^[0-9]{5,6}(-[A-Fa-f0-9]{11})?$

PLMN ID

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
Example
{
  • "traceRef": "string",
  • "traceDepth": "MINIMUM",
  • "neTypeList": "string",
  • "eventList": "string",
  • "collectionEntityIpv4Addr": "198.51.100.1",
  • "collectionEntityIpv6Addr": "2001:db8:85a3::8a2e:370:7334",
  • "traceReportingConsumerUri": "string",
  • "interfaceList": "string",
  • "jobType": "IMMEDIATE_MDT_ONLY"
}

Query Identity Data by SUPI or GPSI (Document)

Retrieve identity data by SUPI or GPSI

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE ID

query Parameters
object (AppPortId)

Application port identifier

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "supiList": [
    ],
  • "gpsiList": [
    ],
  • "allowedAfIds": [
    ],
  • "applicationPortIds": {
    },
  • "afIdGpsis": {
    },
  • "mtcProviderGpsis": {
    }
}

Query ODB Data by SUPI or GPSI (Document)

Retrieve ODB Data data by SUPI or GPSI

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE ID

Responses

Response samples

Content type
application/json
{
  • "roamingOdb": "OUTSIDE_HOME_PLMN"
}

Context Data (Document)

Retrieve multiple context data sets of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
required
Array of strings or strings (ContextDatasetNames) >= 2 items unique

List of context dataset names

Responses

Response samples

Content type
application/json
{
  • "amf3Gpp": {
    },
  • "amfNon3Gpp": {
    },
  • "sdmSubscriptions": [
    ],
  • "eeSubscriptions": [
    ],
  • "smsf3GppAccess": {
    },
  • "smsfNon3GppAccess": {
    },
  • "subscriptionDataSubscriptions": [
    ],
  • "smfRegistrations": [
    ],
  • "ipSmGw": {
    },
  • "roamingInfo": {
    },
  • "peiInfo": {
    }
}

Group Identifiers

Mapping of Group Identifiers

Authorizations:
NoneNoneNone
query Parameters
ext-group-id
string (ExtGroupId) ^extgroupid-[^@]+@[^@]+$

External Group Identifier

int-group-id
string (GroupId) ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0...

Internal Group Identifier

ue-id-ind
boolean
Default: false

Indication whether UE identifiers are required or not

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "extGroupId": "string",
  • "intGroupId": "string",
  • "ueIdList": [
    ],
  • "allowedAfIds": [
    ]
}

5G-VN-Groups (Store)

Retrieves the data of a 5G VN Group

Authorizations:
NoneNoneNone
query Parameters
gpsis
Array of strings (Gpsi) [ items^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ ]

List of GPSIs

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

5GVnGroupConfiguration (Document)

Create an individual 5G VN Grouop

Authorizations:
NoneNoneNone
path Parameters
externalGroupId
required
string (ExtGroupId) ^extgroupid-[^@]+@[^@]+$

External Identifier of a group of UEs

Request Body schema: application/json
required
object (5GVnGroupData)
members
Array of strings (Gpsi) non-empty [ items^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ ]
referenceId
integer (Uint64) [ 0 .. 18446744073709552000 ]

Integer where the allowed values correspond to the value range of an unsigned 64-bit integer.

afInstanceId
string
internalGroupIdentifier
string (GroupId) ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0...

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.

mtcProviderInformation
string (MtcProviderInformation)

String uniquely identifying MTC provider information.

object non-empty

Contains the list of 5G VN Group members, each member is identified by GPSI. A map (list of key-value pairs where Gpsi serves as key) of GpsiInfo. The value in each entries of the map shall be an empty JSON object.

Responses

Request samples

Content type
application/json
{
  • "5gVnGroupData": {
    },
  • "members": [
    ],
  • "referenceId": 18446744073709552000,
  • "afInstanceId": "string",
  • "internalGroupIdentifier": "string",
  • "mtcProviderInformation": "string",
  • "membersData": {
    }
}

Response samples

Content type
application/json
{
  • "5gVnGroupData": {
    },
  • "members": [
    ],
  • "referenceId": 18446744073709552000,
  • "afInstanceId": "string",
  • "internalGroupIdentifier": "string",
  • "mtcProviderInformation": "string",
  • "membersData": {
    }
}

Delete 5GVnGroup

Deletes the 5GVnGroup

Authorizations:
NoneNoneNone
path Parameters
externalGroupId
required
string (ExtGroupId) ^extgroupid-[^@]+@[^@]+$

External Identifier of a group of UEs

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Modify 5GVnGroup

modify the 5GVnGroup

Authorizations:
NoneNoneNone
path Parameters
externalGroupId
required
string (ExtGroupId) ^extgroupid-[^@]+@[^@]+$

External Identifier of a group of UEs

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Query 5GVnGroupConfiguration (Document)

Retrieve a 5GVnGroup configuration

Authorizations:
NoneNoneNone
path Parameters
externalGroupId
required
string (ExtGroupId) ^extgroupid-[^@]+@[^@]+$

External Identifier of a group of UEs

Responses

Response samples

Content type
application/json
{
  • "5gVnGroupData": {
    },
  • "members": [
    ],
  • "referenceId": 18446744073709552000,
  • "afInstanceId": "string",
  • "internalGroupIdentifier": "string",
  • "mtcProviderInformation": "string",
  • "membersData": {
    }
}

LCS Privacy Subscription Data

Retrieves the LCS Privacy subscription data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "lpi": {
    },
  • "unrelatedClass": {
    },
  • "plmnOperatorClasses": [
    ],
  • "evtRptExpectedArea": {
    },
  • "areaUsageInd": "INSIDE_REPORTING",
  • "upLocRepIndAf": "USER_PLANE_REPORT_NOT_ALLOWED"
}

LCS Subscription Data

Retrieves the LCS subscription data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "configuredLmfId": "string",
  • "pruInd": "NON_PRU",
  • "lpHapType": "LOW_POW_HIGH_ACCU_POS",
  • "userPlanePosIndLmf": false
}

LCS Mobile Originated Subscription Data

Retrieves the LCS Mobile Originated subscription data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "allowedServiceClasses": [
    ],
  • "moAssistanceDataTypes": {
    }
}

Query NIDD Authorization Data GPSI or External Group identifier (Document)

Retrieve NIDD Authorization Data GPSI or External Group identifier

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^@]+|ext...

UE ID

query Parameters
required
object (Snssai)

single NSSAI

dnn
required
string (Dnn)

DNN

mtc-provider-information
required
string (MtcProviderInformation)

MTC Provider Information

af-id
string

Application Function Identifier

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "authorizationData": [
    ],
  • "allowedDnnList": [
    ],
  • "allowedSnssaiList": [
    ],
  • "allowedMtcProviders": [
    ],
  • "validityTime": "2019-08-24T14:15:22Z"
}

Enhanced Coverage Restriction Data

Retrieves the subscribed enhanced Coverage Restriction Data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "plmnEcInfoList": [
    ]
}

UE's Location Information (Document)

Retrieves the UE's Location Information

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "supi": "string",
  • "gpsi": "string",
  • "registrationLocationInfoList": [
    ],
  • "supportedFeatures": "string"
}

V2X Subscription Data

Retrieves the subscribed V2X Data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "nrV2xServicesAuth": {
    },
  • "lteV2xServicesAuth": {
    },
  • "nrUePc5Ambr": "string",
  • "ltePc5Ambr": "string"
}

ProSe Service Subscription Data

Retrieves the subscribed ProSe service Data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "proseServiceAuth": {
    },
  • "nrUePc5Ambr": "string",
  • "proseAllowedPlmn": [
    ]
}

LCS Broadcast Assistance Subscription Data

Retrieves the LCS Broadcast Assistance subscription data of a UE

path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

servingPlmnId
required
string (VarPlmnId) ^[0-9]{5,6}(-[A-Fa-f0-9]{11})?$

PLMN ID

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "locationAssistanceType": "string"
}

5G-VN-Groups-Internal (Document)

Retrieves the data of 5G VN Group

query Parameters
internal-group-ids
required
Array of strings (GroupId) [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]

List of Internal Group IDs

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Parameter Provision profile Data for 5G VN Group(Document)

Retrieves the parameter provision profile data for 5G VN Group

Authorizations:
NoneNoneNone
query Parameters
ext-group-ids
Array of strings (ExtGroupId) non-empty [ items^extgroupid-[^@]+@[^@]+$ ]

List of external VN group identifiers

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "allowedMtcProviders": {
    },
  • "supportedFeatures": "string"
}

NIDD Authorization Info (Document)

Create NIDD Authorization Info

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

Request Body schema: application/json
required
required
Array of objects (AuthorizationInfo) non-empty

Responses

Request samples

Content type
application/json
{
  • "niddAuthorizationList": [
    ]
}

Response samples

Content type
application/json
{
  • "niddAuthorizationList": [
    ]
}

Delete NIDD Authorization Info

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Modify NIDD Authorization Info

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Retrieve NIDD Authorization Info

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

Responses

Response samples

Content type
application/json
{
  • "niddAuthorizationList": [
    ]
}

5MBSSubscriptionData (Document)

Retrieves the 5mbs subscription data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "mbsAllowed": false,
  • "mbsSessionIdList": [
    ],
  • "ueMbsAssistanceInfo": [
    ]
}

UE Subscribed Data (Document)

Retrieve multiple subscribed data sets of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE Id

query Parameters
Array of (ContextDataSetName (ContextDataSetName (string) or ContextDataSetName (string))) or (ProvisionedDataSetName (ProvisionedDataSetName (string) or ProvisionedDataSetName (string))) or strings (UeSubscribedDatasetNames) non-empty unique

List of dataset names

serving-plmn
string (VarPlmnId) ^[0-9]{5,6}(-[A-Fa-f0-9]{11})?$

Serving PLMN Id

Array of objects (PlmnId) non-empty

List of PLMNs adjacent to the UE's serving PLMN

object (Snssai)

single NSSAI

dnn
string (Dnn)

DNN

ext-group-ids
Array of strings (ExtGroupId) non-empty [ items^extgroupid-[^@]+@[^@]+$ ]

List of external VN group identifiers

string or string (UcPurpose)

User consent purpose

Responses

Response samples

Content type
application/json
{
  • "amData": {
    },
  • "smfSelData": {
    },
  • "smsSubsData": {
    },
  • "smData": [
    ],
  • "traceData": {
    },
  • "smsMngData": {
    },
  • "lcsPrivacyData": {
    },
  • "lcsMoData": {
    },
  • "lcsSubscriptionData": {
    },
  • "lcsBcaData": {
    },
  • "v2xData": {
    },
  • "proseData": {
    },
  • "odbData": {
    },
  • "eeProfileData": {
    },
  • "ppProfileData": {
    },
  • "niddAuthData": {
    },
  • "ucData": {
    },
  • "mbsSubscriptionData": {
    },
  • "ppData": {
    },
  • "a2xData": {
    },
  • "rangingSlPrivacyData": {
    },
  • "amf3Gpp": {
    },
  • "amfNon3Gpp": {
    },
  • "sdmSubscriptions": [
    ],
  • "eeSubscriptions": [
    ],
  • "smsf3GppAccess": {
    },
  • "smsfNon3GppAccess": {
    },
  • "subscriptionDataSubscriptions": [
    ],
  • "smfRegistrations": [
    ],
  • "ipSmGw": {
    },
  • "roamingInfo": {
    },
  • "peiInfo": {
    },
  • "sorData": {
    },
  • "upuData": {
    },
  • "nssaiAckData": {
    },
  • "cagAckData": {
    }
}

Query Service Specific Authorization Data (Document)

Retrieve ServiceSpecific Authorization Data

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^@]+|ext...

UE ID

required
string or string (ServiceType)

Service Type

query Parameters
required
object (Snssai)

single NSSAI

dnn
required
string (Dnn)

DNN

mtc-provider-information
string (MtcProviderInformation)

MTC Provider Information

af-id
string

Application Function Identifier

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "authorizationData": [
    ],
  • "allowedDnnList": [
    ],
  • "allowedSnssaiList": [
    ],
  • "allowedMtcProviders": [
    ],
  • "validityTime": "2019-08-24T14:15:22Z"
}

Service Specific Authorization Info (Document)

Create Service Specific Authorization Info

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

required
string or string (ServiceType)

Service Type

Request Body schema: application/json
required
required
object non-empty

A map (list of key-value pairs where authId serves as key) of AuthorizationInfo

Responses

Request samples

Content type
application/json
{
  • "serviceSpecificAuthorizationList": {
    }
}

Response samples

Content type
application/json
{
  • "serviceSpecificAuthorizationList": {
    }
}

Delete Service Specific Authorization Info

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

required
string or string (ServiceType)

Service Type

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Modify Service Specific Authorization Info

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

required
string or string (ServiceType)

Service Type

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Retrieve Service Specific Authorization Info

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

required
string or string (ServiceType)

Service Type

Responses

Response samples

Content type
application/json
{
  • "serviceSpecificAuthorizationList": {
    }
}

Update the Roaming Information of the EPC domain (Document)

Update the Roaming Information of the EPC domain

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Request Body schema: application/json
required
roaming
boolean
required
object (PlmnId)

When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc".

Responses

Request samples

Content type
application/json
{
  • "roaming": true,
  • "servingPlmn": {
    }
}

Response samples

Content type
application/json
{
  • "roaming": true,
  • "servingPlmn": {
    }
}

Retrieve the Roaming Information of the EPC domain (Document)

Retrieves the Roaming Information of the EPC domain

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Responses

Response samples

Content type
application/json
{
  • "roaming": true,
  • "servingPlmn": {
    }
}

Update the PEI Information of the 5GC/EPC domains (Document)

Update the PEI Information of the 5GC/EPC domains

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Request Body schema: application/json
required
pei
required
string (Pei) ^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a...

String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003; 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 TS23.316. Examples are imei-012345678901234 or imeisv-0123456789012345.

Responses

Request samples

Content type
application/json
{
  • "pei": "string"
}

Response samples

Content type
application/json
{
  • "pei": "string"
}

Retrieve the Roaming Information of the 5GC/EPC domains (Document)

Retrieves the PEI Information of the 5GC/EPC domains

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

Responses

Response samples

Content type
application/json
{
  • "pei": "string"
}

AMF Group Subscription Info (Document)

Create AmfSubscriptions for a group of UEs or any UE

Authorizations:
NoneNoneNone
path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

UE group Id or any UE.

subsId
required
string
Request Body schema: application/json
required
Array (non-empty)
amfInstanceId
required
string <uuid> (NfInstanceId)

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.

subscriptionId
required
string (Uri)

String providing an URI formatted according to RFC 3986.

subsChangeNotifyCorrelationId
string
object (ContextInfo)

Context Information

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

SMF Event Group Subscription Info (Document)

Create SMF Subscription Info for a group of UEs or any YE

Authorizations:
NoneNoneNone
path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

UE group Id or any UE.

subsId
required
string
Request Body schema: application/json
required
required
Array of objects (SmfSubscriptionItem) non-empty

Responses

Request samples

Content type
application/json
{
  • "smfSubscriptionList": [
    ]
}

Response samples

Content type
application/json
{
  • "smfSubscriptionList": [
    ]
}

HSS Event Group Subscription Info (Document)

Create HSS Subscription Info for a group of UEs

path Parameters
ueGroupId
required
string (VarUeGroupId) ^(extgroupid-[^@]+@[^@]+|anyUE)$

Group of UEs or any UE

subsId
required
string
Request Body schema: application/json
required
required
Array of objects (HssSubscriptionItem) non-empty

Responses

Request samples

Content type
application/json
{
  • "hssSubscriptionList": [
    ]
}

Response samples

Content type
application/json
{
  • "hssSubscriptionList": [
    ]
}

TimeSyncSubscriptionData (Document)

Retrieves the time synchronization subscription data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "afReqAuthorizations": {
    },
  • "serviceIds": [
    ]
}

5G-MBS-Group (Store)

Retrieves the data of a 5G MBS Group

Authorizations:
NoneNoneNone
query Parameters
gpsis
Array of strings (Gpsi) [ items^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ ]

List of GPSIs

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

MulticastMbsGroupMemb (Document)

Create an individual 5G MBS Grouop

Authorizations:
NoneNoneNone
path Parameters
externalGroupId
required
string (ExtGroupId) ^extgroupid-[^@]+@[^@]+$

External Identifier of a group of UEs

Request Body schema: application/json
required
multicastGroupMemb
required
Array of strings (Gpsi) non-empty [ items^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ ]
afInstanceId
string
internalGroupIdentifier
string (GroupId) ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0...

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.

Responses

Request samples

Content type
application/json
{
  • "multicastGroupMemb": [
    ],
  • "afInstanceId": "string",
  • "internalGroupIdentifier": "string"
}

Response samples

Content type
application/json
{
  • "multicastGroupMemb": [
    ],
  • "afInstanceId": "string",
  • "internalGroupIdentifier": "string"
}

Delete 5GmbsGroup

Deletes the 5GmbsGroup

Authorizations:
NoneNoneNone
path Parameters
externalGroupId
required
string (ExtGroupId) ^extgroupid-[^@]+@[^@]+$

External Identifier of a group of UEs

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Modify 5GmbsGroup

modify the 5GmbsGroup

Authorizations:
NoneNoneNone
path Parameters
externalGroupId
required
string (ExtGroupId) ^extgroupid-[^@]+@[^@]+$

External Identifier of a group of UEs

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Query MulticastMbsGroupMemb (Document)

Retrieve a 5GmbsGroup

Authorizations:
NoneNoneNone
path Parameters
externalGroupId
required
string (ExtGroupId) ^extgroupid-[^@]+@[^@]+$

External Identifier of a group of UEs

Responses

Response samples

Content type
application/json
{
  • "multicastGroupMemb": [
    ],
  • "afInstanceId": "string",
  • "internalGroupIdentifier": "string"
}

5G-MBS-Groups-Internal (Document)

Retrieves the data of 5G MBS Group

query Parameters
internal-group-ids
required
Array of strings (GroupId) [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]

List of Internal Group IDs

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Parameter Provision profile Data for 5G MBS Group(Document)

Retrieves the parameter provision profile data for 5G MBS Group

Authorizations:
NoneNoneNone
query Parameters
ext-group-ids
Array of strings (ExtGroupId) non-empty [ items^extgroupid-[^@]+@[^@]+$ ]

List of external MBS group identifiers

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "allowedMbsInfos": {
    },
  • "supportedFeatures": "string"
}

A2X Subscription Data

Retrieves the subscribed A2X Data of a UE

Authorizations:
NoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE id

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "nrA2xServicesAuth": {
    },
  • "lteA2xServicesAuth": {
    },
  • "nrUePc5Ambr": "string",
  • "ltePc5Ambr": "string"
}