Add reader
  • 02 Feb 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Add reader

  • Dark
    Light

POST /readers

Adds a reader to the project.


Header

ParameterTypeDescription
api_tokenstringYou can get the REST API from Settings > Advanced > API tokens.

Body Parameters

ParameterRequiredTypeDescription
email_idYesstringThe Email address of the reader
invited_byYesstringThe ID of an existing user. The name of this user will be mentioned in the invitation email.
first_nameNostringThe first name of the reader.
last_nameNostringThe last name of the reader.
associated_reader_groupsNostring[]List of reader group IDs.
access_scopeNoobjectIf access scope is not given then 0-None access level will be assigned.
is_sso_userNobooleanSpecify if the reader is a Single Sign-On user or not.
skip_sso_invitation_emailNobooleanIf the value is true then the invitation email will not be sent to the reader. Applicable only for a Single Sign-On reader.

Body Parameters > access_scope

ParameterRequiredTypeDescription
access_levelYesnumberThe access level for the reader. 0-None, 1-Category, 2-Version, 3-Project, 4-Language
categoriesConditionallyobject[]List of category scope objects. The field is required when access_level is set to 1-Category
project_versionsConditionally
string[]List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version.
languagesConditionally
object[]List of language scope objects. The field is required when access_level is set to 4-Language.

Body Parameters > access_scope > categories

ParameterRequiredTypeDescription
category_idYesstringThe category ID to which the user should be given access.
project_version_idYesstringThe project version ID to which the category belongs.
language_codeYesstringThe language to which the user should be given access.

Body Parameters > access_scope > languages

ParameterRequiredTypeDescription
project_version_idYesstringThe project version ID to which the user should be given access.
language_codeYesstringThe language to which the user should be given access.

Sample Request

{
	"first_name": "samuel",
	"last_name": "paul",
	"email_id": "samuel.paul@document360.io",
	"associated_reader_groups": [
		"f9291b56-6a66-47ea-9ad5-52cef640a6c8"
	],
	"access_scope": {
		"access_level": 3
	},
	"is_sso_user": false,
	"skip_sso_invitation_email": true,
	"invited_by": "c9710443-8a9b-46ac-a28f-222a76dffe91"
}

Sample Response

{
	"data": {
		"id": "c7d9d699-48f0-4384-b899-201df031260b"
	},
	"extension_data": null,
	"context": null,
	"success": true,
	"errors": [],
	"warnings": [],
	"information": []
}

Response Data

ParameterTypeDescription
idstringThe ID of the newly added reader.

Was this article helpful?

What's Next