CommunitySupport PortalYouTubeStart a free trial

Management Dashboard Users

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.
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": "[email protected]",
    "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": "[email protected]",
    "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
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": "[email protected]",
  "preferredCurrency": "PLN",
  "preferredLanguage": "en",
  "department": "departmentName",
  "groupIds": [
    "1gr5e52e-6e27-4ac5-9471-2467d3fb7503",
    "1gr5e52e-6e27-4ac5-9471-2467d3fb7504"
  ]
}
{
  "id": "e243dc9e-a3f6-4573-bb01-a8ae21d2d4at"
}

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
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": "[email protected]",
  "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"
    }
  ]
}

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.
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

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.
delete
DELETE /iam/{tenant}/users/{userId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Retrieving a list of vendor users

get

Retrieves all users for the given vendor with the assigned groups.

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]+$
vendorIdstringRequired

Unique identifier of a vendor

Responses
200
The request was successful a list of users is returned.
get
GET /iam/{tenant}/users/vendors/{vendorId} 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": "[email protected]",
    "status": "ACTIVE",
    "groupIds": [
      "1gr5e52e-6e27-4ac5-9471-2467d3fb7503"
    ],
    "groups": [
      {
        "id": "1gr5e52e-6e27-4ac5-9471-2467d3fb7503",
        "name": {
          "de": "Raw Materials Vendor Order manager",
          "en": "Raw Materials Bestellmanager Lieferant"
        },
        "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": "[email protected]",
    "status": "PROVISIONED",
    "groupIds": [
      "1gr5e52e-6e27-4ac5-9471-2467d3fb7503"
    ],
    "groups": [
      {
        "id": "1gr5e52e-6e27-4ac5-9471-2467d3fb7503",
        "name": {
          "de": "Raw Materials Vendor Order manager",
          "en": "Raw Materials Bestellmanager Lieferant"
        },
        "userType": "EMPLOYEE"
      }
    ]
  }
]
PreviousUsersNextModels

Was this helpful?