POST api/usergroup/{id}/users

Returns all users in specific user group context based on provided filters

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Unique identifier of user group	globally unique identifier	Required

Body Parameters

Request filters

GetUserGroupUsersRequest

Name	Type	Additional information
KnownSearchFields	Collection of string	None.
KnownSortFields	Collection of string	None.
PageSize	integer	None.
PageIndex	integer	None.
SearchBy	Collection of Filter	None.
SortBy	Collection of Sort	None.

Request Formats

application/json, text/json

Sample:

{
  "KnownSearchFields": [
    "Username",
    "FirstName",
    "LastName",
    "EmailAddress",
    "UserRole",
    "IsActive"
  ],
  "KnownSortFields": [
    "Username",
    "FirstName",
    "LastName",
    "EmailAddress"
  ],
  "PageSize": 1,
  "PageIndex": 2,
  "SearchBy": [
    {
      "Key": "sample string 1",
      "Value": {},
      "Type": 0
    },
    {
      "Key": "sample string 1",
      "Value": {},
      "Type": 0
    }
  ],
  "SortBy": [
    {
      "Key": "sample string 1",
      "Order": 0
    },
    {
      "Key": "sample string 1",
      "Order": 0
    }
  ]
}

application/xml, text/xml

Sample:

<GetUserGroupUsersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Requests.GetRequests">
  <KnownSearchFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
    <d2p1:string>Username</d2p1:string>
    <d2p1:string>FirstName</d2p1:string>
    <d2p1:string>LastName</d2p1:string>
    <d2p1:string>EmailAddress</d2p1:string>
    <d2p1:string>UserRole</d2p1:string>
    <d2p1:string>IsActive</d2p1:string>
  </KnownSearchFields>
  <KnownSortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
    <d2p1:string>Username</d2p1:string>
    <d2p1:string>FirstName</d2p1:string>
    <d2p1:string>LastName</d2p1:string>
    <d2p1:string>EmailAddress</d2p1:string>
  </KnownSortFields>
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">2</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">1</PageSize>
  <SearchBy xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
    <Filter>
      <Key>sample string 1</Key>
      <Type>None</Type>
      <Value />
    </Filter>
    <Filter>
      <Key>sample string 1</Key>
      <Type>None</Type>
      <Value />
    </Filter>
  </SearchBy>
  <SortBy xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
    <Sort>
      <Key>sample string 1</Key>
      <Order>None</Order>
    </Sort>
    <Sort>
      <Key>sample string 1</Key>
      <Order>None</Order>
    </Sort>
  </SortBy>
</GetUserGroupUsersRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of users

ApiCollectionResponseOfGetUserResponse

