user-site

Put

/v2/Teams/{userId}/content

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 content role has to be updated

Body parameters

Team Account - Edit Content Role for individual user.

Here you can edit the existing portal role for individual user with access scope level as None. 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.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 0,
        "categories": [],
        "project_versions": [],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Category.

Here you can edit the existing portal role for individual user with access scope level as Category. 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.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 1,
        "categories": [
          {
            "project_version_id": "9fa1a-37db-4d15-b06b-0261c60d1v4r",
            "category_id": "23ra1a-37db-4d15-b06b-0261c60d1g4t",
            "language_code": "en"
          }
        ],
        "project_versions": [],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Language.

Here you can edit the existing portal role for individual user with access scope level as Language. 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.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 4,
        "categories": [],
        "project_versions": [],
        "languages": [
          {
            "project_version_id": "2f29faa-7bdb-4d15-b06b-61c60d183",
            "language_code": "en"
          }
        ]
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Project.

Here you can edit the existing portal role for individual user with access scope level as Project. 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.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 3,
        "categories": [],
        "project_versions": [],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Version.

Here you can edit the existing portal role for individual user with access scope level as Version. 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.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 2,
        "categories": [],
        "project_versions": [
          "dwqd41a-3f7db-4we415-b06b-0261c60d14rf3",
          "sdfda1a-37fdb-4gd15-b06b-0261c60dsdfdsf"
        ],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Expand All

object

content_permissions

Array of object (ContentPermissionCustomer) Required

Content permissions of the team account. Note that a team account can have multiple content permissions.

object

The content permission of the team account

associated_content_role_id

string Required

The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.

Min length1

access_scope

object (AddUpdateAccessScopeCustomerV2)Required

The access scope of the user

access_level

integer (int32) Required

This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage

Valid values[ 0, 1, 2, 3, 4, 5, 6 ]

categories

Array of object (CategoryScopeCustomer) | null

A list of category scope objects. This is only required if the access level is set 1 - Category

object

project_version_id

string Required

The project version id to which the category belongs.

Min length1

category_id

string Required

The category id to which the user should be given access.

Min length1

language_code

string Required

The language to which the user should be given access.

Min length1

project_versions

Array of string | null

A list of project versions This is only required if the access level is set to 2 - Version

string

languages

Array of object (LanguageScopeCustomer) | null

A list of language scope objects This is only required if the access level is set to 4 - Language

object

project_version_id

string Required

The project version id to which the user should be given access.

Min length1

language_code

string Required

The language to which the user should be given access.

Min length1

is_invitation_id

boolean

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

Team Account - Edit Content Role for individual user.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 0,
        "categories": [],
        "project_versions": [],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Category.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 1,
        "categories": [
          {
            "project_version_id": "9fa1a-37db-4d15-b06b-0261c60d1v4r",
            "category_id": "23ra1a-37db-4d15-b06b-0261c60d1g4t",
            "language_code": "en"
          }
        ],
        "project_versions": [],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Language.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 4,
        "categories": [],
        "project_versions": [],
        "languages": [
          {
            "project_version_id": "2f29faa-7bdb-4d15-b06b-61c60d183",
            "language_code": "en"
          }
        ]
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Project.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 3,
        "categories": [],
        "project_versions": [],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Version.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 2,
        "categories": [],
        "project_versions": [
          "dwqd41a-3f7db-4we415-b06b-0261c60d14rf3",
          "sdfda1a-37fdb-4gd15-b06b-0261c60dsdfdsf"
        ],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Expand All

object

content_permissions

Array of object (ContentPermissionCustomer) Required

Content permissions of the team account. Note that a team account can have multiple content permissions.

object

The content permission of the team account

associated_content_role_id

string Required

The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.

Min length1

access_scope

object (AddUpdateAccessScopeCustomerV2)Required

The access scope of the user

access_level

integer (int32) Required

This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage

Valid values[ 0, 1, 2, 3, 4, 5, 6 ]

categories

Array of object (CategoryScopeCustomer) | null

A list of category scope objects. This is only required if the access level is set 1 - Category

object

project_version_id

string Required

The project version id to which the category belongs.

Min length1

category_id

string Required

The category id to which the user should be given access.

Min length1

language_code

string Required

The language to which the user should be given access.

Min length1

project_versions

Array of string | null

A list of project versions This is only required if the access level is set to 2 - Version

string

languages

Array of object (LanguageScopeCustomer) | null

A list of language scope objects This is only required if the access level is set to 4 - Language

object

project_version_id

string Required

The project version id to which the user should be given access.

Min length1

language_code

string Required

The language to which the user should be given access.

Min length1

is_invitation_id

boolean

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

