POST api/organizationmanagement/user/Create

Creates a new user assigned to the Organization Admin Role

Request Information

URI Parameters

None.

Body Parameters

Model to create a user for.

ESignSystems.SmartSAFE.Models.Admin.UserManagement.RegisterModel

Name	Description	Type	Additional information
Password	Gets or sets the new user's password.	string	Required Data type: Password
ConfirmPassword	Gets or sets the new user's password to confirm.	string	Required Data type: Password
ClientId	Gets or sets the user's client identifier.	integer	None.
OrganizationId	Gets or sets the user's organization identifier.	integer	None.
UserName	Gets or sets the user's user name.	string	Required Max length: 256
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
Email	Gets or sets the user's email address.	string	Required Data type: EmailAddress Matching regular expression pattern: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]+ Max length: 256
PhoneNumber	Gets or sets the user's phone number.	string	Data type: PhoneNumber
Active	Gets or sets a value inticating whether the user is active.	boolean	None.
LockedOut	Gets or sets a value inticating whether the user is locked out.	boolean	None.
SignatureFont	Gets or sets the font of the user's signature.	string	None.
IsAdmin	Gets or sets a value indicating whether or not the user is an admin.	boolean	None.
RequiresPasswordChange	Gets or sets a value indicating whether or not the user must change their password on next login.	boolean	None.
SignatureImage	Gets or sets the user's signature image.	ESignSystems.SmartSAFE.Models.Signing.SignatureImageModel	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.
CustodianId	Gets or sets the custodian id.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Password": "sample string 1",
  "ConfirmPassword": "sample string 2",
  "ClientId": 1,
  "OrganizationId": 1,
  "UserName": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "Email": "sample string 6",
  "PhoneNumber": "sample string 7",
  "Active": true,
  "LockedOut": true,
  "SignatureFont": "sample string 10",
  "IsAdmin": true,
  "RequiresPasswordChange": true,
  "SignatureImage": {
    "UserId": 1,
    "SignatureImage": "sample string 2",
    "InitialsImage": "sample string 3"
  },
  "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
    }
  ],
  "CustodianId": "sample string 13"
}

application/xml, text/xml

Sample:

<RegisterModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Admin.UserManagement">
  <Active>true</Active>
  <ClientId>1</ClientId>
  <Clients xmlns:d2p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Security">
    <d2p1:UserClientAssignmentModel>
      <d2p1:ClientId>1</d2p1:ClientId>
      <d2p1:ClientName>sample string 1</d2p1:ClientName>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:OrganizationId>1</d2p1:OrganizationId>
      <d2p1:UserClientAssignmentId>1</d2p1:UserClientAssignmentId>
      <d2p1:UserId>1</d2p1:UserId>
    </d2p1:UserClientAssignmentModel>
    <d2p1:UserClientAssignmentModel>
      <d2p1:ClientId>1</d2p1:ClientId>
      <d2p1:ClientName>sample string 1</d2p1:ClientName>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:OrganizationId>1</d2p1:OrganizationId>
      <d2p1:UserClientAssignmentId>1</d2p1:UserClientAssignmentId>
      <d2p1:UserId>1</d2p1:UserId>
    </d2p1:UserClientAssignmentModel>
  </Clients>
  <CustodianId>sample string 13</CustodianId>
  <Email>sample string 6</Email>
  <FirstName>sample string 4</FirstName>
  <IsAdmin>true</IsAdmin>
  <LastName>sample string 5</LastName>
  <LockedOut>true</LockedOut>
  <OrganizationId>1</OrganizationId>
  <Permissions xmlns:d2p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Security">
    <d2p1:PermissionAssignmentModel>
      <d2p1:ClientName>sample string 6</d2p1:ClientName>
      <d2p1:Email>sample string 4</d2p1:Email>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:OrganizationName>sample string 5</d2p1:OrganizationName>
      <d2p1:PermissionAssignmentId>1</d2p1:PermissionAssignmentId>
      <d2p1:PermissionId>1</d2p1:PermissionId>
      <d2p1:UserId>1</d2p1:UserId>
      <d2p1:UserName>sample string 1</d2p1:UserName>
    </d2p1:PermissionAssignmentModel>
    <d2p1:PermissionAssignmentModel>
      <d2p1:ClientName>sample string 6</d2p1:ClientName>
      <d2p1:Email>sample string 4</d2p1:Email>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:OrganizationName>sample string 5</d2p1:OrganizationName>
      <d2p1:PermissionAssignmentId>1</d2p1:PermissionAssignmentId>
      <d2p1:PermissionId>1</d2p1:PermissionId>
      <d2p1:UserId>1</d2p1:UserId>
      <d2p1:UserName>sample string 1</d2p1:UserName>
    </d2p1:PermissionAssignmentModel>
  </Permissions>
  <PhoneNumber>sample string 7</PhoneNumber>
  <RequiresPasswordChange>true</RequiresPasswordChange>
  <SignatureFont>sample string 10</SignatureFont>
  <SignatureImage xmlns:d2p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing">
    <d2p1:InitialsImage>sample string 3</d2p1:InitialsImage>
    <d2p1:SignatureImage>sample string 2</d2p1:SignatureImage>
    <d2p1:UserId>1</d2p1:UserId>
  </SignatureImage>
  <UserName>sample string 3</UserName>
  <ConfirmPassword>sample string 2</ConfirmPassword>
  <Password>sample string 1</Password>
</RegisterModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.