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
Show example
Collapse 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_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
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 ]
Collapse 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_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
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 ]
Collapse 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_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
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 ]
Collapse 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_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
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
Show example

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)

Errors in the customer API response

object
warnings
Array of object (BaseWarning)

Warning in the customer API response

object
information
Array of object (BaseInformation)

Information passed by the customer API response

object