Get Users

Modified on Wed, 11 Jun at 12:53 PM

Description: 

This API is use to Retrieve list of users OR Details of specific User when user name is given


API Endpoint: 

/ws/userrolemanagement

 

Method: 

POST

 

Header: 

 

Field

Value

SOAPAction

/ws/datasetManagement.wsdl

 

Request:


XML Element

Type

Value

<wsse:Username>

String

Smarten username

<wsse:Password>

String

Smarten user password

<dat: datasetId >

String

Smarten dataset id, you can access it from Smarten Menu – Data – Dataset 


Request Example: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:user="http://www.elegantjbi.com/ws/userrolemanagement">

   <soapenv:Header>

      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">

         <wsse:UsernameToken wsu:Id="UsernameToken-F6E31F57B4C89D14B416914953072216">

            <wsse:Username>username</wsse:Username>

            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>      

         </wsse:UsernameToken>

      </wsse:Security>

   </soapenv:Header>

   <soapenv:Body>

      <user:getUsersRequest>

         <userName>username</userName>

      </user:getUsersRequest>

   </soapenv:Body>

</soapenv:Envelope>

 

Response:  

Return a response with SOAP XML as object. 

 

XML Element 

Type

Value

<ns2:statusCode>

String

Return the API status response

<roleId>

Integer

Role Id of the user

<roleName>

String 

Role name of the user

<username>

String

Name of the user

<personName>

String

Name of the person

<deptName>

String

Department name

<ssdpUser>

Integer

Is ssdp user 1/0

<smartenInsightUser>

Integer

Having smarten insight 

<IsMobileUser>

Integer

Mobile app user

 

Response Example: 

 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

    <SOAP-ENV:Header>

        <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" SOAP-ENV:mustUnderstand="1">

            <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="XWSSGID-1747337693638-1069532304">

                <wsse:Username>user</wsse:Username>

                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest">xZfupseoeUkiUZTcpBkzavfayB4=</wsse:Password>

                <wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">j6dZDhEDQ4sFAfXXHNI25zd8</wsse:Nonce>

                <wsu:Created>2025-06-03T13:38:51.353Z</wsu:Created>

            </wsse:UsernameToken>

        </wsse:Security>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <ns3:getUsersResponse xmlns:ns3="http://www.elegantjbi.com/ws/userrolemanagement">

            <status>

                <statusCode>Success</statusCode>

            </status>

            <users>

                <userTypeBI>1</userTypeBI>

                <userActive>true</userActive>               <password>$2a$10$Oj342tcippu4TLPhlHv2XuFA2Ogc3cyavAzJJaDU0KjRZjVzi6Tgq</password>

                <emailId/>

                <roleNames>

                    <roleId>80</roleId>

                    <roleName>roleName</roleName>

                    <roleDesc/>

                </roleNames>

      <username>userName</username>

                <personName>personName</personName>

                <deptName>deptName</deptName>

                <ssdpUser>true</ssdpUser>

                <smartenInsightuser>1</smartenInsightuser>

                <isMobileUser>true</isMobileUser>

            </users>

        </ns3:getUsersResponse>

    </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

 

Postman Example: 

 

You can import the example below into Postman. 

 

curl --location 'https://<SMARTENURL>/smarten/ws/RoleManagementService' \

--header 'Content-Type: text/xml' \

--header 'Cookie: JSESSIONID=EtzEQQbsvBwacW1IovMoH2HB0_8ZK8LgiCDHrYgL.ip-172-31-8-13' \

--data '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:user="http://www.elegantjbi.com/ws/userrolemanagement">

   <soapenv:Header>

      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">

         <wsse:UsernameToken wsu:Id="UsernameToken-F6E31F57B4C89D14B416914953072216">

            <wsse:Username>username</wsse:Username>

            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>

       </wsse:UsernameToken>

      </wsse:Security>

   </soapenv:Header>

   <soapenv:Body>

      <user:getUsersRequest>

         <userName>username</userName>

      </user:getUsersRequest>

   </soapenv:Body>

</soapenv:Envelope>'


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article