user-site

Put

/v2/Readers/{readerId}

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

readerId

stringRequired

Body parameters

ReadersGroup - -Update an existing reader with access level None.

Here you can edit the reader with the access permission as None. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Article.

Here you can edit the reader with the access permission as Article. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Category.

Here you can edit the reader with the access permission as Category. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "rfb5c7e-fcbe-4797-b144-1a7ca2508f3",
        "category_id": "fb57e-fcbe-47xz7-b1d4-1a7ca2508f3e",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Language.

Here you can edit the reader with the access permission as Language. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "e3f5c7e-fcbe-4797-b144-1a7ca2508f5d",
        "language_code": "en"
      }
    ]
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Project.

Here you can edit the reader with the access permission as Project. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Version.

Here you can edit the reader with the access permission as Version. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

Collapse all

object

first_name

string | null

The first name of the reader

last_name

string | null

The last name of the reader

associated_reader_groups

Array of string Required

List of reader group IDs. If the value is null or not given, then the reader would be removed from all associated reader groups.

string

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_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

is_invitation_id

boolean

Applicable only for Single Sign-On readers. Set this property to true, if the reader is a Single Sign-On reader who hasn't logged in to the application yet.

sso_user_type

integer (int32)

SSO user type 0 - Normal user, 1 - SSO user, 2 - Invited SSO user

Valid values[ 0, 1, 2 ]

ReadersGroup - -Update an existing reader with access level None.

Here you can edit the reader with the access permission as None. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Article.

Here you can edit the reader with the access permission as Article. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Category.

Here you can edit the reader with the access permission as Category. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "rfb5c7e-fcbe-4797-b144-1a7ca2508f3",
        "category_id": "fb57e-fcbe-47xz7-b1d4-1a7ca2508f3e",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Language.

Here you can edit the reader with the access permission as Language. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "e3f5c7e-fcbe-4797-b144-1a7ca2508f5d",
        "language_code": "en"
      }
    ]
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Project.

Here you can edit the reader with the access permission as Project. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Version.

Here you can edit the reader with the access permission as Version. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

Collapse all

object

first_name

string | null

The first name of the reader

last_name

string | null

The last name of the reader

associated_reader_groups

Array of string Required

List of reader group IDs. If the value is null or not given, then the reader would be removed from all associated reader groups.

string

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_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

is_invitation_id

boolean

Applicable only for Single Sign-On readers. Set this property to true, if the reader is a Single Sign-On reader who hasn't logged in to the application yet.

sso_user_type

integer (int32)

SSO user type 0 - Normal user, 1 - SSO user, 2 - Invited SSO user

Valid values[ 0, 1, 2 ]

ReadersGroup - -Update an existing reader with access level None.

Here you can edit the reader with the access permission as None. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Article.

Here you can edit the reader with the access permission as Article. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Category.

Here you can edit the reader with the access permission as Category. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "rfb5c7e-fcbe-4797-b144-1a7ca2508f3",
        "category_id": "fb57e-fcbe-47xz7-b1d4-1a7ca2508f3e",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Language.

Here you can edit the reader with the access permission as Language. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "e3f5c7e-fcbe-4797-b144-1a7ca2508f5d",
        "language_code": "en"
      }
    ]
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Project.

Here you can edit the reader with the access permission as Project. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Version.

Here you can edit the reader with the access permission as Version. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

Collapse all

object

first_name

string | null

The first name of the reader

last_name

string | null

The last name of the reader

associated_reader_groups

Array of string Required

List of reader group IDs. If the value is null or not given, then the reader would be removed from all associated reader groups.

string

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_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

is_invitation_id

boolean

Applicable only for Single Sign-On readers. Set this property to true, if the reader is a Single Sign-On reader who hasn't logged in to the application yet.

sso_user_type

integer (int32)

SSO user type 0 - Normal user, 1 - SSO user, 2 - Invited SSO user

Valid values[ 0, 1, 2 ]

ReadersGroup - -Update an existing reader with access level None.

Here you can edit the reader with the access permission as None. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Article.

Here you can edit the reader with the access permission as Article. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Category.

Here you can edit the reader with the access permission as Category. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "rfb5c7e-fcbe-4797-b144-1a7ca2508f3",
        "category_id": "fb57e-fcbe-47xz7-b1d4-1a7ca2508f3e",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Language.

Here you can edit the reader with the access permission as Language. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "e3f5c7e-fcbe-4797-b144-1a7ca2508f5d",
        "language_code": "en"
      }
    ]
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Project.

Here you can edit the reader with the access permission as Project. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

ReadersGroup - -Update an existing reader with access level as Version.

Here you can edit the reader with the access permission as Version. Also add readerId in the path to complete the request.

{
  "first_name": "Peter",
  "last_name": "Jone",
  "associated_reader_groups": [
    "se3f5c7e-fcbe-4797-b144-1a7ca2508f50",
    "4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"
  ],
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_invitation_id": true,
  "sso_user_type": 0
}

Collapse all

object

first_name

string | null

The first name of the reader

last_name

string | null

The last name of the reader

associated_reader_groups

Array of string Required

List of reader group IDs. If the value is null or not given, then the reader would be removed from all associated reader groups.

string

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_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

is_invitation_id

boolean

Applicable only for Single Sign-On readers. Set this property to true, if the reader is a Single Sign-On reader who hasn't logged in to the application yet.

sso_user_type

integer (int32)

SSO user type 0 - Normal user, 1 - SSO user, 2 - Invited SSO user

Valid values[ 0, 1, 2 ]

Responses

200

400

Success

Collapse 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

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

Bad Request

Collapse 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

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object