|
/company/{CompanyCode}/users
|
|
/company/{CompanyCode}/users/{UserPrincipalName}
|
|
/company/{CompanyCode}/users/{UserPrincipalName}/mailbox
|
{
"iD": 0,
"userGuid": "f2a6065c-7e5c-4358-a191-8082b278ccdd",
"companyCode": null,
"sAMAccountName": null,
"userPrincipalName": "Ali.Cattanach@sfgate.com",
"distinguishedName": "CN=Ali.Cattanach@sfgate.com,OU=AIV,OU=KNO,OU=Live Environment,DC=lab,DC=compsys,DC=com",
"displayName": null,
"firstname": null,
"middlename": null,
"lastname": null,
"email": "Ali.Cattanach@sfgate.com",
"department": null,
"description": null,
"skype": null,
"facebook": null,
"twitter": null,
"dribbble": null,
"tumblr": null,
"linkedIn": null,
"isResellerAdmin": null,
"isCompanyAdmin": null,
"isEnabled": null,
"disabledDate": null,
"isLockedOut": null,
"passwordNeverExpires": null,
"mailboxPlan": null,
"retentionId": null,
"retentionIdName": null,
"archivePlan": null,
"lyncPlan": null,
"activeSyncPlan": null,
"created": null,
"additionalMB": null,
"roleID": null,
"passwordLastSet": null,
"isTwoFactorEnabled": null,
"role": null,
"apiKey": null,
"retentionPolicy": null,
"userMessageTrackingCount": null,
"citrixDesktopGroups": null,
"citrixApplications": null,
"activeSyncDevices": null,
"delayedUserTasks": null,
"name": null,
"password": null,
"street": null,
"city": null,
"state": null,
"postalCode": null,
"pOBox": null,
"country": null,
"countryName": null,
"company": null,
"jobTitle": null,
"telephoneNumber": null,
"fax": null,
"homePhone": null,
"mobilePhone": null,
"pager": null,
"iPPhone": null,
"office": null,
"notes": null,
"profilePath": null,
"scriptPath": null,
"webpage": null,
"badPwdCount": 0,
"userAccountControl": 0,
"samAccountType": 0,
"badPasswordTime": 0,
"pwdLastSet": 0,
"accountExpires": 0,
"memberOf": null,
"imageFromAD": null,
"changePasswordNextLogin": false,
"adLastLogon": null,
"securityGroups": null,
"exchangeGuid": "fe96cd9e-9263-44ba-9451-ae2758b8f476",
"isLitigationHoldEnabled": false,
"hasPossibleMailbox": false,
"hasPossibleArchive": false,
"isEmailEnabled": false,
"isArchivingEnabled": false,
"archiveName": "",
"archiveMailboxDatabase": null,
"archiveDatabase": null,
"archivingEnabled": false,
"emailDomain": "sfgate.com",
"emailFirst": "Ali.Cattanach",
"sizeInMB": 0,
"domainID": 0,
"emailAddressesProcessed": null,
"emailAliases": [],
"emailFullAccess": null,
"emailFullAccessOriginal": null,
"emailSendAs": null,
"emailSendAsOriginal": null,
"emailSendOnBehalf": null,
"litigationHoldDate": null,
"litigationHoldOwner": "",
"litigationHoldDuration": null,
"retentionComment": "",
"retentionUrl": "",
"forwardTo": null,
"canoncialName": null,
"mailboxDatabase": null,
"activeSyncMailboxPolicy": "Default",
"oWAMailboxPolicy": null,
"autoMapping": false,
"deliverToMailboxAndForward": false,
"mailboxSizeInBytes": 0,
"archiveSizeInBytes": 0,
"msExchMailboxGuid": "00000000-0000-0000-0000-000000000000",
"msExchArchiveGUID": "00000000-0000-0000-0000-000000000000",
"hiddenFromAddressListsEnabled": false,
"mailboxLastLogon": null,
"distributionGroups": null,
"isChecked": false,
"isMailboxEnabled": false,
"isEmailModified": false,
"isLitigationHoldModified": false,
"isArchivingModified": false
}
¶ Retrieves a user’s out of office message for internal and external replies
/company/{CompanyCode}/users/{UserPrincipalName}/mailbox/outofoffice
|
{
"autoReplyState": "Disabled",
"externalMessage": "",
"internalMessage": "",
"startTime": "2021-10-05T12:00:00.0000000-05:00",
"endTime": "2021-10-06T12:00:00.0000000-05:00",
"externalAudience": "All",
"identity": "f2a6065c-7e5c-4358-a191-8082b278ccdd"
}
¶ Retrieves the full access, send as and send on behalf permissions assigned to the mailbox
/company/{CompanyCode}/users/{UserPrincipalName}/mailbox/permissions
|
{
"fullAccess": [],
"sendAs": [],
"sendOnBehalf": [
{
"userGuid": "82668e51-60c5-47d0-9fc2-28f3d653b795",
"sAMAccountName": "JannaLim_sfgatecom",
"userPrincipalName": "Janna.Limeburn@sfgate.com",
"displayName": "Janna Limeburn",
"email": null,
"department": null,
"canonicalName": "lab.compsys.com/Live Environment/KNO/AIV/Janna.Limeburn@sfgate.com"
}
]
}
|
/company/{CompanyCode}/users/{UserPrincipalName}/mailbox/permissions/fullaccess
|
| Parameter |
Type |
Notes |
| user |
Guid |
The user’s unique identifier (Userguid) from Active Directory |
| automapping |
Boolean |
If automapping is enabled for this user is or not |
|
/company/{CompanyCode}/users/{UserPrincipalName}/mailbox/permissions/fullaccess/{UserGuid}
|
| Parameter |
Type |
Notes |
| UserGuid |
Guid |
The user’s unique identifier (Userguid) from Active Directory that you are removing from having full access rights |
|
/company/{CompanyCode}/users/{UserPrincipalName}/mailbox/permissions/sendas
|
| Parameter |
Type |
Notes |
| user |
Guid |
The user’s unique identifier (Userguid) from Active Directory |
|
/company/{CompanyCode}/users/{UserPrincipalName}/mailbox/permissions/sendas/{UserGuid}
|
| Parameter |
Type |
Notes |
| UserGuid |
Guid |
The user’s unique identifier (Userguid) from Active Directory that you are removing from having full access rights |
|
/company/{CompanyCode}/users/{UserPrincipalName}/mailbox/permissions/sendonbehalf
|
| Parameter |
Type |
Notes |
| N/A |
Array |
List of user guid’s to add |
|
/company/{CompanyCode}/users/{UserPrincipalName}/mailbox/permissions/sendonbehalf/{UserGuid}
|
| Parameter |
Type |
Notes |
| N/A |
Array |
Array of canonical names of the user(s) you are removing from having send-on-behalf access or pass nothing / null to remove all |
|
/company/{CompanyCode}/users/{UserPrincipalName}/mailbox/mobiledevices
|
{
{
"iD": 0,
"userID": 0,
"objectGuid": "4872c7e5-383e-48e6-b4cb-fe08ad3ec6ac",
"identity": "",
"deviceId": "39d90cfb17824c8196a59c81b4183653",
"deviceType": "Outlook",
"deviceUserAgent": "Outlook-iOS-Android/1.0",
"deviceModel": "Outlook for iOS and Android",
"deviceImei": null,
"deviceFriendlyName": null,
"deviceOS": "OutlookBasicAuth",
"deviceOSLanguage": null,
"devicePhoneNumber": null,
"deviceMobileOperator": null,
"devicePolicyApplied": "Default",
"devicePolicyApplicationStatus": "AppliedInFull",
"clientVersion": "14.1",
"numberOfFoldersSynced": 111,
"isRemoteWipeSupported": true,
"firstSyncTime": "2020-04-16T19:22:13.8539997Z",
"lastPolicyUpdateTime": "2020-04-16T19:22:14.1592730Z",
"lastSuccessSync": "2020-05-23T05:25:26.2712540Z",
"lastSyncAttemptTime": "2020-05-23T05:25:26.2592447Z",
"deviceAccessState": "Allowed",
"deviceAccessStateReason": "Global",
"status": "DeviceOk",
"statusNote": "",
"user": null,
"deviceWipeSentTime": null,
"deviceWipeRequestTime": null,
"deviceWipeAckTime": null,
"lastPingHeartbeat": 0,
"userPrincipalName": null,
"displayName": null,
"deviceAccessStateAsHtml": "<span class=\"label label-sm label-success\">Access Granted</span>",
"statusAsHtml": "<span class=\"label label-sm label-success\" data-toggle=\"tooltip\" title=\"\">OK</span>",
"menuButton": ""
}
]
}