Update user role
put/v1/users/updateThis API allows you to modify the role of a specific user in your BoldSign organization user account.
Code snippet
curl -X 'PUT' \ 'https://api.boldsign.com/v1/users/update' \ -H 'accept: */*' \ -H 'X-API-KEY: {your API key}' \ -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \ -d '{ "userId": "77f0a721-xxxx-xxxx-xxxx-17fcb032xxxx", "userRole": "Admin" }'
var apiClient = new ApiClient("https://api.boldsign.com", "{apikey}"); var userClient = new UserClient(apiClient); var updateUser = new UpdateUser("77f0a721-xxxx-xxxx-xxxx-17fcb032xxxx", UserRoleType.Admin); userClient.UpdateUser(updateUser);
import boldsign configuration = boldsign.Configuration(api_key="YOUR_API_KEY") with boldsign.ApiClient(configuration) as api_client: user_api = boldsign.UserApi(api_client) update_User = boldsign.UpdateUser( userId="YOUR_USER_ID", userRole="Admin" ) user_api.update_user(update_User)
<?php require_once "vendor/autoload.php"; $config = new BoldSign\Configuration(); $config->setApiKey('YOUR_API_KEY'); $user_api = new BoldSign\Api\UserApi($config); $update_user = new \BoldSign\Model\UpdateUser(); $update_user->setUserId('YOUR_USER_ID'); $update_user->setUserRole('Admin'); $user_api->updateUser($update_user);
ApiClient client = Configuration.getDefaultApiClient(); client.setApiKey("YOUR_API_KEY"); UserApi userApi = new UserApi(client); UpdateUser updateUserRequest = new UpdateUser(); updateUserRequest.setUserId("YOUR_USER_ID"); updateUserRequest.setUserRole(UpdateUser.UserRoleEnum.TEAM_ADMIN); userApi.updateUser(updateUserRequest);
import { UserApi,UpdateUser } from "@boldsign/node-sdk"; const userApi = new UserApi(); userApi.setApiKey("YOUR_API_KEY"); const updateUserRequest = new UpdateUser(); updateUserRequest.userId = "YOUR_USER_ID"; updateUserRequest.userRole = UpdateUser.UserRoleEnum.Member; const updateUserResponse = userApi.updateUser(updateUserRequest);
Request body
userIdstringRequired | The ID of the user account. |
userRolestringRequired | Represents a user role in their organization. They can either be Admin , TeamAdmin , or Member , each with different levels of permissions and access. |
Example response
200 Success