POST api/Admin/UserManagement/SearchUsers

Allows a SAFEAdmin to search for users.

Request Information

URI Parameters

None.

Body Parameters

The user search criteria.

ESignSystems.SmartSAFE.Models.Admin.UserManagement.UserSearchCriteriaModel

Name	Description	Type	Additional information
RoleNames	Gets or sets the role names to search by.	Collection of string	None.
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.
AssignedToClientId	Gets or sets the id of the client the user is assigned to.	integer	None.
ExcludeUsersAssignedToClientId	Gets or sets whether to exclude users already assigned to the client.	boolean	None.
PermissionId	Gets or sets the permission identifier.	integer	None.
ExcludeUsersWithPermissionId	Gets or sets whether to exclude users with the permission.	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:

{
  "RoleNames": [
    "sample string 1",
    "sample string 2"
  ],
  "ClientId": 1,
  "OrganizationId": 1,
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "UserName": "sample string 3",
  "Email": "sample string 4",
  "Active": true,
  "AssignedToClientId": 1,
  "ExcludeUsersAssignedToClientId": true,
  "PermissionId": 1,
  "ExcludeUsersWithPermissionId": true,
  "PageSize": 1,
  "PageOffset": 5
}

application/xml, text/xml

Sample:

<UserSearchCriteriaModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Admin.UserManagement">
  <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>
  <AssignedToClientId>1</AssignedToClientId>
  <ClientId>1</ClientId>
  <Email>sample string 4</Email>
  <ExcludeUsersAssignedToClientId>true</ExcludeUsersAssignedToClientId>
  <ExcludeUsersWithPermissionId>true</ExcludeUsersWithPermissionId>
  <FirstName>sample string 1</FirstName>
  <LastName>sample string 2</LastName>
  <OrganizationId>1</OrganizationId>
  <PermissionId>1</PermissionId>
  <UserName>sample string 3</UserName>
  <RoleNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </RoleNames>
</UserSearchCriteriaModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The list of users resulting from the search.

Collection of ESignSystems.SmartSAFE.Models.Security.ApplicationUserModel

