API Reference — Local user management

Overview

The Redtrust API provides multiple methods. This documentation highlights some of the most relevant methods for users who need to perform key operations to manage local users.

Before you start

Before testing these methods, you need to configure SOAP UI.

important

The <!--Optional:--> comments shown in SOAP requests are automatically generated and may incorrectly mark required fields as optional.

This documentation explicitly indicates which fields are required or optional. Always rely on this documentation.

Create local user

AddLocalUser

This method lets you add new users.

Name	Type	Required	Description
domainId	integer	Yes	Domain ID. Find the value in ListDomains.
username	string	Yes	Username. Accepts letters (A-Z, a-z), numbers (0-9) and this characters -, _ and . to be used as separators.
name	string	Yes	Full name of the user. It can include spaces and accented characters.
password	string	Yes	Password of at least 3 characters. Any characters are allowed.
email	string	Yes	It has to be a valid email format.
forceChangePassword	boolean	Yes	Forces the user to change the password the first time it authenticates to Redtrust.
active	boolean	Yes	Indicates whether the user account is active. If true, the user can log in; if false, the account is disabled.

Request

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header/>
    <soap:Body>
        <urn:AddLocalUser>
            <urn:domainId>1</urn:domainId>
            <urn:username>maria.lopez</urn:username>
            <urn:name>maria</urn:name>
            <urn:password>123maria</urn:password>
            <urn:email>maria@test.com</urn:email>
            <urn:forceChangePassword>0</urn:forceChangePassword>
            <urn:active>1</urn:active>
        </urn:AddLocalUser>
    </soap:Body>
</soap:Envelope>

Response

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/AddLocalUserResponse</a:Action>
    </s:Header>
    <s:Body>
        <AddLocalUserResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
                <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
                <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
                <ResultData i:type="c:int" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult" xmlns:c="http://www.w3.org/2001/XMLSchema">1007</ResultData>
            </Result>
        </AddLocalUserResponse>
    </s:Body>
</s:Envelope>

Update local user

EditLocalUser

This method updates an existing local user. The example shows a change in the name parameter.

Name	Type	Required	Description
domainId	integer	Yes	ID of the domain where the user exists. Find the value in ListDomains.
userId	string	Yes	ID of the user you want to update. Find the value in ListDomainUserIds.
name	string	No*	Full name of the user. It can include spaces and accented characters.
password	string	No	Password of at least 3 characters. Any characters are allowed. To update it you have to provide the name and email. It must be at least 3 characters long. Any characters are allowed.
email	string	No*	To update it you have to provide the name. It has to be a valid email format.
forceChangePassword	boolean	Yes	Forces the user to change the password the first time it authenticates to Redtrust. To update it you have to provide the name and email.
active	boolean	Yes	Defines whether the user account is active. To update it you have to provide the name and email.

(*) Required to update some parameters.

Request

   <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
      <soap:Header/>
      <soap:Body>
         <urn:EditLocalUser>
            <urn:domainId>1</urn:domainId>
            <urn:userId>2</urn:userId>
            <urn:name>Betty Smith</urn:name>
            <urn:password></urn:password>
            <urn:email></urn:email>
            <urn:forceChangePassword>0</urn:forceChangePassword>
            <urn:active>1</urn:active>
         </urn:EditLocalUser>
      </soap:Body>
   </soap:Envelope>

Response

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
   <s:Header>
      <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/EditLocalUserResponse</a:Action>
   </s:Header>
   <s:Body>
      <EditLocalUserResponse xmlns="urn:evolium:redtrust:administration:ws">
         <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
            <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
            <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
         </Result>
      </EditLocalUserResponse>
   </s:Body>
</s:Envelope>

ChangeUsersStatus

Change the status of one or more users (active or inactive).

Name	Type	Required	Description
domainId	integer	Yes	Find the value in ListDomains.
userId	string	Yes	ID of the user you want to update. Find the value in ListDomainUserIds. It can be an array as shown in the example.
status	boolean	Yes	Status of the user, active (1) or inactive (0).

Request

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
   <soap:Header/>
   <soap:Body>
      <urn:ChangeUsersStatus>
         <urn:domainId>1</urn:domainId>
         <urn:userIds>
            <!--Zero or more repetitions:-->
            <arr:int>1011</arr:int>
            <arr:int>1012</arr:int>
            <arr:int>1013</arr:int>
         </urn:userIds>
         <urn:status>1</urn:status>
      </urn:ChangeUsersStatus>
   </soap:Body>
</soap:Envelope>

Response

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
   <s:Header>
      <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/ChangeUsersStatusResponse</a:Action>
   </s:Header>
   <s:Body>
      <ChangeUsersStatusResponse xmlns="urn:evolium:redtrust:administration:ws">
         <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
            <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
            <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
         </Result>
      </ChangeUsersStatusResponse>
   </s:Body>
</s:Envelope>

Delete a user

DeleteUser

Deletes one or multiple users.

Name	Type	Required	Description
domainId	integer	Yes	ID of the domain where the user exists. Find the value in ListDomains.
userId	integer	Yes	ID of the user you want to edit. Find the value in ListDomainUserIds. You can add an array as shown in the example.

Request

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
   <soap:Header/>
   <soap:Body>
      <urn:DeleteUsers>
         <urn:domainId>1</urn:domainId>
         <urn:userIds>
            <!--Zero or more repetitions:-->
            <arr:int>1006</arr:int>
            <arr:int>1010</arr:int>
         </urn:userIds>
      </urn:DeleteUsers>
   </soap:Body>
