Menu
Latest
12 meetings · Prague, Jeju · 12–16 Oct
Reports
RAN1#126-bis · SA2#177

Glossary term · Services

API invoker profile

API Invoker Profile

Services →

API invoker profile is a set of information associated with an API invoker that enables it to use CAPIF APIs and service APIs, defining the invoker's identity, permissions, and access rights within the CAPIF framework.

Introduced
Rel-15
Where
Services › IMS
Specifications
2 specs
API invoker profile Description Purpose What changed Neighbours Specifications

Description

The API Invoker Profile is a fundamental concept in the 3GPP Common API Framework (CAPIF), defined in 3GPP TS 23.222. CAPIF provides a unified framework for exposing and consuming APIs in 5G networks, enabling service-based architecture (SBA) communication between network functions and external applications. The API Invoker Profile represents the set of information associated with an API invoker—an entity that consumes CAPIF APIs or service APIs—that allows it to utilize these APIs securely and according to its authorized permissions.

Architecturally, the API Invoker Profile is managed by the CAPIF Core Function (CCF), which acts as the central authority for API exposure and discovery. When an API invoker registers with the CCF, it provides information such as its identity, authentication credentials, and the types of APIs it intends to access. The CCF then creates and stores an API Invoker Profile for that invoker. This profile includes details like the invoker's identifier, authentication method (e.g., certificate-based or OAuth2), authorization information, and any specific access control policies. The profile is used by the CCF to authenticate and authorize the invoker when it attempts to discover or invoke APIs.

The API Invoker Profile is closely tied to the API Invoker Registration procedure. During registration, the invoker supplies its profile information, which may include its public key or certificate for mutual authentication, the list of API types it is interested in, and its supported security protocols. The CCF validates this information and stores it. Subsequently, when the invoker requests an API discovery or invocation, the CCF checks the invoker's profile to ensure that the invoker is authorized to access the requested API and that the invocation complies with the profile's constraints (e.g., rate limits, allowed service areas).

The profile also plays a role in the API Invoker's lifecycle management. If the invoker's permissions change or if it needs to update its credentials, it can update its profile with the CCF. The CCF may also revoke or suspend an invoker's profile if necessary, for example, due to security violations. This dynamic management ensures that API access remains secure and aligned with operator policies.

In summary, the API Invoker Profile is a key enabler for secure and controlled API exposure in 5G networks. It provides the necessary identity and authorization context for API invokers, allowing the CAPIF framework to enforce access control and ensure that only authorized entities can consume network APIs. This is essential for supporting diverse use cases, from internal network function communication to external third-party application integration, while maintaining the integrity and security of the network.

Purpose & Motivation

The API Invoker Profile exists to solve the problem of securely managing API access in a multi-tenant, multi-provider 5G ecosystem. Before CAPIF, API exposure was often ad-hoc and lacked a standardized way to authenticate and authorize API consumers. The profile provides a standardized container for an API invoker's identity and permissions, enabling consistent security enforcement across different APIs and domains. It addresses the need for fine-grained access control, allowing operators to define precisely which APIs an invoker can use and under what conditions. This is crucial for preventing unauthorized access and for enabling new business models where API access is granted based on service level agreements. The profile also simplifies the integration of external applications by providing a clear registration and authentication mechanism, reducing the complexity and time required to onboard new partners.

What changed in its specifications

The latest release-to-release comparison of specifications that define API invoker profile. Each summary describes the whole specification, not only this term.

TS 23.222Rel-18 → Rel-19

Rel-19 adds CAPIF Phase 3 procedures for unpublishing service APIs between interconnected core functions, revoking API invoker and resource owner authorization, open discovery of service APIs, and UE-hosted API invoker access to resources owned by other UEs.

Full comparison in TS 23.222 →

Release Timeline

Evolution Across Releases

An overview written from the defining specifications, not a verified change history. For the exact text, open the specifications listed below.

Rel-15 Initial

Initial definition introduced with CAPIF architecture. The API Invoker Profile was established as the set of information allowing an API invoker to utilize CAPIF APIs and service APIs, forming the basis for secure API exposure in 5G.

Definition carried over unchanged from Rel-15. The concept remained stable as CAPIF continued to be refined.

Definition carried over unchanged from Rel-16. No changes to the core meaning of the API Invoker Profile.

Definition carried over unchanged from Rel-17. The term continued to be used consistently in CAPIF specifications.

Definition carried over unchanged from Rel-18. No modifications to the definition text.

Definition carried over unchanged from Rel-19. The API Invoker Profile remains a stable concept in the 3GPP vocabulary.

Defining Specifications

3GPP specifications that define or reference API invoker profile, with the latest known release. Sourced from the 3GPP document catalog — see methodology.

SpecificationTitleRelease
TS 23.222 vk10 Common API Framework (CAPIF) Rel-20 read
TS 23.722 vf10 Common API Framework (CAPIF) for 3GPP Northbound APIs Rel-15 read