Description: Retrieve users for account
URL: http://{your-server-url}/api/v1/core/accounts/{accountid}/users
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}/users?page=100&rpp=100
Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Account.AccountResponse
Parameter | Type |
---|---|
Response.Users | Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users.User[] |
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> <Users xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users"> <a:User> <a:AccountId>123</a:AccountId> <a:CloudGuid>String</a:CloudGuid> <a:CreatedDate>2015-01-05T14:45:30.3550311Z</a:CreatedDate> <a:Email>String</a:Email> <a:EntitlementIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <b:int>123</b:int> </a:EntitlementIds> <a:FirstName>String</a:FirstName> <a:GroupId>123</a:GroupId> <a:HomeNetworkId>123</a:HomeNetworkId> <a:Id>123</a:Id> <a:ImagePath>String</a:ImagePath> <a:LastAccess>2015-01-05T14:45:30.3550311Z</a:LastAccess> <a:Lastname>String</a:Lastname> <a:MobileNo>String</a:MobileNo> <a:Password>String</a:Password> <a:RoleIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <b:int>123</b:int> </a:RoleIds> <a:SecretAnswer>String</a:SecretAnswer> <a:SecretQuestion>String</a:SecretQuestion> <a:Status>Locked</a:Status> <a:UserDN>String</a:UserDN> <a:Username>String</a:Username> <a:WorkNo>String</a:WorkNo> </a:User> </Users> </AccountResponse>
{ "DebugMessage":"String", "Errors":[ { "Code":"String", "Message":"String", "StackTrace":"String" } ], "Status":1, "Users":[ { "AccountId":123, "CloudGuid":"String", "CreatedDate":"\/Date(1420469130355)\/", "Email":"String", "EntitlementIds":[ 123 ], "FirstName":"String", "GroupId":123, "HomeNetworkId":123, "Id":123, "ImagePath":"String", "LastAccess":"\/Date(1420469130355)\/", "Lastname":"String", "MobileNo":"String", "Password":"String", "RoleIds":[ 123 ], "SecretAnswer":"String", "SecretQuestion":"String", "Status":2, "UserDN":"String", "Username":"String", "WorkNo":"String" } ] }