Management Dashboard Users
Was this helpful?
Was this helpful?
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$User's unique identifier, generated when the user is created.
Adds expanded groups objects to the response result.
groupsPossible values: 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"
}
]
}Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$User's unique identifier, generated when the user is created.
Indicates whether user will be deleted from Developer Portal as well.
NOTE: Only Developer Portal admin can perform force delete.
falseExample: falseDELETE /iam/{tenant}/users/{userId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$Page number to be retrieved. The number of the first page is 1.
Number of items to be retrieved per page.
Adds expanded groups objects to the response result.
groupsPossible values: The user type of the returned users. Supported types: EMPLOYEE and CUSTOMER.
EMPLOYEEPossible values: 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.
falseGET /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"
}
]
}
]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.
iam.user_create
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$User first name.
User last name.
User preferred site
User preferred currency
User preferred language
User department
User contact email
Unique identifier of a group associated with to this user. Required to perform the request.
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"
}Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$User's unique identifier, generated when the user is created.
User update schema
User first name.
User last name.
User preferred site
User preferred currency
User preferred language
User department
User backoffice user number. For new users, it is the same as ID. For existing users, it may be different.
Groups unique identifier attached to this user. Required to perform the request.
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