GET {clientId}/Config/UserGroups

Retrieve all User Groups.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Your required clientId used to access the WebAPI. A 404 is returned if this value is invalid.	string	Required

Body Parameters

None.

Response Information

Response Codes

Unauthorized (401)
InternalServerError (500)

Resource Description

Collection of ConfigUserGroup

Name	Type	Additional information
Link	integer	None.
GroupName	string	Required Min length: 1
GroupTypeNbr	integer	Required Range: inclusive between 1 and 2147483647
Permissions	Collection of ConfigPermissionTypeOnly	None.
UserGroupID	string	Required Min length: 1
PasswordExpirationInDays	integer	None.
Description	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PasswordExpirationInDays": 1,
    "Description": "sample string 1",
    "Link": 1,
    "GroupName": "sample string 2",
    "GroupTypeNbr": 3,
    "Permissions": [
      {
        "PermissionTypeNbr": 1
      }
    ],
    "UserGroupID": "sample string 4"
  }
]

application/xml, text/xml

Sample:

<ArrayOfConfigUserGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
  <ConfigUserGroup>
    <UserGroupID>sample string 4</UserGroupID>
    <Description>sample string 1</Description>
    <GroupName>sample string 2</GroupName>
    <GroupTypeNbr>3</GroupTypeNbr>
    <Link>1</Link>
    <PasswordExpirationInDays>1</PasswordExpirationInDays>
    <Permissions>
      <ConfigPermissionTypeOnly>
        <PermissionTypeNbr>1</PermissionTypeNbr>
      </ConfigPermissionTypeOnly>
    </Permissions>
  </ConfigUserGroup>
</ArrayOfConfigUserGroup>