-
Notifications
You must be signed in to change notification settings - Fork 3
Service: User Group Member Role Management
Eliza Margaretha Illig edited this page Oct 23, 2024
·
12 revisions
** 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.
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
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 |
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
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | When the group role exists |
| 404 | When the group name is missing or not found |
- Setting LDAP
- Setting initial super client
- Setting a custom environment
- Setting resources for CLARIN FCS
- Disabling query rewrites
- Named virtual corpora
- Importing Kustvakt to Eclipse
- Installing Lombok
- Setting annotation processors
- Setting a test environment
- HTTP Basic Authentication
- OAuth2 authorization scopes
- OAuth2 authorization request
- OAuth2 token request
- OAuth2 token revocation
- OAuth2 client registration
- OAuth2 client info
- OAuth2 client deregistration
- OAuth2 client secret reset
- Plugin registration
- Plugin list (marketplace)
- Plugin installation
- Plugin uninstallation
- Installed plugin list
- VC creation and update
- VC deletion
- VC list
- VC info
- VC KoralQuery
- VC statistics
- VC statistics with KoralQuery