Updates a reader

26 Sep 2023
15 Minutes to read
Contributors

Print
Share
Dark
Light

Updates a reader

Updated on 26 Sep 2023
15 Minutes to read
Contributors

Print
Share
Dark
Light

Article Summary

Share feedback

Thanks for sharing your feedback!

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
}

Expand All

object

first_name

string

The first name of the reader

last_name

string

The last name of the reader

associated_reader_groups

Array of stringRequired

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)

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

A list of project versions

This is only required if the access level is set to 2 - Version

string

languages

Array of object (LanguageScopeCustomer)

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

Expand All

object

first_name

string

The first name of the reader

last_name

string

The last name of the reader

associated_reader_groups

Array of stringRequired

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)

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

A list of project versions

This is only required if the access level is set to 2 - Version

string

languages

Array of object (LanguageScopeCustomer)

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

Expand All

object

first_name

string

The first name of the reader

last_name

string

The last name of the reader

associated_reader_groups

Array of stringRequired

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)

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

A list of project versions

This is only required if the access level is set to 2 - Version

string

languages

Array of object (LanguageScopeCustomer)

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

Expand All

object

first_name

string

The first name of the reader

last_name

string

The last name of the reader

associated_reader_groups

Array of stringRequired

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)

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

A list of project versions

This is only required if the access level is set to 2 - Version

string

languages

Array of object (LanguageScopeCustomer)

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

Success

Readers - Success Response for update reader

This is an example for 200 status, success response.

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

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

Readers - Invalid reader ID

Kindly verify your readers Id and perform the operation again. This seems to be an error while finding the reader, find your reader Id from /v2/Readers.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The reader id is invalid.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": null,
  "information": null
}

Readers - Required Access Scope

Here you should add access_scope within request body parameter. This may consist of access_level, categories, project_versions, languages.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The reader id is invalid.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": null,
  "information": null
}

Readers - Required associated reader groups

Here you should add associated reader groups within request body parameter.

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

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

Deletes a reader group