Contents x
Modify the groups associated with the user
  • 16 Mar 2023
  • 3 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
Contents

Modify the groups associated with the user

  • Updated on 16 Mar 2023
  • 3 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
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
string Required

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.

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.

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.

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.

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.

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.

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.

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
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

400

Bad Request

associated_groups not found

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

{
  "result": false,
  "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
result
boolean

Customer Api response data

extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

Was this article helpful?
What's Next