LogoLogo
CommunitySupport PortalYouTubeStart a free trial
  • Welcome
  • Commerce Engine
  • Orchestration Engine
  • API Documentation
  • Release Notes
  • Changelog
  • Emporix API
  • OpenAPI Generator
  • Standard Practices
    • General Info
    • Mixins
    • Query Parameter
    • Translations
    • Custom ID
    • Upsert
    • B2B Token
  • API Guides and References
    • Authorization
      • OAuth Service
        • API Reference
          • Customer Token
          • Anonymous Token
          • Service Access Token
          • Models
        • Download API Specification
    • Artificial Intelligence
      • AI Service
        • AI Tutorials
        • API Reference
          • Text Generation
          • AI Completions
          • Models
        • Download API Specification
    • Configuration
      • Configuration Service
        • Language Tutorials
        • API Reference
          • Tenant configurations
          • Client configurations
          • Global configurations
          • Models
        • Download API Specification
      • Country Service
        • Country Tutorial
        • API Reference
          • Countries
          • Regions
          • Models
        • Download API Specification
      • Currency Service
        • Currency Tutorial
        • API Reference
          • Currencies
          • Currency exchange
          • Models
        • Download API Specification
      • Unit Handling Service
        • Unit Handling Tutorial
        • API Reference
          • Unit management
          • Unit conversion
          • Type management
          • Models
        • Download API Specification
      • Site Settings Service
        • Site Settings Tutorial
        • API Reference
          • Mixins
          • Site settings
          • Models
        • Download API Specification
      • Indexing Service
        • Indexing Tutorial
        • API Reference
          • Configuration
          • Public Configuration
          • Reindex
          • Models
        • Download API Specification
    • Catalogs and Categories
      • Catalog Service
        • Catalog Tutorials
        • API Reference
          • List catalogs
          • Catalog management
          • Models
        • Download API Specification
      • Category Service
        • Category Tutorials
        • API Reference
          • Category Resources
          • Category Assignment Resources
          • Assignment Resources
          • Category Tree Resources
          • Models
        • Download API Specification
    • Products, Labels and Brands
      • Product Service
        • Product Tutorial
        • API Reference
          • Products
          • Product Templates
          • Models
        • Download API Specification
      • Label Service
        • Label Tutorial
        • API Reference
          • Label
          • Media
          • Models
        • Download API Specification
      • Brand Service
        • Brand Tutorial
        • API Reference
          • Brands
          • Media
          • Models
        • Download API Specification
    • Prices and Taxes
      • Price Service
        • Price Tutorials
        • API Reference
          • Price lists
          • Price matching
          • Price models
          • Prices
          • Prices assigned to price lists
          • Models
        • Download API Specification
      • Tax Service
        • Tax Tutorials
        • API Reference
          • Taxes
          • Tax calculation
          • Models
        • Download API Specification
    • Users and Permissions
      • IAM Service
        • IAM Tutorial
        • API Reference
          • Access Controls
          • Group Assignments
          • Groups
          • Permissions
          • Resources
          • Roles
          • Access Control Templates
          • Users
          • Management Dashboard Users
          • Models
        • Download API Specification
      • Session-context Service
        • Session-context Tutorial
        • API Reference
          • Session management
          • Session context modification
          • Own session management
          • Own session context modification
          • Models
        • Download API Specification
    • Companies and Customers
      • Customer Management
        • Customer Management Tutorial
        • API Reference
          • Locations
          • Contact Assignments
          • Legal Entities
          • Models
        • Download API Specification
      • Customer Service (Customer Managed)
        • API Reference
          • Addresses
          • Account and profile
          • Authentication and authorization
          • Double opt In
          • Credentials
          • Models
        • Download API Specification
      • Customer Service (Tenant Managed)
        • API Reference
          • Account and profile
          • Addresses
          • Models
        • Download API Specification
      • Customer Segments
        • Segments Tutorial
        • API Reference
          • Segments
          • Items Assignments
          • Customers Assignments
          • Models
        • Download API Specification
      • Approval Service
        • Approval Tutorials
        • API Reference
          • Approvals
          • Approval
          • Search
          • Models
        • Download API Specification
    • Delivery and Shipping
      • Shipping Service
        • Shipping Tutorial
        • API Reference
          • Customer Group Relations
          • Delivery Windows
          • Shipping Cost
          • Shipping Zones
          • Shipping Methods
          • Shipping Groups
          • Sites
          • Delivery Times Management
          • Delivery Times Slots Management
          • Delivery Cycles
          • Models
        • Download API Specification
      • Delivery Providers Service
        • API Reference
          • Delivery Orders
          • Delivery Plan
          • Models
        • Download API Specification
    • Rewards and Promotions
      • Coupon Service
        • Coupon Tutorial
        • API Reference
          • Coupon Management
          • Coupon Validation
          • Coupon Redemption
          • Referral Coupon Management
          • Models
        • Download API Specification
      • Reward-points Service
        • Reward-points Tutorial
        • API Reference
          • Redeem Options Management
          • Reward Points Management
          • Signed In Customer Reward Points
          • Models
        • Download API Specification
    • Quotes
      • Quote Service
        • Quote Tutorial
        • API Reference
          • Quote management
          • Quote history
          • Quote pdf
          • Quote reason
          • Models
        • Download API Specification
    • Checkout
      • Cart Service
        • Cart Tutorial
        • API Reference
          • Carts
          • Cart items
          • Discounts
          • Models
        • Download API Specification
      • Payment-gateway Service
        • Payment-gateway Tutorial
        • API Reference
          • Payment
          • Payment mode
          • Payment frontend
          • Payment mode frontend
          • Transaction
          • Models
        • Download API Specification
      • Checkout Service
        • Checkout Tutorial
        • API Reference
          • Checkouts
          • Models
        • Download API Specification
      • Fee Service
        • Fee Tutorial
        • API Reference
          • Fee management
          • Item Fee management
          • Product Fees management
          • Item Fee search
          • Models
        • Download API Specification
      • Shopping List
        • API Reference
          • Shopping Lists
          • Models
        • Download API Specification
    • Orders
      • Availability Service
        • Availability Tutorial
        • API Reference
          • Locations
          • Availabilities
          • Models
        • Download API Specification
      • Order Service
        • Order Tutorial
        • API Reference
          • Orders (tenant Managed)
          • Orders (customer Managed)
          • Models
        • Download API Specification
      • Pick-pack Service
        • API Reference
          • Orders
          • Order cycles
          • Assignees
          • Recalculations
          • Events
          • Models
        • Download API Specification
      • Invoice Service
        • Invoice Tutorial
        • API Reference
          • Invoice Jobs
          • Models
        • Download API Specification
      • Returns Service
        • Returns Tutorial
        • API Reference
          • Returns
          • Models
        • Download API Specification
      • SEPA Export Service
        • API Reference
          • Files
          • Jobs
          • Models
        • Download API Specification
    • Utilities
      • Schema Service
        • Schema Tutorial
        • API Reference
          • Schema
          • Type
          • Reference
          • Custom Schema Type
          • Custom Instance
          • Models
        • Download API Specification
      • Sequential-id Service
        • Sequential-id Tutorial
        • API Reference
          • Sequential IDs management
          • Models
        • Download API Specification
    • Media
      • Media Service
        • Media Tutorial
        • API Reference
          • Assets
          • Models
        • Download API Specification
    • Webhooks
      • Webhook Service
        • Webhooks Tutorial
        • API Reference
          • Config
          • Events
          • Svix Emporix Shared Account
          • Models
        • Download API Specification
      • Events-Availability
      • Events-Cart
      • Events-Catalog
      • Events-Category
      • Events-Client Management
      • Events-Customer
      • Events-Index
      • Events-Order
      • Events-Price
      • Events-Product
      • Events-Quote
      • Events-Product
    • Integrations
      • Emporix and Make
      • Identity Providers
      • Workflow Automation
