CAPIF Access Control Policy

OpenAPI

OpenAPI Version: 3.0.0

info

Title: CAPIF_Access_Control_Policy_API

Description: This API enables the API exposing function to obtain the policy to perform access control on the service API invocations.

Version: "1.0.0"

externalDocs

Description: 3GPP TS 29.222 V15.2.0 Common API Framework for 3GPP Northbound APIs

URL: http://www.3gpp.org/ftp/Specs/archive/29_series/29.222/

servers

URL: '{apiRoot}/access-control-policy/v1'

Variables:

API Root:

Default: https://example.com

Description: apiRoot as defined in subclause 7.5 of 3GPP TS 29.222

paths

/accessControlPolicyList/{serviceApiId}

get:

Description: Retrieves the access control policy list.

Parameters:

- name: serviceApiId

In: path

Description: Identifier of a published service API

Required/Optional: true

Schema:

Type: string

- name: aef-id

In: query

Required/Optional: true

Description: Identifier of the AEF

Schema:

Type: string

- name: api-invoker-id

In: query

Description: Identifier of the API invoker

Schema:

Type: string

- name: supported-features

In: query

Description: To filter irrelevant responses related to unsupported features

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

Responses:

'200' OK.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/accessControlPolicyList'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'

'414': Reference 'TS29122_CommonData.yaml#/components/responses/414'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

components

schemas

accessControlPolicyList

Type: object

Properties:

apiInvokerPolicies:

Type: array

Items:

Reference: '#/components/schemas/ApiInvokerPolicy'

minItems: 0

Description: Policy of each API invoker.

ApiInvokerPolicy

Type: object

Properties:

apiInvokerId:

Type: string

Description: API invoker ID assigned by the CAPIF core function

allowedTotalInvocations:

Type: integer

Description: Total number of invocations allowed on the service API by the API invoker.

allowedInvocationsPerSecond:

Type: integer

Description: Invocations per second allowed on the service API by the API invoker.

allowedInvocationTimeRangeList:

Type: array

Items:

Reference: '#/components/schemas/TimeRangeList'

minItems: 0

Description: The time ranges during which the invocations are allowed on the service API by the API invoker.

Required:

- apiInvokerID

TimeRangeList

Type: object

Properties:

startTime:

Reference: 'TS29122_CommonData.yaml#/components/schemas/DateTime'

stopTime:

Reference: 'TS29122_CommonData.yaml#/components/schemas/DateTime'