VaultService Web Service

VaultService

Click here for a complete list of operations.

GetUserList

Get a list of users.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /vaultservice/vaultservice.asmx HTTP/1.1
Host: vaultdemo.sourcegear.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.sourcegear.com/schemas/vault/GetUserList"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <VaultAuth xmlns="http://www.sourcegear.com/schemas/vault">
      <VaultSessionID>string</VaultSessionID>
      <Token>string</Token>
    </VaultAuth>
  </soap:Header>
  <soap:Body>
    <GetUserList xmlns="http://www.sourcegear.com/schemas/vault">
      <vUsers>
        <VaultUser>
          <AuthType>Vault or ActiveDirectory or Mantis or SourceOffSite</AuthType>
          <AuthDomain>string</AuthDomain>
          <AccessInfo>
            <ID>int</ID>
            <RepOrProj>Repository or Project</RepOrProj>
            <WorkItemProjectAccessLevel>int</WorkItemProjectAccessLevel>
            <WorkItemProjectAccessType>int</WorkItemProjectAccessType>
            <InfoType>User or Group</InfoType>
            <AccessLevel>None or Access or FullAdmin</AccessLevel>
            <AccessType>UserDirect or GroupInherited or RepositoryDefault or GlobalAdmin</AccessType>
            <GroupName>string</GroupName>
            <GroupID>int</GroupID>
          </AccessInfo>
          <UserType>RegularUser or WebOnlyUser</UserType>
          <UserID>int</UserID>
          <Login>string</Login>
          <Name>string</Name>
          <Password>string</Password>
          <Email>string</Email>
          <Description>string</Description>
          <isActive>boolean</isActive>
          <Status>int</Status>
          <DefaultRights>unsignedInt</DefaultRights>
          <FolderRights>
            <VaultFolderRightsItem xsi:nil="true" />
            <VaultFolderRightsItem xsi:nil="true" />
          </FolderRights>
          <BelongToGroups>
            <VaultGroup xsi:nil="true" />
            <VaultGroup xsi:nil="true" />
          </BelongToGroups>
        </VaultUser>
        <VaultUser>
          <AuthType>Vault or ActiveDirectory or Mantis or SourceOffSite</AuthType>
          <AuthDomain>string</AuthDomain>
          <AccessInfo>
            <ID>int</ID>
            <RepOrProj>Repository or Project</RepOrProj>
            <WorkItemProjectAccessLevel>int</WorkItemProjectAccessLevel>
            <WorkItemProjectAccessType>int</WorkItemProjectAccessType>
            <InfoType>User or Group</InfoType>
            <AccessLevel>None or Access or FullAdmin</AccessLevel>
            <AccessType>UserDirect or GroupInherited or RepositoryDefault or GlobalAdmin</AccessType>
            <GroupName>string</GroupName>
            <GroupID>int</GroupID>
          </AccessInfo>
          <UserType>RegularUser or WebOnlyUser</UserType>
          <UserID>int</UserID>
          <Login>string</Login>
          <Name>string</Name>
          <Password>string</Password>
          <Email>string</Email>
          <Description>string</Description>
          <isActive>boolean</isActive>
          <Status>int</Status>
          <DefaultRights>unsignedInt</DefaultRights>
          <FolderRights>
            <VaultFolderRightsItem xsi:nil="true" />
            <VaultFolderRightsItem xsi:nil="true" />
          </FolderRights>
          <BelongToGroups>
            <VaultGroup xsi:nil="true" />
            <VaultGroup xsi:nil="true" />
          </BelongToGroups>
        </VaultUser>
      </vUsers>
    </GetUserList>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetUserListResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <GetUserListResult>int</GetUserListResult>
      <vUsers>
        <VaultUser>
          <AuthType>Vault or ActiveDirectory or Mantis or SourceOffSite</AuthType>
          <AuthDomain>string</AuthDomain>
          <AccessInfo>
            <ID>int</ID>
            <RepOrProj>Repository or Project</RepOrProj>
            <WorkItemProjectAccessLevel>int</WorkItemProjectAccessLevel>
            <WorkItemProjectAccessType>int</WorkItemProjectAccessType>
            <InfoType>User or Group</InfoType>
            <AccessLevel>None or Access or FullAdmin</AccessLevel>
            <AccessType>UserDirect or GroupInherited or RepositoryDefault or GlobalAdmin</AccessType>
            <GroupName>string</GroupName>
            <GroupID>int</GroupID>
          </AccessInfo>
          <UserType>RegularUser or WebOnlyUser</UserType>
          <UserID>int</UserID>
          <Login>string</Login>
          <Name>string</Name>
          <Password>string</Password>
          <Email>string</Email>
          <Description>string</Description>
          <isActive>boolean</isActive>
          <Status>int</Status>
          <DefaultRights>unsignedInt</DefaultRights>
          <FolderRights>
            <VaultFolderRightsItem xsi:nil="true" />
            <VaultFolderRightsItem xsi:nil="true" />
          </FolderRights>
          <BelongToGroups>
            <VaultGroup xsi:nil="true" />
            <VaultGroup xsi:nil="true" />
          </BelongToGroups>
        </VaultUser>
        <VaultUser>
          <AuthType>Vault or ActiveDirectory or Mantis or SourceOffSite</AuthType>
          <AuthDomain>string</AuthDomain>
          <AccessInfo>
            <ID>int</ID>
            <RepOrProj>Repository or Project</RepOrProj>
            <WorkItemProjectAccessLevel>int</WorkItemProjectAccessLevel>
            <WorkItemProjectAccessType>int</WorkItemProjectAccessType>
            <InfoType>User or Group</InfoType>
            <AccessLevel>None or Access or FullAdmin</AccessLevel>
            <AccessType>UserDirect or GroupInherited or RepositoryDefault or GlobalAdmin</AccessType>
            <GroupName>string</GroupName>
            <GroupID>int</GroupID>
          </AccessInfo>
          <UserType>RegularUser or WebOnlyUser</UserType>
          <UserID>int</UserID>
          <Login>string</Login>
          <Name>string</Name>
          <Password>string</Password>
          <Email>string</Email>
          <Description>string</Description>
          <isActive>boolean</isActive>
          <Status>int</Status>
          <DefaultRights>unsignedInt</DefaultRights>
          <FolderRights>
            <VaultFolderRightsItem xsi:nil="true" />
            <VaultFolderRightsItem xsi:nil="true" />
          </FolderRights>
          <BelongToGroups>
            <VaultGroup xsi:nil="true" />
            <VaultGroup xsi:nil="true" />
          </BelongToGroups>
        </VaultUser>
      </vUsers>
    </GetUserListResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /vaultservice/vaultservice.asmx HTTP/1.1
