User collection allows to manage users in Maximizer CRM. Take in count below considerations when using it:
-
Object only supports read operation.\
-
The helper $CURRENTUSER() allows to read properties for the user peforming the operation. See example Read - Lead permissions for current user.\
-
Endpoint allows to read full details of permissions, roles and privileges for the users.
HowTo's
Read - User details for current user
Use the AbEntryRead method to search for Address Book entries in the database.
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"User": {
"Scope": {
"Fields": {
"Key": {
"Uid": 1,
"Value": 1,
"DisplayValue": 1
},
"Password": 1,
"MrMs": 1,
"FirstName": 1,
"LastName": 1,
"DisplayName": 1,
"Salutation": 1,
"CompanyName": 1,
"Position": 1,
"Department": 1,
"Division": 1,
"ReportsTo": {
"Uid": 1,
"Value": 1,
"DisplayValue": 1
},
"Address": {
"AddressLine1": 1,
"AddressLine2": 1,
"City": 1,
"Country": 1,
"StateProvince": 1,
"ZipCode": 1
},
"Phone1": {
"Number": 1,
"Extension": 1,
"Default": 1
},
"Phone2": {
"Number": 1,
"Extension": 1,
"Default": 1
},
"Phone3": {
"Number": 1,
"Extension": 1,
"Default": 1
},
"Phone4": {
"Number": 1,
"Extension": 1,
"Default": 1
},
"Email1": {
"Address": 1,
"Default": 1,
"Description": 1
},
"Email2": {
"Address": 1,
"Default": 1,
"Description": 1
},
"Email3": {
"Address": 1,
"Default": 1,
"Description": 1
},
"AccessType": 1,
"Disabled": 1,
"Roles": {
"Administrator": 1,
"SalesManager": 1,
"SalesRepresentative": 1,
"CustomerServiceManager": 1,
"CustomerServiceRepresentative": 1,
"KnowledgeBaseApprover": 1
},
"Permissions": {
"AccountSetup": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"UserDefinedFieldSetup": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"AddressBook": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"AltAddress": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"CustomerService": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Opportunity": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"UserDefinedFields": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Notes": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Documents": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"KnowledgeBase": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Campaign": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"ActionPlanLibrary": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"CompanyLibrary": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Quota": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Dashboard": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"ProductSetup": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"interactionLog": {
"Read": 1,
"Create": 1,
"Update": 1,
"Delete": 1
}
},
"Privileges": {
"GlobalEdit": 1,
"PublicEntries": 1,
"PrivateEntries": 1,
"Import": 1,
"Export": 1,
"SyncContacts": 1,
"ModifySystemTables": 1,
"ModifyNoteProperties": 1,
"ModifyEmailTemplates": 1,
"ModifyKeyFields": 1,
"BypassUserDetailPermissions": 1,
"BypassEntryPermissions": 1,
"BypassNotePermissions": 1,
"ManageCurrencies": 1,
"AccessAuditLog": 1
}
}
},
"Criteria": {
"SearchQuery": {
"Key": {
"$EQ": "$CURRENTUSER()"
}
}
}
},
"Configuration": {
"Drivers": {
"IUserSearcher": "Maximizer.Model.Access.Sql.UserSearcher"
}
}
}Read - Lead permissions for current user
Use the AbEntryRead method to search for Address Book entries in the database.
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"User": {
"Scope": {
"Fields": {
"Key": 1,
"DisplayValue": 1,
"Email": 1,
"Permissions": {
"Lead": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
}
}
}
},
"Criteria": {
"SearchQuery": {
"Key": {
"$EQ": "$CURRENTUSER()"
}
}
}
}
}Read - User permissions for specific user
Use the AbEntryRead method to search for Address Book entries in the database.
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"User": {
"Scope": {
"Fields": {
"Key": {
"Uid": 1,
"Value": 1
},
"FirstName": 1,
"LastName": 1,
"Email": {
"Address": 1,
"Description": 1
},
"Permissions": {
"Lead": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"UserDefinedFieldSetup": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"AddressBook": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"AltAddress": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"CustomerService": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Opportunity": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"UserDefinedFields": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Notes": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Documents": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"KnowledgeBase": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Campaign": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"ActionPlanLibrary": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"CompanyLibrary": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Quota": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Dashboard": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"ProductSetup": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"interactionLog": {
"Read": 1,
"Create": 1,
"Update": 1,
"Delete": 1
}
},
"Enabled": 1
}
},
"Criteria": {
"SearchQuery": {
"Key": {
"$EQ": {
"Uid": "MASTER"
}
}
}
}
},
"Configuration": {
"Drivers": {
"IUserSearcher": "Maximizer.Model.Access.Sql.UserSearcher"
}
}
}Read - Users using like operator, paging and sorting
Use the AbEntryRead method to search for Address Book entries in the database.
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"User": {
"Scope": {
"Fields": {
"Key": {
"Uid": 1,
"Value": 1
},
"FirstName": 1,
"LastName": 1,
"Email": {
"Address": 1,
"Description": 1
},
"Enabled": 1
}
},
"Criteria": {
"SearchQuery": {
"$OR": [
{
"FirstName": {
"$LIKE": "%DMI%"
}
},
{
"LastName": {
"$LIKE": "%DMI%"
}
},
{
"Email": {
"Address": {
"$LIKE": "%DMI%"
}
}
}
]
}
},
"OrderBy": {
"PageKey": null,
"PageSize": 50,
"Fields": [
{
"FirstName": "ASC"
}
]
}
},
"Configuration": {
"Drivers": {
"IUserSearcher": "Maximizer.Model.Access.Sql.UserSearcher"
}
}
}Read - All enabled users
Use the AbEntryRead method to search for Address Book entries in the database.
// POST https://api.maximizer.com/octopus/UserRead
// Authorization: Bearer <token>
{
"User": {
"Scope": {
"Fields": {
"Key": {
"Uid": 1,
"Value": 1
},
"DisplayValue": 1
}
},
"Criteria": {
"SearchQuery": {
"Enabled": {
"$EQ": true
}
}
}
},
"Configuration": {
"Drivers": { // Required to support usage of Enabled property
"IUserSearcher": "Maximizer.Model.Access.Sql.UserSearcher"
}
}
}MetaData
Read User metadata (simple)
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"Schema": {
"Scope": {
"Fields": 1
},
"Criteria": {
"SearchQuery": {
"Key": {
"$TREE": "/User"
}
}
}
},
"Compatibility": {
"SchemaObject": "1.0"
}
}Read User metadata (more)
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"Schema": {
"Scope": {
"Fields": {
"Key": 1,
"Alias": 1,
"Type": 1,
"Name": 1,
"AppliesTo": 1,
"Sortable": 1,
"Queryable": 1,
"Mandatory": 1,
"Attributes": 1,
"DisplayValue": 1
}
},
"Criteria": {
"SearchQuery": {
"Key": {
"$TREE": "/User"
}
}
}
},
"Compatibility": {
"SchemaObject": "1.0"
}
}User CRUD
Read - User
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"User": {
"Scope": {
"Fields": {
"Key": {
"Uid": 1,
"Value": 1,
"DisplayValue": 1
},
"Password": 1,
"MrMs": 1,
"FirstName": 1,
"LastName": 1,
"DisplayName": 1,
"Salutation": 1,
"CompanyName": 1,
"Position": 1,
"Department": 1,
"Division": 1,
"ReportsTo": {
"Uid": 1,
"Value": 1,
"DisplayValue": 1
},
"Address": {
"AddressLine1": 1,
"AddressLine2": 1,
"City": 1,
"Country": 1,
"StateProvince": 1,
"ZipCode": 1
},
"Phone1": {
"Number": 1,
"Extension": 1,
"Default": 1
},
"Phone2": {
"Number": 1,
"Extension": 1,
"Default": 1
},
"Phone3": {
"Number": 1,
"Extension": 1,
"Default": 1
},
"Phone4": {
"Number": 1,
"Extension": 1,
"Default": 1
},
"Email1": {
"Address": 1,
"Default": 1,
"Description": 1
},
"Email2": {
"Address": 1,
"Default": 1,
"Description": 1
},
"Email3": {
"Address": 1,
"Default": 1,
"Description": 1
},
"AccessType": 1,
"Disabled": 1,
"Roles": {
"Administrator": 1,
"SalesManager": 1,
"SalesRepresentative": 1,
"CustomerServiceManager": 1,
"CustomerServiceRepresentative": 1,
"KnowledgeBaseApprover": 1
},
"Permissions": {
"AccountSetup": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"UserDefinedFieldSetup": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"AddressBook": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"AltAddress": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"CustomerService": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Opportunity": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"UserDefinedFields": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Notes": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Documents": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"KnowledgeBase": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Campaign": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"ActionPlanLibrary": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"CompanyLibrary": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Quota": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"Dashboard": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"ProductSetup": {
"Create": 1,
"Read": 1,
"Update": 1,
"Delete": 1
},
"interactionLog": {
"Read": 1,
"Create": 1,
"Update": 1,
"Delete": 1
}
},
"Privileges": {
"GlobalEdit": 1,
"PublicEntries": 1,
"PrivateEntries": 1,
"Import": 1,
"Export": 1,
"SyncContacts": 1,
"ModifySystemTables": 1,
"ModifyNoteProperties": 1,
"ModifyEmailTemplates": 1,
"ModifyKeyFields": 1,
"BypassUserDetailPermissions": 1,
"BypassEntryPermissions": 1,
"BypassNotePermissions": 1,
"ManageCurrencies": 1,
"AccessAuditLog": 1
}
}
},
"Criteria": {
"SearchQuery": {},
"Top": 10
}
},
"Configuration": {
"Drivers": {
"IUserSearcher": "Maximizer.Model.Access.Sql.UserSearcher"
}
}
}