API docs by Redocly

Npcf_PolicyAuthorization Service API (1.3.1)

Download OpenAPI specification:

PCF Policy Authorization Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

3GPP TS 29.514 V18.8.0; 5G System; Policy Authorization Service; Stage 3.

Application Sessions (Collection)

Creates a new Individual Application Session Context resource

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
Request Body schema: application/json
required

Contains the information for the creation the resource.

object or object or object (AppSessionContextReqData)

Identifies the service requirements of an Individual Application Session Context.

object (AppSessionContextRespData)

Describes the authorization data of an Individual Application Session Context created by the PCF.

object (EventsNotification)

Describes the notification of a matched event.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "ascReqData": {
    },
  • "ascRespData": {
    },
  • "evsNotif": {
    }
}

Response samples

Content type
application/json
{
  • "ascReqData": {
    },
  • "ascRespData": {
    },
  • "evsNotif": {
    }
}

Callback payload samples

Callback
Content type
application/json
{
  • "termCause": "ALL_SDF_DEACTIVATION",
  • "resUri": "string"
}

PCSCF Restoration Indication

Indicates P-CSCF restoration and does not create an Individual Application Session Context

Authorizations:
NoneoAuth2ClientCredentials
Request Body schema: application/json
required

PCSCF Restoration Indication.

One of
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").

ipDomain
string
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".

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

ueIpv6
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.

Responses

Request samples

Content type
application/json
{
  • "dnn": "string",
  • "ipDomain": "string",
  • "sliceInfo": {
    },
  • "supi": "string",
  • "ueIpv4": "198.51.100.1",
  • "ueIpv6": "2001:db8:85a3::8a2e:370:7334"
}

Response samples

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

Individual Application Session Context (Document)

Reads an existing Individual Application Session Context

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
appSessionId
required
string

String identifying the resource.

Responses

Response samples

Content type
application/json
{
  • "ascReqData": {
    },
  • "ascRespData": {
    },
  • "evsNotif": {
    }
}

Modifies an existing Individual Application Session Context

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
appSessionId
required
string

String identifying the resource.

Request Body schema: application/merge-patch+json
required

Modification of the resource.

object (AppSessionContextUpdateData)

Identifies the modifications to the "ascReqData" property of an Individual Application Session Context which may include the modifications to the sub-resource Events Subscription.

Responses

Callbacks

Request samples

Content type
application/merge-patch+json
{
  • "ascReqData": {
    }
}

Response samples

Content type
application/json
{
  • "ascReqData": {
    },
  • "ascRespData": {
    },
  • "evsNotif": {
    }
}

Callback payload samples

