Skip to main content

 

 

Coupa Success Portal

Users API

The users API allows you to create, update, or query users. This ranges from basic demographics, to managing passwords, to managing the groups and approval permissions they may have.

The URL to access users is: https://<instance>/api/users

See Integration Best Practices for more info.

Actions

The Users API allows you to:

Verb Path Action Description
PUT /api/users/:id/avatar avatar Avatar
POST /api/users create Create user
GET /api/users index Query users
GET /api/users/:id show Show user
PATCH /api/users/:id update Update user
PUT /api/users/:id update Update user

Elements

The following elements are available for the Users API:

Element Description Required Field? Unique? Allowable Value Api_In Field? Api_Out Field? Data Type
account-groups account_groups       yes yes AccountGroup 
account-security-type account_security_type       yes yes integer
active A false value will inactivate the account making it no longer available to users. A true value will make it active and available to users.       yes yes boolean
api-user Is an API User?         yes boolean
approval-groups approval_groups       yes yes ApprovalGroup 
approval-limit Maximum amount allowed to approve.       yes   ApprovalLimit 
authentication-method What Authentication Method will be used (Coupa_Credentials, LDAP, SAML)?       yes yes string(255)
avatar-thumb-url Avatar url         yes string
business-group-security-type business_group_security_type     0, 1 yes yes integer
can-expense-for can_expense_for         yes User
content-groups Content Groups       yes yes BusinessGroup 
contract-approval-limit Contract approval limit       yes yes ApprovalLimit 
contract-self-approval-limit Contract self approval limit       yes yes ApprovalLimit 
contracts-user Does the user have a Contracts License?       yes yes boolean
created-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
created-by User who created         yes User
default-account default_account       yes yes Account
default-account-type default_account_type       yes yes AccountType
default-address default_address       yes yes Address
default-currency default_currency       yes yes Currency
default-locale Default locale     en, tr, ja, bg, cs, es, da, de-AT, de-CH, de, el, en-AU, en-CA, en-GB, en-IE, en-IN, en-MT, en-SG, en-ZA, es-CO, es-MX, es-PR, et, fi, fr-BE, fr-CA, fr-CH, fr, hr, hu, it-CH, it, ko, lt, lv, mt, nl-BE, nl, no, pl, pt-BR, pt, ru, sk, sl, sv, zh-CN, zh-TW, zh-HK, en-ZZ, en, tr, ja, bg, cs, es, da, de-AT, de-CH, de, el, en-AU, en-CA, en-GB, en-IE, en-IN, en-MT, en-SG, en-ZA, es-CO, es-MX, es-PR, et, fi, fr-BE, fr-CA, fr-CH, fr, hr, hu, it-CH, it, ko, lt, lv, mt, nl-BE, nl, no, pl, pt-BR, pt, ru, sk, sl, sv, zh-CN, zh-TW, zh-HK, en-ZZ yes yes string(10)
department department       yes yes Department
edit-invoice-on-quick-entry Edit invoice button routes user to fast entry screen       yes yes boolean
email email yes yes   yes yes string(255)
employee-number employee number   yes   yes yes string(255)
expense-approval-limit expense_approval_limit       yes yes ApprovalLimit 
expense-self-approval-limit expense_self_approval_limit       yes yes ApprovalLimit 
expense-user Does the user have a Expense License?       yes yes boolean
expenses-delegated-to Expenses delegated to         yes User
firstname first name yes     yes yes string(40)
fullname full name         yes string(255)
generate-password-and-notify Set to Yes if you want the system to invite the user to the system and have them set up their password     Yes, No yes   string
id Coupa unique identifier         yes integer
inventory-organizations inventory_organizations       yes yes InventoryOrganization 
inventory-user Does the user have a Inventory License?       yes yes boolean
invoice-approval-limit invoice_approval_limit       yes yes ApprovalLimit 
invoice-self-approval-limit Maximum amount allowed for Invoice self approvals       yes   ApprovalLimit 
lastname last name yes     yes yes string(40)
login login yes yes   yes yes string(255)
manager Manager       yes yes User
mention-name Mention Name   yes   yes yes string(255)
password Changed password       yes   string
pcard pcard       yes yes Pcard 
phone-mobile phone mobile       yes yes PhoneNumber 
phone-work phone work       yes yes PhoneNumber 
purchasing-user Does the user have a Purchasing License?       yes yes boolean
requisition-approval-limit requisition_approval_limit       yes yes ApprovalLimit 
requisition-self-approval-limit requisition_self_approval_limit       yes yes ApprovalLimit 
roles roles       yes yes Role 
salesforce-enabled salesforce_enabled       yes   boolean
salesforce-id salesforce_id yes     yes yes string(255)
self-approval-limit Maximum amount allowed for self approvals       yes   ApprovalLimit 
sourcing-user Does the user have a Sourcing License?       yes yes boolean
sso-identifier User's Single Sign-on ID (SSO ID)       yes yes string(255)
updated-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
updated-by User who updated         yes User
working-warehouses working_warehouses       yes yes Warehouse 
  • Was this article helpful?