Update the portal role of a individual user

Updated on Dec 24, 2024

4 minute(s) read

Anand Murali

Put

/v2/Teams/{userId}/portal

Security

API Key

Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Path parameters

userId

stringRequired

The ID of the team account for which the portal role has to be updated

Body parameters

Team Account - Edit Portal Role for individual user.

Here you can edit the existing portal role for individual user. Also 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.

{
  "associated_portal_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
  "is_invitation_id": true
}

object

associated_portal_role_id

string Required

Specify the portal role ID to be assigned for the team account. To get the available roles in the project, use the GET /roles endpoint.

Min length1

is_invitation_id

boolean

Applicable only for SSO users. If temporary invitation ID is passed as team account ID, set this to true.

Team Account - Edit Portal Role for individual user.

{
  "associated_portal_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
  "is_invitation_id": true
}

object

associated_portal_role_id

string Required

Specify the portal role ID to be assigned for the team account. To get the available roles in the project, use the GET /roles endpoint.

Min length1

is_invitation_id

boolean

Applicable only for SSO users. If temporary invitation ID is passed as team account ID, set this to true.

Team Account - Edit Portal Role for individual user.

{
  "associated_portal_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
  "is_invitation_id": true
}

object

associated_portal_role_id

string Required

Specify the portal role ID to be assigned for the team account. To get the available roles in the project, use the GET /roles endpoint.

Min length1

is_invitation_id

boolean

Applicable only for SSO users. If temporary invitation ID is passed as team account ID, set this to true.

Team Account - Edit Portal Role for individual user.

{
  "associated_portal_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
  "is_invitation_id": true
}

object

associated_portal_role_id

string Required

Specify the portal role ID to be assigned for the team account. To get the available roles in the project, use the GET /roles endpoint.

Min length1

is_invitation_id

boolean

Applicable only for SSO users. If temporary invitation ID is passed as team account ID, set this to true.

Responses

200

Success

Successfully updated portal role

New team account created

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

Expand All

object

result

boolean

Customer API response data

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

property*

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object | null

Extention Data for customer Api warning

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

extension_data

object | null

Extention data for customer Api response information

description

string | null

status description for customer Api response information

400

Bad Request

userId Not Found

Kindly check the userId and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The user id 40d55ebb-d2ab-4327-99d0-0e166f8ce6c2q does not exist.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

associated_protal_role_id Not Found

Kindly check the associated_protal_role_id and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The AssociatedPortalRoleId field is required.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Expand All

object

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

property*

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object | null

Extention Data for customer Api warning

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

extension_data

object | null

Extention data for customer Api response information

description

string | null

status description for customer Api response information

Was this article helpful?