Callback
POST: {$request.body#/ascReqData/evSubsc/notifUri}/notify
Content type
application/json
{
  • "adReports": [
    ],
  • "accessType": "3GPP_ACCESS",
  • "addAccessInfo": {
    },
  • "relAccessInfo": {
    },
  • "anChargAddr": {
    },
  • "anChargIds": [
    ],
  • "anGwAddr": {
    },
  • "l4sReports": [
    ],
  • "evSubsUri": "string",
  • "evNotifs": [
    ],
  • "failedResourcAllocReports": [
    ],
  • "succResourcAllocReports": [
    ],
  • "noNetLocSupp": "ANR_NOT_SUPPORTED",
  • "outOfCredReports": [
    ],
  • "plmnId": {
    },
  • "qncReports": [
    ],
  • "qosMonReports": [
    ],
  • "qosMonDatRateReps": [
    ],
  • "pdvMonReports": [
    ],
  • "congestReports": [
    ],
  • "rttMonReports": [
    ],
  • "ranNasRelCauses": [
    ],
  • "ratType": "NR",
  • "satBackhaulCategory": "GEO",
  • "ueLoc": {
    },
  • "ueLocTime": "2019-08-24T14:15:22Z",
  • "ueTimeZone": "-08:00+1",
  • "usgRep": {
    },
  • "urspEnfRep": "string",
  • "sscMode": "SSC_MODE_1",
  • "ueReqDnn": "string",
  • "ueReqPduSessionType": "IPV4",
  • "tsnBridgeManCont": {
    },
  • "tsnPortManContDstt": {
    },
  • "tsnPortManContNwtts": [
    ],
  • "ipv4AddrList": [
    ],
  • "ipv6PrefixList": [
    ],
  • "batOffsetInfo": {
    },
  • "ueReachStatus": "REACHABLE",
  • "retryAfter": 0
}

Deletes an existing Individual Application Session Context

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
appSessionId
required
string

String identifying the Individual Application Session Context resource.

Request Body schema: application/json
optional

Deletion of the Individual Application Session Context resource, req notification.

required
Array of objects (AfEventSubscription) non-empty
notifUri
string (Uri)

String providing an URI formatted according to RFC 3986.

Array of strings or strings (RequestedQosMonitoringParameter) non-empty
object (QosMonitoringInformation)

Indicates the QoS Monitoring information to report, i.e. UL and/or DL and or round trip delay.

object (QosMonitoringInformation)

Indicates the QoS Monitoring information to report, i.e. UL and/or DL and or round trip delay.

Array of strings or strings (RequestedQosMonitoringParameter) non-empty
object (QosMonitoringInformation)

Indicates the QoS Monitoring information to report, i.e. UL and/or DL and or round trip delay.

object (QosMonitoringInformation)

Indicates the QoS Monitoring information to report, i.e. UL and/or DL and or round trip delay.

object (QosMonitoringInformation)

Indicates the QoS Monitoring information to report, i.e. UL and/or DL and or round trip delay.

object (RttFlowReference)

Contains the shared key with the media subcomponent that shares the subscription to round trip time measurements in the complementary direction.

Array of strings or strings (RequiredAccessInfo) non-empty
object (UsageThreshold)

Represents a usage threshold.

notifCorreId
string
afAppIds
Array of strings (AfAppId) non-empty
directNotifInd
boolean

Indicates whether the direct event notification is requested (true) or not (false) for the provided QoS monitoring parameters. Default value is false.

avrgWndw
integer (AverWindow) [ 1 .. 4095 ]
Default: 2000

Unsigned integer indicating Averaging Window (see clause 5.7.3.6 and 5.7.4 of 3GPP TS 23.501), expressed in milliseconds.

Responses

Request samples

Content type
application/json
{
  • "events": [
    ],
  • "notifUri": "string",
  • "reqQosMonParams": [
    ],
  • "qosMon": {
    },
  • "qosMonDatRate": {
    },
  • "pdvReqMonParams": [
    ],
  • "pdvMon": {
    },
  • "congestMon": {
    },
  • "rttMon": {
    },
  • "rttFlowRef": {
    },
  • "reqAnis": [
    ],
  • "usgThres": {
    },
  • "notifCorreId": "string",
  • "afAppIds": [
    ],
  • "directNotifInd": true,
  • "avrgWndw": 2000
}

Response samples

Content type
application/json
{
  • "ascReqData": {
    },
  • "ascRespData": {
    },
  • "evsNotif": {
    }
}

Events Subscription (Document)

creates or modifies an Events Subscription subresource

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
appSessionId
required
string

String identifying the Events Subscription resource.

Request Body schema: application/json
required

Creation or modification of an Events Subscription resource.

required
Array of objects (AfEventSubscription) non-empty
notifUri
string (Uri)

String providing an URI formatted according to RFC 3986.

Array of strings or strings (RequestedQosMonitoringParameter) non-empty
object (QosMonitoringInformation)

Indicates the QoS Monitoring information to report, i.e. UL and/or DL and or round trip delay.

object (QosMonitoringInformation)

Indicates the QoS Monitoring information to report, i.e. UL and/or DL and or round trip delay.

Array of strings or strings (RequestedQosMonitoringParameter) non-empty
object (QosMonitoringInformation)

Indicates the QoS Monitoring information to report, i.e. UL and/or DL and or round trip delay.

object (QosMonitoringInformation)

Indicates the QoS Monitoring information to report, i.e. UL and/or DL and or round trip delay.

object (QosMonitoringInformation)

Indicates the QoS Monitoring information to report, i.e. UL and/or DL and or round trip delay.

object (RttFlowReference)

Contains the shared key with the media subcomponent that shares the subscription to round trip time measurements in the complementary direction.

Array of strings or strings (RequiredAccessInfo) non-empty
object (UsageThreshold)

Represents a usage threshold.

notifCorreId
string
afAppIds
Array of strings (AfAppId) non-empty
directNotifInd
boolean

Indicates whether the direct event notification is requested (true) or not (false) for the provided QoS monitoring parameters. Default value is false.

avrgWndw
integer (AverWindow) [ 1 .. 4095 ]
Default: 2000

Unsigned integer indicating Averaging Window (see clause 5.7.3.6 and 5.7.4 of 3GPP TS 23.501), expressed in milliseconds.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "events": [
    ],
  • "notifUri": "string",
  • "reqQosMonParams": [
    ],
  • "qosMon": {
    },
  • "qosMonDatRate": {
    },
  • "pdvReqMonParams": [
    ],
  • "pdvMon": {
    },
  • "congestMon": {
    },
  • "rttMon": {
    },
  • "rttFlowRef": {
    },
  • "reqAnis": [
    ],
  • "usgThres": {
    },
  • "notifCorreId": "string",
  • "afAppIds": [
    ],
  • "directNotifInd": true,
  • "avrgWndw": 2000
}

