RetrieveUsers

UserService / RetrieveUsers

Description: Retrieve users from current account

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

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
lastname	string	True
page	int	True	page number
email	string	True
username	string	True
firstname	string	True
fullname	string	True
cloudguid	string	True
ugids	int[]	True	comma separated values, eg. ugids=1,2,3
networkids	int[]	True	comma separated values, eg. networkids=1,2,3
networkidrange	int	True	networkid including sub networks
userids	int[]	True	comma separated values, eg. userids=1,2,3
roleids	string[]	True	comma separated values, eg. roleids=1,2
includereadonly	boolean	True	include read only resources, eg. includereadonly=true
allaccounts	boolean	True	include resources from all accessible accounts, eg. allaccounts=true
rpp	int	True	records per page, default = 50, max = 500

Example: http://{your-server-url}/api/v1/core/users?lastname=string&page=100&email=string

Response:

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

Parameter	Type
Response.User	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users.User[]
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>
  <Rpp>123</Rpp>
  <TotalPages>123</TotalPages>
  <User xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users">
    <a:AccountId>123</a:AccountId>
    <a:CloudGuid>String</a:CloudGuid>
    <a:CreatedDate>2014-12-15T15:18:54.2474452Z</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:LastAccess>2014-12-15T15:18:54.2464445Z</a:LastAccess>
    <a:Lastname>String</a:Lastname>
    <a:MobileNo>String</a:MobileNo>
    <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:UserDN>String</a:UserDN>
    <a:Username>String</a:Username>
    <a:WorkNo>String</a:WorkNo>
  </User>
</UserResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Rpp":123,
	"TotalPages":123,
	"User":{
		"AccountId":123,
		"CloudGuid":"String",
		"CreatedDate":"\/Date(1418656734247)\/",
		"Email":"String",
		"EntitlementIds":[
			123
		],
		"FirstName":"String",
		"GroupId":123,
		"HomeNetworkId":123,
		"Id":123,
		"LastAccess":"\/Date(1418656734246)\/",
		"Lastname":"String",
		"MobileNo":"String",
		"RoleIds":[
			123
		],
		"Status":2,
		"UserDN":"String",
		"Username":"String",
		"WorkNo":"String"
	}
}