TMFOP003 Identity Config Operators

Watch: Part 3, Authentication and Authorization in the ODA Canvas

An 8:45 video in the ODA Canvas training series. Watch it with chapters and a transcript, or on YouTube.

Ensures every ODA Component’s roles and permissions are correctly registered in the enterprise Identity Management system. It eliminates manual access control provisioning by automatically translating each component’s declared security requirements into the appropriate roles, so that the right people and systems have the right access — consistently and at scale. Multiple identity provider implementations are supported.


Each ODA Component includes a declarative definition of its requirements for creating Roles and Permissions in the Identity Management system.

A Canvas platform can use any Identity Management system. IdentityConfig Operators automate the configuration of whatever Identity Management service is used.

The Component Operator takes the Component custom resource and extracts the identity configuration requirements into an IdentityConfig resource. The IdentityConfig Operator is a class of Canvas Operator that then manages the lifecycle of these IdentityConfig resources. In a given Canvas implementation, you can implement any Identity Management system by installing the corresponding IdentityConfig operator as part of the Canvas installation.

At present, there are IdentityConfig Operators for the following:

IdentityConfig Data Model

The IdentityConfig resource describes the permissions a component would like to configure in the Identity Management system. The component can provide static definitions in the component itself, or the component can dynamically manage the permissions by exposing a TM Forum Open-API.

IdentityConfig with statically defined roles.

apiVersion: oda.tmforum.org/v1
kind: IdentityConfig
metadata:
  name: ctk-productcatalogmanagementproductcatalogmanagement # Kubernetes resource name for the instance of the IdentityConfig
spec:
  canvasSystemRole: CanvasRole
  componentRole:
  - description: Product Catalogue Administrator
    name: pcadmin
  - description: Catalogue Owner for catalogue 1
    name: cat1owner
  - description: Catalogue Owner for catalogue 2
    name: cat2owner

IdentityConfig with dynamically defined roles. At present, this uses the TMF672 User Roles and Permissions API, while support for the TMF669 Party Role Management API will be deprecated in the future.

apiVersion: oda.tmforum.org/v1
kind: IdentityConfig
metadata:
  name: ctk-productcatalogmanagementproductcatalogmanagement # Kubernetes resource name for the instance of the IdentityConfig
spec:
  canvasSystemRole: CanvasRole
  permissionSpecificationSetAPI:
    implementation: ctk-permissionspecapi
    path: /ctk-productcatalogmanagement/rolesAndPermissionsManagement/v5
    port: 8080
apiVersion: oda.tmforum.org/v1
kind: IdentityConfig
metadata:
  name: ctk-productcatalogmanagementproductcatalogmanagement # Kubernetes resource name for the instance of the IdentityConfig
spec:
  canvasSystemRole: CanvasRole
  partyRoleAPI:
    implementation: ctk-partyroleapi
    path: /ctk-productcatalogmanagement/tmf-api/partyRoleManagement/v4
    port: 8080

Sequence Diagrams

See UC005-Configure-Clients-and-Roles for details of the Identity Management System use case.