Add a user to an account
Below provides details for adding a user to an account granting them the necessary access defined by the role. A user can be added to an account additional times with a different role provided. This enables a user to have varying levels of access depending on need.
Roles in Trimble Account Service ensure that management levels for users and companies are in place for each product and entitlement they own. Account Service allows for the assignment of roles to individual Trimble Identity users. This allows a user to see their products in account management portals like the Trimble AMP.
User Roles:
-
Account Owner: Purchaser of the account, used for billing purposes, can also administer end-users
-
Account Administrator: Can assign and revoke end-users from an AMP
-
End-user: User of the product or entitlement
These roles connect to the below call values:
TCP_ACCOUNT_OWNER
Account Owner, person responsible for the billing and renewal process, can revoke/assign seats.
TCP_SECONDARY_ACCOUNT_OWNER
Alternate Account Owner for billing and renewal purposes, can revoke/assign seats.
TCP_COMPANY_ADMIN
Account Administrator, can assign and revoke seats of end-users.
TCP_TEAM_MANAGER
Account Administrator, can assign and revoke seats of end-users.
TCP_END_USER
End-user, can reset activations, but not assign or revoke access unless this is the same login as TCP_ACCOUNT_OWNER.
To add a role to a user:
- API Call
POST {baseurl} /1.0/accounts/{accountId}/users
-
Headers
- Accept: application/JSON Note: This may be automatically added by your development tool. Postman and cURL add this header to all requests by default.
- Authorization: Bearer {bearer token} Include Trimble Identity OAuth Bearer token for your application (see get access token for more information).
-
Body
userid= {UUID of the user}roleID={TCP_COMPANY_ADMIN, TCP_ACCOUNT_OWNER, TCP_SECONDARY_ACCOUNT_OWNER, TCP_TEAM_MANAGER, TCP_END_USER}
If the
roleIDis not given, by default,TCP_ACCOUNT_OWNERwill be assigned to the user.
Example request:
{ "userIds": [ "user1" ], "roleId": "TCP_COMPANY_ADMIN"}Example response:
{ "code": 0, "message": "string"}