Open APIs

 View Only
  • 1.  Which TMF API is the best fit for customer identity provisioning ?

    TM Forum Member
    Posted Jan 18, 2019 10:15
    Hi - 

    I am trying to implement typical customer identity provisioning use cases , that includes the following :

    1. Creating a customer identity in our Identity management platforms on a  service connect 
    2. Modifying existing customer identity on a service connect / modify 
    3. Deleting customer entity on a service disconnect 
    What would be the best API for my needs ?

    ------------------------------
    Sadhana Venkatesan

    ------------------------------


  • 2.  RE: Which TMF API is the best fit for customer identity provisioning ?

    TM Forum Member
    Posted Jan 20, 2019 14:07
    We don't currently have a user management API design in the Open API, we have a skeleton representation of a user entity in the user roles API https://projects.tmforum.org/wiki/display/PUB/TMF672+User+Roles+and+Permissions+API+REST+Specification+R17.0.1.

    A possible approach would be for you to extend the Customer API https://projects.tmforum.org/wiki/display/PUB/TMF629+Customer+Management+API+REST+Specification+R18.0.1 by adding a relationship from Customer to User (1 - 0..1 or 1 - 0..*), and then provision users in the IDM as part of POST or PATCH on Customer - in this approach your implementation of the Customer API is hiding the IDM details from the consumer.

    But if you think that TMF Open API can be enhanced by adding a user management API, feel free to make a contribution.

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    ------------------------------



  • 3.  RE: Which TMF API is the best fit for customer identity provisioning ?

    TM Forum Member
    Posted Jun 19, 2023 06:09
    Edited by Chetan Patel Jun 21, 2023 05:41

    Hi @Jonathan Goldberg 

    We are not getting customer identity input place holder/schema object under TMF629. Can you please suggest which schema object/place holder will be better to map identity inputs like idno, idtype, validity duration(start & end date)?

    Need to incorporate below object to TMF compliance in TMF629

    customerIdentity/    Complex    [1..n]
                  idNo    String    [1..1]
                  idType    String    [1..1]              
                  validFor/    Complex    [1..1]                     
                         endDate    dateTime    [1..1]

    Will it be better to extend TMF629 with below object ?



    ------------------------------
    Chetan Patel
    Tech Mahindra Limited
    ------------------------------



  • 4.  RE: Which TMF API is the best fit for customer identity provisioning ?

    TM Forum Member
    Posted Jun 22, 2023 10:03

    If we are talking about identifications issued by jurisdictions (e.g. governments), these are part of Party, not of Customer. Specifically we have

    • IndividualIdentification (for people, such as passport, driving license, SSN, government-issued ID card, etc.)
    • OrganizationIdentification (for organizations, such as company number in register of companies, NGO ID in register of charities, etc.)

    Hope it helps.



    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------



  • 5.  RE: Which TMF API is the best fit for customer identity provisioning ?

    TM Forum Member
    Posted Jun 22, 2023 11:50

    Yes, we are going on right track. Here it will be IndividualIdentification but challenge is need to send this information during customer creation. So please suggest which option will be better to fulfil my requirement?

    Option 1 : 

    Options 2 :



    ------------------------------
    Chetan Patel
    Tech Mahindra Limited
    ------------------------------



  • 6.  RE: Which TMF API is the best fit for customer identity provisioning ?

    TM Forum Member
    Posted Jun 22, 2023 11:57

    Customer creation is a complex flow that needs to be orchestrated. You would first create the Individual who plays the role of Customer. As part of Individual creation you will populate the IndividualIdentification sub-entity with the data that the customer gave you. You would also presumably need to create and/or validate at least one address for the customer.

    After this, assuming success, you would create the Customer, setting the engagedParty reference to the Individual you created before, and the Place to the address you created before.

    Finally, you would likely create a BillingAccount for the Customer, and set the account.relatedParty to the Customer.

    Hope it helps



    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------



  • 7.  RE: Which TMF API is the best fit for customer identity provisioning ?

    TM Forum Member
    Posted Jun 22, 2023 16:45

    Thanks a lot for brief explanation. 

    Jonathan, Your explanation exact match if we will go with individual system call and orchestrate full flow.

    Here we have limitation that we can't follow orchestrate & needs to pass all the information in single API call<at customer creation time only> while all the orchestration will be done by middleware application. <As I have explained earlier, I have to pass information to only middleware and need to achieve TMF compliance at my side>

    So here I have only option to pass all the matching information in TMF standard data model instead of orchestration way.   



    ------------------------------
    Chetan Patel
    Tech Mahindra Limited
    ------------------------------



  • 8.  RE: Which TMF API is the best fit for customer identity provisioning ?

    TM Forum Member
    Posted Jun 23, 2023 01:25

    This is an implementation choice that you can make, Chetan. But TMF APIs will not help you here; there are so many different scenarios that could involve composite APIs that it's not feasible to have APIs for them all. TMF Open APIs provide the building blocks (if you like) on which you can develop your integration scenarios.



    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------



  • 9.  RE: Which TMF API is the best fit for customer identity provisioning ?

    TM Forum Member
    Posted Jun 23, 2023 02:01

    Ok, Thanks Jonathan. Let me try to go with block creation if middleware allow me to do it.

    But it's really nice to hear from you about core concept of TMF API.



    ------------------------------
    Chetan Patel
    Tech Mahindra Limited
    ------------------------------