Login
    Contents x
    Add a new reader group
    • 23 May 2024
    • 15 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Add a new reader group

    • Updated on 23 May 2024
    • 15 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Post
    /v2/Readers/groups
    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 readers groups with access level None.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Article.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Category.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "rffb5c7e-fcbe-4797-b144-1a7ca2508fvew",
        "category_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Language.

    Here you can add new readers group with access scope and access level to particular Language.

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
        "language_code": "en"
      }
    ]
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Project.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": [
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd"
    ],
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Version.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    Expand All
    object
    title
    string Required

    The name of the reader group

    Min length1
    Pattern^[^~`!@#$%^&*)(+=|\]\[{};:?/>'.,]*$
    description
    string | null

    Access level of the reader group

    associated_readers
    Array of string | null

    Description of the reader group

    string
    access_scope
    object (AddUpdateAccessScopeCustomerV2)Required

    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) | null

    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 | null

    A list of project versions This is only required if the access level is set to 2 - Version

    string
    languages
    Array of object (LanguageScopeCustomer) | null

    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
    associated_invited_sso_users
    Array of string | null

    List of invitation IDs to be associated with this reader group. Applicable only for SSO readers.

    string
    ReadersGroup - Add a new readers groups with access level None.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Article.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Category.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "rffb5c7e-fcbe-4797-b144-1a7ca2508fvew",
        "category_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Language.

    Here you can add new readers group with access scope and access level to particular Language.

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
        "language_code": "en"
      }
    ]
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Project.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": [
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd"
    ],
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Version.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    Expand All
    object
    title
    string Required

    The name of the reader group

    Min length1
    Pattern^[^~`!@#$%^&*)(+=|\]\[{};:?/>'.,]*$
    description
    string | null

    Access level of the reader group

    associated_readers
    Array of string | null

    Description of the reader group

    string
    access_scope
    object (AddUpdateAccessScopeCustomerV2)Required

    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) | null

    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 | null

    A list of project versions This is only required if the access level is set to 2 - Version

    string
    languages
    Array of object (LanguageScopeCustomer) | null

    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
    associated_invited_sso_users
    Array of string | null

    List of invitation IDs to be associated with this reader group. Applicable only for SSO readers.

    string
    ReadersGroup - Add a new readers groups with access level None.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Article.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Category.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "rffb5c7e-fcbe-4797-b144-1a7ca2508fvew",
        "category_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Language.

    Here you can add new readers group with access scope and access level to particular Language.

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
        "language_code": "en"
      }
    ]
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Project.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": [
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd"
    ],
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Version.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    Expand All
    object
    title
    string Required

    The name of the reader group

    Min length1
    Pattern^[^~`!@#$%^&*)(+=|\]\[{};:?/>'.,]*$
    description
    string | null

    Access level of the reader group

    associated_readers
    Array of string | null

    Description of the reader group

    string
    access_scope
    object (AddUpdateAccessScopeCustomerV2)Required

    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) | null

    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 | null

    A list of project versions This is only required if the access level is set to 2 - Version

    string
    languages
    Array of object (LanguageScopeCustomer) | null

    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
    associated_invited_sso_users
    Array of string | null

    List of invitation IDs to be associated with this reader group. Applicable only for SSO readers.

    string
    ReadersGroup - Add a new readers groups with access level None.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Article.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Category.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "rffb5c7e-fcbe-4797-b144-1a7ca2508fvew",
        "category_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Language.

    Here you can add new readers group with access scope and access level to particular Language.

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
        "language_code": "en"
      }
    ]
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Project.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": [
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd"
    ],
    "languages": null
  },
  "associated_invited_sso_users": null
}
    ReadersGroup - Add a new readers groups with access level to Version.

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

    {
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
    Expand All
    object
    title
    string Required

    The name of the reader group

    Min length1
    Pattern^[^~`!@#$%^&*)(+=|\]\[{};:?/>'.,]*$
    description
    string | null

    Access level of the reader group

    associated_readers
    Array of string | null

    Description of the reader group

    string
    access_scope
    object (AddUpdateAccessScopeCustomerV2)Required

    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) | null

    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 | null

    A list of project versions This is only required if the access level is set to 2 - Version

    string
    languages
    Array of object (LanguageScopeCustomer) | null

    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
    associated_invited_sso_users
    Array of string | null

    List of invitation IDs to be associated with this reader group. Applicable only for SSO readers.

    string
    Responses
    200

    Success

    Readers - Success Response for add reader group

    This is an example for 200 status, success response.

    {
  "result": "02050a57-47e3-41b0-9f88-832c643abb8c",
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
    Expand All
    object
    result
    string | null

    Customer API response data

    extension_data
    object (ExtensionDataObject)
    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError) | null

    Errors in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string | null

    Stack trace for error response message

    description
    string | null

    Description for error cause

    error_code
    string | null

    Error code for Api response

    custom_data
    object | null
    warnings
    Array of object (BaseWarning) | null

    Warnings in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string | null

    Warning description

    warning_code
    string | null

    warning code for customer Api base response

    information
    Array of object (BaseInformation) | null

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string | null

    status description for customer Api response information

    400

    Bad Request

    Readers - Missing of Access Scope

    Kindly add access_scope field as it is mandatory.

    {
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The AccessScope field is required.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
    Readers - Missing of Title

    Kindly add title field as it is mandatory.

    {
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The Title field is required.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
    Readers - Title already exist

    Kindly change title name as it is already exist.

    {
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Title Name already exists. Title has to be unique.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
    Expand All
    object
    extension_data
    object (ExtensionDataObject)
    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError) | null

    Errors in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string | null

    Stack trace for error response message

    description
    string | null

    Description for error cause

    error_code
    string | null

    Error code for Api response

    custom_data
    object | null
    warnings
    Array of object (BaseWarning) | null

    Warnings in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string | null

    Warning description

    warning_code
    string | null

    warning code for customer Api base response

    information
    Array of object (BaseInformation) | null

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string | null

    status description for customer Api response information

    Was this article helpful?
    What's Next
    Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy.
    Products
    Company
    Top Features
    Solutions
    Existing Users
    Connect With Us
    Sales and Support
    Copyright © Abc Inc. All Rights Reserved
    Change password!
    Changing your password will log you out immediately. Use the new password to log back in.
    Change profile
    Success!
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    Logout