IdentityManagementWebService

Click here for a complete list of operations.

ReadIdentitiesById

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 /_tfs_resources/TeamFoundation/Administration/v3.0/IdentityManagementService.asmx HTTP/1.1
Host: dev.pikacom.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://microsoft.com/webservices/ReadIdentitiesById"

<?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>
    <ReadIdentitiesById xmlns="http://microsoft.com/webservices/">
      <teamFoundationIds>
        <guid>guid</guid>
        <guid>guid</guid>
      </teamFoundationIds>
      <queryMembership>int</queryMembership>
      <features>int</features>
      <options>int</options>
      <propertyNameFilters>
        <string>string</string>
        <string>string</string>
      </propertyNameFilters>
      <propertyScope>int</propertyScope>
    </ReadIdentitiesById>
  </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>
    <ReadIdentitiesByIdResponse xmlns="http://microsoft.com/webservices/">
      <ReadIdentitiesByIdResult>
        <TeamFoundationIdentity DisplayName="string" IsContainer="boolean" IsActive="boolean" TeamFoundationId="guid" UniqueName="string" UniqueUserId="int">
          <Descriptor identityType="string" identifier="string" />
          <Attributes>
            <KeyValueOfStringString xsi:nil="true" />
            <KeyValueOfStringString xsi:nil="true" />
          </Attributes>
          <Properties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </Properties>
          <LocalProperties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </LocalProperties>
          <Members>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </Members>
          <MemberOf>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </MemberOf>
          <ProviderDisplayName>string</ProviderDisplayName>
          <CustomDisplayName>string</CustomDisplayName>
        </TeamFoundationIdentity>
        <TeamFoundationIdentity DisplayName="string" IsContainer="boolean" IsActive="boolean" TeamFoundationId="guid" UniqueName="string" UniqueUserId="int">
          <Descriptor identityType="string" identifier="string" />
          <Attributes>
            <KeyValueOfStringString xsi:nil="true" />
            <KeyValueOfStringString xsi:nil="true" />
          </Attributes>
          <Properties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </Properties>
          <LocalProperties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </LocalProperties>
          <Members>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </Members>
          <MemberOf>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </MemberOf>
          <ProviderDisplayName>string</ProviderDisplayName>
          <CustomDisplayName>string</CustomDisplayName>
        </TeamFoundationIdentity>
      </ReadIdentitiesByIdResult>
    </ReadIdentitiesByIdResponse>
  </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 /_tfs_resources/TeamFoundation/Administration/v3.0/IdentityManagementService.asmx HTTP/1.1
Host: dev.pikacom.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:Body>
    <ReadIdentitiesById xmlns="http://microsoft.com/webservices/">
      <teamFoundationIds>
        <guid>guid</guid>
        <guid>guid</guid>
      </teamFoundationIds>
      <queryMembership>int</queryMembership>
      <features>int</features>
      <options>int</options>
      <propertyNameFilters>
        <string>string</string>
        <string>string</string>
      </propertyNameFilters>
      <propertyScope>int</propertyScope>
    </ReadIdentitiesById>
  </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>
    <ReadIdentitiesByIdResponse xmlns="http://microsoft.com/webservices/">
      <ReadIdentitiesByIdResult>
        <TeamFoundationIdentity DisplayName="string" IsContainer="boolean" IsActive="boolean" TeamFoundationId="guid" UniqueName="string" UniqueUserId="int">
          <Descriptor identityType="string" identifier="string" />
          <Attributes>
            <KeyValueOfStringString xsi:nil="true" />
            <KeyValueOfStringString xsi:nil="true" />
          </Attributes>
          <Properties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </Properties>
          <LocalProperties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </LocalProperties>
          <Members>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </Members>
          <MemberOf>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </MemberOf>
          <ProviderDisplayName>string</ProviderDisplayName>
          <CustomDisplayName>string</CustomDisplayName>
        </TeamFoundationIdentity>
        <TeamFoundationIdentity DisplayName="string" IsContainer="boolean" IsActive="boolean" TeamFoundationId="guid" UniqueName="string" UniqueUserId="int">
          <Descriptor identityType="string" identifier="string" />
          <Attributes>
            <KeyValueOfStringString xsi:nil="true" />
            <KeyValueOfStringString xsi:nil="true" />
          </Attributes>
          <Properties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </Properties>
          <LocalProperties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </LocalProperties>
          <Members>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </Members>
          <MemberOf>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </MemberOf>
          <ProviderDisplayName>string</ProviderDisplayName>
          <CustomDisplayName>string</CustomDisplayName>
        </TeamFoundationIdentity>
      </ReadIdentitiesByIdResult>
    </ReadIdentitiesByIdResponse>
  </soap12:Body>
</soap12:Envelope>