Response samples

Content type
application/json
Example
{
  • "events": [
    ],
  • "notifUri": "string",
  • "reqQosMonParams": [
    ],
  • "qosMon": {
    },
  • "qosMonDatRate": {
    },
  • "pdvReqMonParams": [
    ],
  • "pdvMon": {
    },
  • "congestMon": {
    },
  • "rttMon": {
    },
  • "rttFlowRef": {
    },
  • "reqAnis": [
    ],
  • "usgThres": {
    },
  • "notifCorreId": "string",
  • "afAppIds": [
    ],
  • "directNotifInd": true,
  • "avrgWndw": 2000
}

Callback payload samples

Callback
POST: {$request.body#/notifUri}/notify
Content type
application/json
{
  • "adReports": [
    ],
  • "accessType": "3GPP_ACCESS",
  • "addAccessInfo": {
    },
  • "relAccessInfo": {
    },
  • "anChargAddr": {
    },
  • "anChargIds": [
    ],
  • "anGwAddr": {
    },
  • "l4sReports": [
    ],
  • "evSubsUri": "string",
  • "evNotifs": [
    ],
  • "failedResourcAllocReports": [
    ],
  • "succResourcAllocReports": [
    ],
  • "noNetLocSupp": "ANR_NOT_SUPPORTED",
  • "outOfCredReports": [
    ],
  • "plmnId": {
    },
  • "qncReports": [
    ],
  • "qosMonReports": [
    ],
  • "qosMonDatRateReps": [
    ],
  • "pdvMonReports": [
    ],
  • "congestReports": [
    ],
  • "rttMonReports": [
    ],
  • "ranNasRelCauses": [
    ],
  • "ratType": "NR",
  • "satBackhaulCategory": "GEO",
  • "ueLoc": {
    },
  • "ueLocTime": "2019-08-24T14:15:22Z",
  • "ueTimeZone": "-08:00+1",
  • "usgRep": {
    },
  • "urspEnfRep": "string",
  • "sscMode": "SSC_MODE_1",
  • "ueReqDnn": "string",
  • "ueReqPduSessionType": "IPV4",
  • "tsnBridgeManCont": {
    },
  • "tsnPortManContDstt": {
    },
  • "tsnPortManContNwtts": [
    ],
  • "ipv4AddrList": [
    ],
  • "ipv6PrefixList": [
    ],
  • "batOffsetInfo": {
    },
  • "ueReachStatus": "REACHABLE",
  • "retryAfter": 0
}

deletes the Events Subscription subresource

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
appSessionId
required
string

String identifying the Individual Application Session Context resource.

Responses

Response samples

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