Update portal role
  • 02 Feb 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Update portal role

  • Dark
    Light

PUT /teams/{userId}/portal

Updates the portal role of the user. 

Note
To update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.

Header

ParameterTypeDescription
api_tokenstringYou can get the REST API from Settings > Advanced > API tokens.


Body Parameters

ParameterRequired
TypeDescription
associated_portal_role_id
YesstringThe portal role ID. To get the available roles in the project use the GET /roles endpoint.
is_invitation_id
NobooleanApplicable only for SSO users. If temporary invitation ID is passed as user ID, then set this to true.


Sample Request

{
	"associated_portal_role_id": "c1b8ae08-78d5-41d9-b3c4-3b0892b05ca8",
	"is_invitation_id": false
}


Sample Response

If the result property is true, then it indicates that the record has been successfully updated.

{
    "result": true,
    "extension_data": null,
    "context": null,
    "success": true,
    "errors": [],
    "warnings": [],
    "information": []
}

Was this article helpful?