Finding the replacement of the SOAP APIs for WSO2 identity server for 6.0.0 version

Shweta Nikam 0
Viewed 54

As part of WSO2 identity server 6.0.0, SOAP APIs are deprecated and recommended to use REST-based APIs. We are using RemoteUserStoreManagerService.wsdl and UserIdentityManagementAdminService.wsdl SOAP APIs in our project, want to replace the SOAP APIs with recommended REST APIs. Can you help us to find the list of REST APIs to replace RemoteUserStoreManagerService.wsdl and UserIdentityManagementAdminService.wsdl SOAP APIs. The APIs document is not clear.

We are unable to find the replacement for the claim management APIs which are specific to user.The APIs which are provided for the Claim management are not user specific, we want to retrieve/create/delete the claims by passing username or userid in the request payload. Can you please provide the details that are such APIs available for the claim management.

wso2
2 Answers

The REST API that you have mentioned matches the ClaimMetadataManagementService.wsdl https://is.docs.wso2.com/en/5.11.0/develop/managing-claims-with-apis/

The only available REST API to manage user claims (retrieving, updating, deleting) is SCIM 2.0 Users APIs https://is.docs.wso2.com/en/latest/apis/scim2-rest-apis/#/Users%20Endpoint/getUser

The thing you have to keep in mind is that SCIM is a protocol that is used for user management. Even though you directly used the local claim URIs in SOAP services to manage user claims, in SCIM API calls you to have to use the respective SCIM claim that is mapped to the local claim.

Check the SCIM Claim Dialects by navigating to management console -> Main -> Identity -> Claims -> List. There you can find the SCIM claim to local claim mapping

eg: Get Specific user's name, username claims. Required attributes should be added to attributes param based on the SCIM protocol:

GET https://localhost:9443/scim2/Users/<user-id>?attributes=username,name

Add user claims: Refer https://is.docs.wso2.com/en/latest/apis/scim2-patch-operations/#add-user-attributes and https://medium.com/p/1c43bb218658

Delete user claims: Refer https://is.docs.wso2.com/en/latest/apis/scim2-patch-operations/#remove-user-attributes and https://medium.com/p/1c43bb218658

Anuradha Karunarathna0

A similar issue was raised here. Check the first answer.

The doc that you have referred is to manage the claims in general. Refer to the introduction paragraph.

The API overview page contains all the information about all the APIs you need. The following image shows the APIs needed to mange users, roles and groups (More than what you have asked in the question).

enter image description here

NOTE: Better not to use SCIM1.1

Sominda Gamage0
Related