API docs by Redocly

Npcf_AMPolicyControl (1.3.1)

Download OpenAPI specification:

Access and Mobility Policy Control Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

3GPP TS 29.507 V18.8.0; 5G System; Access and Mobility Policy Control Service.

AM Policy Associations (Collection)

Create individual AM policy association.

Authorizations:
NoneoAuth2ClientCredentials
Request Body schema: application/json
required
notificationUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

altNotifIpv4Addrs
Array of strings (Ipv4Addr) non-empty [ items^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2... ]

Alternate or backup IPv4 Address(es) where to send Notifications.

altNotifIpv6Addrs
Array of strings (Ipv6Addr) non-empty [ items^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((... ]

Alternate or backup IPv6 Address(es) where to send Notifications.

altNotifFqdns
Array of strings (Fqdn) non-empty [ items [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... ]

Alternate or backup FQDN(s) where to send Notifications.

supi
required
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.
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.

accessType
string (AccessType)
Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"

Indicates whether the access is via 3GPP or via non-3GPP.

accessTypes
Array of strings (AccessType) non-empty
Items Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"
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.

object (UserLocation)

At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several of them may be present.

timeZone
string (TimeZone)

String with format "time-numoffset" optionally appended by "daylightSavingTime", where

  • "time-numoffset" shall represent the time zone adjusted for daylight saving time and be encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339;
  • "daylightSavingTime" shall represent the adjustment that has been made and shall be encoded as "+1" or "+2" for a +1 or +2 hours adjustment.

The example is for 8 hours behind UTC, +1 hour adjustment for Daylight Saving Time.

object (PlmnIdNid)

Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.

string or string (RatType)

Indicates the radio access used.

Array of strings or strings (RatType) non-empty
groupIds
Array of strings (GroupId) non-empty [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]
(any or any) or (object or object) (ServiceAreaRestriction)
object (WirelineServiceAreaRestriction)

The "restrictionType" attribute and the "areas" attribute shall be either both present or absent. The empty array of areas is used when service is allowed/restricted nowhere.

rfsp
integer (RfspIndex) [ 1 .. 256 ]

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

object (Ambr)

Contains the maximum aggregated uplink and downlink bit rates.

Array of objects or null (UeSliceMbr) non-empty

The subscribed UE Slice-MBR for each subscribed S-NSSAI of the home PLMN mapping to a S-NSSAI of the serving PLMN Shall be provided when available.

Array of objects (Snssai) non-empty

array of allowed S-NSSAIs for the 3GPP access.

object non-empty

Represents the Partially Allowed NSSAI. The key of the map shall be set to the value of the "snssai" attribute of the corresponding map entry (encoded using the PartiallyAllowedSnssai data structure).

object non-empty

Represents the set of S-NSSAI(s) rejected partially in the RA. The key of the map shall be set to the value of the "snssai" attribute of the corresponding map entry (encoded using the SnssaiPartRejected data structure).

Array of objects (Snssai) non-empty
Array of objects (Snssai) non-empty
Array of objects (Snssai) non-empty

array of target S-NSSAIs.

Array of objects (MappingOfSnssai) non-empty

mapping of each S-NSSAI of the Allowed NSSAI to the corresponding S-NSSAI of the HPLMN.

Array of objects (Snssai) non-empty

array of allowed S-NSSAIs for the Non-3GPP access.

object (Guami)

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

string or string (ServiceName)

Service names known to NRF

object or null (TraceData)

contains Trace control and configuration parameters.

Array of objects (NwdafData) non-empty
suppFeat
required
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.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "notificationUri": "string",
  • "altNotifIpv4Addrs": [
    ],
  • "altNotifIpv6Addrs": [
    ],
  • "altNotifFqdns": [
    ],
  • "supi": "string",
  • "gpsi": "string",
  • "accessType": "3GPP_ACCESS",
  • "accessTypes": [
    ],
  • "pei": "string",
  • "userLoc": {
    },
  • "timeZone": "-08:00+1",
  • "servingPlmn": {
    },
  • "ratType": "NR",
  • "ratTypes": [
    ],
  • "groupIds": [
    ],
  • "servAreaRes": {
    },
  • "wlServAreaRes": {
    },
  • "rfsp": 1,
  • "ueAmbr": {
    },
  • "ueSliceMbrs": [
    ],
  • "allowedSnssais": [
    ],
  • "partAllowedNssai": {
    },
  • "snssaisPartRejected": {
    },
  • "rejectedSnssais": [
    ],
  • "pendingNssai": [
    ],
  • "targetSnssais": [
    ],
  • "mappingSnssais": [
    ],
  • "n3gAllowedSnssais": [
    ],
  • "guami": {
    },
  • "serviveName": "nnrf-nfm",
  • "traceReq": {
    },
  • "nwdafDatas": [
    ],
  • "suppFeat": "string"
}

Response samples

Content type
application/json
{
  • "request": {
    },
  • "triggers": [
    ],
  • "servAreaRes": {
    },
  • "wlServAreaRes": {
    },
  • "rfsp": 1,
  • "rfspValTime": 0,
  • "targetRfsp": 1,
  • "smfSelInfo": {
    },
  • "ueAmbr": {
    },
  • "ueSliceMbrs": [
    ],
  • "pras": {
    },
  • "pcfUeInfo": {
    },
  • "matchPdus": [
    ],
  • "asTimeDisParam": {
    },
  • "sliceUsgCtrlInfoSets": {
    },
  • "chfInfo": {
    },
  • "suppFeat": "string"
}

Callback payload samples

Callback
Content type
application/json
{
  • "resourceUri": "string",
  • "triggers": [
    ],
  • "servAreaRes": {
    },
  • "wlServAreaRes": {
    },
  • "rfsp": 1,
  • "rfspValTime": 0,
  • "targetRfsp": 1,
  • "smfSelInfo": {
    },
  • "ueAmbr": {
    },
  • "ueSliceMbrs": [
    ],
  • "pras": {
    },
  • "pcfUeInfo": {
    },
  • "matchPdus": [
    ],
  • "asTimeDisParam": {
    },
  • "snssaiReplInfos": {
    },
  • "sliceUsgCtrlInfoSets": {
    },
  • "suppFeat": "string"
}

Individual AM Policy Association (Document)

Read individual AM policy association.

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
polAssoId
required
string

Identifier of a policy association

Responses

Response samples

Content type
application/json
{
  • "request": {
    },
  • "triggers": [
    ],
  • "servAreaRes": {
    },
  • "wlServAreaRes": {
    },
  • "rfsp": 1,
  • "rfspValTime": 0,
  • "targetRfsp": 1,
  • "smfSelInfo": {
    },
  • "ueAmbr": {
    },
  • "ueSliceMbrs": [
    ],
  • "pras": {
    },
  • "pcfUeInfo": {
    },
  • "matchPdus": [
    ],
  • "asTimeDisParam": {
    },
  • "sliceUsgCtrlInfoSets": {
    },
  • "chfInfo": {
    },
  • "suppFeat": "string"
}

Delete individual AM policy association.

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
polAssoId
required
string

Identifier of a policy association

Responses

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}

Report observed event triggers and obtain updated policies for an individual AM policy association.

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
polAssoId
required
string

Identifier of a policy association

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

String providing an URI formatted according to RFC 3986.

altNotifIpv4Addrs
Array of strings (Ipv4Addr) non-empty [ items^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2... ]

Alternate or backup IPv4 Address(es) where to send Notifications.

altNotifIpv6Addrs
Array of strings (Ipv6Addr) non-empty [ items^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((... ]

Alternate or backup IPv6 Address(es) where to send Notifications.

altNotifFqdns
Array of strings (Fqdn) non-empty [ items [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... ]

Alternate or backup FQDN(s) where to send Notifications.

Array of strings or strings (RequestTrigger) non-empty

Request Triggers that the NF service consumer observes.

(any or any) or (object or object) (ServiceAreaRestriction)
object (WirelineServiceAreaRestriction)

The "restrictionType" attribute and the "areas" attribute shall be either both present or absent. The empty array of areas is used when service is allowed/restricted nowhere.

rfsp
integer (RfspIndex) [ 1 .. 256 ]

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

object or null (SmfSelectionData)

Represents the SMF Selection information that may be replaced by the PCF.

object (Ambr)

Contains the maximum aggregated uplink and downlink bit rates.

Array of objects or null (UeSliceMbr) non-empty

The subscribed UE-Slice-MBR for each subscribed S-NSSAI of the home PLMN mapping to a S-NSSAI of the serving PLMN Shall be provided for the "UE_SLICE_MBR_CH" policy control request trigger.

object non-empty

Contains the UE presence status for tracking area for which changes of the UE presence occurred. The praId attribute within the PresenceInfo data type is the key of the map.

object (UserLocation)

At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several of them may be present.

Array of objects (Snssai) non-empty

array of allowed S-NSSAIs for the 3GPP access.

object non-empty

Represents the Partially Allowed NSSAI. The key of the map shall be set to the value of the "snssai" attribute of the corresponding map entry (encoded using the PartiallyAllowedSnssai data structure).

object non-empty

Represents the set of S-NSSAI(s) rejected partially in the RA. The key of the map shall be set to the value of the "snssai" attribute of the corresponding map entry (encoded using the SnssaiPartRejected data structure).

Array of objects (Snssai) non-empty
Array of objects (Snssai) non-empty
Array of objects (Snssai) non-empty

array of target S-NSSAIs.

Array of objects (MappingOfSnssai) non-empty

mapping of each S-NSSAI of the Allowed NSSAI to the corresponding S-NSSAI of the HPLMN.

Array of objects or null (SnssaiReplaceInfo) non-empty

Change or removal of Mapping of (replaced) S-NSSAI(s) with Alternative S-NSSAI(s) for one or more S-NSSAI(s) of the UE's Allowed NSSAI and/or Partially Allowed NSSAI.

accessTypes
Array of strings (AccessType) non-empty
Items Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"
Array of strings or strings (RatType) non-empty
Array of objects (Snssai) non-empty

array of allowed S-NSSAIs for the Non-3GPP access.

Array of objects (Snssai) non-empty

Represents the unavailable S-NSSAI(s) from the UE's Allowed NSSAI and/or Partially Allowed NSSAI that require network slice replacement.

object or null (TraceData)

contains Trace control and configuration parameters.

object (Guami)

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

Array of objects or null (NwdafData) non-empty
suppFeat
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.

Responses

Request samples

Content type
application/json
{
  • "notificationUri": "string",
  • "altNotifIpv4Addrs": [
    ],
  • "altNotifIpv6Addrs": [
    ],
  • "altNotifFqdns": [
    ],
  • "triggers": [
    ],
  • "servAreaRes": {
    },
  • "wlServAreaRes": {
    },
  • "rfsp": 1,
  • "smfSelInfo": {
    },
  • "ueAmbr": {
    },
  • "ueSliceMbrs": [
    ],
  • "praStatuses": {
    },
  • "userLoc": {
    },
  • "allowedSnssais": [
    ],
  • "partAllowedNssai": {
    },
  • "snssaisPartRejected": {
    },
  • "rejectedSnssais": [
    ],
  • "pendingNssai": [
    ],
  • "targetSnssais": [
    ],
  • "mappingSnssais": [
    ],
  • "snssaiReplInfos": [
    ],
  • "accessTypes": [
    ],
  • "ratTypes": [
    ],
  • "n3gAllowedSnssais": [
    ],
  • "unavailSnssais": [
    ],
  • "traceReq": {
    },
  • "guami": {
    },
  • "nwdafDatas": [
    ],
  • "suppFeat": "string"
}

Response samples

Content type
application/json
{
  • "resourceUri": "string",
  • "triggers": [
    ],
  • "servAreaRes": {
    },
  • "wlServAreaRes": {
    },
  • "rfsp": 1,
  • "rfspValTime": 0,
  • "targetRfsp": 1,
  • "smfSelInfo": {
    },
  • "ueAmbr": {
    },
  • "ueSliceMbrs": [
    ],
  • "pras": {
    },
  • "pcfUeInfo": {
    },
  • "matchPdus": [
    ],
  • "asTimeDisParam": {
    },
  • "snssaiReplInfos": {
    },
  • "sliceUsgCtrlInfoSets": {
    },
  • "suppFeat": "string"
}