-
Print
-
DarkLight
POST/readers
Adds a reader to the project
Header
Parameter | Type | Description |
---|---|---|
api_token | string | REST API key you can obtain from Settings > Advanced > API tokens. |
Body Parameters
Parameters highlighted in bold are mandatory
Parameter | Type | Description |
---|---|---|
email_id | string | The Email address of the reader |
associated_reader_groups | string[] | List of reader group IDs. |
access_scope | object | Access scope of this reader. |
is_sso_user | boolean | Specify if reader is a Single Sign-On user or not |
skip_sso_invitation_email | boolean | If set to true, the invitation email will not be sent to the reader. Applicable only for a SSO reader. |
user_id | string | The ID of the user that will be marked as an inviter. Mandatory when is_sso_user is true |
Body Parameters > access_scope
Parameter | Type | Description |
---|---|---|
access_level | number | The access level for the reader. 0-None, 1-Category, 2-Version, 3-Project. If access scope is not specified, the reader will be added with Project scope. |
categories | string[] | List of category IDs the reader has access to. Mandatory when access_level is 1-Category. |
project_versions | string[] | List of project version IDs the reader has access to. Mandatory when access_level is 2-Version. |
Sample Request
{
"email_id": "samuel.paul@document360.com",
"associated_reader_groups": [
"bb88841d-fac4-4a73-b106-4c5fcdd58ffe"
]
}
Sample Response
{
"data": {
"id": "c7d9d699-48f0-4384-b899-201df031260b"
},
"extension_data": null,
"context": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}
Response Data
Parameter | Type | Description |
---|---|---|
id | string | ID of the newly added reader. |
Was this article helpful?