Get all users in project

Description

Returns all users and their properties in the specified project.

URL

/qcbin/v2/sa/api/domains/{domain}/projects/{project}/users

You can use the extra-fields query parameter to get extra properties of users. For example, the extra-fields=group parameter returns the group data of users.

HTTP Method

GET

Remarks

Accept: application/xml, application/json

Returns

On success, the HTTP return value is 200.

On success, returns the full data of all the users in the project in an XML/JSON string with the Site users schema reference.

Return Value Example

Below is the response example of the https://<ALM server>/qcbin/v2/sa/api/domains/<default name>/projects/<project name>/users?extra-fields=group request

Copy code

<users total-results="2">
<user>
  <name>emma</name>
  <id>254</id>
  <full-name/>
  <email/>
  <description/>
  <phone/>
  <is-active>true</is-active>
  <expire-date/>
  <identity-key/>
  <idp-name/>
  <policy>
    <policy-id>1</policy-id>
    <policy-name>Default</policy-name>
  </policy>
  <role/>
  <user-auth-data>
    <user-id>254</user-id>
    <server-id>-2</server-id>
  </user-auth-data>
  <group>
    <group-name>QATester</group-name>
  </group>
  <group>
    <group-name>Developer</group-name>
  </group>
  <group>
    <group-name>Viewer</group-name>
  </group>
  <is-locked>false</is-locked>
</user>
<user>
  <name>alex</name>
  <id>255</id>
  <full-name/>
  <email/>
  <description/>
  <phone/>
  <is-active>true</is-active>
  <expire-date/>
  <identity-key/>
  <idp-name/>
  <policy>
    <policy-id>1</policy-id>
    <policy-name>Default</policy-name>
  </policy>
  <role/>
  <user-auth-data>
    <user-id>255</user-id>
    <server-id>-2</server-id>
  </user-auth-data>
  <group>
    <group-name>TDAdmin</group-name>
  </group>
  <group>
    <group-name>Viewer</group-name>
  </group>
  <is-locked>false</is-locked>
</user>
</users>