RetrieveUsergroups

UserService / RetrieveUsergroups

Description: Retrieve usergroups from current account

URL: http://{your-server-url}/api/v1/core/users/usergroups

Method: GET

Token Required: True

Request Headers:

currentaccountid: {accountid - optional and default value is user's own account}
content-type: application/json or content-type: application/xml
token: {token}

Required Roles:

Portal Administrator, Account Administrator, Account Owner, Network Administrator

Request Query Parameters:

Parameter	Type	Nullable	Description
page	int	True	page number
name	string	True
ugids	int[]	True	comma separated values, eg. ugids=1,2,3
networkids	int[]	True	comma separated values, eg. networkids=1,2,3
roleids	string[]	True	comma separated values, eg. roleids=1,2
includereadonly	boolean	True	include read only resources, eg. includereadonly=true
groupguids	guid[]	True	comma separated values, eg. groupguids=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
rpp	int	True	records per page, default = 50, max = 500

Example: http://{your-server-url}/api/v1/core/users/usergroups?page=100&name=string&ugids=1,2,3

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.User.UserResponse

Parameter	Type
Response.Groups	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users.Usergroup[]
Response.CurrentPage	int
Response.TotalPages	int
Response.Rpp	int

Enums:

Field	Name	Values
Status	Nexus.AppSpace.Service.Contract.Model.Enums.User.Status	Disabled = 0, Active = 1, Locked = 2, Undefined = -1

The following is an example response Xml body:

<UserResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.User" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DebugMessage xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">String</DebugMessage>
  <Errors xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">
    <Error>
      <Code>String</Code>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
  <CurrentPage>123</CurrentPage>
  <Groups xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users">
    <a:Usergroup>
      <a:Description>String</a:Description>
      <a:EntitlementIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <b:int>123</b:int>
      </a:EntitlementIds>
      <a:Guid>11111111-1111-1111-1111-111111111111</a:Guid>
      <a:HomeNetworkId>123</a:HomeNetworkId>
      <a:Id>123</a:Id>
      <a:Name>String</a:Name>
      <a:RoleIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <b:int>123</b:int>
      </a:RoleIds>
      <a:Status>Locked</a:Status>
    </a:Usergroup>
  </Groups>
  <Rpp>123</Rpp>
  <TotalPages>123</TotalPages>
</UserResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Groups":[
		{
			"Description":"String",
			"EntitlementIds":[
				123
			],
			"Guid":"11111111-1111-1111-1111-111111111111",
			"HomeNetworkId":123,
			"Id":123,
			"Name":"String",
			"RoleIds":[
				123
			],
			"Status":2
		}
	],
	"Rpp":123,
	"TotalPages":123
}