Contents x
    Update the portal role of a individual user
    • 26 Sep 2023
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Update the portal role of a individual user

    • Updated on 26 Sep 2023
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Article Summary

    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.

    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.

    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.

    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.

    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 (ExtensionDataObject)
    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError)

    Errors in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string

    Stack trace for error response message

    description
    string

    Description for error cause

    error_code
    string

    Error code for Api resonse

    custom_data
    object
    warnings
    Array of object (BaseWarning)

    Warning in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    Warning description

    warning_code
    string

    warning code for customer Api base response

    information
    Array of object (BaseInformation)

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    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
    result
    boolean

    Customer API response data

    extension_data
    object (ExtensionDataObject)
    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError)

    Errors in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string

    Stack trace for error response message

    description
    string

    Description for error cause

    error_code
    string

    Error code for Api resonse

    custom_data
    object
    warnings
    Array of object (BaseWarning)

    Warning in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    Warning description

    warning_code
    string

    warning code for customer Api base response

    information
    Array of object (BaseInformation)

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    status description for customer Api response information

    Was this article helpful?
    What's Next