POST user/add-user-to-organization-group

Add a user to organization groups

Request Information

Headers

HTTP_AUTHORIZATION: Required. OAuth 1.0 parameters with the OAuth signature of the url you are going to request. The consumer keys and access token can be obtained from the community administration.

Sample:
        HTTP_AUTHORIZATION:
            OAuth oauth_token="CObXqjfOisVh9%2F2GjC7NNd8BCzY%3D",
            oauth_consumer_key="clGACsiGaMp%2FD%2BUwkSvRBxA1k50%3D",
            oauth_nonce="VqKza6d5x1HpPQWFe08spbdOnkTQpfaLfD9Oeuyg",
            oauth_signature_method="HMAC-SHA1",
            oauth_timestamp="1462882011",
            oauth_signature="RH5aKKKJaEvK5cIsZZzXtFh7cCk%3D"
    

Body Parameters

NameDescriptionTypeAdditional information
user_id

User identificator

globally unique identifier

Required

organization_short_name

Organization short name

string

Required

groups_short_names

Groups where the user is going to be added

Collection of string

Required

Request Formats

application/json, text/json

Sample:
{
  "user_id": "50b7615f-e32d-469d-ad93-d5829ab983ef",
  "organization_short_name": "gnossteam",
  "groups_short_names": [
    "administrators",
    "team1"
  ]
}

Response Information

Response HTTP status code

On success, the response contains 200 code.

On fail, throws a WebException with code:

  • 401 Unauthorized if the OAuth signature is invalid
  • 400 Bad Request if the params are invalid
  • 500 Internal server error if something goes wrong...