Host: vaultdemo.sourcegear.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <VaultAuth xmlns="http://www.sourcegear.com/schemas/vault">
      <VaultSessionID>string</VaultSessionID>
      <Token>string</Token>
    </VaultAuth>
  </soap12:Header>
  <soap12:Body>
    <GetUserList xmlns="http://www.sourcegear.com/schemas/vault">
      <vUsers>
        <VaultUser>
          <AuthType>Vault or ActiveDirectory or Mantis or SourceOffSite</AuthType>
          <AuthDomain>string</AuthDomain>
          <AccessInfo>
            <ID>int</ID>
            <RepOrProj>Repository or Project</RepOrProj>
            <WorkItemProjectAccessLevel>int</WorkItemProjectAccessLevel>
            <WorkItemProjectAccessType>int</WorkItemProjectAccessType>
            <InfoType>User or Group</InfoType>
            <AccessLevel>None or Access or FullAdmin</AccessLevel>
            <AccessType>UserDirect or GroupInherited or RepositoryDefault or GlobalAdmin</AccessType>
            <GroupName>string</GroupName>
            <GroupID>int</GroupID>
          </AccessInfo>
          <UserType>RegularUser or WebOnlyUser</UserType>
          <UserID>int</UserID>
          <Login>string</Login>
          <Name>string</Name>
          <Password>string</Password>
          <Email>string</Email>
          <Description>string</Description>
          <isActive>boolean</isActive>
          <Status>int</Status>
          <DefaultRights>unsignedInt</DefaultRights>
          <FolderRights>
            <VaultFolderRightsItem xsi:nil="true" />
            <VaultFolderRightsItem xsi:nil="true" />
          </FolderRights>
          <BelongToGroups>
            <VaultGroup xsi:nil="true" />
            <VaultGroup xsi:nil="true" />
          </BelongToGroups>
        </VaultUser>
        <VaultUser>
          <AuthType>Vault or ActiveDirectory or Mantis or SourceOffSite</AuthType>
          <AuthDomain>string</AuthDomain>
          <AccessInfo>
            <ID>int</ID>
            <RepOrProj>Repository or Project</RepOrProj>
            <WorkItemProjectAccessLevel>int</WorkItemProjectAccessLevel>
            <WorkItemProjectAccessType>int</WorkItemProjectAccessType>
            <InfoType>User or Group</InfoType>
            <AccessLevel>None or Access or FullAdmin</AccessLevel>
            <AccessType>UserDirect or GroupInherited or RepositoryDefault or GlobalAdmin</AccessType>
            <GroupName>string</GroupName>
            <GroupID>int</GroupID>
          </AccessInfo>
          <UserType>RegularUser or WebOnlyUser</UserType>
          <UserID>int</UserID>
          <Login>string</Login>
          <Name>string</Name>
          <Password>string</Password>
          <Email>string</Email>
          <Description>string</Description>
          <isActive>boolean</isActive>
          <Status>int</Status>
          <DefaultRights>unsignedInt</DefaultRights>
          <FolderRights>
            <VaultFolderRightsItem xsi:nil="true" />
            <VaultFolderRightsItem xsi:nil="true" />
          </FolderRights>
          <BelongToGroups>
            <VaultGroup xsi:nil="true" />
            <VaultGroup xsi:nil="true" />
          </BelongToGroups>
        </VaultUser>
      </vUsers>
    </GetUserList>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetUserListResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <GetUserListResult>int</GetUserListResult>
      <vUsers>
        <VaultUser>
          <AuthType>Vault or ActiveDirectory or Mantis or SourceOffSite</AuthType>
          <AuthDomain>string</AuthDomain>
          <AccessInfo>
            <ID>int</ID>
            <RepOrProj>Repository or Project</RepOrProj>
            <WorkItemProjectAccessLevel>int</WorkItemProjectAccessLevel>
            <WorkItemProjectAccessType>int</WorkItemProjectAccessType>
            <InfoType>User or Group</InfoType>
            <AccessLevel>None or Access or FullAdmin</AccessLevel>
            <AccessType>UserDirect or GroupInherited or RepositoryDefault or GlobalAdmin</AccessType>
            <GroupName>string</GroupName>
            <GroupID>int</GroupID>
          </AccessInfo>
          <UserType>RegularUser or WebOnlyUser</UserType>
          <UserID>int</UserID>
          <Login>string</Login>
          <Name>string</Name>
          <Password>string</Password>
          <Email>string</Email>
          <Description>string</Description>
          <isActive>boolean</isActive>
          <Status>int</Status>
          <DefaultRights>unsignedInt</DefaultRights>
          <FolderRights>
            <VaultFolderRightsItem xsi:nil="true" />
            <VaultFolderRightsItem xsi:nil="true" />
          </FolderRights>
          <BelongToGroups>
            <VaultGroup xsi:nil="true" />
            <VaultGroup xsi:nil="true" />
          </BelongToGroups>
        </VaultUser>
        <VaultUser>
          <AuthType>Vault or ActiveDirectory or Mantis or SourceOffSite</AuthType>
          <AuthDomain>string</AuthDomain>
          <AccessInfo>
            <ID>int</ID>
            <RepOrProj>Repository or Project</RepOrProj>
            <WorkItemProjectAccessLevel>int</WorkItemProjectAccessLevel>
            <WorkItemProjectAccessType>int</WorkItemProjectAccessType>
            <InfoType>User or Group</InfoType>
            <AccessLevel>None or Access or FullAdmin</AccessLevel>
            <AccessType>UserDirect or GroupInherited or RepositoryDefault or GlobalAdmin</AccessType>
            <GroupName>string</GroupName>
            <GroupID>int</GroupID>
          </AccessInfo>
          <UserType>RegularUser or WebOnlyUser</UserType>
          <UserID>int</UserID>
          <Login>string</Login>
          <Name>string</Name>
          <Password>string</Password>
          <Email>string</Email>
          <Description>string</Description>
          <isActive>boolean</isActive>
          <Status>int</Status>
          <DefaultRights>unsignedInt</DefaultRights>
          <FolderRights>
            <VaultFolderRightsItem xsi:nil="true" />
            <VaultFolderRightsItem xsi:nil="true" />
          </FolderRights>
          <BelongToGroups>
            <VaultGroup xsi:nil="true" />
            <VaultGroup xsi:nil="true" />
          </BelongToGroups>
        </VaultUser>
      </vUsers>
    </GetUserListResponse>
  </soap12:Body>
</soap12:Envelope>