</soap:Envelope>

Response

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
   <s:Header>
      <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/DeleteUsersResponse</a:Action>
   </s:Header>
   <s:Body>
      <DeleteUsersResponse xmlns="urn:evolium:redtrust:administration:ws">
         <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
            <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
            <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
         </Result>
      </DeleteUsersResponse>
   </s:Body>
</s:Envelope>

Retrieve user information

ListUsersInDomain

Provides a list of users in a domain.

Name	Type	Required	Description
domainId	integer	Yes	ID of the domain where the user exists. Find the value in ListDomains.
filter	string	No	When empty, it lists all users. Alternatively, add the username or email you need to filter the results.

Request

   <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
      <soap:Header/>
      <soap:Body>
         <urn:ListUsersInDomain>
            <urn:filter>john</urn:filter>
            <urn:domainId>1</urn:domainId>
         </urn:ListUsersInDomain>
      </soap:Body>
   </soap:Envelope>

Response

   <s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
      <s:Header>
         <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/ListUsersInDomainResponse</a:Action>
      </s:Header>
      <s:Body>
         <ListUsersInDomainResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
               <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
               <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
               <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">The operation has been successfully completed.</ResultMessage>
               <ResultData i:type="b:ArrayOfUserView" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">
                  <b:UserView>
                     <b:consumeLicense>false</b:consumeLicense>
                     <b:domain>local.users</b:domain>
                     <b:email>john@test.com</b:email>
                     <b:friendlyName>john</b:friendlyName>
                     <b:groupType>USER</b:groupType>
                     <b:lastCertificateUsage i:nil="true"/>
                     <b:passwordExpirationDate i:nil="true"/>
                     <b:status>true</b:status>
                     <b:type>LOCAL_USER</b:type>
                     <b:uid>USER:1007@local.users</b:uid>
                     <b:userHandler>1007</b:userHandler>
                     <b:username>john.smith</b:username>
                  </b:UserView>
               </ResultData>
               <TotalItems xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">1</TotalItems>
            </Result>
         </ListUsersInDomainResponse>
      </s:Body>
   </s:Envelope>         

ListDomains

Get a list of domains.

Name	Type	Required	Description
filter	string	No	When empty, it lists all domains. Alternatively, add the domain name for which you need the ID.

Request

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
   <soap:Header/>
   <soap:Body>
      <urn:ListDomains>
         <urn:filter>local.users</urn:filter>
      </urn:ListDomains>
   </soap:Body>
</soap:Envelope>

Response

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
   <s:Header>
      <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/ListDomainsResponse</a:Action>
   </s:Header>
   <s:Body>
      <ListDomainsResponse xmlns="urn:evolium:redtrust:administration:ws">
         <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
            <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
            <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">The operation has been successfully completed.</ResultMessage>
            <ResultData i:type="b:ArrayOfDomainView" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">
               <b:DomainView>
                  <b:alias>local.users</b:alias>
                  <b:allowPersonalArea>false</b:allowPersonalArea>
                  <b:allowUploadCerts>false</b:allowUploadCerts>
                  <b:allowedUsers>0</b:allowedUsers>
                  <b:domainPartners xmlns:c="http://schemas.datacontract.org/2004/07/RTCommonModels.Enums"/>
                  <b:id>1</b:id>
                  <b:isExternal>false</b:isExternal>
                  <b:numUsers>5</b:numUsers>
                  <b:schema>LOCAL_USER</b:schema>
                  <b:sharepointAccess>false</b:sharepointAccess>
                  <b:webSignatureAccess>false</b:webSignatureAccess>
               </b:DomainView>
            </ResultData>
            <TotalItems xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">1</TotalItems>
         </Result>
      </ListDomainsResponse>
   </s:Body>
</s:Envelope>

ListDomainUserIds

Get a list of user IDs in a domain.

Name	Type	Required	Description
domainId	string	Yes	ID of the domain where the user exists. Find the value in ListDomains.
viewType	string	Yes	'VIEW_ALL', 'VIEW_ACTIVE', 'VIEW_INACTIVE', 'VIEW_CONSUME_LICENSE', 'VIEW_NO_CONSUME_LICENSE'
filter	string	No	When empty, it lists all domains. Alternatively, enter the domain name for which you need the ID.

Request

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
   <soap:Header/>
   <soap:Body>
      <urn:ListDomainUserIds>
         <urn:domainId>1</urn:domainId>
         <urn:viewType>VIEW_ALL</urn:viewType>
         <urn:filter></urn:filter>
      </urn:ListDomainUserIds>
   </soap:Body>
</soap:Envelope>

Response

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
   <s:Header>
      <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/ListDomainUserIdsResponse</a:Action>
   </s:Header>
   <s:Body>
      <ListDomainUserIdsResponse xmlns="urn:evolium:redtrust:administration:ws">
         <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
            <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
            <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">A operação foi concluída com sucesso.</ResultMessage>
            <ResultData i:type="c:ArrayOfint" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult" xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
               <c:int>2</c:int>
               <c:int>1005</c:int>
               <c:int>1006</c:int>
               <c:int>1007</c:int>
            </ResultData>
            <TotalItems xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">4</TotalItems>
         </Result>
      </ListDomainUserIdsResponse>
   </s:Body>
</s:Envelope>

warning

If you get any errors when making a request, check your SOAP API configuration and make sure you authenticated with the correct credentials (for example, with the admin user).