This documentation is for WSO2 Identity Server 5.3.0 . View documentation for the latest release.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

For the methods that have a 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.

...

MethodisReadOnly
DescriptionCheck whether the user store is read-only.
Input Parameters

None

Output ParametersA boolean parameter indicating if the user store is read-only or not.
Code Block
languagexml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.ws.um.carbon.wso2.org">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:isReadOnly/>
   </soapenv:Body>
</soapenv:Envelope>

...

Note

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 shown as selected = false.

updateCredential()

...

MethodgetUserClaimValuesForClaims
DescriptionRetrieve the claim values of a user when given a set of claims and a user profile
Input Parameters
ParameterTypeDescription
UsernameStringUsername
Set of ClaimsStringName of the claim
Profile NameStringName of the user profile
Output ParametersArray An array of objects of type ClaimValue which contains the claim mapping between claim URI and claim value

...

MethodlistUsers
DescriptionRetrieves a list of user names upto up to a particular maximum limit.
Input Parameters
ParameterTypeDescription
FilterString

A filter to filter out any users.

Tip

Use the asterisk (*) for filtering as given below.

  • The string (*) returns all the user names. The displayed number of user names depends on the define Max Item List.
  • The string *<string> returns all the user names ending with the given <string>, e.g., the string *abc, will return all the user names ending with abc.
  • The string <string>* returns all the user names starting with the given <string>, e.g., the string abc* will return all the user names starting with abc.
Max Item LimitInteger

The max limit to the number of users that are returned in the list.

Info
  • If the value given is below 0, it will be disregarded and the system configured limit will be taken instead.
  • If the value given is greater than the system configured limit, it will be disregarded and the system configured limit will be taken instead.
Output ParametersA filtered string array of all the user names

...

MethodgetUserClaimValues
DescriptionGet a list of all claim information for a given user name and profile name
Input Parameters
ParameterTypeDescription
UsernameStringUsername of User
Profile NameStringName of the profile
Output ParametersArray An array of objects of type 'claim' which includes all the information of the claims.
Code Block
languagexml
soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://service.ws.um.carbon.wso2.org">
   <soap:Header/>
   <soap:Body>
      <ser:getUserClaimValues>
         <!--Optional:-->
         <ser:userName>nila@wso2support.com</ser:userName>
         <!--Optional:-->
         <ser:profileName>default</ser:profileName>
      </ser:getUserClaimValues>
   </soap:Body>
</soap:Envelope>

...