Service: User Group Creation

** WARNING: Member invitation and VC access are DEPRECATED from Kustvakt version 0.75 and will be completely removed in API v1.1.

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

Creates a user group with the group creator (the authenticated user) as the only member, or updates the user-group if it exists. Other members can be invited to the group by using the group-member invitation API. In the service URL, groupName is marked with @ as a prefix. If the specified user-group exists, the service returns HTTP status 204 No Content, otherwise 201 Created.

A group creator is the group owner and automatically granted with USER_GROUP_ADMIN and VC_ACCESS_ADMIN roles. User group admins have privileges to manage user-group members such as inviting users as group members. On the other hand, VC access admin have privileges to manage group VC such as sharing a VC to the group.

Available in: full version

Method: PUT

Service URL: root/group/@{groupName}

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	application/x-www-form-urlencoded

Path Parameters

Name	Required	Description	Type
groupName	yes	user-group name consisting only of alphabets, underscores, dashes or fullstops	String

URL Encoded Parameters

Name	Required	Description	Type
description	no	description about the group	String

Examples

Request with cURL

curl --request PUT -H 'Content-Type: application/x-www-form-urlencoded' 
     -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1MTM1MzI3O
       TAxMzQsInN1YiI6InVzZXJuYW1lIiwiaXNzIjoiaHR0cDpcL1wva29yYXAuaWRzLW1
       hbm5oZWltLmRlIn0.p4jHIGeVwTpYAPFiWAd0R8Zcazyg7e9_tUGxOyFGUlo' 
     -d 'description=people working on the KorAP project'
      http://localhost:8089/api/v1.0/group/@korap-group

Request with Basic authentication (for testing only)

curl --request PUT -H 'Content-Type: application/x-www-form-urlencoded' 
     -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' 
     -d 'description=a group of people working on the KorAP project'
      http://localhost:8089/api/v1.0/group/@korap-group

Response

HTTP/1.1 201 Created (when creating a new user-group)

or

HTTP/1.1 204 No Content (when updating an existing user-group)