Name	Description	Type	Additional information
UserName	Gets or sets the user's user name.	string	Required
FirstName	Gets or sets the user's first name.	string	Required Max length: 50
LastName	Gets or sets the user's last name.	string	Required Max length: 50
FullName	Gets the user's full name.	string	None.
OrganizationId	Gets or sets the user's organization identifier.	integer	None.
OrganizationName	Gets or sets the organization name.	string	None.
ClientId	Gets or sets the user's client identifier.	integer	None.
ClientName	Gets or sets the client name.	string	None.
Id	Gets or sets the user's user identifier.	integer	None.
Email	Gets or sets the user's email address.	string	Required Matching regular expression pattern: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,4}
SignatureFont	Gets or sets the font of the user's signature.	string	None.
PhoneNumber	Gets or sets the user's phone number.	string	Matching regular expression pattern: ^[01]?[- .]?($[2-9]\d{2}$\|[2-9]\d{2})[- .]?\d{3}[- .]?\d{4}$
Password	Gets or sets the user's password when creating a new user.	string	Data type: Password
Active	Gets or sets a value indicating whether the user is active.	boolean	None.
Roles	Gets or sets the list of roles associated to the user.	Collection of string	None.
IsClientAdmin	Gets or sets a value indicating whether or not the user is a client admin.	boolean	None.
IsOrganizationAdmin	Gets or sets a value indicating whether or not the user is an organization admin.	boolean	None.
FeaturePermissions	Gets or sets a list of feature permissions.	Collection of integer	None.
Permissions	Gets or sets the permissions.	Collection of ESignSystems.SmartSAFE.Models.Security.PermissionAssignmentModel	None.
Clients	Gets or sets the clients.	Collection of ESignSystems.SmartSAFE.Models.Security.UserClientAssignmentModel	None.
RequiresPasswordChange	Gets or sets whether the user requires a password change.	boolean	None.
UserManagement	Gets or sets whether the user has the user management permission.	boolean	None.
CustodianId	Gets or sets the custodian id.	string	None.
LockedOut	Gets or sets a value inticating whether the user is locked out.	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "UserName": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "FullName": "sample string 2 sample string 3",
    "OrganizationId": 1,
    "OrganizationName": "sample string 4",
    "ClientId": 1,
    "ClientName": "sample string 5",
    "Id": 6,
    "Email": "sample string 7",
    "SignatureFont": "sample string 8",
    "PhoneNumber": "sample string 9",
    "Password": "sample string 10",
    "Active": true,
    "Roles": [
      "sample string 1",
      "sample string 2"
    ],
    "IsClientAdmin": true,
    "IsOrganizationAdmin": true,
    "FeaturePermissions": [
      1,
      2
    ],
    "Permissions": [
      {
        "PermissionAssignmentId": 1,
        "PermissionId": 1,
        "UserId": 1,
        "UserName": "sample string 1",
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4",
        "OrganizationName": "sample string 5",
        "ClientName": "sample string 6",
        "IsDeleted": true
      },
      {
        "PermissionAssignmentId": 1,
        "PermissionId": 1,
        "UserId": 1,
        "UserName": "sample string 1",
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4",
        "OrganizationName": "sample string 5",
        "ClientName": "sample string 6",
        "IsDeleted": true
      }
    ],
    "Clients": [
      {
        "UserClientAssignmentId": 1,
        "UserId": 1,
        "ClientId": 1,
        "ClientName": "sample string 1",
        "OrganizationId": 1,
        "IsDeleted": true
      },
      {
        "UserClientAssignmentId": 1,
        "UserId": 1,
        "ClientId": 1,
        "ClientName": "sample string 1",
        "OrganizationId": 1,
        "IsDeleted": true
      }
    ],
    "RequiresPasswordChange": true,
    "UserManagement": true,
    "CustodianId": "sample string 16",
    "LockedOut": true
  },
  {
    "UserName": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "FullName": "sample string 2 sample string 3",
    "OrganizationId": 1,
    "OrganizationName": "sample string 4",
    "ClientId": 1,
    "ClientName": "sample string 5",
    "Id": 6,
    "Email": "sample string 7",
    "SignatureFont": "sample string 8",
    "PhoneNumber": "sample string 9",
    "Password": "sample string 10",
    "Active": true,
    "Roles": [
      "sample string 1",
      "sample string 2"
    ],
    "IsClientAdmin": true,
    "IsOrganizationAdmin": true,
    "FeaturePermissions": [
      1,
      2
    ],
    "Permissions": [
      {
        "PermissionAssignmentId": 1,
        "PermissionId": 1,
        "UserId": 1,
        "UserName": "sample string 1",
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4",
        "OrganizationName": "sample string 5",
        "ClientName": "sample string 6",
        "IsDeleted": true
      },
      {
        "PermissionAssignmentId": 1,
        "PermissionId": 1,
        "UserId": 1,
        "UserName": "sample string 1",
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4",
        "OrganizationName": "sample string 5",
        "ClientName": "sample string 6",
        "IsDeleted": true
      }
    ],
    "Clients": [
      {
        "UserClientAssignmentId": 1,
        "UserId": 1,
        "ClientId": 1,
        "ClientName": "sample string 1",
        "OrganizationId": 1,
        "IsDeleted": true
      },
      {
        "UserClientAssignmentId": 1,
        "UserId": 1,
        "ClientId": 1,
        "ClientName": "sample string 1",
        "OrganizationId": 1,
        "IsDeleted": true
      }
    ],
    "RequiresPasswordChange": true,
    "UserManagement": true,
    "CustodianId": "sample string 16",
    "LockedOut": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfApplicationUserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Security">
  <ApplicationUserModel>
    <Active>true</Active>
    <ClientId>1</ClientId>
    <ClientName>sample string 5</ClientName>
    <Clients>
      <UserClientAssignmentModel>
        <ClientId>1</ClientId>
        <ClientName>sample string 1</ClientName>
        <IsDeleted>true</IsDeleted>
        <OrganizationId>1</OrganizationId>
        <UserClientAssignmentId>1</UserClientAssignmentId>
        <UserId>1</UserId>
      </UserClientAssignmentModel>
      <UserClientAssignmentModel>
        <ClientId>1</ClientId>
        <ClientName>sample string 1</ClientName>
        <IsDeleted>true</IsDeleted>
        <OrganizationId>1</OrganizationId>
        <UserClientAssignmentId>1</UserClientAssignmentId>
        <UserId>1</UserId>
      </UserClientAssignmentModel>
    </Clients>
    <CustodianId>sample string 16</CustodianId>
    <Email>sample string 7</Email>
    <FeaturePermissions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </FeaturePermissions>
    <FirstName>sample string 2</FirstName>
    <Id>6</Id>
    <IsClientAdmin>true</IsClientAdmin>
    <IsOrganizationAdmin>true</IsOrganizationAdmin>
    <LastName>sample string 3</LastName>
    <LockedOut>true</LockedOut>
    <OrganizationId>1</OrganizationId>
    <OrganizationName>sample string 4</OrganizationName>
    <Password>sample string 10</Password>
    <Permissions>
      <PermissionAssignmentModel>
        <ClientName>sample string 6</ClientName>
        <Email>sample string 4</Email>
        <FirstName>sample string 2</FirstName>
        <IsDeleted>true</IsDeleted>
        <LastName>sample string 3</LastName>
        <OrganizationName>sample string 5</OrganizationName>
        <PermissionAssignmentId>1</PermissionAssignmentId>
        <PermissionId>1</PermissionId>
        <UserId>1</UserId>
        <UserName>sample string 1</UserName>
      </PermissionAssignmentModel>
      <PermissionAssignmentModel>
        <ClientName>sample string 6</ClientName>
        <Email>sample string 4</Email>
        <FirstName>sample string 2</FirstName>
        <IsDeleted>true</IsDeleted>
        <LastName>sample string 3</LastName>
        <OrganizationName>sample string 5</OrganizationName>
        <PermissionAssignmentId>1</PermissionAssignmentId>
        <PermissionId>1</PermissionId>
        <UserId>1</UserId>
        <UserName>sample string 1</UserName>
      </PermissionAssignmentModel>
    </Permissions>
    <PhoneNumber>sample string 9</PhoneNumber>
    <RequiresPasswordChange>true</RequiresPasswordChange>
    <Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Roles>
    <SignatureFont>sample string 8</SignatureFont>
    <UserManagement>true</UserManagement>
    <UserName>sample string 1</UserName>
  </ApplicationUserModel>
  <ApplicationUserModel>
    <Active>true</Active>
    <ClientId>1</ClientId>
    <ClientName>sample string 5</ClientName>
    <Clients>
      <UserClientAssignmentModel>
        <ClientId>1</ClientId>
        <ClientName>sample string 1</ClientName>
        <IsDeleted>true</IsDeleted>
        <OrganizationId>1</OrganizationId>
        <UserClientAssignmentId>1</UserClientAssignmentId>
        <UserId>1</UserId>
      </UserClientAssignmentModel>
      <UserClientAssignmentModel>
        <ClientId>1</ClientId>
        <ClientName>sample string 1</ClientName>
        <IsDeleted>true</IsDeleted>
        <OrganizationId>1</OrganizationId>
        <UserClientAssignmentId>1</UserClientAssignmentId>
        <UserId>1</UserId>
      </UserClientAssignmentModel>
    </Clients>
    <CustodianId>sample string 16</CustodianId>
    <Email>sample string 7</Email>
    <FeaturePermissions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </FeaturePermissions>
    <FirstName>sample string 2</FirstName>
    <Id>6</Id>
    <IsClientAdmin>true</IsClientAdmin>
    <IsOrganizationAdmin>true</IsOrganizationAdmin>
    <LastName>sample string 3</LastName>
    <LockedOut>true</LockedOut>
    <OrganizationId>1</OrganizationId>
    <OrganizationName>sample string 4</OrganizationName>
    <Password>sample string 10</Password>
    <Permissions>
      <PermissionAssignmentModel>
        <ClientName>sample string 6</ClientName>
        <Email>sample string 4</Email>
        <FirstName>sample string 2</FirstName>
        <IsDeleted>true</IsDeleted>
        <LastName>sample string 3</LastName>
        <OrganizationName>sample string 5</OrganizationName>
        <PermissionAssignmentId>1</PermissionAssignmentId>
        <PermissionId>1</PermissionId>
        <UserId>1</UserId>
        <UserName>sample string 1</UserName>
      </PermissionAssignmentModel>
      <PermissionAssignmentModel>
        <ClientName>sample string 6</ClientName>
        <Email>sample string 4</Email>
        <FirstName>sample string 2</FirstName>
        <IsDeleted>true</IsDeleted>
        <LastName>sample string 3</LastName>
        <OrganizationName>sample string 5</OrganizationName>
        <PermissionAssignmentId>1</PermissionAssignmentId>
        <PermissionId>1</PermissionId>
        <UserId>1</UserId>
        <UserName>sample string 1</UserName>
      </PermissionAssignmentModel>
    </Permissions>
    <PhoneNumber>sample string 9</PhoneNumber>
    <RequiresPasswordChange>true</RequiresPasswordChange>
    <Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Roles>
    <SignatureFont>sample string 8</SignatureFont>
    <UserManagement>true</UserManagement>
    <UserName>sample string 1</UserName>
  </ApplicationUserModel>
</ArrayOfApplicationUserModel>