Post
/v2/Teams
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Body parameters
Show example
Collapse all
object

Request to add a new team account user

email_id
string (email) Required

The email address of the team account

Min length1
first_name
string

First name of the team account

last_name
string

Last name of the team account

invited_by
string Required

The ID of an existing team account. To get the id, please refer GET /v2/Teams endpoint

Min length1
is_sso_user
boolean

Set this to true, if you are adding an SSO user

skip_sso_invitation_email
boolean

Set this to true, if you would like to avoid sending an invitation email to the newly added team account. This property is applicable only when adding a SSO user.

associated_portal_role_id
string Required

The associated portal role id. To get the list of portal roles refer /teams/roles endpoint.

Min length1
content_permissions
Array of object (ContentPermissionCustomer) Required

The content level permissions for the newly added team account

object

The content permission of the team account

associated_content_role_id
string Required

The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.

Min length1
access_scope
object (AddUpdateAccessScopeCustomerV2)Required

The access scope of the user

associated_groups
Array of string

A list of group ids to which the team account has to be added. Please refer /teams/groups endpoint to get the available groups.

string
Collapse all
object

Request to add a new team account user

email_id
string (email) Required

The email address of the team account

Min length1
first_name
string

First name of the team account

last_name
string

Last name of the team account

invited_by
string Required

The ID of an existing team account. To get the id, please refer GET /v2/Teams endpoint

Min length1
is_sso_user
boolean

Set this to true, if you are adding an SSO user

skip_sso_invitation_email
boolean

Set this to true, if you would like to avoid sending an invitation email to the newly added team account. This property is applicable only when adding a SSO user.

associated_portal_role_id
string Required

The associated portal role id. To get the list of portal roles refer /teams/roles endpoint.

Min length1
content_permissions
Array of object (ContentPermissionCustomer) Required

The content level permissions for the newly added team account

object

The content permission of the team account

associated_content_role_id
string Required

The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.

Min length1
access_scope
object (AddUpdateAccessScopeCustomerV2)Required

The access scope of the user

associated_groups
Array of string

A list of group ids to which the team account has to be added. Please refer /teams/groups endpoint to get the available groups.

string
Collapse all
object

Request to add a new team account user

email_id
string (email) Required

The email address of the team account

Min length1
first_name
string

First name of the team account

last_name
string

Last name of the team account

invited_by
string Required

The ID of an existing team account. To get the id, please refer GET /v2/Teams endpoint

Min length1
is_sso_user
boolean

Set this to true, if you are adding an SSO user

skip_sso_invitation_email
boolean

Set this to true, if you would like to avoid sending an invitation email to the newly added team account. This property is applicable only when adding a SSO user.

associated_portal_role_id
string Required

The associated portal role id. To get the list of portal roles refer /teams/roles endpoint.

Min length1
content_permissions
Array of object (ContentPermissionCustomer) Required

The content level permissions for the newly added team account

object

The content permission of the team account

associated_content_role_id
string Required

The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.

Min length1
access_scope
object (AddUpdateAccessScopeCustomerV2)Required

The access scope of the user

associated_groups
Array of string

A list of group ids to which the team account has to be added. Please refer /teams/groups endpoint to get the available groups.

string
Collapse all
object

Request to add a new team account user

email_id
string (email) Required

The email address of the team account

Min length1
first_name
string

First name of the team account

last_name
string

Last name of the team account

invited_by
string Required

The ID of an existing team account. To get the id, please refer GET /v2/Teams endpoint

Min length1
is_sso_user
boolean

Set this to true, if you are adding an SSO user

skip_sso_invitation_email
boolean

Set this to true, if you would like to avoid sending an invitation email to the newly added team account. This property is applicable only when adding a SSO user.

associated_portal_role_id
string Required

The associated portal role id. To get the list of portal roles refer /teams/roles endpoint.

Min length1
content_permissions
Array of object (ContentPermissionCustomer) Required

The content level permissions for the newly added team account

object

The content permission of the team account

associated_content_role_id
string Required

The content role id of the team account.Please refer GET /Teams/roles endpoint to get the list of content roles.

Min length1
access_scope
object (AddUpdateAccessScopeCustomerV2)Required

The access scope of the user

associated_groups
Array of string

A list of group ids to which the team account has to be added. Please refer /teams/groups endpoint to get the available groups.

string
Responses
200
400
Show example

Success

Collapse all
object
result
object (AddUserData)
id
string

Newly added user Id

extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError)

Errors in the customer API response

object
warnings
Array of object (BaseWarning)

Warning in the customer API response

object
information
Array of object (BaseInformation)

Information passed by the customer API response

object