POST api/Permissions/Reports/ClientUsers

Searches the client users and reports their permissions.

Request Information

URI Parameters

None.

Body Parameters

The user permissions search criteria model.

ESignSystems.SmartSAFE.Models.Security.UserPermissionsSearchCriteriaModel

Name	Description	Type	Additional information
ClientId	Gets or sets property to search by client identifier.	integer	None.
OrganizationId	Gets or sets the OrganizationId.	integer	None.
FirstName	Gets or sets property to search by first name.	string	Max length: 50
LastName	Gets or sets property to search by last name.	string	Max length: 50
Username	Gets or sets property to search by user name.	string	Max length: 256
Email	Gets or sets property to search by email address.	string	Max length: 256
Active	Gets or sets a value indicating whether to search only for active users.	boolean	None.
PageSize	Gets or sets the number of rows in the page.	integer	Range: inclusive between 1 and 2147483647
PageOffset	Gets or sets the offset page to return.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientId": 1,
  "OrganizationId": 1,
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "Username": "sample string 3",
  "Email": "sample string 4",
  "Active": true,
  "PageSize": 1,
  "PageOffset": 5
}

application/xml, text/xml

Sample:

<UserPermissionsSearchCriteriaModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Security">
  <PageOffset xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">5</PageOffset>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize>
  <Active>true</Active>
  <ClientId>1</ClientId>
  <Email>sample string 4</Email>
  <FirstName>sample string 1</FirstName>
  <LastName>sample string 2</LastName>
  <OrganizationId>1</OrganizationId>
  <Username>sample string 3</Username>
</UserPermissionsSearchCriteriaModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of results in the form of a dictionary.

Collection of Dictionary of string [key] and Object [value]

Response Formats

application/json, text/json

Sample:

[
  {
    "sample string 1": {},
    "sample string 3": {}
  },
  {
    "sample string 1": {},
    "sample string 3": {}
  }
]

application/xml, text/xml

Sample:

<ArrayOfArrayOfKeyValueOfstringanyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <ArrayOfKeyValueOfstringanyType>
    <KeyValueOfstringanyType>
      <Key>sample string 1</Key>
      <Value />
    </KeyValueOfstringanyType>
    <KeyValueOfstringanyType>
      <Key>sample string 3</Key>
      <Value />
    </KeyValueOfstringanyType>
  </ArrayOfKeyValueOfstringanyType>
  <ArrayOfKeyValueOfstringanyType>
    <KeyValueOfstringanyType>
      <Key>sample string 1</Key>
      <Value />
    </KeyValueOfstringanyType>
    <KeyValueOfstringanyType>
      <Key>sample string 3</Key>
      <Value />
    </KeyValueOfstringanyType>
  </ArrayOfKeyValueOfstringanyType>
</ArrayOfArrayOfKeyValueOfstringanyType>