Contents x
    Add a new reader
    • 26 Sep 2023
    • 15 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Add a new reader

    • Updated on 26 Sep 2023
    • 15 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Article Summary

    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
    ReadersGroup - Add a new reader with access level None.

    Here you can add new reader with access scope and access level as None.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Article.

    Here you can add new reader with access scope and access level to Article.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Category.

    Here you can add new reader with access scope and access level to Category.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "d4fb5c7e-fcbe-4797-b144-1a7ca2508fe3",
        "category_id": "s5fb5c7e-fcbe-4797-b144-1a7ca2508fq2",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Language.

    Here you can add new reader with access scope and access level to Language.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "4rb5c7e-fcbe-4797-b144-1a7ca2508fdr",
        "language_code": "en"
      }
    ]
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Project.

    Here you can add new reader with access scope and access level to Project.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Version.

    Here you can add new reader with access scope and access level to Version.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    Expand 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_version_id
    string Required

    The project version id to which the category belongs.

    Min length1
    category_id
    string Required

    The category id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    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
    project_version_id
    string Required

    The project version id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    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
    ReadersGroup - Add a new reader with access level None.

    Here you can add new reader with access scope and access level as None.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Article.

    Here you can add new reader with access scope and access level to Article.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Category.

    Here you can add new reader with access scope and access level to Category.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "d4fb5c7e-fcbe-4797-b144-1a7ca2508fe3",
        "category_id": "s5fb5c7e-fcbe-4797-b144-1a7ca2508fq2",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Language.

    Here you can add new reader with access scope and access level to Language.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "4rb5c7e-fcbe-4797-b144-1a7ca2508fdr",
        "language_code": "en"
      }
    ]
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Project.

    Here you can add new reader with access scope and access level to Project.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Version.

    Here you can add new reader with access scope and access level to Version.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    Expand 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_version_id
    string Required

    The project version id to which the category belongs.

    Min length1
    category_id
    string Required

    The category id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    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
    project_version_id
    string Required

    The project version id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    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
    ReadersGroup - Add a new reader with access level None.

    Here you can add new reader with access scope and access level as None.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Article.

    Here you can add new reader with access scope and access level to Article.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Category.

    Here you can add new reader with access scope and access level to Category.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "d4fb5c7e-fcbe-4797-b144-1a7ca2508fe3",
        "category_id": "s5fb5c7e-fcbe-4797-b144-1a7ca2508fq2",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Language.

    Here you can add new reader with access scope and access level to Language.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "4rb5c7e-fcbe-4797-b144-1a7ca2508fdr",
        "language_code": "en"
      }
    ]
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Project.

    Here you can add new reader with access scope and access level to Project.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Version.

    Here you can add new reader with access scope and access level to Version.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    Expand 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_version_id
    string Required

    The project version id to which the category belongs.

    Min length1
    category_id
    string Required

    The category id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    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
    project_version_id
    string Required

    The project version id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    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
    ReadersGroup - Add a new reader with access level None.

    Here you can add new reader with access scope and access level as None.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Article.

    Here you can add new reader with access scope and access level to Article.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Category.

    Here you can add new reader with access scope and access level to Category.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "d4fb5c7e-fcbe-4797-b144-1a7ca2508fe3",
        "category_id": "s5fb5c7e-fcbe-4797-b144-1a7ca2508fq2",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Language.

    Here you can add new reader with access scope and access level to Language.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "4rb5c7e-fcbe-4797-b144-1a7ca2508fdr",
        "language_code": "en"
      }
    ]
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Project.

    Here you can add new reader with access scope and access level to Project.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    ReadersGroup - Add a new reader with access level to Version.

    Here you can add new reader with access scope and access level to Version.

    {
  "first_name": "Peter",
  "last_name": "Jone",
  "email_id": "peterjone@mail.com",
  "associated_reader_groups": null,
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "is_sso_user": false,
  "skip_sso_invitation_email": true,
  "invited_by": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"
}
    Expand 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_version_id
    string Required

    The project version id to which the category belongs.

    Min length1
    category_id
    string Required

    The category id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    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
    project_version_id
    string Required

    The project version id to which the user should be given access.

    Min length1
    language_code
    string Required

    The language to which the user should be given access.

    Min length1
    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

    Success

    Readers - Success Response for adding new readers.

    This is an example for 200 status, success response.

    {
  "result": "1c8e9f29-33e8-4301-af1d-dbf3c15a2782",
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
    Expand 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
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string

    Stack trace for error response message

    description
    string

    Description for error cause

    error_code
    string

    Error code for Api resonse

    custom_data
    object
    warnings
    Array of object (BaseWarning)

    Warning in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    Warning description

    warning_code
    string

    warning code for customer Api base response

    information
    Array of object (BaseInformation)

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    status description for customer Api response information

    400

    Bad Request

    Readers - InvitedBy filed is missing

    Kindly add InvitedBy field as it is required.

    {
  "result": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The InvitedBy field is required.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
    Readers - Email field is missing

    Kindly add Email field as it is required.

    {
  "result": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Email Address is required.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
    Readers - AccessScope field is missing

    Kindly add access_scope field as it is required.

    {
  "result": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The AccessScope field is required.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
    Expand 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
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string

    Stack trace for error response message

    description
    string

    Description for error cause

    error_code
    string

    Error code for Api resonse

    custom_data
    object
    warnings
    Array of object (BaseWarning)

    Warning in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    Warning description

    warning_code
    string

    warning code for customer Api base response

    information
    Array of object (BaseInformation)

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    status description for customer Api response information

    Was this article helpful?
    What's Next