Powered by GitBook
LogoLogo

Resources

  • Emporix.com
  • Developer Policy
  • Terms of Use

Find us

  • LinkedIn

© 2025 Emporix. All Rights Reserved.

On this page

Was this helpful?

Export as PDF
  1. API Guides and References
  2. Users and Permissions
  3. IAM Service
  4. API Reference

Management Dashboard Users

PreviousUsersNextModels

Was this helpful?

Retrieving a user of the `EMPLOYEE` type

get

For a specific tenant, retrieves user by ID along with the groups this user belongs to. The user type can be specified as EMPLOYEE or CUSTOMER.


Required scopes

  • iam.user_read

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
userIdstringRequired

User's unique identifier, generated when the user is created.

Query parameters
expandstring · enumOptional

Adds expanded groups objects to the response result.

Example: groupsPossible values:
Responses
200
The request was successful and user is returned.
application/json
400
Unsupported language provided.
application/json
401
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that tenant from the token does not match tenant from path.
application/json
403
Scope validation failed, details will be provided in response message
application/json
404
Given resource cannot be found.
application/json
get
GET /iam/{tenant}/users/{userId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "id": "00u4ukqvzlEP31sCk417",
  "firstName": "John",
  "lastName": "Doe",
  "backofficeUserNumber": "00u4ukqvzlEP31sCk417",
  "preferredSite": "main",
  "preferredCurrency": "PLN",
  "preferredLanguage": "en",
  "department": "departmentName",
  "validFrom": "2022-08-19T10:41:10Z",
  "isAccountLocked": true,
  "contactEmail": "user1@gmail.com",
  "status": "ACTIVE",
  "groupIds": [
    "1gr5e52e-6e27-4ac5-9471-2467d3fb7503"
  ],
  "groups": [
    {
      "id": "1gr5e52e-6e27-4ac5-9471-2467d3fb7503",
      "name": {
        "de": "Backoffice Manager",
        "en": "Backoffice managers"
      },
      "description": {
        "de": "Backoffice Manager",
        "en": "Backoffice managers"
      },
      "code": "BO_MANAGER",
      "userType": "EMPLOYEE"
    }
  ]
}

