Put
/v1/Readers

Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Body parameters

Details of the reader to add

Collapse all

object

reader_id
string   Required 

The ID of the reader to update

Min length1
associated_reader_groups
Array of string

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_scope
object  Required 

access_level
integer   Required 

Valid values[0,1,2,3,4,5]
categories
Array of string

List of category scope objects. The field is required when access_level is set to 1-Category


project_versions
Array of string

List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version.


Collapse all

object

reader_id
string   Required 

The ID of the reader to update

Min length1
associated_reader_groups
Array of string

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_scope
object  Required 

access_level
integer   Required 

Valid values[0,1,2,3,4,5]
categories
Array of string

List of category scope objects. The field is required when access_level is set to 1-Category


project_versions
Array of string

List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version.


Collapse all

object

reader_id
string   Required 

The ID of the reader to update

Min length1
associated_reader_groups
Array of string

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_scope
object  Required 

access_level
integer   Required 

Valid values[0,1,2,3,4,5]
categories
Array of string

List of category scope objects. The field is required when access_level is set to 1-Category


project_versions
Array of string

List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version.


Collapse all

object

reader_id
string   Required 

The ID of the reader to update

Min length1
associated_reader_groups
Array of string

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_scope
object  Required 

access_level
integer   Required 

Valid values[0,1,2,3,4,5]
categories
Array of string

List of category scope objects. The field is required when access_level is set to 1-Category


project_versions
Array of string

List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version.


Responses
200
400
Show example

Success

Collapse all

object

extension_data
object


success
boolean 

Status indication for customer Api response


errors
Array of object

Errors in the customer Api response


object

warnings
Array of object

Warning in the customer Api response


object

information
Array of object

Information passed by the customer Api response


object