From 5.4.0 onwards, SCIM 2.0 REST APIs are supported out-of-the-box with
WSO2 Identity Server and is recommended for user store management. For
more information on using the SCIM 2.0 REST APIs instead of the SOAP
service given below, see Using the SCIM 2.0 REST
APIs.
This section guides you through invoking and working with the
RemoteUserStoreManagerService and the operations you can work with
in this service.
RemoteUserStoreManagerService is an admin service of
the WSO2 Carbon platform. As admin services are secured to prevent
anonymous invocations, you cannot view the WSDL of the admin service by
default. Follow the steps below to view and invoke it:
Set the bellow configuration in
<IS_HOME>/repository/conf/deployment.toml file.
For more information on WSO2 admin services and how to invoke an admin
service using either SoapUI or any other client program, see Calling
Admin Services from
Apps
section in WSO2 Carbon documentation.
Operations included in the API and sample requests¶
The following operations are available in the
RemoteUserStoreManagerService.
Note
For the methods that have profile name as an input parameter, you
can also pass null for the parameter in which case the default profile
will then be considered instead.
Note: This operation retrieves a list of all the users. The users
assigned to the specified role will be indicated in the list. Users
belonging to the role are shown as selected = true and users not
belonging to the role are show as selected = false.
Retrieve the claim values of a user when given a set of claims and a user profile
Input Parameters
Parameter
Type
Description
Username
String
Username
Set of Claims
String
Name of the claim
Profile Name
String
Name of the user profile
Output Parameters
Array of objects of type ClaimValue which contains the claim mapping between claim URI and claim value
<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:ser="http://service.ws.um.carbon.wso2.org"><soapenv:Header/><soapenv:Body><ser:getUserClaimValuesForClaims><!--Optional:--><ser:userName>[email protected]</ser:userName><!--Zero or more repetitions:--><ser:claims>country</ser:claims><!--Optional:--><ser:profileName>[email protected]</ser:profileName></ser:getUserClaimValuesForClaims></soapenv:Body></soapenv:Envelope>
<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:ser="http://service.ws.um.carbon.wso2.org"><soapenv:Header/><soapenv:Body><ser:deleteUserClaimValues><!--Optional:--><ser:userName>[email protected]</ser:userName><!--Zero or more repetitions:--><ser:claims>http://wso2.org/claims/organization</ser:claims><ser:claims>http://wso2.org/claims/country</ser:claims><!--Optional:--><ser:profileName>default</ser:profileName></ser:deleteUserClaimValues></soapenv:Body></soapenv:Envelope>
Properties of the user (claim mapping) as a mapping
Profile Name
String
Name of the profile
Output Parameters
None
<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:ser="http://service.ws.um.carbon.wso2.org"xmlns:xsd="http://common.mgt.user.carbon.wso2.org/xsd"><soapenv:Header/><soapenv:Body><ser:addUser><!--Optional:--><ser:userName>nilasini</ser:userName><!--Optional:--><ser:credential>admin</ser:credential><!--Zero or more repetitions:--><ser:roleList>teacher</ser:roleList><ser:roleList>Doctor</ser:roleList><!--Zero or more repetitions:--><ser:claims><!--Optional:--><xsd:claimURI>http://wso2.org/claims/country</xsd:claimURI><!--Optional:--><xsd:value>England</xsd:value></ser:claims><ser:claims><!--Optional:--><xsd:claimURI>http://wso2.org/claims/organization</xsd:claimURI><!--Optional:--><xsd:value>Intuit</xsd:value></ser:claims><!--Optional:--><ser:profileName>default</ser:profileName><!--Optional:--><ser:requirePasswordChange>false</ser:requirePasswordChange></ser:addUser></soapenv:Body></soapenv:Envelope>
<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:ser="http://service.ws.um.carbon.wso2.org"xmlns:xsd="http://dao.service.ws.um.carbon.wso2.org/xsd"><soapenv:Header/><soapenv:Body><ser:addRole><!--Optional:--><ser:roleName>hrManager</ser:roleName><!--Zero or more repetitions:--><ser:userList>[email protected]</ser:userList><ser:userList>venilope</ser:userList><ser:userList>[email protected]</ser:userList><!--Zero or more repetitions:--><ser:permissions><!--Optional:--><xsd:action>ui.execute</xsd:action><!--Optional:--><xsd:resourceId>/permission/admin/manage/identity</xsd:resourceId></ser:permissions></ser:addRole></soapenv:Body></soapenv:Envelope>
<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:ser="http://service.ws.um.carbon.wso2.org"xmlns:xsd="http://common.mgt.user.carbon.wso2.org/xsd"><soapenv:Header/><soapenv:Body><ser:setUserClaimValues><!--Optional:--><ser:userName>[email protected]</ser:userName><!--Zero or more repetitions:--><ser:claims><!--Optional:--><xsd:claimURI>http://wso2.org/claims/organization</xsd:claimURI><!--Optional:--><xsd:value>wso2</xsd:value></ser:claims><ser:claims><!--Optional:--><xsd:claimURI>http://wso2.org/claims/country</xsd:claimURI><!--Optional:--><xsd:value>srilanka</xsd:value></ser:claims><!--Optional:--><ser:profileName>default</ser:profileName></ser:setUserClaimValues></soapenv:Body></soapenv:Envelope>