Name	Type	Additional information
PageSize	integer	None.
PageIndex	integer	None.
Total	integer	None.
SearchBy	Collection of Filter	None.
SortBy	Collection of Sort	None.
Data	Collection of GetUserResponse	None.
Errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "PageSize": 1,
  "PageIndex": 2,
  "Total": 3,
  "SearchBy": [
    {
      "Key": "sample string 1",
      "Value": {},
      "Type": 0
    },
    {
      "Key": "sample string 1",
      "Value": {},
      "Type": 0
    }
  ],
  "SortBy": [
    {
      "Key": "sample string 1",
      "Order": 0
    },
    {
      "Key": "sample string 1",
      "Order": 0
    }
  ],
  "Data": [
    {
      "Id": "b95adc37-0c11-4655-b705-33810cb7d133",
      "Username": "sample string 2",
      "EmailAddress": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "LoginProviders": [
        {
          "Id": "2866e912-8277-47c5-aa8b-22bac97081ca",
          "ProviderName": "sample string 2",
          "ProviderKey": "sample string 3",
          "UserId": "47bf6a57-319c-4132-9dd9-73eb9884b013"
        },
        {
          "Id": "2866e912-8277-47c5-aa8b-22bac97081ca",
          "ProviderName": "sample string 2",
          "ProviderKey": "sample string 3",
          "UserId": "47bf6a57-319c-4132-9dd9-73eb9884b013"
        }
      ],
      "Roles": [
        "sample string 1",
        "sample string 2"
      ],
      "IsActive": true,
      "IsPrivateCustomer": true
    },
    {
      "Id": "b95adc37-0c11-4655-b705-33810cb7d133",
      "Username": "sample string 2",
      "EmailAddress": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "LoginProviders": [
        {
          "Id": "2866e912-8277-47c5-aa8b-22bac97081ca",
          "ProviderName": "sample string 2",
          "ProviderKey": "sample string 3",
          "UserId": "47bf6a57-319c-4132-9dd9-73eb9884b013"
        },
        {
          "Id": "2866e912-8277-47c5-aa8b-22bac97081ca",
          "ProviderName": "sample string 2",
          "ProviderKey": "sample string 3",
          "UserId": "47bf6a57-319c-4132-9dd9-73eb9884b013"
        }
      ],
      "Roles": [
        "sample string 1",
        "sample string 2"
      ],
      "IsActive": true,
      "IsPrivateCustomer": true
    }
  ],
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ApiCollectionResponseOfGetUserResponseLgVmlFmJ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Responses">
    <d2p1:GetUserResponse>
      <d2p1:EmailAddress>sample string 3</d2p1:EmailAddress>
      <d2p1:FirstName>sample string 4</d2p1:FirstName>
      <d2p1:Id>b95adc37-0c11-4655-b705-33810cb7d133</d2p1:Id>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:IsPrivateCustomer>true</d2p1:IsPrivateCustomer>
      <d2p1:LastName>sample string 5</d2p1:LastName>
      <d2p1:LoginProviders>
        <d2p1:GetLoginProviderResponse>
          <d2p1:Id>2866e912-8277-47c5-aa8b-22bac97081ca</d2p1:Id>
          <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
          <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
          <d2p1:UserId>47bf6a57-319c-4132-9dd9-73eb9884b013</d2p1:UserId>
        </d2p1:GetLoginProviderResponse>
        <d2p1:GetLoginProviderResponse>
          <d2p1:Id>2866e912-8277-47c5-aa8b-22bac97081ca</d2p1:Id>
          <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
          <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
          <d2p1:UserId>47bf6a57-319c-4132-9dd9-73eb9884b013</d2p1:UserId>
        </d2p1:GetLoginProviderResponse>
      </d2p1:LoginProviders>
      <d2p1:Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Roles>
      <d2p1:Username>sample string 2</d2p1:Username>
    </d2p1:GetUserResponse>
    <d2p1:GetUserResponse>
      <d2p1:EmailAddress>sample string 3</d2p1:EmailAddress>
      <d2p1:FirstName>sample string 4</d2p1:FirstName>
      <d2p1:Id>b95adc37-0c11-4655-b705-33810cb7d133</d2p1:Id>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:IsPrivateCustomer>true</d2p1:IsPrivateCustomer>
      <d2p1:LastName>sample string 5</d2p1:LastName>
      <d2p1:LoginProviders>
        <d2p1:GetLoginProviderResponse>
          <d2p1:Id>2866e912-8277-47c5-aa8b-22bac97081ca</d2p1:Id>
          <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
          <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
          <d2p1:UserId>47bf6a57-319c-4132-9dd9-73eb9884b013</d2p1:UserId>
        </d2p1:GetLoginProviderResponse>
        <d2p1:GetLoginProviderResponse>
          <d2p1:Id>2866e912-8277-47c5-aa8b-22bac97081ca</d2p1:Id>
          <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
          <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
          <d2p1:UserId>47bf6a57-319c-4132-9dd9-73eb9884b013</d2p1:UserId>
        </d2p1:GetLoginProviderResponse>
      </d2p1:LoginProviders>
      <d2p1:Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Roles>
      <d2p1:Username>sample string 2</d2p1:Username>
    </d2p1:GetUserResponse>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <PageIndex>2</PageIndex>
  <PageSize>1</PageSize>
  <SearchBy>
    <Filter>
      <Key>sample string 1</Key>
      <Type>None</Type>
      <Value />
    </Filter>
    <Filter>
      <Key>sample string 1</Key>
      <Type>None</Type>
      <Value />
    </Filter>
  </SearchBy>
  <SortBy>
    <Sort>
      <Key>sample string 1</Key>
      <Order>None</Order>
    </Sort>
    <Sort>
      <Key>sample string 1</Key>
      <Order>None</Order>
    </Sort>
  </SortBy>
  <Total>3</Total>
</ApiCollectionResponseOfGetUserResponseLgVmlFmJ>