Deleting a user from the Management Dashboard

delete

Removes a specified user from all groups. This operation blocks user access to Management Dashboard, but the Developer Portal account access remains the same.


Required scopes

  • iam.user_delete

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
userIdstringRequired

User's unique identifier, generated when the user is created.

Query parameters
forceDeletebooleanOptional

Indicates whether user will be deleted from Developer Portal as well.

NOTE: Only Developer Portal admin can perform force delete.

Default: falseExample: false
Responses
204
User has been deleted successfully.
401
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that tenant from the token does not match tenant from path.
application/json
403
Scope validation failed, details will be provided in response message
application/json
delete
DELETE /iam/{tenant}/users/{userId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

  • GETRetrieving a list of users
  • POSTCreate a new user of `EMPLOYEE` type
  • GETRetrieving a user of the `EMPLOYEE` type
  • PUTUpdating a user of the `EMPLOYEE` type
  • DELETEDeleting a user from the Management Dashboard

Retrieving a list of users

get

Retrieves all users for the given tenant with the assigned groups. The user type can be specified as EMPLOYEE or CUSTOMER.


Required scopes

  • iam.user_read

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
Query parameters
pageNumberstringOptional

Page number to be retrieved. The number of the first page is 1.

pageSizestringOptional

Number of items to be retrieved per page.

expandstring · enumOptional

Adds expanded groups objects to the response result.

Example: groupsPossible values:
userTypestring · enumOptional

The user type of the returned users. Supported types: EMPLOYEE and CUSTOMER.

Example: EMPLOYEEPossible values:
Header parameters
X-Total-CountbooleanOptional

In order to get information how many entities meet a filter requirements, X-Total-Count header has been introduced. The header is optional and its default value is false. It the header is provided and it is true then total count is returned in the X-Total-Count response header. In both cases (X-Total-Count true, false or not provided), the response body has the same format (array of entities). In other words, the information about total count is returned on demand, depending of an existence of X-Total-Count header in a request. Therefore, the X-Total-Count header is not returned if an API consumer didn't ask for it.

Default: false
Responses
200
The request was successful a list of users is returned.
400
Bad Request
application/json
401
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that tenant from the token does not match tenant from path.
application/json
403
Scope validation failed, details will be provided in response message
application/json
get
GET /iam/{tenant}/users HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "id": "00u4ukrqkmEP1opFf417",
    "firstName": "John 2",
    "lastName": "Doe",
    "backofficeUserNumber": "00u4ukrqkmEP1opFf417",
    "preferredSite": "main",
    "preferredCurrency": "PLN",
    "preferredLanguage": "en",
    "department": "departmentName",
    "validFrom": "2022-08-19T10:41:28Z",
    "isAccountLocked": true,
    "contactEmail": "user2@gmail.com",
    "status": "ACTIVE",
    "groupIds": [
      "1gr5e52e-6e27-4ac5-9471-2467d3fb7503"
    ],
    "groups": [
      {
        "id": "1gr5e52e-6e27-4ac5-9471-2467d3fb7503",
        "name": {
          "de": "Backoffice Manager",
          "en": "Backoffice managers"
        },
        "description": {
          "de": "Backoffice Manager",
          "en": "Backoffice managers"
        },
        "code": "BO_MANAGER",
        "userType": "EMPLOYEE"
      }
    ]
  },
  {
    "id": "00u4ukqvzlEP31sCk417",
    "firstName": "John",
    "lastName": "Doe",
    "backofficeUserNumber": "00u4ukqvzlEP31sCk417",
    "preferredSite": "main",
    "preferredCurrency": "PLN",
    "preferredLanguage": "en",
    "department": "departmentName",
    "validFrom": "2022-08-19T10:41:10Z",
    "isAccountLocked": true,
    "contactEmail": "user1@gmail.com",
    "status": "PROVISIONED",
    "groupIds": [
      "1gr5e52e-6e27-4ac5-9471-2467d3fb7503"
    ],
    "groups": [
      {
        "id": "1gr5e52e-6e27-4ac5-9471-2467d3fb7503",
        "name": {
          "de": "Backoffice Manager",
          "en": "Backoffice managers"
        },
        "description": {
          "de": "Backoffice Manager",
          "en": "Backoffice managers"
        },
        "code": "BO_MANAGER",
        "userType": "EMPLOYEE"
      }
    ]
  }
]

