IM InfoSphere Identity Insight, Version 8.0


getIdentityDetail() SOAP API method

Requests and obtains the details of particular identity that is identified by the external ID of one of its composite identity records. The UMF API equivalent of the getIdentityDetail method are the SOA_IDENTITY_DETAIL_REQUEST input document and the SOA_IDENTITY_DETAIL_RESPONSE output document.

Syntax

getIdentityDetail
(
 dataSourceCode,
 externalID
 depth
 additionalInfo
);

Description

Parameters
dataSourceCode
Type: String
Nullable: No
This parameter identifies the data source in the system from where the identity is being requested.
externalID
Type: String
Nullable: No
This parameter identifies the unique ID for the identity is being requested.
depth
Type: DepthSetting
Nullable: Yes
This parameter indicates the level of detail for the response. If not specified, then FULL is assumed.
Valid Values: FULL
additionalinfo
Type: CustomInformation
Nullable: Yes
This parameter is reserved for field customizations to the WSDL and XSLT transforms without changing the signature of the method.
Example Request
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <soapenv:Body>
  <getIdentityDetail xmlns="http://services/">
   <dataSourceCode xmlns="">100</dataSourceCode>
   <externalID xmlns="">PNR684-10QR</externalID>
   <depth xsi:type="ns1:DepthSetting" xmlns:ns1="http://common/" xmlns="">
    <value>FULL</value>
   </depth>
   <additionalInfo xsi:nil="true" xmlns=""/>
  </getIdentityDetail>
 </soapenv:Body>
</soapenv:Envelope>

Description

Returns
getIdentityDetailResponse
identity
minOccurs="0"
type="xsd_3:IdentityDetail"
IdentityDetail
identityHandle
type=" xsd_1:IdentityHandle
IdentityHandle
internalID
type="xsd:long"
externalID
type="xsd:string"
dataSourceCode
type="xsd:string"
externalReference
type="xsd:string"
roleIDs
maxOccurs="unbounded"
minOccurs="0"
type="xsd:long"
attributes
maxOccurs="unbounded"
minOccurs="0"
type=" xsd_1:AttributeDetail
AttributeDetail
IdentityHandle
internalID
type="xsd:long"
externalID
type="xsd:string"
dataSourceCode
type="xsd:string"
externalReference
type="xsd:string"
lastModifiedTimestamp
type="xsd:dateTime"
validFromTimestamp
type="xsd:dateTime"
validThroughTimestamp
type="xsd:dateTime"
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 <soapenv:Body>
  <getIdentityDetailResponse xmlns="http://services/">
   <identity xmlns="">
    <identityHandle>
     <internalID>86</internalID>
     <externalID>PNR684-10QR</externalID>
     <dataSourceCode>100</dataSourceCode>
     <externalReference>PNR684-10QR</externalReference>
    </identityHandle>
    <roleIDs>1</roleIDs>
    <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:NameDetail">
     <identityHandle>
      <internalID>86</internalID>
      <externalID>PNR684-10QR</externalID>
      <dataSourceCode>100</dataSourceCode>
      <externalReference>PNR684-10QR</externalReference>
     </identityHandle>
     <lastModifiedTimestamp>2008-07-28T15:11:56</lastModifiedTimestamp>
     <nameID>91</nameID>
     <nameTypeCode>M</nameTypeCode>
     <givenName>Davie</givenName>
     <surname>Chaplin</surname>
    </attributes>
    <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:AddressDetail">
     <identityHandle>
      <internalID>86</internalID>
      <externalID>PNR684-10QR</externalID>
      <dataSourceCode>100</dataSourceCode>
      <externalReference>PNR684-10QR</externalReference>
     </identityHandle>
     <lastModifiedTimestamp>2008-07-28T15:11:56</lastModifiedTimestamp>
     <validFromTimestamp>1998-01-01T00:00:00</validFromTimestamp>
     <validThroughTimestamp>2002-12-01T00:00:00</validThroughTimestamp>
     <addressID>87</addressID>
     <addressTypeCode>H</addressTypeCode>
     <street1>4231 Orange Street</street1>
     <city>San Francisco</city>
     <state>CA</state>
     <country>USA</country>
     <postalCode>94014</postalCode>
    </attributes>
    <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:CharacteristicDetail">
     <identityHandle>
      <internalID>86</internalID>
      <externalID>PNR684-10QR</externalID>
      <dataSourceCode>100</dataSourceCode>
      <externalReference>PNR684-10QR</externalReference>
     </identityHandle>
     <lastModifiedTimestamp>2008-07-28T15:11:56</lastModifiedTimestamp>
     <characteristicID>82</characteristicID>
     <characteristicValue>M</characteristicValue>
     <characteristicTypeID>2</characteristicTypeID>
    </attributes>
    <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:EmailDetail">
     <identityHandle>
      <internalID>86</internalID>
      <externalID>PNR684-10QR</externalID>
      <dataSourceCode>100</dataSourceCode>
      <externalReference>PNR684-10QR</externalReference>
     </identityHandle>
     <lastModifiedTimestamp>2008-07-28T15:11:56</lastModifiedTimestamp>
     <emailID>37</emailID>
     <emailAddress>DAVID63@AOL.COM</emailAddress>
     <userEmailType>H</userEmailType>
     <userDefinedStatus>0</userDefinedStatus>
    </attributes>
   </identity>
  </getIdentityDetailResponse>
 </soapenv:Body>
</soapenv:Envelope>




Feedback



Last updated: 2011