API reference — Local user management

Overview

The Redtrust administration API includes methods for managing the complete lifecycle of local users: creating them, updating them, changing their status, unblocking them, and deleting them.

Before you start

Before testing these methods, you need to set up SoapUI.

important

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

This documentation explicitly states which fields are required or optional. Always trust this documentation.

Create a local user

AddLocalUser

Creates a new local user in a domain.

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 the characters -, _ and . as separators.
name	string	Yes	Full name of the user. Can include spaces and accented characters.
password	string	Yes	Password of at least 3 characters. Any characters are allowed.
email	string	Yes	Must be a valid email format.
forceChangePassword	boolean	Yes	Forces the user to change the password the first time they authenticate to Redtrust.
active	boolean	Yes	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>

The ResultData field contains the ID of the new user.

Update a local user

EditLocalUser

Updates an existing local user. Fields not included in the request retain their current value.

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 update. Find the value in ListDomainUserIds.
name	string	No*	Full name of the user. 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.
email	string	No*	To update it you have to provide the name. Must be a valid email format.
forceChangePassword	boolean	Yes	Forces the user to change the password the first time they authenticate to Redtrust. To update it you have to provide the name and email.
active	boolean	Yes	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>

Enable or disable users

ChangeUsersStatus

Changes the active or inactive status of one or more users at once.

Name	Type	Required	Description
domainId	integer	Yes	Domain ID. Find the value in ListDomains.
userIds	array of integers	Yes	IDs of the users to update. Find the values in ListDomainUserIds. You can send multiple IDs as shown in the example.
status	integer	Yes	Status to apply: 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>

Unblock a local user

UnblockLocalUser

Unblocks a local user who has been locked out after too many failed authentication attempts.

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 to unblock. Find the value in ListDomainUserIds.

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:UnblockLocalUser>
            <urn:domainId>1</urn:domainId>
            <urn:userId>1007</urn:userId>
        </urn:UnblockLocalUser>
    </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/UnblockLocalUserResponse</a:Action>
    </s:Header>
    <s:Body>
        <UnblockLocalUserResponse 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:boolean" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult" xmlns:c="http://www.w3.org/2001/XMLSchema">false</ResultData>
                <TotalItems xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">1</TotalItems>
            </Result>
        </UnblockLocalUserResponse>
    </s:Body>
</s:Envelope>

The ResultData field indicates the user's blocked status after the operation. false means the user is now unblocked.

Delete users

DeleteUsers

Permanently deletes one or more users.

Name	Type	Required	Description
domainId	integer	Yes	ID of the domain where the user exists. Find the value in ListDomains.
userIds	array of integers	Yes	IDs of the users to delete. Find the values in ListDomainUserIds. You can send multiple IDs 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

Returns the list of users in a domain with their main data.

Name	Type	Required	Description
domainId	integer	Yes	Domain ID. Find the value in ListDomains.
filter	string	No	Text that results must contain. If empty, returns all users.

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>

See the full field reference for UserView in Response objects.

ListDomains

Returns the list of available domains. Use this method to obtain the value of domainId.

Name	Type	Required	Description
filter	string	No	Text that results must contain. If empty, returns all domains.

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>

See the full field reference for DomainView in Response objects.

ListDomainUserIds

Returns the list of user IDs in a domain. Use this method to obtain the value of userId or userIds.

Name	Type	Required	Description
domainId	integer	Yes	Domain ID. Find the value in ListDomains.
viewType	string	Yes	Filters users by status: VIEW_ALL, VIEW_ACTIVE, VIEW_INACTIVE, VIEW_CONSUME_LICENSE, VIEW_NO_CONSUME_LICENSE.
filter	string	No	Text that results must contain. If empty, returns all users.

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">The operation has been successfully completed.</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>