Contents x
    Get complete user details by id
    • 25 Nov 2023
    • 2 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Get complete user details by id

    • Updated on 25 Nov 2023
    • 2 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Article Summary

    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": "peterjone@mail.com",
    "profile_logo_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E",
    "last_login_at": "2023-11-25T10:59:35.1896081Z",
    "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 (TeamAccountGroupSummaryCustomer)

    Customer API response data

    object
    group_id
    string

    The ID of the team account group.

    title
    string

    The name of the team account group.

    description
    string

    Description of the team account group.

    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 response

    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

    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.

    {
  "result": null,
  "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
    result
    Array of object (TeamAccountGroupSummaryCustomer)

    Customer API response data

    object
    group_id
    string

    The ID of the team account group.

    title
    string

    The name of the team account group.

    description
    string

    Description of the team account group.

    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 response

    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