You are here: Entitlement Management > Enterprise User Identities > retrieveEnterpriseIdentities

Retrieve Enterprise User IDs

Description

Return the list of user IDs added to an enterprise named entitlement. The entitlement must be deployed on Sentinel Cloud Connect.

Default Protocol Method Type URI

HTTPS

GET

retrieveEnterpriseIdentities.xml

Post Parameters

Parameter Description Valid Values Optional

entId

Identifier of the entitlement.

Note: The entId is the handle returned by the createEntitlement.xml web service. You can use the searchEntitlements.xml web service to retrieve entId for an entitlement.

Integer

No

lastModified Creation or Modification time stamp. Long Yes

Sample Code

import java.io.IOException;
import java.net.URLDecoder;

//..............................
//..............................
//..............................
import org.apache.http.params.HttpParams;
public class EMSSample {
	private static DefaultHttpClient httpclient = new DefaultHttpClient();
	private static Principal principal = null;
	private static StringBuffer query;
	//..............................
	//..............................
	//..............................
	public static String retrieveEnterpriseIdentities.xml()throws Exception  {
		if(!verifyLogin()){
			return "login failed";
		}
		HttpContext context = new BasicHttpContext();
		context.setAttribute(ClientContext.USER_TOKEN, principal);
		HttpGet get = new HttpGet("https://localhost:8443/ems/3.6/retrieveEnterpriseIdentities.xml");
		query = new StringBuffer();
		setParameter("entId", "1");
		setParameter("lastModified", "1327379905000");
		get.setURI(new URI(URLDecoder.decode(get.getURI() + query.toString(),"UTF-8")));
		HttpResponse response = httpclient.execute(get, context);
		HttpEntity entity = response.getEntity();
		byte[] b = null;
		if (entity != null) {
			long l = entity.getContentLength();
			b = new byte[(int) l];
			entity.getContent().read(b);
			entity.consumeContent();
		}
		return new String(b);
	}
	static void setParameter(String key, String value) {
		if (query.toString().equals("")) {
			query.append("?" + key + "=" + value + "&");
		} else {
			query.append(key + "=" + value + "&");
		}
	}
}

Sample Response

<emsResponse>
  <stat>ok</stat>
  <total>2</total>
  <users>
    <user>
      <userName>user1</userName>
      <creationTime>1410951059000</creationTime>
      <modificationTime>1410951059000</modificationTime>
    </user>
    <user>
      <userName>user2</userName>
      <creationTime>1410951059000</creationTime>
      <modificationTime>1410951059000</modificationTime>
    </user>
  </users>
</emsResponse>
See Also:

Output Format for Failure

Error codes

Error Code Description

101

You are not authorized to use this service.

107

An internal error occurred! Please report the error to System administrator.

118

{field} should be of data type integer. [Note: This error code is applicable for the fields - featureId, License modelId, entId, ftrId, customerId, lmId, templateType, lineItemId, CustomerId, stationCount, status, and granularity.]

120

{field} value is less than the minimum permitted value {value}. [Note: This error code is applicable for the fields - productd, featureId,entId, billType, lmId, lastModified, timeZoneId, customerId, and granularity.]

122

{field} is a required field and should have a not null value. [Note: This error code is applicable for the fields - Eid, namespaceName, featureName, startDate, endDate, userIds, featureId, productName, productVersion, detailsLM, lmId, templateType, customAttribute, lineItemId, customerRefId, granularity, loginId, oldPassword, and newPassword.]

120 {field} value is less than the minimum permitted value {value}. [Note: This error code is applicable for the fields - productd, featureId,entId, billType, lmId, lastModified, timeZoneId, customerId, and granularity.]

128

You should log on first.

132 The URL address does not exist.

1003

Entitlement is for a Retail Customer.

1005

Enterprise UserID not removed.

1009

Entitlement is for an unnamed enterprise Customer.

1080 {field} should be of dataType long. [Note: This error code is applicable for the field - lastModified.]
1081 Invalid Web service version provided
1084 No Web service version provided
1088 The EMS system is running on HTTPS. Please provide the correct Web service URL.