POST api/Splashtop/teams/users/query

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ids		Collection of integer	None.
fields		Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "ids": [
    1,
    2
  ],
  "fields": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<SplashtopController.QueryParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iMOE_Back_End.Controllers">
  <fields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </fields>
  <ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ids>
</SplashtopController.QueryParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of userQueryInfo

Name	Type	Additional information
id	integer	None.
email	string	None.
member_name	string	None.
role	string	None.
status	string	None.
enable_2fa	boolean	None.
access_permissions_kind	string	None.
last_session_at	string	None.
last_login_at	string	None.
super_admin	boolean	None.
group_id	integer	None.
group_scope	string	None.
in_charge_group_ids	Collection of integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "email": "sample string 2",
    "member_name": "sample string 3",
    "role": "sample string 4",
    "status": "sample string 5",
    "enable_2fa": true,
    "access_permissions_kind": "sample string 7",
    "last_session_at": "sample string 8",
    "last_login_at": "sample string 9",
    "super_admin": true,
    "group_id": 1,
    "group_scope": "sample string 11",
    "in_charge_group_ids": [
      1,
      2
    ]
  },
  {
    "id": 1,
    "email": "sample string 2",
    "member_name": "sample string 3",
    "role": "sample string 4",
    "status": "sample string 5",
    "enable_2fa": true,
    "access_permissions_kind": "sample string 7",
    "last_session_at": "sample string 8",
    "last_login_at": "sample string 9",
    "super_admin": true,
    "group_id": 1,
    "group_scope": "sample string 11",
    "in_charge_group_ids": [
      1,
      2
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfSplashtopController.userQueryInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iMOE_Back_End.Controllers">
  <SplashtopController.userQueryInfo>
    <access_permissions_kind>sample string 7</access_permissions_kind>
    <email>sample string 2</email>
    <enable_2fa>true</enable_2fa>
    <group_id>1</group_id>
    <group_scope>sample string 11</group_scope>
    <id>1</id>
    <in_charge_group_ids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </in_charge_group_ids>
    <last_login_at>sample string 9</last_login_at>
    <last_session_at>sample string 8</last_session_at>
    <member_name>sample string 3</member_name>
    <role>sample string 4</role>
    <status>sample string 5</status>
    <super_admin>true</super_admin>
  </SplashtopController.userQueryInfo>
  <SplashtopController.userQueryInfo>
    <access_permissions_kind>sample string 7</access_permissions_kind>
    <email>sample string 2</email>
    <enable_2fa>true</enable_2fa>
    <group_id>1</group_id>
    <group_scope>sample string 11</group_scope>
    <id>1</id>
    <in_charge_group_ids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </in_charge_group_ids>
    <last_login_at>sample string 9</last_login_at>
    <last_session_at>sample string 8</last_session_at>
    <member_name>sample string 3</member_name>
    <role>sample string 4</role>
    <status>sample string 5</status>
    <super_admin>true</super_admin>
  </SplashtopController.userQueryInfo>
</ArrayOfSplashtopController.userQueryInfo>