The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.
The ID of the team account
Success
Here you can verify the user portal role, content role,and group associated by the user.
{
"result": {
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"first_name": "peter",
"last_name": "jone",
"email_id": "peterjone@mail.com",
"profile_logo_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D",
"last_login_at": "2024-06-13T14:30:00Z",
"portal_role": {
"role_id": "c1b8ae08-78d5-41d9-b3c4-3b0892b05ca8",
"role_name": " Owner"
},
"content_roles": [
{
"version_access": null,
"language_access": null,
"category_access": null,
"article_access": null,
"access_scope_level": 3,
"role_id": "62810dc1-2d21-422e-bdfb-c3daebf91dd3",
"role_name": "Editor"
}
],
"associated_groups": [
{
"id": "c08e52df-1de9-44e7-8c02-be0e41826c24",
"title": "MyGroupName",
"description": "This is my group description.",
"content_role_infos": null
}
]
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Customer API response data
The ID of the user
First name of the user
Last name of the user
Email address of the user
Profile image URL of the user
Last login date of the user
The name of the portal role
The name of content role
This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage
THe group associated with the team account
This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Bad Request
Here the user Id is not valid, go to /v2/Teams/email-exists for finding the user Id. Kindly verify that the IsAnSsoUser is false for Non - SSO user.
{
"extension_data": null,
"success": true,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The user id does not exist.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.