openapi: 3.2.0
info:
  title: 3gpp-am-policyauthorization AM Policy Events Subscription API
  version: 1.2.0
  description: "API for AM policy authorization.  \n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-am-policyauthorization/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
tags:
- name: AM Policy Events Subscription
paths:
  /{afId}/app-am-contexts/{appAmContextId}/events-subscription:
    put:
      summary: creates or modifies an AM Policy Events Subscription sub-resource.
      operationId: UpdateAmEventsSubsc
      tags:
      - AM Policy Events Subscription
      parameters:
      - name: afId
        in: path
        description: Identifier of the AF
        required: true
        schema:
          type: string
      - name: appAmContextId
        in: path
        description: string identifying the AM Policy Events Subscription subresource
        required: true
        schema:
          type: string
      requestBody:
        description: 'Creation or modification of an application AM Policy Events Subscription sub-resource.

          '
        required: true
        content:
          application/json:
            schema:
              $ref: TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/AmEventsSubscData
      responses:
        '201':
          description: 'The creation of the application AM Policy Events Subscription sub-resource is confirmed and its representation is returned. If an AM Event is matched, the response also includes the notification.

            '
          content:
            application/json:
              schema:
                $ref: TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/AmEventsSubscRespData
          headers:
            Location:
              description: 'Contains the URI of the created AM Policy Events Subscription subresource, according to the structure {apiRoot}/3gpp-am-policyauthorization/v1/{afId}/app-am- contexts/{appAmContextId}/events-subscription}

                '
              required: true
              schema:
                type: string
        '200':
          description: 'The modification of the AM Policy Events Subscription subresource is confirmed and its representation is returned. If an AM Event is matched, the response also includes the notification.

            '
          content:
            application/json:
              schema:
                $ref: TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/AmEventsSubscRespData
        '204':
          description: 'The modification of the AM Policy Events Subscription subresource is confirmed without returning additional data.

            '
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '411':
          $ref: TS29122_CommonData.yaml#/components/responses/411
        '413':
          $ref: TS29122_CommonData.yaml#/components/responses/413
        '415':
          $ref: TS29122_CommonData.yaml#/components/responses/415
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
      callbacks:
        amEventNotification:
          '{$request.body#/evSubscs/eventNotifUri}':
            post:
              requestBody:
                description: Contains the information for the notification of an event occurrence.
                required: true
                content:
                  application/json:
                    schema:
                      $ref: TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/AmEventsNotification
              responses:
                '204':
                  description: The receipt of the notification is acknowledged.
                '307':
                  $ref: TS29122_CommonData.yaml#/components/responses/307
                '308':
                  $ref: TS29122_CommonData.yaml#/components/responses/308
                '400':
                  $ref: TS29122_CommonData.yaml#/components/responses/400
                '401':
                  $ref: TS29122_CommonData.yaml#/components/responses/401
                '403':
                  $ref: TS29122_CommonData.yaml#/components/responses/403
                '404':
                  $ref: TS29122_CommonData.yaml#/components/responses/404
                '411':
                  $ref: TS29122_CommonData.yaml#/components/responses/411
                '413':
                  $ref: TS29122_CommonData.yaml#/components/responses/413
                '415':
                  $ref: TS29122_CommonData.yaml#/components/responses/415
                '429':
                  $ref: TS29122_CommonData.yaml#/components/responses/429
                '500':
                  $ref: TS29122_CommonData.yaml#/components/responses/500
                '503':
                  $ref: TS29122_CommonData.yaml#/components/responses/503
                default:
                  $ref: TS29122_CommonData.yaml#/components/responses/default
    delete:
      summary: deletes the AM Policy Events Subscription sub-resource
      operationId: DeleteAmEventsSubsc
      tags:
      - AM Policy Events Subscription
      parameters:
      - name: afId
        in: path
        description: Identifier of the AF
        required: true
        schema:
          type: string
      - name: appAmContextId
        in: path
        description: string identifying the Individual Application AM Context resource.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: 'The deletion of the of the AM Policy Events Subscription subresource is confirmed without returning additional data.

            '
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
components:
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}
externalDocs:
  description: '3GPP TS 29.522 V19.5.0; 5G System; Network Exposure Function Northbound APIs.

    '
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/