Service: User Group Member Role Management

** WARNING: Role addition service and parameters memberUsername and roleIds are DEPRECATED starting 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.

Adds or deletes roles of active user-group members. Only user-group admins and system admins are allowed.

Available in: full version

Method: POST

Service URL:

• root/group/@{group_name}/role/add (DEPRECATED)
• root/group/@{group_name}/role/delete

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
group_name	yes	user-group name	String

URL-encoded Form Parameters

Name	Required	Description	Type
member	yes	the username of a group member	String
memberUsername (DEPRECATED)	yes	the username of a group member	String
roleId (DEPRECATED)	yes	role id that should be assign to the member, multiple roles can be assigned by specifying the parameters multiple times	List
role	yes	member roles to be removed	List see de.ids_mannheim.korap.constant.PredefinedRole

Examples

Request example with Basic authentication (for testing only)

curl -H 'Content-Type: application/x-www-form-urlencoded' 
     -H 'Authorization: Basic ZG9yeTpwYXNzd29yZA==' 
     -d 'member=nemo&role=GROUP_ADMIN'
     http://localhost:8089/api/v1.0/group/@dory-group/role/delete

DEPRECATED

curl -H 'Content-Type: application/x-www-form-urlencoded' 
     -H 'Authorization: Basic ZG9yeTpwYXNzd29yZA==' 
     -d 'member=nemo&roleId=1&roleId=2' 
     http://localhost:8089/api/v1.0/group/@dory-group/role/add

DEPRECATED

curl -H 'Content-Type: application/x-www-form-urlencoded' 
     -H 'Authorization: Basic ZG9yeTpwYXNzd29yZA==' 
     -d 'member=nemo&roleId=2'
     http://localhost:8089/api/v1.0/group/@dory-group/role/delete

Response

Status Code	Description
200	OK
400	When the group role exists
404	When the group name is missing or not found