Document360 Customer API

Get complete user details by id

23 May 2024
3 Minutes to read
Contributors

Print
Share
Dark
Light
PDF

Get complete user details by id

Updated on 23 May 2024
3 Minutes to read
Contributors

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Get

/v2/Teams/{userId}

Security

API Key

Header parameter nameapi_token

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

Path parameters

userId

stringRequired

The ID of the team account

Responses

200

Success

Teams - Success status Response

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": "[email protected]",
    "profile_logo_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E",
    "last_login_at": "2024-05-23T02:28:57Z",
    "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": []
}

Expand All

object

result

Array of object (CompleteUserInfoCustomer) | null

Customer API response data

object

user_id

string | null

The ID of the user

first_name

string | null

First name of the user

last_name

string | null

Last name of the user

email_id

string | null

Email address of the user

profile_logo_url

string | null

Profile image URL of the user

last_login_at

string (date-time) | null

Last login date of the user

portal_role

object (RoleSummaryCustomer)

role_id

string | null

role_name

string | null

content_roles

Array of object (ContentRoleSummaryCustomer) | null

The name of content role

object

version_access

object (VersionAccessInfo)

version_name

string | null

version_id

string | null

language_access

object (LanguageAccessInfo)

language_id

string | null

language_name

string | null

language_code

string | null

version_name

string | null

version_id

string | null

category_access

object (CategoryAccessInfo)

category_name

string | null

category_id

string | null

language_id

string | null

language_name

string | null

language_code

string | null

version_name

string | null

version_id

string | null

article_access

object (ArticleAccessInfo)

article_name

string | null

category_name

string | null

category_id

string | null

language_id

string | null

language_name

string | null

language_code

string | null

version_name

string | null

version_id

string | null

access_scope_level

integer (int32)

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 ]

role_id

string | null

role_name

string | null

associated_groups

Array of object (GroupInfo) | null

THe group associated with the team account

object

string | null

title

string | null

description

string | null

content_role_infos

Array of object (ContentRoleInfo) | null

object

version_access_info

object (VersionAccessInfo)

version_name

string | null

version_id

string | null

language_access_info

object (LanguageAccessInfo)

language_id

string | null

language_name

string | null

language_code

string | null

version_name

string | null

version_id

string | null

category_access_info

object (CategoryAccessInfo)

category_name

string | null

category_id

string | null

language_id

string | null

language_name

string | null

language_code

string | null

version_name

string | null

version_id

string | null

article_access_info

object (ArticleAccessInfo)

article_name

string | null

category_name

string | null

category_id

string | null

language_id

string | null

language_name

string | null

language_code

string | null

version_name

string | null

version_id

string | null

access_scope_level

integer (int32)

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 ]

role_name

string | null

role_id

string | null

group_name

string | null

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

Teams - Invalid User Id

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": []
}

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

Get all user groups