User Detail Request (user-detail-request)

  • Updated

The User-Detail-Request and User-Detail-Response integration points, allow your organization to use an external system (such as Active Directory, an Identity Provider, or an ERP). As the Master Source of Truth for user information.

This setup centralizes user management, ensuring that when a user’s department, role, or status changes in your primary system. It is automatically reflected, in Unimarket upon their next login.

 

How the Integration Works

  1. Trigger: When a user attempts to log in to Unimarket, a user-detail-request is sent to your external system.

  2. Validation: Your system identifies the user and prepares their current profile details.

  3. Update: Your system sends a user-detail-response back to Unimarket.

  4. Overwrite: Unimarket receives the details and replaces all existing data for that user (roles, names, organization units, etc.) with the new information.

 

Implementation Requirements

  • Persistence: Since the response replaces all local data, your external system must send all required roles every time the user logs in. If a role is omitted in a new response, it will be removed from the user in Unimarket.

  • Organization Units: The response should also include the user's Organization Unit to ensure they are placed in the correct part of the approval hierarchy.

  • Identity Mapping: The identity used in the request must match the unique identifier (e.g., username or email) used in your external system.

 

Key Data: Unimarket User Roles

To manage permissions externally, your system must store and pass the specific Integration Syntax for each role. Below is the complete reference of Unimarket user roles and their required integration strings:

 

Administration Roles

Role NameIntegration SyntaxDefinition
Community AdministratorCOMMUNITY_ADMINFull community administrative privileges.
User AdministratorCOMMUNITY_USER_ADMINManage users and roles (cannot assign Community Admin role).
Community ManagementCOMMUNITY_MANAGEMENTManage community setup and master data.
Community ProfileCOMMUNITY_PROFILEManage community branding, names, and welcome text.
Community FeaturesCOMMUNITY_FEATURESManage preferences for checkout, ordering, and matching.

Purchasing & Sourcing Roles

Role NameIntegration SyntaxDefinition
BuyerCOMMUNITY_BUYERShop the marketplace and create/complete requisitions.
BrowserCOMMUNITY_BROWSERCreate requisitions and reassign them to Buyers.
On Behalf OfCOMMUNITY_ON_BEHALF_OF_BUYERCreate requisitions for any other user.
Bid RequestCOMMUNITY_RFX_CREATEInitiate RFQs, RFPs, and RFIs via the sourcing module.
RFQCOMMUNITY_RFQ_CREATEInitiate simple RFQs with suppliers.
Create Blanket OrderCOMMUNITY_BLANKET_ORDER_CREATECreate blanket orders for specific suppliers.

Invoicing & Finance Roles

Role NameIntegration SyntaxDefinition
Create InvoicesCOMMUNITY_INVOICE_CREATECreate invoices via PO or Retrofit; force match invoices.
Create Buyer InvoicesCOMMUNITY_INVOICE_BUYER_CREATECreate invoices for the user's own orders only.
ExpensesCOMMUNITY_EXPENSESCreate personal expense claims.
On Behalf of ReceivingCOMMUNITY_ON_BEHALF_OF_RECEIVINGView and receive all community orders (Central Receiving).
View TransactionsCOMMUNITY_TRANSACTION_VIEWView all purchases across the entire community.

Specialist & Support Roles

Role NameIntegration SyntaxDefinition
Approval AdministratorCOMMUNITY_APPROVALSManage community approval configurations and data.
Escalate ApprovalCOMMUNITY_APPROVAL_ESCALATEMove requisitions forward in the approval chain.
Contracts AdministratorCONTRACTS_ADMINEdit any contract without being a named member.
Supplier Request AdminCOMMUNITY_SUPPLIER_REQUEST_ADMINManage and approve new supplier requests from users.
User SupportCOMMUNITY_USER_SUPPORTSwitch into other users to assist without making changes.

 

Implementation Rule

Crucial Logic: The user-detail-response message is destructive. If a user currently has three roles in Unimarket, but your external system only sends two in the latest response, the third role will be automatically removed.