You can get the REST API from Settings > Advanced > API tokens.
Route Parameters
Parameter
Required
Type
Description
readerId
Yes
string
The ID of the reader to update
Body Parameters
Parameter
Required
Type
Description
associated_reader_groups
Yes
Yes
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
Yes
object
Access scope of this reader.
first_name
No
string
The first name of the reader.
last_name
No
string
The last name of the reader.
is_invitation_id
No
bool
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.
Body Parameters > access_scope
Parameter
Required
Type
Description
access_level
Yes
number
The access level for the reader. 0-None, 1-Category, 2-Version, 3-Project, 4-Language
categories
Conditionally
object[]
List of category scope objects. The field is required when access_level is set to 1-Category
project_versions
Conditionally
string[]
List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version.
languages
Conditionally
object[]
List of language scope objects. The field is required when access_level is set to 4-Language.
Body Parameters > access_scope > categories
Parameter
Required
Type
Description
category_id
Yes
string
The category ID to which the user should be given access.
project_version_id
Yes
string
The project version ID to which the category belongs.
language_code
Yes
string
The language to which the user should be given access.
Body Parameters > access_scope > languages
Parameter
Required
Type
Description
project_version_id
Yes
string
The project version ID to which the user should be given access.
language_code
Yes
string
The language to which the user should be given access.
By clicking on "Accept cookies", you consent to the use of only necessary/essential cookies to enhance the Document360 knowledge base site navigation, analyze site usage, and assist in our marketing efforts. For more details, please read our Privacy policy.