Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Here you can add new reader with access scope and access level as None.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 0,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Article.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 5,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Category.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 1,
"categories": [
{
"project_version_id": "d4fb5c7e-fcbe-4797-b144-1a7ca2508fe3",
"category_id": "s5fb5c7e-fcbe-4797-b144-1a7ca2508fq2",
"language_code": "en"
}
],
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Language.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 4,
"categories": null,
"project_versions": null,
"languages": [
{
"project_version_id": "4rb5c7e-fcbe-4797-b144-1a7ca2508fdr",
"language_code": "en"
}
]
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Project.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 3,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Version.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 2,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}The first name of the reader
The last name of the reader
The Email address of the reader
List of reader group IDs
If access scope is not given, then 0-None access level will be assigned
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.
Specify if the reader is a Single Sign-On user or not
Specify to add the reader to the specific scheme name, if the reader is a Single Sign-On user. If the scheme name is not provided, then the reader will be added to the default scheme.
If the value is true, then the invitation email will not be sent to the reader. Applicable only for a Single Sign-On reader.
The ID of an existing team account. The name of this team account will be mentioned in the invitation email.
Here you can add new reader with access scope and access level as None.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 0,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Article.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 5,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Category.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 1,
"categories": [
{
"project_version_id": "d4fb5c7e-fcbe-4797-b144-1a7ca2508fe3",
"category_id": "s5fb5c7e-fcbe-4797-b144-1a7ca2508fq2",
"language_code": "en"
}
],
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Language.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 4,
"categories": null,
"project_versions": null,
"languages": [
{
"project_version_id": "4rb5c7e-fcbe-4797-b144-1a7ca2508fdr",
"language_code": "en"
}
]
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Project.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 3,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Version.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 2,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}The first name of the reader
The last name of the reader
The Email address of the reader
List of reader group IDs
If access scope is not given, then 0-None access level will be assigned
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.
Specify if the reader is a Single Sign-On user or not
Specify to add the reader to the specific scheme name, if the reader is a Single Sign-On user. If the scheme name is not provided, then the reader will be added to the default scheme.
If the value is true, then the invitation email will not be sent to the reader. Applicable only for a Single Sign-On reader.
The ID of an existing team account. The name of this team account will be mentioned in the invitation email.
Here you can add new reader with access scope and access level as None.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 0,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Article.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 5,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Category.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 1,
"categories": [
{
"project_version_id": "d4fb5c7e-fcbe-4797-b144-1a7ca2508fe3",
"category_id": "s5fb5c7e-fcbe-4797-b144-1a7ca2508fq2",
"language_code": "en"
}
],
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Language.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 4,
"categories": null,
"project_versions": null,
"languages": [
{
"project_version_id": "4rb5c7e-fcbe-4797-b144-1a7ca2508fdr",
"language_code": "en"
}
]
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Project.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 3,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Version.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 2,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}The first name of the reader
The last name of the reader
The Email address of the reader
List of reader group IDs
If access scope is not given, then 0-None access level will be assigned
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.
Specify if the reader is a Single Sign-On user or not
Specify to add the reader to the specific scheme name, if the reader is a Single Sign-On user. If the scheme name is not provided, then the reader will be added to the default scheme.
If the value is true, then the invitation email will not be sent to the reader. Applicable only for a Single Sign-On reader.
The ID of an existing team account. The name of this team account will be mentioned in the invitation email.
Here you can add new reader with access scope and access level as None.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 0,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Article.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 5,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Category.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 1,
"categories": [
{
"project_version_id": "d4fb5c7e-fcbe-4797-b144-1a7ca2508fe3",
"category_id": "s5fb5c7e-fcbe-4797-b144-1a7ca2508fq2",
"language_code": "en"
}
],
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Language.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 4,
"categories": null,
"project_versions": null,
"languages": [
{
"project_version_id": "4rb5c7e-fcbe-4797-b144-1a7ca2508fdr",
"language_code": "en"
}
]
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Project.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 3,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}Here you can add new reader with access scope and access level to Version.
{
"first_name": "Peter",
"last_name": "Jone",
"email_id": "peterjone@mail.com",
"associated_reader_groups": null,
"access_scope": {
"access_level": 2,
"categories": null,
"project_versions": null,
"languages": null
},
"is_sso_user": false,
"scheme_name": null,
"skip_sso_invitation_email": true,
"invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}The first name of the reader
The last name of the reader
The Email address of the reader
List of reader group IDs
If access scope is not given, then 0-None access level will be assigned
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.
Specify if the reader is a Single Sign-On user or not
Specify to add the reader to the specific scheme name, if the reader is a Single Sign-On user. If the scheme name is not provided, then the reader will be added to the default scheme.
If the value is true, then the invitation email will not be sent to the reader. Applicable only for a Single Sign-On reader.
The ID of an existing team account. The name of this team account will be mentioned in the invitation email.
Success
This is an example for 200 status, success response.
{
"result": "1c8e9f29-33e8-4301-af1d-dbf3c15a2782",
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}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 add InvitedBy field as it is required.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The InvitedBy field is required.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly add Email field as it is required.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Email Address is required.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly add access_scope field as it is required.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The AccessScope field is required.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}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