Users are individuals who have access to some part of Sage Intacct. Most users are employees, but users might also be outside the company, such as accountants, attorneys, bankers, vendors, customers, or auditors.
Any person that wants to log in through the UI or API must have a unique user record.
Returns a collection with a key, ID, and link for each user. This operation is mostly for use in testing; use the query service to find users that meet certain criteria and specify the properties that are returned.
OK
Bad Request
{- "ia::result": [
- {
- "key": "1",
- "id": "Admin",
- "href": "/objects/company-config/user/1"
}, - {
- "key": "2",
- "id": "Jane Doe",
- "href": "/objects/company-config/user/2"
}, - {
- "key": "4",
- "id": "Larry Smith",
- "href": "/objects/company-config/user/4"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new user. The user must be associated with a new or existing contact.
User to create
id required | string User login ID. This unique identifier cannot be changed after the user is created. Example: "john.doe" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
accountEmail required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object The contact associated with this user. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
userName | string The name that will be used to identify the user. This name is displayed in the user interface. Example: "John Doe" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
userType | string Default: "business" The user type for this user. User types determines the maximum set of features and activities that a user can access and perform in Intacct. The things a user can do also depend on the permissions that are assigned to the user. For more information see User types Example: "employee" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
adminPrivileges | string Default: "off" User admin privileges.
Example: "off" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string Default: "active" User status.
Example: "active" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Settings for use of the Sage Intacct Web Services (API). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Password properties. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Single sign-on settings for the user. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Entity level restrictions. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
trustedDevices | string Default: "companyDefault" Whether to recognize trusted devices for the user-- always, never, or use the company setting. Example: "always" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
isChatterDisabled | boolean Default: false Specifies whether the Intacct Collaborate feature is disabled for the user. Example: false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
hideOtherDepartmentTransactions | boolean Default: false Specifies whether to hide transactions from this user that do not belong to the departments listed in the Example: false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Deprecated This field is deprecated, please use entities. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Company entities that the user is allowed to view and work with. Leave empty to allow the user to work with all entities. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Departments that the user is allowed to view and work with. Leave empty to allow the user to work with all departments. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects List of territories that the user is assigned to. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects List of roles assigned to the user. The array will be empty for companies that have user-based permissions. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Array of objects that define the permissions and access rights assigned to the user. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Array of objects that define the user's permissions and access rights for custom applications. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object The entity that the user is associated with. Users created at the top level do not have an entity reference so the | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Created
Bad Request
{- "id": "Admin",
- "userName": "Admin",
- "userType": "business",
- "adminPrivileges": "full",
- "contact": {
- "id": "jsmith",
- "permissionAssignments": [
- {
- "permission": {
- "key": "404"
}, - "accessRights": [
- "list",
- "delete"
]
}, - {
- "permission": {
- "key": "253"
}, - "accessRights": [
- "list"
]
}
]
}, - "customPermissionAssignments": [
- {
- "application": {
- "key": "10002",
- "permission": [
- {
- "name": "Product Lines",
- "group": "objects"
}
]
}, - "accessRights": [
- "list",
- "readonly",
- "template"
]
}
]
}
{- "ia::result": {
- "key": "102",
- "id": "Admin",
- "href": "/objects/company-config/user/102"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified user.
key required | string System-assigned key for a user. Example: 65 |
OK
Bad Request
{- "ia::result": {
- "id": "Admin",
- "userName": "Admin",
- "contact": {
- "mailingAddress": {
- "addressLine1": "744 Edgewater Blvd",
- "addressLine2": "Apt 104",
- "addressLine3": "Western industrial area",
- "city": "San Jose",
- "state": "CA",
- "postCode": "95110",
- "country": "United States"
}, - "id": "contact01650967341",
- "lastName": "John",
- "firstName": "E.",
- "middleName": "Doe",
- "prefix": "Mr",
- "printAs": "John E. Doe",
- "phone1": "6692248123",
- "phone2": null,
- "mobile": "1222455566",
- "pager": null,
- "fax": "1222455566",
- "URL2": null,
- "companyName": "Sage Inc",
- "key": "3446",
- "href": "/objects/company-config/contact/3446"
}, - "adminPrivileges": "off",
- "userType": "business",
- "webServices": {
- "isEnabled": true,
- "isRestricted": false
}, - "status": "active",
- "entityAccess": {
- "allowUnrestrictedAccess": true,
- "allowTopLevelAccess": false
}, - "password": {
- "neverExpires": true,
- "requiresReset": false,
- "disablePassword": false
}, - "audit": {
- "createdDateTime": "2022-04-26T10:17:12Z",
- "modifiedDateTime": "2022-04-26T11:05:26Z",
- "createdBy": "12",
- "modifiedBy": "13",
- "createdByUser": {
- "key": "12",
- "id": "Admin",
- "href": "/objects/company-config/user/12"
}, - "modifiedByUser": {
- "key": "13",
- "id": "Aman",
- "href": "/objects/company-config/user/13"
}
}, - "key": "65",
- "isChatterDisabled": false,
- "hideOtherDepartmentTransactions": false,
- "entity": {
- "key": "54",
- "id": "313131",
- "name": "Central Region",
- "href": "/objects/company-config/entity/54"
}, - "locations": [
- {
- "key": "87",
- "id": "London",
- "href": "/objects/company-config/location/87"
}, - {
- "key": "92",
- "id": "Paris",
- "href": "/objects/company-config/location/92"
}
], - "departments": [
- {
- "key": "55",
- "id": "Sales",
- "href": "/objects/company-config/department/55"
}, - {
- "key": "65",
- "id": "Accounting",
- "href": "/objects/company-config/department/65"
}
], - "territories": [
- {
- "key": "22",
- "id": "South",
- "href": "/objects/accounts-receivable/territory/22"
}, - {
- "key": "32",
- "id": "West",
- "href": "/objects/accounts-receivable/territory/32"
}
], - "roles": [
- {
- "key": "2",
- "id": "::SYS::Multi Entity Shared-ROLE-FOR - Admin",
- "href": "/objects/company-config/role/2"
}, - {
- "key": "23",
- "id": "::SYS::Multi Entity Shared-ROLE-FOR - User",
- "href": "/objects/company-config/role/23"
}
], - "permissionAssignments": [
- {
- "permission": {
- "id": "404",
- "key": "404",
- "href": "/objects/company-config/permission/404"
}, - "accessRights": [
- "list",
- "delete"
]
}, - {
- "permission": {
- "id": "253",
- "key": "253",
- "href": "/objects/company-config/permission/253"
}, - "accessRights": [
- "list",
- "delete"
]
}
], - "customPermissionAssignments": [
- {
- "application": {
- "key": "10002",
- "id": "Intacct Database Services",
- "href": "/objects/platform/custom-application/10002",
- "permission": [
- {
- "name": "Product Lines",
- "group": "objects"
}
]
}, - "accessRights": [
- "list",
- "readonly"
]
}
], - "sso": {
- "isSSOEnabled": true,
- "federatedSSOId": "john.doe"
}, - "trustedDevices": "never",
- "href": "/objects/company-config/user/65"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing user by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned key for a user. Example: 65 |
userName | string The name that will be used to identify the user. This name is displayed in the user interface. Example: "John Doe" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
accountEmail | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
userType | string Default: "business" The user type for this user. User types determines the maximum set of features and activities that a user can access and perform in Intacct. The things a user can do also depend on the permissions that are assigned to the user. For more information see User types Example: "employee" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
adminPrivileges | string Default: "off" User admin privileges.
Example: "off" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string Default: "active" User status.
Example: "active" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Settings for use of the Sage Intacct Web Services (API). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Password properties. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Single sign-on settings for the user. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Entity level restrictions. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object The contact associated with this user. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
trustedDevices | string Default: "companyDefault" Whether to recognize trusted devices for the user-- always, never, or use the company setting. Example: "always" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
isChatterDisabled | boolean Default: false Specifies whether the Intacct Collaborate feature is disabled for the user. Example: false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
hideOtherDepartmentTransactions | boolean Default: false Specifies whether to hide transactions from this user that do not belong to the departments listed in the Example: false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Deprecated This field is deprecated, please use entities. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Company entities that the user is allowed to view and work with. Leave empty to allow the user to work with all entities. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Departments that the user is allowed to view and work with. Leave empty to allow the user to work with all departments. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects List of territories that the user is assigned to. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects List of roles assigned to the user. The array will be empty for companies that have user-based permissions. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Array of objects that define the permissions and access rights assigned to the user. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Array of objects that define the user's permissions and access rights for custom applications. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object The entity that the user is associated with. Users created at the top level do not have an entity reference so the | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OK
Bad Request
{- "userName": "Admin",
- "status": "inactive",
- "permissionAssignments": [
- {
- "permission": {
- "key": "404"
}, - "accessRights": [
- "list"
]
}
], - "customPermissionAssignments": [
- {
- "application": {
- "key": "10002",
- "permission": [
- {
- "name": "Custom Dimensions",
- "group": "objects"
}
]
}, - "accessRights": [
- "list",
- "readonly",
- "template"
]
}
]
}
{- "ia::result": {
- "key": "65",
- "id": "Admin",
- "href": "/objects/company-config/user/65"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
After a user logs in to Sage Intacct, they cannot be deleted. Users are preserved to maintain the audit trail throughout Intacct.
key required | string System-assigned key for a user. Example: 65 |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}