This operation returns a list of users and user groups.
Request
Syntax
GET <webservice>/UsersAndGroups HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Header
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or Web Console used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Response
Response Parameters
|
Parameter |
Description |
Element |
|---|---|---|
|
fullName |
The full name of the user, for example, the user's first and last name. |
users |
|
description |
The user description. |
users |
|
|
The email address of the user. |
users |
|
_type_ |
The type of CommCell object. Valid value is 13 for users. |
associatedUserOrUserGroup |
|
userId |
The system-generated ID assigned to the user. |
associatedUserOrUserGroup |
|
userName |
The name of the user. |
associatedUserOrUserGroup |
|
description |
The user group description. |
userGroups |
|
_type_ |
The type of CommCell object. Valid value is 15 for user groups. |
associatedUserOrUserGroup |
|
userGroupId |
The system-generated ID assigned to the user group. |
associatedUserOrUserGroup |
|
userGroupName |
The name of the user group. |
associatedUserOrUserGroup |
Examples
Sample Request
GET <webservice>/UsersAndGroups HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
<?xml version='1.0' encoding='utf-8' ?>
<Api_GetAllCreatedUsersAndGroupsResponse>
<users fullName="Administrator" description="Administrator" email="jsmith@mycompany.com">
<associatedUserOrUserGroup _type_="13" userId="1" userName="Admin"/>
</users>
<users fullName="Mac User" description="" email="mcuser@mycompany.com">
<associatedUserOrUserGroup _type_="13" userId="2" userName="mcuser"/>
</users>
<users fullName="admin" description="" email="admin@mycompany.loc">
<associatedUserOrUserGroup _type_="13" userId="3" userName="DOMAIN001\admin"/>
</users>
<users fullName="K. Green" description="Saml Login User " email="kgreen@mycompany.com">
<associatedUserOrUserGroup _type_="13" userId="4" userName="kgreen@mycompany.com"/>
</users>
<userGroups fullName="" description="Administrative Group" email="">
<associatedUserOrUserGroup _type_="15" userGroupId="1" userGroupName="master"/>
</userGroups>
<userGroups fullName="" description="Members of this group can see all Commcell Objects, regardless of (other) group associations" email="">
<associatedUserOrUserGroup _type_="15" userGroupId="3" userGroupName="View All"/>
</userGroups>
<userGroups fullName="" description="" email="">
<associatedUserOrUserGroup _type_="15" userGroupId="4" userGroupName="DOMAIN001\Administrators"/>
</userGroups>
</Api_GetAllCreatedUsersAndGroupsResponse>