Description: Retrieve usergroups for account
URL: http://{your-server-url}/api/v1/core/accounts/{accountid}/usergroups
Method: GET
Token Required: True
content-type: application/json or content-type: application/xml
token: {token}
Portal Administrator, Account Administrator, Account Owner
Type: Nexus.AppSpace.Service.Contract.Model.Enums.Rights.Rights
Right | Require |
---|---|
Basic | Yes |
Parameter | Type | Nullable | Description |
---|---|---|---|
page | int | True | page number |
rpp | int | True | records per page, default = 50, max = 500 |
Example: http://{your-server-url}/api/v1/core/accounts/{accountid}/usergroups?page=100&rpp=100
Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Account.AccountResponse
Parameter | Type |
---|---|
Response.Usergroups | Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users.Usergroup[] |
Field | Name | Values |
---|---|---|
Status | Nexus.AppSpace.Service.Contract.Model.Enums.User.Status | Disabled = 0, Active = 1, Locked = 2, Undefined = -1 |
<AccountResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Account" 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> <Usergroups 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> </Usergroups> </AccountResponse>
{ "DebugMessage":"String", "Errors":[ { "Code":"String", "Message":"String", "StackTrace":"String" } ], "Status":1, "Usergroups":[ { "Description":"String", "EntitlementIds":[ 123 ], "Guid":"11111111-1111-1111-1111-111111111111", "HomeNetworkId":123, "Id":123, "Name":"String", "RoleIds":[ 123 ], "Status":2 } ] }