Update for our Zephyr for Jira Server/DataCenter customers : Our team is working on a major version release of Zephyr for Jira to be compatible with Jira 8 .The tentative ETA for the release of this compatible version is by end of March 2019.Please watch this space and anticipate further notifications from the Zephyr team on the updates with regards to the release of the same.Till then we suggest you to use lower version of Jira for seamless operations of Zephyr plugin.For any further feedback , follow up queries or suggestions kindly 'Submit a Ticket' with us.
Support | Zephyr



SOAP API - Return list of all Users

Created on

Using the SOAP API method linked below, we can return a filtered list or all users from a Zephyr instance:

http://support.yourzephyr.com/api_help/4.7/javadocs/com/thed/service/soap/impl/ZephyrSoapServiceImpl.html#getUsersByCriteria(java.util.List, java.lang.Boolean, java.lang.String)

As with all ...ByCriteria filters in Zephyr API, there are three main components to the call:

1) searchCriteria - The filter criteria used when flag(2) is set to 'false'. Ignored if flag(2) is set to 'true'

2) returnAllDataFlag - Boolean value or 'true' (return all results) or 'false' (return filtered results)

3) token - Session token returned in separate login call

 

A call to return all users would look something like:

client.getUsersByCriteria(listOfCriteria, 'true', token);

In the call above, since the flag is set to 'true' the criteria is ignored and as long as the session token is valid the return will be a list of all users in the Zephyr Enterprise/Community server.

The returned object is of type 'RemoteUser' and details can be seen at the link below:

http://support.yourzephyr.com/api_help/4.7/javadocs/com/thed/rpc/bean/RemoteUser.html


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request
Powered by Zendesk