Team Account - Edit Content Role for individual user.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 0,
        "categories": [],
        "project_versions": [],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Category.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 1,
        "categories": [
          {
            "project_version_id": "9fa1a-37db-4d15-b06b-0261c60d1v4r",
            "category_id": "23ra1a-37db-4d15-b06b-0261c60d1g4t",
            "language_code": "en"
          }
        ],
        "project_versions": [],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Language.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 4,
        "categories": [],
        "project_versions": [],
        "languages": [
          {
            "project_version_id": "2f29faa-7bdb-4d15-b06b-61c60d183",
            "language_code": "en"
          }
        ]
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Project.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 3,
        "categories": [],
        "project_versions": [],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Version.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 2,
        "categories": [],
        "project_versions": [
          "dwqd41a-3f7db-4we415-b06b-0261c60d14rf3",
          "sdfda1a-37fdb-4gd15-b06b-0261c60dsdfdsf"
        ],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Expand All

object

content_permissions

Array of object (ContentPermissionCustomer) Required

Content permissions of the team account. Note that a team account can have multiple content permissions.

object

The content permission of the team account

associated_content_role_id

string Required

The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.

Min length1

access_scope

object (AddUpdateAccessScopeCustomerV2)Required

The access scope of the user

access_level

integer (int32) Required

This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage

Valid values[ 0, 1, 2, 3, 4, 5, 6 ]

categories

Array of object (CategoryScopeCustomer) | null

A list of category scope objects. This is only required if the access level is set 1 - Category

object

project_version_id

string Required

The project version id to which the category belongs.

Min length1

category_id

string Required

The category id to which the user should be given access.

Min length1

language_code

string Required

The language to which the user should be given access.

Min length1

project_versions

Array of string | null

A list of project versions This is only required if the access level is set to 2 - Version

string

languages

Array of object (LanguageScopeCustomer) | null

A list of language scope objects This is only required if the access level is set to 4 - Language

object

project_version_id

string Required

The project version id to which the user should be given access.

Min length1

language_code

string Required

The language to which the user should be given access.

Min length1

is_invitation_id

boolean

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

Team Account - Edit Content Role for individual user.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 0,
        "categories": [],
        "project_versions": [],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Category.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 1,
        "categories": [
          {
            "project_version_id": "9fa1a-37db-4d15-b06b-0261c60d1v4r",
            "category_id": "23ra1a-37db-4d15-b06b-0261c60d1g4t",
            "language_code": "en"
          }
        ],
        "project_versions": [],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Language.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 4,
        "categories": [],
        "project_versions": [],
        "languages": [
          {
            "project_version_id": "2f29faa-7bdb-4d15-b06b-61c60d183",
            "language_code": "en"
          }
        ]
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Project.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 3,
        "categories": [],
        "project_versions": [],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Team Account - Edit Content Role for individual user with access scope level as Version.

{
  "content_permissions": [
    {
      "associated_content_role_id": "2e29fa1a-37db-4d15-b06b-0261c60d1898",
      "access_scope": {
        "access_level": 2,
        "categories": [],
        "project_versions": [
          "dwqd41a-3f7db-4we415-b06b-0261c60d14rf3",
          "sdfda1a-37fdb-4gd15-b06b-0261c60dsdfdsf"
        ],
        "languages": []
      }
    }
  ],
  "is_invitation_id": false
}

Expand All

object

content_permissions

Array of object (ContentPermissionCustomer) Required

Content permissions of the team account. Note that a team account can have multiple content permissions.

object

The content permission of the team account

associated_content_role_id

string Required

The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.

Min length1

access_scope

object (AddUpdateAccessScopeCustomerV2)Required

The access scope of the user

access_level

integer (int32) Required

This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage

Valid values[ 0, 1, 2, 3, 4, 5, 6 ]

categories

Array of object (CategoryScopeCustomer) | null

A list of category scope objects. This is only required if the access level is set 1 - Category

object

project_version_id

string Required

The project version id to which the category belongs.

Min length1

category_id

string Required

The category id to which the user should be given access.

Min length1

language_code

string Required

The language to which the user should be given access.

Min length1

project_versions

Array of string | null

A list of project versions This is only required if the access level is set to 2 - Version

string

languages

Array of object (LanguageScopeCustomer) | null

A list of language scope objects This is only required if the access level is set to 4 - Language

object

project_version_id

string Required

The project version id to which the user should be given access.

Min length1

language_code

string Required

The language to which the user should be given access.

Min length1

is_invitation_id

boolean

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

Responses

200

Success

Successfully updated content roles

New role updated successfully.

{
  "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) | null

Errors in the customer API response

object

extension_data

object (ExtensionDataObject)

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

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object (ExtensionDataObject)

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

description

string | null

status description for customer Api response information

400

Bad Request

userId not found

Kindly verify the userId and perform the task again.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The invitation id 2e63692d-894b-4a41-90ce-1d0ba87a4b17 does not exist.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Expand All

object

extension_data

object (ExtensionDataObject)

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object (ExtensionDataObject)

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

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object (ExtensionDataObject)

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

description

string | null

status description for customer Api response information