Create a new user of `EMPLOYEE` type

post

Creates a new Management Dashboard user for a given tenant. The user will be able to log in to the Management Dashboard right after they confirm their email and set up a password. If a user with a given email already exists in the system, the assignment will be created and no further steps are needed.


Required scopes

  • iam.user_create

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
Body
firstNamestringRequired

User first name.

lastNamestringRequired

User last name.

preferredSitestringRequired

User preferred site

preferredCurrencystringRequired

User preferred currency

preferredLanguagestringRequired

User preferred language

departmentstringRequired

User department

contactEmailstringRequired

User contact email

groupIdsstring[]Required

Unique identifier of a group associated with to this user. Required to perform the request.

Responses
201
The request was successful. The user has been created.
application/json
400
Unsupported language provided.
application/json
401
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that tenant from the token does not match tenant from path.
application/json
403
Scope validation failed, details will be provided in response message
application/json
404
Given resource cannot be found.
application/json
post
POST /iam/{tenant}/users HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 269

{
  "lastName": "Doe",
  "firstName": "John",
  "preferredSite": "main",
  "contactEmail": "example@emporix.com",
  "preferredCurrency": "PLN",
  "preferredLanguage": "en",
  "department": "departmentName",
  "groupIds": [
    "1gr5e52e-6e27-4ac5-9471-2467d3fb7503",
    "1gr5e52e-6e27-4ac5-9471-2467d3fb7504"
  ]
}
{
  "id": "e243dc9e-a3f6-4573-bb01-a8ae21d2d4at"
}

Updating a user of the `EMPLOYEE` type

put

Updating a user of the EMPLOYEE type. The user will be deleted from all groups and assigned to a given group list based on the groupIds field.


Required scopes

  • iam.user_update

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
userIdstringRequired

User's unique identifier, generated when the user is created.

Body

User update schema

firstNamestringRequired

User first name.

lastNamestringRequired

User last name.

preferredSitestringRequired

User preferred site

preferredCurrencystringRequired

User preferred currency

preferredLanguagestringRequired

User preferred language

departmentstringRequired

User department

backofficeUserNumberstringRequired

User backoffice user number. For new users, it is the same as ID. For existing users, it may be different.

groupIdsstring[]Required

Groups unique identifier attached to this user. Required to perform the request.

Responses
204
The request was successful. The user has been updated.
400
Unsupported language provided.
application/json
401
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that tenant from the token does not match tenant from path.
application/json
403
Scope validation failed, details will be provided in response message
application/json
404
Given resource cannot be found.
application/json
put
PUT /iam/{tenant}/users/{userId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 278

{
  "lastName": "Doe",
  "firstName": "John",
  "preferredSite": "main",
  "preferredCurrency": "PLN",
  "preferredLanguage": "en",
  "backofficeUserNumber": "00u4ujmuyhhfJodyS417",
  "department": "departmentName",
  "groupIds": [
    "1gr5e52e-6e27-4ac5-9471-2467d3fb7503",
    "1gr5e52e-6e27-4ac5-9471-2467d3fb7504"
  ]
}

No content