Modify the groups associated with the user

Updated on Dec 24, 2024

3 minute(s) read

Anand Murali

Put

/v2/Teams/{userId}/groups

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

Body parameters

Team Account -Edit associated user groups.

Here you can add or remove the existing associated groups of the user. To update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.

{
  "associated_groups": [
    "2e29fa1a-37db-4d15-b06b-0261c60d1898",
    "y529fa1a-gedb-4d15-b76b-0261c60d87t8"
  ],
  "is_invitation_id": true
}

object

associated_groups

Array of string Required

An array of group IDs in which the team account is associated.

string

is_invitation_id

boolean

Applicable only for SSO team accounts. If temporary invitation ID is passed as team account ID, then set this to true.

Team Account -Edit associated user groups.

{
  "associated_groups": [
    "2e29fa1a-37db-4d15-b06b-0261c60d1898",
    "y529fa1a-gedb-4d15-b76b-0261c60d87t8"
  ],
  "is_invitation_id": true
}

object

associated_groups

Array of string Required

An array of group IDs in which the team account is associated.

string

is_invitation_id

boolean

Applicable only for SSO team accounts. If temporary invitation ID is passed as team account ID, then set this to true.

Team Account -Edit associated user groups.

{
  "associated_groups": [
    "2e29fa1a-37db-4d15-b06b-0261c60d1898",
    "y529fa1a-gedb-4d15-b76b-0261c60d87t8"
  ],
  "is_invitation_id": true
}

object

associated_groups

Array of string Required

An array of group IDs in which the team account is associated.

string

is_invitation_id

boolean

Applicable only for SSO team accounts. If temporary invitation ID is passed as team account ID, then set this to true.

Team Account -Edit associated user groups.

{
  "associated_groups": [
    "2e29fa1a-37db-4d15-b06b-0261c60d1898",
    "y529fa1a-gedb-4d15-b76b-0261c60d87t8"
  ],
  "is_invitation_id": true
}

object

associated_groups

Array of string Required

An array of group IDs in which the team account is associated.

string

is_invitation_id

boolean

Applicable only for SSO team accounts. If temporary invitation ID is passed as team account ID, then set this to true.

Responses

200

Success

Successfully updated associated groups

Updated the group accociated with the user.

{
  "result": true,
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Expand All

object

result

boolean

Customer API response data

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

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

property*

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object | null

Extention Data for customer Api warning

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

Extention data for customer Api response information

description

string | null

status description for customer Api response information

400

Bad Request

associated_groups not found

kindly check the associated_groups id from /V2/Teams/Groups.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The AssociatedGroups field is required.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Expand All

object

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

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

property*

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object | null

Extention Data for customer Api warning

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

Extention data for customer Api response information

description

string | null

status description for customer Api response information

Was this article helpful?