Users

Change a user's account role

This route allows you to promote or demote a user's account role in a multi-organization account.<br/><br/>Prerequisites:<br/>- The caller must have the Account admin role.<br/>- The target user must hold the Admin role in at least one organization within the account before being eligible for the Account admin role.<br/>- Machine tokens cannot call this route.<br/>- You cannot change your own role.<br/>- Both the caller and target must belong to the same company.<br/><br/>To learn more about multiple organization membership, check out the documentation.

patch/v1/users/{userId}/account-role

Request

  • Base URL: https://api.port.io
  • URL: https://api.port.io/v1/users/{userId}/account-role
  • Auth: API key in header Authorization

Path parameters

userIdstring required

The target user's ID, returned in the id field from Get all users in your organization or Get a user.

Request body

accountRole'ADMIN' | 'MEMBER' required

Use ADMIN to promote the user to account admin, or MEMBER to demote an account admin to member.

Response

Default Response

okboolean

Changes

No recorded changes to this operation across all 1 revision of this API.