Update employee

Employee updates include tasks such as assigning or removing roles, creating or modifying credentials, updating personal data, and similar activities.

Update employee roles

Use the Update employee roles endpoint and provide the new desired set of roles whenever you need to add or remove roles associated with an employee.

Shell (bash)

curl -L -X PUT 'https://auth-api.sandbox.tuumplatform.com/api/v1/employees/ID-1116/roles' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiTGlpdmEgS2FzdCIsImVtcGxveWVlSWQiOiJJRC0xMDcxIiwidGVuYW50Q29kZSI6Ik1CIiwiZXhwaXJ5RFRpbWUiOiIyMDI1LTEyLTE4VDExOjUzOjMyIiwiZXhwIjoxNzY2MDU4ODEyLCJyb2xlcyI6WyJBRE1JTiIsIkRBU0hCT0FSRF9CQUxBTkNFX1ZJRVdFUiIsIlNZU1RFTSJdfQ.btgTJlZGxrws5BNsIve4N6eZa_4EdMJr1QJQ7SCpRfA' \
-H 'Content-Type: application/json' \
-d '{
  "roles": [
    "SYSTEM",
    "ADMIN",
    "CARD_MANAGER",
    "CUSTOMER_SERVICE"
  ]
}'

An employee can be assigned multiple roles. Its effective permissions are the combined set of all privileges from those roles.

Manage employee credentials

Use the Update any employee password endpoint whenever you need to change the password for a specific employee.

Shell (bash)

curl -L -X PUT 'https://auth-api.sandbox.tuumplatform.com/api/v1/employees/ID-1116/change-password' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiTGlpdmEgS2FzdCIsImVtcGxveWVlSWQiOiJJRC0xMDcxIiwidGVuYW50Q29kZSI6Ik1CIiwiZXhwaXJ5RFRpbWUiOiIyMDI1LTEyLTE4VDExOjUzOjMyIiwiZXhwIjoxNzY2MDU4ODEyLCJyb2xlcyI6WyJBRE1JTiIsIkRBU0hCT0FSRF9CQUxBTkNFX1ZJRVdFUiIsIlNZU1RFTSJdfQ.btgTJlZGxrws5BNsIve4N6eZa_4EdMJr1QJQ7SCpRfA' \
-H 'Content-Type: application/json' \
--data-raw '{
  "password": "new_employee_password"
}'

Use the Update current employee password endpoint to change the password for the currently logged-in user.

Shell (bash)

curl -L -X PUT 'https://auth-api.sandbox.tuumplatform.com/api/v1/employees/change-password' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiTXlGaXJzdCBBcHBsaWNhdGlvbiIsImVtcGxveWVlSWQiOiJJRC0xMTE2IiwidGVuYW50Q29kZSI6Ik1CIiwiZXhwaXJ5RFRpbWUiOiIyMDI1LTEyLTE4VDEyOjQ3OjI4IiwiZXhwIjoxNzY2MDYyMDQ4LCJyb2xlcyI6WyJBRE1JTiIsIkNBUkRfTUFOQUdFUiIsIkNVU1RPTUVSX1NFUlZJQ0UiLCJTWVNURU0iXX0.CzMqeoUOWPfXvZuBQt5NskmbVWCsZdiiIBsfbAjc2eQ' \
-H 'Content-Type: application/json' \
--data-raw '{
  "password": "mYnEwb@Zzw00rD"
}'

Update employee data

Use the Update employee endpoint to modify the data for a specific employee.

Shell (bash)

curl -L -X PUT 'https://auth-api.sandbox.tuumplatform.com/api/v1/employees/ID-1117' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiTGlpdmEgS2FzdCIsImVtcGxveWVlSWQiOiJJRC0xMDcxIiwidGVuYW50Q29kZSI6Ik1CIiwiZXhwaXJ5RFRpbWUiOiIyMDI1LTEyLTE4VDEzOjU2OjU0IiwiZXhwIjoxNzY2MDY2MjE0LCJyb2xlcyI6WyJBRE1JTiIsIkRBU0hCT0FSRF9CQUxBTkNFX1ZJRVdFUiIsIlNZU1RFTSJdfQ.1HUIQ2cZsvoC29zfulds1hFznW5O3JeQlvPPaxk0fJk' \
-H 'Content-Type: application/json' \
-d '{
  "firstName": "MyUpdated",
  "lastName": "ApplicationName"
}'

Unblock employee

Use the Unblock employee endpoint whenever you need to unblock a blocked user.

Shell (bash)

curl -L -X PUT 'https://auth-api.sandbox.tuumplatform.com/api/v1/employees/ID-1116/unblock' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiTGlpdmEgS2FzdCIsImVtcGxveWVlSWQiOiJJRC0xMDcxIiwidGVuYW50Q29kZSI6Ik1CIiwiZXhwaXJ5RFRpbWUiOiIyMDI1LTEyLTE4VDEyOjUyOjU4IiwiZXhwIjoxNzY2MDYyMzc4LCJyb2xlcyI6WyJBRE1JTiIsIkRBU0hCT0FSRF9CQUxBTkNFX1ZJRVdFUiIsIlNZU1RFTSJdfQ.V97l-AKVdgTsiluxdcsqW00vF2Mex1r7Z5toTylmtvQ' \
-d ''

Invalidate all employee tokens

Use the Invalidate all employee tokens endpoint whenever you need to revoke all valid tokens associated with a particular user.

Shell (bash)

curl -L -X POST 'https://auth-api.sandbox.tuumplatform.com/api/v1/employees/ID-1116/invalidate-tokens' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiTGlpdmEgS2FzdCIsImVtcGxveWVlSWQiOiJJRC0xMDcxIiwidGVuYW50Q29kZSI6Ik1CIiwiZXhwaXJ5RFRpbWUiOiIyMDI1LTEyLTE4VDEyOjUyOjU4IiwiZXhwIjoxNzY2MDYyMzc4LCJyb2xlcyI6WyJBRE1JTiIsIkRBU0hCT0FSRF9CQUxBTkNFX1ZJRVdFUiIsIlNZU1RFTSJdfQ.V97l-AKVdgTsiluxdcsqW00vF2Mex1r7Z5toTylmtvQ' \
-d ''