Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}The first name of the reader
The last name of the reader
List of reader group IDs. If the value is null or not given, then the reader would be removed from all associated reader groups.
Access level of the reader. 0-None, 1-Category, 2-Version, 3-Project, 4-Language.
This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage
A list of category scope objects. This is only required if the access level is set 1 - Category
The project version id to which the category belongs.
The category id to which the user should be given access.
The language to which the user should be given access.
A list of project versions This is only required if the access level is set to 2 - Version
A list of language scope objects This is only required if the access level is set to 4 - Language
The project version id to which the user should be given access.
The language to which the user should be given access.
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 0 - Normal user, 1 - SSO user, 2 - Invited SSO user
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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}The first name of the reader
The last name of the reader
List of reader group IDs. If the value is null or not given, then the reader would be removed from all associated reader groups.
Access level of the reader. 0-None, 1-Category, 2-Version, 3-Project, 4-Language.
This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage
A list of category scope objects. This is only required if the access level is set 1 - Category
The project version id to which the category belongs.
The category id to which the user should be given access.
The language to which the user should be given access.
A list of project versions This is only required if the access level is set to 2 - Version
A list of language scope objects This is only required if the access level is set to 4 - Language
The project version id to which the user should be given access.
The language to which the user should be given access.
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 0 - Normal user, 1 - SSO user, 2 - Invited SSO user
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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}The first name of the reader
The last name of the reader
List of reader group IDs. If the value is null or not given, then the reader would be removed from all associated reader groups.
Access level of the reader. 0-None, 1-Category, 2-Version, 3-Project, 4-Language.
This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage
A list of category scope objects. This is only required if the access level is set 1 - Category
The project version id to which the category belongs.
The category id to which the user should be given access.
The language to which the user should be given access.
A list of project versions This is only required if the access level is set to 2 - Version
A list of language scope objects This is only required if the access level is set to 4 - Language
The project version id to which the user should be given access.
The language to which the user should be given access.
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 0 - Normal user, 1 - SSO user, 2 - Invited SSO user
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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}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": false,
"sso_user_type": 0
}The first name of the reader
The last name of the reader
List of reader group IDs. If the value is null or not given, then the reader would be removed from all associated reader groups.
Access level of the reader. 0-None, 1-Category, 2-Version, 3-Project, 4-Language.
This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage
A list of category scope objects. This is only required if the access level is set 1 - Category
The project version id to which the category belongs.
The category id to which the user should be given access.
The language to which the user should be given access.
A list of project versions This is only required if the access level is set to 2 - Version
A list of language scope objects This is only required if the access level is set to 4 - Language
The project version id to which the user should be given access.
The language to which the user should be given access.
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 0 - Normal user, 1 - SSO user, 2 - Invited SSO user
Success
This is an example for 200 status, success response.
{
"extension_data": null,
"success": true,
"errors": null,
"warnings": null,
"information": null
}Customer API response data
Extention data for customer API response
Status indication for customer API response
Errors in the customer API response
Thids is the Extention data object
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Extention Data for customer Api warning
Warning description
warning code for customer Api base response
Information passed by the customer API response
Extention data for customer Api response information
status description for customer Api response information
Bad Request
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
}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
}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
}Extention data for customer API response
Status indication for customer API response
Errors in the customer API response
Thids is the Extention data object
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Extention Data for customer Api warning
Warning description
warning code for customer Api base response
Information passed by the customer API response
Extention data for customer Api response information
status description for customer Api response information