Get all available roles including default as well as custom roles
  • 23 May 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Get all available roles including default as well as custom roles

  • Dark
    Light
  • PDF

Article summary

Get
/v2/Teams/roles
Security
API Key
Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Responses
200

Success

Teams - Success status Response

Here you can verify diffrent type of roles for the Teams.

{
  "result": [
    {
      "id": "64ced5a8-c2b9-4421-821a-4e32bdfaaecc",
      "title": "Contributor",
      "description": "An editor or draft writer with no admin access.",
      "is_system_role": true,
      "role_type": 0
    },
    {
      "id": "c1b8ae08-78d5-41d9-b3c4-3b0892b05ca8",
      "title": "Owner",
      "description": "",
      "is_system_role": true,
      "role_type": 0
    },
    {
      "id": "264485a9-088e-49bf-b33e-a417e9fa01e5",
      "title": "Admin",
      "description": "Admin has access to everything except billing.",
      "is_system_role": true,
      "role_type": 0
    },
    {
      "id": "88ec9ab0-2355-46b6-8eed-b3ce2cd870a8",
      "title": "None",
      "description": "No content scope assigned. This role can be changed later.",
      "is_system_role": true,
      "role_type": 0
    },
    {
      "id": "62810dc1-2d21-422e-bdfb-c3daebf91dd3",
      "title": "Editor",
      "description": "The editor can manage the articles, categories, drive, workflows, and content reuse.",
      "is_system_role": true,
      "role_type": 1
    },
    {
      "id": "926c7a3c-0fe8-40c8-a96f-f02c95a12d5c",
      "title": "Draft writer",
      "description": "A draft writer can add or edit the articles/category pages but has limitations publishing them.",
      "is_system_role": true,
      "role_type": 1
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
result
Array of object (RoleMetaData) | null

Customer API response data

object
id
string | null

The ID of the role

title
string | null

Name of the role

description
string | null

Description of role

is_system_role
boolean

If true, it indicates that the role is one of the system default roles.

role_type
integer (int32)
Valid values[ 0, 1 ]
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?

Changing your password will log you out immediately. Use the new password to log back in.
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.