User Role Permission Management API
REST API
Overview
A user role is defined as the entity that defines a set of privileges covering various functions and/or manageable assets. When a user is assigned a given role then it is actually allocated all the privileges defined for that role type and the corresponding permissions are created for that user.
Versioning NoteThis API has progressed to TMF672 v5.1 RC3. Both v5.0 (Preview) and v5.1(Preview) will remain available to ensure traceability for members who may have explored the earlier v5.0 preview assets. As with all preview APIs, these assets are provided for early evaluation and may evolve prior to a stable release.
Version history
08-May-2026 docker-compose has been expanded to enable proxy settings by default, simplifying CTK execution in corporate HTTP proxy environments where this previously required in‑house configuration. README files have been updated to document proxy usage. Failed HTML reports can now be opened directly in a browser, and HTML reports now include headers identifying the API and CTK version used, improving certification clarity and traceability.
08-Apr-2026 – TMF672 User Role Permission Management API v5.1.0 Stable release: Open API Specification (OAS), User Guide, Conformance Profile, Postman Collection, CTK and RI https://www.tmforum.org/open-digital-architecture/open-apis/user-role-permission-management-api-TMF672/v5.1
03-Mar-2026 TMF672 v5.1.0 RC3 Preview release: Open API Specification (OAS), User Guide, Conformance Profile, and Postman Collection. Includes a fix addressing ambiguity caused by identical oneOf schemas in the PartyRefOrPartyRoleRef definition. A restriction has been added to the allowed value of @type, enabling broader tooling compatibility without altering the API signatures.
09 Feb 2026 TMF672 v5.1.0 release: Open API Specification (OAS), User Guide, Conformance Profile
20 Dec 2024 TMF672 v5.0.0 release: User guide v5.0.1 and Conformance profile v5.0.1 updates made.
14 Nov 2024 TMF672 v5.0.0 release: OAS and User guide fixes including example and two minor fixes in schema.
v4.0.0
V4.0 15-May-2026 – CTK updated docker-compose has been expanded to enable proxy settings by default, simplifying CTK execution in corporate HTTP proxy environments. README files have been updated to document proxy configuration.
07-Nov-2024 TMF672 v4.1.0 CTK file fix Mac-Linux-RUNCTK.sh modified to remove syntax errors. No impact to awarded Open API Conformance certifications.
API No.
TMF672
Stable version
v4.0
This Version
v5.1
Types
RESTful
DOMAIN
Common
IPR MODE
Apache 2.0 unless stated
Release Date
08 May 2026
API assets v5.1
OPEN API SPECIFICATION
Postman collection
API USER GUIDE (RAND)
Sample implementation code
CTK
Conformance Profile (RAND)
Components
ODA Components are the software building blocks of a cloud native digital service provider’s network and IT systems, designed for plug-and-play interoperability in a standardized deployment environment (the ODA Canvas). This is a list of ODA Components that expose this API either as a Mandatory or Optional API.
Mandatory