Service: User Group Member Invitation

** WARNING: This service is experimental and may change without any notice.

Invites users as members of a user-group. Only user-group admins and system admins are allowed. If mailing is enabled (see mail setting), email notifications to join the group are sent to the users listed as members. Membership status PENDING is assigned to the invited users.

Available in: full version

Method: POST

Service URL: root/group/@{group_name}/invite

Parameters

Header Parameters

Name	Required	Description	Value
Authorization	yes	HTTP authentication with scheme: Bearer	OAuth2 access token
Content-Type	yes	content type of the input data	x-www-form-urlencoded

Path Parameters

Name	Required	Description	Type
group_name	yes	user group name	String

URL Encoded parameter

Name	Required	Description	Type
members	yes	a list of usernames separated by commas	String

Examples

Request with cURL

curl -H 'Content-Type: application/x-www-form-urlencoded' 
     -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1MTM1MzI3O
       TAxMzQsInN1YiI6InVzZXJuYW1lIiwiaXNzIjoiaHR0cDpcL1wva29yYXAuaWRzLW1
       hbm5oZWltLmRlIn0.p4jHIGeVwTpYAPFiWAd0R8Zcazyg7e9_tUGxOyFGUlo' 
     -d 'members=pearl,tad'
      http://localhost:8089/api/v1.0/group/@marlin-group/invite

Request with Basic authentication (for testing only)

curl -H 'Content-Type: application/x-www-form-urlencoded' 
     -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' 
     -d 'members=pearl,tad'
      http://localhost:8089/api/v1.0/group/@marlin-group/invite