Post
/v2/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
Show example
Collapse all
object
first_name
string

The first name of the reader

last_name
string

The last name of the reader

email_id
string (email) Required

The Email address of the reader

Min length1
associated_reader_groups
Array of string

List of reader group IDs

string
access_scope
object (AddUpdateAccessScopeCustomerV2)

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

Specify if the reader is a Single Sign-On user or not

skip_sso_invitation_email
boolean

If the value is true, then the invitation email will not be sent to the reader. Applicable only for a Single Sign-On reader.

invited_by
string Required

The ID of an existing team account. The name of this team account will be mentioned in the invitation email.

Min length1
Collapse all
object
first_name
string

The first name of the reader

last_name
string

The last name of the reader

email_id
string (email) Required

The Email address of the reader

Min length1
associated_reader_groups
Array of string

List of reader group IDs

string
access_scope
object (AddUpdateAccessScopeCustomerV2)

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

Specify if the reader is a Single Sign-On user or not

skip_sso_invitation_email
boolean

If the value is true, then the invitation email will not be sent to the reader. Applicable only for a Single Sign-On reader.

invited_by
string Required

The ID of an existing team account. The name of this team account will be mentioned in the invitation email.

Min length1
Collapse all
object
first_name
string

The first name of the reader

last_name
string

The last name of the reader

email_id
string (email) Required

The Email address of the reader

Min length1
associated_reader_groups
Array of string

List of reader group IDs

string
access_scope
object (AddUpdateAccessScopeCustomerV2)

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

Specify if the reader is a Single Sign-On user or not

skip_sso_invitation_email
boolean

If the value is true, then the invitation email will not be sent to the reader. Applicable only for a Single Sign-On reader.

invited_by
string Required

The ID of an existing team account. The name of this team account will be mentioned in the invitation email.

Min length1
Collapse all
object
first_name
string

The first name of the reader

last_name
string

The last name of the reader

email_id
string (email) Required

The Email address of the reader

Min length1
associated_reader_groups
Array of string

List of reader group IDs

string
access_scope
object (AddUpdateAccessScopeCustomerV2)

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

Specify if the reader is a Single Sign-On user or not

skip_sso_invitation_email
boolean

If the value is true, then the invitation email will not be sent to the reader. Applicable only for a Single Sign-On reader.

invited_by
string Required

The ID of an existing team account. The name of this team account will be mentioned in the invitation email.

Min length1
Responses
200
400
Show example

Success

Collapse all
object
result
string

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)

Warnings in the customer API response

object
information
Array of object (BaseInformation)

Information passed by the customer API response

object