Back

GET api/v1/Users/Detail

Requires Authorization

Get user details for logged in user.

Request Information

URI Parameters

None.

Body Parameters

None.

Sample Request

Response Information

Resource Description

UserDetailViewModel

Name	Description	Type	Additional information
Name	User name	string	None.
Address	User email Address	string	None.
Language	User's default culture / language	string	None.
Status	User status	string	None.
Authorized	Indicates if user is authorized or not	boolean	None.
CustomerName	Name of the customer user is associated to	string	None.
ApplicationSettings	Application Settings for the user	ApplicationSettingModel	None.

Sample Response

application/json, text/json

Sample:

{
  "Name": "J Smith",
  "Address": "jsmith@example.com",
  "Language": "en-us",
  "Status": "Active",
  "Authorized": true,
  "CustomerName": "Customer & Company",
  "ApplicationSettings": {
    "ServiceBrand": null,
    "Language": null,
    "DateFormat": null,
    "LocalTimeZone": null,
    "AttachXmlServiceEmails": null,
    "SendAcknowledgement": null,
    "SendUnmarked": null,
    "SendPassword": true,
    "SetPassword": true,
    "RetrievePassword": true,
    "Tls": true,
    "SecureReplyEnabled": null,
    "MinimumTlsVersion": null,
    "SecureReplyLandingPage": null,
    "EsignExpiration": null,
    "Annotation": true,
    "HandSignMethod": null,
    "EsignSequential": true,
    "EsignShowClientCode": false,
    "EsignSignaturePageFirst": 0,
    "EsignLandingPage": null,
    "LargeMailDownloadExpiration": 30,
    "LargeMailDownloadReminder": 7,
    "EnableLargeMailDownloadNotice": true,
    "SecureMailAttachmentDisplayOption": 0,
    "SecureMailDownloadExpiration": 14,
    "SecureMailDownloadReminder": 0,
    "EnableSecureMailDownloadNotice": true,
    "MaxReceiptMessageSize": null,
    "ReceiptCopyDestination": null,
    "ReceiptRerouteDestination": null,
    "EsignContractCopyDestination": null,
    "EsignContractRerouteDestination": null,
    "TrackUnmarkedEmail": null,
    "SendRegisteredReplyAck": null,
    "SendSecureReplyAck": null,
    "SendRegisteredReplyRcpt": null,
    "SendSecureReplyRcpt": null,
    "CopyMeEnabled": null,
    "EncryptionEnabled": null,
    "EncryptionOption": null,
    "EncryptionOptionCustom": null,
    "EncryptionOptionCustomPassword": null,
    "EncryptionOptionCustomPasswordEmail": null,
    "ESignEnabled": null,
    "LanguageApp": null,
    "LargeFileTransferEnabled": null,
    "LargeFileTransferSendAuto": null,
    "LargeFileTransferSendByLargeMail": null,
    "SideNoteEnabled": null,
    "SideNoteCc": null,
    "SideNoteBcc": null,
    "SignatureUrl": null,
    "SignatureImageUrl": null,
    "SignatureText": null,
    "TrackProveEnabled": null,
    "AckRerouteAddress": null,
    "EsignSignatureAuthentication": null,
    "DocumentAnnotate": null,
    "PrefixRegisteredToSubject": null,
    "LargeMailDwnldNoticeCopyAddress": null,
    "LargeMailDwnldNoticeRerouteAddress": null,
    "SecureMailDwnldNoticeCopyAddress": null,
    "SecureMailDwnldNoticeRerouteAddress": null,
    "SendSigningNotice": null,
    "RequestReadReceipt": null,
    "OneTimeDownload": null,
    "AllowSigningByNonRecipientAddress": null,
    "AttachOfferPDF": null,
    "DigitalSeal": null,
    "RedactSetting": null,
    "GenerateEsignTransparency": null,
    "SigningDestinationColor": null,
    "IsSigningLabel": null,
    "SigningLabelValue": null
  }
}