Skip to content

Service: User Group Member Role Management

Eliza Margaretha edited this page May 20, 2022 · 10 revisions

** 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
  • 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
memberUsername yes the username of a group member String
roleId yes role id that should be assign to the member, multiple roles can be assigned by specifying the parameters multiple times List

Examples

Request example with cURL

curl -H 'Content-Type: application/x-www-form-urlencoded' 
     -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1MTM1MzI3O
       TAxMzQsInN1YiI6InVzZXJuYW1lIiwiaXNzIjoiaHR0cDpcL1wva29yYXAuaWRzLW1
       hbm5oZWltLmRlIn0.p4jHIGeVwTpYAPFiWAd0R8Zcazyg7e9_tUGxOyFGUlo' 
     -d 'memberUsername=marlin&roleId=1&roleId=2'
     http://localhost:8089/api/v1.0/group/@marlin-group/role/add

Request example with Basic authentication (for testing only)

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

Advanced Setting

Developer Setting

Search services

Metadata services

Authentication and Authorization services

Client services

Super client services

Plugin services

User services

User group services

Virtual corpus services

Virtual corpus access services

Administrative services

Description services

Clone this wiki locally